futures.liquidationVolume

Adds futures liquidation-volume columns to an immutable query builder. Calling .liquidationVolume() without arguments selects all dollar-volume columns.

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
    .liquidationVolume(['total'], { metric: 'coin' })
    .for({
      products: ['BTCUSDT'],
    })
    .over({
      last: '1D',
      resolution: '1h',
    }),
);
 
const rows = data.rows();

Definition

function liquidationVolume(
): FuturesBuilder<C | FuturesLiquidationVolumeColumn<'dollar'>>;
 
function liquidationVolume<M extends FuturesLiquidationVolumeMetric>(
  options: { readonly metric: M },
): FuturesBuilder<C | FuturesLiquidationVolumeColumn<M>>;
 
function liquidationVolume<P extends FuturesLiquidationVolumePart>(
  parts: readonly P[],
): FuturesBuilder<C | FuturesLiquidationVolumeColumn<'dollar', P>>;
 
function liquidationVolume<
  P extends FuturesLiquidationVolumePart,
  M extends FuturesLiquidationVolumeMetric,
>(
  parts: readonly P[],
  options: { readonly metric: M },
): FuturesBuilder<C | FuturesLiquidationVolumeColumn<M, P>>;

Parameters

parts

Type: readonly FuturesLiquidationVolumePart[]
Optional
Default: ['buy', 'sell', 'total']

Part	`coin` column	`dollar` column
`buy`	`buy_liquidations_coin_volume`	`buy_liquidations_dollar_volume`
`sell`	`sell_liquidations_coin_volume`	`sell_liquidations_dollar_volume`
`total`	`liquidations_coin_volume`	`liquidations_dollar_volume`

options

Type: { readonly metric: 'coin' | 'dollar' }
Optional
Default: { metric: 'dollar' }

Selects whether liquidation volume is measured in coins or dollars.

Return Type

Type: FuturesBuilder<C | FuturesLiquidationVolumeColumn<M, P>>

Returns a builder typed with the accumulated columns.