Skip to content
Longport Whale
Expiring Option Details

Expiry Options Export

Export the Expiry Options list to a file. In sync mode (mode:0) the download URL is returned directly; in async mode (mode:1) a file_download_id is returned, to be polled via the shared GET/DELETE /v1/datasets/download/{id} endpoint for status and the final download URL.

POSThttps://b-api.longbridge.xyz/v1/datasets/holding_end_of_day_options/download

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters. Same fields as the filters of holding_end_of_day_options.yaml (the query capability).

Child attributes
filters.aaidstring

Aaid

filters.trading_directionstring

Position Direction. Multi-select; submit as a comma-joined string. Allowed values are listed under enum.. Options: long call = Long Call; short call = Short Call; long put = Long Put; short put = Short Put

long callshort calllong putshort put

filters.option_idstring

Option Id

filters.price_statusstring

Price Status. Multi-select; submit as a comma-joined string. Allowed values are listed under enum.. Options: 1 = In the money; 2 = Out of the money; 0 = All

120

filters.margin_call_statusstring

Margin Call Status. Multi-select; submit as a comma-joined string. Allowed values are listed under enum.. Options: 0 = Not Triggered; 1 = Margin Call; 2 = Forceselling Call; 5 = Over Financing Call (Financing > Credit Limit); 7 = Option Exercise Force Call; 8 = Option Exercise Margin Call

012578

filters.is_exercise_preparestring

Cover Status. Multi-select; submit as a comma-joined string. Allowed values are listed under enum.. Options: 1 = Covered; 2 = Not Covered

12

filters.price_percent_sortstring

IMT Percentage(%)

orderByarray<object>

Order By

modeinteger

Mode. Defaults to 0 (sync) when omitted.. Options: 0 = Sync; 1 = Async

01

extstring

Ext. Supports csv/xlsx; defaults to csv.

csvxlsx

file_namestring

File Name

remarkstring

Remark

down_fieldsarray<string>

Down Fields. When omitted, all fields are exported; allowed values are listed under items.enum (the same field list as the query endpoint's data.list.items).

ticket_contentstring

Ticket Content. Shown to the approver when the template has a download-approval ticket configured.

ticket_preview_urlstring

Ticket Preview URL

hideinteger

Hide. Options: 0 = Not Hidden; 1 = Hidden

01

Responses

HTTP 200Export result. In sync mode the download URL is returned directly; in async mode a file_download_id is returned for subsequent polling.
Standard response envelopecodemessagedata
dataobjectdata structure
urlstring

Download URL. Returned in sync mode (mode:0); empty in async mode.

file_download_idstring

File Download ID. Returned in async mode (mode:1); used to poll GET/DELETE /v1/datasets/download/{id}.

ticket_idstring

Ticket ID

Whale Docs