corporate fee events Export

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters. Same fields as the filters of corp_action_fee_events.yaml (the query capability).

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

orderByarray<object>

Order By

modeinteger

Mode. Defaults to 0 (sync) when omitted.. Options: 0 = Sync; 1 = Async

01

extstring

Ext. Supports csv/xlsx; defaults to csv.

csvxlsx

file_namestring

File Name

remarkstring

Remark

down_fieldsarray<string>

Down Fields. When omitted, all fields are exported; allowed values are listed under items.enum (the same field list as the query endpoint's data.list.items).

ticket_contentstring

Ticket Content. Shown to the approver when the template has a download-approval ticket configured.

ticket_preview_urlstring

Ticket Preview URL

hideinteger

Hide. Options: 0 = Not Hidden; 1 = Hidden

01

Responses

HTTP 200Export result. In sync mode the download URL is returned directly; in async mode a file_download_id is returned for subsequent polling.

Standard response envelopecodemessagedata

dataobjectdata structure

urlstring

Download URL. Returned in sync mode (mode:0); empty in async mode.

file_download_idstring

File Download ID. Returned in async mode (mode:1); used to poll GET/DELETE /v1/datasets/download/{id}.

ticket_idstring

Ticket ID

Request

curl --request POST \
  --url 'https://b-api.longbridge.xyz/v1/datasets/corp_action_fee_events/download' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "orderBy": [],
  "mode": 0,
  "ext": "csv",
  "file_name": "",
  "remark": "",
  "down_fields": [],
  "ticket_content": "",
  "ticket_preview_url": "",
  "hide": 0
}'

Response

{
  "code": 0,
  "message": null,
  "data": {
    "url": "<string>",
    "file_download_id": "<string>",
    "ticket_id": "<string>"
  }
}