HomeDocumentationAPI Reference
Log In

Get Liquidation History

Method Name

private/get_liquidation_history

TODO description

Parameters

subaccount_id integer required
Subaccount id
end_timestamp integer
End timestamp of the event history (default current time)
start_timestamp integer
Start timestamp of the event history (default 0)

Response

id string or integer required
result array of objects required
result[].auction_id string required
Unique ID of the auction
result[].auction_type string required
Type of auction
enum solvent insolvent
result[].end_timestamp integer or null required
Timestamp of the auction end (in ms since UNIX epoch), or null if not ended
result[].fee string required
Fee paid by the subaccount
result[].start_timestamp integer required
Timestamp of the auction start (in ms since UNIX epoch)
result[].subaccount_id integer required
Liquidated subaccount ID
result[].tx_hash string required
Hash of the transaction that started the auction
result[].bids array of objects required
List of auction bid events
result[].bids[].cash_received string required
Cash received by the subaccount for the liquidation. For the liquidated accounts this is the amount the liquidator paid to buy out the percentage of the portfolio. For the liquidator account, this is the amount they received from the security module (if positive) or the amount they paid for the bid (if negative)
result[].bids[].discount_pnl string required
Realized PnL due to liquidating or being liquidated at a discount to mark portfolio value
result[].bids[].percent_liquidated string required
Percent of the subaccount that was liquidated
result[].bids[].realized_pnl string required
Realized PnL of the auction bid, assuming positions are closed at mark price at the time of the liquidation
result[].bids[].realized_pnl_excl_fees string required
Realized PnL of the auction bid, excluding fees from total cost basis, assuming positions are closed at mark price at the time of the liquidation
result[].bids[].timestamp integer required
Timestamp of the bid (in ms since UNIX epoch)
result[].bids[].tx_hash string required
Hash of the bid transaction
result[].bids[].amounts_liquidated object required
Amounts of each asset that were closed
result[].bids[].positions_realized_pnl object required
Realized PnL of each position that was closed
result[].bids[].positions_realized_pnl_excl_fees object required
Realized PnL of each position that was closed, excluding fees from total cost basis

Example

{request_example_shell}
{request_example_javascript}
{request_example_python}

The above command returns JSON structured like this:

{response_example_json}