The Instrument object

symbol

string

Canonical symbol, such as HYPERLIQUID:BTC. Runs and events report instruments by this

short

string

Short symbol, such as BTC

name

string

Full name, such as Bitcoin Perpetual (Hyperliquid)

category

string

The market category, such as crypto, fx, index or commodities

tick_size

number

Smallest price step. Left out when not set

contract_multiplier

number

The instrument's contract multiplier. Left out when not set

order_flow

boolean

true when volume-tape scripts, such as footprint and delta, can run on it

coverage

object

The range your plan can run on. Fields below

sessions

array of object

The instrument's trading sessions. Left out when it has none, as crypto instruments trade around the clock. Fields below

start

string

The later of your plan's history start and the instrument's first data

end

string or null

The instrument's last available data, or null when not recorded

start

string

Session start time

end

string

Session end time

session_type

string

REGULAR, HOLIDAY, PRE_MARKET, POST_MARKET or OUT_OF_HOURS

spread_type

string

FIXED or VARIABLE

spread_as_ticks

number

The spread in ticks when spread_type is FIXED

volume_to_spread_as_ticks

object

The spread in ticks for each volume level, LOW, MEDIUM or HIGH, when spread_type is VARIABLE