option rule list · Whale Docs

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

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

origin_option_symbolstring

Filters results by Origin Option Symbol.

statestring

Filters results by State.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

Allowed values:

init - Init
ib_confirmed - Ib Confirmed
sync_risk_system_failed - Sync Risk System Failed
sync_risk_system_succeed - Sync Risk System Succeed
executing - Executing
execut_failed - Execution Failed
execut_succeed - Execution Successful

init · Initib_confirmed · Ib Confirmedsync_risk_system_failed · Sync Risk System Failedsync_risk_system_succeed · Sync Risk System Succeedexecuting · Executingexecut_failed · Execution Failedexecut_succeed · Execution Successful

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated option rule list 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.

account_channelstring

Returned value: Account Channel.

origin_option_symbolstring

Returned value: Origin Option Symbol.

option_symbol_change_tostring

Returned value: Option Symbol Change To.

ib_option_counter_idstring

Returned value: Ib Option Counter Id.

contract_sizestring

Returned value: Contract Size.

strike_price_exprstring

Returned value: Strike Price Expr.

statestring

Returned value: State.

state_valstring

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

update_bystring

Returned value: Update By.

updated_atstring

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

contract_multiplierstring

Returned value: Contract Multiplier.

new_multiplierstring

Returned value: New Multiplier.

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

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "23529",
        "account_channel": "lb",
        "origin_option_symbol": "LI",
        "option_symbol_change_to": "LI",
        "ib_option_counter_id": "",
        "contract_size": "4",
        "strike_price_expr": "{price} / 2",
        "state": "sync_risk_system_succeed",
        "state_val": "sync_risk_system_succeed",
        "update_by": "user@example.com",
        "updated_at": "1778843625",
        "contract_multiplier": "5",
        "new_multiplier": "2"
      }
    ],
    "total": 853
  }
}

Export

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

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

Export options Export records Download result