corporate registers · Whale Docs

POSThttps://b-api.lbkrs.com/v1/datasets/corp_action_client_entitlements

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_corporate.corporate_query

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes

payable_dateobject

Filters results by Payable Date.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

ca_codestring

Filters results by Announcement NO..

aaidstring

Filters results by Client.

marketstring

Filters results by Market.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

Allowed values: US, HK, UK, SH, SZ, SG, KR, JP, AU, DE, CA, TH, ID, MY, TR, NA, OSL, HAS, EU, UT, GTMMF

Values

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

origin_counter_idstring

Filters results by Origin Counter ID.

execute_statestring

Filters results by Client Execution Status.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

Values

1: Not Processed
2: Success
3: Failed
4: Cancelled
5: Stock Success

stage_statestring

Filters results by CA Execution Status.

Values

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

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated corporate registers records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Returned value: List of list.

Child attributes

payable_datestring

Returned value: Payable Date. The date or time format follows the value returned by the API.

ca_codestring

Returned value: Announcement NO..

event_idstring

Returned value: Event ID.

member_idstring

Returned value: Client ID.

custodian_namestring

Returned value: Custodian.

counterpart_accountstring

Returned value: Sub A/C.

origin_idstring

Returned value: A/C No..

real_namestring

Returned value: Name.

marketstring

Returned value: Market.

origin_counter_idstring

Returned value: Counter ID (Debit).

origin_quantitystring

Returned value: Quantity.

currencystring

Returned value: Currency.

amount_payablestring

Returned value: Est Amount.

actual_amount_payablestring

Returned value: Actual Amount.

recycle_stock_payablestring

Returned value: Est Quantity.

actual_recycle_stock_payablestring

Returned value: Actual Quantity.

new_counter_idstring

Returned value: Counter ID (Credit).

stock_payablestring

Returned value: Est Quantity.

actual_stock_payablestring

Returned value: Actual Quantity.

execute_statestring

Returned value: Client Execution Status.

execute_state_valstring

Raw value of execute_state. The execute_state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

stage_statestring

Returned value: CA Execution Status.

stage_state_valstring

Raw value of stage_state. The stage_state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

created_atstring

Returned value: Created At. The date or time format follows the value returned by the API.

updated_atstring

Returned value: Updated At. The date or time format follows the value returned by the API.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

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

Request

curl --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/corp_action_client_entitlements' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {
    "payable_date": "20260614-20260714"
  },
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "payable_date": "20250101",
        "ca_code": "1",
        "event_id": "1000000001",
        "member_id": "101456715",
        "custodian_name": "张三",
        "counterpart_account": "1200",
        "origin_id": "1000000001",
        "real_name": "张三",
        "market": "US",
        "origin_counter_id": "1000000001",
        "origin_quantity": "1200",
        "currency": "USD",
        "amount_payable": "125630.50",
        "actual_amount_payable": "125630.50",
        "recycle_stock_payable": "string",
        "actual_recycle_stock_payable": "string",
        "new_counter_id": "1000000001",
        "stock_payable": "string",
        "actual_stock_payable": "string",
        "execute_state": "1",
        "execute_state_val": "1",
        "stage_state": "1",
        "stage_state_val": "1",
        "created_at": "1789713827",
        "updated_at": "1789713827"
      }
    ],
    "total": 1
  }
}

Export

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

POSThttps://b-api.lbkrs.com/v1/datasets/corp_action_client_entitlements/download

lb_hk_corporate.corporate_query

Export options Export records Download result