Skip to content
Longport WhaleLongport Whale
Option Exercise

Exercisable Sub - Account Info Preview

Query the quantity summary of a given exercisable option across settlement sub-accounts, previewing how it breaks down by sub-account before exercise processing.

Request parameters

  • Combine business filters through filters (see the filter field descriptions below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

  • Filtered by exercisable ID (t.exercisable_id) and aggregated by settlement sub-account.
  • Each record represents one settlement sub-account and carries the total position, unprocessed quantity, exercised quantity, and abandoned quantity, together with the counterparty's exercised and abandoned quantities.
  • Used to check whether the exercise and abandon quantities of an exercisable option match the counterparty across sub-accounts.

Returns

On success, returns the matching records with pagination info. See the response definition for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/risk_option_exercisable_sub_account_info

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 above, or the call will be rejected.

Request body application/json

filtersobject

Filters

Child attributes
t.exercisable_idstring

Exercisable ID

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
settlement_accountstring

Sub Account

option_holding_numstring

Total Position

to_exercise_numstring

Unprocessed Quantity

exercised_numstring

Exercise Quantity Completed

expired_numstring

Invalid Exercise Quantity

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