Skip to content

Instrument


dataclass backtide.data.Instrument

A tradeable financial instrument.

Each instrument is uniquely identified by a symbol and belongs to exactly one instrument type.

Attributes

symbol : str

Ticker symbol as used on the exchange.

name : str
Human-readable name of the instrument.

base : str | Currency | None
The currency of the tradeable instrument. Only defined for forex and crypto pairs.

quote : str | Currency
The currency the instrument trades on.

instrument_type : InstrumentType
Instrument type this instrument belongs to.

exchange : str | Exchange
The exchange this instrument is listed in.

provider : Provider
The data provider that sourced this instrument.


See Also

Bar

A single OHLCV candle for one symbol at one interval.

InstrumentProfile

A wrapper around an instrument with additional metadata.

Interval

The time resolution of a single Bar.