options.terms

Builds an immutable, validated request for the BTC or ETH implied-volatility term structure.

Imports

import { Velo } from 'velo-sdk';

Examples

import { Velo, options } from 'velo-sdk';
 
const velo = new Velo({ apiKey: process.env.VELO_API_KEY! });
 
const points = await velo.query(
  options.terms({ coins: ['BTC', 'ETH'] }),
);

Definition

function terms(params: TermsParams): OptionsTermsBuilder;

Parameters

params

• Type: TermsParams

params.coins

• Type: readonly ('BTC' | 'ETH')[]

One or both supported coins.

Return Type

• Type: OptionsTermsBuilder

Returns an immutable request builder. Pass it to velo.query() to resolve TermPoint[], or to velo.stream() to iterate TermPoint items.

TermPoint