Skip to main content

search

Filter indices for rows containing the query.

Parameters

query: str

Search query.

Optional: True


is_symbol: bool

Whether to search by ticker symbol.

Default: False

Optional: True


Returns

results: list[IndexSearch]

Serializable results.


provider: Optional[Literal['cboe']]

Provider name.


warnings: Optional[list[Warning_]]

list of warnings.


chart: Optional[Chart]

Chart object.


extra: dict[str, Any]

Extra info.


Data

symbol: str

Symbol representing the entity requested in the data.

name: str

Name of the index.