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
Search query.

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

query: str
Search query.

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

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

query: str
Search query.

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

active: bool
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
Default: 10000
The number of data entries to return.

query: str
Search query.

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

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

query: str
Search query.

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

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

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

query: str
Search query.

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

use_cache: bool
Default: True
Whether to use a cached request. The list of companies is cached for two days.

query: str
Search query.

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

Data

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

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

name: str
Name of the company.

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

name: str
Name of the company.

dpm_name: str
Name of the primary market maker.

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

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

name: str
Name of the company.

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

intrinio_id: str
The Intrinio ID of the company.

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

name: str
Name of the company.

nasdaq_traded: str
Is Nasdaq traded?

exchange: str
Primary Exchange

market_category: str
Market Category

etf: str
Is ETF?

round_lot_size: float
Round Lot Size

test_issue: str
Is test Issue?

financial_status: str
Financial Status

cqs_symbol: str
CQS Symbol

nasdaq_symbol: str
NASDAQ Symbol

next_shares: str
Is NextShares?

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

name: str
Name of the company.

cik: str
Central Index Key

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

name: str
Name of the company.

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

name: str
Name of the company.

exchange: str
Exchange where the security is listed.

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