futures.premium

Adds the futures premium column to an immutable query builder.

Imports

import { Velo } from 'velo-sdk';

Examples

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

Definition

function premium(): FuturesBuilder<C | FuturesPremiumColumn>;

Parameters

None.

Return Type

Type: FuturesBuilder<C | FuturesPremiumColumn>

Returns a builder typed with the accumulated columns.