Ctrl+K

Get permitted accounts balances for an enterprise

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

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.

Path Parameters

  • enterpriseIdstringRequired
    Your enterprise id.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
    Min length: >= 1 characters

Query Parameters

  • accountIdsarray[string]
    Optional list of account IDs. When provided, returns balances only for these accounts; when omitted, returns all permitted accounts.
  • venuestring
    When provided, only accounts at this venue (`Account.venueId`) are included.
    Example: COINBASE_EXCHANGE
    Min length: >= 1 characters
  • genericAssetarray[string]
    When provided (repeat param), only balances whose `genericAsset` is in this list are returned.
    Min length: >= 1 characters
  • displayAssetarray[string]
    When provided (repeat param), only balances whose `displayAsset` is in this list are returned. displayAsset equals genericAsset when mapped, otherwise rawAsset.
    Min length: >= 1 characters
  • searchLabelstring
    Case-insensitive partial match against account name. Filters accounts whose name contains the value.
    Example: trading
    Min length: >= 1 characters
  • limitstring or numberRequired
    Maximum number of results to return per page. Defaults to 50.
    Example: 50
  • offsetstring or numberRequired
    Number of results to skip before returning. Defaults to 0.
    Example: 0

200 Response

accounts array[object] required
Per-account shape in the enterprise balances list. Balances are grouped by funding sub-type at the top level; sub-accounts carry their own sub-type-grouped balances.
id string required
venueId string required
Min length: >= 1 characters
status string required
Allowed values: active inactive deleted pending_credentials
name string required
Min length: >= 1 characters
accountSubTypes array[object] required
One funding sub-type's balances on an account. The sub-type identity (normalized key + projected raw / label) is carried once at this level; the asset balances live inside `balances`. Pass-through values (HLD §10.30 — venue raws not yet mapped) carry the raw label in `accountSubType` and have neither `rawAccountSubType` nor `accountSubTypeLabel`, since there is no config entry to project from.
subAccounts array[object] required
Sub-account with its balances grouped by funding sub-type.
total number required

400 Response

401 Response

errorName string required
error string required

403 Response

errorName string required
error string required

500 Response

errorName string required
error string required