Tmx Equity Search

---

Implementation details

Class names

Model name	Parameters class	Data class
TmxEquitySearch	TmxEquitySearchQueryParams	TmxEquitySearchData

Import Statement

from openbb_core.provider.standard_models. import (
TmxEquitySearchData,
TmxEquitySearchQueryParams,
)

Parameters

• standard
• tmx

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.

country: str | None
Default: CA
Restrict to a two-letter country code. Set to None for every market.

symbol_only: bool | None
Default: False
Match the symbol only, instead of the symbol or the name.

limit: int | None
Default: 200
The maximum number of results.

use_cache: bool | None
Default: True
Whether to use the on-disk response cache. Set to False to bypass.

Data

• standard
• tmx

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 | None
The exchange the instrument trades on.

exchange_code: str | None
The exchange code.

country: str | None
The country the instrument is listed in.

security_type: str | None
The instrument type.

market_cap: float | None
The market capitalization.

optionable: bool | None
Whether the instrument has listed options.