Balances

Get an account's balances by ID

get

This method returns the account's balances that matches the entered ID.

Authorizations

Ledger_API_Key & Ledger_API_UserLedger_API_Key & Ledger_API_User & Ledger_Store_Auth_TokenLedger_API_UserLedger_API_User & Ledger_Store_Auth_Token

X-Ledger-API-KeystringRequired

If you've set up your API Key when initializing your LAM, you'll need to include it as a header along with the api user header. For more details, see step 5 of the get started documentation.

X-Ledger-API-UserstringRequired

(required) Username of a registered API User

Path parameters

account_idintegerRequired

The account's ID

Responses

200

Account object

application/json

Responseone of

or

or

404

Account not found

application/json

get

/accounts/{account_id}/balances

HTTPcURLJavaScriptPython

GET /accounts/{account_id}/balances HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
X-Ledger-API-User: YOUR_API_KEY
Accept: */*

{
  "available": "750",
  "pending": "250",
  "total": "1000"
}

Get an account's balances history by ID

get

This method returns the account's balances history that matches the entered ID.

Authorizations

Ledger_API_Key & Ledger_API_UserLedger_API_Key & Ledger_API_User & Ledger_Store_Auth_TokenLedger_API_UserLedger_API_User & Ledger_Store_Auth_Token

X-Ledger-API-KeystringRequired

If you've set up your API Key when initializing your LAM, you'll need to include it as a header along with the api user header. For more details, see step 5 of the get started documentation.

X-Ledger-API-UserstringRequired

(required) Username of a registered API User

Path parameters

account_idintegerRequired

The account's ID

Query parameters

endstring · date-time | nullableOptional

End of the balance history time span.

Default: 2025-04-08T14:57:28.155582+00:00

startstring · date-time | nullableOptional

Start of the balance history time span.

Default: 2025-04-08T14:57:28.155554+00:00

Responses

200

Account object

application/json

501

Not supported for this currency

application/json

get

/accounts/{account_id}/balances/history

HTTPcURLJavaScriptPython

GET /accounts/{account_id}/balances/history HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
X-Ledger-API-User: YOUR_API_KEY
Accept: */*

{
  "account_index": 1,
  "balances": [
    {
      "date": "text",
      "value": "text"
    }
  ],
  "currency": {
    "magnitude": 1,
    "name": "text",
    "network": "text",
    "token_address": "text"
  }
}