jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-29 05:21:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Change StockEOD

Browse Source
This commit is contained in:
Igor Radovanovic
2023-08-09 14:03:28 +02:00
parent a1e8d6dfc3
commit 82002f2875
12 changed files with 3995 additions and 668 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
openbb_sdk/sdk/core/openbb_core/app/static/package/__extensions__.py
View File

@@ -1,15 +1,24 @@
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
from openbb_core.app.static.container import Container
class Extensions(Container):
@property
def news(self): # route = "/news"
from openbb_core.app.static.package import news
def crypto(self): # route = "/crypto"
from openbb_core.app.static.package import crypto
return news.CLASS_news(command_runner_session=self._command_runner_session)
return crypto.CLASS_crypto(command_runner_session=self._command_runner_session)
@property
def economy(self): # route = "/economy"
from openbb_core.app.static.package import economy
return economy.CLASS_economy(
command_runner_session=self._command_runner_session
)
@property
def fixedincome(self): # route = "/fixedincome"
@@ -26,24 +35,10 @@ class Extensions(Container):
return forex.CLASS_forex(command_runner_session=self._command_runner_session)
@property
def economy(self): # route = "/economy"
from openbb_core.app.static.package import economy
def news(self): # route = "/news"
from openbb_core.app.static.package import news
return economy.CLASS_economy(
command_runner_session=self._command_runner_session
)
@property
def crypto(self): # route = "/crypto"
from openbb_core.app.static.package import crypto
return crypto.CLASS_crypto(command_runner_session=self._command_runner_session)
@property
def stocks(self): # route = "/stocks"
from openbb_core.app.static.package import stocks
return stocks.CLASS_stocks(command_runner_session=self._command_runner_session)
return news.CLASS_news(command_runner_session=self._command_runner_session)
@property
def qa(self): # route = "/qa"
@@ -51,6 +46,12 @@ class Extensions(Container):
return qa.CLASS_qa(command_runner_session=self._command_runner_session)
@property
def stocks(self): # route = "/stocks"
from openbb_core.app.static.package import stocks
return stocks.CLASS_stocks(command_runner_session=self._command_runner_session)
@property
def ta(self): # route = "/ta"
from openbb_core.app.static.package import ta

125
openbb_sdk/sdk/core/openbb_core/app/static/package/crypto.py
View File

