available

All indices available from a given provider.

Examples

from openbb import obb
obb.index.available(provider='fmp')
obb.index.available(provider='yfinance')

Parameters

• standard
• cboe
• fmp
• tmx
• yfinance

use_cache: bool
Default: True
When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass.

use_cache: bool
Default: True
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.

---

Returns

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

symbol: str
Symbol representing the entity requested in the data.

name: str
exchange: str
Stock exchange where the index is listed.

currency: str
Currency the index is traded in.

symbol: str
Symbol for the index.

name: str
exchange: str
Stock exchange where the index is listed.

currency: str
Currency the index is traded in.

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.

symbol: str
Symbol representing the entity requested in the data.

name: str
exchange: str
Stock exchange where the index is listed.

currency: str
Currency the index is traded in.

symbol: str
The ticker symbol of the index.

name: str
exchange: str
Stock exchange where the index is listed.

currency: str
Currency the index is traded in.

symbol: str
Symbol for the index.

name: str
exchange: str
Stock exchange where the index is listed.

currency: str
Currency the index is traded in.

code: str
ID code for keying the index in the OpenBB Terminal.