Reading account

Read account

GET /api/public/v1/accounts/:id

This endpoint returns data for a single account.

Headers

Name
Value

Content-Type

application/vnd.api+json

Authorization

Bearer <api_key>

Path Parameters

Name
Type
Description

id

string

Account ID.

Response

{
  "data": {
    "id": "e289de2b-37bd-4eff-b832-f754c31a2d95",
    "type": "accounts",
    "attributes": {
      "currencyCode": "USDT",
      "balance": "4188.566205",
      "currencyType": "crypto"
    },
    "relationships": {
      "company": {
        "meta": {
          "included": false
        }
      },
      "networks": {
        "data": [
          {
            "type": "network",
            "id": "2cfea86d-f334-4bd2-99ac-e74281520c95"
          },
          {
            "type": "network",
            "id": "8ededca3-a1cd-4b46-8c3a-14915f706ab2"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "2cfea86d-f334-4bd2-99ac-e74281520c95",
      "type": "network",
      "attributes": {
        "currencyCode": "USDT",
        "name": "Ethereum (ERC20)",
        "code": "hterc6dp"
      }
    },
    {
      "id": "8ededca3-a1cd-4b46-8c3a-14915f706ab2",
      "type": "network",
      "attributes": {
        "currencyCode": "USDT",
        "name": "Tron (TRC20)",
        "code": "ttrx:usdt"
      }
    }
  ],
  "meta": {},
  "jsonapi": {
    "version": "1.0"
  }
}

Response Body

Name
Type
Description

data.id

string

Account ID.

data.type

string

Entity type returned. Always accounts.

data.attributes

object

A set of account attributes.

data.attributes.currencyCode

string

Account currency code. Refer to the list of supported currencies.

data.attributes.balance

string

Account total balance.

data.attributes.currencyType

string

Account currency type. Can be either fiat or crypto.

included.id

string

Entity ID.

included.type

string

Entity type. Only "network" for now.

included.attributes.currencyCode

string

Network currency code. Useful for displaying to end-users.

included.attributes.name

string

Network name. Useful for displaying to end-users.

included.attributes.code

string

Network code. Refer to Supported currencies.

Last updated