gainers

Get the top ETF gainers.

Examples

from openbb import obb
# Get the top ETF gainers.
obb.etf.discovery.gainers(provider='wsj')

---

Parameters

• standard
• wsj

Name	Type	Description	Default	Optional
sort	Literal['asc', 'desc']	Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.	desc	True
limit	int	The number of data entries to return.	10	True

Name	Type	Description	Default	Optional
sort	Literal['asc', 'desc']	Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.	desc	True
limit	int	The number of data entries to return.	10	True

---

Returns

OBBject
    results : List[ETFGainers]
        Serializable results.

    provider : Optional[Literal['wsj']]
        Provider name.

    warnings : Optional[List[Warning_]]
        List of warnings.

    chart : Optional[Chart]
        Chart object.

    extra : Dict[str, Any]
        Extra info.

---

Data

• standard
• wsj

Name	Type	Description
symbol	str	Symbol representing the entity requested in the data.
name	str	Name of the entity.
last_price	float	Last price.
percent_change	float	Percent change.
net_change	float	Net change.
volume	float	The trading volume.
date	Union[date, str]	The date of the data.

Name	Type	Description
symbol	str	Symbol representing the entity requested in the data.
name	str	Name of the entity.
last_price	float	Last price.
percent_change	float	Percent change.
net_change	float	Net change.
volume	float	The trading volume.
date	Union[date, str]	The date of the data.
bluegrass_channel	str	Bluegrass channel.
country	str	Country of the entity.
mantissa	int	Mantissa.
type	str	Type of the entity.
formatted_price	str	Formatted price.
formatted_volume	str	Formatted volume.
formatted_price_change	str	Formatted price change.
formatted_percent_change	str	Formatted percent change.
url	str	The source url.