Bond Account Details · Whale Docs

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

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

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

Child attributes

aaidstring

Client. Filters results by Client.

counter_idstring

Bond Code. Filters results by Bond Code.

account_typestring

Account Type. Filters results by Account Type.

Allowed values: SETTLEMENT, BUSINESS (Business), EXTERNAL, INTERNAL

SETTLEMENTBUSINESSEXTERNALINTERNAL

updated_atobject

Updated At. Filters results by Updated At.

Child attributes

gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

done_atobject

Done At. Filters results by Done At.

Child attributes

gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

biz_codestring

Biz Code. Filters results by Biz Code.

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

transfer_biz_namestring

Biz Code Name. Filters results by Biz Code Name.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

Responses

HTTP 200On success, returns paginated Bond Account Details records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List. Returned value: List of list.

Child attributes

idstring

ID. Returned value: Unique identifier of the current record.

id_valstring

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

done_atstring

Done At. Returned value: Done At. The date or time format follows the value returned by the API.

member_idstring

Member ID. Returned value: Member ID.

real_namestring

Name. Returned value: Name.

origin_idstring

A/C No. Returned value: A/C No.

account_typestring

Account Type. Returned value: Account Type.

biz_codestring

Biz Code. Returned value: Biz Code.

biz_code_valstring

Biz Code (raw value). Raw value of biz_code. The biz_code field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

counter_idstring

Bond Code. Returned value: Bond Code.

statement_nostring

Statement Transaction No. Returned value: Statement Transaction No.

report_directionstring

Direction. Returned value: Direction.

report_direction_valstring

Direction (raw value). Raw value of report_direction. The report_direction field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

quantitystring

Qty. Returned value: Qty.

after_quantitystring

Updated Qty (After). Returned value: Updated Qty (After).

updated_atstring

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

multilingual_remarkstring

Remark. Returned value: Remark.

totalintegerrequired

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.

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/account_bond_holding_changes' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "57255084",
        "id_val": "",
        "done_at": "1783599953",
        "member_id": "1000000000000000000",
        "real_name": "示例用户",
        "origin_id": "H00000000",
        "account_type": "SETTLEMENT",
        "biz_code": "[LSTINTR]Securities transfer in",
        "biz_code_val": "LSTINTR",
        "counter_id": "TH/HK/XS2971644146",
        "statement_no": "",
        "report_direction": "Input",
        "report_direction_val": "0",
        "quantity": "10,000",
        "after_quantity": "1,010,000",
        "updated_at": "1783599953",
        "multilingual_remark": ""
      }
    ],
    "total": 0
  }
}

Export

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

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

Export options Export records Download result