Skip to content
Velo

futures.liquidations

Adds futures liquidation-count columns to an immutable query builder. Calling .liquidations() without arguments selects both buy and sell counts.

Imports

import { Velo } from 'velo-sdk';

Examples

import { Velo, futures } from 'velo-sdk';
 
const velo = new Velo({ apiKey: process.env.VELO_API_KEY! });
 
const data = await velo.query(
  futures
    .liquidations(['sell'])
    .for({
      products: ['BTCUSDT'],
    })
    .over({
      last: '1D',
      resolution: '1h',
    }),
);
 
const rows = data.rows();

Definition

function liquidations(): FuturesBuilder<C | FuturesLiquidationColumn>;
 
function liquidations<P extends FuturesLiquidationPart>(
  parts: readonly P[],
): FuturesBuilder<C | FuturesLiquidationColumn<P>>;

Parameters

parts

  • Type: readonly FuturesLiquidationPart[]
  • Optional
  • Default: ['buy', 'sell']
PartSelected column
buybuy_liquidations
sellsell_liquidations

Return Type

  • Type: FuturesBuilder<C | FuturesLiquidationColumn<P>>

Returns a builder typed with the accumulated columns.