options.indexPrice

Adds the underlying index-price column to an immutable query builder.

Imports

import { Velo } from 'velo-sdk';

Examples

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

Definition

function indexPrice(
): OptionsBuilder<C | OptionsIndexPriceColumn>;

Parameters

None.

Return Type

Type: OptionsBuilder<C | OptionsIndexPriceColumn>

Returns a builder typed with the accumulated columns.