Equity Search

---

Implementation details

Class names

Model name	Parameters class	Data class
EquitySearch	EquitySearchQueryParams	EquitySearchData

Import Statement

from openbb_core.provider.standard_models.equity_search import (
EquitySearchData,
EquitySearchQueryParams,
)

Parameters

• standard
• cboe
• intrinio
• nasdaq
• sec
• tmx
• tradier

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.

query: str | None
Search query.

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

active: bool | None
Default: True
When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded.

limit: int | None
Default: 10000
The number of data entries to return.

query: str | None
Search query.

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

is_etf: bool | None
Default: False
If True, returns only ETFs.

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.

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 a cached request. The list of companies is cached for two days.

query: str | None
Search query.

is_symbol: bool | None
Default: False
Whether the query is a symbol. Defaults to False.

Data

• standard
• cboe
• intrinio
• nasdaq
• sec
• tmx
• tradier

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.

dpm_name: str | None
Name of the primary market maker.

post_station: str | None
Post and station location on the CBOE trading floor.

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

name: str | None
Name of the company.

cik: str | None
lei: str | None
The Legal Entity Identifier (LEI) of the company.

intrinio_id: str
The Intrinio ID of the company.

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

name: str | None
Name of the company.

nasdaq_traded: str | None
Is Nasdaq traded?

exchange: str | None
Primary Exchange

market_category: str | None
Market Category

etf: str | None
Is ETF?

round_lot_size: float | None
Round Lot Size

test_issue: str | None
Is test Issue?

financial_status: str | None
Financial Status

cqs_symbol: str | None
CQS Symbol

nasdaq_symbol: str | None
NASDAQ Symbol

next_shares: str | None
Is NextShares?

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

name: str | None
Name of the company.

cik: str
Central Index Key

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.

exchange: str
Exchange where the security is listed.

security_type: Literal['stock', 'option', 'etf', 'index', 'mutual_fund']
Type of security.