Equity Gainers

---

Implementation details

Class names

Model name	Parameters class	Data class
EquityGainers	EquityGainersQueryParams	EquityGainersData

Import Statement

from openbb_core.provider.standard_models. import (
EquityGainersData,
EquityGainersQueryParams,
)

---

Parameters

• standard
• tmx
• yfinance

Name	Type	Description	Default	Optional
sort	str	Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.	desc	True
provider	Literal['tmx', 'yfinance']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default.	tmx	True

Name	Type	Description	Default	Optional
sort	str	Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.	desc	True
provider	Literal['tmx', 'yfinance']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default.	tmx	True
category	Literal['dividend', 'energy', 'healthcare', 'industrials', 'price_performer', 'rising_stars', 'real_estate', 'tech', 'utilities', '52w_high', 'volume']	The category of list to retrieve. Defaults to price_performer.	price_performer	True

Name	Type	Description	Default	Optional
sort	str	Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.	desc	True
provider	Literal['tmx', 'yfinance']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default.	tmx	True

---

Data

• standard
• tmx
• yfinance

Name	Type	Description
symbol	str	Symbol representing the entity requested in the data.
name	str	Name of the entity.
price	float	Last price.
change	float	Change in price value.
percent_change	float	Percent change.
volume	float	The trading volume.

Name	Type	Description
symbol	str	Symbol representing the entity requested in the data.
name	str	Name of the entity.
price	float	Last price.
change	float	Change in price value.
percent_change	float	Percent change.
volume	float	The trading volume.
rank	int	The rank of the stock in the list.

Name	Type	Description
symbol	str	Symbol representing the entity requested in the data.
name	str	Name of the entity.
price	float	Last price.
change	float	Change in price value.
percent_change	float	Percent change.
volume	float	The trading volume.
market_cap	float	Market Cap.
avg_volume_3_months	float	Average volume over the last 3 months in millions.
pe_ratio_ttm	float	PE Ratio (TTM).