Options Exercise Overview

Queries Options Exercise Overview data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

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

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. Combines business filters. Omit a filter field to disable that filter.

Child attributes

due_datestring

Exercised Date. Filters results by Exercised Date.

statusstring

Status. Filters results by Status.

handled · Processedwaittohandle · Pendingwaittocheck · Waittocheck

settlement_channel_codestring

Settlement Channel. Filters results by Settlement Channel.

3 · Ib26 · Atomic

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Options Exercise Overview records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List. Returned value: List of list.

Child attributes

due_datestring

Exercise Date. Returned value: Exercise Date. The date or time format follows the value returned by the API.

statusstring

Status. Returned value: Status.

status_valstring

Status (raw value). Raw value of status. The status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

option_countstring

Option Count. Returned value: Option Count.

total_option_holding_numstring

Position Sum Holding. Returned value: Position Sum Holding.

exercised_option_countstring

Exercised Option Count. Returned value: Exercised Option Count.

advance_exercise_option_countstring

Advance Exercise Option Count. Returned value: Advance Exercise Option Count.

expired_option_countstring

Expired Option Count. Returned value: Expired Option Count.

partially_exercised_option_countstring

Partially Exercised Option Count. Returned value: Partially Exercised Option Count.

handled_option_countstring

Handled Option Count. Returned value: Handled Option Count.

settlement_channel_codestring

Settlement Channel. Returned value: Settlement Channel.

settlement_channel_code_valstring

Settlement Channel (raw value). Raw value of settlement_channel_code. The settlement_channel_code field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

totalintegerrequired

Total. 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 --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/risk_option_exercise_overview' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20' \
  --data-urlencode 'orderBy=[]'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "due_date": "2026-07-14",
        "status": "Processed",
        "status_val": "handled",
        "option_count": "1",
        "total_option_holding_num": "10",
        "exercised_option_count": "1",
        "advance_exercise_option_count": "0",
        "expired_option_count": "0",
        "partially_exercised_option_count": "0",
        "handled_option_count": "1",
        "settlement_channel_code": "Lb Hk",
        "settlement_channel_code_val": "2"
      }
    ],
    "total": 140
  }
}