Skip to content
Longport WhaleLongport Whale
Option Exercise

Exercisable Details (exercise Buy Stock)

Query the Exercisable Details (exercise Buy Stock) list.

GEThttps://b-api.longbridge.xyz/v1/datasets/risk_option_exercisable_buy_stock_detail

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

AuthorizationstringheaderRequired

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

Permission

option_exercise.option_exercise_exercisable_detail_query

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

Query parameters

filtersobject

Filters

Child attributes
exercisable_idstring

Exercisable Id

settlement_accountstring

IB Sub Account

pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List

Child attributes
idstring

ID

aaidstring

A/C No.

aaid_valstring

A/C No. (raw value). Raw value behind field aaid: aaid returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

counter_idstring

Option Counter Id

underlying_counter_idstring

Underlying Counter Id

numstring

Total Position

left_numstring

Unprocessed Quantity

option_cash_changestring

Option Cash Change

statusstring

Status

status_valstring

Status (raw value). Raw value behind field status: status returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

exercise_need_buy_open_qtystring

Exercise Need Buy Open Qty

exercise_need_buy_close_qtystring

Exercise Need Buy Close Qty

strike_divisorstring

Strike Divisor

error_codestring

Error Code

error_code_valstring

Error Code (raw value). Raw value behind field error_code: error_code returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

totalintegerrequired

Total

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