https://b-api.longbridge.xyz/v1/datasets/va_account_balancesDataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.
This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.
Authorization
Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.
Permission
The Broker ACCESS_TOKEN must be granted the permission below, or the call will be rejected.
Query parameters
Filters. Combines business filters. Omit a filter field to disable that filter.
Child attributes
Original Account No.. Filters results by Original Account No..
Updated At. Filters results by Updated At.
Currency Type. Filters results by Currency Type.
1 · Fiat2 · Crypto
Currency. Filters results by Currency.
Values are dynamic. Call GET /v1/datasets/refs/va_balance_currency to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.
Channel Account Type. Filters results by Channel Account Type.
Values are dynamic. Call GET /v1/datasets/refs/va_balance_account_type to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.
Page. Page number to retrieve, starting from 1.
Page Size. Number of records to return per page.
Order By. Array of sorting rules. Each item defines a sort field and direction.
Responses
HTTP 200On success, returns paginated Position Management Inquiry records together with pagination metadata such as the page number, page size, and total record count.codemessagedatadataobjectdata structureList. Returned value: List of list.
Child attributes
ID. Returned value: Unique identifier of the current record.
Channel. Returned value: Channel.
Original Account No.. Returned value: Original Account No..
Channel Account Type. Returned value: Channel Account Type.
Currency Type. Returned value: Currency Type.
Currency Type (raw value). Raw value of currency_type. The currency_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.
Currency. Returned value: Currency.
Total Channel Balance. Returned value: Total Channel Balance.
Available Channel Balance. Returned value: Available Channel Balance.
Frozen Channel Funds. Returned value: Frozen Channel Funds.
Client - Used Limit. Returned value: Client - Used Limit.
Available Pos.. Returned value: Available Pos..
Prompt Pos.. Returned value: Prompt Pos..
Intercepted Pos.. Returned value: Intercepted Pos..
Updated At. Returned value: Updated At. The date or time format follows the value returned by the API.
Updater. Returned value: Updater.
Updater (raw value). Raw value of updater. The updater field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.
Total. Returned value: Total number of matching records, used for pagination.
HTTP 400Bad request. Check the business error code in code and the error details in message.codemessagedatadataobjectdata structureNo nested fields
HTTP 401The user is not authenticated, or the login session has expired.codemessagedatadataobjectdata structureNo nested fields
HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.codemessagedatadataobjectdata structureNo nested fields
HTTP 408The request timed out. Check the business error code in code and the error details in message.codemessagedatadataobjectdata structureNo nested fields