diff options
author | montezdesousa <79287829+montezdesousa@users.noreply.github.com> | 2023-09-19 15:16:29 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-09-19 16:16:29 +0200 |
commit | 848edee368ab920d7feb7348e6179d312bee3a04 (patch) | |
tree | 639ec6515ee282dbf93f377d4c812ae455c1d39c | |
parent | fc9d7522ac802e9f20c1226705b00f1429e5a17f (diff) |
Limit number of characters in docstring types (#5438)
* package_builder changes
* truncate only the mandatory args
* minor fix
-rw-r--r-- | openbb_sdk/openbb/package/crypto.py | 12 | ||||
-rw-r--r-- | openbb_sdk/openbb/package/economy.py | 36 | ||||
-rw-r--r-- | openbb_sdk/openbb/package/fixedincome.py | 50 | ||||
-rw-r--r-- | openbb_sdk/openbb/package/forex.py | 26 | ||||
-rw-r--r-- | openbb_sdk/openbb/package/futures.py | 16 | ||||
-rw-r--r-- | openbb_sdk/openbb/package/news.py | 32 | ||||
-rw-r--r-- | openbb_sdk/openbb/package/stocks.py | 98 | ||||
-rw-r--r-- | openbb_sdk/openbb/package/stocks_ca.py | 2 | ||||
-rw-r--r-- | openbb_sdk/openbb/package/stocks_dd.py | 8 | ||||
-rw-r--r-- | openbb_sdk/openbb/package/stocks_fa.py | 190 | ||||
-rw-r--r-- | openbb_sdk/openbb/package/stocks_options.py | 4 | ||||
-rw-r--r-- | openbb_sdk/sdk/core/openbb_core/app/static/package_builder.py | 16 |
12 files changed, 251 insertions, 239 deletions
diff --git a/openbb_sdk/openbb/package/crypto.py b/openbb_sdk/openbb/package/crypto.py index b6d602bd724..7148f48ea7e 100644 --- a/openbb_sdk/openbb/package/crypto.py +++ b/openbb_sdk/openbb/package/crypto.py @@ -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) diff --git a/openbb_sdk/openbb/package/economy.py b/openbb_sdk/openbb/package/economy.py index 12b5d5c5e98..cfd7d846d71 100644 --- a/openbb_sdk/openbb/package/economy.py +++ b/openbb_sdk/openbb/package/economy.py @@ -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. diff --git a/openbb_sdk/openbb/package/fixedincome.py b/openbb_sdk/openbb/package/fixedincome.py index 50bf2542345..b5510c462d5 100644 --- a/openbb_sdk/openbb/package/fixedincome.py +++ b/openbb_sdk/openbb/package/fixedincome.py @@ -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. diff --git a/openbb_sdk/openbb/package/forex.py b/openbb_sdk/openbb/package/forex.py index aaf80df5186..21808b761f5 100644 --- a/openbb_sdk/openbb/package/forex.py +++ b/openbb_sdk/openbb/package/forex.py @@ -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 diff --git a/openbb_sdk/openbb/package/futures.py b/openbb_sdk/openbb/package/futures.py index 3993a774d40..b5b573cb1bc 100644 --- a/openbb_sdk/openbb/package/futures.py +++ b/openbb_sdk/openbb/package/futures.py @@ -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) diff --git a/openbb_sdk/openbb/package/news.py b/openbb_sdk/openbb/package/news.py index ca86b4f4bae..6ce3239e8a6 100644 --- a/openbb_sdk/openbb/package/news.py +++ b/openbb_sdk/openbb/package/news.py @@ -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 diff --git a/openbb_sdk/openbb/package/stocks.py b/openbb_sdk/openbb/package/stocks.py index 49e3d986071..4197b48ebbf 100644 --- a/openbb_sdk/openbb/package/stocks.py +++ b/openbb_sdk/openbb/package/stocks.py @@ -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 |