Skip to main content

Get Account

Reads one account — a (member, asset) balance — by its own id.

GET/api/accounts/{id}Auth: Required

Response​

The account.

idnumberRequired

The account's own id — this is the account_id other endpoints take.

member_idnumberRequired

The member this account belongs to.

asset_idstringRequired

Asset code.

balancestringRequired

Funds available to spend now — on orders, payouts and transfers. Held funds are not included; they are in locked.

lockedstringRequired

Funds held for open orders, payouts in progress and deposits waiting to be auto-converted. Not part of balance — the member holds balance + locked on the account. Deposits held by AML screening (status frozen) are in neither field until they are released.

updated_atstringRequired

When the record last changed.

created_atstringRequired

When the record was created.