mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 21:12:16 +00:00
7deb4e69f6
* feat: balancesheet
* feat: income statement
* fix: cash flow statement
* feat: financial ratios
* feat: reported financials
* feat: revenue business line
* feat: revenue per geography
* fix: warnings
* Update balance_sheet.py
* fix: remove warning imports
* feat: balance sheet growth
* feat: calendar ipo
* feat: cashflow growth
* feat: __validators__
* fix: typing
* fix: validator msg
* feat: trailing dividend_yield
* feat: short volume
* feat: share statistics
* feat: price target + consensus
* fix: update validator
* feat: historical dividends
* feat: key executives
* fix: getattr directly
* fix: type hint validator
* fix: add default to getattr
* typo
* feat: otc
* feat: options chains
* fix: remove list validators
* feat: add validator dict to fetchers
* lint
* update standard models
* lint
* feat: rename validator
* fix: ownership
* feat: query params description
* fix: balance yfinance
* key execs, income statement
* remove change
* fix: revenue geographic
* fix: disable pylint
* fix: unusual + balance
* unit test validator
* minor fix
* explicit validators
* update test
* feat: multiple items allowed
* rebuild
* move check_single_value
* crypto historical
* order providers
* fix typing
* rename extra dict
* marking multiple items allowed
* Revert "marking multiple items allowed"
This reverts commit 7da04817e1.
* error msg
* fix: default provider runtime vs configuration
* minor fix
* docstring
* revert default changes
* get provider before executing cmd
* fix container bug
* clean filter
* add comment
* prevent bad defaults
* update docstring
* typing
* fix
* black
* fix docstring generation
* [Feature] - Mark multiple item fetchers (#6074)
* feat: price target
* bezinga company news
* equity quote
* marking multiple items allowed
* more multiple items
* black
* rebuild
* another batch
* rebuild
* another
* cpi
* move prop
* rebuild
---------
Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt>
* rename var
* update msg
* rename func
* fix test
* mypy
* ruff
---------
Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt>
697 lines
22 KiB
Python
697 lines
22 KiB
Python
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
|
|
|
|
import datetime
|
|
from typing import Literal, Optional, Union
|
|
|
|
from openbb_core.app.model.custom_parameter import OpenBBCustomParameter
|
|
from openbb_core.app.model.obbject import OBBject
|
|
from openbb_core.app.static.container import Container
|
|
from openbb_core.app.static.utils.decorators import validate
|
|
from openbb_core.app.static.utils.filters import filter_inputs
|
|
from typing_extensions import Annotated
|
|
|
|
|
|
class ROUTER_equity_discovery(Container):
|
|
"""/equity/discovery
|
|
active
|
|
aggressive_small_caps
|
|
filings
|
|
gainers
|
|
growth_tech
|
|
losers
|
|
undervalued_growth
|
|
undervalued_large_caps
|
|
"""
|
|
|
|
def __repr__(self) -> str:
|
|
return self.__doc__ or ""
|
|
|
|
@validate
|
|
def active(
|
|
self,
|
|
sort: Annotated[
|
|
str,
|
|
OpenBBCustomParameter(
|
|
description="Sort order. Possible values: 'asc', 'desc'. Default: 'desc'."
|
|
),
|
|
] = "desc",
|
|
provider: Optional[Literal["yfinance"]] = None,
|
|
**kwargs
|
|
) -> OBBject:
|
|
"""Get the most active Equities.
|
|
|
|
Parameters
|
|
----------
|
|
sort : str
|
|
Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.
|
|
provider : Optional[Literal['yfinance']]
|
|
The provider to use for the query, by default None.
|
|
If None, the provider specified in defaults is selected or 'yfinance' if there is
|
|
no default.
|
|
|
|
Returns
|
|
-------
|
|
OBBject
|
|
results : List[EquityActive]
|
|
Serializable results.
|
|
provider : Optional[Literal['yfinance']]
|
|
Provider name.
|
|
warnings : Optional[List[Warning_]]
|
|
List of warnings.
|
|
chart : Optional[Chart]
|
|
Chart object.
|
|
extra: Dict[str, Any]
|
|
Extra info.
|
|
|
|
EquityActive
|
|
------------
|
|
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 : Optional[str]
|
|
Market Cap displayed in billions. (provider: yfinance)
|
|
avg_volume_3_months : Optional[float]
|
|
Average volume over the last 3 months in millions. (provider: yfinance)
|
|
pe_ratio_ttm : Optional[float]
|
|
PE Ratio (TTM). (provider: yfinance)
|
|
|
|
Example
|
|
-------
|
|
>>> from openbb import obb
|
|
>>> obb.equity.discovery.active(sort="desc")
|
|
""" # noqa: E501
|
|
|
|
return self._run(
|
|
"/equity/discovery/active",
|
|
**filter_inputs(
|
|
provider_choices={
|
|
"provider": self._get_provider(
|
|
provider,
|
|
"/equity/discovery/active",
|
|
("yfinance",),
|
|
)
|
|
},
|
|
standard_params={
|
|
"sort": sort,
|
|
},
|
|
extra_params=kwargs,
|
|
)
|
|
)
|
|
|
|
@validate
|
|
def aggressive_small_caps(
|
|
self,
|
|
sort: Annotated[
|
|
str,
|
|
OpenBBCustomParameter(
|
|
description="Sort order. Possible values: 'asc', 'desc'. Default: 'desc'."
|
|
),
|
|
] = "desc",
|
|
provider: Optional[Literal["yfinance"]] = None,
|
|
**kwargs
|
|
) -> OBBject:
|
|
"""Get aggressive small cap Equities.
|
|
|
|
Parameters
|
|
----------
|
|
sort : str
|
|
Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.
|
|
provider : Optional[Literal['yfinance']]
|
|
The provider to use for the query, by default None.
|
|
If None, the provider specified in defaults is selected or 'yfinance' if there is
|
|
no default.
|
|
|
|
Returns
|
|
-------
|
|
OBBject
|
|
results : List[EquityAggressiveSmallCaps]
|
|
Serializable results.
|
|
provider : Optional[Literal['yfinance']]
|
|
Provider name.
|
|
warnings : Optional[List[Warning_]]
|
|
List of warnings.
|
|
chart : Optional[Chart]
|
|
Chart object.
|
|
extra: Dict[str, Any]
|
|
Extra info.
|
|
|
|
EquityAggressiveSmallCaps
|
|
-------------------------
|
|
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 : Optional[str]
|
|
Market Cap. (provider: yfinance)
|
|
avg_volume_3_months : Optional[float]
|
|
Average volume over the last 3 months in millions. (provider: yfinance)
|
|
pe_ratio_ttm : Optional[float]
|
|
PE Ratio (TTM). (provider: yfinance)
|
|
|
|
Example
|
|
-------
|
|
>>> from openbb import obb
|
|
>>> obb.equity.discovery.aggressive_small_caps(sort="desc")
|
|
""" # noqa: E501
|
|
|
|
return self._run(
|
|
"/equity/discovery/aggressive_small_caps",
|
|
**filter_inputs(
|
|
provider_choices={
|
|
"provider": self._get_provider(
|
|
provider,
|
|
"/equity/discovery/aggressive_small_caps",
|
|
("yfinance",),
|
|
)
|
|
},
|
|
standard_params={
|
|
"sort": sort,
|
|
},
|
|
extra_params=kwargs,
|
|
)
|
|
)
|
|
|
|
@validate
|
|
def filings(
|
|
self,
|
|
start_date: Annotated[
|
|
Union[datetime.date, None, str],
|
|
OpenBBCustomParameter(
|
|
description="Start date of the data, in YYYY-MM-DD format."
|
|
),
|
|
] = None,
|
|
end_date: Annotated[
|
|
Union[datetime.date, None, str],
|
|
OpenBBCustomParameter(
|
|
description="End date of the data, in YYYY-MM-DD format."
|
|
),
|
|
] = None,
|
|
form_type: Annotated[
|
|
Optional[str],
|
|
OpenBBCustomParameter(
|
|
description="Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types."
|
|
),
|
|
] = None,
|
|
limit: Annotated[
|
|
int,
|
|
OpenBBCustomParameter(description="The number of data entries to return."),
|
|
] = 100,
|
|
provider: Optional[Literal["fmp"]] = None,
|
|
**kwargs
|
|
) -> OBBject:
|
|
"""Get the most-recent filings submitted to the SEC.
|
|
|
|
Parameters
|
|
----------
|
|
start_date : Union[datetime.date, None, str]
|
|
Start date of the data, in YYYY-MM-DD format.
|
|
end_date : Union[datetime.date, None, str]
|
|
End date of the data, in YYYY-MM-DD format.
|
|
form_type : Optional[str]
|
|
Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types.
|
|
limit : int
|
|
The number of data entries to return.
|
|
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.
|
|
is_done : Optional[bool]
|
|
Flag for whether or not the filing is done. (provider: fmp)
|
|
|
|
Returns
|
|
-------
|
|
OBBject
|
|
results : List[DiscoveryFilings]
|
|
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.
|
|
|
|
DiscoveryFilings
|
|
----------------
|
|
symbol : str
|
|
Symbol representing the entity requested in the data.
|
|
cik : str
|
|
Central Index Key (CIK) for the requested entity.
|
|
title : str
|
|
Title of the filing.
|
|
date : datetime
|
|
The date of the data.
|
|
form_type : str
|
|
The form type of the filing
|
|
link : str
|
|
URL to the filing page on the SEC site.
|
|
|
|
Example
|
|
-------
|
|
>>> from openbb import obb
|
|
>>> obb.equity.discovery.filings(limit=100)
|
|
""" # noqa: E501
|
|
|
|
return self._run(
|
|
"/equity/discovery/filings",
|
|
**filter_inputs(
|
|
provider_choices={
|
|
"provider": self._get_provider(
|
|
provider,
|
|
"/equity/discovery/filings",
|
|
("fmp",),
|
|
)
|
|
},
|
|
standard_params={
|
|
"start_date": start_date,
|
|
"end_date": end_date,
|
|
"form_type": form_type,
|
|
"limit": limit,
|
|
},
|
|
extra_params=kwargs,
|
|
)
|
|
)
|
|
|
|
@validate
|
|
def gainers(
|
|
self,
|
|
sort: Annotated[
|
|
str,
|
|
OpenBBCustomParameter(
|
|
description="Sort order. Possible values: 'asc', 'desc'. Default: 'desc'."
|
|
),
|
|
] = "desc",
|
|
provider: Optional[Literal["yfinance"]] = None,
|
|
**kwargs
|
|
) -> OBBject:
|
|
"""Get the top Equity gainers.
|
|
|
|
Parameters
|
|
----------
|
|
sort : str
|
|
Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.
|
|
provider : Optional[Literal['yfinance']]
|
|
The provider to use for the query, by default None.
|
|
If None, the provider specified in defaults is selected or 'yfinance' if there is
|
|
no default.
|
|
|
|
Returns
|
|
-------
|
|
OBBject
|
|
results : List[EquityGainers]
|
|
Serializable results.
|
|
provider : Optional[Literal['yfinance']]
|
|
Provider name.
|
|
warnings : Optional[List[Warning_]]
|
|
List of warnings.
|
|
chart : Optional[Chart]
|
|
Chart object.
|
|
extra: Dict[str, Any]
|
|
Extra info.
|
|
|
|
EquityGainers
|
|
-------------
|
|
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 : Optional[str]
|
|
Market Cap. (provider: yfinance)
|
|
avg_volume_3_months : Optional[float]
|
|
Average volume over the last 3 months in millions. (provider: yfinance)
|
|
pe_ratio_ttm : Optional[float]
|
|
PE Ratio (TTM). (provider: yfinance)
|
|
|
|
Example
|
|
-------
|
|
>>> from openbb import obb
|
|
>>> obb.equity.discovery.gainers(sort="desc")
|
|
""" # noqa: E501
|
|
|
|
return self._run(
|
|
"/equity/discovery/gainers",
|
|
**filter_inputs(
|
|
provider_choices={
|
|
"provider": self._get_provider(
|
|
provider,
|
|
"/equity/discovery/gainers",
|
|
("yfinance",),
|
|
)
|
|
},
|
|
standard_params={
|
|
"sort": sort,
|
|
},
|
|
extra_params=kwargs,
|
|
)
|
|
)
|
|
|
|
@validate
|
|
def growth_tech(
|
|
self,
|
|
sort: Annotated[
|
|
str,
|
|
OpenBBCustomParameter(
|
|
description="Sort order. Possible values: 'asc', 'desc'. Default: 'desc'."
|
|
),
|
|
] = "desc",
|
|
provider: Optional[Literal["yfinance"]] = None,
|
|
**kwargs
|
|
) -> OBBject:
|
|
"""Get growth tech Equities.
|
|
|
|
Parameters
|
|
----------
|
|
sort : str
|
|
Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.
|
|
provider : Optional[Literal['yfinance']]
|
|
The provider to use for the query, by default None.
|
|
If None, the provider specified in defaults is selected or 'yfinance' if there is
|
|
no default.
|
|
|
|
Returns
|
|
-------
|
|
OBBject
|
|
results : List[GrowthTechEquities]
|
|
Serializable results.
|
|
provider : Optional[Literal['yfinance']]
|
|
Provider name.
|
|
warnings : Optional[List[Warning_]]
|
|
List of warnings.
|
|
chart : Optional[Chart]
|
|
Chart object.
|
|
extra: Dict[str, Any]
|
|
Extra info.
|
|
|
|
GrowthTechEquities
|
|
------------------
|
|
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 : Optional[str]
|
|
Market Cap. (provider: yfinance)
|
|
avg_volume_3_months : Optional[float]
|
|
Average volume over the last 3 months in millions. (provider: yfinance)
|
|
pe_ratio_ttm : Optional[float]
|
|
PE Ratio (TTM). (provider: yfinance)
|
|
|
|
Example
|
|
-------
|
|
>>> from openbb import obb
|
|
>>> obb.equity.discovery.growth_tech(sort="desc")
|
|
""" # noqa: E501
|
|
|
|
return self._run(
|
|
"/equity/discovery/growth_tech",
|
|
**filter_inputs(
|
|
provider_choices={
|
|
"provider": self._get_provider(
|
|
provider,
|
|
"/equity/discovery/growth_tech",
|
|
("yfinance",),
|
|
)
|
|
},
|
|
standard_params={
|
|
"sort": sort,
|
|
},
|
|
extra_params=kwargs,
|
|
)
|
|
)
|
|
|
|
@validate
|
|
def losers(
|
|
self,
|
|
sort: Annotated[
|
|
str,
|
|
OpenBBCustomParameter(
|
|
description="Sort order. Possible values: 'asc', 'desc'. Default: 'desc'."
|
|
),
|
|
] = "desc",
|
|
provider: Optional[Literal["yfinance"]] = None,
|
|
**kwargs
|
|
) -> OBBject:
|
|
"""Get the top Equity losers.
|
|
|
|
Parameters
|
|
----------
|
|
sort : str
|
|
Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.
|
|
provider : Optional[Literal['yfinance']]
|
|
The provider to use for the query, by default None.
|
|
If None, the provider specified in defaults is selected or 'yfinance' if there is
|
|
no default.
|
|
|
|
Returns
|
|
-------
|
|
OBBject
|
|
results : List[EquityLosers]
|
|
Serializable results.
|
|
provider : Optional[Literal['yfinance']]
|
|
Provider name.
|
|
warnings : Optional[List[Warning_]]
|
|
List of warnings.
|
|
chart : Optional[Chart]
|
|
Chart object.
|
|
extra: Dict[str, Any]
|
|
Extra info.
|
|
|
|
EquityLosers
|
|
------------
|
|
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 : Optional[str]
|
|
Market Cap. (provider: yfinance)
|
|
avg_volume_3_months : Optional[float]
|
|
Average volume over the last 3 months in millions. (provider: yfinance)
|
|
pe_ratio_ttm : Optional[float]
|
|
PE Ratio (TTM). (provider: yfinance)
|
|
|
|
Example
|
|
-------
|
|
>>> from openbb import obb
|
|
>>> obb.equity.discovery.losers(sort="desc")
|
|
""" # noqa: E501
|
|
|
|
return self._run(
|
|
"/equity/discovery/losers",
|
|
**filter_inputs(
|
|
provider_choices={
|
|
"provider": self._get_provider(
|
|
provider,
|
|
"/equity/discovery/losers",
|
|
("yfinance",),
|
|
)
|
|
},
|
|
standard_params={
|
|
"sort": sort,
|
|
},
|
|
extra_params=kwargs,
|
|
)
|
|
)
|
|
|
|
@validate
|
|
def undervalued_growth(
|
|
self,
|
|
sort: Annotated[
|
|
str,
|
|
OpenBBCustomParameter(
|
|
description="Sort order. Possible values: 'asc', 'desc'. Default: 'desc'."
|
|
),
|
|
] = "desc",
|
|
provider: Optional[Literal["yfinance"]] = None,
|
|
**kwargs
|
|
) -> OBBject:
|
|
"""Get undervalued growth Equities.
|
|
|
|
Parameters
|
|
----------
|
|
sort : str
|
|
Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.
|
|
provider : Optional[Literal['yfinance']]
|
|
The provider to use for the query, by default None.
|
|
If None, the provider specified in defaults is selected or 'yfinance' if there is
|
|
no default.
|
|
|
|
Returns
|
|
-------
|
|
OBBject
|
|
results : List[EquityUndervaluedGrowth]
|
|
Serializable results.
|
|
provider : Optional[Literal['yfinance']]
|
|
Provider name.
|
|
warnings : Optional[List[Warning_]]
|
|
List of warnings.
|
|
chart : Optional[Chart]
|
|
Chart object.
|
|
extra: Dict[str, Any]
|
|
Extra info.
|
|
|
|
EquityUndervaluedGrowth
|
|
-----------------------
|
|
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 : Optional[str]
|
|
Market Cap. (provider: yfinance)
|
|
avg_volume_3_months : Optional[float]
|
|
Average volume over the last 3 months in millions. (provider: yfinance)
|
|
pe_ratio_ttm : Optional[float]
|
|
PE Ratio (TTM). (provider: yfinance)
|
|
|
|
Example
|
|
-------
|
|
>>> from openbb import obb
|
|
>>> obb.equity.discovery.undervalued_growth(sort="desc")
|
|
""" # noqa: E501
|
|
|
|
return self._run(
|
|
"/equity/discovery/undervalued_growth",
|
|
**filter_inputs(
|
|
provider_choices={
|
|
"provider": self._get_provider(
|
|
provider,
|
|
"/equity/discovery/undervalued_growth",
|
|
("yfinance",),
|
|
)
|
|
},
|
|
standard_params={
|
|
"sort": sort,
|
|
},
|
|
extra_params=kwargs,
|
|
)
|
|
)
|
|
|
|
@validate
|
|
def undervalued_large_caps(
|
|
self,
|
|
sort: Annotated[
|
|
str,
|
|
OpenBBCustomParameter(
|
|
description="Sort order. Possible values: 'asc', 'desc'. Default: 'desc'."
|
|
),
|
|
] = "desc",
|
|
provider: Optional[Literal["yfinance"]] = None,
|
|
**kwargs
|
|
) -> OBBject:
|
|
"""Get undervalued large cap Equities.
|
|
|
|
Parameters
|
|
----------
|
|
sort : str
|
|
Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.
|
|
provider : Optional[Literal['yfinance']]
|
|
The provider to use for the query, by default None.
|
|
If None, the provider specified in defaults is selected or 'yfinance' if there is
|
|
no default.
|
|
|
|
Returns
|
|
-------
|
|
OBBject
|
|
results : List[EquityUndervaluedLargeCaps]
|
|
Serializable results.
|
|
provider : Optional[Literal['yfinance']]
|
|
Provider name.
|
|
warnings : Optional[List[Warning_]]
|
|
List of warnings.
|
|
chart : Optional[Chart]
|
|
Chart object.
|
|
extra: Dict[str, Any]
|
|
Extra info.
|
|
|
|
EquityUndervaluedLargeCaps
|
|
--------------------------
|
|
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 : Optional[float]
|
|
Market Cap. (provider: yfinance)
|
|
avg_volume_3_months : Optional[float]
|
|
Average volume over the last 3 months in millions. (provider: yfinance)
|
|
pe_ratio_ttm : Optional[float]
|
|
PE Ratio (TTM). (provider: yfinance)
|
|
|
|
Example
|
|
-------
|
|
>>> from openbb import obb
|
|
>>> obb.equity.discovery.undervalued_large_caps(sort="desc")
|
|
""" # noqa: E501
|
|
|
|
return self._run(
|
|
"/equity/discovery/undervalued_large_caps",
|
|
**filter_inputs(
|
|
provider_choices={
|
|
"provider": self._get_provider(
|
|
provider,
|
|
"/equity/discovery/undervalued_large_caps",
|
|
("yfinance",),
|
|
)
|
|
},
|
|
standard_params={
|
|
"sort": sort,
|
|
},
|
|
extra_params=kwargs,
|
|
)
|
|
)
|