Skip to main content

search

Search for ETFs.

An empty query returns the full list of ETFs from the provider.

Examples

from openbb import obb
# An empty query returns the full list of ETFs from the provider.
obb.etf.search(provider='fmp')
# The query will return results from text-based fields containing the term.
obb.etf.search(query='commercial real estate', provider='fmp')

Parameters

query: str

Search query.

Optional: True


Returns

results: list[EtfSearch]

Serializable results.


provider: Optional[Literal['fmp', 'intrinio', 'tmx']]

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.(ETF)

name: str

Name of the ETF.