Option Exercise Records

Queries Exercise List 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_records

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_option_exercise_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

aaidstring

Aaid. Filters results by Aaid.

directionstring

Position Side. Filters results by Position Side.

1 · Long2 · Short

counter_idstring

Option Counter Id. Filters results by Option Counter Id.

statusstring

Status. Filters results by Status.

Allowed values: Init, Exercising, PartiallyExercised, Exercised, ExerciseFailed (ExerciseAborted)

InitExercisingPartiallyExercisedExercisedExerciseFailed

exercisable_idstring

Exercisable Id. Filters results by Exercisable Id.

exercise_datestring

Exercise Date. Filters results by Exercise Date.

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 Exercise 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

List. Returned value: List of list.

Child attributes

idstring

Id. Returned value: Unique identifier of the current record.

counter_idstring

Option Counter Id. Returned value: Option Counter Id.

counter_id_valstring

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

exercise_datestring

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

numstring

Total Position. Returned value: Total Position.

exercised_numstring

Exercise Quantity Completed. Returned value: Exercise Quantity Completed.

expired_numstring

Invalid Exercise Quantity. Returned value: Invalid Exercise Quantity.

left_numstring

Pending Exercise Quantity. Returned value: Pending Exercise Quantity.

aaidstring

Aaid. Returned value: Aaid.

aaid_valstring

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

strike_pricestring

Strike Price. Returned value: Strike Price.

close_pricestring

Underlying Stock Settlement Price. Returned value: Underlying Stock Settlement Price.

typestring

Type. Returned value: Type.

type_valstring

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

option_exercise_cashstring

Option Exercise Cash. Returned value: Option Exercise Cash.

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.

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_records' \
  --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": [
      {
        "id": "220652",
        "counter_id": "OP/US/QQQ251103C634000",
        "counter_id_val": "",
        "exercise_date": "2025-11-03",
        "num": "10",
        "exercised_num": "10",
        "expired_num": "0",
        "left_num": "0",
        "aaid": "H00000000",
        "aaid_val": "",
        "strike_price": "634",
        "close_price": "633.32",
        "type": "ExerciseDueDate",
        "type_val": "1",
        "option_exercise_cash": "634000",
        "status": "Exercised",
        "status_val": "Exercised"
      }
    ],
    "total": 15191
  }
}