Settlement Batch · Whale Docs

POSThttps://b-api.longbridge.xyz/v1/datasets/booking_settlement_record_batches

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters

Child attributes

filters.marketstring

Market. Options: US = US; HK = HK; UK = UK; SH = SH; SZ = SZ; SG = SG; KR = KR; JP = JP; AU = AU; DE = DE; CA = CA; TH = TH; ID = ID; MY = MY; TR = TR; NA = NA; OSL = OSL; HAS = HAS; EU = EU; UT = UT; GTMMF = GTMMF

USHKUKSHSZSGKRJPAUDECATHIDMYTRNAOSLHASEUUTGTMMF

filters.expected_settlement_dateobject

Expected Settlement Date. Range filter; both bounds are optional (omit a bound to leave that side unbounded).

Child attributes

filters.expected_settlement_date.gtestring

Greater Than or Equal

filters.expected_settlement_date.ltestring

Less Than or Equal

filters.statestring

Status. Options: 2 = DataPulled; 3 = DataLoaded; 4 = Calculated; 5 = Charged; 6 = Settled; 10005 = Settling; 20005 = 交收失败（联系技术人员解决）; 7 = Equity settled

2345610005200057

filters.falsestring

Settlement Batch No

pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List

totalintegerrequired

Total

Request

curl --request POST \
  --url 'https://b-api.longbridge.xyz/v1/datasets/booking_settlement_record_batches' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20,
  "orderBy": []
}'

Response

{
  "code": 0,
  "message": null,
  "data": {
    "list": [
      {
        "biz_type": "<string>",
        "false": "<string>",
        "market": "<string>",
        "state": "<string>",
        "expected_settlement_date": "<string>",
        "trade_date": "<string>",
        "settled_at": "<string>",
        "expected_balance_settlement_date": "<string>",
        "expected_equity_settlement_date": "<string>"
      }
    ],
    "total": 0
  }
}