Skip to content
Corp Action Rule

Save Option Rule

Create or edit a US-equity option corporate-action adjustment rule, used to adjust the affected option contracts' multiplier, contract size, and strike price when a corporate action occurs on the underlying.

Request parameters

  • Required: change_to (change direction/type), counter_id (underlying symbol), origin_option_symbol (original option symbol), contract_multiplier, contract_size, new_multiplier, strike_divisor, strike_price_expr, payable_date (sync ledger date).
  • Optional: id (rule ID).
  • See each field's documentation for format, value range, and business meaning.

Business notes

When id is provided the request edits an existing rule; otherwise it creates a new one. The rule parameters drive the subsequent contract adjustment and reconciliation.

Risk warning

This operation creates or modifies an option corporate-action adjustment rule and may affect later contract-parameter adjustments and reconciliation results. Confirm the underlying, original option symbol, and all adjustment parameters before calling.

Result

On success the rule is created or updated; the resulting state and returned data are defined by the 200 response.

POSThttps://b-api.lbkrs.com/v1/option/save

Authorization

AuthorizationstringheaderRequired

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

Permission

corporate.us_corporate_query

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

Request body application/json

idstring

Rule ID associated with this request.

change_tostringrequired

New option root symbol after the corporate action, e.g. RKLB1. Leave empty to keep the symbol unchanged.

contract_multiplierstringrequired

This field is required.

contract_sizestringrequired

This field is required.

counter_idstringrequired

Counter ID associated with this request. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

new_multiplierstringrequired

This field is required.

origin_option_symbolstringrequired

Root symbol of the options to adjust, without type/market prefix (e.g. RKLB for OP/US/RKLB261120C100000). This field is required.

payable_datestringrequired

Payable (sync) ledger date in YYYYMMDD format. Must be the current ledger date or the next ledger date as returned by get_near_three_ledger_date (ledger_date / next_ledger_date). This field is required.

strike_divisorstringrequired

This field is required.

strike_price_exprstringrequired

Formula for the new strike price, where {price} is the old strike; operators + - * / ( ) are allowed, e.g. {price}*2 or {price}-0.19. A bare value such as /2 is rejected (99000). 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