corporate fees · Whale Docs

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters

Child attributes

filters.ca_codestring

Announcement NO

filters.origin_counter_idstring

Origin Counter Id

filters.payable_dateobject

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

Child attributes

filters.payable_date.gtestring

Greater Than or Equal

filters.payable_date.ltestring

Less Than or Equal

filters.aaidstring

Client

filters.statestring

Client Execution Status. Options: 1 = Not Processed; 2 = Success; 3 = Failed; 4 = Cancelled; 5 = Stock Success

12345

filters.stage_statestring

CA Execution Status. Options: 1 = Initialized; 2 = Confrimed; 3 = Recoding; 4 = Record - Success; 5 = Record - Failed; 6 = Execution - Pending Approval; 7 = Executing; 9 = Execution - Success; 10 = Execution - Failed; 0 = Not Created; 12 = Cancelled; 11 = Success; Avg cost is updated; 13 = Cancelled; Avg cost is updated; 14 = Execution - Success; 15 = Expired; 1617 = In approval

1234567910012111314151617

filters.fee_codestring

Fee Type. Values are dynamically queried from corporate_fee_code (not fixed); fetch them live via GET /v1/datasets/refs/corporate_action_fee_code.

filters.marketstring

Market. Multi-select; submit as a comma-joined string. Allowed values are listed under enum.. 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

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/corp_action_client_fees' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20,
  "orderBy": []
}'

Response

{
  "code": 0,
  "message": null,
  "data": {
    "list": [
      {
        "ca_code": "<string>",
        "event_id": "<string>",
        "market": "<string>",
        "origin_counter_id": "<string>",
        "payable_date": "<string>",
        "member_id": "<string>",
        "origin_id": "<string>",
        "real_name": "<string>",
        "fee_code": "<string>",
        "calc_amount": "<string>",
        "amount": "<string>",
        "currency": "<string>",
        "state": "<string>",
        "stage_state": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    ],
    "total": 0
  }
}