Skip to content
Global Rule

Add Fee Event

Add Fee Event.

Request parameters

  • Required: ann_type (Announcement Type), event_type (Event Type), market (Market), fee_code (Fee Code), metric_type (Metric Type), calc_method (Calc Method), ref_value (Ref Value), max_fee (Max Fee), min_fee (Min Fee), currency (Currency), target (Target), order (Order), fraction_type (Fraction Type), restrict_type (Restrict Type)
  • See each field for its format, allowed values, and business meaning.

Result

On success, the endpoint completes the operation. See the 200 response schema for returned data and subsequent state information.

POSThttps://b-api.longbridge.xyz/corporate_action/add_fee_event

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

ann_typenumberrequired

Specifies Announcement Type. This field is required.

Allowed values:

  • 1 - Stock

1 · Stock

event_typenumberrequired

Specifies Event Type. This field is required.

Allowed values:

  • 1 - Callable bull/bear contract recall.
  • 2 - Dividend

1 · Callable bull/bear contract recall.2 · Dividend

marketstringrequired

Specifies Market. This field is required.

fee_codestringrequired

Specifies Fee Code. This field is required.

metric_typenumberrequired

Specifies Metric Type. This field is required.

Allowed values:

  • 1 - The registered-holding (per lot) parameter value.
  • 2 - Announced fixed amount.
  • 3 - The equity-amount parameter value.

1 · The registered-holding (per lot) parameter value.2 · Announced fixed amount.3 · The equity-amount parameter value.

calc_methodstringrequired

Specifies Calc Method. This field is required.

Allowed values:

  • 1 - By ratio.
  • 2 - Fixed fee.

1 · By ratio.2 · Fixed fee.

ref_valuestringrequired

Specifies Ref Value. This field is required.

max_feestringrequired

Specifies Max Fee. This field is required.

min_feestringrequired

Specifies Min Fee. This field is required.

currencystringrequired

Currency code used for this request. This field is required.

targetstringrequired

Specifies Target. This field is required.

ordernumberrequired

Specifies Order. This field is required.

fraction_typenumberrequired

Specifies Fraction Type. This field is required.

restrict_typenumberrequired

Specifies Restrict Type. This field is required.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

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

Whale Docs