Skip to content
Velo

futures.price

Adds futures price columns to a query builder. Calling .price() without arguments selects all four OHLC 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
    .price(['close'])
    .for({
      products: ['BTCUSDT'],
    })
    .over({
      last: '1D',
      resolution: '1h',
    }),
);
 
const rows = data.rows();

Definition

function price(): FuturesBuilder<C | FuturesPriceColumn>;
 
function price<P extends FuturesPricePart>(
  parts: readonly P[],
): FuturesBuilder<C | FuturesPriceColumn<P>>;

Parameters

parts

  • Type: readonly FuturesPricePart[]
  • Optional
  • Default: ['open', 'high', 'low', 'close']

Return Type

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

Returns a builder typed with the accumulated columns.