corporate fees · Whale Docs

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

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

Child attributes

ca_codestring

Filters results by Announcement NO..

origin_counter_idstring

Filters results by Origin Counter Id.

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.

aaidstring

Filters results by Client.

statestring

Filters results by Client Execution Status.

Allowed values:

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

1 · Not Processed2 · Success3 · Failed4 · Cancelled5 · Stock Success

stage_statestring

Filters results by CA Execution Status.

Allowed 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

1 · Initialized2 · Confrimed3 · Recoding4 · Record - Success5 · Record - Failed6 · Execution - Pending Approval7 · Executing9 · Execution - Success10 · Execution - Failed0 · Not Created12 · Cancelled11 · Success; Avg cost is updated13 · Cancelled; Avg cost is updated14 · Execution - Success15 · Expired1617 · In approval

fee_codestring

Filters results by Fee Type.

Values are dynamic. Call GET /v1/datasets/refs/corporate_action_fee_code to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

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

US · USHK · HKUK · UKSH · SHSZ · SZSG · SGKR · KRJP · JPAU · AUDE · DECA · CATH · THID · IDMY · MYTR · TRNA · NAOSL · OSLHAS · HASEU · EUUT · UTGTMMF · GTMMF

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated corporate fees 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

ca_codestring

Returned value: Announcement NO..

event_idstring

Returned value: Event ID.

marketstring

Returned value: Market.

origin_counter_idstring

Returned value: Origin Counter ID.

payable_datestring

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

member_idstring

Returned value: Client ID.

origin_idstring

Returned value: A/C No..

real_namestring

Returned value: Name.

fee_codestring

Returned value: Fee Type.

fee_code_valstring

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

calc_amountstring

Returned value: Calc Amount.

amountstring

Returned value: Amount.

currencystring

Returned value: Currency.

statestring

Returned value: Client Status.

state_valstring

Raw value of state. The 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.longbridge.xyz/v1/datasets/corp_action_client_fees' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "ca_code": "AT_TC_20260713020709_045246",
        "event_id": "124047",
        "market": "HK",
        "origin_counter_id": "ST/HK/9992",
        "payable_date": "20260710",
        "member_id": "1000000000000000000",
        "origin_id": "H00000000",
        "real_name": "示例用户",
        "fee_code": "Handling Fee",
        "fee_code_val": "HANDING_FEE",
        "calc_amount": "50.00",
        "amount": "0.00",
        "currency": "HKD",
        "state": "Not Processed",
        "state_val": "1",
        "stage_state": "Record - Success",
        "stage_state_val": "4",
        "created_at": "1784185321",
        "updated_at": "1784185321"
      }
    ],
    "total": 1541007
  }
}

Export

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

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

Export options Export records Download result