Skip to content

options.iv

Adds standardized at-the-money implied-volatility columns to an immutable query builder. Calling .iv() without arguments selects every tenor.

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
    .iv(['1m', '3m'])
    .for({
      coins: ['BTC'],
    })
    .over({
      last: '1D',
      resolution: '1h',
    }),
);
 
const rows = data.rows();

Definition

function iv(): OptionsBuilder<C | OptionsIvColumn>;
 
function iv<T extends OptionsIvTenor>(
  tenors: readonly T[],
): OptionsBuilder<C | OptionsIvColumn<T>>;

Parameters

tenors

Type: readonly OptionsIvTenor[]
Optional
Default: ['1w', '1m', '3m', '6m']

Tenor	Selected column
`1w`	`iv_1w`
`1m`	`iv_1m`
`3m`	`iv_3m`
`6m`	`iv_6m`

Return Type

Type: OptionsBuilder<C | OptionsIvColumn<T>>

Returns a builder typed with the accumulated columns.