Balances

Get Account Balances

Retrieve account balances by accountId.

GEThttp://localhost:3001/api/v1/accounts/{accountId}/balances

Path parameters

accountId*string (uuid)

The account ID

Response

2004004014034XX5XX

Successful response

Body

application/json

accountIdstring (uuid)

mtmstring (number)

Example: "-39592.01"

mtmCurrencystring

Example: "USD"

lastUpdatedAtDatetime

Date-time in ISO 8601 format

Example: "2024-08-01T18:44:05Z"

creditobject

assetsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3001/api/v1/accounts/{accountId}/balances', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "mtm": "-39592.01",
  "mtmCurrency": "USD",
  "lastUpdatedAt": "2024-08-01T18:44:05Z",
  "credit": {
    "creditCurrency": "USD",
    "creditLimit": "40000",
    "utilizedCredit": "39592.01",
    "unutilizedCredit": "407.99"
  },
  "assets": [
    {
      "asset": "BTC",
      "tradeBalance": "0",
      "custodyBalance": "0",
      "pendingSettlement": "0",
      "open": "0",
      "availableToWithdraw": "0"
    }
  ]
}