Auctions Watch

Channel Name Schema

`auctions.watch`

Subscribe to state of ongoing auctions.

Channel Parameters

Notification Data


channel string required Subscribed channel name
data array of objects required
data[].details object or null required Details of the auction, if ongoing.
data[].details.currency string or null required Currency of subaccount (for PM margin type).
data[].details.estimated_bid_price string required Estimated bid price for this liquidation. This value is not scaled by the bid percent, and instead represents the discounted mark value of the whole subaccount. This value will be negative for insolvent auctions.
data[].details.estimated_discount_pnl string required Estimated profit relative to `estimated_mtm` if the liquidation is successful, assuming execution at `estimated_percent_bid` and `estimated_bid_price`.
data[].details.estimated_mtm string required Estimated mark-to-market value of the subaccount being auctioned off. This value is not scaled by the bid percent, and instead represents the un-discounted mark value of the whole subaccount.
data[].details.estimated_percent_bid string required An estimate for the maximum percent of the subaccount that can be liquidated.
data[].details.last_seen_trade_id integer required Last trade ID for the account being auctioned off (to use in the `private/liquidate` endpoint). This value is used to ensure that the state of balances reported in `subaccount_balances` is in sync. A trade ID error from `private/liquidate` indicates that the channel is currently out of sync with the on-chain state of the subaccount due to a pending bid.
data[].details.margin_type string required Margin type of the subaccount being auctioned off. It is recommended to bid on subaccounts using the same margin type and currency as to not run into unsupported currency errors or maximum account size limits. enum `PM` `SM`
data[].details.min_cash_transfer string required Suggested minimum amount of cash to transfer to a newly created subaccount for bidding (to use in the `private/liquidate` endpoint). Any unused cash will get returned back to the original subaccount. If the bidder plans to bid less than the `estimated_percent_bid`, they may scale this value down accordingly.
data[].details.min_price_limit string required Estimated minimum `price_limit` (to use in the `private/liquidate` endpoint). This is the minimum amount of cash that would be required to buy out the percent of the subaccount. If the bidder plans to bid less than the `estimated_percent_bid`, they may scale this value down accordingly.
data[].details.subaccount_balances object required Current balances of the subaccount being auctioned off. The bidder should expect to receive a percentage of these balances proportional to the `estimated_percent_bid`, and pay `estimated_bid_price * estimated_percent_bid` for them. These balances already include any pending perp settlements and funding payments into the USDC balance.

data[].state string required State of the auction. enum `ongoing` `ended`
data[].subaccount_id integer required Subaccount ID being auctioned off.
data[].timestamp integer required Timestamp of the auction result (in milliseconds since epoch).

Example

Subscriptions are only available via websockets.

{request_example_javascript}

{request_example_python}

Notification messages on this channel will look like this:

{response_example_json}