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.

• Optional: True

---

is_symbol: bool

Whether to search by ticker symbol.

• Default: False

• Optional: True

query: str

Search query.

• Optional: True

---

is_symbol: bool

Whether to search by ticker symbol.

• Default: False

• Optional: True

---

use_cache: bool

Whether to use the cache or not.

• Default: True

• Optional: True

query: str

Search query.

• Optional: True

---

is_symbol: bool

Whether to search by ticker symbol.

• Default: False

• Optional: True

---

active: bool

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.

• Default: True

• Optional: True

---

limit: int

The number of data entries to return.

• Default: 10000

• Optional: True

query: str

Search query.

• Optional: True

---

is_symbol: bool

Whether to search by ticker symbol.

• Default: False

• Optional: True

---

is_etf: bool

If True, returns ETFs.

• Optional: True

query: str

Search query.

• Optional: True

---

is_symbol: bool

Whether to search by ticker symbol.

• Default: False

• Optional: True

---

use_cache: bool

Whether to use the cache or not.

• Default: True

• Optional: True

---

is_fund: bool

Whether to direct the search to the list of mutual funds and ETFs.

• Default: False

• Optional: True

query: str

Search query.

• Optional: True

---

is_symbol: bool

Whether to search by ticker symbol.

• Default: False

• Optional: True

---

use_cache: bool

Whether to use a cached request. The list of companies is cached for two days.

• Default: True

• Optional: True

query: str

Search query.

• Optional: True

---

is_symbol: bool

Whether the query is a symbol. Defaults to False.

• Default: False

• Optional: True

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.