Skip to content
Longport WhaleLongport Whale
Instant Balance

Account Balance Query

Queries Account Balance Query data. Combine business filters in filters, and use page and page_size to control pagination.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

GEThttps://b-api.longbridge.xyz/v1/datasets/atm_bank_balances

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

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Query parameters

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes
currencystring

Filters results by Currency.

Values are dynamic. Call GET /v1/datasets/refs/tenant_currencies_by_channel to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

updated_atobject

Filters results by Updated Time.

Child attributes
gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Account Balance Query records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

Returned value: List of list.

Child attributes
idstring

Returned value: Unique identifier of the current record.

accountstring

Returned value: Bank Account.

account_valstring

Raw value of account. The account field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

bank_namestring

Returned value: Bank Name.

currencystring

Returned value: Currency.

currency_valstring

Raw value of currency. The currency field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

yesterday_balancestring

Returned value: Yesterday Balance.

balancestring

Returned value: Current Balance.

usable_balancestring

Returned value: Available Balance.

frozen_amtstring

Returned value: Total Freeze Amount.

last_tran_datestring

Returned value: Last Trading Day. The date or time format follows the value returned by the API.

last_intr_datestring

Returned value: Last Interest Accrual Date. The date or time format follows the value returned by the API.

updated_atstring

Returned value: Updated Time. The date or time format follows the value returned by the API.

totalintegerrequired

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.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.longbridge.xyz/v1/datasets/atm_bank_balances/download
Export optionsExport recordsDownload result
Whale Docs