Skip to content
Longport Whale
Entitlement List

corporate registers Export

Export the corporate registers list to a file. In sync mode (mode:0) the download URL is returned directly; in async mode (mode:1) a file_download_id is returned, to be polled via the shared GET/DELETE /v1/datasets/download/{id} endpoint for status and the final download URL.

POSThttps://b-api.longbridge.xyz/v1/datasets/corp_action_client_entitlements/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_client_entitlements.yaml (the query capability).

Child attributes
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.ca_codestring

Announcement NO

filters.aaidstring

Client

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

filters.origin_counter_idstring

Origin Counter ID

filters.execute_statestring

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

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

Whale Docs