available

All indices available from a given provider.

Example

from openbb import obb
obb.index.available(provider="yfinance").to_df()

---

Parameters

• standard
• cboe
• fmp
• tmx
• yfinance

Name	Type	Description	Default	Optional
provider	Literal['cboe', 'fmp', 'tmx', 'yfinance']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.	cboe	True

Name	Type	Description	Default	Optional
provider	Literal['cboe', 'fmp', 'tmx', 'yfinance']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.	cboe	True
use_cache	bool	When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass.	True	True

Name	Type	Description	Default	Optional
provider	Literal['cboe', 'fmp', 'tmx', 'yfinance']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.	cboe	True

Name	Type	Description	Default	Optional
provider	Literal['cboe', 'fmp', 'tmx', 'yfinance']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.	cboe	True
use_cache	bool	Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False.	True	True

Name	Type	Description	Default	Optional
provider	Literal['cboe', 'fmp', 'tmx', 'yfinance']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.	cboe	True

---

Returns

OBBject
    results : List[AvailableIndices]
        Serializable results.

    provider : Optional[Literal['cboe', 'fmp', 'tmx', 'yfinance']]
        Provider name.

    warnings : Optional[List[Warning_]]
        List of warnings.

    chart : Optional[Chart]
        Chart object.

    extra : Dict[str, Any]
        Extra info.

---

Data

• standard
• cboe
• fmp
• tmx
• yfinance

Name	Type	Description
name	str	Name of the index.
currency	str	Currency the index is traded in.

Name	Type	Description
name	str	Name of the index.
currency	str	Currency the index is traded in.
symbol	str	Symbol for the index.
description	str	Description for the index. Valid only for US indices.
data_delay	int	Data delay for the index. Valid only for US indices.
open_time	datetime.time	Opening time for the index. Valid only for US indices.
close_time	datetime.time	Closing time for the index. Valid only for US indices.
time_zone	str	Time zone for the index. Valid only for US indices.
tick_days	str	The trading days for the index. Valid only for US indices.
tick_frequency	str	The frequency of the index ticks. Valid only for US indices.
tick_period	str	The period of the index ticks. Valid only for US indices.

Name	Type	Description
name	str	Name of the index.
currency	str	Currency the index is traded in.
stock_exchange	str	Stock exchange where the index is listed.
exchange_short_name	str	Short name of the stock exchange where the index is listed.

Name	Type	Description
name	str	Name of the index.
currency	str	Currency the index is traded in.
symbol	str	The ticker symbol of the index.

Name	Type	Description
name	str	Name of the index.
currency	str	Currency the index is traded in.
code	str	ID code for keying the index in the OpenBB Terminal.
symbol	str	Symbol for the index.