Skip to content
Longport WhaleLongport Whale
Corp Action Management

corporate stock register details v2

Query the corporate stock register details v2.

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters

Child attributes
aaidstring

Client

pageinteger

Page

page_sizeinteger

Page Size

Responses

HTTP 200Paginated list result.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List

Child attributes
origin_counter_idstring

Origin Counter ID

custodian_namestring

Custodian

counterpart_accountstring

Sub A/C

origin_idstring

A/C No.

account_statestring

Client State

account_state_valstring

Raw value behind field account_state: account_state returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

client_detail_typestring

ClientDetailType

real_namestring

Client Name

origin_quantitystring

Eligible Qty

choices_quantitystring

Actual Exercised Qty

notify_statestring

Client Mandate Collection Status

notify_state_valstring

Raw value behind field notify_state: notify_state returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

execute_statestring

Client CA Execution Status

execute_state_valstring

Raw value behind field execute_state: execute_state returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

updated_bystring

Mandate Updated By

updated_atstring

Updated At

send_email_atstring

Send Email At

totalintegerrequired

Total

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.longbridge.xyz/v1/datasets/corp_action_stock_register_details/download
Export optionsExport recordsDownload result
Whale Docs