Bank Balance Records · Whale Docs

GEThttps://b-api.longbridge.xyz/v1/datasets/clearing_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

dtstring

Filters results by Accounting Date.

sourcestring

Filters results by Source.

Allowed values:

1 - Manual Input
0 - API

1 · Manual Input0 · API

currencystring

Filters results by Currency.

lb_bank_accountstring

Filters results by Bank Account.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Bank Balance Records 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.

bank_idstring

Returned value: Company Bank Account ID.

dtstring

Returned value: Accounting Date.

lb_bank_accountstring

Returned value: Bank Account.

bank_namestring

Returned value: Bank Short Name.

currencystring

Returned value: Currency.

balancestring

Returned value: Balance.

sourcestring

Returned value: Source.

source_valstring

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

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

Request

curl --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/clearing_bank_balances' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "102957",
        "bank_id": "532",
        "dt": "20260715",
        "lb_bank_account": "示例用户",
        "bank_name": "创兴银行银企直联",
        "currency": "HKD",
        "balance": "96,816",
        "source": "API",
        "source_val": "0",
        "updated_at": "1784160007"
      }
    ],
    "total": 126
  }
}

Export

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

POSThttps://b-api.longbridge.xyz/v1/datasets/clearing_bank_balances/download

Export options Export records Download result