Struct Liquidation 

pub struct Liquidation {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Liquidation

pub fn get( &self, exchange: impl Into<String>, symbol: impl Into<String>, options: LiquidationOptions, ) -> Result<Value>

Fetch recent liquidation events for a futures symbol on a given exchange, newest first.

pub fn feed(&self, options: LiquidationFeedOptions) -> Result<Value>

Fetch most recent liquidation events across all futures symbols, newest first. Use together with the /ws/v1/liquidation/feed firehose for a live feed view.

pub fn heatmap(&self, options: LiquidationHeatmapOptions) -> Result<Value>

Aggregated long/short liquidation USD by (token, exchange) over a rolling window. Result is cached for ~10s. Sub-1h windows are not supported (in-memory buckets are 30min); use the WS feed for finer granularity.

pub fn map( &self, base: impl Into<String>, options: LiquidationMapOptions, ) -> Result<Value>

Coinglass-style liquidation map for one perpetual pair. Returns a price-grid breakdown of where leveraged positions would be liquidated, split by leverage tier (10x / 25x / 50x / 100x) and side (long below current price, short above). Built from current OI + last-24h candle entries + a fixed leverage-cohort prior. Read the assumptions field in the response for the modelling disclaimer. Cached server-side (~5s) so back-to-back polls are cheap.

pub fn symbol_history( &self, symbol: impl Into<String>, options: LiquidationSymbolHistoryOptions, ) -> Result<Value>

Bucketed long / short liquidation USD over time for a single (base, quote) pair, joined with the futures-candle close as a reference price line. Long/short USD comes from cex.liquidation (Side=‘sell’ = long position liquidated, ‘buy’ = short). Price comes from candle.futures_1m on the requested exchange — or Binance as the reference when none is specified. Cached ~30s server-side.

Trait Implementations

impl Clone for Liquidation

fn clone(&self) -> Liquidation

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Datamaxi for Liquidation

fn new(api_key: String) -> Liquidation

Creates a new instance of the implementing type using the provided API key.

fn new_with_base_url(api_key: String, base_url: String) -> Liquidation

Creates a new instance of the implementing type using the provided API key and base URL.