Skip to content
Longport Whale
Entitlement List

corporate registers

Query the corporate registers.

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters

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

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

Whale Docs