mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-08 02:11:44 +00:00
bf20807424
* stashing * more stashing * add tests * black * test params * mypy * more mypy * grammar police * grammar police
211 lines
8.1 KiB
Python
211 lines
8.1 KiB
Python
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
|
|
|
|
from typing import List, Literal, Optional, Union
|
|
|
|
from openbb_core.app.model.field import OpenBBField
|
|
from openbb_core.app.model.obbject import OBBject
|
|
from openbb_core.app.static.container import Container
|
|
from openbb_core.app.static.utils.decorators import exception_handler, validate
|
|
from openbb_core.app.static.utils.filters import filter_inputs
|
|
from typing_extensions import Annotated
|
|
|
|
|
|
class ROUTER_equity_compare(Container):
|
|
"""/equity/compare
|
|
company_facts
|
|
peers
|
|
"""
|
|
|
|
def __repr__(self) -> str:
|
|
return self.__doc__ or ""
|
|
|
|
@exception_handler
|
|
@validate
|
|
def company_facts(
|
|
self,
|
|
symbol: Annotated[
|
|
Union[str, None, List[Optional[str]]],
|
|
OpenBBField(
|
|
description="Symbol to get data for. Multiple comma separated items allowed for provider(s): sec."
|
|
),
|
|
] = None,
|
|
fact: Annotated[
|
|
str,
|
|
OpenBBField(
|
|
description="The fact to lookup, typically a GAAP-reporting measure. Choices vary by provider."
|
|
),
|
|
] = "",
|
|
provider: Annotated[
|
|
Optional[Literal["sec"]],
|
|
OpenBBField(
|
|
description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'sec' if there is\n no default."
|
|
),
|
|
] = None,
|
|
**kwargs
|
|
) -> OBBject:
|
|
"""Copmare reported company facts and fundamental data points.
|
|
|
|
Parameters
|
|
----------
|
|
symbol : Union[str, None, List[Optional[str]]]
|
|
Symbol to get data for. Multiple comma separated items allowed for provider(s): sec.
|
|
fact : str
|
|
The fact to lookup, typically a GAAP-reporting measure. Choices vary by provider.
|
|
provider : Optional[Literal['sec']]
|
|
The provider to use for the query, by default None.
|
|
If None, the provider specified in defaults is selected or 'sec' if there is
|
|
no default.
|
|
year : Optional[int]
|
|
The year to retrieve the data for. If not provided, the current year is used. When symbol(s) are provided, excluding the year will return all reported values for the concept. (provider: sec)
|
|
fiscal_period : Optional[Literal['fy', 'q1', 'q2', 'q3', 'q4']]
|
|
The fiscal period to retrieve the data for. If not provided, the most recent quarter is used. This parameter is ignored when a symbol is supplied. (provider: sec)
|
|
instantaneous : bool
|
|
Whether to retrieve instantaneous data. See the notes above for more information. Defaults to False. Some facts are only available as instantaneous data.
|
|
The function will automatically attempt the inverse of this parameter if the initial fiscal quarter request fails. This parameter is ignored when a symbol is supplied. (provider: sec)
|
|
use_cache : bool
|
|
Whether to use cache for the request. Defaults to True. (provider: sec)
|
|
|
|
Returns
|
|
-------
|
|
OBBject
|
|
results : List[CompareCompanyFacts]
|
|
Serializable results.
|
|
provider : Optional[Literal['sec']]
|
|
Provider name.
|
|
warnings : Optional[List[Warning_]]
|
|
List of warnings.
|
|
chart : Optional[Chart]
|
|
Chart object.
|
|
extra : Dict[str, Any]
|
|
Extra info.
|
|
|
|
CompareCompanyFacts
|
|
-------------------
|
|
symbol : Optional[str]
|
|
Symbol representing the entity requested in the data.
|
|
name : Optional[str]
|
|
Name of the entity.
|
|
value : float
|
|
The reported value of the fact or concept.
|
|
reported_date : Optional[date]
|
|
The date when the report was filed.
|
|
period_beginning : Optional[date]
|
|
The start date of the reporting period.
|
|
period_ending : Optional[date]
|
|
The end date of the reporting period.
|
|
fiscal_year : Optional[int]
|
|
The fiscal year.
|
|
fiscal_period : Optional[str]
|
|
The fiscal period of the fiscal year.
|
|
cik : Optional[Union[int, str]]
|
|
Central Index Key (CIK) for the requested entity. (provider: sec)
|
|
location : Optional[str]
|
|
Geographic location of the reporting entity. (provider: sec)
|
|
form : Optional[str]
|
|
The SEC form associated with the fact or concept. (provider: sec)
|
|
frame : Optional[str]
|
|
The frame ID associated with the fact or concept, if applicable. (provider: sec)
|
|
accession : Optional[str]
|
|
SEC filing accession number associated with the reported fact or concept. (provider: sec)
|
|
fact : Optional[str]
|
|
The display name of the fact or concept. (provider: sec)
|
|
unit : Optional[str]
|
|
The unit of measurement for the fact or concept. (provider: sec)
|
|
|
|
Examples
|
|
--------
|
|
>>> from openbb import obb
|
|
>>> obb.equity.compare.company_facts(provider='sec')
|
|
>>> obb.equity.compare.company_facts(provider='sec', fact='PaymentsForRepurchaseOfCommonStock', year=2023)
|
|
>>> obb.equity.compare.company_facts(provider='sec', symbol='NVDA,AAPL,AMZN,MSFT,GOOG,SMCI', fact='RevenueFromContractWithCustomerExcludingAssessedTax', year=2024)
|
|
""" # noqa: E501
|
|
|
|
return self._run(
|
|
"/equity/compare/company_facts",
|
|
**filter_inputs(
|
|
provider_choices={
|
|
"provider": self._get_provider(
|
|
provider,
|
|
"/equity/compare/company_facts",
|
|
("sec",),
|
|
)
|
|
},
|
|
standard_params={
|
|
"symbol": symbol,
|
|
"fact": fact,
|
|
},
|
|
extra_params=kwargs,
|
|
info={"symbol": {"sec": {"multiple_items_allowed": True}}},
|
|
)
|
|
)
|
|
|
|
@exception_handler
|
|
@validate
|
|
def peers(
|
|
self,
|
|
symbol: Annotated[str, OpenBBField(description="Symbol to get data for.")],
|
|
provider: Annotated[
|
|
Optional[Literal["fmp"]],
|
|
OpenBBField(
|
|
description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default."
|
|
),
|
|
] = None,
|
|
**kwargs
|
|
) -> OBBject:
|
|
"""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.
|
|
|
|
|
|
Parameters
|
|
----------
|
|
symbol : str
|
|
Symbol to get data for.
|
|
provider : Optional[Literal['fmp']]
|
|
The provider to use for the query, by default None.
|
|
If None, the provider specified in defaults is selected or 'fmp' if there is
|
|
no default.
|
|
|
|
Returns
|
|
-------
|
|
OBBject
|
|
results : 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.
|
|
|
|
EquityPeers
|
|
-----------
|
|
peers_list : List[str]
|
|
A list of equity peers based on sector, exchange and market cap.
|
|
|
|
Examples
|
|
--------
|
|
>>> from openbb import obb
|
|
>>> obb.equity.compare.peers(symbol='AAPL', provider='fmp')
|
|
""" # noqa: E501
|
|
|
|
return self._run(
|
|
"/equity/compare/peers",
|
|
**filter_inputs(
|
|
provider_choices={
|
|
"provider": self._get_provider(
|
|
provider,
|
|
"/equity/compare/peers",
|
|
("fmp",),
|
|
)
|
|
},
|
|
standard_params={
|
|
"symbol": symbol,
|
|
},
|
|
extra_params=kwargs,
|
|
)
|
|
)
|