options.delta

Adds options delta columns to an immutable query builder. Calling .delta() without arguments selects call and put delta in dollars.

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

Definition

function delta(): OptionsBuilder<C | OptionsDeltaColumn<'dollar'>>;
 
function delta<M extends OptionsDeltaMetric>(
  options: { readonly metric: M },
): OptionsBuilder<C | OptionsDeltaColumn<M>>;
 
function delta<P extends OptionsDeltaPart>(
  parts: readonly P[],
): OptionsBuilder<C | OptionsDeltaColumn<'dollar', P>>;
 
function delta<
  P extends OptionsDeltaPart,
  M extends OptionsDeltaMetric,
>(
  parts: readonly P[],
  options: { readonly metric: M },
): OptionsBuilder<C | OptionsDeltaColumn<M, P>>;

Parameters

parts

Type: readonly OptionsDeltaPart[]
Optional
Default: ['call', 'put']

Part	`coin` column	`dollar` column
`call`	`call_delta_coins`	`call_delta_dollars`
`put`	`put_delta_coins`	`put_delta_dollars`

options

Type: { readonly metric: 'coin' | 'dollar' }
Optional
Default: { metric: 'dollar' }

Selects whether delta is measured in coins or dollars.

Return Type

Type: OptionsBuilder<C | OptionsDeltaColumn<M, P>>

Returns a builder typed with the accumulated columns.