corporate announcement fee events

Queries the list of fee rules that apply to a single corporate-action announcement, used to verify its fee scheme.

Request parameters

Combine business filter conditions through filters (see the filters field descriptions below for the available fields), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Returns the applicable fee schemes by announcement id.

Each record carries the scheme number and type, fee type, applicable sub-account, metric type, calculation formula, fee rate, maximum and minimum fee, currency, priority, rounding method, and special fee rule, and it distinguishes standard fee rules from announcement-level customised fee rules.

Use it to confirm how fees are calculated when the corporate action is executed.

Returns

On success, returns the list of matching records with pagination. See the response schema for the meaning of each returned column.

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

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

Filters

Child attributes

idstring

pageinteger

Page

page_sizeinteger

Page Size

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List

Child attributes

idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

event_idstring

EVENT ID

event_typestring

Event Type

event_type_valstring

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

fee_codestring

Fee Type

fee_code_valstring

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

targetstring

Sub A/C

metric_typestring

Metric Type

metric_type_valstring

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

calc_methodstring

Calculation Formula

calc_method_valstring

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

ref_valuestring

Fee Rate

max_feestring

Max Fee

min_feestring

Min Fee

currencystring

Currency

orderstring

Fee Priority

fraction_typestring

Rounding Method

fraction_type_valstring

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

restrict_typestring

Special Rule

restrict_type_valstring

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

fee_event_idstring

Standard Fee Rule ID

ann_fee_event_idstring

Customise Fee Rule ID

marketstring

Market

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

Request

curl --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/corp_action_announcement_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": "123",
        "event_id": "1000000001",
        "event_type": "1",
        "event_type_val": "1",
        "fee_code": "1",
        "fee_code_val": "1",
        "target": "string",
        "metric_type": "1",
        "metric_type_val": "1",
        "calc_method": "1",
        "calc_method_val": "1",
        "ref_value": "125630.50",
        "max_fee": "12.50",
        "min_fee": "12.50",
        "currency": "USD",
        "order": "string",
        "fraction_type": "1",
        "fraction_type_val": "1",
        "restrict_type": "1",
        "restrict_type_val": "1",
        "fee_event_id": "1000000001",
        "ann_fee_event_id": "1000000001",
        "market": "US"
      }
    ],
    "total": 1
  }
}

Export

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

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

lb_hk_corporate.corporate_query

Export options Export records Download result