Options Exercise Overview

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

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Request body application/json

filtersobject

Filters

Child attributes

filters.due_datestring

Exercised Date

filters.statusstring

Status. Options: handled = Processed; waittohandle = Pending; waittocheck = Waittocheck

handledwaittohandlewaittocheck

filters.settlement_channel_codestring

Settlement Channel. Options: 3 = Ib; 26 = Atomic

326

pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List

totalintegerrequired

Total

Request

curl --request POST \
  --url 'https://b-api.longbridge.xyz/v1/datasets/risk_option_exercise_overview' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20,
  "orderBy": []
}'

Response

{
  "code": 0,
  "message": null,
  "data": {
    "list": [
      {
        "due_date": "<string>",
        "status": "<string>",
        "option_count": "<string>",
        "total_option_holding_num": "<string>",
        "exercised_option_count": "<string>",
        "advance_exercise_option_count": "<string>",
        "expired_option_count": "<string>",
        "partially_exercised_option_count": "<string>",
        "handled_option_count": "<string>",
        "settlement_channel_code": "<string>"
      }
    ],
    "total": 0
  }
}