Liquidations

private/liquidate

Bids on an open liquidation auction. Names the bidder's own subaccount, the account being auctioned, the fraction of it to absorb as a whole percent (a multiple of 0.01), and a signed limit price. The limit is compared against the discounted price of the whole remaining account — the quote's estimated_bid_price — not against the cash the bid actually moves, and it is negative for an insolvent auction where the security module pays the bidder. The realized fill is capped at the auction's current maximum proportion, so it can land below the requested percent. Quote the auction first with public/get_live_auctions or the auctions.watch channel: both the price and the fraction on offer move with wall-clock and with the account's mark.

post/private/liquidate

Request

  • Base URL: https://api.derive.xyz/v3
  • URL: https://api.derive.xyz/v3/private/liquidate
  • Auth: none declared

Request body

liquidate_subaccount_idinteger required

Subaccount being liquidated.

noncestring required
percent_of_accstring decimal required

Fraction of the account to liquidate ("1.0" = 100%), decimal string or JSON number. Must be a whole percent, i.e. a multiple of "0.01".

price_limitstring decimal required

Max total cash paid for the filled portion; negative is a minimum payout in insolvent auctions. "0" opts out. Decimal string or JSON number.

signaturestring required
signature_expiry_secinteger required
signerstring required
subaccount_idinteger required

Bidder subaccount.

Response

Success

op_uuidstring required
operation_idinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.