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

HTTP 200

{
  "data": {
    "id": "5850abb7-0a60-4041-800c-1d43b4dcf4d6",
    "type": "accounts",
    "attributes": {
      "currencyCode": "BTC",
      "balance": "0.20087774",
      "currencyType": "crypto"
    },
    "relationships": {
      "company": {
        "meta": {
          "included": false
        }
      },
      "networks": {
        "data": [
          {
            "type": "network",
            "id": "a1d019ea-26f8-457b-931e-efb06a14ce59"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "a1d019ea-26f8-457b-931e-efb06a14ce59",
      "type": "network",
      "attributes": {
        "currencyCode": "BTC",
        "name": "BTC Testnet"
      }
    }
  ],
  "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.
data.relationships.networks.data	string	Array of supported networks for a given crypto account.