Skip to content
Longport WhaleLongport Whale
Option Exercise

Exercisable List

Query the Exercisable List.

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

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_list_query

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

Query parameters

filtersobject

Filters

Child attributes
counter_idstring

Option Code

directionstring

Position Side

12

statusstring

Status

InitHoldingPullingHoldingPulledHoldingLoadedExercisingPartiallyExercisedExercisedExerciseFailedToInitExerciseCallBackingCallBackFailed

underlying_counter_idstring

Underlying Code

option_fields_matchstring

Exercise Reconciliation Status

123

stock_fields_matchstring

Trade Reconciliation Status

123

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

Exercisable ID

counter_idstring

Option Code

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.

numstring

Total Position

option_fields_matchstring

Exercise Reconciliation Status

option_fields_match_valstring

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

stock_fields_matchstring

Trade Reconciliation Status

stock_fields_match_valstring

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

exercised_numstring

Exercised Quantity

expired_numstring

Invalid Quantity

pending_exercise_qtystring

Pending Exercise Qty

pending_expired_qtystring

Pending Expired Qty

in_out_moneystring

In Out Money

in_out_money_valstring

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

strike_pricestring

Strike Price

close_pricestring

Underlying Stock Settlement Price

directionstring

Position Side

direction_valstring

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

strike_divisorstring

Strike Divisor

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