Available Indices
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
AvailableIndices | AvailableIndicesQueryParams | AvailableIndicesData |
Import Statement
from openbb_core.provider.standard_models.available_indices import (
AvailableIndicesData,
AvailableIndicesQueryParams,
)
Parameters
- standard
- cboe
- fmp
- tmx
- yfinance
use_cache: bool | None
Default: True
When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass.
use_cache: bool | None
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.
Data
- standard
- cboe
- fmp
- tmx
- yfinance
symbol: str
Symbol representing the entity requested in the data.
name: str | None
exchange: str | None
Stock exchange where the index is listed.
currency: str | None
Currency the index is traded in.
symbol: str | None
Symbol for the index.
name: str | None
exchange: str | None
Stock exchange where the index is listed.
currency: str | None
Currency the index is traded in.
description: str | None
Description for the index. Valid only for US indices.
data_delay: int | None
Data delay for the index. Valid only for US indices.
open_time: datetime.time | None
Opening time for the index. Valid only for US indices.
close_time: datetime.time | None
Closing time for the index. Valid only for US indices.
time_zone: str | None
Time zone for the index. Valid only for US indices.
tick_days: str | None
The trading days for the index. Valid only for US indices.
tick_frequency: str | None
The frequency of the index ticks. Valid only for US indices.
tick_period: str | None
The period of the index ticks. Valid only for US indices.
symbol: str
Symbol representing the entity requested in the data.
name: str | None
exchange: str | None
Stock exchange where the index is listed.
currency: str | None
Currency the index is traded in.
symbol: str
The ticker symbol of the index.
name: str | None
exchange: str | None
Stock exchange where the index is listed.
currency: str | None
Currency the index is traded in.
symbol: str
Symbol for the index.
name: str | None
exchange: str | None
Stock exchange where the index is listed.
currency: str | None
Currency the index is traded in.
code: str
ID code for keying the index in the OpenBB Terminal.