Method Name
private/get_option_settlement_history
private/get_option_settlement_historyGet expired option settlement history for a subaccount
Required minimum session key permission level is read_only
Parameters
| subaccount_id
integer
required
Subaccount ID for which to get expired option settlement history |
Response
| id
string or integer
required
|
| result
object
required
|
| result.subaccount_id
integer
required
Subaccount_id for which to get expired option settlement history |
| result.settlements
array of objects
required
List of expired option settlements |
| result.settlements[].amount
string
required
Amount that was settled |
| result.settlements[].expiry
integer
required
Expiry timestamp of the option |
| result.settlements[].instrument_name
string
required
Instrument name |
| result.settlements[].option_settlement_pnl
string
required
USD profit or loss from option settlements calculated as: settlement value - (average cost including fees x amount) |
| result.settlements[].option_settlement_pnl_excl_fees
string
required
USD profit or loss from option settlements calculated as: settlement value - (average price excluding fees x amount) |
| result.settlements[].settlement_price
string
required
Price of option settlement |
| result.settlements[].subaccount_id
integer
required
Subaccount ID of the settlement event |
Example
{request_example_shell}
{request_example_javascript}
{request_example_python}
The above command returns JSON structured like this:
{response_example_json}