option change list · Whale Docs

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters

Child attributes

filters.underlying_counter_idstring

Underlying Counter Id

filters.origin_option_counter_idstring

Origin Option Counter Id

filters.statestring

State. Multi-select; submit as a comma-joined string. Allowed values are listed under enum.. Options: 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

initib_confirmedsync_risk_system_failedsync_risk_system_succeedexecutingexecut_failedexecut_succeed

pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List

totalintegerrequired

Total

Request

curl --request POST \
  --url 'https://b-api.longbridge.xyz/v1/datasets/instrument_option_changes' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20,
  "orderBy": []
}'

Response

{
  "code": 0,
  "message": null,
  "data": {
    "list": [
      {
        "id": "<string>",
        "underlying_counter_id": "<string>",
        "origin_option_counter_id": "<string>",
        "new_option_counter_id": "<string>",
        "position": "<string>",
        "detail_num": "<string>",
        "state": "<string>",
        "option_change_rule_id": "<string>",
        "origin_quantity": "<string>",
        "new_quantity": "<string>"
      }
    ],
    "total": 0
  }
}