HomeDocumentationAPI Reference
Log In
API Reference

Liquidate

Liquidates a given subaccount using funds from another subaccount. This endpoint has a few limitations:
1. If succesful, the RPC will freeze the caller's subaccount until the bid is settled or is reverted on chain.
2. The caller's subaccount must not have any open orders.
3. The caller's subaccount must have enough withdrawable cash to cover the bid and the buffer margin requirements. Required minimum session key permission level is admin

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Amount of cash to transfer to a newly created subaccount for bidding. Must be non-negative.

integer
required

Last seen trade ID for account being liquidated. Not checked if set to 0.

integer
required

Subaccount ID of the account to be liquidated.

integer
required

Unique nonce defined as (UTC_timestamp in ms)(random_number_up_to_6_digits) (e.g. 1695836058725001, where 001 is the random number)

string
required

Percent of the liquidated position to bid for. Will bid for the maximum possible percent of the position if set to 1

string
required

Maximum amount of cash to be paid from bidder to liquidated account (supports negative amounts for insolvent auctions). Not checked if set to 0.

string
required

Ethereum signature of the order

integer
required

Unix timestamp in seconds. Order signature becomes invalid after this time, and the system will cancel the order.Expiry MUST be at least 5 min from now.

string
required

Owner wallet address or registered session key that signed order

integer
required

Subaccount ID owned by wallet, that will be doing the bidding.

Response

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json