Listing account transactions

GET /api/public/v1/accounts/:account_id/transactions

Returns the transaction history for a single account. Results are paginated and can be filtered by date and ordered.

Headers

Name	Value
Content-Type	application/vnd.api+json
Authorization	Bearer <api_key>

Path Parameters

Name	Type	Description
account_id	string	Account ID.

URL Parameters

Name	Type	Description
order	string	Order in which the list of transactions should be returned. Can be either created_at, amount or balance.
order_type	string	Order type. Can be either asc or desc.
per_page	number	Number of transactions per page to return.
page	number	Page for which you want to return transactions.
created_at_from	string	Date and time filter. Supports timestamps in ISO 8601 format, e.g. 2024-06-18T15:49:02.031Z.
created_at_to	string	Date and time filter. Supports timestamps in ISO 8601 format, e.g. 2024-06-18T15:49:02.031Z.

Response

HTTP 200

{
  "data": [
    {
      "id": "28e51afe-a9f9-43f1-9204-cc90a7deb4f2",
      "type": "transactions",
      "attributes": {
        "createdAt": "2024-06-18T15:49:02.031Z",
        "simplifiedState": "completed",
        "transactionType": "CoinTransaction",
        "amount": "0.00010000",
        "balance": "0.20087774"
      },
      "relationships": {
        "account": {
          "data": {
            "type": "accounts",
            "id": "5850abb7-0a60-4041-800c-1d43b4dcf4d6"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "5850abb7-0a60-4041-800c-1d43b4dcf4d6",
      "type": "accounts",
      "attributes": {
        "currencyCode": "BTC",
        "balance": "0.20087774",
        "currencyType": "crypto"
      },
      "relationships": {
        "company": {
          "meta": {
            "included": false
          }
        },
        "networks": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 1,
    "total": 78
  },
  "jsonapi": {
    "version": "1.0"
  }
}

Response Body

Name	Type	Description
data[].id	string	Transaction ID.
data[].type	string	Entity type returned. Always transactions.
data[].attributes	object	A set of transaction attributes.
data[].attributes.createdAt	string	Transaction creation timestamp in UTC+0. Refer to the Date and time format page.
data[].attributes.simplifiedState	string	Transaction status.
data[].attributes.transactionType	string	Transaction type. Can be either ExchangeTransaction, CoinTransaction or ManualTransaction.
data[].attributes.amount	string	Transaction amount.
data[].attributes.balance	string	Account balance immediately after Txn processed this transaction.
data[].attributes.currency	string	Currency code of the transaction. Matches the account currency.
data[].attributes.reference	string	Reference associated with the transaction.
data[].attributes.accountId	string	ID of the account the transaction belongs to. Same value as data[].relationships.account.id.
data[].relationships.account.type	string	Entity type of the related account. Always accounts.
data[].relationships.account.id	string	ID of the account the transaction belongs to.
meta.page	number	Current page number. null when no page parameter is supplied.
meta.per_page	number	Page size used for the response.
meta.total	number	Total number of transactions matching the query.