client.futures

Fetches Velo's futures product catalog. Active products are returned by default.

Imports

const velo = require('velo-node')

Example

const velo = require('velo-node')
 
async function main() {
  const client = new velo.Client('api_key')
  const active = await client.futures()
  const delisted = await client.futures(true)
  const depthProducts = active.filter((product) => product.depth)
}
 
main()

Definition

futures(delisted = false): Promise<Object[]>

Parameters

delisted

• Type: boolean
• Optional
• Default: false

When true, returns delisted-only futures products.

Return Type

• Type: Promise<Object[]>

Resolves to an array of catalog products. An empty array is returned when no products match.