Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Link Accounts

Get permitted accounts balances for an enterprise

Returns the latest balance snapshots per asset for permitted accounts. When optional query param accountIds is provided, returns balances only for those account IDs; when omitted, returns all permitted accounts in the enterprise. Optional venue restricts accounts by venueId; optional repeated genericAsset restricts balance rows to those genericAsset values. Each account includes its permitted sub-account balances. Returns an empty array if no accounts are found.

get/api/link/v1/enterprises/{enterpriseId}/balances

Path parameters

enterpriseIdstring required
Example:59cd72485007a239fb00282ed480da1f

Your enterprise id.

Query parameters

accountIdsstring[]

Optional list of account IDs. When provided, returns balances only for these accounts; when omitted, returns all permitted accounts.

[
  "aba3a693-4f28-4523-8e53-85a3df22a608"
]
venuestring
Example:COINBASE_EXCHANGE

When provided, only accounts at this venue (Account.venueId) are included.

genericAssetstring[]

When provided (repeat param), only balances whose genericAsset is in this list are returned.

[
  "usdc",
  "btc"
]
displayAssetstring[]

When provided (repeat param), only balances whose displayAsset is in this list are returned. displayAsset equals genericAsset when mapped, otherwise rawAsset.

[
  "usdc",
  "XXBT"
]
searchLabelstring
Example:trading

Case-insensitive partial match against account name. Filters accounts whose name contains the value.

string required
OR
50 required

Maximum number of results to return per page. Defaults to 50.

string required
OR
0 required

Number of results to skip before returning. Defaults to 0.

Headers

user-idstring required

User id of the user making the request.

Response

OK

totalnumber required