Expiry Options

Queries Expiry Options 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/holding_end_of_day_options

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

aaidstring

Aaid. Filters results by Aaid.

trading_directionstring

Position Direction. Filters results by Position Direction.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

long call · Long Callshort call · Short Calllong put · Long Putshort put · Short Put

option_idstring

Option Id. Filters results by Option Id.

price_statusstring

Price Status. Filters results by Price Status.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

1 · In the money2 · Out of the money0 · All

margin_call_statusstring

Margin Call Status. Filters results by Margin Call Status.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

0 · Not Triggered1 · Margin Call2 · Forceselling Call5 · Over Financing Call (Financing > Credit Limit)7 · Option Exercise Force Call8 · Option Exercise Margin Call

is_exercise_preparestring

Cover Status. Filters results by Cover Status.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

1 · Covered2 · Not Covered

price_percent_sortstring

IMT Percentage(%). Filters results by IMT Percentage(%).

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 Expiry Options 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

aaidstring

A/C No.. Returned value: A/C No..

aaid_valstring

A/C No. (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.

margin_call_statusstring

Margin Call Status. Returned value: Margin Call Status.

margin_call_status_valstring

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

is_exercise_preparestring

Cover Status. Returned value: Indicates whether cover status.

is_exercise_prepare_valstring

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

trading_directionstring

Position Direction. Returned value: Position Direction.

trading_direction_valstring

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

option_idstring

Option Code. Returned value: Option Code.

option_amtstring

Number Of Options. Returned value: Number Of Options.

end_datestring

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

rights_exercise_pricestring

Strike Price (USD). Returned value: Strike Price (USD).

market_pricestring

Stock Market Price (USD). Returned value: Stock Market Price (USD).

total_assetstring

NAV(USD). Returned value: NAV(USD).

price_statusstring

In/Out. Returned value: In/Out.

price_status_valstring

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

price_percentstring

IMT Percentage. Returned value: IMT Percentage.

created_atstring

Created At. Returned value: Created At. The date or time format follows the value returned by the API.

settlement_channelstring

Settlement Channel. Returned value: Settlement Channel.

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/holding_end_of_day_options' \
  --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": [
      {
        "aaid": "H00000000",
        "aaid_val": "",
        "margin_call_status": "Not Triggered",
        "margin_call_status_val": "0",
        "is_exercise_prepare": "Not Covered",
        "is_exercise_prepare_val": "false",
        "trading_direction": "Long Put",
        "trading_direction_val": "long put",
        "option_id": "OP/US/AAPL250912P227500",
        "option_amt": "100",
        "end_date": "20250912",
        "rights_exercise_price": "227.5",
        "market_price": "327.5",
        "total_asset": "1,126,582,878.48",
        "price_status": "OTM",
        "price_status_val": "2",
        "price_percent": "%",
        "created_at": "1764311213",
        "settlement_channel": "ib_hk"
      }
    ],
    "total": 2430
  }
}