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

build package

Browse Source
This commit is contained in:
tehcoderer
2023-08-09 11:48:01 -04:00
parent 47bad0d40f
commit 9afe9fde22
9 changed files with 519 additions and 351 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,16 +1,23 @@
### 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"
@@ -27,24 +34,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"
@@ -52,6 +45,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

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

@@ -33,7 +33,7 @@ class CLASS_crypto(Container):
),
] = None,
chart: bool = False,
provider: Optional[Literal["polygon", "fmp"]] = None,
provider: Optional[Literal["fmp", "polygon"]] = None,
**kwargs,
) -> CommandOutput[typing.List]:
"""Crypto Intraday Price.
@@ -44,7 +44,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,28 +85,6 @@ class CLASS_crypto(Container):
vwap : PositiveFloat
Volume Weighted Average Price of the symbol.
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.
fmp
===
@@ -129,7 +107,29 @@ class CLASS_crypto(Container):
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.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,

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

@@ -342,7 +342,7 @@ class CLASS_economy(Container):
),
] = 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.
@@ -353,7 +353,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.
@@ -394,32 +394,6 @@ class CLASS_economy(Container):
vwap : Optional[float]
Volume Weighted Average Price of the symbol.
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.
fmp
===
@@ -443,8 +417,30 @@ class CLASS_economy(Container):
Change \\% in the price of the symbol.
label : Optional[str]
Human readable format of the date.
changeOverTime : float
Change \\% in the price of the symbol over a period of time."""
changeOverTime : Optional[float]
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
---------------
n : PositiveInt
The number of transactions for the symbol in the time period.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,

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

@@ -18,7 +18,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 +29,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 +53,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
=======
@@ -91,26 +110,7 @@ class CLASS_forex(Container):
last_updated_utc : datetime
The last updated timestamp in UTC.
delisted_utc : Optional[datetime]
The delisted timestamp in UTC.
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."""
The delisted timestamp in UTC.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
@@ -147,7 +147,7 @@ class CLASS_forex(Container):
),
] = None,
chart: bool = False,
provider: Optional[Literal["polygon", "fmp"]] = None,
provider: Optional[Literal["fmp", "polygon"]] = None,
**kwargs,
) -> CommandOutput[typing.List]:
"""Forex Intraday Price.
@@ -158,7 +158,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,28 +199,6 @@ class CLASS_forex(Container):
vwap : Optional[PositiveFloat]
Volume Weighted Average Price of the symbol.
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.
fmp
===
@@ -242,7 +220,29 @@ class CLASS_forex(Container):
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.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,

76
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",
@@ -83,8 +109,8 @@
"stocks_fa_own": "/stocks/fa/own",
"stocks_fa_pt": "/stocks/fa/pt",
"stocks_fa_pta": "/stocks/fa/pta",
"stocks_fa_rating": "/stocks/fa/rating",
"stocks_fa_ratios": "/stocks/fa/ratios",
"stocks_fa_rating": "/stocks/fa/rating",
"stocks_fa_revfc": "/stocks/fa/revfc",
"stocks_fa_revgeo": "/stocks/fa/revgeo",
"stocks_fa_revseg": "/stocks/fa/revseg",
@@ -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",

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

