Skip to main content
Version: v5

search

Screen indexes by domicile.

Examples​

from openbb import obb
# Screen the index universe.
obb.nasdaq.index.search(index_type='us', provider='nasdaq')

Parameters​

query: str | None
Search query.

is_symbol: bool | None
Default: False
Whether to search by ticker symbol.


Returns​

results: NasdaqIndexSearch

Serializable results.

provider: str | None

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.