Skip to main content

peers

Get the closest peers for a given company.

Peers consist of companies trading on the same exchange, operating within the same sector and with comparable market capitalizations.

Examples

from openbb import obb
obb.equity.compare.peers(symbol='AAPL', provider='fmp')

Parameters

symbol: str
Symbol to get data for.


Returns

results: list[EquityPeers]

Serializable results.

provider: Optional[Literal['fmp']]

Provider name.

warnings: Optional[list[Warning_]]

list of warnings.

chart: Optional[Chart]

Chart object.

extra: dict[str, Any]

Extra info.


Data

symbol: str
Symbol representing the entity requested in the data.