Index Search
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
IndexSearch | IndexSearchQueryParams | IndexSearchData |
Import Statement
from openbb_core.provider.standard_models.index_search import (
IndexSearchData,
IndexSearchQueryParams,
)
Parameters
- standard
- cboe
query: str
Search query.
• Optional: True
is_symbol: bool
Whether to search by ticker symbol.
• Default: False
• Optional: True
query: str
Search query.
• Optional: True
is_symbol: bool
Whether to search by ticker symbol.
• Default: False
• Optional: True
use_cache: bool
When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass.
• Default: True
• Optional: True
Data
- standard
- cboe
symbol: str
Symbol representing the entity requested in the data.
name: str
Name of the index.
symbol: str
Symbol representing the entity requested in the data.
name: str
Name of the index.
description: str
Description for the index.
data_delay: int
Data delay for the index. Valid only for US indices.
currency: str
Currency for the index.
time_zone: str
Time zone 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.
tick_days: str
The trading days for the index. Valid only for US indices.
tick_frequency: str
Tick frequency for the index. Valid only for US indices.
tick_period: str
Tick period for the index. Valid only for US indices.