client.spot

Fetches Velo's spot 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.spot()
  const delisted = await client.spot(true)
}
 
main()

Definition

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

Parameters

delisted

Type: boolean
Optional
Default: false

When true, returns delisted-only spot products.

Return Type

Type: Promise<Object[]>

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

Property	Type	Description
`exchange`	`string`	The exchange and spot market.
`coin`	`string`	The Velo-aggregated coin symbol.
`product`	`string`	The exchange-native product symbol.
`begin`	`number`	First available timestamp in milliseconds.
`end`	Optional `number`	Last available timestamp for a delisted product.