Listing account transactions

List account transactions

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

This endpoint returns the complete transaction history for a single account.

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.

Response

{
  "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": null,
    "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

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

This is what your account balance was when Txn processed the transaction.

data.relationships

object

Additional data on the transaction relationship.

data.relationships.account.type

string

Type of the entity returned in the data.relationships.account.id string. Always accounts.

data.relationships.account.id

string

Account ID which the transaction belongs to.

meta

object

Object that contains the pagination data.

meta.page

string

Current page number you are on.

meta.per_page

string

Number of transactions per page.

meta.total

number

Total number of pages returned.

Last updated