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

Combines business filters. Omit a filter field to disable that filter.

Child attributes

underlying_counter_idstring

Filters results by Underlying Counter Id.

origin_option_counter_idstring

Filters results by Origin Option Counter Id.

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 change 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.

id_valstring

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

underlying_counter_idstring

Returned value: Underlying Counter Id.

origin_option_counter_idstring

Returned value: Origin Option Counter Id.

origin_option_counter_id_valstring

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

new_option_counter_idstring

Returned value: New Option Counter Id.

new_option_counter_id_valstring

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

positionstring

Returned value: Position.

detail_numstring

Returned value: Detail Num.

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.

option_change_rule_idstring

Returned value: Option Change Rule Id.

origin_quantitystring

Returned value: Origin Quantity.

new_quantitystring

Returned value: New Quantity.

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

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "43178",
        "id_val": "",
        "underlying_counter_id": "ST/US/LI",
        "origin_option_counter_id": "OP/US/LI260515C13000",
        "origin_option_counter_id_val": "",
        "new_option_counter_id": "OP/US/LI260515C6500",
        "new_option_counter_id_val": "",
        "position": "LONG",
        "detail_num": "0",
        "state": "sync_risk_system_succeed",
        "state_val": "sync_risk_system_succeed",
        "option_change_rule_id": "23529",
        "origin_quantity": "200",
        "new_quantity": "1,000"
      }
    ],
    "total": 16000
  }
}

Export

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

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

Export options Export records Download result