@@ -100,7 +100,7 @@ class CLASS_stocks(Container):
),
] = 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.
@@ -111,7 +111,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,33 +147,11 @@ class CLASS_stocks(Container):
The low price of the symbol.
close : PositiveFloat
The close price of the symbol.
volume : NonNegativeFloat
volume : float
The volume of the symbol.
vwap : Optional[PositiveFloat]
Volume Weighted Average Price of the symbol.
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.
fmp
===
@@ -197,8 +175,30 @@ class CLASS_stocks(Container):
Change \\% in the price of the symbol.
label : Optional[str]
Human readable format of the date.
changeOverTime : float
Change \\% in the price of the symbol over a period of time."""
changeOverTime : Optional[float]
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 : Optional[PositiveInt]
The number of transactions for the symbol in the time period.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
@@ -239,7 +239,7 @@ class CLASS_stocks(Container):
),
] = 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.
@@ -250,7 +250,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.
@@ -331,6 +331,23 @@ class CLASS_stocks(Container):
teaser : Optional[str]
The teaser of 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
=======
@@ -375,24 +392,7 @@ class CLASS_stocks(Container):
publisher : PolygonPublisher
Publisher of the article.
tickers : List[str]
Tickers covered in the article.
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."""
Tickers covered in the article.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
@@ -632,7 +632,9 @@ class CLASS_stocks(Container):
@validate_arguments
def quote(
self,
symbol: str,
symbol: typing.Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs,

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

@@ -1,5 +1,6 @@
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
import typing
from typing import Literal, Optional
from pydantic import BaseModel, validate_arguments

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

@@ -5,6 +5,7 @@ import typing
from typing import Annotated, List, Literal, Optional, Union
import pydantic
import pydantic.main
from pydantic import BaseModel, validate_arguments
import openbb_core.app.model.command_context
@@ -51,7 +52,7 @@ class CLASS_stocks_fa(Container):
OpenBBCustomParameter(description="The number of data entries to return."),
] = 12,
chart: bool = False,
provider: Optional[Literal["polygon", "fmp"]] = None,
provider: Optional[Literal["fmp", "polygon"]] = None,
**kwargs,
) -> CommandOutput[typing.List]:
"""Balance Sheet.
@@ -62,7 +63,7 @@ class CLASS_stocks_fa(Container):
Parameters
----------
provider: Literal[polygon, fmp]
provider: Literal[fmp, polygon]
The provider to use for the query.
symbol : ConstrainedStrValue
Symbol to get data for.
@@ -175,6 +176,42 @@ class CLASS_stocks_fa(Container):
total_liabilities_and_total_equity : Optional[int]
None
fmp
===
Parameters
----------
cik : Optional[str]
None
BalanceSheet
------------
calendarYear : Optional[int]
None
link : Optional[str]
None
finalLink : Optional[str]
None
cashAndShortTermInvestments : Optional[int]
None
goodwillAndIntangibleAssets : Optional[int]
None
deferredRevenueNonCurrent : Optional[int]
None
totalInvestments : Optional[int]
None
capitalLeaseObligations : Optional[int]
None
deferredTaxLiabilitiesNonCurrent : Optional[int]
None
totalNonCurrentLiabilities : Optional[int]
None
totalDebt : Optional[int]
None
netDebt : Optional[int]
None
polygon
=======
@@ -216,43 +253,7 @@ class CLASS_stocks_fa(Container):
BalanceSheet
------------
All fields are standardized.
fmp
===
Parameters
----------
cik : Optional[str]
None
BalanceSheet
------------
calendarYear : Optional[int]
None
link : Optional[str]
None
finalLink : Optional[str]
None
cashAndShortTermInvestments : Optional[int]
None
goodwillAndIntangibleAssets : Optional[int]
None
deferredRevenueNonCurrent : Optional[int]
None
totalInvestments : Optional[int]
None
capitalLeaseObligations : Optional[int]
None
deferredTaxLiabilitiesNonCurrent : Optional[int]
None
totalNonCurrentLiabilities : Optional[int]
None
totalDebt : Optional[int]
None
netDebt : Optional[int]
None"""
All fields are standardized.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
@@ -552,7 +553,7 @@ class CLASS_stocks_fa(Container):
OpenBBCustomParameter(description="The number of data entries to return."),
] = 12,
chart: bool = False,
provider: Optional[Literal["polygon", "fmp"]] = None,
provider: Optional[Literal["fmp", "polygon"]] = None,
**kwargs,
) -> CommandOutput[typing.List]:
"""Cash Flow Statement.
@@ -563,7 +564,7 @@ class CLASS_stocks_fa(Container):
Parameters
----------
provider: Literal[polygon, fmp]
provider: Literal[fmp, polygon]
The provider to use for the query.
symbol : ConstrainedStrValue
Symbol to get data for.
@@ -656,6 +657,24 @@ class CLASS_stocks_fa(Container):
cash_at_end_of_period : Optional[int]
None
fmp
===
Parameters
----------
cik : Optional[str]
Central Index Key (CIK) of the company.
CashFlowStatement
-----------------
calendarYear : Optional[int]
None
link : Optional[str]
None
finalLink : Optional[str]
None
polygon
=======
@@ -697,25 +716,7 @@ class CLASS_stocks_fa(Container):
CashFlowStatement
-----------------
All fields are standardized.
fmp
===
Parameters
----------
cik : Optional[str]
Central Index Key (CIK) of the company.
CashFlowStatement
-----------------
calendarYear : Optional[int]
None
link : Optional[str]
None
finalLink : Optional[str]
None"""
All fields are standardized.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
@@ -1433,7 +1434,7 @@ class CLASS_stocks_fa(Container):
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
period: Annotated[
Literal["quarterly", "annually"],
Literal["annually", "quarterly"],
OpenBBCustomParameter(
description="Period of the data to return (quarterly or annually)."
),
@@ -1658,7 +1659,7 @@ class CLASS_stocks_fa(Container):
OpenBBCustomParameter(description="The number of data entries to return."),
] = 12,
chart: bool = False,
provider: Optional[Literal["polygon", "fmp"]] = None,
provider: Optional[Literal["fmp", "polygon"]] = None,
**kwargs,
) -> CommandOutput[typing.List]:
"""Income Statement.
@@ -1669,7 +1670,7 @@ class CLASS_stocks_fa(Container):
Parameters
----------
provider: Literal[polygon, fmp]
provider: Literal[fmp, polygon]
The provider to use for the query.
symbol : ConstrainedStrValue
Symbol to get data for.
@@ -1772,6 +1773,19 @@ class CLASS_stocks_fa(Container):
final_link : Optional[str]
Final link to the income statement.
fmp
===
Parameters
----------
cik : Optional[str]
The CIK of the company if no symbol is provided.
IncomeStatement
---------------
All fields are standardized.
polygon
=======
@@ -1826,35 +1840,7 @@ class CLASS_stocks_fa(Container):
participating_securities_distributed_and_undistributed_earnings_loss_basic : Optional[float]
None
preferred_stock_dividends_and_other_adjustments : Optional[float]
None
fmp
===
Parameters
----------
cik : Optional[str]
The CIK of the company if no symbol is provided.
IncomeStatement
---------------
calendarYear : Optional[int]
None
grossProfitRatio : Optional[float]
None
ebitdaratio : Optional[float]
None
operatingIncomeRatio : Optional[float]
None
incomeBeforeTaxRatio : Optional[float]
None
netIncomeRatio : Optional[float]
None
link : Optional[str]
None
finalLink : Optional[str]
None"""
None""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
@@ -3150,6 +3136,207 @@ class CLASS_stocks_fa(Container):
return filter_output(o)
@filter_call
@validate_arguments
def ratios(
self,
symbol: typing.Annotated[
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
period: Annotated[
Literal["annually", "quarterly"],
OpenBBCustomParameter(
description="Period of the data to return (quarterly or annually)."
),
] = "annually",
limit: Annotated[
Optional[pydantic.types.NonNegativeInt],
OpenBBCustomParameter(description="The number of data entries to return."),
] = 12,
chart: bool = False,
provider: Optional[Literal["fmp"]] = None,
**kwargs,
) -> CommandOutput[typing.List]:
"""Extensive set of ratios over time.
openbb
======
Parameters
----------
provider: Literal[fmp]
The provider to use for the query.
symbol : ConstrainedStrValue
Symbol to get data for.
period : Literal['annually', 'quarterly']
Period of the data to return (quarterly or annually).
limit : Optional[NonNegativeInt]
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.
FinancialRatios
---------------
symbol : str
The symbol of the company.
date : str
The date of the financial ratios.
period : str
The period of the financial ratios.
current_ratio : Optional[float]
The current ratio.
quick_ratio : Optional[float]
The quick ratio.
cash_ratio : Optional[float]
The cash ratio.
days_of_sales_outstanding : Optional[float]
Days of sales outstanding.
days_of_inventory_outstanding : Optional[float]
Days of inventory outstanding.
operating_cycle : Optional[float]
Operating cycle.
days_of_payables_outstanding : Optional[float]
Days of payables outstanding.
cash_conversion_cycle : Optional[float]
Cash conversion cycle.
gross_profit_margin : Optional[float]
Gross profit margin.
operating_profit_margin : Optional[float]
Operating profit margin.
pretax_profit_margin : Optional[float]
Pretax profit margin.
net_profit_margin : Optional[float]
Net profit margin.
effective_tax_rate : Optional[float]
Effective tax rate.
return_on_assets : Optional[float]
Return on assets.
return_on_equity : Optional[float]
Return on equity.
return_on_capital_employed : Optional[float]
Return on capital employed.
net_income_per_ebt : Optional[float]
Net income per EBT.
ebt_per_ebit : Optional[float]
EBT per EBIT.
ebit_per_revenue : Optional[float]
EBIT per revenue.
debt_ratio : Optional[float]
Debt ratio.
debt_equity_ratio : Optional[float]
Debt equity ratio.
long_term_debt_to_capitalization : Optional[float]
Long term debt to capitalization.
total_debt_to_capitalization : Optional[float]
Total debt to capitalization.
interest_coverage : Optional[float]
Interest coverage.
cash_flow_to_debt_ratio : Optional[float]
Cash flow to debt ratio.
company_equity_multiplier : Optional[float]
Company equity multiplier.
receivables_turnover : Optional[float]
Receivables turnover.
payables_turnover : Optional[float]
Payables turnover.
inventory_turnover : Optional[float]
Inventory turnover.
fixed_asset_turnover : Optional[float]
Fixed asset turnover.
asset_turnover : Optional[float]
Asset turnover.
operating_cash_flow_per_share : Optional[float]
Operating cash flow per share.
free_cash_flow_per_share : Optional[float]
Free cash flow per share.
cash_per_share : Optional[float]
Cash per share.
payout_ratio : Optional[float]
Payout ratio.
operating_cash_flow_sales_ratio : Optional[float]
Operating cash flow sales ratio.
free_cash_flow_operating_cash_flow_ratio : Optional[float]
Free cash flow operating cash flow ratio.
cash_flow_coverage_ratios : Optional[float]
Cash flow coverage ratios.
short_term_coverage_ratios : Optional[float]
Short term coverage ratios.
capital_expenditure_coverage_ratio : Optional[float]
Capital expenditure coverage ratio.
dividend_paid_and_capex_coverage_ratio : Optional[float]
Dividend paid and capex coverage ratio.
dividend_payout_ratio : Optional[float]
Dividend payout ratio.
price_book_value_ratio : Optional[float]
Price book value ratio.
price_to_book_ratio : Optional[float]
Price to book ratio.
price_to_sales_ratio : Optional[float]
Price to sales ratio.
price_earnings_ratio : Optional[float]
Price earnings ratio.
price_to_free_cash_flows_ratio : Optional[float]
Price to free cash flows ratio.
price_to_operating_cash_flows_ratio : Optional[float]
Price to operating cash flows ratio.
price_cash_flow_ratio : Optional[float]
Price cash flow ratio.
price_earnings_to_growth_ratio : Optional[float]
Price earnings to growth ratio.
price_sales_ratio : Optional[float]
Price sales ratio.
dividend_yield : Optional[float]
Dividend yield.
enterprise_value_multiple : Optional[float]
Enterprise value multiple.
price_fair_value : Optional[float]
Price fair value.
fmp
===
Parameters
----------
All fields are standardized.
FinancialRatios
---------------
All fields are standardized.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": symbol,
"period": period,
"limit": limit,
},
extra_params=kwargs,
chart=chart,
)
o = self._command_runner_session.run(
"/stocks/fa/ratios",
**inputs,
).output
return filter_output(o)
@filter_call
@validate_arguments
def rating(
@@ -3167,23 +3354,6 @@ class CLASS_stocks_fa(Container):
return filter_output(o)
@filter_call
@validate_arguments
def ratios(
self, chart: bool = False
) -> CommandOutput[openbb_core.app.model.results.empty.Empty]:
"""Extensive set of ratios over time.""" # noqa: E501
inputs = filter_inputs(
chart=chart,
)
o = self._command_runner_session.run(
"/stocks/fa/ratios",
**inputs,
).output
return filter_output(o)
@filter_call
@validate_arguments
def revfc(
@@ -3209,7 +3379,7 @@ class CLASS_stocks_fa(Container):
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
period: Annotated[
Literal["quarterly", "annually"],
Literal["annually", "quarterly"],
OpenBBCustomParameter(
description="Period of the data to return (quarterly or annually)."
),
@@ -3310,7 +3480,7 @@ class CLASS_stocks_fa(Container):
str, OpenBBCustomParameter(description="Symbol to get data for.")
],
period: Annotated[
Literal["quarterly", "annually"],
Literal["annually", "quarterly"],
OpenBBCustomParameter(
description="Period of the data to return (quarterly or annually)."
),

62
openbb_sdk/sdk/core/openbb_core/app/static/package/ta.py
View File

@@ -57,7 +57,7 @@ class CLASS_ta(Container):
>>> from openbb import obb
>>> stock_data = obb.stocks.load(symbol="TSLA", start_date="2023-01-01", provider="fmp")
>>> atr_data = obb.ta.atr(data=stock_data.results)
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
index=index,
@@ -109,7 +109,7 @@ class CLASS_ta(Container):
>>> from openbb import obb
>>> stock_data = obb.stocks.load(symbol="TSLA", start_date="2023-01-01", provider="fmp")
>>> fib_data = obb.ta.fib(data=stock_data.results, period=120)
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
index=index,
@@ -166,7 +166,7 @@ class CLASS_ta(Container):
>>> from openbb import obb
>>> stock_data = obb.stocks.load(symbol="TSLA", start_date="2023-01-01", provider="fmp")
>>> obv_data = obb.ta.obv(data=stock_data.results, offset=0)
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
index=index,
@@ -219,7 +219,7 @@ class CLASS_ta(Container):
>>> from openbb import obb
>>> stock_data = obb.stocks.load(symbol="TSLA", start_date="2023-01-01", provider="fmp")
>>> fisher_data = obb.ta.fisher(data=stock_data.results, length=14, signal=1)
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
index=index,
@@ -275,7 +275,7 @@ class CLASS_ta(Container):
>>> from openbb import obb
>>> stock_data = obb.stocks.load(symbol="TSLA", start_date="2023-01-01", provider="fmp")
>>> adosc_data = obb.ta.adosc(data=stock_data.results, fast=3, slow=10, offset=0)
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
index=index,
@@ -297,7 +297,7 @@ class CLASS_ta(Container):
def tv(
self, chart: bool = False
) -> CommandOutput[openbb_core.app.model.results.empty.Empty]:
"""TradingView."""
"""TradingView.""" # noqa: E501
inputs = filter_inputs(
chart=chart,
)
@@ -365,7 +365,7 @@ class CLASS_ta(Container):
>>> bbands = obb.ta.bbands(
>>> data=stock_data.results, target="close", length=50, std=2, mamode="sma", offset=0
>>> )
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
target=target,
@@ -389,7 +389,7 @@ class CLASS_ta(Container):
def multi(
self, chart: bool = False
) -> CommandOutput[openbb_core.app.model.results.empty.Empty]:
"""Plot multiple indicators on the same chart."""
"""Plot multiple indicators on the same chart.""" # noqa: E501
inputs = filter_inputs(
chart=chart,
)
@@ -444,7 +444,7 @@ class CLASS_ta(Container):
>>> from openbb import obb
>>> stock_data = obb.stocks.load(symbol="TSLA", start_date="2023-01-01", provider="fmp")
>>> zlma_data = obb.ta.zlma(data=stock_data.results, target="close", length=50, offset=0)
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
target=target,
@@ -506,7 +506,7 @@ class CLASS_ta(Container):
>>> from openbb import obb
>>> stock_data = obb.stocks.load(symbol="TSLA", start_date="2023-01-01", provider="fmp")
>>> aroon_data = obb.ta.aroon(data=stock_data.results, length=25, scalar=100)
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
index=index,
@@ -565,7 +565,7 @@ class CLASS_ta(Container):
>>> from openbb import obb
>>> stock_data = obb.stocks.load(symbol="TSLA", start_date="2023-01-01", provider="fmp")
>>> sma_data = obb.ta.sma(data=stock_data.results,target="close",length=50,offset=0)
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
target=target,
@@ -622,7 +622,7 @@ class CLASS_ta(Container):
>>> from openbb import obb
>>> stock_data = obb.stocks.load(symbol="TSLA", start_date="2023-01-01", provider="fmp")
>>> demark_data = obb.ta.demark(data=stock_data.results,offset=0)
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
index=index,
@@ -677,7 +677,7 @@ class CLASS_ta(Container):
>>> from openbb import obb
>>> stock_data = obb.stocks.load(symbol="TSLA", start_date="2023-01-01", provider="fmp")
>>> vwap_data = obb.ta.vwap(data=stock_data.results,anchor="D",offset=0)
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
index=index,
@@ -698,7 +698,7 @@ class CLASS_ta(Container):
def recom(
self, chart: bool = False
) -> CommandOutput[openbb_core.app.model.results.empty.Empty]:
"""Recommendation."""
"""Recommendation.""" # noqa: E501
inputs = filter_inputs(
chart=chart,
)
@@ -758,7 +758,7 @@ class CLASS_ta(Container):
>>> from openbb import obb
>>> stock_data = obb.stocks.load(symbol="TSLA", start_date="2023-01-01", provider="fmp")
>>> macd_data = obb.ta.macd(data=stock_data.results,target="close",fast=12,slow=26,signal=9)
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
target=target,
@@ -816,7 +816,7 @@ class CLASS_ta(Container):
>>> from openbb import obb
>>> stock_data = obb.stocks.load(symbol="TSLA", start_date="2023-01-01", provider="fmp")
>>> hma_data = obb.ta.hma(data=stock_data.results,target="close",length=50,offset=0)
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
target=target,
@@ -875,7 +875,7 @@ class CLASS_ta(Container):
>>> from openbb import obb
>>> stock_data = obb.stocks.load(symbol="TSLA", start_date="2023-01-01", provider="fmp")
>>> donchian_data = obb.ta.donchian(data=stock_data.results,lower_length=20,upper_length=20,offset=0)
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
index=index,
@@ -927,7 +927,7 @@ class CLASS_ta(Container):
Number of periods for the offset, by default 26.
lookahead : bool, optional
drops the Chikou Span Column to prevent potential data leak
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
index=index,
@@ -980,7 +980,7 @@ class CLASS_ta(Container):
>>> from openbb import obb
>>> stock_data = obb.stocks.load(symbol="TSLA", start_date="2023-01-01", provider="fmp")
>>> clenow_data = obb.ta.clenow(data=stock_data.results,period=90)
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
index=index,
@@ -1037,7 +1037,7 @@ class CLASS_ta(Container):
>>> from openbb import obb
>>> stock_data = obb.stocks.load(symbol="TSLA", start_date="2023-01-01", provider="fmp")
>>> ad_data = obb.ta.ad(data=stock_data.results,offset=0)
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
index=index,
@@ -1091,7 +1091,7 @@ class CLASS_ta(Container):
>>> from openbb import obb
>>> stock_data = obb.stocks.load(symbol="TSLA", start_date="2023-01-01", provider="fmp")
>>> adx_data = obb.ta.adx(data=stock_data.results,length=50,scalar=100.0,drift=1)
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
index=index,
@@ -1148,7 +1148,7 @@ class CLASS_ta(Container):
>>> from openbb import obb
>>> stock_data = obb.stocks.load(symbol="TSLA", start_date="2023-01-01", provider="fmp")
>>> wma_data = obb.ta.wma(data=stock_data.results, target="close", length=50, offset=0)
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
target=target,
@@ -1197,7 +1197,7 @@ class CLASS_ta(Container):
-------
CommandOutput[List[Data]]
The CCI data.
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
index=index,
@@ -1257,7 +1257,7 @@ class CLASS_ta(Container):
>>> from openbb import obb
>>> stock_data = obb.stocks.load(symbol="TSLA", start_date="2023-01-01", provider="fmp")
>>> rsi_data = obb.ta.rsi(data=stock_data.results, target="close", length=14, scalar=100.0, drift=1)
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
target=target,
@@ -1280,7 +1280,7 @@ class CLASS_ta(Container):
def summary(
self, chart: bool = False
) -> CommandOutput[openbb_core.app.model.results.empty.Empty]:
"""Summary."""
"""Summary.""" # noqa: E501
inputs = filter_inputs(
chart=chart,
)
@@ -1334,7 +1334,7 @@ class CLASS_ta(Container):
>>> from openbb import obb
>>> stock_data = obb.stocks.load(symbol="TSLA", start_date="2023-01-01", provider="fmp")
>>> stoch_data = obb.ta.stoch(data=stock_data.results, fast_k_period=14, slow_d_period=3, slow_k_period=3)
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
index=index,
@@ -1356,7 +1356,7 @@ class CLASS_ta(Container):
def rsp(
self, chart: bool = False
) -> CommandOutput[openbb_core.app.model.results.empty.Empty]:
"""Relative Strength Performance."""
"""Relative Strength Performance.""" # noqa: E501
inputs = filter_inputs(
chart=chart,
)
@@ -1412,7 +1412,7 @@ class CLASS_ta(Container):
>>> from openbb import obb
>>> stock_data = obb.stocks.load(symbol="TSLA", start_date="2023-01-01", provider="fmp")
>>> kc_data = obb.ta.kc(data=stock_data.results, length=20, scalar=20, ma_mode="ema", offset=0)
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
index=index,
@@ -1465,7 +1465,7 @@ class CLASS_ta(Container):
>>> from openbb import obb
>>> stock_data = obb.stocks.load(symbol="TSLA", start_date="2023-01-01", provider="fmp")
>>> cg_data = obb.ta.cg(data=stock_data.results, length=14)
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
index=index,
@@ -1548,7 +1548,7 @@ class CLASS_ta(Container):
>>> from openbb import obb
>>> stock_data = obb.stocks.load(symbol="TSLA", start_date="2023-01-01", provider="fmp")
>>> cones_data = obb.ta.cones(data=stock_data.results, lower_q=0.25, upper_q=0.75, model="STD")
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
index=index,
@@ -1611,7 +1611,7 @@ class CLASS_ta(Container):
>>> stock_data = obb.stocks.load(symbol="TSLA", start_date="2023-01-01", provider="fmp")
>>> ema_data = obb.ta.ema(data=stock_data.results,target="close",length=50,offset=0)
"""
""" # noqa: E501
inputs = filter_inputs(
data=data,
target=target,