list_instruments

function backtide.data.list_instruments(instrument_type, exchange=None, limit=100, verbose=True)

List available instruments for a given instrument type.

When exchanges is provided, the limit is distributed evenly across the specified exchanges.

Parameters

instrument_type : str | InstrumentType

For which instrument type to list the instruments.

exchange : str | Exchange | list[str | Exchange] | None, default=None

Optional exchange filter. If None, a default list of major exchanges is used. If specified, only query those exchanges and distribute limit evenly across them. This parameter is ignored for single-exchange providers.

limit : int, default=100

Maximum number of instruments to return. The actual number may be smaller, but not larger.

verbose : bool, default=True

Whether to display a progress spinner in the terminal.

Returns

list[Instrument]

Instruments for the given instrument type.

Example

>>> from backtide.data import list_instruments

>>> print(list_instruments("crypto", limit=5))

[Instrument(symbol="BTC-USD", name="Bitcoin USD", base="BTC", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="ETH-USD", name="Ethereum USD", base="ETH", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="USDT-USD", name="Tether USDt USD", base="USDT", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="BNB-USD", name="BNB USD", base="BNB", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="XRP-USD", name="XRP USD", base="XRP", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="USDC-USD", name="USDC USD", base="USDC", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="SOL-USD", name="Solana USD", base="SOL", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="TRX-USD", name="TRON USD", base="TRX", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="STETH-USD", name="Lido Staked ETH USD", base="STETH", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="DOGE-USD", name="Dogecoin USD", base="DOGE", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="HYPE32196-USD", name="Hyperliquid USD", base="HYPE32196", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="USDS33039-USD", name="USDS USD", base="USDS33039", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="LEO-USD", name="UNUS SED LEO USD", base="LEO", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="WSTETH-USD", name="Lido wstETH USD", base="WSTETH", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="WBTC-USD", name="Wrapped Bitcoin USD", base="WBTC", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="ADA-USD", name="Cardano USD", base="ADA", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="ZEC-USD", name="Zcash USD", base="ZEC", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="WBETH-USD", name="Wrapped Beacon ETH USD", base="WBETH", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="BCH-USD", name="Bitcoin Cash USD", base="BCH", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="WETH-USD", name="WETH USD", base="WETH", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="XMR-USD", name="Monero USD", base="XMR", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="LINK-USD", name="Chainlink USD", base="LINK", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="CBBTC32994-USD", name="Coinbase Wrapped BTC USD", base="CBBTC32994", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="CC37263-USD", name="Canton USD", base="CC37263", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="DAI-USD", name="Dai USD", base="DAI", quote="USD", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="BTC-EUR", name="Bitcoin EUR", base="BTC", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="ETH-EUR", name="Ethereum EUR", base="ETH", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="USDT-EUR", name="Tether USDt EUR", base="USDT", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="BNB-EUR", name="BNB EUR", base="BNB", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="XRP-EUR", name="XRP EUR", base="XRP", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="USDC-EUR", name="USDC EUR", base="USDC", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="SOL-EUR", name="Solana EUR", base="SOL", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="TRX-EUR", name="TRON EUR", base="TRX", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="DOGE-EUR", name="Dogecoin EUR", base="DOGE", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="ADA-EUR", name="Cardano EUR", base="ADA", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="ZEC-EUR", name="Zcash EUR", base="ZEC", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="BCH-EUR", name="Bitcoin Cash EUR", base="BCH", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="XMR-EUR", name="Monero EUR", base="XMR", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="LINK-EUR", name="Chainlink EUR", base="LINK", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="DAI-EUR", name="Dai EUR", base="DAI", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="XLM-EUR", name="Stellar EUR", base="XLM", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="LTC-EUR", name="Litecoin EUR", base="LTC", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="AVAX-EUR", name="Avalanche EUR", base="AVAX", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="HBAR-EUR", name="Hedera EUR", base="HBAR", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="SHIB-EUR", name="Shiba Inu EUR", base="SHIB", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="CRO-EUR", name="Cronos EUR", base="CRO", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="UNI7083-EUR", name="Uniswap EUR", base="UNI7083", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="DOT-EUR", name="Polkadot EUR", base="DOT", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="ICP-EUR", name="Internet Computer EUR", base="ICP", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="ETC-EUR", name="Ethereum Classic EUR", base="ETC", quote="EUR", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="BTC-GBP", name="Bitcoin GBP", base="BTC", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="ETH-GBP", name="Ethereum GBP", base="ETH", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="USDT-GBP", name="Tether USDt GBP", base="USDT", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="BNB-GBP", name="BNB GBP", base="BNB", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="XRP-GBP", name="XRP GBP", base="XRP", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="USDC-GBP", name="USDC GBP", base="USDC", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="SOL-GBP", name="Solana GBP", base="SOL", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="TRX-GBP", name="TRON GBP", base="TRX", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="DOGE-GBP", name="Dogecoin GBP", base="DOGE", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="ADA-GBP", name="Cardano GBP", base="ADA", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="ZEC-GBP", name="Zcash GBP", base="ZEC", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="BCH-GBP", name="Bitcoin Cash GBP", base="BCH", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="XMR-GBP", name="Monero GBP", base="XMR", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="LINK-GBP", name="Chainlink GBP", base="LINK", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="DAI-GBP", name="Dai GBP", base="DAI", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="XLM-GBP", name="Stellar GBP", base="XLM", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="LTC-GBP", name="Litecoin GBP", base="LTC", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="AVAX-GBP", name="Avalanche GBP", base="AVAX", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="HBAR-GBP", name="Hedera GBP", base="HBAR", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="SHIB-GBP", name="Shiba Inu GBP", base="SHIB", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="CRO-GBP", name="Cronos GBP", base="CRO", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="UNI7083-GBP", name="Uniswap GBP", base="UNI7083", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="DOT-GBP", name="Polkadot GBP", base="DOT", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="ICP-GBP", name="Internet Computer GBP", base="ICP", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo), Instrument(symbol="ETC-GBP", name="Ethereum Classic GBP", base="ETC", quote="GBP", instrument_type="crypto", exchange="CCC", provider=Yahoo)]