@@ -2,12 +2,11 @@
import datetime
import typing
from typing import Annotated, Literal, Optional, Union
from typing import Literal, Optional, Union
from pydantic import validate_arguments
from openbb_core.app.model.command_output import CommandOutput
from openbb_core.app.model.custom_parameter import OpenBBCustomParameter
from openbb_core.app.static.container import Container
from openbb_core.app.static.filters import filter_call, filter_inputs, filter_output
@@ -17,26 +16,14 @@ class CLASS_crypto(Container):
@validate_arguments
def load(
self,
symbol: typing.Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
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,
symbol: str,
start_date: Union[datetime.date, None, str] = None,
end_date: Union[datetime.date, None, str] = None,
chart: bool = False,
provider: Optional[Literal["polygon", "fmp"]] = None,
provider: Optional[Literal["fmp", "polygon"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
"""Crypto Intraday Price.
r"""Crypto Intraday Price.
openbb
@@ -44,7 +31,7 @@ class CLASS_crypto(Container):
Parameters
----------
provider: Literal[polygon, fmp]
provider: Literal[fmp, polygon]
The provider to use for the query.
symbol : ConstrainedStrValue
Symbol to get data for.
@@ -85,6 +72,30 @@ class CLASS_crypto(Container):
vwap : PositiveFloat
Volume Weighted Average Price of the symbol.
fmp
===
Parameters
----------
timeseries : Optional[NonNegativeInt]
Number of days to look back.
CryptoEOD
---------
adjClose : float
Adjusted Close Price of the symbol.
unadjustedVolume : float
Unadjusted volume of the symbol.
change : float
Change in the price of the symbol from the previous day.
changePercent : float
Change \% in the price of the symbol.
label : str
Human readable format of the date.
changeOverTime : float
Change \% in the price of the symbol over a period of time.
polygon
=======
@@ -107,6 +118,54 @@ class CLASS_crypto(Container):
n : PositiveInt
The number of transactions for the symbol in the time period.
openbb
======
Parameters
----------
provider: Literal[fmp, polygon]
The provider to use for the query.
symbol : ConstrainedStrValue
Symbol to get data for.
start_date : Optional[date]
Start date of the data, in YYYY-MM-DD format.
end_date : Optional[date]
End date of the data, in YYYY-MM-DD format.
Returns
-------
CommandOutput
results: List[Data]
Serializable results.
provider: Optional[PROVIDERS]
Provider name.
warnings: Optional[List[Warning_]]
List of warnings.
error: Optional[Error]
Caught exceptions.
chart: Optional[Chart]
Chart object.
CryptoEOD
---------
date : datetime
The date of the data.
open : PositiveFloat
The open price of the symbol.
high : PositiveFloat
The high price of the symbol.
low : PositiveFloat
The low price of the symbol.
close : PositiveFloat
The close price of the symbol.
volume : PositiveFloat
The volume of the symbol.
vwap : PositiveFloat
Volume Weighted Average Price of the symbol.
fmp
===
@@ -125,11 +184,33 @@ class CLASS_crypto(Container):
change : float
Change in the price of the symbol from the previous day.
changePercent : float
Change \\% in the price of the symbol.
Change \% in the price of the symbol.
label : str
Human readable format of the date.
changeOverTime : float
Change \\% in the price of the symbol over a period of time."""
Change \% in the price of the symbol over a period of time.
polygon
=======
Parameters
----------
timespan : Literal['minute', 'hour', 'day', 'week', 'month', 'quarter', 'year']
The timespan of the data.
sort : Literal['asc', 'desc']
Sort order of the data.
limit : PositiveInt
The number of data entries to return.
adjusted : bool
Whether the data is adjusted.
multiplier : PositiveInt
The multiplier of the timespan.
CryptoEOD
---------
n : PositiveInt
The number of transactions for the symbol in the time period."""
inputs = filter_inputs(
provider_choices={
"provider": provider,

492
openbb_sdk/sdk/core/openbb_core/app/static/package/economy.py
View File

@@ -2,14 +2,13 @@
import datetime
import typing
from typing import Annotated, List, Literal, Optional, Union
from typing import List, Literal, Optional, Union
from pydantic import validate_arguments
import openbb_core.app.model.command_context
import openbb_core.app.model.results.empty
from openbb_core.app.model.command_output import CommandOutput
from openbb_core.app.model.custom_parameter import OpenBBCustomParameter
from openbb_core.app.static.container import Container
from openbb_core.app.static.filters import filter_call, filter_inputs, filter_output
@@ -41,12 +40,7 @@ class CLASS_economy(Container):
@validate_arguments
def const(
self,
index: Annotated[
Literal["nasdaq", "sp500", "dowjones"],
OpenBBCustomParameter(
description="The index for which we want to fetch the constituents."
),
] = "dowjones",
index: Literal["nasdaq", "sp500", "dowjones"] = "dowjones",
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
@@ -54,6 +48,64 @@ class CLASS_economy(Container):
"""Get the constituents of an index.
openbb
======
Parameters
----------
provider: Literal[fmp]
The provider to use for the query.
index : Literal['nasdaq', 'sp500', 'dowjones']
The index for which we want to fetch the constituents.
Returns
-------
CommandOutput
results: List[Data]
Serializable results.
provider: Optional[PROVIDERS]
Provider name.
warnings: Optional[List[Warning_]]
List of warnings.
error: Optional[Error]
Caught exceptions.
chart: Optional[Chart]
Chart object.
MajorIndicesConstituents
------------------------
symbol : ConstrainedStrValue
Symbol to get data for.
name : str
The name of the constituent company in the index.
sector : str
The sector the constituent company in the index belongs to.
sub_sector : Optional[str]
The sub-sector the constituent company in the index belongs to.
headquarter : Optional[str]
The location of the headquarter of the constituent company in the index.
date_first_added : Union[date, str, NoneType]
The date the constituent company was added to the index.
cik : int
The Central Index Key of the constituent company in the index.
founded : Union[date, str]
The founding year of the constituent company in the index.
fmp
===
Parameters
----------
All fields are standardized.
MajorIndicesConstituents
------------------------
All fields are standardized.
openbb
======
@@ -131,88 +183,64 @@ class CLASS_economy(Container):
@validate_arguments
def cpi(
self,
countries: Annotated[
List[
Literal[
"australia",
"austria",
"belgium",
"brazil",
"bulgaria",
"canada",
"chile",
"china",
"croatia",
"cyprus",
"czech_republic",
"denmark",
"estonia",
"euro_area",
"finland",
"france",
"germany",
"greece",
"hungary",
"iceland",
"india",
"indonesia",
"ireland",
"israel",
"italy",
"japan",
"korea",
"latvia",
"lithuania",
"luxembourg",
"malta",
"mexico",
"netherlands",
"new_zealand",
"norway",
"poland",
"portugal",
"romania",
"russian_federation",
"slovak_republic",
"slovakia",
"slovenia",
"south_africa",
"spain",
"sweden",
"switzerland",
"turkey",
"united_kingdom",
"united_states",
]
],
OpenBBCustomParameter(description="The country or countries to get data."),
countries: List[
Literal[
"australia",
"austria",
"belgium",
"brazil",
"bulgaria",
"canada",
"chile",
"china",
"croatia",
"cyprus",
"czech_republic",
"denmark",
"estonia",
"euro_area",
"finland",
"france",
"germany",
"greece",
"hungary",
"iceland",
"india",
"indonesia",
"ireland",
"israel",
"italy",
"japan",
"korea",
"latvia",
"lithuania",
"luxembourg",
"malta",
"mexico",
"netherlands",
"new_zealand",
"norway",
"poland",
"portugal",
"romania",
"russian_federation",
"slovak_republic",
"slovakia",
"slovenia",
"south_africa",
"spain",
"sweden",
"switzerland",
"turkey",
"united_kingdom",
"united_states",
]
],
units: Annotated[
Literal["growth_previous", "growth_same", "index_2015"],
OpenBBCustomParameter(description="The data units."),
] = "growth_same",
frequency: Annotated[
Literal["monthly", "quarterly", "annual"],
OpenBBCustomParameter(description="The data time frequency."),
] = "monthly",
harmonized: typing.Annotated[
bool,
OpenBBCustomParameter(
description="Whether you wish to obtain harmonized data."
),
] = False,
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,
units: Literal["growth_previous", "growth_same", "index_2015"] = "growth_same",
frequency: Literal["monthly", "quarterly", "annual"] = "monthly",
harmonized: bool = False,
start_date: Union[datetime.date, None, str] = None,
end_date: Union[datetime.date, None, str] = None,
chart: bool = False,
provider: Optional[Literal["fred"]] = None,
**kwargs
@@ -220,6 +248,66 @@ class CLASS_economy(Container):
"""CPI.
openbb
======
Parameters
----------
provider: Literal[fred]
The provider to use for the query.
countries : List[Literal['australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'croatia', 'cyprus', 'czech_republic', 'denmark', 'estonia', 'euro_area', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'india', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'malta', 'mexico', 'netherlands', 'new_zealand', 'norway', 'poland', 'portugal', 'romania', 'russian_federation', 'slovak_republic', 'slovakia', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states']]
The country or countries to get data.
units : Literal['growth_previous', 'growth_same', 'index_2015']
The data units.
frequency : Literal['monthly', 'quarterly', 'annual']
The data time frequency.
harmonized : bool
Whether you wish to obtain harmonized data.
start_date : Optional[date]
Start date of the data, in YYYY-MM-DD format.
end_date : Optional[date]
End date of the data, in YYYY-MM-DD format.
Returns
-------
CommandOutput
results: List[Data]
Serializable results.
provider: Optional[PROVIDERS]
Provider name.
warnings: Optional[List[Warning_]]
List of warnings.
error: Optional[Error]
Caught exceptions.
chart: Optional[Chart]
Chart object.
CPI
---
date : date
The date of the data.
realtime_start : date
The date the data was updated.
realtime_end : date
The date the data was updated.
value : float
The value of the data.
fred
====
Parameters
----------
All fields are standardized.
CPI
---
All fields are standardized.
openbb
======
@@ -326,26 +414,14 @@ class CLASS_economy(Container):
@validate_arguments
def index(
self,
symbol: typing.Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
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,
symbol: str,
start_date: Union[datetime.date, None, str] = None,
end_date: Union[datetime.date, None, str] = None,
chart: bool = False,
provider: Optional[Literal["polygon", "fmp"]] = None,
provider: Optional[Literal["fmp", "polygon"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
"""Get OHLCV data for an index.
r"""Get OHLCV data for an index.
openbb
@@ -353,7 +429,7 @@ class CLASS_economy(Container):
Parameters
----------
provider: Literal[polygon, fmp]
provider: Literal[fmp, polygon]
The provider to use for the query.
symbol : ConstrainedStrValue
Symbol to get data for.
@@ -390,6 +466,34 @@ class CLASS_economy(Container):
volume : PositiveFloat
The volume of the symbol.
fmp
===
Parameters
----------
timeseries : Optional[NonNegativeInt]
Number of days to look back.
MajorIndicesEOD
---------------
date : datetime
The date of the data.
adjClose : float
Adjusted Close Price of the symbol.
unadjustedVolume : float
Unadjusted volume of the symbol.
change : float
Change in the price of the symbol from the previous day.
changePercent : float
Change \% in the price of the symbol.
vwap : float
Volume Weighted Average Price of the symbol.
label : str
Human readable format of the date.
changeOverTime : float
Change \% in the price of the symbol over a period of time.
polygon
=======
@@ -416,6 +520,50 @@ class CLASS_economy(Container):
vw : PositiveFloat
The volume weighted average price of the symbol.
openbb
======
Parameters
----------
provider: Literal[fmp, polygon]
The provider to use for the query.
symbol : ConstrainedStrValue
Symbol to get data for.
start_date : Optional[date]
Start date of the data, in YYYY-MM-DD format.
end_date : Optional[date]
End date of the data, in YYYY-MM-DD format.
Returns
-------
CommandOutput
results: List[Data]
Serializable results.
provider: Optional[PROVIDERS]
Provider name.
warnings: Optional[List[Warning_]]
List of warnings.
error: Optional[Error]
Caught exceptions.
chart: Optional[Chart]
Chart object.
MajorIndicesEOD
---------------
open : PositiveFloat
The open price of the symbol.
high : PositiveFloat
The high price of the symbol.
low : PositiveFloat
The low price of the symbol.
close : PositiveFloat
The close price of the symbol.
volume : PositiveFloat
The volume of the symbol.
fmp
===
@@ -436,13 +584,39 @@ class CLASS_economy(Container):
change : float
Change in the price of the symbol from the previous day.
changePercent : float
Change \\% in the price of the symbol.
Change \% in the price of the symbol.
vwap : float
Volume Weighted Average Price of the symbol.
label : str
Human readable format of the date.
changeOverTime : float
Change \\% in the price of the symbol over a period of time."""
Change \% in the price of the symbol over a period of time.
polygon
=======
Parameters
----------
timespan : Literal['minute', 'hour', 'day', 'week', 'month', 'quarter', 'year']
The timespan of the data.
sort : Literal['asc', 'desc']
Sort order of the data.
limit : PositiveInt
The number of data entries to return.
adjusted : bool
Whether the data is adjusted.
multiplier : PositiveInt
The multiplier of the timespan.
MajorIndicesEOD
---------------
t : datetime
The timestamp of the data.
n : PositiveInt
The number of transactions for the symbol in the time period.
vw : PositiveFloat
The volume weighted average price of the symbol."""
inputs = filter_inputs(
provider_choices={
"provider": provider,
@@ -471,6 +645,57 @@ class CLASS_economy(Container):
"""AVAILABLE_INDICES.
openbb
======
Parameters
----------
provider: Literal[fmp]
The provider to use for the query.
All fields are standardized.
Returns
-------
CommandOutput
results: List[Data]
Serializable results.
provider: Optional[PROVIDERS]
Provider name.
warnings: Optional[List[Warning_]]
List of warnings.
error: Optional[Error]
Caught exceptions.
chart: Optional[Chart]
Chart object.
AvailableIndices
----------------
symbol : ConstrainedStrValue
Symbol to get data for.
name : Optional[str]
The name of the index.
currency : Optional[str]
The currency the index is traded in.
stock_exchange : str
The stock exchange where the index is listed.
exchange_short_name : str
The short name of the stock exchange where the index is listed.
fmp
===
Parameters
----------
All fields are standardized.
AvailableIndices
----------------
All fields are standardized.
openbb
======
@@ -543,6 +768,55 @@ class CLASS_economy(Container):
"""Market Risk Premium.
openbb
======
Parameters
----------
provider: Literal[fmp]
The provider to use for the query.
All fields are standardized.
Returns
-------
CommandOutput
results: List[Data]
Serializable results.
provider: Optional[PROVIDERS]
Provider name.
warnings: Optional[List[Warning_]]
List of warnings.
error: Optional[Error]
Caught exceptions.
chart: Optional[Chart]
Chart object.
RiskPremium
-----------
country : str
Market country.
continent : Optional[str]
Continent of the country.
total_equity_risk_premium : PositiveFloat
The total equity risk premium for the country.
country_risk_premium : NonNegativeFloat
The country-specific risk premium.
fmp
===
Parameters
----------
All fields are standardized.
RiskPremium
-----------
All fields are standardized.
openbb
======

87
openbb_sdk/sdk/core/openbb_core/app/static/package/fixedincome.py
View File

@@ -2,14 +2,13 @@
import datetime
import typing
from typing import Annotated, Literal, Optional, Union
from typing import Literal, Optional, Union
from pydantic import validate_arguments
import openbb_core.app.model.command_context
import openbb_core.app.model.results.empty
from openbb_core.app.model.command_output import CommandOutput
from openbb_core.app.model.custom_parameter import OpenBBCustomParameter
from openbb_core.app.static.container import Container
from openbb_core.app.static.filters import filter_call, filter_inputs, filter_output
@@ -19,18 +18,8 @@ class CLASS_fixedincome(Container):
@validate_arguments
def treasury(
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,
start_date: Union[datetime.date, None, str] = None,
end_date: Union[datetime.date, None, str] = None,
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
@@ -38,6 +27,76 @@ class CLASS_fixedincome(Container):
"""Get treasury rates.
openbb
======
Parameters
----------
provider: Literal[fmp]
The provider to use for the query.
start_date : Optional[date]
Start date of the data, in YYYY-MM-DD format.
end_date : Optional[date]
End date of the data, in YYYY-MM-DD format.
Returns
-------
CommandOutput
results: List[Data]
Serializable results.
provider: Optional[PROVIDERS]
Provider name.
warnings: Optional[List[Warning_]]
List of warnings.
error: Optional[Error]
Caught exceptions.
chart: Optional[Chart]
Chart object.
TreasuryRates
-------------
date : date
The date of the data.
month_1 : float
The 1 month treasury rate.
month_2 : float
The 2 month treasury rate.
month_3 : float
The 3 month treasury rate.
month_6 : float
The 6 month treasury rate.
year_1 : float
The 1 year treasury rate.
year_2 : float
The 2 year treasury rate.
year_3 : float
The 3 year treasury rate.
year_5 : float
The 5 year treasury rate.
year_7 : float
The 7 year treasury rate.
year_10 : float
The 10 year treasury rate.
year_20 : float
The 20 year treasury rate.
year_30 : float
The 30 year treasury rate.
fmp
===
Parameters
----------
All fields are standardized.
TreasuryRates
-------------
All fields are standardized.
openbb
======

220
openbb_sdk/sdk/core/openbb_core/app/static/package/forex.py
View File

@@ -2,12 +2,11 @@
import datetime
import typing
from typing import Annotated, Literal, Optional, Union
from typing import Literal, Optional, Union
from pydantic import validate_arguments
from openbb_core.app.model.command_output import CommandOutput
from openbb_core.app.model.custom_parameter import OpenBBCustomParameter
from openbb_core.app.static.container import Container
from openbb_core.app.static.filters import filter_call, filter_inputs, filter_output
@@ -18,7 +17,7 @@ class CLASS_forex(Container):
def pairs(
self,
chart: bool = False,
provider: Optional[Literal["polygon", "fmp"]] = None,
provider: Optional[Literal["fmp", "polygon"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
"""Forex Available Pairs.
@@ -29,7 +28,7 @@ class CLASS_forex(Container):
Parameters
----------
provider: Literal[polygon, fmp]
provider: Literal[fmp, polygon]
The provider to use for the query.
All fields are standardized.
@@ -53,6 +52,25 @@ class CLASS_forex(Container):
name : str
The name of the currency pair.
fmp
===
Parameters
----------
All fields are standardized.
ForexPairs
----------
symbol : str
The symbol of the currency pair.
currency : str
The base currency of the currency pair.
stockExchange : Optional[str]
The stock exchange of the currency pair.
exchange_short_name : Optional[str]
The short name of the stock exchange of the currency pair.
polygon
=======
@@ -93,6 +111,37 @@ class CLASS_forex(Container):
delisted_utc : Optional[datetime]
The delisted timestamp in UTC.
openbb
======
Parameters
----------
provider: Literal[fmp, polygon]
The provider to use for the query.
All fields are standardized.
Returns
-------
CommandOutput
results: List[Data]
Serializable results.
provider: Optional[PROVIDERS]
Provider name.
warnings: Optional[List[Warning_]]
List of warnings.
error: Optional[Error]
Caught exceptions.
chart: Optional[Chart]
Chart object.
ForexPairs
----------
name : str
The name of the currency pair.
fmp
===
@@ -110,7 +159,47 @@ class CLASS_forex(Container):
stockExchange : Optional[str]
The stock exchange of the currency pair.
exchange_short_name : Optional[str]
The short name of the stock exchange of the currency pair."""
The short name of the stock exchange of the currency pair.
polygon
=======
Parameters
----------
symbol : Optional[str]
Symbol of the pair to search.
date : Optional[date]
A specific date to get data for.
search : Optional[str]
Search for terms within the ticker and/or company name.
active : Optional[Literal[True, False]]
Specify if the tickers returned should be actively traded on the queried date.
order : Optional[Literal['asc', 'desc']]
Order data by ascending or descending.
sort : Optional[Literal['ticker', 'name', 'market', 'locale', 'currency_symbol', 'currency_name', 'base_currency_symbol', 'base_currency_name', 'last_updated_utc', 'delisted_utc']]
Sort field used for ordering.
limit : Optional[PositiveInt]
The number of data entries to return.
ForexPairs
----------
market : str
The name of the trading market. Always 'fx'.
locale : str
The locale of the currency pair.
currency_symbol : str
The symbol of the quote currency.
currency_name : str
The name of the quote currency.
base_currency_symbol : str
The symbol of the base currency.
base_currency_name : str
The name of the base currency.
last_updated_utc : datetime
The last updated timestamp in UTC.
delisted_utc : Optional[datetime]
The delisted timestamp in UTC."""
inputs = filter_inputs(
provider_choices={
"provider": provider,
@@ -131,26 +220,14 @@ class CLASS_forex(Container):
@validate_arguments
def load(
self,
symbol: typing.Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
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,
symbol: str,
start_date: Union[datetime.date, None, str] = None,
end_date: Union[datetime.date, None, str] = None,
chart: bool = False,
provider: Optional[Literal["polygon", "fmp"]] = None,
provider: Optional[Literal["fmp", "polygon"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
"""Forex Intraday Price.
r"""Forex Intraday Price.
openbb
@@ -158,7 +235,7 @@ class CLASS_forex(Container):
Parameters
----------
provider: Literal[polygon, fmp]
provider: Literal[fmp, polygon]
The provider to use for the query.
symbol : ConstrainedStrValue
Symbol to get data for.
@@ -199,6 +276,29 @@ class CLASS_forex(Container):
vwap : Optional[PositiveFloat]
Volume Weighted Average Price of the symbol.
fmp
===
Parameters
----------
All fields are standardized.
ForexEOD
--------
adjClose : float
Adjusted Close Price of the symbol.
unadjustedVolume : float
Unadjusted volume of the symbol.
change : float
Change in the price of the symbol from the previous day.
changePercent : float
Change \% in the price of the symbol.
label : str
Human readable format of the date.
changeOverTime : float
Change \% in the price of the symbol over a period of time.
polygon
=======
@@ -221,6 +321,54 @@ class CLASS_forex(Container):
n : PositiveInt
The number of transactions for the symbol in the time period.
openbb
======
Parameters
----------
provider: Literal[fmp, polygon]
The provider to use for the query.
symbol : ConstrainedStrValue
Symbol to get data for.
start_date : Optional[date]
Start date of the data, in YYYY-MM-DD format.
end_date : Optional[date]
End date of the data, in YYYY-MM-DD format.
Returns
-------
CommandOutput
results: List[Data]
Serializable results.
provider: Optional[PROVIDERS]
Provider name.
warnings: Optional[List[Warning_]]
List of warnings.
error: Optional[Error]
Caught exceptions.
chart: Optional[Chart]
Chart object.
ForexEOD
--------
date : datetime
The date of the data.
open : PositiveFloat
The open price of the symbol.
high : PositiveFloat
The high price of the symbol.
low : PositiveFloat
The low price of the symbol.
close : PositiveFloat
The close price of the symbol.
volume : NonNegativeFloat
The volume of the symbol.
vwap : Optional[PositiveFloat]
Volume Weighted Average Price of the symbol.
fmp
===
@@ -238,11 +386,33 @@ class CLASS_forex(Container):
change : float
Change in the price of the symbol from the previous day.
changePercent : float
Change \\% in the price of the symbol.
Change \% in the price of the symbol.
label : str
Human readable format of the date.
changeOverTime : float
Change \\% in the price of the symbol over a period of time."""
Change \% in the price of the symbol over a period of time.
polygon
=======
Parameters
----------
timespan : Literal['minute', 'hour', 'day', 'week', 'month', 'quarter', 'year']
The timespan of the data.
sort : Literal['asc', 'desc']
Sort order of the data.
limit : PositiveInt
The number of data entries to return.
adjusted : bool
Whether the data is adjusted.
multiplier : PositiveInt
The multiplier of the timespan.
ForexEOD
--------
n : PositiveInt
The number of transactions for the symbol in the time period."""
inputs = filter_inputs(
provider_choices={
"provider": provider,

74
openbb_sdk/sdk/core/openbb_core/app/static/package/module_map.json vendored
View File

@@ -1,14 +1,7 @@
{
"news_globalnews": "/news/globalnews",
"crypto_load": "/crypto/load",
"__extensions__": "",
"news": "/news",
"news_sectornews": "/news/sectornews",
"fixedincome_treasury": "/fixedincome/treasury",
"fixedincome": "/fixedincome",
"fixedincome_ycrv": "/fixedincome/ycrv",
"forex_pairs": "/forex/pairs",
"forex": "/forex",
"forex_load": "/forex/load",
"crypto": "/crypto",
"economy_corecpi": "/economy/corecpi",
"economy": "/economy",
"economy_const": "/economy/const",
@@ -44,8 +37,41 @@
"economy_trust": "/economy/trust",
"economy_usbonds": "/economy/usbonds",
"economy_valuation": "/economy/valuation",
"crypto_load": "/crypto/load",
"crypto": "/crypto",
"fixedincome_treasury": "/fixedincome/treasury",
"fixedincome": "/fixedincome",
"fixedincome_ycrv": "/fixedincome/ycrv",
"forex_pairs": "/forex/pairs",
"forex": "/forex",
"forex_load": "/forex/load",
"news_globalnews": "/news/globalnews",
"news": "/news",
"news_sectornews": "/news/sectornews",
"qa_normality": "/qa/normality",
"qa": "/qa",
"qa_capm": "/qa/capm",
"qa_qqplot": "/qa/qqplot",
"qa_om": "/qa/om",
"qa_kurtosis": "/qa/kurtosis",
"qa_pick": "/qa/pick",
"qa_spread": "/qa/spread",
"qa_rolling": "/qa/rolling",
"qa_var": "/qa/var",
"qa_line": "/qa/line",
"qa_hist": "/qa/hist",
"qa_unitroot": "/qa/unitroot",
"qa_beta": "/qa/beta",
"qa_sh": "/qa/sh",
"qa_so": "/qa/so",
"qa_cusum": "/qa/cusum",
"qa_raw": "/qa/raw",
"qa_cdf": "/qa/cdf",
"qa_decompose": "/qa/decompose",
"qa_skew": "/qa/skew",
"qa_quantile": "/qa/quantile",
"qa_bw": "/qa/bw",
"qa_es": "/qa/es",
"qa_acf": "/qa/acf",
"qa_summary": "/qa/summary",
"stocks_fa_analysis": "/stocks/fa/analysis",
"stocks": "/stocks",
"stocks_fa": "/stocks/fa",
@@ -193,32 +219,6 @@
"stocks_tob": "/stocks/tob",
"stocks_quote": "/stocks/quote",
"stocks_search": "/stocks/search",
"qa_normality": "/qa/normality",
"qa": "/qa",
"qa_capm": "/qa/capm",
"qa_qqplot": "/qa/qqplot",
"qa_om": "/qa/om",
"qa_kurtosis": "/qa/kurtosis",
"qa_pick": "/qa/pick",
"qa_spread": "/qa/spread",
"qa_rolling": "/qa/rolling",
"qa_var": "/qa/var",
"qa_line": "/qa/line",
"qa_hist": "/qa/hist",
"qa_unitroot": "/qa/unitroot",
"qa_beta": "/qa/beta",
"qa_sh": "/qa/sh",
"qa_so": "/qa/so",
"qa_cusum": "/qa/cusum",
"qa_raw": "/qa/raw",
"qa_cdf": "/qa/cdf",
"qa_decompose": "/qa/decompose",
"qa_skew": "/qa/skew",
"qa_quantile": "/qa/quantile",
"qa_bw": "/qa/bw",
"qa_es": "/qa/es",
"qa_acf": "/qa/acf",
"qa_summary": "/qa/summary",
"ta_atr": "/ta/atr",
"ta": "/ta",
"ta_fib": "/ta/fib",

100
openbb_sdk/sdk/core/openbb_core/app/static/package/news.py
View File

@@ -9,7 +9,6 @@ from pydantic import validate_arguments
import openbb_core.app.model.command_context
import openbb_core.app.model.results.empty
from openbb_core.app.model.command_output import CommandOutput
from openbb_core.app.model.custom_parameter import OpenBBCustomParameter
from openbb_core.app.static.container import Container
from openbb_core.app.static.filters import filter_call, filter_inputs, filter_output
@@ -19,10 +18,7 @@ class CLASS_news(Container):
@validate_arguments
def globalnews(
self,
page: typing.Annotated[
pydantic.types.NonNegativeInt,
OpenBBCustomParameter(description="The page of the global news."),
] = 0,
page: pydantic.types.NonNegativeInt = 0,
chart: bool = False,
provider: Optional[Literal["benzinga", "fmp"]] = None,
**kwargs
@@ -30,6 +26,100 @@ class CLASS_news(Container):
"""Global News.
openbb
======
Parameters
----------
provider: Literal[benzinga, fmp]
The provider to use for the query.
page : NonNegativeInt
The page of the global news.
Returns
-------
CommandOutput
results: List[Data]
Serializable results.
provider: Optional[PROVIDERS]
Provider name.
warnings: Optional[List[Warning_]]
List of warnings.
error: Optional[Error]
Caught exceptions.
chart: Optional[Chart]
Chart object.
GlobalNews
----------
date : datetime
The published date of the news.
title : str
The title of the news.
image : Optional[str]
The image URL of the news.
text : str
The text/body of the news.
url : str
The URL of the news.
benzinga
========
Parameters
----------
pageSize : int
The number of results to return per page.
displayOutput : Literal['headline', 'summary', 'full', 'all']
The type of data to return.
date : Optional[datetime]
The date of the news to retrieve.
dateFrom : Optional[datetime]
The start date of the news to retrieve.
dateTo : Optional[datetime]
The end date of the news to retrieve.
updatedSince : Optional[int]
The number of seconds since the news was updated.
publishedSince : Optional[int]
The number of seconds since the news was published.
sort : Optional[Literal['published_at', 'updated_at', 'title', 'author', 'channel', 'ticker', 'topic', 'content_type']]
The order in which to sort the news. Options are: published_at, updated_at, title, author, channel, ticker, topic, content_type.
isin : Optional[str]
The ISIN of the news to retrieve.
cusip : Optional[str]
The CUSIP of the news to retrieve.
tickers : Optional[str]
The tickers of the news to retrieve.
channels : Optional[str]
The channels of the news to retrieve.
topics : Optional[str]
The topics of the news to retrieve.
authors : Optional[str]
The authors of the news to retrieve.
content_types : Optional[str]
The content types of the news to retrieve.
GlobalNews
----------
All fields are standardized.
fmp
===
Parameters
----------
All fields are standardized.
GlobalNews
----------
site : str
The site of the news.
openbb
======

463
openbb_sdk/sdk/core/openbb_core/app/static/package/stocks.py
View File

@@ -2,7 +2,7 @@
import datetime
import typing
from typing import Annotated, Literal, Optional, Union
from typing import Literal, Optional, Union
import pydantic
from pydantic import validate_arguments
@@ -10,7 +10,6 @@ from pydantic import validate_arguments
import openbb_core.app.model.command_context
import openbb_core.app.model.results.empty
from openbb_core.app.model.command_output import CommandOutput
from openbb_core.app.model.custom_parameter import OpenBBCustomParameter
from openbb_core.app.static.container import Container
from openbb_core.app.static.filters import filter_call, filter_inputs, filter_output
@@ -84,26 +83,14 @@ class CLASS_stocks(Container):
@validate_arguments
def load(
self,
symbol: typing.Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
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,
symbol: str,
start_date: Union[datetime.date, None, str] = None,
end_date: Union[datetime.date, None, str] = None,
chart: bool = False,
provider: Optional[Literal["polygon", "fmp"]] = None,
provider: Optional[Literal["fmp", "polygon"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
"""Load stock data for a specific ticker.
r"""Load stock data for a specific ticker.
openbb
@@ -111,7 +98,7 @@ class CLASS_stocks(Container):
Parameters
----------
provider: Literal[polygon, fmp]
provider: Literal[fmp, polygon]
The provider to use for the query.
symbol : ConstrainedStrValue
Symbol to get data for.
@@ -147,11 +134,35 @@ class CLASS_stocks(Container):
The low price of the symbol.
close : PositiveFloat
The close price of the symbol.
volume : PositiveFloat
volume : NonNegativeFloat
The volume of the symbol.
vwap : PositiveFloat
vwap : Optional[PositiveFloat]
Volume Weighted Average Price of the symbol.
fmp
===
Parameters
----------
timeseries : Optional[NonNegativeInt]
Number of days to look back.
StockEOD
--------
adjClose : float
Adjusted Close Price of the symbol.
unadjustedVolume : float
Unadjusted volume of the symbol.
change : float
Change in the price of the symbol from the previous day.
changePercent : float
Change \% in the price of the symbol.
label : str
Human readable format of the date.
changeOverTime : float
Change \% in the price of the symbol over a period of time.
polygon
=======
@@ -174,6 +185,54 @@ class CLASS_stocks(Container):
n : PositiveInt
The number of transactions for the symbol in the time period.
openbb
======
Parameters
----------
provider: Literal[fmp, polygon]
The provider to use for the query.
symbol : ConstrainedStrValue
Symbol to get data for.
start_date : Optional[date]
Start date of the data, in YYYY-MM-DD format.
end_date : Optional[date]
End date of the data, in YYYY-MM-DD format.
Returns
-------
CommandOutput
results: List[Data]
Serializable results.
provider: Optional[PROVIDERS]
Provider name.
warnings: Optional[List[Warning_]]
List of warnings.
error: Optional[Error]
Caught exceptions.
chart: Optional[Chart]
Chart object.
StockEOD
--------
date : datetime
The date of the data.
open : PositiveFloat
The open price of the symbol.
high : PositiveFloat
The high price of the symbol.
low : PositiveFloat
The low price of the symbol.
close : PositiveFloat
The close price of the symbol.
volume : NonNegativeFloat
The volume of the symbol.
vwap : Optional[PositiveFloat]
Volume Weighted Average Price of the symbol.
fmp
===
@@ -192,11 +251,33 @@ class CLASS_stocks(Container):
change : float
Change in the price of the symbol from the previous day.
changePercent : float
Change \\% in the price of the symbol.
Change \% in the price of the symbol.
label : str
Human readable format of the date.
changeOverTime : float
Change \\% in the price of the symbol over a period of time."""
Change \% in the price of the symbol over a period of time.
polygon
=======
Parameters
----------
timespan : Literal['minute', 'hour', 'day', 'week', 'month', 'quarter', 'year']
The timespan of the data.
sort : Literal['asc', 'desc']
Sort order of the data.
limit : PositiveInt
The number of data entries to return.
adjusted : bool
Whether the data is adjusted.
multiplier : PositiveInt
The multiplier of the timespan.
StockEOD
--------
n : PositiveInt
The number of transactions for the symbol in the time period."""
inputs = filter_inputs(
provider_choices={
"provider": provider,
@@ -221,23 +302,11 @@ class CLASS_stocks(Container):
@validate_arguments
def news(
self,
symbols: typing.Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
page: typing.Annotated[
int,
OpenBBCustomParameter(
description="The page of the stock news to be retrieved."
),
] = 0,
limit: Annotated[
Optional[pydantic.types.NonNegativeInt],
OpenBBCustomParameter(
description="The number of results to return per page."
),
] = 15,
symbols: str,
page: int = 0,
limit: Optional[pydantic.types.NonNegativeInt] = 15,
chart: bool = False,
provider: Optional[Literal["benzinga", "polygon", "fmp"]] = None,
provider: Optional[Literal["benzinga", "fmp", "polygon"]] = None,
**kwargs
) -> CommandOutput[typing.List]:
"""Get news for one or more stock tickers.
@@ -248,7 +317,7 @@ class CLASS_stocks(Container):
Parameters
----------
provider: Literal[benzinga, polygon, fmp]
provider: Literal[benzinga, fmp, polygon]
The provider to use for the query.
symbols : ConstrainedStrValue
Symbol to get data for.
@@ -321,6 +390,23 @@ class CLASS_stocks(Container):
image : List[BenzingaImage]
The images associated with the news.
fmp
===
Parameters
----------
All fields are standardized.
StockNews
---------
symbol : str
Ticker of the fetched news.
image : Optional[str]
URL to the image of the news source.
site : str
Name of the news source.
polygon
=======
@@ -367,6 +453,86 @@ class CLASS_stocks(Container):
tickers : List[str]
Tickers covered in the article.
openbb
======
Parameters
----------
provider: Literal[benzinga, fmp, polygon]
The provider to use for the query.
symbols : ConstrainedStrValue
Symbol to get data for.
page : int
The page of the stock news to be retrieved.
limit : Optional[NonNegativeInt]
The number of results to return per page.
Returns
-------
CommandOutput
results: List[Data]
Serializable results.
provider: Optional[PROVIDERS]
Provider name.
warnings: Optional[List[Warning_]]
List of warnings.
error: Optional[Error]
Caught exceptions.
chart: Optional[Chart]
Chart object.
StockNews
---------
date : date
The published date of the news.
title : str
The title of the news.
text : Optional[str]
The text/body of the news.
url : str
The URL of the news.
benzinga
========
Parameters
----------
displayOutput : Literal['headline', 'summary', 'full', 'all']
The type of data to return.
date : Optional[datetime]
The date of the news to retrieve.
dateFrom : Optional[datetime]
The start date of the news to retrieve.
dateTo : Optional[datetime]
The end date of the news to retrieve.
updatedSince : Optional[int]
The number of seconds since the news was updated.
publishedSince : Optional[int]
The number of seconds since the news was published.
sort : Optional[Literal['published_at', 'updated_at', 'title', 'author', 'channel', 'ticker', 'topic', 'content_type']]
The order in which to sort the news. Options are: published_at, updated_at, title, author, channel, ticker, topic, content_type.
isin : Optional[str]
The ISIN of the news to retrieve.
cusip : Optional[str]
The CUSIP of the news to retrieve.
channels : Optional[str]
The channels of the news to retrieve.
topics : Optional[str]
The topics of the news to retrieve.
authors : Optional[str]
The authors of the news to retrieve.
content_types : Optional[str]
The content types of the news to retrieve.
StockNews
---------
image : List[BenzingaImage]
The images associated with the news.
fmp
===
@@ -382,7 +548,53 @@ class CLASS_stocks(Container):
image : Optional[str]
URL to the image of the news source.
site : str
Name of the news source."""
Name of the news source.
polygon
=======
Parameters
----------
ticker_lt : Optional[str]
Less than, by default None
ticker_lte : Optional[str]
Less than or equal, by default None
ticker_gt : Optional[str]
Greater than, by default None
ticker_gte : Optional[str]
Greater than or equal, by default None
published_utc : Optional[str]
The published date of the query, by default None
published_utc_lt : Optional[str]
Less than, by default None
published_utc_lte : Optional[str]
Less than or equal, by default None
published_utc_gt : Optional[str]
Greater than, by default None
published_utc_gte : Optional[str]
Greater than or equal, by default None
order : Optional[Literal['asc', 'desc']]
The sort order of the query, by default None
sort : Optional[str]
The sort of the query, by default None
StockNews
---------
amp_url : Optional[str]
AMP URL.
author : Optional[str]
Author of the article.
id : str
Article ID.
image_url : Optional[str]
Image URL.
keywords : Optional[List[str]]
Keywords in the article
publisher : PolygonPublisher
Publisher of the article.
tickers : List[str]
Tickers covered in the article."""
inputs = filter_inputs(
provider_choices={
"provider": provider,
@@ -407,13 +619,8 @@ class CLASS_stocks(Container):
@validate_arguments
def multiples(
self,
symbol: typing.Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
limit: Annotated[
Optional[int],
OpenBBCustomParameter(description="The number of data entries to return."),
] = 100,
symbol: str,
limit: Optional[int] = 100,
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
@@ -573,6 +780,164 @@ class CLASS_stocks(Container):
All fields are standardized.
StockMultiples
--------------
All fields are standardized.
openbb
======
Parameters
----------
provider: Literal[fmp]
The provider to use for the query.
symbol : ConstrainedStrValue
Symbol to get data for.
limit : Optional[int]
The number of data entries to return.
Returns
-------
CommandOutput
results: List[Data]
Serializable results.
provider: Optional[PROVIDERS]
Provider name.
warnings: Optional[List[Warning_]]
List of warnings.
error: Optional[Error]
Caught exceptions.
chart: Optional[Chart]
Chart object.
StockMultiples
--------------
revenue_per_share_ttm : Optional[float]
Revenue per share calculated as trailing twelve months.
net_income_per_share_ttm : Optional[float]
Net income per share calculated as trailing twelve months.
operating_cash_flow_per_share_ttm : Optional[float]
Operating cash flow per share calculated as trailing twelve months.
free_cash_flow_per_share_ttm : Optional[float]
Free cash flow per share calculated as trailing twelve months.
cash_per_share_ttm : Optional[float]
Cash per share calculated as trailing twelve months.
book_value_per_share_ttm : Optional[float]
Book value per share calculated as trailing twelve months.
tangible_book_value_per_share_ttm : Optional[float]
Tangible book value per share calculated as trailing twelve months.
shareholders_equity_per_share_ttm : Optional[float]
Shareholders equity per share calculated as trailing twelve months.
interest_debt_per_share_ttm : Optional[float]
Interest debt per share calculated as trailing twelve months.
market_cap_ttm : Optional[float]
Market capitalization calculated as trailing twelve months.
enterprise_value_ttm : Optional[float]
Enterprise value calculated as trailing twelve months.
pe_ratio_ttm : Optional[float]
Price-to-earnings ratio (P/E ratio) calculated as trailing twelve months.
price_to_sales_ratio_ttm : Optional[float]
Price-to-sales ratio calculated as trailing twelve months.
pocf_ratio_ttm : Optional[float]
Price-to-operating cash flow ratio calculated as trailing twelve months.
pfcf_ratio_ttm : Optional[float]
Price-to-free cash flow ratio calculated as trailing twelve months.
pb_ratio_ttm : Optional[float]
Price-to-book ratio calculated as trailing twelve months.
ptb_ratio_ttm : Optional[float]
Price-to-tangible book ratio calculated as trailing twelve months.
ev_to_sales_ttm : Optional[float]
Enterprise value-to-sales ratio calculated as trailing twelve months.
enterprise_value_over_ebitda_ttm : Optional[float]
Enterprise value-to-EBITDA ratio calculated as trailing twelve months.
ev_to_operating_cash_flow_ttm : Optional[float]
Enterprise value-to-operating cash flow ratio calculated as trailing twelve months.
ev_to_free_cash_flow_ttm : Optional[float]
Enterprise value-to-free cash flow ratio calculated as trailing twelve months.
earnings_yield_ttm : Optional[float]
Earnings yield calculated as trailing twelve months.
free_cash_flow_yield_ttm : Optional[float]
Free cash flow yield calculated as trailing twelve months.
debt_to_equity_ttm : Optional[float]
Debt-to-equity ratio calculated as trailing twelve months.
debt_to_assets_ttm : Optional[float]
Debt-to-assets ratio calculated as trailing twelve months.
net_debt_to_ebitda_ttm : Optional[float]
Net debt-to-EBITDA ratio calculated as trailing twelve months.
current_ratio_ttm : Optional[float]
Current ratio calculated as trailing twelve months.
interest_coverage_ttm : Optional[float]
Interest coverage calculated as trailing twelve months.
income_quality_ttm : Optional[float]
Income quality calculated as trailing twelve months.
dividend_yield_ttm : Optional[float]
Dividend yield calculated as trailing twelve months.
payout_ratio_ttm : Optional[float]
Payout ratio calculated as trailing twelve months.
sales_general_and_administrative_to_revenue_ttm : Optional[float]
Sales general and administrative expenses-to-revenue ratio calculated as trailing twelve months.
research_and_development_to_revenue_ttm : Optional[float]
Research and development expenses-to-revenue ratio calculated as trailing twelve months.
intangibles_to_total_assets_ttm : Optional[float]
Intangibles-to-total assets ratio calculated as trailing twelve months.
capex_to_operating_cash_flow_ttm : Optional[float]
Capital expenditures-to-operating cash flow ratio calculated as trailing twelve months.
capex_to_revenue_ttm : Optional[float]
Capital expenditures-to-revenue ratio calculated as trailing twelve months.
capex_to_depreciation_ttm : Optional[float]
Capital expenditures-to-depreciation ratio calculated as trailing twelve months.
stock_based_compensation_to_revenue_ttm : Optional[float]
Stock-based compensation-to-revenue ratio calculated as trailing twelve months.
graham_number_ttm : Optional[float]
Graham number calculated as trailing twelve months.
roic_ttm : Optional[float]
Return on invested capital calculated as trailing twelve months.
return_on_tangible_assets_ttm : Optional[float]
Return on tangible assets calculated as trailing twelve months.
graham_net_net_ttm : Optional[float]
Graham net-net working capital calculated as trailing twelve months.
working_capital_ttm : Optional[float]
Working capital calculated as trailing twelve months.
tangible_asset_value_ttm : Optional[float]
Tangible asset value calculated as trailing twelve months.
net_current_asset_value_ttm : Optional[float]
Net current asset value calculated as trailing twelve months.
invested_capital_ttm : Optional[float]
Invested capital calculated as trailing twelve months.
average_receivables_ttm : Optional[float]
Average receivables calculated as trailing twelve months.
average_payables_ttm : Optional[float]
Average payables calculated as trailing twelve months.
average_inventory_ttm : Optional[float]
Average inventory calculated as trailing twelve months.
days_sales_outstanding_ttm : Optional[float]
Days sales outstanding calculated as trailing twelve months.
days_payables_outstanding_ttm : Optional[float]
Days payables outstanding calculated as trailing twelve months.
days_of_inventory_on_hand_ttm : Optional[float]
Days of inventory on hand calculated as trailing twelve months.
receivables_turnover_ttm : Optional[float]
Receivables turnover calculated as trailing twelve months.
payables_turnover_ttm : Optional[float]
Payables turnover calculated as trailing twelve months.
inventory_turnover_ttm : Optional[float]
Inventory turnover calculated as trailing twelve months.
roe_ttm : Optional[float]
Return on equity calculated as trailing twelve months.
capex_per_share_ttm : Optional[float]
Capital expenditures per share calculated as trailing twelve months.
fmp
===
Parameters
----------
All fields are standardized.
StockMultiples
--------------
All fields are standardized."""

51
openbb_sdk/sdk/core/openbb_core/app/static/package/stocks_ca.py
View File

@@ -8,7 +8,6 @@ from pydantic import validate_arguments
import openbb_core.app.model.command_context
import openbb_core.app.model.results.empty
from openbb_core.app.model.command_output import CommandOutput
from openbb_core.app.model.custom_parameter import OpenBBCustomParameter
from openbb_core.app.static.container import Container
from openbb_core.app.static.filters import filter_call, filter_inputs, filter_output
@@ -18,9 +17,7 @@ class CLASS_stocks_ca(Container):
@validate_arguments
def peers(
self,
symbol: typing.Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
symbol: str,
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
@@ -28,6 +25,52 @@ class CLASS_stocks_ca(Container):
"""Company peers.
openbb
======
Parameters
----------
provider: Literal[fmp]
The provider to use for the query.
symbol : ConstrainedStrValue
Symbol to get data for.
Returns
-------
CommandOutput
results: List[Data]
Serializable results.
provider: Optional[PROVIDERS]
Provider name.
warnings: Optional[List[Warning_]]
List of warnings.
error: Optional[Error]
Caught exceptions.
chart: Optional[Chart]
Chart object.
StockPeers
----------
symbol : str
Symbol representing the entity requested in the data.
peers_list : Optional[List[str]]
A list of stock peers based on sector, exchange and market cap.
fmp
===
Parameters
----------
All fields are standardized.
StockPeers
----------
All fields are standardized.
openbb
======

284
openbb_sdk/sdk/core/openbb_core/app/static/package/stocks_dd.py
View File

@@ -1,12 +1,11 @@
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
import typing
from typing import Annotated, Literal, Optional
from typing import Literal, Optional
from pydantic import validate_arguments
from openbb_core.app.model.command_output import CommandOutput
from openbb_core.app.model.custom_parameter import OpenBBCustomParameter
from openbb_core.app.static.container import Container
from openbb_core.app.static.filters import filter_call, filter_inputs, filter_output
@@ -16,122 +15,111 @@ class CLASS_stocks_dd(Container):
@validate_arguments
def sec(
self,
symbol: typing.Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
type: Annotated[
Literal[
"1",
"1-A",
"1-E",
"1-K",
"1-N",
"1-SA",
"1-U",
"1-Z",
"10",
"10-D",
"10-K",
"10-M",
"10-Q",
"11-K",
"12b-25",
"13F",
"13H",
"144",
"15",
"15F",
"17-H",
"18",
"18-K",
"19b-4",
"19b-4(e)",
"19b-7",
"2-E",
"20-F",
"24F-2",
"25",
"3",
"4",
"40-F",
"5",
"6-K",
"7-M",
"8-A",
"8-K",
"8-M",
"9-M",
"ABS-15G",
"ABS-EE",
"ABS DD-15E",
"ADV",
"ADV-E",
"ADV-H",
"ADV-NR",
"ADV-W",
"ATS",
"ATS-N",
"ATS-R",
"BD",
"BD-N",
"BDW",
"C",
"CA-1",
"CB",
"CFPORTAL",
"CRS",
"CUSTODY",
"D",
"F-1",
"F-10",
"F-3",
"F-4",
"F-6",
"F-7",
"F-8",
"F-80",
"F-N",
"F-X",
"ID",
"MA",
"MA-I",
"MA-NR",
"MA-W",
"MSD",
"MSDW",
"N-14",
"N-17D-1",
"N-17f-1",
"N-17f-2",
"N-18f-1",
"N-1A",
"N-2",
"N-23c-3",
"N-27D-1",
"N-3",
"N-4",
"N-5",
"N-54A",
"N-54C",
"N-6",
"N-6EI-1",
"N-6F",
"N-8A",
"N-8B-2",
"N-8B-4",
"N-8F",
"N-CEN",
],
OpenBBCustomParameter(description="The type of the SEC filing form."),
symbol: str,
type: Literal[
"1",
"1-A",
"1-E",
"1-K",
"1-N",
"1-SA",
"1-U",
"1-Z",
"10",
"10-D",
"10-K",
"10-M",
"10-Q",
"11-K",
"12b-25",
"13F",
"13H",
"144",
"15",
"15F",
"17-H",
"18",
"18-K",
"19b-4",
"19b-4(e)",
"19b-7",
"2-E",
"20-F",
"24F-2",
"25",
"3",
"4",
"40-F",
"5",
"6-K",
"7-M",
"8-A",
"8-K",
"8-M",
"9-M",
"ABS-15G",
"ABS-EE",
"ABS DD-15E",
"ADV",
"ADV-E",
"ADV-H",
"ADV-NR",
"ADV-W",
"ATS",
"ATS-N",
"ATS-R",
"BD",
"BD-N",
"BDW",
"C",
"CA-1",
"CB",
"CFPORTAL",
"CRS",
"CUSTODY",
"D",
"F-1",
"F-10",
"F-3",
"F-4",
"F-6",
"F-7",
"F-8",
"F-80",
"F-N",
"F-X",
"ID",
"MA",
"MA-I",
"MA-NR",
"MA-W",
"MSD",
"MSDW",
"N-14",
"N-17D-1",
"N-17f-1",
"N-17f-2",
"N-18f-1",
"N-1A",
"N-2",
"N-23c-3",
"N-27D-1",
"N-3",
"N-4",
"N-5",
"N-54A",
"N-54C",
"N-6",
"N-6EI-1",
"N-6F",
"N-8A",
"N-8B-2",
"N-8B-4",
"N-8F",
"N-CEN",
] = "10-K",
page: Annotated[
Optional[int],
OpenBBCustomParameter(description="Page number of the results."),
] = 0,
limit: Annotated[
Optional[int],
OpenBBCustomParameter(description="The number of data entries to return."),
] = 100,
page: Optional[int] = 0,
limit: Optional[int] = 100,
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs
@@ -139,6 +127,68 @@ class CLASS_stocks_dd(Container):
"""SEC Filings.
openbb
======
Parameters
----------
provider: Literal[fmp]
The provider to use for the query.
symbol : ConstrainedStrValue
Symbol to get data for.
type : Literal['1', '1-A', '1-E', '1-K', '1-N', '1-SA', '1-U', '1-Z', '10', '10-D', '10-K', '10-M', '10-Q', '11-K', '12b-25', '13F', '13H', '144', '15', '15F', '17-H', '18', '18-K', '19b-4', '19b-4(e)', '19b-7', '2-E', '20-F', '24F-2', '25', '3', '4', '40-F', '5', '6-K', '7-M', '8-A', '8-K', '8-M', '9-M', 'ABS-15G', 'ABS-EE', 'ABS DD-15E', 'ADV', 'ADV-E', 'ADV-H', 'ADV-NR', 'ADV-W', 'ATS', 'ATS-N', 'ATS-R', 'BD', 'BD-N', 'BDW', 'C', 'CA-1', 'CB', 'CFPORTAL', 'CRS', 'CUSTODY', 'D', 'F-1', 'F-10', 'F-3', 'F-4', 'F-6', 'F-7', 'F-8', 'F-80', 'F-N', 'F-X', 'ID', 'MA', 'MA-I', 'MA-NR', 'MA-W', 'MSD', 'MSDW', 'N-14', 'N-17D-1', 'N-17f-1', 'N-17f-2', 'N-18f-1', 'N-1A', 'N-2', 'N-23c-3', 'N-27D-1', 'N-3', 'N-4', 'N-5', 'N-54A', 'N-54C', 'N-6', 'N-6EI-1', 'N-6F', 'N-8A', 'N-8B-2', 'N-8B-4', 'N-8F', 'N-CEN']
The type of the SEC filing form.
page : Optional[int]
Page number of the results.
limit : Optional[int]
The number of data entries to return.
Returns
-------
CommandOutput
results: List[Data]
Serializable results.
provider: Optional[PROVIDERS]
Provider name.
warnings: Optional[List[Warning_]]
List of warnings.
error: Optional[Error]
Caught exceptions.
chart: Optional[Chart]
Chart object.
SECFilings
----------
symbol : ConstrainedStrValue
Symbol to get data for.
filling_date : datetime
The filling date of the SEC filing.
accepted_date : datetime
The accepted date of the SEC filing.
cik : str
The CIK of the SEC filing.
type : str
The type of the SEC filing.
link : str
The link of the SEC filing.
final_link : str
The final link of the SEC filing.
fmp
===
Parameters
----------
All fields are standardized.
SECFilings
----------
All fields are standardized.
openbb
======

2719
openbb_sdk/sdk/core/openbb_core/app/static/package/stocks_fa.py
View File

File diff suppressed because it is too large Load Diff

7
openbb_sdk/sdk/provider/openbb_provider/standard_models/stock_eod.py
View File

@@ -4,12 +4,11 @@
from datetime import date, datetime
from typing import Optional
from pydantic import Field, PositiveFloat
from openbb_provider.abstract.data import Data
from openbb_provider.abstract.query_params import QueryParams
from openbb_provider.standard_models.base import BaseSymbol
from openbb_provider.utils.descriptions import DATA_DESCRIPTIONS, QUERY_DESCRIPTIONS
from pydantic import Field, NonNegativeFloat, PositiveFloat
class StockEODQueryParams(QueryParams, BaseSymbol):
@@ -33,5 +32,5 @@ class StockEODData(Data):
high: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("high", ""))
low: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("low", ""))
close: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("close", ""))
volume: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("volume", ""))
vwap: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("vwap", ""))
volume: NonNegativeFloat = Field(description=DATA_DESCRIPTIONS.get("volume", ""))
vwap: Optional[PositiveFloat] = Field(description=DATA_DESCRIPTIONS.get("vwap", ""))