Skip to content

options.skew

Adds standardized 25-delta skew columns to an immutable query builder. Calling .skew() 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
    .skew(['1m', '3m'])
    .for({
      coins: ['BTC'],
    })
    .over({
      last: '1D',
      resolution: '1h',
    }),
);
 
const rows = data.rows();

Definition

function skew(): OptionsBuilder<C | OptionsSkewColumn>;
 
function skew<T extends OptionsSkewTenor>(
  tenors: readonly T[],
): OptionsBuilder<C | OptionsSkewColumn<T>>;

Parameters

tenors

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

Tenor	Selected column
`1w`	`skew_1w`
`1m`	`skew_1m`
`3m`	`skew_3m`
`6m`	`skew_6m`

Return Type

Type: OptionsBuilder<C | OptionsSkewColumn<T>>

Returns a builder typed with the accumulated columns.