Skip to content
Longport WhaleLongport Whale
Corp Action Rule

Save Option Rule

Save Option Rule.

Request parameters

  • Required: change_to (Change To), contract_multiplier (Contract Multiplier), contract_size (Contract Size), counter_id (Counter ID), new_multiplier (New Multiplier), origin_option_symbol (Origin Option Symbol), strike_divisor (Strike Divisor), strike_price_expr (Strike Price Expr)
  • Optional: id (Rule ID)
  • 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/v1/option/save

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

idstring

Rule ID associated with this request.

change_tostringrequired

Specifies Change To. This field is required.

contract_multiplierstringrequired

Specifies Contract Multiplier. This field is required.

contract_sizestringrequired

Specifies Contract Size. This field is required.

counter_idstringrequired

Counter ID associated with this request.

new_multiplierstringrequired

Specifies New Multiplier. This field is required.

origin_option_symbolstringrequired

Specifies Origin Option Symbol. This field is required.

strike_divisorstringrequired

Specifies Strike Divisor. This field is required.

strike_price_exprstringrequired

Specifies Strike Price Expr. 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