Method Name
private/get_option_settlement_history
private/get_option_settlement_historyGet expired option settlement history for a subaccount or wallet.
If wallet is provided, returns settlements for all subaccounts belonging to that wallet.
Required minimum session key permission level is read_only
Parameters
| subaccount_idinteger Subaccount ID for which to get expired option settlement history |
| walletstring Wallet address (if set, returns settlements for all subaccounts) |
Response
| idstring or integerrequired |
| resultobjectrequired |
| result.settlementsarray of objectsrequired List of expired option settlements |
| result.settlements[].amountstringrequired Amount that was settled |
| result.settlements[].expiryintegerrequired Expiry timestamp of the option |
| result.settlements[].instrument_namestringrequired Instrument name |
| result.settlements[].option_settlement_pnlstringrequired USD profit or loss from option settlements calculated as: settlement value - (average cost including fees x amount) |
| result.settlements[].option_settlement_pnl_excl_feesstringrequired USD profit or loss from option settlements calculated as: settlement value - (average price excluding fees x amount) |
| result.settlements[].settlement_pricestringrequired Price of option settlement |
| result.settlements[].subaccount_idintegerrequired 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}