corporate fee events · Whale Docs

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters

Child attributes

filters.event_typestring

Event Type. Options: 1 = TM EXPIRED; 2 = BE-RIGHTS ISSUE; 3 = BE-OPEN OFFER; 4 = BE-PREFERENTIAL OFFER; 5 = BE-SCRIP DIVIDEND; 6 = BE-CASH DIVIDEND; 7 = BE-SCRIP EVENT; 8 = BE-BONUS ISSUE; 9 = CA-Share Consolidation; 10 = CA-Share Conversion; 11 = CA-Share Subdivision/Splitting; 12 = DS EXPIRED; 14 = EO Subscription; 15 = OO Subscription; 16 = ER Subscription; 17 = RS Subscription; 18 = TC TakeOverConditional; 19 = TU TakeOverUnConditional; 20 = ADR-Custody Fee; 21 = SO-Spin Off; 22 = IP-Interest Payment; 23 = TM MERGER; 24 = VT-ANNUAL GENERAL MEETING; 25 = VT-EXTRAORDINARY GENERAL MEETING; 26 = VT-SPECIAL GENERAL MEETING

12345678910111214151617181920212223242526

filters.fee_codestring

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

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

Response

{
  "code": 0,
  "message": null,
  "data": {
    "list": [
      {
        "id": "<string>",
        "event_type": "<string>",
        "market": "<string>",
        "fee_code": "<string>",
        "metric_type": "<string>",
        "calc_method": "<string>",
        "ref_value": "<string>",
        "max_fee": "<string>",
        "min_fee": "<string>",
        "currency": "<string>",
        "op_user_id": "<string>",
        "updated_at": "<string>",
        "target": "<string>",
        "order": "<string>",
        "fraction_type": "<string>",
        "restrict_type": "<string>",
        "biz_code": "<string>",
        "fee_code2": "<string>"
      }
    ],
    "total": 0
  }
}