Skip to Content
ELK Developers

GET /v1/balances

Account balances and credit

Download .md
GET
/v1/balances

Returns asset balances, holds, available funds and USD credit. Requires a linked account, current KYC, an approved IP and ViewQuotes. Available credit equals limit minus outstanding exposure minus holds. A zero credit limit permits funded orders only. No request body is required.

Authorization

ApiKey
headerAuthorizationBearer <token>

Send Authorization: Bearer over HTTPS. Each key is associated with an account and environment. Invalid, expired or revoked keys return 401.

Response Body

Current balances, holds and credit

application/json
  1. response
schema_version*integer
Value in12
source*string
as_of*UtcTimestamp

Desk statement observation time, not a provider mark timestamp.

Formatdate-time
balances*array<>
Itemsitems <= 1000
credit*
Example Request
curl -X GET 'https://api.elkcrypto.com/sandbox/v1/balances'
Example Response
{  "source": "desk_journal",  "as_of": "2019-08-24T14:15:22Z",  "schema_version": 2,  "balances": [    {}  ],  "credit": {    "currency": "USD",    "limit": "string",    "outstanding": "string",    "on_hold": "string",    "basis": "asset_deficits_v1",    "available": "string"  }}