Skip to main content

profile

Equity Info. Get general price and performance metrics of a stock.

Example​

from openbb import obb
obb.equity.profile(symbol="AAPL")

Parameters​

NameTypeDescriptionDefaultOptional
symbolUnion[str, List[str]]Symbol to get data for.False
providerLiteral['cboe']The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default."cboe"True

Returns​

OBBject
results : List[EquityInfo]
Serializable results.

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

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

chart : Optional[Chart]
Chart object.

metadata: Optional[Metadata]
Metadata info about the command execution.

Data​

NameTypeDescription
symbolstrSymbol representing the entity requested in the data.
namestrName associated with the ticker symbol.
pricefloatLast transaction price.
openfloatThe open price.
highfloatThe high price.
lowfloatThe low price.
closefloatThe close price.
changefloatChange in price over the current trading period.
change_percentfloatPercent change in price over the current trading period.
prev_closefloatPrevious closing price.