Exercise List · Whale Docs

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters

Child attributes

filters.aaidstring

Aaid

filters.directionstring

Position Side. Options: 1 = Long; 2 = Short

12

filters.counter_idstring

Option Counter Id

filters.statusstring

Status. Options: Init = Init; Exercising = Exercising; PartiallyExercised = PartiallyExercised; Exercised = Exercised; ExerciseFailed = ExerciseAborted

InitExercisingPartiallyExercisedExercisedExerciseFailed

filters.exercisable_idstring

Exercisable Id

filters.exercise_datestring

Exercise Date

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_records' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20,
  "orderBy": []
}'

Response

{
  "code": 0,
  "message": null,
  "data": {
    "list": [
      {
        "id": "<string>",
        "counter_id": "<string>",
        "exercise_date": "<string>",
        "num": "<string>",
        "exercised_num": "<string>",
        "expired_num": "<string>",
        "left_num": "<string>",
        "aaid": "<string>",
        "strike_price": "<string>",
        "close_price": "<string>",
        "type": "<string>",
        "option_exercise_cash": "<string>",
        "status": "<string>"
      }
    ],
    "total": 0
  }
}