Finra Equity Search
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
FinraEquitySearch | FinraEquitySearchQueryParams | FinraEquitySearchData |
Import Statement
from openbb_core.provider.standard_models. import (
FinraEquitySearchData,
FinraEquitySearchQueryParams,
)
Parameters
- standard
- finra
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.
security_type: str | None
Default: all
The type of security to search for.
Data
- standard
- finra
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.
security_type: str | None
The Morningstar security type - Stock, ETF, Closed-End Fund, or Open-End Fund.
security_description: str | None
The share class, or the Morningstar category of a fund.
country: str | None
The ISO 3166 alpha-3 code of the listing country.
currency: str | None
The trading currency.
isin: str | None
The International Securities Identification Number.
security_id: str | None
The Morningstar security id.
performance_id: str | None
The Morningstar performance id.
exchange: str | None
The Market Identifier Code of the listing venue.
listing_market: str | None
The Market Data Center name of the listing exchange.
composite_market: str | None
The Market Data Center name of the composite market.
quote_symbol: str | None
The real-time quote key - composite market, type, and symbol.
url: str | None
The security's page on the FINRA Market Data Center.