List client balances

get

https://app.bitgo-test.com/api/network/v1/enterprises/{enterpriseId}/clients/balances

This API call allows clients to get trading and allocated balances at BitGo for any connected trading partner. The trading balances are live data. The data under networkBalances are not the live balances at the partner, the live balances should be viewed on the partner's platform. networkBalances will only update as a result of allocations, deallocations, and settlement.

Error scenarios:

400: Invalid Request Error
Occurs when the request parameters are invalid or malformed
Examples: Invalid UUID format for enterpriseId, invalid filter parameters, invalid pagination parameters, invalid connection or partner IDs
401: Authentication Error
Occurs when the request is not authorized
Examples: Caller is not a member of the enterprise.
403: Permission Denied Error
Occurs when the authenticated client doesn't have necessary permissions
Examples: Client doesn't have permission to view balances. Enterprise does not have OES license.
404: Not Found Error
Occurs when the specified enterprise or resources cannot be found
Examples: Enterprise doesn't exist.
500: Internal Server Error
Occurs when there's an unexpected server error processing the request
Examples: Database connection issues, transient network errors,

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

enterpriseId

string

required

length ≥ 1

The enterprise identifier of the client. This identifies the client enterprise that owns the allocation.

Query Params

pageNumber

string

The page number (integer) you wish to fetch. When provided, the API will skip pageSize * pageNumber records. Page numbers are zero-based, so the first page is 0. If not provided, defaults to 0.

pageSize

string

The page size (integer) you wish to fetch. When provided, the API will return at most pageSize records per page. If not provided, a default page size defined by the server will be used.

connectionIds

array of strings

Optional array of connection IDs to filter by.

If provided:

Only balances for connections with these specific IDs will be returned.
Useful for monitoring specific trading relationships or connections.
Can be used to focus on particular allocation targets.

If omitted, results will include data for all your connections subject to other filters.

connectionIds

partnerIds

array of strings

Optional array of partner IDs to filter by.

If provided:

Only balances for connections to partners with these IDs will be returned.
Useful for focusing on balances with specific partner organizations.
Can be used to monitor exposure to particular partners.

If omitted, results will include data for connections to all partners.

partnerIds

Responses

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error