catalog.options

Fetches the active options product catalog and optionally filters it by coin, product, or exchange.

Imports

import { Velo } from 'velo-sdk';

Examples

import { Velo, catalog } from 'velo-sdk';
 
const velo = new Velo({ apiKey: process.env.VELO_API_KEY! });
 
const products = await velo.query(
  catalog.options({
    coin: 'BTC',
    exchange: 'deribit',
  }),
);

Definition

function options(params?: OptionsCatalogParams): OptionsCatalogBuilder;

Parameters

params

Type: OptionsCatalogParams
Optional

Property	Type	Description
`coin`	`string`	Matches a Velo-aggregated coin symbol.
`product`	`string`	Matches an exchange-native product symbol.
`exchange`	`OptionsExchange`	Matches an options exchange. Currently accepts `deribit`.

coin and product are mutually exclusive. All filters are exact and case-insensitive. The options catalog does not support a delisted parameter.

Return Type

Type: OptionsCatalogBuilder

Returns an immutable request builder.

Passing it to velo.query() resolves to OptionProduct[]: an array of matching catalog products, or an empty array when no products match. Per-request timeout, retry, and abort-signal options (HttpRequestOptions) are supplied as the second argument to velo.query().

Property	Type	Description
`exchange`	`OptionsExchange`	The exchange and options market.
`coin`	`string`	The Velo-aggregated coin symbol.
`product`	`string`	The exchange-native product symbol.
`begin`	`number`	First available timestamp in milliseconds.