equity_search

Search for stock symbol, CIK, LEI, or company name.

Examples

from openbb import obb
obb.sec.equity_search(provider='sec')
obb.sec.equity_search(query='AAPL', provider='sec')

Parameters

• standard
• sec

query: str | None
Search query.

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

query: str | None
Search query.

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

use_cache: bool | None
Default: True
Whether to use the cache or not.

is_fund: bool | None
Default: False
Whether to direct the search to the list of mutual funds and ETFs.

---

Returns

results: SecEquitySearch

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

• standard
• sec

symbol: str | None
Symbol representing the entity requested in the data.

name: str | None
Name of the company.

symbol: str | None
Symbol representing the entity requested in the data.

name: str | None
Name of the company.

cik: str
Central Index Key