client.termStructure

Fetches the latest BTC or ETH implied-volatility term structure.

Imports

const velo = require('velo-node')

Example

const velo = require('velo-node')
 
async function main() {
  const client = new velo.Client('api_key')
  const points = await client.termStructure({
    coins: ['BTC', 'ETH']
  })
 
  console.log(points)
}
 
main()

Definition

termStructure(params): Promise<Object[]>

Parameters

params

Type: Object

params.coins

Type: string[]

One or both supported coins: "BTC" and "ETH".

Return Type

Type: Promise<Object[]>

Resolves to the latest matching term-structure points.

Property	Type	Description
`coin`	`string`	The underlying coin: `BTC` or `ETH`.
`time`	`number`	Snapshot timestamp in milliseconds.
`at_the_money_iv`	`number`	At-the-money implied volatility.
`dte`	`number`	Days to expiration.
`fwd_iv`	`number`	Forward implied volatility.

Historical term-structure values are not returned by this method.