corporate fee events · Whale Docs

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

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

event_typestring

Filters results by Event Type.

Allowed values:

1 - TM EXPIRED
2 - BE-RIGHTS ISSUE
3 - BE-OPEN OFFER
4 - BE-PREFERENTIAL OFFER
5 - BE-SCRIP DIVIDEND
6 - BE-CASH DIVIDEND
7 - BE-SCRIP EVENT
8 - BE-BONUS ISSUE
9 - CA-Share Consolidation
10 - CA-Share Conversion
11 - CA-Share Subdivision/Splitting
12 - DS EXPIRED
14 - EO Subscription
15 - OO Subscription
16 - ER Subscription
17 - RS Subscription
18 - TC TakeOverConditional
19 - TU TakeOverUnConditional
20 - ADR-Custody Fee
21 - SO-Spin Off
22 - IP-Interest Payment
23 - TM MERGER
24 - VT-ANNUAL GENERAL MEETING
25 - VT-EXTRAORDINARY GENERAL MEETING
26 - VT-SPECIAL GENERAL MEETING

1 · TM EXPIRED2 · BE-RIGHTS ISSUE3 · BE-OPEN OFFER4 · BE-PREFERENTIAL OFFER5 · BE-SCRIP DIVIDEND6 · BE-CASH DIVIDEND7 · BE-SCRIP EVENT8 · BE-BONUS ISSUE9 · CA-Share Consolidation10 · CA-Share Conversion11 · CA-Share Subdivision/Splitting12 · DS EXPIRED14 · EO Subscription15 · OO Subscription16 · ER Subscription17 · RS Subscription18 · TC TakeOverConditional19 · TU TakeOverUnConditional20 · ADR-Custody Fee21 · SO-Spin Off22 · IP-Interest Payment23 · TM MERGER24 · VT-ANNUAL GENERAL MEETING25 · VT-EXTRAORDINARY GENERAL MEETING26 · VT-SPECIAL GENERAL MEETING

fee_codestring

Filters results by Fee Type.

Values are dynamic. Call GET /v1/datasets/refs/corporate_action_fee_code_excl_scrip_gst 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 fee events 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

idstring

Returned value: Unique identifier of the current record.

event_typestring

Returned value: Event Type.

event_type_valstring

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

marketstring

Returned value: Market.

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.

metric_typestring

Returned value: Metric Type.

metric_type_valstring

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

calc_methodstring

Returned value: Calc Formula.

calc_method_valstring

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

ref_valuestring

Returned value: Rate.

max_feestring

Returned value: Max Fee.

min_feestring

Returned value: Min Fee.

currencystring

Returned value: Currency.

op_user_idstring

Returned value: Processed By.

updated_atstring

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

targetstring

Returned value: Sub A/C.

orderstring

Returned value: Priority.

fraction_typestring

Returned value: Rounding Method.

fraction_type_valstring

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

restrict_typestring

Returned value: Special Rule.

restrict_type_valstring

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

biz_codestring

Returned value: Biz Code.

fee_code2string

Returned value: Fee Code.

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_fee_events' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "27036",
        "event_type": "TM EXPIRED",
        "event_type_val": "1",
        "market": "HK",
        "fee_code": "CCASS FEE",
        "fee_code_val": "CCASS_FEE",
        "metric_type": "Qty As of Record Date (per lot)",
        "metric_type_val": "1",
        "calc_method": "Fee Amt=Value Of Metric Type *  Fee Rate",
        "calc_method_val": "1",
        "ref_value": "0.1",
        "max_fee": "9,999,999.00",
        "min_fee": "10.00",
        "currency": "HKD",
        "op_user_id": "user@example.com",
        "updated_at": "1784083481",
        "target": "ALL",
        "order": "0",
        "fraction_type": "Round",
        "fraction_type_val": "0",
        "restrict_type": "Unlimited",
        "restrict_type_val": "0",
        "biz_code": "LCAFEE",
        "fee_code2": "CCASS_FEE"
      }
    ],
    "total": 105
  }
}

Export

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

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

Export options Export records Download result