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

Limit number of characters in docstring types (#5438)

Browse Source 
* package_builder changes

* truncate only the mandatory args

* minor fix
This commit is contained in:
montezdesousa
2023-09-19 15:16:29 +01:00
committed by GitHub
parent fc9d7522ac
commit 848edee368
12 changed files with 251 additions and 239 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
openbb_sdk/openbb/package/crypto.py
View File

@@ -47,15 +47,15 @@ class CLASS_crypto(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
start_date : Union[datetime.date, NoneType, str]
start_date : Union[datetime.date, None, str]
Start date of the data, in YYYY-MM-DD format.
end_date : Union[datetime.date, NoneType, str]
end_date : Union[datetime.date, None, str]
End date of the data, in YYYY-MM-DD format.
provider : Union[Literal['fmp', 'polygon', 'yfinance'], NoneType]
provider : Union[Literal['fmp', 'polygon', 'yfinance'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
timeseries : Union[pydantic.types.NonNegativeInt, NoneType]
timeseries : Union[pydantic.types.NonNegativeInt, None]
Number of days to look back. (provider: fmp)
timespan : Literal['minute', 'hour', 'day', 'week', 'month', 'quarter', 'year']
Timespan of the data. (provider: polygon)
@@ -67,9 +67,9 @@ class CLASS_crypto(Container):
Whether the data is adjusted. (provider: polygon)
multiplier : PositiveInt
Multiplier of the timespan. (provider: polygon)
interval : Union[Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1wk', '1mo', '3mo'], NoneType]
interval : Union[Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1wk', '1mo', '3mo'], None]
Data granularity. (provider: yfinance)
period : Union[Literal['1d', '5d', '1mo', '3mo', '6mo', '1y', '2y', '5y', '10y', 'ytd', 'max'], NoneType]
period : Union[Literal['1d', '5d', '1mo', '3mo', '6mo', '1y', '2y', '5y', '10y', 'ytd', 'max'], None]
Period of the data to return. (provider: yfinance)
prepost : bool
Include Pre and Post market data. (provider: yfinance)

36
openbb_sdk/openbb/package/economy.py
View File

@@ -33,7 +33,7 @@ class CLASS_economy(Container):
Parameters
----------
provider : Union[Literal['cboe', 'fmp', 'yfinance'], NoneType]
provider : Union[Literal['cboe', 'fmp', 'yfinance'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'cboe' if there is
no default.
@@ -120,7 +120,7 @@ class CLASS_economy(Container):
----------
index : Literal['nasdaq', 'sp500', 'dowjones']
Index for which we want to fetch the constituents.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -265,7 +265,7 @@ class CLASS_economy(Container):
Parameters
----------
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']]
countries : List[Literal['australia', 'austria', 'belgium', 'brazil', 'bulgar...
The country or countries to get data.
units : Literal['growth_previous', 'growth_same', 'index_2015']
The data units.
@@ -273,11 +273,11 @@ class CLASS_economy(Container):
The data time frequency.
harmonized : bool
Whether you wish to obtain harmonized data.
start_date : Union[datetime.date, NoneType, str]
start_date : Union[datetime.date, None, str]
Start date of the data, in YYYY-MM-DD format.
end_date : Union[datetime.date, NoneType, str]
end_date : Union[datetime.date, None, str]
End date of the data, in YYYY-MM-DD format.
provider : Union[Literal['fred'], NoneType]
provider : Union[Literal['fred'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fred' if there is
no default.
@@ -355,15 +355,15 @@ class CLASS_economy(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
start_date : Union[datetime.date, NoneType, str]
start_date : Union[datetime.date, None, str]
Start date of the data, in YYYY-MM-DD format.
end_date : Union[datetime.date, NoneType, str]
end_date : Union[datetime.date, None, str]
End date of the data, in YYYY-MM-DD format.
provider : Union[Literal['cboe'], NoneType]
provider : Union[Literal['cboe'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'cboe' if there is
no default.
interval : Union[Literal['1d', '1m'], NoneType]
interval : Union[Literal['1d', '1m'], None]
Data granularity. (provider: cboe)
Returns
@@ -428,7 +428,7 @@ class CLASS_economy(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
provider : Union[Literal['cboe'], NoneType]
provider : Union[Literal['cboe'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'cboe' if there is
no default.
@@ -523,17 +523,17 @@ class CLASS_economy(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
start_date : Union[datetime.date, NoneType, str]
start_date : Union[datetime.date, None, str]
Start date of the data, in YYYY-MM-DD format.
end_date : Union[datetime.date, NoneType, str]
end_date : Union[datetime.date, None, str]
End date of the data, in YYYY-MM-DD format.
provider : Union[Literal['cboe', 'fmp', 'polygon', 'yfinance'], NoneType]
provider : Union[Literal['cboe', 'fmp', 'polygon', 'yfinance'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'cboe' if there is
no default.
interval : Union[Literal['1d', '1m'], NoneType, Literal['1min', '5min', '15min', '30min', '1hour', '4hour', '1day'], Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1wk', '1mo', '3mo']]
interval : Union[Literal['1d', '1m'], None, Literal['1min', '5min', '15min', '30min', '1hour', '4hour', '1day'], Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1wk', '1mo', '3mo']]
Data granularity. (provider: cboe, fmp, yfinance)
timeseries : Union[pydantic.types.NonNegativeInt, NoneType]
timeseries : Union[pydantic.types.NonNegativeInt, None]
Number of days to look back. (provider: fmp)
timespan : Literal['minute', 'hour', 'day', 'week', 'month', 'quarter', 'year']
Timespan of the data. (provider: polygon)
@@ -545,7 +545,7 @@ class CLASS_economy(Container):
Whether the data is adjusted. (provider: polygon)
multiplier : PositiveInt
Multiplier of the timespan. (provider: polygon)
period : Union[Literal['1d', '5d', '1mo', '3mo', '6mo', '1y', '2y', '5y', '10y', 'ytd', 'max'], NoneType]
period : Union[Literal['1d', '5d', '1mo', '3mo', '6mo', '1y', '2y', '5y', '10y', 'ytd', 'max'], None]
Period of the data to return. (provider: yfinance)
prepost : bool
Include Pre and Post market data. (provider: yfinance)
@@ -627,7 +627,7 @@ class CLASS_economy(Container):
Parameters
----------
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.

50
openbb_sdk/openbb/package/fixedincome.py
View File

@@ -52,11 +52,11 @@ class CLASS_fixedincome(Container):
Parameters
----------
start_date : Union[datetime.date, NoneType, str]
start_date : Union[datetime.date, None, str]
Start date of the data, in YYYY-MM-DD format.
end_date : Union[datetime.date, NoneType, str]
end_date : Union[datetime.date, None, str]
End date of the data, in YYYY-MM-DD format.
provider : Union[Literal['fred'], NoneType]
provider : Union[Literal['fred'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fred' if there is
no default.
@@ -126,11 +126,11 @@ class CLASS_fixedincome(Container):
Parameters
----------
start_date : Union[datetime.date, NoneType, str]
start_date : Union[datetime.date, None, str]
Start date of the data, in YYYY-MM-DD format.
end_date : Union[datetime.date, NoneType, str]
end_date : Union[datetime.date, None, str]
End date of the data, in YYYY-MM-DD format.
provider : Union[Literal['fred'], NoneType]
provider : Union[Literal['fred'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fred' if there is
no default.
@@ -200,11 +200,11 @@ class CLASS_fixedincome(Container):
Parameters
----------
start_date : Union[datetime.date, NoneType, str]
start_date : Union[datetime.date, None, str]
Start date of the data, in YYYY-MM-DD format.
end_date : Union[datetime.date, NoneType, str]
end_date : Union[datetime.date, None, str]
End date of the data, in YYYY-MM-DD format.
provider : Union[Literal['fred'], NoneType]
provider : Union[Literal['fred'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fred' if there is
no default.
@@ -274,11 +274,11 @@ class CLASS_fixedincome(Container):
Parameters
----------
start_date : Union[datetime.date, NoneType, str]
start_date : Union[datetime.date, None, str]
Start date of the data, in YYYY-MM-DD format.
end_date : Union[datetime.date, NoneType, str]
end_date : Union[datetime.date, None, str]
End date of the data, in YYYY-MM-DD format.
provider : Union[Literal['fred'], NoneType]
provider : Union[Literal['fred'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fred' if there is
no default.
@@ -332,7 +332,7 @@ class CLASS_fixedincome(Container):
Parameters
----------
provider : Union[Literal['fred'], NoneType]
provider : Union[Literal['fred'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fred' if there is
no default.
@@ -407,11 +407,11 @@ class CLASS_fixedincome(Container):
Parameters
----------
start_date : Union[datetime.date, NoneType, str]
start_date : Union[datetime.date, None, str]
Start date of the data, in YYYY-MM-DD format.
end_date : Union[datetime.date, NoneType, str]
end_date : Union[datetime.date, None, str]
End date of the data, in YYYY-MM-DD format.
provider : Union[Literal['fred'], NoneType]
provider : Union[Literal['fred'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fred' if there is
no default.
@@ -480,11 +480,11 @@ class CLASS_fixedincome(Container):
Parameters
----------
start_date : Union[datetime.date, NoneType, str]
start_date : Union[datetime.date, None, str]
Start date of the data, in YYYY-MM-DD format.
end_date : Union[datetime.date, NoneType, str]
end_date : Union[datetime.date, None, str]
End date of the data, in YYYY-MM-DD format.
provider : Union[Literal['fred'], NoneType]
provider : Union[Literal['fred'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fred' if there is
no default.
@@ -550,11 +550,11 @@ class CLASS_fixedincome(Container):
Parameters
----------
start_date : Union[datetime.date, NoneType, str]
start_date : Union[datetime.date, None, str]
Start date of the data, in YYYY-MM-DD format.
end_date : Union[datetime.date, NoneType, str]
end_date : Union[datetime.date, None, str]
End date of the data, in YYYY-MM-DD format.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -638,11 +638,11 @@ class CLASS_fixedincome(Container):
Parameters
----------
date : Union[datetime.date, NoneType]
date : Union[datetime.date, None]
Date to get Yield Curve data. Defaults to the most recent FRED entry.
inflation_adjusted : Union[bool, NoneType]
inflation_adjusted : Union[bool, None]
Get inflation adjusted rates.
provider : Union[Literal['fred'], NoneType]
provider : Union[Literal['fred'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fred' if there is
no default.

26
openbb_sdk/openbb/package/forex.py
View File

@@ -48,11 +48,11 @@ class CLASS_forex(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
start_date : Union[datetime.date, NoneType, str]
start_date : Union[datetime.date, None, str]
Start date of the data, in YYYY-MM-DD format.
end_date : Union[datetime.date, NoneType, str]
end_date : Union[datetime.date, None, str]
End date of the data, in YYYY-MM-DD format.
provider : Union[Literal['fmp', 'polygon', 'yfinance'], NoneType]
provider : Union[Literal['fmp', 'polygon', 'yfinance'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -66,9 +66,9 @@ class CLASS_forex(Container):
Whether the data is adjusted. (provider: polygon)
multiplier : PositiveInt
Multiplier of the timespan. (provider: polygon)
interval : Union[Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1wk', '1mo', '3mo'], NoneType]
interval : Union[Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1wk', '1mo', '3mo'], None]
Data granularity. (provider: yfinance)
period : Union[Literal['1d', '5d', '1mo', '3mo', '6mo', '1y', '2y', '5y', '10y', 'ytd', 'max'], NoneType]
period : Union[Literal['1d', '5d', '1mo', '3mo', '6mo', '1y', '2y', '5y', '10y', 'ytd', 'max'], None]
Period of the data to return. (provider: yfinance)
prepost : bool
Include Pre and Post market data. (provider: yfinance)
@@ -150,23 +150,23 @@ class CLASS_forex(Container):
Parameters
----------
provider : Union[Literal['fmp', 'intrinio', 'polygon'], NoneType]
provider : Union[Literal['fmp', 'intrinio', 'polygon'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
symbol : Union[str, NoneType]
symbol : Union[str, None]
Symbol of the pair to search. (provider: polygon)
date : Union[datetime.date, NoneType]
date : Union[datetime.date, None]
A specific date to get data for. (provider: polygon)
search : Union[str, NoneType]
search : Union[str, None]
Search for terms within the ticker and/or company name. (provider: polygon)
active : Union[Literal[True, False], NoneType]
active : Union[Literal[True, False], None]
Specify if the tickers returned should be actively traded on the queried date. (provider: polygon)
order : Union[Literal['asc', 'desc'], NoneType]
order : Union[Literal['asc', 'desc'], None]
Order data by ascending or descending. (provider: polygon)
sort : Union[Literal['ticker', 'name', 'market', 'locale', 'currency_symbol', 'currency_name', 'base_currency_symbol', 'base_currency_name', 'last_updated_utc', 'delisted_utc'], NoneType]
sort : Union[Literal['ticker', 'name', 'market', 'locale', 'currency_symbol', 'currency_name', 'base_currency_symbol', 'base_currency_name', 'last_updated_utc', 'delisted_utc'], None]
Sort field used for ordering. (provider: polygon)
limit : Union[pydantic.types.PositiveInt, NoneType]
limit : Union[pydantic.types.PositiveInt, None]
The number of data entries to return. (provider: polygon)
Returns

16
openbb_sdk/openbb/package/futures.py
View File

@@ -40,9 +40,9 @@ class CLASS_futures(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
date : Union[datetime.date, NoneType]
date : Union[datetime.date, None]
Historical date to search curve for.
provider : Union[Literal['cboe', 'yfinance'], NoneType]
provider : Union[Literal['cboe', 'yfinance'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'cboe' if there is
no default.
@@ -118,19 +118,19 @@ class CLASS_futures(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
start_date : Union[datetime.date, NoneType, str]
start_date : Union[datetime.date, None, str]
Start date of the data, in YYYY-MM-DD format.
end_date : Union[datetime.date, NoneType, str]
end_date : Union[datetime.date, None, str]
End date of the data, in YYYY-MM-DD format.
expiration : Union[str, NoneType]
expiration : Union[str, None]
Future expiry date with format YYYY-MM
provider : Union[Literal['yfinance'], NoneType]
provider : Union[Literal['yfinance'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'yfinance' if there is
no default.
interval : Union[Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1wk', '1mo', '3mo'], NoneType]
interval : Union[Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1wk', '1mo', '3mo'], None]
Data granularity. (provider: yfinance)
period : Union[Literal['1d', '5d', '1mo', '3mo', '6mo', '1y', '2y', '5y', '10y', 'ytd', 'max'], NoneType]
period : Union[Literal['1d', '5d', '1mo', '3mo', '6mo', '1y', '2y', '5y', '10y', 'ytd', 'max'], None]
Period of the data to return. (provider: yfinance)
prepost : bool
Include Pre and Post market data. (provider: yfinance)

32
openbb_sdk/openbb/package/news.py
View File

@@ -35,7 +35,7 @@ class CLASS_news(Container):
----------
page : NonNegativeInt
Page of the global news.
provider : Union[Literal['benzinga', 'fmp', 'intrinio'], NoneType]
provider : Union[Literal['benzinga', 'fmp', 'intrinio'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'benzinga' if there is
no default.
@@ -43,37 +43,37 @@ class CLASS_news(Container):
Number of results to return per page. (provider: benzinga)
display_output : Literal['headline', 'summary', 'full', 'all']
Type of data to return. (provider: benzinga)
date : Union[datetime.datetime, NoneType]
date : Union[datetime.datetime, None]
Date of the news to retrieve. (provider: benzinga)
date_from : Union[datetime.datetime, NoneType]
date_from : Union[datetime.datetime, None]
Start date of the news to retrieve. (provider: benzinga)
date_to : Union[datetime.datetime, NoneType]
date_to : Union[datetime.datetime, None]
End date of the news to retrieve. (provider: benzinga)
updated_since : Union[int, NoneType]
updated_since : Union[int, None]
Number of seconds since the news was updated. (provider: benzinga)
published_since : Union[int, NoneType]
published_since : Union[int, None]
Number of seconds since the news was published. (provider: benzinga)
sort : Union[Literal['published_at', 'updated_at', 'title', 'author', 'channel', 'ticker', 'topic', 'content_type'], NoneType]
sort : Union[Literal['published_at', 'updated_at', 'title', 'author', 'channel', 'ticker', 'topic', 'content_type'], None]
Order in which to sort the news. (provider: benzinga)
isin : Union[str, NoneType]
isin : Union[str, None]
The ISIN of the news to retrieve. (provider: benzinga)
cusip : Union[str, NoneType]
cusip : Union[str, None]
The CUSIP of the news to retrieve. (provider: benzinga)
tickers : Union[str, NoneType]
tickers : Union[str, None]
Tickers of the news to retrieve. (provider: benzinga)
channels : Union[str, NoneType]
channels : Union[str, None]
Channels of the news to retrieve. (provider: benzinga)
topics : Union[str, NoneType]
topics : Union[str, None]
Topics of the news to retrieve. (provider: benzinga)
authors : Union[str, NoneType]
authors : Union[str, None]
Authors of the news to retrieve. (provider: benzinga)
content_types : Union[str, NoneType]
content_types : Union[str, None]
Content types of the news to retrieve. (provider: benzinga)
next_page : str
Token to get the next page of data from a previous API call. (provider: intrinio)
limit : Union[int, NoneType]
limit : Union[int, None]
The number of data entries to return. (provider: intrinio)
all_pages : Union[bool, NoneType]
all_pages : Union[bool, None]
Returns all pages of data from the API call at once. (provider: intrinio)
Returns

98
openbb_sdk/openbb/package/stocks.py
View File

@@ -64,7 +64,7 @@ class CLASS_stocks(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
provider : Union[Literal['cboe'], NoneType]
provider : Union[Literal['cboe'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'cboe' if there is
no default.
@@ -195,45 +195,45 @@ class CLASS_stocks(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
start_date : Union[datetime.date, NoneType, str]
start_date : Union[datetime.date, None, str]
Start date of the data, in YYYY-MM-DD format.
end_date : Union[datetime.date, NoneType, str]
end_date : Union[datetime.date, None, str]
End date of the data, in YYYY-MM-DD format.
chart : bool
Whether to create a chart or not, by default False.
provider : Union[Literal['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'yfinance'], NoneType]
provider : Union[Literal['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygo...
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'alpha_vantage' if there is
no default.
period : Union[Literal['intraday', 'daily', 'weekly', 'monthly'], Literal['1d', '5d', '1mo', '3mo', '6mo', '1y', '2y', '5y', '10y', 'ytd', 'max'], NoneType]
period : Union[Literal['intraday', 'daily', 'weekly', 'monthly'], Literal['1d', '5d', '1mo', '3mo', '6mo', '1y', '2y', '5y', '10y', 'ytd', 'max'], None]
Period of the data to return. (provider: alpha_vantage, yfinance)
interval : Union[Literal['1min', '5min', '15min', '30min', '60min'], NoneType, Literal['1d', '1m'], Literal['1min', '5min', '15min', '30min', '1hour', '4hour', '1day'], Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1wk', '1mo', '3mo']]
interval : Union[Literal['1min', '5min', '15min', '30min', '60min'], None, Literal['1d', '1m'], Literal['1min', '5min', '15min', '30min', '1hour', '4hour', '1day'], Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1wk', '1mo', '3mo']]
Data granularity. (provider: alpha_vantage, cboe, fmp, yfinance)
adjusted : Union[bool, NoneType]
adjusted : Union[bool, None]
Output time series is adjusted by historical split and dividend events. (provider: alpha_vantage, polygon)
extended_hours : Union[bool, NoneType]
extended_hours : Union[bool, None]
Extended trading hours during pre-market and after-hours. (provider: alpha_vantage)
month : Union[str, NoneType]
month : Union[str, None]
Query a specific month in history (in YYYY-MM format). (provider: alpha_vantage)
outputsize : Union[Literal['compact', 'full'], NoneType]
outputsize : Union[Literal['compact', 'full'], None]
Compact returns only the latest 100 data points in the intraday time series; full returns trailing 30 days of the most recent intraday data if the month parameter (see above) is not specified, or the full intraday data for a specific month in history if the month parameter is specified. (provider: alpha_vantage)
timeseries : Union[pydantic.types.NonNegativeInt, NoneType]
timeseries : Union[pydantic.types.NonNegativeInt, None]
Number of days to look back. (provider: fmp)
timezone : Union[Literal['Africa/Algiers', 'Africa/Cairo', 'Africa/Casablanca', 'Africa/Harare', 'Africa/Johannesburg', 'Africa/Monrovia', 'Africa/Nairobi', 'America/Argentina/Buenos_Aires', 'America/Bogota', 'America/Caracas', 'America/Chicago', 'America/Chihuahua', 'America/Denver', 'America/Godthab', 'America/Guatemala', 'America/Guyana', 'America/Halifax', 'America/Indiana/Indianapolis', 'America/Juneau', 'America/La_Paz', 'America/Lima', 'America/Lima', 'America/Los_Angeles', 'America/Mazatlan', 'America/Mexico_City', 'America/Mexico_City', 'America/Monterrey', 'America/Montevideo', 'America/New_York', 'America/Phoenix', 'America/Regina', 'America/Santiago', 'America/Sao_Paulo', 'America/St_Johns', 'America/Tijuana', 'Asia/Almaty', 'Asia/Baghdad', 'Asia/Baku', 'Asia/Bangkok', 'Asia/Bangkok', 'Asia/Chongqing', 'Asia/Colombo', 'Asia/Dhaka', 'Asia/Dhaka', 'Asia/Hong_Kong', 'Asia/Irkutsk', 'Asia/Jakarta', 'Asia/Jerusalem', 'Asia/Kabul', 'Asia/Kamchatka', 'Asia/Karachi', 'Asia/Karachi', 'Asia/Kathmandu', 'Asia/Kolkata', 'Asia/Kolkata', 'Asia/Kolkata', 'Asia/Kolkata', 'Asia/Krasnoyarsk', 'Asia/Kuala_Lumpur', 'Asia/Kuwait', 'Asia/Magadan', 'Asia/Muscat', 'Asia/Muscat', 'Asia/Novosibirsk', 'Asia/Rangoon', 'Asia/Riyadh', 'Asia/Seoul', 'Asia/Shanghai', 'Asia/Singapore', 'Asia/Srednekolymsk', 'Asia/Taipei', 'Asia/Tashkent', 'Asia/Tbilisi', 'Asia/Tehran', 'Asia/Tokyo', 'Asia/Tokyo', 'Asia/Tokyo', 'Asia/Ulaanbaatar', 'Asia/Urumqi', 'Asia/Vladivostok', 'Asia/Yakutsk', 'Asia/Yekaterinburg', 'Asia/Yerevan', 'Atlantic/Azores', 'Atlantic/Cape_Verde', 'Atlantic/South_Georgia', 'Australia/Adelaide', 'Australia/Brisbane', 'Australia/Darwin', 'Australia/Hobart', 'Australia/Melbourne', 'Australia/Melbourne', 'Australia/Perth', 'Australia/Sydney', 'Etc/UTC', 'UTC', 'Europe/Amsterdam', 'Europe/Athens', 'Europe/Belgrade', 'Europe/Berlin', 'Europe/Berlin', 'Europe/Bratislava', 'Europe/Brussels', 'Europe/Bucharest', 'Europe/Budapest', 'Europe/Copenhagen', 'Europe/Dublin', 'Europe/Helsinki', 'Europe/Istanbul', 'Europe/Kaliningrad', 'Europe/Kiev', 'Europe/Lisbon', 'Europe/Ljubljana', 'Europe/London', 'Europe/London', 'Europe/Madrid', 'Europe/Minsk', 'Europe/Moscow', 'Europe/Moscow', 'Europe/Paris', 'Europe/Prague', 'Europe/Riga', 'Europe/Rome', 'Europe/Samara', 'Europe/Sarajevo', 'Europe/Skopje', 'Europe/Sofia', 'Europe/Stockholm', 'Europe/Tallinn', 'Europe/Vienna', 'Europe/Vilnius', 'Europe/Volgograd', 'Europe/Warsaw', 'Europe/Zagreb', 'Pacific/Apia', 'Pacific/Auckland', 'Pacific/Auckland', 'Pacific/Chatham', 'Pacific/Fakaofo', 'Pacific/Fiji', 'Pacific/Guadalcanal', 'Pacific/Guam', 'Pacific/Honolulu', 'Pacific/Majuro', 'Pacific/Midway', 'Pacific/Midway', 'Pacific/Noumea', 'Pacific/Pago_Pago', 'Pacific/Port_Moresby', 'Pacific/Tongatapu'], NoneType]
timezone : Union[Literal['Africa/Algiers', 'Africa/Cairo', 'Africa/Casablanca', 'Africa/Harare', 'Africa/Johannesburg', 'Africa/Monrovia', 'Africa/Nairobi', 'America/Argentina/Buenos_Aires', 'America/Bogota', 'America/Caracas', 'America/Chicago', 'America/Chihuahua', 'America/Denver', 'America/Godthab', 'America/Guatemala', 'America/Guyana', 'America/Halifax', 'America/Indiana/Indianapolis', 'America/Juneau', 'America/La_Paz', 'America/Lima', 'America/Lima', 'America/Los_Angeles', 'America/Mazatlan', 'America/Mexico_City', 'America/Mexico_City', 'America/Monterrey', 'America/Montevideo', 'America/New_York', 'America/Phoenix', 'America/Regina', 'America/Santiago', 'America/Sao_Paulo', 'America/St_Johns', 'America/Tijuana', 'Asia/Almaty', 'Asia/Baghdad', 'Asia/Baku', 'Asia/Bangkok', 'Asia/Bangkok', 'Asia/Chongqing', 'Asia/Colombo', 'Asia/Dhaka', 'Asia/Dhaka', 'Asia/Hong_Kong', 'Asia/Irkutsk', 'Asia/Jakarta', 'Asia/Jerusalem', 'Asia/Kabul', 'Asia/Kamchatka', 'Asia/Karachi', 'Asia/Karachi', 'Asia/Kathmandu', 'Asia/Kolkata', 'Asia/Kolkata', 'Asia/Kolkata', 'Asia/Kolkata', 'Asia/Krasnoyarsk', 'Asia/Kuala_Lumpur', 'Asia/Kuwait', 'Asia/Magadan', 'Asia/Muscat', 'Asia/Muscat', 'Asia/Novosibirsk', 'Asia/Rangoon', 'Asia/Riyadh', 'Asia/Seoul', 'Asia/Shanghai', 'Asia/Singapore', 'Asia/Srednekolymsk', 'Asia/Taipei', 'Asia/Tashkent', 'Asia/Tbilisi', 'Asia/Tehran', 'Asia/Tokyo', 'Asia/Tokyo', 'Asia/Tokyo', 'Asia/Ulaanbaatar', 'Asia/Urumqi', 'Asia/Vladivostok', 'Asia/Yakutsk', 'Asia/Yekaterinburg', 'Asia/Yerevan', 'Atlantic/Azores', 'Atlantic/Cape_Verde', 'Atlantic/South_Georgia', 'Australia/Adelaide', 'Australia/Brisbane', 'Australia/Darwin', 'Australia/Hobart', 'Australia/Melbourne', 'Australia/Melbourne', 'Australia/Perth', 'Australia/Sydney', 'Etc/UTC', 'UTC', 'Europe/Amsterdam', 'Europe/Athens', 'Europe/Belgrade', 'Europe/Berlin', 'Europe/Berlin', 'Europe/Bratislava', 'Europe/Brussels', 'Europe/Bucharest', 'Europe/Budapest', 'Europe/Copenhagen', 'Europe/Dublin', 'Europe/Helsinki', 'Europe/Istanbul', 'Europe/Kaliningrad', 'Europe/Kiev', 'Europe/Lisbon', 'Europe/Ljubljana', 'Europe/London', 'Europe/London', 'Europe/Madrid', 'Europe/Minsk', 'Europe/Moscow', 'Europe/Moscow', 'Europe/Paris', 'Europe/Prague', 'Europe/Riga', 'Europe/Rome', 'Europe/Samara', 'Europe/Sarajevo', 'Europe/Skopje', 'Europe/Sofia', 'Europe/Stockholm', 'Europe/Tallinn', 'Europe/Vienna', 'Europe/Vilnius', 'Europe/Volgograd', 'Europe/Warsaw', 'Europe/Zagreb', 'Pacific/Apia', 'Pacific/Auckland', 'Pacific/Auckland', 'Pacific/Chatham', 'Pacific/Fakaofo', 'Pacific/Fiji', 'Pacific/Guadalcanal', 'Pacific/Guam', 'Pacific/Honolulu', 'Pacific/Majuro', 'Pacific/Midway', 'Pacific/Midway', 'Pacific/Noumea', 'Pacific/Pago_Pago', 'Pacific/Port_Moresby', 'Pacific/Tongatapu'], None]
Returns trading times in this timezone. (provider: intrinio)
source : Union[Literal['realtime', 'delayed', 'nasdaq_basic'], NoneType]
source : Union[Literal['realtime', 'delayed', 'nasdaq_basic'], None]
The source of the data. (provider: intrinio)
start_time : Union[datetime.time, NoneType]
start_time : Union[datetime.time, None]
Return intervals starting at the specified time on the `start_date` formatted as 'hh:mm:ss'. (provider: intrinio)
end_time : Union[datetime.time, NoneType]
end_time : Union[datetime.time, None]
Return intervals stopping at the specified time on the `end_date` formatted as 'hh:mm:ss'. (provider: intrinio)
interval_size : Union[Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h'], NoneType]
interval_size : Union[Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h'], None]
The data time frequency. (provider: intrinio)
limit : Union[pydantic.types.NonNegativeInt, NoneType, pydantic.types.PositiveInt]
limit : Union[pydantic.types.NonNegativeInt, None, pydantic.types.PositiveInt]
The number of data entries to return. (provider: intrinio, polygon)
next_page : Union[str, NoneType]
next_page : Union[str, None]
Token to get the next page of data from a previous API call. (provider: intrinio)
all_pages : Union[bool, NoneType]
all_pages : Union[bool, None]
Returns all pages of data from the API call at once. (provider: intrinio)
timespan : Literal['minute', 'hour', 'day', 'week', 'month', 'quarter', 'year']
Timespan of the data. (provider: polygon)
@@ -351,11 +351,11 @@ class CLASS_stocks(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
limit : Union[int, NoneType]
limit : Union[int, None]
The number of data entries to return.
chart : bool
Whether to create a chart or not, by default False.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -544,63 +544,63 @@ class CLASS_stocks(Container):
Symbol to get data for.
page : int
Page of the stock news to be retrieved.
limit : Union[pydantic.types.NonNegativeInt, NoneType]
limit : Union[pydantic.types.NonNegativeInt, None]
Number of results to return per page.
chart : bool
Whether to create a chart or not, by default False.
provider : Union[Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'yfinance'], NoneType]
provider : Union[Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'yfinance...
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'benzinga' if there is
no default.
display_output : Literal['headline', 'summary', 'full', 'all']
Type of data to return. (provider: benzinga)
date : Union[datetime.datetime, NoneType]
date : Union[datetime.datetime, None]
Date of the news to retrieve. (provider: benzinga)
date_from : Union[datetime.datetime, NoneType]
date_from : Union[datetime.datetime, None]
Start date of the news to retrieve. (provider: benzinga)
date_to : Union[datetime.datetime, NoneType]
date_to : Union[datetime.datetime, None]
End date of the news to retrieve. (provider: benzinga)
updated_since : Union[int, NoneType]
updated_since : Union[int, None]
Number of seconds since the news was updated. (provider: benzinga)
published_since : Union[int, NoneType]
published_since : Union[int, None]
Number of seconds since the news was published. (provider: benzinga)
sort : Union[Literal['published_at', 'updated_at', 'title', 'author', 'channel', 'ticker', 'topic', 'content_type'], NoneType, str]
sort : Union[Literal['published_at', 'updated_at', 'title', 'author', 'channel', 'ticker', 'topic', 'content_type'], None, str]
Order in which to sort the news. (provider: benzinga, polygon)
isin : Union[str, NoneType]
isin : Union[str, None]
The ISIN of the news to retrieve. (provider: benzinga)
cusip : Union[str, NoneType]
cusip : Union[str, None]
The CUSIP of the news to retrieve. (provider: benzinga)
channels : Union[str, NoneType]
channels : Union[str, None]
Channels of the news to retrieve. (provider: benzinga)
topics : Union[str, NoneType]
topics : Union[str, None]
Topics of the news to retrieve. (provider: benzinga)
authors : Union[str, NoneType]
authors : Union[str, None]
Authors of the news to retrieve. (provider: benzinga)
content_types : Union[str, NoneType]
content_types : Union[str, None]
Content types of the news to retrieve. (provider: benzinga)
next_page : Union[str, NoneType]
next_page : Union[str, None]
Token to get the next page of data from a previous API call. (provider: intrinio)
all_pages : Union[bool, NoneType]
all_pages : Union[bool, None]
Returns all pages of data from the API call at once. (provider: intrinio)
ticker_lt : Union[str, NoneType]
ticker_lt : Union[str, None]
Less than. (provider: polygon)
ticker_lte : Union[str, NoneType]
ticker_lte : Union[str, None]
Less than or equal. (provider: polygon)
ticker_gt : Union[str, NoneType]
ticker_gt : Union[str, None]
Greater than. (provider: polygon)
ticker_gte : Union[str, NoneType]
ticker_gte : Union[str, None]
Greater than or equal. (provider: polygon)
published_utc : Union[str, NoneType]
published_utc : Union[str, None]
Published date of the query. (provider: polygon)
published_utc_lt : Union[str, NoneType]
published_utc_lt : Union[str, None]
Less than. (provider: polygon)
published_utc_lte : Union[str, NoneType]
published_utc_lte : Union[str, None]
Less than or equal. (provider: polygon)
published_utc_gt : Union[str, NoneType]
published_utc_gt : Union[str, None]
Greater than. (provider: polygon)
published_utc_gte : Union[str, NoneType]
published_utc_gte : Union[str, None]
Greater than or equal. (provider: polygon)
order : Union[Literal['asc', 'desc'], NoneType]
order : Union[Literal['asc', 'desc'], None]
Sort order of the query. (provider: polygon)
Returns
@@ -706,7 +706,7 @@ class CLASS_stocks(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
provider : Union[Literal['fmp', 'intrinio'], NoneType]
provider : Union[Literal['fmp', 'intrinio'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -850,7 +850,7 @@ class CLASS_stocks(Container):
Search query.
ticker : bool
Whether to search by ticker symbol.
provider : Union[Literal['cboe'], NoneType]
provider : Union[Literal['cboe'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'cboe' if there is
no default.

2
openbb_sdk/openbb/package/stocks_ca.py
View File

@@ -34,7 +34,7 @@ class CLASS_stocks_ca(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.

8
openbb_sdk/openbb/package/stocks_dd.py
View File

@@ -147,13 +147,13 @@ class CLASS_stocks_dd(Container):
----------
symbol : Union[str, List[str]]
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']
type : Literal['1', '1-A', '1-E', '1-K', '1-N', '1-SA', '1-U', '1-Z', '10', '10...
Type of the SEC filing form.
page : Union[int, NoneType]
page : Union[int, None]
Page number of the results.
limit : Union[int, NoneType]
limit : Union[int, None]
The number of data entries to return.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.

190
openbb_sdk/openbb/package/stocks_fa.py
View File

@@ -73,47 +73,47 @@ class CLASS_stocks_fa(Container):
Symbol to get data for.
period : Literal['annual', 'quarter']
Period of the data to return.
limit : Union[pydantic.types.NonNegativeInt, NoneType]
limit : Union[pydantic.types.NonNegativeInt, None]
The number of data entries to return.
provider : Union[Literal['fmp', 'intrinio', 'polygon', 'yfinance'], NoneType]
provider : Union[Literal['fmp', 'intrinio', 'polygon', 'yfinance'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
type : Literal['reported', 'standardized']
Type of the statement to be fetched. (provider: intrinio)
year : Union[int, NoneType]
year : Union[int, None]
Year of the statement to be fetched. (provider: intrinio)
company_name : Union[str, NoneType]
company_name : Union[str, None]
Name of the company. (provider: polygon)
company_name_search : Union[str, NoneType]
company_name_search : Union[str, None]
Name of the company to search. (provider: polygon)
sic : Union[str, NoneType]
sic : Union[str, None]
The Standard Industrial Classification (SIC) of the company. (provider: polygon)
filing_date : Union[datetime.date, NoneType]
filing_date : Union[datetime.date, None]
Filing date of the financial statement. (provider: polygon)
filing_date_lt : Union[datetime.date, NoneType]
filing_date_lt : Union[datetime.date, None]
Filing date less than the given date. (provider: polygon)
filing_date_lte : Union[datetime.date, NoneType]
filing_date_lte : Union[datetime.date, None]
Filing date less than or equal to the given date. (provider: polygon)
filing_date_gt : Union[datetime.date, NoneType]
filing_date_gt : Union[datetime.date, None]
Filing date greater than the given date. (provider: polygon)
filing_date_gte : Union[datetime.date, NoneType]
filing_date_gte : Union[datetime.date, None]
Filing date greater than or equal to the given date. (provider: polygon)
period_of_report_date : Union[datetime.date, NoneType]
period_of_report_date : Union[datetime.date, None]
Period of report date of the financial statement. (provider: polygon)
period_of_report_date_lt : Union[datetime.date, NoneType]
period_of_report_date_lt : Union[datetime.date, None]
Period of report date less than the given date. (provider: polygon)
period_of_report_date_lte : Union[datetime.date, NoneType]
period_of_report_date_lte : Union[datetime.date, None]
Period of report date less than or equal to the given date. (provider: polygon)
period_of_report_date_gt : Union[datetime.date, NoneType]
period_of_report_date_gt : Union[datetime.date, None]
Period of report date greater than the given date. (provider: polygon)
period_of_report_date_gte : Union[datetime.date, NoneType]
period_of_report_date_gte : Union[datetime.date, None]
Period of report date greater than or equal to the given date. (provider: polygon)
include_sources : Union[bool, NoneType]
include_sources : Union[bool, None]
Whether to include the sources of the financial statement. (provider: polygon)
order : Union[Literal['asc', 'desc'], NoneType]
order : Union[Literal['asc', 'desc'], None]
Order of the financial statement. (provider: polygon)
sort : Union[Literal['filing_date', 'period_of_report_date'], NoneType]
sort : Union[Literal['filing_date', 'period_of_report_date'], None]
Sort of the financial statement. (provider: polygon)
Returns
@@ -280,7 +280,7 @@ class CLASS_stocks_fa(Container):
Symbol to get data for.
limit : int
The number of data entries to return.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -424,11 +424,11 @@ class CLASS_stocks_fa(Container):
Parameters
----------
start_date : Union[datetime.date, NoneType, str]
start_date : Union[datetime.date, None, str]
Start date of the data, in YYYY-MM-DD format.
end_date : Union[datetime.date, NoneType, str]
end_date : Union[datetime.date, None, str]
End date of the data, in YYYY-MM-DD format.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -508,47 +508,47 @@ class CLASS_stocks_fa(Container):
Symbol to get data for.
period : Literal['annual', 'quarter']
Period of the data to return.
limit : Union[pydantic.types.NonNegativeInt, NoneType]
limit : Union[pydantic.types.NonNegativeInt, None]
The number of data entries to return.
provider : Union[Literal['fmp', 'intrinio', 'polygon', 'yfinance'], NoneType]
provider : Union[Literal['fmp', 'intrinio', 'polygon', 'yfinance'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
type : Literal['reported', 'standardized']
Type of the statement to be fetched. (provider: intrinio)
year : Union[int, NoneType]
year : Union[int, None]
Year of the statement to be fetched. (provider: intrinio)
company_name : Union[str, NoneType]
company_name : Union[str, None]
Name of the company. (provider: polygon)
company_name_search : Union[str, NoneType]
company_name_search : Union[str, None]
Name of the company to search. (provider: polygon)
sic : Union[str, NoneType]
sic : Union[str, None]
The Standard Industrial Classification (SIC) of the company. (provider: polygon)
filing_date : Union[datetime.date, NoneType]
filing_date : Union[datetime.date, None]
Filing date of the financial statement. (provider: polygon)
filing_date_lt : Union[datetime.date, NoneType]
filing_date_lt : Union[datetime.date, None]
Filing date less than the given date. (provider: polygon)
filing_date_lte : Union[datetime.date, NoneType]
filing_date_lte : Union[datetime.date, None]
Filing date less than or equal to the given date. (provider: polygon)
filing_date_gt : Union[datetime.date, NoneType]
filing_date_gt : Union[datetime.date, None]
Filing date greater than the given date. (provider: polygon)
filing_date_gte : Union[datetime.date, NoneType]
filing_date_gte : Union[datetime.date, None]
Filing date greater than or equal to the given date. (provider: polygon)
period_of_report_date : Union[datetime.date, NoneType]
period_of_report_date : Union[datetime.date, None]
Period of report date of the financial statement. (provider: polygon)
period_of_report_date_lt : Union[datetime.date, NoneType]
period_of_report_date_lt : Union[datetime.date, None]
Period of report date less than the given date. (provider: polygon)
period_of_report_date_lte : Union[datetime.date, NoneType]
period_of_report_date_lte : Union[datetime.date, None]
Period of report date less than or equal to the given date. (provider: polygon)
period_of_report_date_gt : Union[datetime.date, NoneType]
period_of_report_date_gt : Union[datetime.date, None]
Period of report date greater than the given date. (provider: polygon)
period_of_report_date_gte : Union[datetime.date, NoneType]
period_of_report_date_gte : Union[datetime.date, None]
Period of report date greater than or equal to the given date. (provider: polygon)
include_sources : Union[bool, NoneType]
include_sources : Union[bool, None]
Whether to include the sources of the financial statement. (provider: polygon)
order : Union[Literal['asc', 'desc'], NoneType]
order : Union[Literal['asc', 'desc'], None]
Order of the financial statement. (provider: polygon)
sort : Union[Literal['filing_date', 'period_of_report_date'], NoneType]
sort : Union[Literal['filing_date', 'period_of_report_date'], None]
Sort of the financial statement. (provider: polygon)
Returns
@@ -701,7 +701,7 @@ class CLASS_stocks_fa(Container):
Symbol to get data for.
limit : int
The number of data entries to return.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -821,7 +821,7 @@ class CLASS_stocks_fa(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -906,11 +906,11 @@ class CLASS_stocks_fa(Container):
Parameters
----------
start_date : Union[datetime.date, NoneType, str]
start_date : Union[datetime.date, None, str]
Start date of the data, in YYYY-MM-DD format.
end_date : Union[datetime.date, NoneType, str]
end_date : Union[datetime.date, None, str]
End date of the data, in YYYY-MM-DD format.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -974,7 +974,7 @@ class CLASS_stocks_fa(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -1045,9 +1045,9 @@ class CLASS_stocks_fa(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
limit : Union[int, NoneType]
limit : Union[int, None]
The number of data entries to return.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -1119,7 +1119,7 @@ class CLASS_stocks_fa(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -1202,7 +1202,7 @@ class CLASS_stocks_fa(Container):
Period of the data to return.
limit : int
The number of data entries to return.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -1311,47 +1311,47 @@ class CLASS_stocks_fa(Container):
Symbol to get data for.
period : Literal['annual', 'quarter']
Period of the data to return.
limit : Union[pydantic.types.NonNegativeInt, NoneType]
limit : Union[pydantic.types.NonNegativeInt, None]
The number of data entries to return.
provider : Union[Literal['fmp', 'intrinio', 'polygon', 'yfinance'], NoneType]
provider : Union[Literal['fmp', 'intrinio', 'polygon', 'yfinance'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
type : Literal['reported', 'standardized']
Type of the statement to be fetched. (provider: intrinio)
year : Union[int, NoneType]
year : Union[int, None]
Year of the statement to be fetched. (provider: intrinio)
company_name : Union[str, NoneType]
company_name : Union[str, None]
Name of the company. (provider: polygon)
company_name_search : Union[str, NoneType]
company_name_search : Union[str, None]
Name of the company to search. (provider: polygon)
sic : Union[str, NoneType]
sic : Union[str, None]
The Standard Industrial Classification (SIC) of the company. (provider: polygon)
filing_date : Union[datetime.date, NoneType]
filing_date : Union[datetime.date, None]
Filing date of the financial statement. (provider: polygon)
filing_date_lt : Union[datetime.date, NoneType]
filing_date_lt : Union[datetime.date, None]
Filing date less than the given date. (provider: polygon)
filing_date_lte : Union[datetime.date, NoneType]
filing_date_lte : Union[datetime.date, None]
Filing date less than or equal to the given date. (provider: polygon)
filing_date_gt : Union[datetime.date, NoneType]
filing_date_gt : Union[datetime.date, None]
Filing date greater than the given date. (provider: polygon)
filing_date_gte : Union[datetime.date, NoneType]
filing_date_gte : Union[datetime.date, None]
Filing date greater than or equal to the given date. (provider: polygon)
period_of_report_date : Union[datetime.date, NoneType]
period_of_report_date : Union[datetime.date, None]
Period of report date of the financial statement. (provider: polygon)
period_of_report_date_lt : Union[datetime.date, NoneType]
period_of_report_date_lt : Union[datetime.date, None]
Period of report date less than the given date. (provider: polygon)
period_of_report_date_lte : Union[datetime.date, NoneType]
period_of_report_date_lte : Union[datetime.date, None]
Period of report date less than or equal to the given date. (provider: polygon)
period_of_report_date_gt : Union[datetime.date, NoneType]
period_of_report_date_gt : Union[datetime.date, None]
Period of report date greater than the given date. (provider: polygon)
period_of_report_date_gte : Union[datetime.date, NoneType]
period_of_report_date_gte : Union[datetime.date, None]
Period of report date greater than or equal to the given date. (provider: polygon)
include_sources : Union[bool, NoneType]
include_sources : Union[bool, None]
Whether to include the sources of the financial statement. (provider: polygon)
order : Union[Literal['asc', 'desc'], NoneType]
order : Union[Literal['asc', 'desc'], None]
Order of the financial statement. (provider: polygon)
sort : Union[Literal['filing_date', 'period_of_report_date'], NoneType]
sort : Union[Literal['filing_date', 'period_of_report_date'], None]
Sort of the financial statement. (provider: polygon)
Returns
@@ -1500,7 +1500,7 @@ class CLASS_stocks_fa(Container):
The number of data entries to return.
period : Literal['annual', 'quarter']
Period of the data to return.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -1653,15 +1653,15 @@ class CLASS_stocks_fa(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
transactionType : Union[List[Literal['A-Award', 'C-Conversion', 'D-Return', 'E-ExpireShort', 'F-InKind', 'G-Gift', 'H-ExpireLong', 'I-Discretionary', 'J-Other', 'L-Small', 'M-Exempt', 'O-OutOfTheMoney', 'P-Purchase', 'S-Sale', 'U-Tender', 'W-Will', 'X-InTheMoney', 'Z-Trust']], NoneType]
transactionType : Union[List[Literal['A-Award', 'C-Conversion', 'D-Return', ...
Type of the transaction.
reportingCik : Union[int, NoneType]
reportingCik : Union[int, None]
CIK of the reporting owner.
companyCik : Union[int, NoneType]
companyCik : Union[int, None]
CIK of the company owner.
page : Union[int, NoneType]
page : Union[int, None]
Page number of the data to fetch.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -1757,9 +1757,9 @@ class CLASS_stocks_fa(Container):
Symbol to get data for.
include_current_quarter : bool
Include current quarter data.
date : Union[datetime.date, NoneType]
date : Union[datetime.date, None]
A specific date to get data for.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -1897,9 +1897,9 @@ class CLASS_stocks_fa(Container):
Symbol to get data for.
period : Literal['annual', 'quarter']
Period of the data to return.
limit : Union[int, NoneType]
limit : Union[int, None]
The number of data entries to return.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -2074,7 +2074,7 @@ class CLASS_stocks_fa(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -2141,7 +2141,7 @@ class CLASS_stocks_fa(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -2274,11 +2274,11 @@ class CLASS_stocks_fa(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
date : Union[datetime.date, NoneType]
date : Union[datetime.date, None]
A specific date to get data for.
page : Union[int, NoneType]
page : Union[int, None]
Page number of the data to fetch.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -2411,7 +2411,7 @@ class CLASS_stocks_fa(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -2474,7 +2474,7 @@ class CLASS_stocks_fa(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -2567,9 +2567,9 @@ class CLASS_stocks_fa(Container):
Symbol to get data for.
period : Literal['annual', 'quarter']
Period of the data to return.
limit : Union[pydantic.types.NonNegativeInt, NoneType]
limit : Union[pydantic.types.NonNegativeInt, None]
The number of data entries to return.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -2750,7 +2750,7 @@ class CLASS_stocks_fa(Container):
Period of the data to return.
structure : Literal['hierarchical', 'flat']
Structure of the returned data.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -2831,7 +2831,7 @@ class CLASS_stocks_fa(Container):
Period of the data to return.
structure : Literal['hierarchical', 'flat']
Structure of the returned data.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -2890,7 +2890,7 @@ class CLASS_stocks_fa(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -2955,7 +2955,7 @@ class CLASS_stocks_fa(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -3030,7 +3030,7 @@ class CLASS_stocks_fa(Container):
Year of the earnings call transcript.
quarter : Literal[1, 2, 3, 4]
Quarter of the earnings call transcript.
provider : Union[Literal['fmp'], NoneType]
provider : Union[Literal['fmp'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.

4
openbb_sdk/openbb/package/stocks_options.py
View File

@@ -34,11 +34,11 @@ class CLASS_stocks_options(Container):
----------
symbol : Union[str, List[str]]
Symbol to get data for.
provider : Union[Literal['cboe', 'intrinio'], NoneType]
provider : Union[Literal['cboe', 'intrinio'], None]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'cboe' if there is
no default.
date : Union[datetime.date, str, NoneType]
date : Union[datetime.date, str, None]
Date for which the options chains are returned. (provider: intrinio)
Returns

16
openbb_sdk/sdk/core/openbb_core/app/static/package_builder.py
View File

@@ -334,6 +334,16 @@ class DocstringGenerator:
) -> str:
"""Create the docstring for model."""
def format_type(type_: str, char_limit: Optional[int] = None) -> str:
"""Format type in docstrings"""
type_str = str(type_)
type_str = type_str.replace("NoneType", "None")
if char_limit:
type_str = type_str[:char_limit] + (
"..." if len(str(type_str)) > char_limit else ""
)
return type_str
standard_dict = params["standard"].__dataclass_fields__
extra_dict = params["extra"].__dataclass_fields__
@@ -363,14 +373,16 @@ class DocstringGenerator:
type_ = ""
description = ""
docstring += f"{param_name} : {type_}\n"
type_str = format_type(type_, char_limit=79)
docstring += f"{param_name} : {type_str}\n"
docstring += f" {description}\n"
# Kwargs
for param_name, param in extra_dict.items():
p_type = param.type
type_ = p_type.__name__ if inspect.isclass(p_type) else p_type
docstring += f"{param_name} : {type_}\n"
type_str = format_type(type_)
docstring += f"{param_name} : {type_str}\n"
docstring += f" {param.default.description}\n"
# Returns