futures.volume

Adds futures volume columns to an immutable query builder. Calling .volume() 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
    .volume(['total'], { metric: 'coin' })
    .for({
      products: ['BTCUSDT'],
    })
    .over({
      last: '1D',
      resolution: '1h',
    }),
);
 
const rows = data.rows();

Definition

function volume(): FuturesBuilder<C | FuturesVolumeColumn<'dollar'>>;
 
function volume<M extends FuturesVolumeMetric>(
  options: { readonly metric: M },
): FuturesBuilder<C | FuturesVolumeColumn<M>>;
 
function volume<P extends FuturesVolumePart>(
  parts: readonly P[],
): FuturesBuilder<C | FuturesVolumeColumn<'dollar', P>>;
 
function volume<
  P extends FuturesVolumePart,
  M extends FuturesVolumeMetric,
>(
  parts: readonly P[],
  options: { readonly metric: M },
): FuturesBuilder<C | FuturesVolumeColumn<M, P>>;

Parameters

parts

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

Part	`coin` column	`dollar` column
`total`	`coin_volume`	`dollar_volume`
`buy`	`buy_coin_volume`	`buy_dollar_volume`
`sell`	`sell_coin_volume`	`sell_dollar_volume`

options

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

Selects whether volume is measured in coins or dollars.

Return Type

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

Returns a builder typed with the accumulated columns.