Method Name
public/get_liquidation_history
public/get_liquidation_historyReturns a paginated liquidation history for all subaccounts. Note that the pagination is based on the number of
raw events that include bids, auction start, and auction end events. This means that the count returned in the
pagination info will be larger than the total number of auction events. This also means the number of returned
auctions per page will be smaller than the supplied page_size.
Parameters
| end_timestampinteger End timestamp of the event history in ms since Unix epoch (default current time) |
| pageinteger Page number of results to return (default 1, returns last if above num_pages) |
| page_sizeinteger Number of results per page (default 100, max 1000) |
| start_timestampinteger Start timestamp of the event history in ms since Unix epoch (default 0) |
| subaccount_idinteger (Optional) Subaccount ID |
Response
| idstring or integerrequired |
| resultobjectrequired |
| result.auctionsarray of objectsrequired List of auction results |
| result.auctions[].auction_idstringrequired Unique ID of the auction |
| result.auctions[].auction_typestringrequired Type of auction enum solventinsolvent |
| result.auctions[].end_timestampinteger or nullrequired Timestamp of the auction end (in ms since UNIX epoch), or null if not ended |
| result.auctions[].feestringrequired Fee paid by the subaccount |
| result.auctions[].start_timestampintegerrequired Timestamp of the auction start (in ms since UNIX epoch) |
| result.auctions[].subaccount_idintegerrequired Liquidated subaccount ID |
| result.auctions[].tx_hashstringrequired Hash of the transaction that started the auction |
| result.auctions[].bidsarray of objectsrequired List of auction bid events |
| result.auctions[].bids[].cash_receivedstringrequired 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.auctions[].bids[].discount_pnlstringrequired Realized PnL due to liquidating or being liquidated at a discount to mark portfolio value |
| result.auctions[].bids[].percent_liquidatedstringrequired Percent of the subaccount that was liquidated |
| result.auctions[].bids[].realized_pnlstringrequired Realized PnL of the auction bid, assuming positions are closed at mark price at the time of the liquidation |
| result.auctions[].bids[].realized_pnl_excl_feesstringrequired 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.auctions[].bids[].timestampintegerrequired Timestamp of the bid (in ms since UNIX epoch) |
| result.auctions[].bids[].tx_hashstringrequired Hash of the bid transaction |
| result.auctions[].bids[].amounts_liquidatedobjectrequired Amounts of each asset that were closed |
| result.auctions[].bids[].positions_realized_pnlobjectrequired Realized PnL of each position that was closed |
| result.auctions[].bids[].positions_realized_pnl_excl_feesobjectrequired Realized PnL of each position that was closed, excluding fees from total cost basis |
| result.paginationobjectrequired Pagination info |
| result.pagination.countintegerrequired Total number of items, across all pages |
| result.pagination.num_pagesintegerrequired Number of pages |
Example
{request_example_shell}{request_example_javascript}{request_example_python}The above command returns JSON structured like this:
{response_example_json}