Skip to content
Velo

futures.fundingRate

Adds futures funding-rate columns to an immutable query builder. Calling .fundingRate() without arguments selects both the rate and average columns.

Funding rates reflect rates as they update, rather than the rates at the last funding payment interval. These are sometimes called “predicted funding rates.” All funding rates are normalized to an eight-hour interval.

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
    .fundingRate(['average'])
    .for({
      products: ['BTCUSDT'],
    })
    .over({
      last: '1D',
      resolution: '1h',
    }),
);
 
const rows = data.rows();

Definition

function fundingRate(): FuturesBuilder<C | FuturesFundingRateColumn>;
 
function fundingRate<P extends FuturesFundingRatePart>(
  parts: readonly P[],
): FuturesBuilder<C | FuturesFundingRateColumn<P>>;

Parameters

parts

  • Type: readonly FuturesFundingRatePart[]
  • Optional
  • Default: ['rate', 'average']
PartSelected column
ratefunding_rate
averagefunding_rate_avg

Return Type

  • Type: FuturesBuilder<C | FuturesFundingRateColumn<P>>

Returns a builder typed with the accumulated columns.