From a64f4b49a5a427b08d1b8400b8abbf6e1f5f6f51 Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Tue, 7 May 2024 14:24:28 +0100 Subject: [PATCH 01/24] feat: add field annotation and replace multiple items by dict --- .../openbb_core/app/provider_interface.py | 18 +- .../openbb_core/app/static/package_builder.py | 13 +- .../openbb_core/app/static/utils/filters.py | 54 +- .../core/openbb_core/provider/registry_map.py | 75 +- openbb_platform/openbb/assets/reference.json | 25198 ++++++++++------ .../openbb/package/crypto_price.py | 10 +- openbb_platform/openbb/package/currency.py | 7 +- .../openbb/package/currency_price.py | 10 +- .../openbb/package/derivatives_options.py | 4 +- openbb_platform/openbb/package/economy.py | 37 +- openbb_platform/openbb/package/equity.py | 4 +- .../openbb/package/equity_estimates.py | 48 +- .../openbb/package/equity_fundamental.py | 68 +- .../openbb/package/equity_ownership.py | 8 +- .../openbb/package/equity_price.py | 33 +- openbb_platform/openbb/package/etf.py | 58 +- .../openbb/package/fixedincome_corporate.py | 12 +- openbb_platform/openbb/package/index.py | 14 +- openbb_platform/openbb/package/news.py | 103 +- .../openbb/package/regulators_sec.py | 17 +- .../models/equity_historical.py | 2 +- .../models/historical_eps.py | 2 +- .../openbb_benzinga/models/analyst_search.py | 10 +- .../openbb_benzinga/models/company_news.py | 2 +- .../openbb_benzinga/models/price_target.py | 2 +- .../openbb_cboe/models/equity_historical.py | 2 +- .../cboe/openbb_cboe/models/equity_quote.py | 2 +- .../openbb_cboe/models/index_historical.py | 2 +- .../openbb_econdb/models/country_profile.py | 2 +- .../models/economic_indicators.py | 4 +- .../openbb_finviz/models/equity_profile.py | 2 +- .../openbb_finviz/models/key_metrics.py | 2 +- .../openbb_finviz/models/price_performance.py | 2 +- .../openbb_finviz/models/price_target.py | 2 +- .../openbb_fmp/models/analyst_estimates.py | 2 +- .../fmp/openbb_fmp/models/company_news.py | 2 +- .../openbb_fmp/models/crypto_historical.py | 2 +- .../openbb_fmp/models/currency_historical.py | 2 +- .../openbb_fmp/models/currency_snapshots.py | 2 +- .../openbb_fmp/models/equity_historical.py | 2 +- .../fmp/openbb_fmp/models/equity_profile.py | 4 +- .../fmp/openbb_fmp/models/equity_quote.py | 2 +- .../models/equity_valuation_multiples.py | 2 +- .../fmp/openbb_fmp/models/etf_countries.py | 2 +- .../openbb_fmp/models/etf_equity_exposure.py | 2 +- .../fmp/openbb_fmp/models/etf_info.py | 2 +- .../models/executive_compensation.py | 2 +- .../models/forward_eps_estimates.py | 2 +- .../fmp/openbb_fmp/models/index_historical.py | 2 +- .../fmp/openbb_fmp/models/key_metrics.py | 2 +- .../openbb_fmp/models/price_performance.py | 2 +- .../fmp/openbb_fmp/models/price_target.py | 2 +- .../models/price_target_consensus.py | 2 +- .../providers/fred/openbb_fred/models/cpi.py | 2 +- .../fred/openbb_fred/models/series.py | 2 +- .../providers/fred/openbb_fred/models/spot.py | 4 +- .../openbb_intrinio/models/company_news.py | 2 +- .../openbb_intrinio/models/equity_info.py | 2 +- .../openbb_intrinio/models/equity_quote.py | 2 +- .../openbb_intrinio/models/etf_info.py | 2 +- .../models/etf_price_performance.py | 2 +- .../models/forward_eps_estimates.py | 2 +- .../models/forward_sales_estimates.py | 2 +- .../models/historical_attributes.py | 4 +- .../models/index_historical.py | 2 +- .../openbb_intrinio/models/key_metrics.py | 2 +- .../models/latest_attributes.py | 4 +- .../models/price_target_consensus.py | 2 +- .../openbb_nasdaq/models/economic_calendar.py | 2 +- .../models/historical_dividends.py | 2 +- .../openbb_polygon/models/company_news.py | 2 +- .../models/crypto_historical.py | 2 +- .../models/currency_historical.py | 2 +- .../models/currency_snapshots.py | 2 +- .../models/equity_historical.py | 2 +- .../openbb_polygon/models/index_historical.py | 2 +- .../openbb_tiingo/models/company_news.py | 2 +- .../openbb_tiingo/models/crypto_historical.py | 2 +- .../models/currency_historical.py | 2 +- .../openbb_tiingo/models/equity_historical.py | 2 +- .../tmx/openbb_tmx/models/company_news.py | 2 +- .../openbb_tmx/models/equity_historical.py | 2 +- .../tmx/openbb_tmx/models/equity_profile.py | 2 +- .../tmx/openbb_tmx/models/equity_quote.py | 2 +- .../tmx/openbb_tmx/models/etf_countries.py | 2 +- .../tmx/openbb_tmx/models/etf_info.py | 2 +- .../models/price_target_consensus.py | 2 +- .../models/equity_historical.py | 2 +- .../openbb_tradier/models/equity_quote.py | 2 +- .../models/economic_calendar.py | 2 +- .../openbb_yfinance/models/company_news.py | 2 +- .../models/crypto_historical.py | 2 +- .../models/currency_historical.py | 2 +- .../models/equity_historical.py | 2 +- .../openbb_yfinance/models/equity_profile.py | 2 +- .../openbb_yfinance/models/equity_quote.py | 2 +- .../openbb_yfinance/models/etf_info.py | 2 +- .../models/futures_historical.py | 2 +- .../models/index_historical.py | 2 +- .../openbb_yfinance/models/key_metrics.py | 2 +- .../openbb_yfinance/models/market_indices.py | 2 +- .../models/price_target_consensus.py | 2 +- .../models/share_statistics.py | 2 +- 103 files changed, 16036 insertions(+), 9939 deletions(-) diff --git a/openbb_platform/core/openbb_core/app/provider_interface.py b/openbb_platform/core/openbb_core/app/provider_interface.py index 0932704cb960..a4a47a0f2697 100644 --- a/openbb_platform/core/openbb_core/app/provider_interface.py +++ b/openbb_platform/core/openbb_core/app/provider_interface.py @@ -253,15 +253,21 @@ def _create_field( annotation = field.annotation additional_description = "" - if (extra := field.json_schema_extra) and ( - multiple := extra.get("multiple_items_allowed") # type: ignore - ): - if provider_name: + if extra := field.json_schema_extra: + providers = [] + for p, v in extra.items(): # type: ignore[union-attr] + if isinstance(v, dict) and v.get("multiple_items_allowed"): + providers.append(p) + elif isinstance(v, list) and "multiple_items_allowed" in v: + # For backwards compatibility, before this was a list + providers.append(p) + + if len(providers) == 1: additional_description += " Multiple comma separated items allowed." - else: + elif len(providers) > 1: additional_description += ( " Multiple comma separated items allowed for provider(s): " - + ", ".join(multiple) # type: ignore[arg-type] + + ", ".join(providers) # type: ignore[arg-type] + "." ) diff --git a/openbb_platform/core/openbb_core/app/static/package_builder.py b/openbb_platform/core/openbb_core/app/static/package_builder.py index 8a2a86a66190..c96a6c28c3a7 100644 --- a/openbb_platform/core/openbb_core/app/static/package_builder.py +++ b/openbb_platform/core/openbb_core/app/static/package_builder.py @@ -524,6 +524,9 @@ def get_extra(field: FieldInfo) -> dict: # Getting json_schema_extra without changing the original dict json_schema_extra = getattr(field_default, "json_schema_extra", {}).copy() json_schema_extra.pop("choices", None) + for v in json_schema_extra.values(): + if isinstance(v, dict): + v.pop("annotation", None) return json_schema_extra return {} @@ -864,7 +867,15 @@ def get_expanded_type( original_type: Optional[type] = None, ) -> object: """Expand the original field type.""" - if extra and "multiple_items_allowed" in extra: + if extra and any( + ( + v.get("multiple_items_allowed") + if isinstance(v, dict) + # For backwards compatibility, before this was a list + else "multiple_items_allowed" in v + ) + for v in extra.values() + ): if original_type is None: raise ValueError( "multiple_items_allowed requires the original type to be specified." diff --git a/openbb_platform/core/openbb_core/app/static/utils/filters.py b/openbb_platform/core/openbb_core/app/static/utils/filters.py index b2262a1e8c88..3f2c02708428 100644 --- a/openbb_platform/core/openbb_core/app/static/utils/filters.py +++ b/openbb_platform/core/openbb_core/app/static/utils/filters.py @@ -1,13 +1,13 @@ """OpenBB filters.""" -from typing import Dict, List, Optional +from typing import Any, Dict, Optional from openbb_core.app.utils import check_single_item, convert_to_basemodel def filter_inputs( data_processing: bool = False, - info: Optional[Dict[str, Dict[str, List[str]]]] = None, + info: Optional[Dict[str, Dict[str, Any]]] = None, **kwargs, ) -> dict: """Filter command inputs.""" @@ -16,32 +16,42 @@ def filter_inputs( kwargs[key] = convert_to_basemodel(value) if info: - PROPERTY = "multiple_items_allowed" - # Here we check if list items are passed and multiple items allowed for # the given provider/input combination. In that case we transform the list # into a comma-separated string - for field, props in info.items(): - if PROPERTY in props and ( - provider := kwargs.get("provider_choices", {}).get("provider") - ): - for p in ("standard_params", "extra_params"): - if field in kwargs.get(p, {}): - current = kwargs[p][field] - new = ( - ",".join(map(str, current)) - if isinstance(current, list) - else current + provider = kwargs.get("provider_choices", {}).get("provider") + for field, properties in info.items(): + + for p in ("standard_params", "extra_params"): + if field in kwargs.get(p, {}): + current = kwargs[p][field] + new = ( + ",".join(map(str, current)) + if isinstance(current, list) + else current + ) + + provider_properties = properties.get(provider, {}) + if isinstance(provider_properties, dict): + multiple_items_allowed = provider_properties.get( + "multiple_items_allowed" + ) + elif isinstance(provider_properties, list): + # For backwards compatibility, before this was a list + multiple_items_allowed = ( + "multiple_items_allowed" in provider_properties ) + else: + multiple_items_allowed = True - if provider and provider not in props[PROPERTY]: - check_single_item( - new, - f"{field} -> multiple items not allowed for '{provider}'", - ) + if not multiple_items_allowed: + check_single_item( + new, + f"{field} -> multiple items not allowed for '{provider}'", + ) - kwargs[p][field] = new - break + kwargs[p][field] = new + break else: provider = kwargs.get("provider_choices", {}).get("provider") for param_category in ("standard_params", "extra_params"): diff --git a/openbb_platform/core/openbb_core/provider/registry_map.py b/openbb_platform/core/openbb_core/provider/registry_map.py index 05dff9ef4f6c..a620fd6d45ee 100644 --- a/openbb_platform/core/openbb_core/provider/registry_map.py +++ b/openbb_platform/core/openbb_core/provider/registry_map.py @@ -104,11 +104,11 @@ def _get_maps(self, registry: Registry) -> Tuple[MapType, Dict[str, Dict]]: } ) - self._merge_json_schema_extra(p, fetcher, standard_extra[model_name]) + self._update_json_schema_extra(p, fetcher, standard_extra[model_name]) return standard_extra, original_models - def _merge_json_schema_extra( + def _update_json_schema_extra( self, provider: str, fetcher: Fetcher, @@ -116,26 +116,30 @@ def _merge_json_schema_extra( ): """Merge json schema extra for different providers.""" model: BaseModel = RegistryMap._get_model(fetcher, "query_params") - std_fields = model_map["openbb"]["QueryParams"]["fields"] + standard_fields = model_map["openbb"]["QueryParams"]["fields"] extra_fields = model_map[provider]["QueryParams"]["fields"] - for f, props in getattr(model, "__json_schema_extra__", {}).items(): - for p in props: - if f in std_fields: - model_field = std_fields[f] - elif f in extra_fields: - model_field = extra_fields[f] - else: - continue - if model_field.json_schema_extra is None: - model_field.json_schema_extra = {} + for field, properties in getattr(model, "__json_schema_extra__", {}).items(): + if field in standard_fields: + model_field = standard_fields[field] + elif field in extra_fields: + model_field = extra_fields[field] + else: + continue - if p not in model_field.json_schema_extra: - model_field.json_schema_extra[p] = [] + if model_field.json_schema_extra is None: + model_field.json_schema_extra = {} - providers = model_field.json_schema_extra[p] - if provider not in providers: - providers.append(provider) + model_field.json_schema_extra[provider] = properties + + # Register annotation for standard fields edited in the provider + for cf in set(standard_fields).intersection(set(extra_fields)): + if standard_fields[cf].json_schema_extra is None: + standard_fields[cf].json_schema_extra = {} + if extra_fields[cf].annotation != standard_fields[cf].annotation: + standard_fields[cf].json_schema_extra.setdefault(provider, {}).update( + {"annotation": extra_fields[cf].annotation} + ) def _get_models(self, map_: MapType) -> List[str]: """Get available models.""" @@ -152,33 +156,28 @@ def _extract_info( ) -> tuple: """Extract info (fields and docstring) from fetcher query params or data.""" model: BaseModel = RegistryMap._get_model(fetcher, type_) - all_fields = {} standard_info: Dict[str, Any] = {"fields": {}, "docstring": None} - found_top_level = False + extra_info: Dict[str, Any] = {"fields": {}, "docstring": model.__doc__} + found_first_standard = False for c in RegistryMap._class_hierarchy(model): if c.__name__ in SKIP: continue - if (Path(getfile(c)).parent == STANDARD_MODELS_FOLDER) or found_top_level: - if not found_top_level: - # We might update the standard_info more than once to account for - # nested standard models, but we only want to update the docstring - # once with the __doc__ of the top-level standard model. - standard_info["docstring"] = c.__doc__ - found_top_level = True - standard_info["fields"].update(c.model_fields) - else: - all_fields.update(c.model_fields) - extra_info: Dict[str, Any] = { - "fields": {}, - "docstring": model.__doc__, - } + fields = { + name: field + for name, field in c.model_fields.items() + # This ensures fields inherited by c are discarded + if name in c.__annotations__ + } - # We ignore fields that are already in the standard model - for name, field in all_fields.items(): - if name not in standard_info["fields"]: - extra_info["fields"][name] = field + if Path(getfile(c)).parent == STANDARD_MODELS_FOLDER: + if not found_first_standard: + standard_info["docstring"] = c.__doc__ + found_first_standard = True + standard_info["fields"].update(fields) + else: + extra_info["fields"].update(fields) return standard_info, extra_info diff --git a/openbb_platform/openbb/assets/reference.json b/openbb_platform/openbb/assets/reference.json index 3d8781d622cc..3af8ae342e88 100644 --- a/openbb_platform/openbb/assets/reference.json +++ b/openbb_platform/openbb/assets/reference.json @@ -47,8 +47,8 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", + "type": "str", + "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format.", "default": "", "optional": false }, @@ -261,7 +261,57 @@ "optional": true } ], - "yfinance": [] + "yfinance": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false + }, + { + "name": "vwap", + "type": "Annotated[float, Gt(gt=0)]", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true + } + ] }, "model": "CryptoHistorical" }, @@ -289,7 +339,15 @@ "optional": true } ], - "fmp": [] + "fmp": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": null, + "optional": true + } + ] }, "returns": { "OBBject": [ @@ -374,8 +432,8 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", + "type": "str", + "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format.", "default": "", "optional": false }, @@ -565,8 +623,108 @@ "optional": true } ], - "tiingo": [], - "yfinance": [] + "tiingo": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": null, + "optional": true + }, + { + "name": "vwap", + "type": "Annotated[float, Gt(gt=0)]", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": null, + "optional": true + }, + { + "name": "vwap", + "type": "Annotated[float, Gt(gt=0)]", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true + } + ] }, "model": "CurrencyHistorical" }, @@ -805,8 +963,8 @@ "standard": [ { "name": "base", - "type": "Union[str, List[str]]", - "description": "The base currency symbol. Multiple items allowed for provider(s): fmp, polygon.", + "type": "str", + "description": "The base currency symbol.", "default": "usd", "optional": true }, @@ -832,8 +990,52 @@ "optional": true } ], - "fmp": [], - "polygon": [] + "fmp": [ + { + "name": "base", + "type": "str", + "description": "The base currency symbol.", + "default": "usd", + "optional": true + }, + { + "name": "quote_type", + "type": "Literal['direct', 'indirect']", + "description": "Whether the quote is direct or indirect. Selecting 'direct' will return the exchange rate as the amount of domestic currency required to buy one unit of the foreign currency. Selecting 'indirect' (default) will return the exchange rate as the amount of foreign currency required to buy one unit of the domestic currency.", + "default": "indirect", + "optional": true + }, + { + "name": "counter_currencies", + "type": "Union[List[str], str]", + "description": "An optional list of counter currency symbols to filter for. None returns all.", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "base", + "type": "str", + "description": "The base currency symbol.", + "default": "usd", + "optional": true + }, + { + "name": "quote_type", + "type": "Literal['direct', 'indirect']", + "description": "Whether the quote is direct or indirect. Selecting 'direct' will return the exchange rate as the amount of domestic currency required to buy one unit of the foreign currency. Selecting 'indirect' (default) will return the exchange rate as the amount of foreign currency required to buy one unit of the domestic currency.", + "default": "indirect", + "optional": true + }, + { + "name": "counter_currencies", + "type": "Union[List[str], str]", + "description": "An optional list of counter currency symbols to filter for. None returns all.", + "default": null, + "optional": true + } + ] }, "returns": { "OBBject": [ @@ -1713,8 +1915,8 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "type": "str", + "description": "Symbol to get data for.", "default": "", "optional": false }, @@ -1831,44 +2033,102 @@ "optional": false } ], - "yfinance": [] - }, - "model": "FuturesHistorical" - }, - "/derivatives/futures/curve": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Futures Term Structure, current or historical.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Enter a date to get the term structure from a historical date.\nobb.derivatives.futures.curve(symbol='NG', provider='yfinance', date='2023-01-01')\n```\n\n", - "parameters": { - "standard": [ + "yfinance": [ { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "name": "date", + "type": "datetime", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", - "default": null, - "optional": true + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Literal['yfinance']", - "description": "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.", - "default": "yfinance", - "optional": true - } - ], - "yfinance": [] - }, - "returns": { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false + } + ] + }, + "model": "FuturesHistorical" + }, + "/derivatives/futures/curve": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Futures Term Structure, current or historical.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Enter a date to get the term structure from a historical date.\nobb.derivatives.futures.curve(symbol='NG', provider='yfinance', date='2023-01-01')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['yfinance']", + "description": "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.", + "default": "yfinance", + "optional": true + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": null, + "optional": true + } + ] + }, + "returns": { "OBBject": [ { "name": "results", @@ -1914,7 +2174,22 @@ "optional": true } ], - "yfinance": [] + "yfinance": [ + { + "name": "expiration", + "type": "str", + "description": "Futures expiration month.", + "default": "", + "optional": false + }, + { + "name": "price", + "type": "float", + "description": "The close price.", + "default": null, + "optional": true + } + ] }, "model": "FuturesCurve" }, @@ -2019,7 +2294,22 @@ "optional": true } ], - "oecd": [] + "oecd": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": null, + "optional": true + }, + { + "name": "value", + "type": "float", + "description": "Nominal GDP value on the date.", + "default": null, + "optional": true + } + ] }, "model": "GdpForecast" }, @@ -2117,7 +2407,22 @@ "optional": true } ], - "oecd": [] + "oecd": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": null, + "optional": true + }, + { + "name": "value", + "type": "float", + "description": "Nominal GDP value on the date.", + "default": null, + "optional": true + } + ] }, "model": "GdpNominal" }, @@ -2215,7 +2520,22 @@ "optional": true } ], - "oecd": [] + "oecd": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": null, + "optional": true + }, + { + "name": "value", + "type": "float", + "description": "Nominal GDP value on the date.", + "default": null, + "optional": true + } + ] }, "model": "GdpReal" }, @@ -2250,12 +2570,27 @@ "optional": true } ], - "fmp": [], + "fmp": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + } + ], "tradingeconomics": [ { "name": "country", - "type": "Union[str, List[str]]", - "description": "Country of the event. Multiple items allowed for provider(s): tradingeconomics.", + "type": "str", + "description": "Country of the event.", "default": null, "optional": true }, @@ -2435,92 +2770,234 @@ "optional": true } ], - "tradingeconomics": [] - }, - "model": "EconomicCalendar" - }, - "/economy/cpi": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get Consumer Price Index (CPI).\n\nReturns either the rescaled index value, or a rate of change (inflation).", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.cpi(country='japan,china,turkey', provider='fred')\n# Use the `units` parameter to define the reference period for the change in values.\nobb.economy.cpi(country='united_states,united_kingdom', units='growth_previous', provider='fred')\n```\n\n", - "parameters": { - "standard": [ + "tradingeconomics": [ { - "name": "country", - "type": "Union[str, List[str]]", - "description": "The country to get data. Multiple items allowed for provider(s): fred.", - "default": "", - "optional": false + "name": "date", + "type": "datetime", + "description": "The date of the data.", + "default": null, + "optional": true }, { - "name": "units", - "type": "Literal['growth_previous', 'growth_same', 'index_2015']", - "description": "The unit of measurement for the data. Options: - `growth_previous`: Percent growth from the previous period. If monthly data, this is month-over-month, etc - `growth_same`: Percent growth from the same period in the previous year. If looking at monthly data, this would be year-over-year, etc. - `index_2015`: Rescaled index value, such that the value in 2015 is 100.", - "default": "growth_same", + "name": "country", + "type": "str", + "description": "Country of event.", + "default": null, "optional": true }, { - "name": "frequency", - "type": "Literal['monthly', 'quarter', 'annual']", - "description": "The frequency of the data. Options: `monthly`, `quarter`, and `annual`.", - "default": "monthly", + "name": "event", + "type": "str", + "description": "Event name.", + "default": null, "optional": true }, { - "name": "harmonized", - "type": "bool", - "description": "Whether you wish to obtain harmonized data.", - "default": false, + "name": "reference", + "type": "str", + "description": "Abbreviated period for which released data refers to.", + "default": null, "optional": true }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "source", + "type": "str", + "description": "Source of the data.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "sourceurl", + "type": "str", + "description": "Source URL.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fred']", - "description": "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.", - "default": "fred", + "name": "actual", + "type": "Union[str, float]", + "description": "Latest released value.", + "default": null, "optional": true - } - ], - "fred": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[ConsumerPriceIndex]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." + "name": "previous", + "type": "Union[str, float]", + "description": "Value for the previous period after the revision (if revision is applicable).", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "consensus", + "type": "Union[str, float]", + "description": "Average forecast among a representative group of economists.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "forecast", + "type": "Union[str, float]", + "description": "Trading Economics projections", + "default": null, + "optional": true + }, + { + "name": "url", + "type": "str", + "description": "Trading Economics URL", + "default": null, + "optional": true + }, + { + "name": "importance", + "type": "Union[Literal[0, 1, 2, 3], str]", + "description": "Importance of the event. 1-Low, 2-Medium, 3-High", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency of the data.", + "default": null, + "optional": true + }, + { + "name": "unit", + "type": "str", + "description": "Unit of the data.", + "default": null, + "optional": true + } + ] + }, + "model": "EconomicCalendar" + }, + "/economy/cpi": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Consumer Price Index (CPI).\n\nReturns either the rescaled index value, or a rate of change (inflation).", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.cpi(country='japan,china,turkey', provider='fred')\n# Use the `units` parameter to define the reference period for the change in values.\nobb.economy.cpi(country='united_states,united_kingdom', units='growth_previous', provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "country", + "type": "str", + "description": "The country to get data.", + "default": "", + "optional": false + }, + { + "name": "units", + "type": "Literal['growth_previous', 'growth_same', 'index_2015']", + "description": "The unit of measurement for the data. Options: - `growth_previous`: Percent growth from the previous period. If monthly data, this is month-over-month, etc - `growth_same`: Percent growth from the same period in the previous year. If looking at monthly data, this would be year-over-year, etc. - `index_2015`: Rescaled index value, such that the value in 2015 is 100.", + "default": "growth_same", + "optional": true + }, + { + "name": "frequency", + "type": "Literal['monthly', 'quarter', 'annual']", + "description": "The frequency of the data. Options: `monthly`, `quarter`, and `annual`.", + "default": "monthly", + "optional": true + }, + { + "name": "harmonized", + "type": "bool", + "description": "Whether you wish to obtain harmonized data.", + "default": false, + "optional": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [ + { + "name": "country", + "type": "str", + "description": "The country to get data.", + "default": "", + "optional": false + }, + { + "name": "units", + "type": "Literal['growth_previous', 'growth_same', 'index_2015']", + "description": "The unit of measurement for the data. Options: - `growth_previous`: Percent growth from the previous period. If monthly data, this is month-over-month, etc - `growth_same`: Percent growth from the same period in the previous year. If looking at monthly data, this would be year-over-year, etc. - `index_2015`: Rescaled index value, such that the value in 2015 is 100.", + "default": "growth_same", + "optional": true + }, + { + "name": "frequency", + "type": "Literal['monthly', 'quarter', 'annual']", + "description": "The frequency of the data. Options: `monthly`, `quarter`, and `annual`.", + "default": "monthly", + "optional": true + }, + { + "name": "harmonized", + "type": "bool", + "description": "Whether you wish to obtain harmonized data.", + "default": false, + "optional": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[ConsumerPriceIndex]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { "name": "extra", @@ -2539,7 +3016,15 @@ "optional": false } ], - "fred": [] + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + } + ] }, "model": "ConsumerPriceIndex" }, @@ -2622,7 +3107,36 @@ "optional": true } ], - "fmp": [] + "fmp": [ + { + "name": "country", + "type": "str", + "description": "Market country.", + "default": "", + "optional": false + }, + { + "name": "continent", + "type": "str", + "description": "Continent of the country.", + "default": null, + "optional": true + }, + { + "name": "total_equity_risk_premium", + "type": "Annotated[float, Gt(gt=0)]", + "description": "Total equity risk premium for the country.", + "default": null, + "optional": true + }, + { + "name": "country_risk_premium", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Country-specific risk premium.", + "default": null, + "optional": true + } + ] }, "model": "RiskPremium" }, @@ -2904,8 +3418,8 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fred.", + "type": "str", + "description": "Symbol to get data for.", "default": "", "optional": false }, @@ -2939,6 +3453,13 @@ } ], "fred": [ + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100000, + "optional": true + }, { "name": "frequency", "type": "Literal[None, 'a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", @@ -3017,7 +3538,15 @@ "optional": false } ], - "fred": [], + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + } + ], "intrinio": [ { "name": "value", @@ -3068,7 +3597,29 @@ "optional": true } ], - "federal_reserve": [] + "federal_reserve": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "adjusted", + "type": "bool", + "description": "Whether to return seasonally adjusted data.", + "default": true, + "optional": true + } + ] }, "returns": { "OBBject": [ @@ -3158,23 +3709,80 @@ "optional": true } ], - "federal_reserve": [] - }, - "model": "MoneyMeasures" - }, - "/economy/unemployment": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get global unemployment data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.unemployment(provider='oecd')\nobb.economy.unemployment(country=all, frequency=quarterly, provider='oecd')\n# Demographics for the statistics are selected with the `age` parameter.\nobb.economy.unemployment(country=all, frequency=quarterly, age=25-54, provider='oecd')\n```\n\n", - "parameters": { - "standard": [ + "federal_reserve": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "month", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "M1", + "type": "float", + "description": "Value of the M1 money supply in billions.", + "default": "", + "optional": false + }, + { + "name": "M2", + "type": "float", + "description": "Value of the M2 money supply in billions.", + "default": "", + "optional": false + }, + { + "name": "currency", + "type": "float", + "description": "Value of currency in circulation in billions.", + "default": null, + "optional": true + }, + { + "name": "demand_deposits", + "type": "float", + "description": "Value of demand deposits in billions.", + "default": null, + "optional": true + }, + { + "name": "retail_money_market_funds", + "type": "float", + "description": "Value of retail money market funds in billions.", + "default": null, + "optional": true + }, + { + "name": "other_liquid_deposits", + "type": "float", + "description": "Value of other liquid deposits in billions.", + "default": null, + "optional": true + }, + { + "name": "small_denomination_time_deposits", + "type": "float", + "description": "Value of small denomination time deposits in billions.", + "default": null, + "optional": true + } + ] + }, + "model": "MoneyMeasures" + }, + "/economy/unemployment": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get global unemployment data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.unemployment(provider='oecd')\nobb.economy.unemployment(country=all, frequency=quarterly, provider='oecd')\n# Demographics for the statistics are selected with the `age` parameter.\nobb.economy.unemployment(country=all, frequency=quarterly, age=25-54, provider='oecd')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, @@ -3284,7 +3892,29 @@ "optional": true } ], - "oecd": [] + "oecd": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": null, + "optional": true + }, + { + "name": "value", + "type": "float", + "description": "Unemployment rate (given as a whole number, i.e 10=10%)", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Country for which unemployment rate is given", + "default": null, + "optional": true + } + ] }, "model": "Unemployment" }, @@ -3382,7 +4012,29 @@ "optional": true } ], - "oecd": [] + "oecd": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": null, + "optional": true + }, + { + "name": "value", + "type": "float", + "description": "CLI value", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Country for which CLI is given", + "default": null, + "optional": true + } + ] }, "model": "CLI" }, @@ -3487,7 +4139,29 @@ "optional": true } ], - "oecd": [] + "oecd": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": null, + "optional": true + }, + { + "name": "value", + "type": "float", + "description": "Interest rate (given as a whole number, i.e 10=10%)", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Country for which interest rate is given", + "default": null, + "optional": true + } + ] }, "model": "STIR" }, @@ -3592,7 +4266,29 @@ "optional": true } ], - "oecd": [] + "oecd": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": null, + "optional": true + }, + { + "name": "value", + "type": "float", + "description": "Interest rate (given as a whole number, i.e 10=10%)", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Country for which interest rate is given", + "default": null, + "optional": true + } + ] }, "model": "LTIR" }, @@ -3642,6 +4338,13 @@ } ], "fred": [ + { + "name": "symbol", + "type": "str", + "description": "For this function, it is the series_group ID or series ID. If the symbol provided is for a series_group, set the `is_series_group` parameter to True. Not all series that are in FRED have geographical data.", + "default": "", + "optional": false + }, { "name": "is_series_group", "type": "bool", @@ -3776,8 +4479,8 @@ "standard": [ { "name": "country", - "type": "Union[str, List[str]]", - "description": "The country to get data. Multiple items allowed for provider(s): econdb.", + "type": "str", + "description": "The country to get data.", "default": "", "optional": false }, @@ -3936,91 +4639,190 @@ "optional": true } ], - "econdb": [] - }, - "model": "CountryProfile" - }, - "/economy/available_indicators": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the available economic indicators for a provider.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.available_indicators(provider='econdb')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "provider", - "type": "Literal['econdb']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'econdb' if there is no default.", - "default": "econdb", - "optional": true - } - ], "econdb": [ { - "name": "use_cache", - "type": "bool", - "description": "Whether to use cache or not, by default is True The cache of indicator symbols will persist for one week.", - "default": true, - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[AvailableIndicators]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['econdb']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "country", + "type": "str", + "description": "", + "default": "", + "optional": false }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "population", + "type": "int", + "description": "Population.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol_root", - "type": "str", - "description": "The root symbol representing the indicator.", + "name": "gdp_usd", + "type": "float", + "description": "Gross Domestic Product, in billions of USD.", "default": null, "optional": true }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data. The root symbol with additional codes.", + "name": "gdp_qoq", + "type": "float", + "description": "GDP growth quarter-over-quarter change, as a normalized percent.", "default": null, "optional": true }, { - "name": "country", - "type": "str", - "description": "The name of the country, region, or entity represented by the symbol.", + "name": "gdp_yoy", + "type": "float", + "description": "GDP growth year-over-year change, as a normalized percent.", "default": null, "optional": true }, { - "name": "iso", + "name": "cpi_yoy", + "type": "float", + "description": "Consumer Price Index year-over-year change, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "core_yoy", + "type": "float", + "description": "Core Consumer Price Index year-over-year change, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "retail_sales_yoy", + "type": "float", + "description": "Retail Sales year-over-year change, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "industrial_production_yoy", + "type": "float", + "description": "Industrial Production year-over-year change, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "policy_rate", + "type": "float", + "description": "Short term policy rate, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "yield_10y", + "type": "float", + "description": "10-year government bond yield, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "govt_debt_gdp", + "type": "float", + "description": "Government debt as a percent (normalized) of GDP.", + "default": null, + "optional": true + }, + { + "name": "current_account_gdp", + "type": "float", + "description": "Current account balance as a percent (normalized) of GDP.", + "default": null, + "optional": true + }, + { + "name": "jobless_rate", + "type": "float", + "description": "Unemployment rate, as a normalized percent.", + "default": null, + "optional": true + } + ] + }, + "model": "CountryProfile" + }, + "/economy/available_indicators": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the available economic indicators for a provider.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.available_indicators(provider='econdb')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "provider", + "type": "Literal['econdb']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'econdb' if there is no default.", + "default": "econdb", + "optional": true + } + ], + "econdb": [ + { + "name": "use_cache", + "type": "bool", + "description": "Whether to use cache or not, by default is True The cache of indicator symbols will persist for one week.", + "default": true, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[AvailableIndicators]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['econdb']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol_root", + "type": "str", + "description": "The root symbol representing the indicator.", + "default": null, + "optional": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. The root symbol with additional codes.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "The name of the country, region, or entity represented by the symbol.", + "default": null, + "optional": true + }, + { + "name": "iso", "type": "str", "description": "The ISO code of the country, region, or entity represented by the symbol.", "default": null, @@ -4113,15 +4915,15 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Multiple items allowed for provider(s): econdb.", + "type": "str", + "description": "Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.).", "default": "", "optional": false }, { "name": "country", - "type": "Union[str, List[str]]", - "description": "The country to get data. The country represented by the indicator, if available. Multiple items allowed for provider(s): econdb.", + "type": "str", + "description": "The country to get data. The country represented by the indicator, if available.", "default": null, "optional": true }, @@ -4231,7 +5033,43 @@ "optional": true } ], - "econdb": [] + "econdb": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "symbol_root", + "type": "str", + "description": "The root symbol for the indicator (e.g. GDP).", + "default": null, + "optional": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "The country represented by the data.", + "default": null, + "optional": true + }, + { + "name": "value", + "type": "Union[int, float]", + "description": "", + "default": null, + "optional": true + } + ] }, "model": "EconomicIndicators" }, @@ -4526,7 +5364,22 @@ "optional": true } ], - "fmp": [] + "fmp": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + } + ] }, "returns": { "OBBject": [ @@ -4659,7 +5512,22 @@ "optional": true } ], - "fmp": [] + "fmp": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + } + ] }, "returns": { "OBBject": [ @@ -4728,42 +5596,93 @@ "optional": false } ], - "fmp": [] - }, - "model": "CalendarSplits" - }, - "/equity/calendar/earnings": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get historical and upcoming company earnings releases. Includes earnings per share (EPS) and revenue data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.calendar.earnings(provider='fmp')\n# Get earnings calendar for specific dates.\nobb.equity.calendar.earnings(start_date='2024-02-01', end_date='2024-02-07', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ + "fmp": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true + "name": "label", + "type": "str", + "description": "Label of the stock splits.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Literal['fmp']", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "numerator", + "type": "float", + "description": "Numerator of the stock splits.", + "default": "", + "optional": false + }, + { + "name": "denominator", + "type": "float", + "description": "Denominator of the stock splits.", + "default": "", + "optional": false + } + ] + }, + "model": "CalendarSplits" + }, + "/equity/calendar/earnings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical and upcoming company earnings releases. Includes earnings per share (EPS) and revenue data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.calendar.earnings(provider='fmp')\n# Get earnings calendar for specific dates.\nobb.equity.calendar.earnings(start_date='2024-02-01', end_date='2024-02-07', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp']", "description": "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.", "default": "fmp", "optional": true } ], - "fmp": [] + "fmp": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + } + ] }, "returns": { "OBBject": [ @@ -4903,7 +5822,15 @@ "optional": true } ], - "fmp": [] + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + } + ] }, "returns": { "OBBject": [ @@ -4944,7 +5871,15 @@ "optional": true } ], - "fmp": [] + "fmp": [ + { + "name": "peers_list", + "type": "List[str]", + "description": "A list of equity peers based on sector, exchange and market cap.", + "default": "", + "optional": true + } + ] }, "model": "EquityPeers" }, @@ -4959,8 +5894,8 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp.", + "type": "str", + "description": "Symbol to get data for.", "default": null, "optional": true }, @@ -5206,6 +6141,13 @@ } ], "benzinga": [ + { + "name": "action", + "type": "Literal['Downgrades', 'Maintains', 'Reinstates', 'Reiterates', 'Upgrades', 'Assumes', 'Initiates Coverage On', 'Terminates Coverage On', 'Removes', 'Suspends', 'Firm Dissolved']", + "description": "Description of the change in rating from firm's last rating.Note that all of these terms are precisely defined.", + "default": null, + "optional": true + }, { "name": "action_change", "type": "Literal['Announces', 'Maintains', 'Lowers', 'Raises', 'Removes', 'Adjusts']", @@ -5307,8 +6249,8 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "type": "str", + "description": "Symbol to get data for.", "default": "", "optional": false }, @@ -5523,77 +6465,7 @@ "optional": true } ], - "fmp": [] - }, - "model": "AnalystEstimates" - }, - "/equity/estimates/consensus": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get consensus price target and recommendation.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.consensus(symbol='AAPL', provider='fmp')\nobb.equity.estimates.consensus(symbol='AAPL,MSFT', provider='yfinance')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", - "default": null, - "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'yfinance']", - "description": "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.", - "default": "fmp", - "optional": true - } - ], - "fmp": [], - "intrinio": [ - { - "name": "industry_group_number", - "type": "int", - "description": "The Zacks industry group number.", - "default": null, - "optional": true - } - ], - "yfinance": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[PriceTargetConsensus]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "fmp": [ { "name": "symbol", "type": "str", @@ -5602,190 +6474,203 @@ "optional": false }, { - "name": "name", - "type": "str", - "description": "The company name", + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "estimated_revenue_low", + "type": "int", + "description": "Estimated revenue low.", "default": null, "optional": true }, { - "name": "target_high", - "type": "float", - "description": "High target of the price target consensus.", + "name": "estimated_revenue_high", + "type": "int", + "description": "Estimated revenue high.", "default": null, "optional": true }, { - "name": "target_low", - "type": "float", - "description": "Low target of the price target consensus.", + "name": "estimated_revenue_avg", + "type": "int", + "description": "Estimated revenue average.", "default": null, "optional": true }, { - "name": "target_consensus", - "type": "float", - "description": "Consensus target of the price target consensus.", + "name": "estimated_sga_expense_low", + "type": "int", + "description": "Estimated SGA expense low.", "default": null, "optional": true }, { - "name": "target_median", - "type": "float", - "description": "Median target of the price target consensus.", + "name": "estimated_sga_expense_high", + "type": "int", + "description": "Estimated SGA expense high.", "default": null, "optional": true - } - ], - "fmp": [], - "intrinio": [ + }, { - "name": "standard_deviation", - "type": "float", - "description": "The standard deviation of target price estimates.", + "name": "estimated_sga_expense_avg", + "type": "int", + "description": "Estimated SGA expense average.", "default": null, "optional": true }, { - "name": "total_anaylsts", + "name": "estimated_ebitda_low", "type": "int", - "description": "The total number of target price estimates in consensus.", + "description": "Estimated EBITDA low.", "default": null, "optional": true }, { - "name": "raised", + "name": "estimated_ebitda_high", "type": "int", - "description": "The number of analysts that have raised their target price estimates.", + "description": "Estimated EBITDA high.", "default": null, "optional": true }, { - "name": "lowered", + "name": "estimated_ebitda_avg", "type": "int", - "description": "The number of analysts that have lowered their target price estimates.", + "description": "Estimated EBITDA average.", "default": null, "optional": true }, { - "name": "most_recent_date", - "type": "date", - "description": "The date of the most recent estimate.", + "name": "estimated_ebit_low", + "type": "int", + "description": "Estimated EBIT low.", "default": null, "optional": true }, { - "name": "industry_group_number", + "name": "estimated_ebit_high", "type": "int", - "description": "The Zacks industry group number.", + "description": "Estimated EBIT high.", "default": null, "optional": true - } - ], - "yfinance": [ + }, { - "name": "recommendation", - "type": "str", - "description": "Recommendation - buy, sell, etc.", + "name": "estimated_ebit_avg", + "type": "int", + "description": "Estimated EBIT average.", "default": null, "optional": true }, { - "name": "recommendation_mean", - "type": "float", - "description": "Mean recommendation score where 1 is strong buy and 5 is strong sell.", + "name": "estimated_net_income_low", + "type": "int", + "description": "Estimated net income low.", "default": null, "optional": true }, { - "name": "number_of_analysts", + "name": "estimated_net_income_high", "type": "int", - "description": "Number of analysts providing opinions.", + "description": "Estimated net income high.", "default": null, "optional": true }, { - "name": "current_price", + "name": "estimated_net_income_avg", + "type": "int", + "description": "Estimated net income average.", + "default": null, + "optional": true + }, + { + "name": "estimated_eps_avg", "type": "float", - "description": "Current price of the stock.", + "description": "Estimated EPS average.", "default": null, "optional": true }, { - "name": "currency", - "type": "str", - "description": "Currency the stock is priced in.", + "name": "estimated_eps_high", + "type": "float", + "description": "Estimated EPS high.", + "default": null, + "optional": true + }, + { + "name": "estimated_eps_low", + "type": "float", + "description": "Estimated EPS low.", + "default": null, + "optional": true + }, + { + "name": "number_analyst_estimated_revenue", + "type": "int", + "description": "Number of analysts who estimated revenue.", + "default": null, + "optional": true + }, + { + "name": "number_analysts_estimated_eps", + "type": "int", + "description": "Number of analysts who estimated EPS.", "default": null, "optional": true } ] }, - "model": "PriceTargetConsensus" + "model": "AnalystEstimates" }, - "/equity/estimates/analyst_search": { + "/equity/estimates/consensus": { "deprecated": { "flag": null, "message": null }, - "description": "Search for specific analysts and get their forecast track record.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.analyst_search(provider='benzinga')\nobb.equity.estimates.analyst_search(firm_name='Wedbush', provider='benzinga')\n```\n\n", + "description": "Get consensus price target and recommendation.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.consensus(symbol='AAPL', provider='fmp')\nobb.equity.estimates.consensus(symbol='AAPL,MSFT', provider='yfinance')\n```\n\n", "parameters": { "standard": [ { - "name": "analyst_name", - "type": "Union[str, List[str]]", - "description": "Analyst names to return. Omitting will return all available analysts. Multiple items allowed for provider(s): benzinga.", - "default": null, - "optional": true - }, - { - "name": "firm_name", - "type": "Union[str, List[str]]", - "description": "Firm names to return. Omitting will return all available firms. Multiple items allowed for provider(s): benzinga.", + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", "default": null, "optional": true }, { "name": "provider", - "type": "Literal['benzinga']", - "description": "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.", - "default": "benzinga", + "type": "Literal['fmp', 'intrinio', 'yfinance']", + "description": "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.", + "default": "fmp", "optional": true } ], - "benzinga": [ - { - "name": "analyst_ids", - "type": "Union[str, List[str]]", - "description": "List of analyst IDs to return. Multiple items allowed for provider(s): benzinga.", - "default": null, - "optional": true - }, + "fmp": [ { - "name": "firm_ids", - "type": "Union[str, List[str]]", - "description": "Firm IDs to return. Multiple items allowed for provider(s): benzinga.", + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", "default": null, "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "Number of results returned. Limit 1000.", - "default": 100, - "optional": true - }, + } + ], + "intrinio": [ { - "name": "page", + "name": "industry_group_number", "type": "int", - "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date.", - "default": 0, + "description": "The Zacks industry group number.", + "default": null, "optional": true - }, + } + ], + "yfinance": [ { - "name": "fields", - "type": "Union[str, List[str]]", - "description": "Fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple items allowed for provider(s): benzinga.", + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", "default": null, "optional": true } @@ -5795,12 +6680,12 @@ "OBBject": [ { "name": "results", - "type": "List[AnalystSearch]", + "type": "List[PriceTargetConsensus]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['benzinga']]", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", "description": "Provider name." }, { @@ -5823,165 +6708,436 @@ "data": { "standard": [ { - "name": "last_updated", - "type": "datetime", - "description": "Date of the last update.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "The company name", "default": null, "optional": true }, { - "name": "firm_name", - "type": "str", - "description": "Firm name of the analyst.", + "name": "target_high", + "type": "float", + "description": "High target of the price target consensus.", "default": null, "optional": true }, { - "name": "name_first", - "type": "str", - "description": "Analyst first name.", + "name": "target_low", + "type": "float", + "description": "Low target of the price target consensus.", "default": null, "optional": true }, { - "name": "name_last", - "type": "str", - "description": "Analyst last name.", + "name": "target_consensus", + "type": "float", + "description": "Consensus target of the price target consensus.", "default": null, "optional": true }, { - "name": "name_full", - "type": "str", - "description": "Analyst full name.", - "default": "", - "optional": false + "name": "target_median", + "type": "float", + "description": "Median target of the price target consensus.", + "default": null, + "optional": true } ], - "benzinga": [ + "fmp": [ { - "name": "analyst_id", + "name": "symbol", "type": "str", - "description": "ID of the analyst.", - "default": null, - "optional": true + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "firm_id", + "name": "name", "type": "str", - "description": "ID of the analyst firm.", + "description": "The company name", "default": null, "optional": true }, { - "name": "smart_score", + "name": "target_high", "type": "float", - "description": "A weighted average of the total_ratings_percentile, overall_avg_return_percentile, and overall_success_rate", + "description": "High target of the price target consensus.", "default": null, "optional": true }, { - "name": "overall_success_rate", + "name": "target_low", "type": "float", - "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain overall.", + "description": "Low target of the price target consensus.", "default": null, "optional": true }, { - "name": "overall_avg_return_percentile", + "name": "target_consensus", "type": "float", - "description": "The percentile (normalized) of this analyst's overall average return per rating in comparison to other analysts' overall average returns per rating.", + "description": "Consensus target of the price target consensus.", "default": null, "optional": true }, { - "name": "total_ratings_percentile", + "name": "target_median", "type": "float", - "description": "The percentile (normalized) of this analyst's total number of ratings in comparison to the total number of ratings published by all other analysts", + "description": "Median target of the price target consensus.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "total_ratings", - "type": "int", - "description": "Number of recommendations made by this analyst.", + "name": "standard_deviation", + "type": "float", + "description": "The standard deviation of target price estimates.", "default": null, "optional": true }, { - "name": "overall_gain_count", + "name": "total_anaylsts", "type": "int", - "description": "The number of ratings that have gained value since the date of recommendation", + "description": "The total number of target price estimates in consensus.", "default": null, "optional": true }, { - "name": "overall_loss_count", + "name": "raised", "type": "int", - "description": "The number of ratings that have lost value since the date of recommendation", + "description": "The number of analysts that have raised their target price estimates.", "default": null, "optional": true }, { - "name": "overall_average_return", - "type": "float", - "description": "The average percent (normalized) price difference per rating since the date of recommendation", + "name": "lowered", + "type": "int", + "description": "The number of analysts that have lowered their target price estimates.", "default": null, "optional": true }, { - "name": "overall_std_dev", - "type": "float", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings since the date of recommendation", + "name": "most_recent_date", + "type": "date", + "description": "The date of the most recent estimate.", "default": null, "optional": true }, { - "name": "gain_count_1m", + "name": "industry_group_number", "type": "int", - "description": "The number of ratings that have gained value over the last month", + "description": "The Zacks industry group number.", "default": null, "optional": true - }, + } + ], + "yfinance": [ { - "name": "loss_count_1m", - "type": "int", - "description": "The number of ratings that have lost value over the last month", + "name": "recommendation", + "type": "str", + "description": "Recommendation - buy, sell, etc.", "default": null, "optional": true }, { - "name": "average_return_1m", + "name": "recommendation_mean", "type": "float", - "description": "The average percent (normalized) price difference per rating over the last month", + "description": "Mean recommendation score where 1 is strong buy and 5 is strong sell.", "default": null, "optional": true }, { - "name": "std_dev_1m", - "type": "float", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last month", + "name": "number_of_analysts", + "type": "int", + "description": "Number of analysts providing opinions.", "default": null, "optional": true }, { - "name": "smart_score_1m", + "name": "current_price", "type": "float", - "description": "A weighted average smart score over the last month.", + "description": "Current price of the stock.", "default": null, "optional": true }, { - "name": "success_rate_1m", - "type": "float", - "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last month", + "name": "currency", + "type": "str", + "description": "Currency the stock is priced in.", "default": null, "optional": true - }, + } + ] + }, + "model": "PriceTargetConsensus" + }, + "/equity/estimates/analyst_search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search for specific analysts and get their forecast track record.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.analyst_search(provider='benzinga')\nobb.equity.estimates.analyst_search(firm_name='Wedbush', provider='benzinga')\n```\n\n", + "parameters": { + "standard": [ { - "name": "gain_count_3m", - "type": "int", - "description": "The number of ratings that have gained value over the last 3 months", + "name": "analyst_name", + "type": "str", + "description": "Analyst names to return. Omitting will return all available analysts.", + "default": null, + "optional": true + }, + { + "name": "firm_name", + "type": "str", + "description": "Firm names to return. Omitting will return all available firms.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['benzinga']", + "description": "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.", + "default": "benzinga", + "optional": true + } + ], + "benzinga": [ + { + "name": "analyst_ids", + "type": "str", + "description": "List of analyst IDs to return.", + "default": null, + "optional": true + }, + { + "name": "firm_ids", + "type": "str", + "description": "Firm IDs to return.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "Number of results returned. Limit 1000.", + "default": 100, + "optional": true + }, + { + "name": "page", + "type": "int", + "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date.", + "default": 0, + "optional": true + }, + { + "name": "fields", + "type": "str", + "description": "Fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[AnalystSearch]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['benzinga']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "last_updated", + "type": "datetime", + "description": "Date of the last update.", + "default": null, + "optional": true + }, + { + "name": "firm_name", + "type": "str", + "description": "Firm name of the analyst.", + "default": null, + "optional": true + }, + { + "name": "name_first", + "type": "str", + "description": "Analyst first name.", + "default": null, + "optional": true + }, + { + "name": "name_last", + "type": "str", + "description": "Analyst last name.", + "default": null, + "optional": true + }, + { + "name": "name_full", + "type": "str", + "description": "Analyst full name.", + "default": "", + "optional": false + } + ], + "benzinga": [ + { + "name": "analyst_id", + "type": "str", + "description": "ID of the analyst.", + "default": null, + "optional": true + }, + { + "name": "firm_id", + "type": "str", + "description": "ID of the analyst firm.", + "default": null, + "optional": true + }, + { + "name": "smart_score", + "type": "float", + "description": "A weighted average of the total_ratings_percentile, overall_avg_return_percentile, and overall_success_rate", + "default": null, + "optional": true + }, + { + "name": "overall_success_rate", + "type": "float", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain overall.", + "default": null, + "optional": true + }, + { + "name": "overall_avg_return_percentile", + "type": "float", + "description": "The percentile (normalized) of this analyst's overall average return per rating in comparison to other analysts' overall average returns per rating.", + "default": null, + "optional": true + }, + { + "name": "total_ratings_percentile", + "type": "float", + "description": "The percentile (normalized) of this analyst's total number of ratings in comparison to the total number of ratings published by all other analysts", + "default": null, + "optional": true + }, + { + "name": "total_ratings", + "type": "int", + "description": "Number of recommendations made by this analyst.", + "default": null, + "optional": true + }, + { + "name": "overall_gain_count", + "type": "int", + "description": "The number of ratings that have gained value since the date of recommendation", + "default": null, + "optional": true + }, + { + "name": "overall_loss_count", + "type": "int", + "description": "The number of ratings that have lost value since the date of recommendation", + "default": null, + "optional": true + }, + { + "name": "overall_average_return", + "type": "float", + "description": "The average percent (normalized) price difference per rating since the date of recommendation", + "default": null, + "optional": true + }, + { + "name": "overall_std_dev", + "type": "float", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings since the date of recommendation", + "default": null, + "optional": true + }, + { + "name": "gain_count_1m", + "type": "int", + "description": "The number of ratings that have gained value over the last month", + "default": null, + "optional": true + }, + { + "name": "loss_count_1m", + "type": "int", + "description": "The number of ratings that have lost value over the last month", + "default": null, + "optional": true + }, + { + "name": "average_return_1m", + "type": "float", + "description": "The average percent (normalized) price difference per rating over the last month", + "default": null, + "optional": true + }, + { + "name": "std_dev_1m", + "type": "float", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last month", + "default": null, + "optional": true + }, + { + "name": "smart_score_1m", + "type": "float", + "description": "A weighted average smart score over the last month.", + "default": null, + "optional": true + }, + { + "name": "success_rate_1m", + "type": "float", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last month", + "default": null, + "optional": true + }, + { + "name": "gain_count_3m", + "type": "int", + "description": "The number of ratings that have gained value over the last 3 months", "default": null, "optional": true }, @@ -6231,8 +7387,8 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", + "type": "str", + "description": "Symbol to get data for.", "default": null, "optional": true }, @@ -6477,8 +7633,8 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", + "type": "str", + "description": "Symbol to get data for.", "default": null, "optional": true }, @@ -6667,15 +7823,107 @@ "optional": true } ], - "fmp": [], - "intrinio": [ + "fmp": [ { - "name": "revisions_change_percent", - "type": "float", - "description": "The earnings per share (EPS) percent change in estimate for the period.", - "default": null, - "optional": true - }, + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": null, + "optional": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "fiscal_year", + "type": "int", + "description": "Fiscal year for the estimate.", + "default": null, + "optional": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "Fiscal quarter for the estimate.", + "default": null, + "optional": true + }, + { + "name": "calendar_year", + "type": "int", + "description": "Calendar year for the estimate.", + "default": null, + "optional": true + }, + { + "name": "calendar_period", + "type": "str", + "description": "Calendar quarter for the estimate.", + "default": null, + "optional": true + }, + { + "name": "low_estimate", + "type": "float", + "description": "Estimated EPS low for the period.", + "default": null, + "optional": true + }, + { + "name": "high_estimate", + "type": "float", + "description": "Estimated EPS high for the period.", + "default": null, + "optional": true + }, + { + "name": "mean", + "type": "float", + "description": "Estimated EPS mean for the period.", + "default": null, + "optional": true + }, + { + "name": "median", + "type": "float", + "description": "Estimated EPS median for the period.", + "default": null, + "optional": true + }, + { + "name": "standard_deviation", + "type": "float", + "description": "Estimated EPS standard deviation for the period.", + "default": null, + "optional": true + }, + { + "name": "number_of_analysts", + "type": "int", + "description": "Number of analysts providing estimates for the period.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "revisions_change_percent", + "type": "float", + "description": "The earnings per share (EPS) percent change in estimate for the period.", + "default": null, + "optional": true + }, { "name": "mean_1w", "type": "float", @@ -6732,7 +7980,15 @@ "optional": true } ], - "yfinance": [] + "yfinance": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true + } + ] }, "returns": { "OBBject": [ @@ -6858,7 +8114,15 @@ "optional": true } ], - "yfinance": [] + "yfinance": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true + } + ] }, "returns": { "OBBject": [ @@ -6984,7 +8248,15 @@ "optional": true } ], - "yfinance": [] + "yfinance": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true + } + ] }, "returns": { "OBBject": [ @@ -7110,7 +8382,15 @@ "optional": true } ], - "yfinance": [] + "yfinance": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true + } + ] }, "returns": { "OBBject": [ @@ -7236,7 +8516,15 @@ "optional": true } ], - "yfinance": [] + "yfinance": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true + } + ] }, "returns": { "OBBject": [ @@ -7362,7 +8650,15 @@ "optional": true } ], - "yfinance": [] + "yfinance": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true + } + ] }, "returns": { "OBBject": [ @@ -7488,7 +8784,15 @@ "optional": true } ], - "yfinance": [] + "yfinance": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true + } + ] }, "returns": { "OBBject": [ @@ -7719,7 +9023,50 @@ "optional": false } ], - "fmp": [] + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "", + "optional": false + }, + { + "name": "title", + "type": "str", + "description": "Title of the filing.", + "default": "", + "optional": false + }, + { + "name": "date", + "type": "datetime", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "form_type", + "type": "str", + "description": "The form type of the filing", + "default": "", + "optional": false + }, + { + "name": "link", + "type": "str", + "description": "URL to the filing page on the SEC site.", + "default": "", + "optional": false + } + ] }, "model": "DiscoveryFilings" }, @@ -7734,8 +9081,8 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "type": "str", + "description": "Symbol to get data for.", "default": "", "optional": false }, @@ -7747,7 +9094,15 @@ "optional": true } ], - "fmp": [] + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + } + ] }, "returns": { "OBBject": [ @@ -8208,815 +9563,788 @@ "optional": true } ], - "fmp": [] - }, - "model": "EquityValuationMultiples" - }, - "/equity/fundamental/balance": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the balance sheet for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.balance(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.balance(symbol='AAPL', period='annual', limit=5, provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ + "fmp": [ { "name": "symbol", "type": "str", - "description": "Symbol to get data for.", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "period", - "type": "str", - "description": "Time period of the data to return.", - "default": "annual", + "name": "revenue_per_share_ttm", + "type": "float", + "description": "Revenue per share calculated as trailing twelve months.", + "default": null, "optional": true }, { - "name": "limit", - "type": "Annotated[int, Ge(ge=0)]", - "description": "The number of data entries to return.", - "default": 5, - "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", - "description": "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.", - "default": "fmp", - "optional": true - } - ], - "fmp": [], - "intrinio": [ - { - "name": "fiscal_year", - "type": "int", - "description": "The specific fiscal year. Reports do not go beyond 2008.", + "name": "net_income_per_share_ttm", + "type": "float", + "description": "Net income per share calculated as trailing twelve months.", "default": null, "optional": true - } - ], - "polygon": [ + }, { - "name": "filing_date", - "type": "date", - "description": "Filing date of the financial statement.", + "name": "operating_cash_flow_per_share_ttm", + "type": "float", + "description": "Operating cash flow per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "filing_date_lt", - "type": "date", - "description": "Filing date less than the given date.", + "name": "free_cash_flow_per_share_ttm", + "type": "float", + "description": "Free cash flow per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "filing_date_lte", - "type": "date", - "description": "Filing date less than or equal to the given date.", + "name": "cash_per_share_ttm", + "type": "float", + "description": "Cash per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "filing_date_gt", - "type": "date", - "description": "Filing date greater than the given date.", + "name": "book_value_per_share_ttm", + "type": "float", + "description": "Book value per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "filing_date_gte", - "type": "date", - "description": "Filing date greater than or equal to the given date.", + "name": "tangible_book_value_per_share_ttm", + "type": "float", + "description": "Tangible book value per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "period_of_report_date", - "type": "date", - "description": "Period of report date of the financial statement.", + "name": "shareholders_equity_per_share_ttm", + "type": "float", + "description": "Shareholders equity per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "period_of_report_date_lt", - "type": "date", - "description": "Period of report date less than the given date.", + "name": "interest_debt_per_share_ttm", + "type": "float", + "description": "Interest debt per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "period_of_report_date_lte", - "type": "date", - "description": "Period of report date less than or equal to the given date.", + "name": "market_cap_ttm", + "type": "float", + "description": "Market capitalization calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "period_of_report_date_gt", - "type": "date", - "description": "Period of report date greater than the given date.", + "name": "enterprise_value_ttm", + "type": "float", + "description": "Enterprise value calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "period_of_report_date_gte", - "type": "date", - "description": "Period of report date greater than or equal to the given date.", + "name": "pe_ratio_ttm", + "type": "float", + "description": "Price-to-earnings ratio (P/E ratio) calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "include_sources", - "type": "bool", - "description": "Whether to include the sources of the financial statement.", - "default": true, + "name": "price_to_sales_ratio_ttm", + "type": "float", + "description": "Price-to-sales ratio calculated as trailing twelve months.", + "default": null, "optional": true }, { - "name": "order", - "type": "Literal['asc', 'desc']", - "description": "Order of the financial statement.", + "name": "pocf_ratio_ttm", + "type": "float", + "description": "Price-to-operating cash flow ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "sort", - "type": "Literal['filing_date', 'period_of_report_date']", - "description": "Sort of the financial statement.", + "name": "pfcf_ratio_ttm", + "type": "float", + "description": "Price-to-free cash flow ratio calculated as trailing twelve months.", "default": null, "optional": true - } - ], - "yfinance": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[BalanceSheet]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "period_ending", - "type": "date", - "description": "The end date of the reporting period.", - "default": "", - "optional": false }, { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the report.", + "name": "pb_ratio_ttm", + "type": "float", + "description": "Price-to-book ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the fiscal period.", + "name": "ptb_ratio_ttm", + "type": "float", + "description": "Price-to-tangible book ratio calculated as trailing twelve months.", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "filing_date", - "type": "date", - "description": "The date when the filing was made.", + "name": "ev_to_sales_ttm", + "type": "float", + "description": "Enterprise value-to-sales ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "accepted_date", - "type": "datetime", - "description": "The date and time when the filing was accepted.", + "name": "enterprise_value_over_ebitda_ttm", + "type": "float", + "description": "Enterprise value-to-EBITDA ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "reported_currency", - "type": "str", - "description": "The currency in which the balance sheet was reported.", + "name": "ev_to_operating_cash_flow_ttm", + "type": "float", + "description": "Enterprise value-to-operating cash flow ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "cash_and_cash_equivalents", + "name": "ev_to_free_cash_flow_ttm", "type": "float", - "description": "Cash and cash equivalents.", + "description": "Enterprise value-to-free cash flow ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "short_term_investments", + "name": "earnings_yield_ttm", "type": "float", - "description": "Short term investments.", + "description": "Earnings yield calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "cash_and_short_term_investments", + "name": "free_cash_flow_yield_ttm", "type": "float", - "description": "Cash and short term investments.", + "description": "Free cash flow yield calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "net_receivables", + "name": "debt_to_equity_ttm", "type": "float", - "description": "Net receivables.", + "description": "Debt-to-equity ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "inventory", + "name": "debt_to_assets_ttm", "type": "float", - "description": "Inventory.", + "description": "Debt-to-assets ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "other_current_assets", + "name": "net_debt_to_ebitda_ttm", "type": "float", - "description": "Other current assets.", + "description": "Net debt-to-EBITDA ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "total_current_assets", + "name": "current_ratio_ttm", "type": "float", - "description": "Total current assets.", + "description": "Current ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "plant_property_equipment_net", + "name": "interest_coverage_ttm", "type": "float", - "description": "Plant property equipment net.", + "description": "Interest coverage calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "goodwill", + "name": "income_quality_ttm", "type": "float", - "description": "Goodwill.", + "description": "Income quality calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "intangible_assets", + "name": "dividend_yield_ttm", "type": "float", - "description": "Intangible assets.", + "description": "Dividend yield calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "goodwill_and_intangible_assets", + "name": "dividend_yield_percentage_ttm", "type": "float", - "description": "Goodwill and intangible assets.", + "description": "Dividend yield percentage calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "long_term_investments", + "name": "dividend_to_market_cap_ttm", "type": "float", - "description": "Long term investments.", + "description": "Dividend to market capitalization ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "tax_assets", + "name": "dividend_per_share_ttm", "type": "float", - "description": "Tax assets.", + "description": "Dividend per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "other_non_current_assets", + "name": "payout_ratio_ttm", "type": "float", - "description": "Other non current assets.", + "description": "Payout ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "non_current_assets", + "name": "sales_general_and_administrative_to_revenue_ttm", "type": "float", - "description": "Total non current assets.", + "description": "Sales general and administrative expenses-to-revenue ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "other_assets", + "name": "research_and_development_to_revenue_ttm", "type": "float", - "description": "Other assets.", + "description": "Research and development expenses-to-revenue ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "total_assets", + "name": "intangibles_to_total_assets_ttm", "type": "float", - "description": "Total assets.", + "description": "Intangibles-to-total assets ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "accounts_payable", + "name": "capex_to_operating_cash_flow_ttm", "type": "float", - "description": "Accounts payable.", + "description": "Capital expenditures-to-operating cash flow ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "short_term_debt", + "name": "capex_to_revenue_ttm", "type": "float", - "description": "Short term debt.", + "description": "Capital expenditures-to-revenue ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "tax_payables", + "name": "capex_to_depreciation_ttm", "type": "float", - "description": "Tax payables.", + "description": "Capital expenditures-to-depreciation ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "current_deferred_revenue", + "name": "stock_based_compensation_to_revenue_ttm", "type": "float", - "description": "Current deferred revenue.", + "description": "Stock-based compensation-to-revenue ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "other_current_liabilities", + "name": "graham_number_ttm", "type": "float", - "description": "Other current liabilities.", + "description": "Graham number calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "total_current_liabilities", + "name": "roic_ttm", "type": "float", - "description": "Total current liabilities.", + "description": "Return on invested capital calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "long_term_debt", + "name": "return_on_tangible_assets_ttm", "type": "float", - "description": "Long term debt.", + "description": "Return on tangible assets calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "deferred_revenue_non_current", + "name": "graham_net_net_ttm", "type": "float", - "description": "Non current deferred revenue.", + "description": "Graham net-net working capital calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "deferred_tax_liabilities_non_current", + "name": "working_capital_ttm", "type": "float", - "description": "Deferred tax liabilities non current.", + "description": "Working capital calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "other_non_current_liabilities", + "name": "tangible_asset_value_ttm", "type": "float", - "description": "Other non current liabilities.", + "description": "Tangible asset value calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "total_non_current_liabilities", + "name": "net_current_asset_value_ttm", "type": "float", - "description": "Total non current liabilities.", + "description": "Net current asset value calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "other_liabilities", + "name": "invested_capital_ttm", "type": "float", - "description": "Other liabilities.", + "description": "Invested capital calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "capital_lease_obligations", + "name": "average_receivables_ttm", "type": "float", - "description": "Capital lease obligations.", + "description": "Average receivables calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "total_liabilities", + "name": "average_payables_ttm", "type": "float", - "description": "Total liabilities.", + "description": "Average payables calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "preferred_stock", + "name": "average_inventory_ttm", "type": "float", - "description": "Preferred stock.", + "description": "Average inventory calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "common_stock", + "name": "days_sales_outstanding_ttm", "type": "float", - "description": "Common stock.", + "description": "Days sales outstanding calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "retained_earnings", + "name": "days_payables_outstanding_ttm", "type": "float", - "description": "Retained earnings.", + "description": "Days payables outstanding calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "accumulated_other_comprehensive_income", + "name": "days_of_inventory_on_hand_ttm", "type": "float", - "description": "Accumulated other comprehensive income (loss).", + "description": "Days of inventory on hand calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "other_shareholders_equity", + "name": "receivables_turnover_ttm", "type": "float", - "description": "Other shareholders equity.", + "description": "Receivables turnover calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "other_total_shareholders_equity", + "name": "payables_turnover_ttm", "type": "float", - "description": "Other total shareholders equity.", + "description": "Payables turnover calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "total_common_equity", + "name": "inventory_turnover_ttm", "type": "float", - "description": "Total common equity.", + "description": "Inventory turnover calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "total_equity_non_controlling_interests", + "name": "roe_ttm", "type": "float", - "description": "Total equity non controlling interests.", + "description": "Return on equity calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "total_liabilities_and_shareholders_equity", + "name": "capex_per_share_ttm", "type": "float", - "description": "Total liabilities and shareholders equity.", + "description": "Capital expenditures per share calculated as trailing twelve months.", "default": null, "optional": true - }, + } + ] + }, + "model": "EquityValuationMultiples" + }, + "/equity/fundamental/balance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the balance sheet for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.balance(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.balance(symbol='AAPL', period='annual', limit=5, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ { - "name": "minority_interest", - "type": "float", - "description": "Minority interest.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "total_liabilities_and_total_equity", - "type": "float", - "description": "Total liabilities and total equity.", - "default": null, + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", "optional": true }, { - "name": "total_investments", - "type": "float", - "description": "Total investments.", - "default": null, + "name": "limit", + "type": "Annotated[int, Ge(ge=0)]", + "description": "The number of data entries to return.", + "default": 5, "optional": true }, { - "name": "total_debt", - "type": "float", - "description": "Total debt.", - "default": null, + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", + "description": "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.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "net_debt", - "type": "float", - "description": "Net debt.", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", "optional": true - }, + } + ], + "intrinio": [ { - "name": "link", - "type": "str", - "description": "Link to the filing.", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", "optional": true }, { - "name": "final_link", - "type": "str", - "description": "Link to the filing document.", + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", "default": null, "optional": true } ], - "intrinio": [ + "polygon": [ { - "name": "reported_currency", - "type": "str", - "description": "The currency in which the balance sheet is reported.", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm']", + "description": "None", + "default": "annual", "optional": true }, { - "name": "cash_and_cash_equivalents", - "type": "float", - "description": "Cash and cash equivalents.", + "name": "filing_date", + "type": "date", + "description": "Filing date of the financial statement.", "default": null, "optional": true }, { - "name": "cash_and_due_from_banks", - "type": "float", - "description": "Cash and due from banks.", + "name": "filing_date_lt", + "type": "date", + "description": "Filing date less than the given date.", "default": null, "optional": true }, { - "name": "restricted_cash", - "type": "float", - "description": "Restricted cash.", + "name": "filing_date_lte", + "type": "date", + "description": "Filing date less than or equal to the given date.", "default": null, "optional": true }, { - "name": "short_term_investments", - "type": "float", - "description": "Short term investments.", + "name": "filing_date_gt", + "type": "date", + "description": "Filing date greater than the given date.", "default": null, "optional": true }, { - "name": "federal_funds_sold", - "type": "float", - "description": "Federal funds sold.", + "name": "filing_date_gte", + "type": "date", + "description": "Filing date greater than or equal to the given date.", "default": null, "optional": true }, { - "name": "accounts_receivable", - "type": "float", - "description": "Accounts receivable.", + "name": "period_of_report_date", + "type": "date", + "description": "Period of report date of the financial statement.", "default": null, "optional": true }, { - "name": "note_and_lease_receivable", - "type": "float", - "description": "Note and lease receivable. (Vendor non-trade receivables)", + "name": "period_of_report_date_lt", + "type": "date", + "description": "Period of report date less than the given date.", "default": null, "optional": true }, { - "name": "inventories", - "type": "float", - "description": "Net Inventories.", + "name": "period_of_report_date_lte", + "type": "date", + "description": "Period of report date less than or equal to the given date.", "default": null, "optional": true }, { - "name": "customer_and_other_receivables", - "type": "float", - "description": "Customer and other receivables.", + "name": "period_of_report_date_gt", + "type": "date", + "description": "Period of report date greater than the given date.", "default": null, "optional": true }, { - "name": "interest_bearing_deposits_at_other_banks", - "type": "float", - "description": "Interest bearing deposits at other banks.", + "name": "period_of_report_date_gte", + "type": "date", + "description": "Period of report date greater than or equal to the given date.", "default": null, "optional": true }, { - "name": "time_deposits_placed_and_other_short_term_investments", - "type": "float", - "description": "Time deposits placed and other short term investments.", - "default": null, + "name": "include_sources", + "type": "bool", + "description": "Whether to include the sources of the financial statement.", + "default": true, "optional": true }, { - "name": "trading_account_securities", - "type": "float", - "description": "Trading account securities.", + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order of the financial statement.", "default": null, "optional": true }, { - "name": "loans_and_leases", - "type": "float", - "description": "Loans and leases.", + "name": "sort", + "type": "Literal['filing_date', 'period_of_report_date']", + "description": "Sort of the financial statement.", "default": null, "optional": true - }, + } + ], + "yfinance": [ { - "name": "allowance_for_loan_and_lease_losses", - "type": "float", - "description": "Allowance for loan and lease losses.", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[BalanceSheet]", + "description": "Serializable results." }, { - "name": "current_deferred_refundable_income_taxes", - "type": "float", - "description": "Current deferred refundable income taxes.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", + "description": "Provider name." }, { - "name": "other_current_assets", - "type": "float", - "description": "Other current assets.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "loans_and_leases_net_of_allowance", - "type": "float", - "description": "Loans and leases net of allowance.", + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", "default": null, "optional": true }, { - "name": "accrued_investment_income", - "type": "float", - "description": "Accrued investment income.", + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "other_current_non_operating_assets", - "type": "float", - "description": "Other current non-operating assets.", + "name": "filing_date", + "type": "date", + "description": "The date when the filing was made.", "default": null, "optional": true }, { - "name": "loans_held_for_sale", - "type": "float", - "description": "Loans held for sale.", + "name": "accepted_date", + "type": "datetime", + "description": "The date and time when the filing was accepted.", "default": null, "optional": true }, { - "name": "prepaid_expenses", - "type": "float", - "description": "Prepaid expenses.", + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet was reported.", "default": null, "optional": true }, { - "name": "total_current_assets", + "name": "cash_and_cash_equivalents", "type": "float", - "description": "Total current assets.", + "description": "Cash and cash equivalents.", "default": null, "optional": true }, { - "name": "plant_property_equipment_gross", + "name": "short_term_investments", "type": "float", - "description": "Plant property equipment gross.", + "description": "Short term investments.", "default": null, "optional": true }, { - "name": "accumulated_depreciation", + "name": "cash_and_short_term_investments", "type": "float", - "description": "Accumulated depreciation.", + "description": "Cash and short term investments.", "default": null, "optional": true }, { - "name": "premises_and_equipment_net", + "name": "net_receivables", "type": "float", - "description": "Net premises and equipment.", + "description": "Net receivables.", "default": null, "optional": true }, { - "name": "plant_property_equipment_net", + "name": "inventory", "type": "float", - "description": "Net plant property equipment.", + "description": "Inventory.", "default": null, "optional": true }, { - "name": "long_term_investments", + "name": "other_current_assets", "type": "float", - "description": "Long term investments.", + "description": "Other current assets.", "default": null, "optional": true }, { - "name": "mortgage_servicing_rights", + "name": "total_current_assets", "type": "float", - "description": "Mortgage servicing rights.", + "description": "Total current assets.", "default": null, "optional": true }, { - "name": "unearned_premiums_asset", + "name": "plant_property_equipment_net", "type": "float", - "description": "Unearned premiums asset.", + "description": "Plant property equipment net.", "default": null, "optional": true }, { - "name": "non_current_note_lease_receivables", + "name": "goodwill", "type": "float", - "description": "Non-current note lease receivables.", + "description": "Goodwill.", "default": null, "optional": true }, { - "name": "deferred_acquisition_cost", + "name": "intangible_assets", "type": "float", - "description": "Deferred acquisition cost.", + "description": "Intangible assets.", "default": null, "optional": true }, { - "name": "goodwill", + "name": "goodwill_and_intangible_assets", "type": "float", - "description": "Goodwill.", + "description": "Goodwill and intangible assets.", "default": null, "optional": true }, { - "name": "separate_account_business_assets", + "name": "long_term_investments", "type": "float", - "description": "Separate account business assets.", + "description": "Long term investments.", "default": null, "optional": true }, { - "name": "non_current_deferred_refundable_income_taxes", + "name": "tax_assets", "type": "float", - "description": "Noncurrent deferred refundable income taxes.", + "description": "Tax assets.", "default": null, "optional": true }, { - "name": "intangible_assets", + "name": "other_non_current_assets", "type": "float", - "description": "Intangible assets.", + "description": "Other non current assets.", "default": null, "optional": true }, { - "name": "employee_benefit_assets", + "name": "non_current_assets", "type": "float", - "description": "Employee benefit assets.", + "description": "Total non current assets.", "default": null, "optional": true }, @@ -9028,1918 +10356,1766 @@ "optional": true }, { - "name": "other_non_current_operating_assets", + "name": "total_assets", "type": "float", - "description": "Other noncurrent operating assets.", + "description": "Total assets.", "default": null, "optional": true }, { - "name": "other_non_current_non_operating_assets", + "name": "accounts_payable", "type": "float", - "description": "Other noncurrent non-operating assets.", + "description": "Accounts payable.", "default": null, "optional": true }, { - "name": "interest_bearing_deposits", + "name": "short_term_debt", "type": "float", - "description": "Interest bearing deposits.", + "description": "Short term debt.", "default": null, "optional": true }, { - "name": "total_non_current_assets", + "name": "tax_payables", "type": "float", - "description": "Total noncurrent assets.", + "description": "Tax payables.", "default": null, "optional": true }, { - "name": "total_assets", + "name": "current_deferred_revenue", "type": "float", - "description": "Total assets.", + "description": "Current deferred revenue.", "default": null, "optional": true }, { - "name": "non_interest_bearing_deposits", + "name": "other_current_liabilities", "type": "float", - "description": "Non interest bearing deposits.", + "description": "Other current liabilities.", "default": null, "optional": true }, { - "name": "federal_funds_purchased_and_securities_sold", + "name": "total_current_liabilities", "type": "float", - "description": "Federal funds purchased and securities sold.", + "description": "Total current liabilities.", "default": null, "optional": true }, { - "name": "bankers_acceptance_outstanding", + "name": "long_term_debt", "type": "float", - "description": "Bankers acceptance outstanding.", + "description": "Long term debt.", "default": null, "optional": true }, { - "name": "short_term_debt", + "name": "deferred_revenue_non_current", "type": "float", - "description": "Short term debt.", + "description": "Non current deferred revenue.", "default": null, "optional": true }, { - "name": "accounts_payable", + "name": "deferred_tax_liabilities_non_current", "type": "float", - "description": "Accounts payable.", + "description": "Deferred tax liabilities non current.", "default": null, "optional": true }, { - "name": "current_deferred_revenue", + "name": "other_non_current_liabilities", "type": "float", - "description": "Current deferred revenue.", + "description": "Other non current liabilities.", "default": null, "optional": true }, { - "name": "current_deferred_payable_income_tax_liabilities", + "name": "total_non_current_liabilities", "type": "float", - "description": "Current deferred payable income tax liabilities.", + "description": "Total non current liabilities.", "default": null, "optional": true }, { - "name": "accrued_interest_payable", + "name": "other_liabilities", "type": "float", - "description": "Accrued interest payable.", + "description": "Other liabilities.", "default": null, "optional": true }, { - "name": "accrued_expenses", + "name": "capital_lease_obligations", "type": "float", - "description": "Accrued expenses.", + "description": "Capital lease obligations.", "default": null, "optional": true }, { - "name": "other_short_term_payables", + "name": "total_liabilities", "type": "float", - "description": "Other short term payables.", + "description": "Total liabilities.", "default": null, "optional": true }, { - "name": "customer_deposits", + "name": "preferred_stock", "type": "float", - "description": "Customer deposits.", + "description": "Preferred stock.", "default": null, "optional": true }, { - "name": "dividends_payable", + "name": "common_stock", "type": "float", - "description": "Dividends payable.", + "description": "Common stock.", "default": null, "optional": true }, { - "name": "claims_and_claim_expense", + "name": "retained_earnings", "type": "float", - "description": "Claims and claim expense.", + "description": "Retained earnings.", "default": null, "optional": true }, { - "name": "future_policy_benefits", + "name": "accumulated_other_comprehensive_income", "type": "float", - "description": "Future policy benefits.", + "description": "Accumulated other comprehensive income (loss).", "default": null, "optional": true }, { - "name": "current_employee_benefit_liabilities", + "name": "other_shareholders_equity", "type": "float", - "description": "Current employee benefit liabilities.", + "description": "Other shareholders equity.", "default": null, "optional": true }, { - "name": "unearned_premiums_liability", + "name": "other_total_shareholders_equity", "type": "float", - "description": "Unearned premiums liability.", + "description": "Other total shareholders equity.", "default": null, "optional": true }, { - "name": "other_taxes_payable", + "name": "total_common_equity", "type": "float", - "description": "Other taxes payable.", + "description": "Total common equity.", "default": null, "optional": true }, { - "name": "policy_holder_funds", + "name": "total_equity_non_controlling_interests", "type": "float", - "description": "Policy holder funds.", + "description": "Total equity non controlling interests.", "default": null, "optional": true }, { - "name": "other_current_liabilities", + "name": "total_liabilities_and_shareholders_equity", "type": "float", - "description": "Other current liabilities.", + "description": "Total liabilities and shareholders equity.", "default": null, "optional": true }, { - "name": "other_current_non_operating_liabilities", + "name": "minority_interest", "type": "float", - "description": "Other current non-operating liabilities.", + "description": "Minority interest.", "default": null, "optional": true }, { - "name": "separate_account_business_liabilities", + "name": "total_liabilities_and_total_equity", "type": "float", - "description": "Separate account business liabilities.", + "description": "Total liabilities and total equity.", "default": null, "optional": true }, { - "name": "total_current_liabilities", + "name": "total_investments", "type": "float", - "description": "Total current liabilities.", + "description": "Total investments.", "default": null, "optional": true }, { - "name": "long_term_debt", + "name": "total_debt", "type": "float", - "description": "Long term debt.", + "description": "Total debt.", "default": null, "optional": true }, { - "name": "other_long_term_liabilities", + "name": "net_debt", "type": "float", - "description": "Other long term liabilities.", + "description": "Net debt.", "default": null, "optional": true }, { - "name": "non_current_deferred_revenue", - "type": "float", - "description": "Non-current deferred revenue.", + "name": "link", + "type": "str", + "description": "Link to the filing.", "default": null, "optional": true }, { - "name": "non_current_deferred_payable_income_tax_liabilities", - "type": "float", - "description": "Non-current deferred payable income tax liabilities.", + "name": "final_link", + "type": "str", + "description": "Link to the filing document.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "non_current_employee_benefit_liabilities", - "type": "float", - "description": "Non-current employee benefit liabilities.", + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet is reported.", "default": null, "optional": true }, { - "name": "other_non_current_operating_liabilities", + "name": "cash_and_cash_equivalents", "type": "float", - "description": "Other non-current operating liabilities.", + "description": "Cash and cash equivalents.", "default": null, "optional": true }, { - "name": "other_non_current_non_operating_liabilities", + "name": "cash_and_due_from_banks", "type": "float", - "description": "Other non-current, non-operating liabilities.", + "description": "Cash and due from banks.", "default": null, "optional": true }, { - "name": "total_non_current_liabilities", + "name": "restricted_cash", "type": "float", - "description": "Total non-current liabilities.", + "description": "Restricted cash.", "default": null, "optional": true }, { - "name": "capital_lease_obligations", + "name": "short_term_investments", "type": "float", - "description": "Capital lease obligations.", + "description": "Short term investments.", "default": null, "optional": true }, { - "name": "asset_retirement_reserve_litigation_obligation", + "name": "federal_funds_sold", "type": "float", - "description": "Asset retirement reserve litigation obligation.", + "description": "Federal funds sold.", "default": null, "optional": true }, { - "name": "total_liabilities", + "name": "accounts_receivable", "type": "float", - "description": "Total liabilities.", + "description": "Accounts receivable.", "default": null, "optional": true }, { - "name": "commitments_contingencies", + "name": "note_and_lease_receivable", "type": "float", - "description": "Commitments contingencies.", + "description": "Note and lease receivable. (Vendor non-trade receivables)", "default": null, "optional": true }, { - "name": "redeemable_non_controlling_interest", + "name": "inventories", "type": "float", - "description": "Redeemable non-controlling interest.", + "description": "Net Inventories.", "default": null, "optional": true }, { - "name": "preferred_stock", + "name": "customer_and_other_receivables", "type": "float", - "description": "Preferred stock.", + "description": "Customer and other receivables.", "default": null, "optional": true }, { - "name": "common_stock", + "name": "interest_bearing_deposits_at_other_banks", "type": "float", - "description": "Common stock.", + "description": "Interest bearing deposits at other banks.", "default": null, "optional": true }, { - "name": "retained_earnings", + "name": "time_deposits_placed_and_other_short_term_investments", "type": "float", - "description": "Retained earnings.", + "description": "Time deposits placed and other short term investments.", "default": null, "optional": true }, { - "name": "treasury_stock", + "name": "trading_account_securities", "type": "float", - "description": "Treasury stock.", + "description": "Trading account securities.", "default": null, "optional": true }, { - "name": "accumulated_other_comprehensive_income", + "name": "loans_and_leases", "type": "float", - "description": "Accumulated other comprehensive income.", + "description": "Loans and leases.", "default": null, "optional": true }, { - "name": "participating_policy_holder_equity", + "name": "allowance_for_loan_and_lease_losses", "type": "float", - "description": "Participating policy holder equity.", + "description": "Allowance for loan and lease losses.", "default": null, "optional": true }, { - "name": "other_equity_adjustments", + "name": "current_deferred_refundable_income_taxes", "type": "float", - "description": "Other equity adjustments.", + "description": "Current deferred refundable income taxes.", "default": null, "optional": true }, { - "name": "total_common_equity", + "name": "other_current_assets", "type": "float", - "description": "Total common equity.", + "description": "Other current assets.", "default": null, "optional": true }, { - "name": "total_preferred_common_equity", + "name": "loans_and_leases_net_of_allowance", "type": "float", - "description": "Total preferred common equity.", + "description": "Loans and leases net of allowance.", "default": null, "optional": true }, { - "name": "non_controlling_interest", + "name": "accrued_investment_income", "type": "float", - "description": "Non-controlling interest.", + "description": "Accrued investment income.", "default": null, "optional": true }, { - "name": "total_equity_non_controlling_interests", + "name": "other_current_non_operating_assets", "type": "float", - "description": "Total equity non-controlling interests.", + "description": "Other current non-operating assets.", "default": null, "optional": true }, { - "name": "total_liabilities_shareholders_equity", + "name": "loans_held_for_sale", "type": "float", - "description": "Total liabilities and shareholders equity.", + "description": "Loans held for sale.", "default": null, "optional": true - } - ], - "polygon": [ + }, { - "name": "accounts_receivable", - "type": "int", - "description": "Accounts receivable", + "name": "prepaid_expenses", + "type": "float", + "description": "Prepaid expenses.", "default": null, "optional": true }, { - "name": "marketable_securities", - "type": "int", - "description": "Marketable securities", + "name": "total_current_assets", + "type": "float", + "description": "Total current assets.", "default": null, "optional": true }, { - "name": "prepaid_expenses", - "type": "int", - "description": "Prepaid expenses", + "name": "plant_property_equipment_gross", + "type": "float", + "description": "Plant property equipment gross.", "default": null, "optional": true }, { - "name": "other_current_assets", - "type": "int", - "description": "Other current assets", + "name": "accumulated_depreciation", + "type": "float", + "description": "Accumulated depreciation.", "default": null, "optional": true }, { - "name": "total_current_assets", - "type": "int", - "description": "Total current assets", + "name": "premises_and_equipment_net", + "type": "float", + "description": "Net premises and equipment.", "default": null, "optional": true }, { - "name": "property_plant_equipment_net", - "type": "int", - "description": "Property plant and equipment net", + "name": "plant_property_equipment_net", + "type": "float", + "description": "Net plant property equipment.", "default": null, "optional": true }, { - "name": "inventory", - "type": "int", - "description": "Inventory", + "name": "long_term_investments", + "type": "float", + "description": "Long term investments.", "default": null, "optional": true }, { - "name": "other_non_current_assets", - "type": "int", - "description": "Other non-current assets", + "name": "mortgage_servicing_rights", + "type": "float", + "description": "Mortgage servicing rights.", "default": null, "optional": true }, { - "name": "total_non_current_assets", - "type": "int", - "description": "Total non-current assets", + "name": "unearned_premiums_asset", + "type": "float", + "description": "Unearned premiums asset.", "default": null, "optional": true }, { - "name": "intangible_assets", - "type": "int", - "description": "Intangible assets", + "name": "non_current_note_lease_receivables", + "type": "float", + "description": "Non-current note lease receivables.", "default": null, "optional": true }, { - "name": "total_assets", - "type": "int", - "description": "Total assets", + "name": "deferred_acquisition_cost", + "type": "float", + "description": "Deferred acquisition cost.", "default": null, "optional": true }, { - "name": "accounts_payable", - "type": "int", - "description": "Accounts payable", + "name": "goodwill", + "type": "float", + "description": "Goodwill.", "default": null, "optional": true }, { - "name": "employee_wages", - "type": "int", - "description": "Employee wages", + "name": "separate_account_business_assets", + "type": "float", + "description": "Separate account business assets.", "default": null, "optional": true }, { - "name": "other_current_liabilities", - "type": "int", - "description": "Other current liabilities", + "name": "non_current_deferred_refundable_income_taxes", + "type": "float", + "description": "Noncurrent deferred refundable income taxes.", "default": null, "optional": true }, { - "name": "total_current_liabilities", - "type": "int", - "description": "Total current liabilities", + "name": "intangible_assets", + "type": "float", + "description": "Intangible assets.", "default": null, "optional": true }, { - "name": "other_non_current_liabilities", - "type": "int", - "description": "Other non-current liabilities", + "name": "employee_benefit_assets", + "type": "float", + "description": "Employee benefit assets.", "default": null, "optional": true }, { - "name": "total_non_current_liabilities", - "type": "int", - "description": "Total non-current liabilities", + "name": "other_assets", + "type": "float", + "description": "Other assets.", "default": null, "optional": true }, { - "name": "long_term_debt", - "type": "int", - "description": "Long term debt", + "name": "other_non_current_operating_assets", + "type": "float", + "description": "Other noncurrent operating assets.", "default": null, "optional": true }, { - "name": "total_liabilities", - "type": "int", - "description": "Total liabilities", + "name": "other_non_current_non_operating_assets", + "type": "float", + "description": "Other noncurrent non-operating assets.", "default": null, "optional": true }, { - "name": "minority_interest", - "type": "int", - "description": "Minority interest", + "name": "interest_bearing_deposits", + "type": "float", + "description": "Interest bearing deposits.", "default": null, "optional": true }, { - "name": "temporary_equity_attributable_to_parent", - "type": "int", - "description": "Temporary equity attributable to parent", + "name": "total_non_current_assets", + "type": "float", + "description": "Total noncurrent assets.", "default": null, "optional": true }, { - "name": "equity_attributable_to_parent", - "type": "int", - "description": "Equity attributable to parent", + "name": "total_assets", + "type": "float", + "description": "Total assets.", "default": null, "optional": true }, { - "name": "temporary_equity", - "type": "int", - "description": "Temporary equity", + "name": "non_interest_bearing_deposits", + "type": "float", + "description": "Non interest bearing deposits.", "default": null, "optional": true }, { - "name": "preferred_stock", - "type": "int", - "description": "Preferred stock", + "name": "federal_funds_purchased_and_securities_sold", + "type": "float", + "description": "Federal funds purchased and securities sold.", "default": null, "optional": true }, { - "name": "redeemable_non_controlling_interest", - "type": "int", - "description": "Redeemable non-controlling interest", + "name": "bankers_acceptance_outstanding", + "type": "float", + "description": "Bankers acceptance outstanding.", "default": null, "optional": true }, { - "name": "redeemable_non_controlling_interest_other", - "type": "int", - "description": "Redeemable non-controlling interest other", + "name": "short_term_debt", + "type": "float", + "description": "Short term debt.", "default": null, "optional": true }, { - "name": "total_stock_holders_equity", - "type": "int", - "description": "Total stock holders equity", + "name": "accounts_payable", + "type": "float", + "description": "Accounts payable.", "default": null, "optional": true }, { - "name": "total_liabilities_and_stock_holders_equity", - "type": "int", - "description": "Total liabilities and stockholders equity", + "name": "current_deferred_revenue", + "type": "float", + "description": "Current deferred revenue.", "default": null, "optional": true }, { - "name": "total_equity", - "type": "int", - "description": "Total equity", + "name": "current_deferred_payable_income_tax_liabilities", + "type": "float", + "description": "Current deferred payable income tax liabilities.", "default": null, "optional": true - } - ], - "yfinance": [] - }, - "model": "BalanceSheet" - }, - "/equity/fundamental/balance_growth": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the growth of a company's balance sheet items over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.balance_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.balance_growth(symbol='AAPL', limit=10, provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 10, + "name": "accrued_interest_payable", + "type": "float", + "description": "Accrued interest payable.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", + "name": "accrued_expenses", + "type": "float", + "description": "Accrued expenses.", + "default": null, "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[BalanceSheetGrowth]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "other_short_term_payables", + "type": "float", + "description": "Other short term payables.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "customer_deposits", + "type": "float", + "description": "Customer deposits.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "dividends_payable", + "type": "float", + "description": "Dividends payable.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "claims_and_claim_expense", + "type": "float", + "description": "Claims and claim expense.", "default": null, "optional": true }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "future_policy_benefits", + "type": "float", + "description": "Future policy benefits.", + "default": null, + "optional": true }, { - "name": "period", - "type": "str", - "description": "Reporting period.", - "default": "", - "optional": false + "name": "current_employee_benefit_liabilities", + "type": "float", + "description": "Current employee benefit liabilities.", + "default": null, + "optional": true }, { - "name": "growth_cash_and_cash_equivalents", + "name": "unearned_premiums_liability", "type": "float", - "description": "Growth rate of cash and cash equivalents.", - "default": "", - "optional": false + "description": "Unearned premiums liability.", + "default": null, + "optional": true }, { - "name": "growth_short_term_investments", + "name": "other_taxes_payable", "type": "float", - "description": "Growth rate of short-term investments.", - "default": "", - "optional": false + "description": "Other taxes payable.", + "default": null, + "optional": true }, { - "name": "growth_cash_and_short_term_investments", + "name": "policy_holder_funds", "type": "float", - "description": "Growth rate of cash and short-term investments.", - "default": "", - "optional": false + "description": "Policy holder funds.", + "default": null, + "optional": true }, { - "name": "growth_net_receivables", + "name": "other_current_liabilities", "type": "float", - "description": "Growth rate of net receivables.", - "default": "", - "optional": false + "description": "Other current liabilities.", + "default": null, + "optional": true }, { - "name": "growth_inventory", + "name": "other_current_non_operating_liabilities", "type": "float", - "description": "Growth rate of inventory.", - "default": "", - "optional": false + "description": "Other current non-operating liabilities.", + "default": null, + "optional": true }, { - "name": "growth_other_current_assets", + "name": "separate_account_business_liabilities", "type": "float", - "description": "Growth rate of other current assets.", - "default": "", - "optional": false + "description": "Separate account business liabilities.", + "default": null, + "optional": true }, { - "name": "growth_total_current_assets", + "name": "total_current_liabilities", "type": "float", - "description": "Growth rate of total current assets.", - "default": "", - "optional": false + "description": "Total current liabilities.", + "default": null, + "optional": true }, { - "name": "growth_property_plant_equipment_net", + "name": "long_term_debt", "type": "float", - "description": "Growth rate of net property, plant, and equipment.", - "default": "", - "optional": false + "description": "Long term debt.", + "default": null, + "optional": true }, { - "name": "growth_goodwill", + "name": "other_long_term_liabilities", "type": "float", - "description": "Growth rate of goodwill.", - "default": "", - "optional": false + "description": "Other long term liabilities.", + "default": null, + "optional": true }, { - "name": "growth_intangible_assets", + "name": "non_current_deferred_revenue", "type": "float", - "description": "Growth rate of intangible assets.", - "default": "", - "optional": false + "description": "Non-current deferred revenue.", + "default": null, + "optional": true }, { - "name": "growth_goodwill_and_intangible_assets", + "name": "non_current_deferred_payable_income_tax_liabilities", "type": "float", - "description": "Growth rate of goodwill and intangible assets.", - "default": "", - "optional": false + "description": "Non-current deferred payable income tax liabilities.", + "default": null, + "optional": true }, { - "name": "growth_long_term_investments", + "name": "non_current_employee_benefit_liabilities", "type": "float", - "description": "Growth rate of long-term investments.", - "default": "", - "optional": false + "description": "Non-current employee benefit liabilities.", + "default": null, + "optional": true }, { - "name": "growth_tax_assets", + "name": "other_non_current_operating_liabilities", "type": "float", - "description": "Growth rate of tax assets.", - "default": "", - "optional": false + "description": "Other non-current operating liabilities.", + "default": null, + "optional": true }, { - "name": "growth_other_non_current_assets", + "name": "other_non_current_non_operating_liabilities", "type": "float", - "description": "Growth rate of other non-current assets.", - "default": "", - "optional": false + "description": "Other non-current, non-operating liabilities.", + "default": null, + "optional": true }, { - "name": "growth_total_non_current_assets", + "name": "total_non_current_liabilities", "type": "float", - "description": "Growth rate of total non-current assets.", - "default": "", - "optional": false + "description": "Total non-current liabilities.", + "default": null, + "optional": true }, { - "name": "growth_other_assets", + "name": "capital_lease_obligations", "type": "float", - "description": "Growth rate of other assets.", - "default": "", - "optional": false - }, - { - "name": "growth_total_assets", - "type": "float", - "description": "Growth rate of total assets.", - "default": "", - "optional": false - }, - { - "name": "growth_account_payables", - "type": "float", - "description": "Growth rate of accounts payable.", - "default": "", - "optional": false - }, - { - "name": "growth_short_term_debt", - "type": "float", - "description": "Growth rate of short-term debt.", - "default": "", - "optional": false - }, - { - "name": "growth_tax_payables", - "type": "float", - "description": "Growth rate of tax payables.", - "default": "", - "optional": false - }, - { - "name": "growth_deferred_revenue", - "type": "float", - "description": "Growth rate of deferred revenue.", - "default": "", - "optional": false - }, - { - "name": "growth_other_current_liabilities", - "type": "float", - "description": "Growth rate of other current liabilities.", - "default": "", - "optional": false - }, - { - "name": "growth_total_current_liabilities", - "type": "float", - "description": "Growth rate of total current liabilities.", - "default": "", - "optional": false + "description": "Capital lease obligations.", + "default": null, + "optional": true }, { - "name": "growth_long_term_debt", + "name": "asset_retirement_reserve_litigation_obligation", "type": "float", - "description": "Growth rate of long-term debt.", - "default": "", - "optional": false + "description": "Asset retirement reserve litigation obligation.", + "default": null, + "optional": true }, { - "name": "growth_deferred_revenue_non_current", + "name": "total_liabilities", "type": "float", - "description": "Growth rate of non-current deferred revenue.", - "default": "", - "optional": false + "description": "Total liabilities.", + "default": null, + "optional": true }, { - "name": "growth_deferrred_tax_liabilities_non_current", + "name": "commitments_contingencies", "type": "float", - "description": "Growth rate of non-current deferred tax liabilities.", - "default": "", - "optional": false + "description": "Commitments contingencies.", + "default": null, + "optional": true }, { - "name": "growth_other_non_current_liabilities", + "name": "redeemable_non_controlling_interest", "type": "float", - "description": "Growth rate of other non-current liabilities.", - "default": "", - "optional": false + "description": "Redeemable non-controlling interest.", + "default": null, + "optional": true }, { - "name": "growth_total_non_current_liabilities", + "name": "preferred_stock", "type": "float", - "description": "Growth rate of total non-current liabilities.", - "default": "", - "optional": false + "description": "Preferred stock.", + "default": null, + "optional": true }, { - "name": "growth_other_liabilities", + "name": "common_stock", "type": "float", - "description": "Growth rate of other liabilities.", - "default": "", - "optional": false + "description": "Common stock.", + "default": null, + "optional": true }, { - "name": "growth_total_liabilities", + "name": "retained_earnings", "type": "float", - "description": "Growth rate of total liabilities.", - "default": "", - "optional": false + "description": "Retained earnings.", + "default": null, + "optional": true }, { - "name": "growth_common_stock", + "name": "treasury_stock", "type": "float", - "description": "Growth rate of common stock.", - "default": "", - "optional": false + "description": "Treasury stock.", + "default": null, + "optional": true }, { - "name": "growth_retained_earnings", + "name": "accumulated_other_comprehensive_income", "type": "float", - "description": "Growth rate of retained earnings.", - "default": "", - "optional": false + "description": "Accumulated other comprehensive income.", + "default": null, + "optional": true }, { - "name": "growth_accumulated_other_comprehensive_income_loss", + "name": "participating_policy_holder_equity", "type": "float", - "description": "Growth rate of accumulated other comprehensive income/loss.", - "default": "", - "optional": false + "description": "Participating policy holder equity.", + "default": null, + "optional": true }, { - "name": "growth_othertotal_stockholders_equity", + "name": "other_equity_adjustments", "type": "float", - "description": "Growth rate of other total stockholders' equity.", - "default": "", - "optional": false + "description": "Other equity adjustments.", + "default": null, + "optional": true }, { - "name": "growth_total_stockholders_equity", + "name": "total_common_equity", "type": "float", - "description": "Growth rate of total stockholders' equity.", - "default": "", - "optional": false + "description": "Total common equity.", + "default": null, + "optional": true }, { - "name": "growth_total_liabilities_and_stockholders_equity", + "name": "total_preferred_common_equity", "type": "float", - "description": "Growth rate of total liabilities and stockholders' equity.", - "default": "", - "optional": false + "description": "Total preferred common equity.", + "default": null, + "optional": true }, { - "name": "growth_total_investments", + "name": "non_controlling_interest", "type": "float", - "description": "Growth rate of total investments.", - "default": "", - "optional": false + "description": "Non-controlling interest.", + "default": null, + "optional": true }, { - "name": "growth_total_debt", + "name": "total_equity_non_controlling_interests", "type": "float", - "description": "Growth rate of total debt.", - "default": "", - "optional": false + "description": "Total equity non-controlling interests.", + "default": null, + "optional": true }, { - "name": "growth_net_debt", + "name": "total_liabilities_shareholders_equity", "type": "float", - "description": "Growth rate of net debt.", - "default": "", - "optional": false + "description": "Total liabilities and shareholders equity.", + "default": null, + "optional": true } ], - "fmp": [] - }, - "model": "BalanceSheetGrowth" - }, - "/equity/fundamental/cash": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the cash flow statement for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.cash(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.cash(symbol='AAPL', period='annual', limit=5, provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, + "polygon": [ { - "name": "period", - "type": "str", - "description": "Time period of the data to return.", - "default": "annual", + "name": "accounts_receivable", + "type": "int", + "description": "Accounts receivable", + "default": null, "optional": true }, { - "name": "limit", - "type": "Annotated[int, Ge(ge=0)]", - "description": "The number of data entries to return.", - "default": 5, + "name": "marketable_securities", + "type": "int", + "description": "Marketable securities", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", - "description": "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.", - "default": "fmp", - "optional": true - } - ], - "fmp": [], - "intrinio": [ - { - "name": "fiscal_year", + "name": "prepaid_expenses", "type": "int", - "description": "The specific fiscal year. Reports do not go beyond 2008.", + "description": "Prepaid expenses", "default": null, "optional": true - } - ], - "polygon": [ + }, { - "name": "filing_date", - "type": "date", - "description": "Filing date of the financial statement.", + "name": "other_current_assets", + "type": "int", + "description": "Other current assets", "default": null, "optional": true }, { - "name": "filing_date_lt", - "type": "date", - "description": "Filing date less than the given date.", + "name": "total_current_assets", + "type": "int", + "description": "Total current assets", "default": null, "optional": true }, { - "name": "filing_date_lte", - "type": "date", - "description": "Filing date less than or equal to the given date.", + "name": "property_plant_equipment_net", + "type": "int", + "description": "Property plant and equipment net", "default": null, "optional": true }, { - "name": "filing_date_gt", - "type": "date", - "description": "Filing date greater than the given date.", + "name": "inventory", + "type": "int", + "description": "Inventory", "default": null, "optional": true }, { - "name": "filing_date_gte", - "type": "date", - "description": "Filing date greater than or equal to the given date.", + "name": "other_non_current_assets", + "type": "int", + "description": "Other non-current assets", "default": null, "optional": true }, { - "name": "period_of_report_date", - "type": "date", - "description": "Period of report date of the financial statement.", + "name": "total_non_current_assets", + "type": "int", + "description": "Total non-current assets", "default": null, "optional": true }, { - "name": "period_of_report_date_lt", - "type": "date", - "description": "Period of report date less than the given date.", + "name": "intangible_assets", + "type": "int", + "description": "Intangible assets", "default": null, "optional": true }, { - "name": "period_of_report_date_lte", - "type": "date", - "description": "Period of report date less than or equal to the given date.", + "name": "total_assets", + "type": "int", + "description": "Total assets", "default": null, "optional": true }, { - "name": "period_of_report_date_gt", - "type": "date", - "description": "Period of report date greater than the given date.", + "name": "accounts_payable", + "type": "int", + "description": "Accounts payable", "default": null, "optional": true }, { - "name": "period_of_report_date_gte", - "type": "date", - "description": "Period of report date greater than or equal to the given date.", + "name": "employee_wages", + "type": "int", + "description": "Employee wages", "default": null, "optional": true }, { - "name": "include_sources", - "type": "bool", - "description": "Whether to include the sources of the financial statement.", - "default": false, - "optional": true - }, - { - "name": "order", - "type": "Literal[None, 'asc', 'desc']", - "description": "Order of the financial statement.", + "name": "other_current_liabilities", + "type": "int", + "description": "Other current liabilities", "default": null, "optional": true }, { - "name": "sort", - "type": "Literal[None, 'filing_date', 'period_of_report_date']", - "description": "Sort of the financial statement.", + "name": "total_current_liabilities", + "type": "int", + "description": "Total current liabilities", "default": null, "optional": true - } - ], - "yfinance": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[CashFlowStatement]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "period_ending", - "type": "date", - "description": "The end date of the reporting period.", - "default": "", - "optional": false }, { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the report.", + "name": "other_non_current_liabilities", + "type": "int", + "description": "Other non-current liabilities", "default": null, "optional": true }, { - "name": "fiscal_year", + "name": "total_non_current_liabilities", "type": "int", - "description": "The fiscal year of the fiscal period.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "filing_date", - "type": "date", - "description": "The date of the filing.", + "description": "Total non-current liabilities", "default": null, "optional": true }, { - "name": "accepted_date", - "type": "datetime", - "description": "The date the filing was accepted.", + "name": "long_term_debt", + "type": "int", + "description": "Long term debt", "default": null, "optional": true }, { - "name": "reported_currency", - "type": "str", - "description": "The currency in which the cash flow statement was reported.", + "name": "total_liabilities", + "type": "int", + "description": "Total liabilities", "default": null, "optional": true }, { - "name": "net_income", - "type": "float", - "description": "Net income.", + "name": "minority_interest", + "type": "int", + "description": "Minority interest", "default": null, "optional": true }, { - "name": "depreciation_and_amortization", - "type": "float", - "description": "Depreciation and amortization.", + "name": "temporary_equity_attributable_to_parent", + "type": "int", + "description": "Temporary equity attributable to parent", "default": null, "optional": true }, { - "name": "deferred_income_tax", - "type": "float", - "description": "Deferred income tax.", + "name": "equity_attributable_to_parent", + "type": "int", + "description": "Equity attributable to parent", "default": null, "optional": true }, { - "name": "stock_based_compensation", - "type": "float", - "description": "Stock-based compensation.", + "name": "temporary_equity", + "type": "int", + "description": "Temporary equity", "default": null, "optional": true }, { - "name": "change_in_working_capital", - "type": "float", - "description": "Change in working capital.", + "name": "preferred_stock", + "type": "int", + "description": "Preferred stock", "default": null, "optional": true }, { - "name": "change_in_account_receivables", - "type": "float", - "description": "Change in account receivables.", + "name": "redeemable_non_controlling_interest", + "type": "int", + "description": "Redeemable non-controlling interest", "default": null, "optional": true }, { - "name": "change_in_inventory", - "type": "float", - "description": "Change in inventory.", + "name": "redeemable_non_controlling_interest_other", + "type": "int", + "description": "Redeemable non-controlling interest other", "default": null, "optional": true }, { - "name": "change_in_account_payable", - "type": "float", - "description": "Change in account payable.", + "name": "total_stock_holders_equity", + "type": "int", + "description": "Total stock holders equity", "default": null, "optional": true }, { - "name": "change_in_other_working_capital", - "type": "float", - "description": "Change in other working capital.", + "name": "total_liabilities_and_stock_holders_equity", + "type": "int", + "description": "Total liabilities and stockholders equity", "default": null, "optional": true }, { - "name": "change_in_other_non_cash_items", - "type": "float", - "description": "Change in other non-cash items.", + "name": "total_equity", + "type": "int", + "description": "Total equity", "default": null, "optional": true - }, + } + ], + "yfinance": [ { - "name": "net_cash_from_operating_activities", - "type": "float", - "description": "Net cash from operating activities.", - "default": null, - "optional": true + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false }, { - "name": "purchase_of_property_plant_and_equipment", - "type": "float", - "description": "Purchase of property, plant and equipment.", + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", "default": null, "optional": true }, { - "name": "acquisitions", - "type": "float", - "description": "Acquisitions.", + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", "default": null, "optional": true - }, + } + ] + }, + "model": "BalanceSheet" + }, + "/equity/fundamental/balance_growth": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the growth of a company's balance sheet items over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.balance_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.balance_growth(symbol='AAPL', limit=10, provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "purchase_of_investment_securities", - "type": "float", - "description": "Purchase of investment securities.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "sale_and_maturity_of_investments", - "type": "float", - "description": "Sale and maturity of investments.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10, "optional": true }, { - "name": "other_investing_activities", - "type": "float", - "description": "Other investing activities.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "net_cash_from_investing_activities", - "type": "float", - "description": "Net cash from investing activities.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[BalanceSheetGrowth]", + "description": "Serializable results." }, { - "name": "repayment_of_debt", - "type": "float", - "description": "Repayment of debt.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "issuance_of_common_equity", - "type": "float", - "description": "Issuance of common equity.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "repurchase_of_common_equity", - "type": "float", - "description": "Repurchase of common equity.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "payment_of_dividends", - "type": "float", - "description": "Payment of dividends.", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "other_financing_activities", - "type": "float", - "description": "Other financing activities.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "net_cash_from_financing_activities", - "type": "float", - "description": "Net cash from financing activities.", - "default": null, - "optional": true + "name": "period", + "type": "str", + "description": "Reporting period.", + "default": "", + "optional": false }, { - "name": "effect_of_exchange_rate_changes_on_cash", + "name": "growth_cash_and_cash_equivalents", "type": "float", - "description": "Effect of exchange rate changes on cash.", - "default": null, - "optional": true + "description": "Growth rate of cash and cash equivalents.", + "default": "", + "optional": false }, { - "name": "net_change_in_cash_and_equivalents", + "name": "growth_short_term_investments", "type": "float", - "description": "Net change in cash and equivalents.", - "default": null, - "optional": true + "description": "Growth rate of short-term investments.", + "default": "", + "optional": false }, { - "name": "cash_at_beginning_of_period", + "name": "growth_cash_and_short_term_investments", "type": "float", - "description": "Cash at beginning of period.", - "default": null, - "optional": true + "description": "Growth rate of cash and short-term investments.", + "default": "", + "optional": false }, { - "name": "cash_at_end_of_period", + "name": "growth_net_receivables", "type": "float", - "description": "Cash at end of period.", - "default": null, - "optional": true + "description": "Growth rate of net receivables.", + "default": "", + "optional": false }, { - "name": "operating_cash_flow", + "name": "growth_inventory", "type": "float", - "description": "Operating cash flow.", - "default": null, - "optional": true + "description": "Growth rate of inventory.", + "default": "", + "optional": false }, { - "name": "capital_expenditure", + "name": "growth_other_current_assets", "type": "float", - "description": "Capital expenditure.", - "default": null, - "optional": true + "description": "Growth rate of other current assets.", + "default": "", + "optional": false }, { - "name": "free_cash_flow", + "name": "growth_total_current_assets", "type": "float", - "description": "None", - "default": null, - "optional": true + "description": "Growth rate of total current assets.", + "default": "", + "optional": false }, { - "name": "link", - "type": "str", - "description": "Link to the filing.", - "default": null, - "optional": true + "name": "growth_property_plant_equipment_net", + "type": "float", + "description": "Growth rate of net property, plant, and equipment.", + "default": "", + "optional": false }, { - "name": "final_link", - "type": "str", - "description": "Link to the filing document.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "reported_currency", - "type": "str", - "description": "The currency in which the balance sheet is reported.", - "default": null, - "optional": true + "name": "growth_goodwill", + "type": "float", + "description": "Growth rate of goodwill.", + "default": "", + "optional": false }, { - "name": "net_income_continuing_operations", + "name": "growth_intangible_assets", "type": "float", - "description": "Net Income (Continuing Operations)", - "default": null, - "optional": true + "description": "Growth rate of intangible assets.", + "default": "", + "optional": false }, { - "name": "net_income_discontinued_operations", + "name": "growth_goodwill_and_intangible_assets", "type": "float", - "description": "Net Income (Discontinued Operations)", - "default": null, - "optional": true + "description": "Growth rate of goodwill and intangible assets.", + "default": "", + "optional": false }, { - "name": "net_income", + "name": "growth_long_term_investments", "type": "float", - "description": "Consolidated Net Income.", - "default": null, - "optional": true + "description": "Growth rate of long-term investments.", + "default": "", + "optional": false }, { - "name": "provision_for_loan_losses", + "name": "growth_tax_assets", "type": "float", - "description": "Provision for Loan Losses", - "default": null, - "optional": true + "description": "Growth rate of tax assets.", + "default": "", + "optional": false }, { - "name": "provision_for_credit_losses", + "name": "growth_other_non_current_assets", "type": "float", - "description": "Provision for credit losses", - "default": null, - "optional": true + "description": "Growth rate of other non-current assets.", + "default": "", + "optional": false }, { - "name": "depreciation_expense", + "name": "growth_total_non_current_assets", "type": "float", - "description": "Depreciation Expense.", - "default": null, - "optional": true + "description": "Growth rate of total non-current assets.", + "default": "", + "optional": false }, { - "name": "amortization_expense", + "name": "growth_other_assets", "type": "float", - "description": "Amortization Expense.", - "default": null, - "optional": true + "description": "Growth rate of other assets.", + "default": "", + "optional": false }, { - "name": "share_based_compensation", + "name": "growth_total_assets", "type": "float", - "description": "Share-based compensation.", - "default": null, - "optional": true + "description": "Growth rate of total assets.", + "default": "", + "optional": false }, { - "name": "non_cash_adjustments_to_reconcile_net_income", + "name": "growth_account_payables", "type": "float", - "description": "Non-Cash Adjustments to Reconcile Net Income.", - "default": null, - "optional": true + "description": "Growth rate of accounts payable.", + "default": "", + "optional": false }, { - "name": "changes_in_operating_assets_and_liabilities", + "name": "growth_short_term_debt", "type": "float", - "description": "Changes in Operating Assets and Liabilities (Net)", - "default": null, - "optional": true + "description": "Growth rate of short-term debt.", + "default": "", + "optional": false }, { - "name": "net_cash_from_continuing_operating_activities", + "name": "growth_tax_payables", "type": "float", - "description": "Net Cash from Continuing Operating Activities", - "default": null, - "optional": true + "description": "Growth rate of tax payables.", + "default": "", + "optional": false }, { - "name": "net_cash_from_discontinued_operating_activities", + "name": "growth_deferred_revenue", "type": "float", - "description": "Net Cash from Discontinued Operating Activities", - "default": null, - "optional": true + "description": "Growth rate of deferred revenue.", + "default": "", + "optional": false }, { - "name": "net_cash_from_operating_activities", + "name": "growth_other_current_liabilities", "type": "float", - "description": "Net Cash from Operating Activities", - "default": null, - "optional": true + "description": "Growth rate of other current liabilities.", + "default": "", + "optional": false }, { - "name": "divestitures", + "name": "growth_total_current_liabilities", "type": "float", - "description": "Divestitures", - "default": null, - "optional": true + "description": "Growth rate of total current liabilities.", + "default": "", + "optional": false }, { - "name": "sale_of_property_plant_and_equipment", + "name": "growth_long_term_debt", "type": "float", - "description": "Sale of Property, Plant, and Equipment", - "default": null, - "optional": true + "description": "Growth rate of long-term debt.", + "default": "", + "optional": false }, { - "name": "acquisitions", + "name": "growth_deferred_revenue_non_current", "type": "float", - "description": "Acquisitions", - "default": null, - "optional": true + "description": "Growth rate of non-current deferred revenue.", + "default": "", + "optional": false }, { - "name": "purchase_of_investments", + "name": "growth_deferrred_tax_liabilities_non_current", "type": "float", - "description": "Purchase of Investments", - "default": null, - "optional": true + "description": "Growth rate of non-current deferred tax liabilities.", + "default": "", + "optional": false }, { - "name": "purchase_of_investment_securities", + "name": "growth_other_non_current_liabilities", "type": "float", - "description": "Purchase of Investment Securities", - "default": null, - "optional": true + "description": "Growth rate of other non-current liabilities.", + "default": "", + "optional": false }, { - "name": "sale_and_maturity_of_investments", + "name": "growth_total_non_current_liabilities", "type": "float", - "description": "Sale and Maturity of Investments", - "default": null, - "optional": true + "description": "Growth rate of total non-current liabilities.", + "default": "", + "optional": false }, { - "name": "loans_held_for_sale", + "name": "growth_other_liabilities", "type": "float", - "description": "Loans Held for Sale (Net)", - "default": null, - "optional": true + "description": "Growth rate of other liabilities.", + "default": "", + "optional": false }, { - "name": "purchase_of_property_plant_and_equipment", + "name": "growth_total_liabilities", "type": "float", - "description": "Purchase of Property, Plant, and Equipment", - "default": null, - "optional": true + "description": "Growth rate of total liabilities.", + "default": "", + "optional": false }, { - "name": "other_investing_activities", + "name": "growth_common_stock", "type": "float", - "description": "Other Investing Activities (Net)", - "default": null, - "optional": true + "description": "Growth rate of common stock.", + "default": "", + "optional": false }, { - "name": "net_cash_from_continuing_investing_activities", + "name": "growth_retained_earnings", "type": "float", - "description": "Net Cash from Continuing Investing Activities", - "default": null, - "optional": true + "description": "Growth rate of retained earnings.", + "default": "", + "optional": false }, { - "name": "net_cash_from_discontinued_investing_activities", + "name": "growth_accumulated_other_comprehensive_income_loss", "type": "float", - "description": "Net Cash from Discontinued Investing Activities", - "default": null, - "optional": true + "description": "Growth rate of accumulated other comprehensive income/loss.", + "default": "", + "optional": false }, { - "name": "net_cash_from_investing_activities", + "name": "growth_othertotal_stockholders_equity", "type": "float", - "description": "Net Cash from Investing Activities", - "default": null, - "optional": true + "description": "Growth rate of other total stockholders' equity.", + "default": "", + "optional": false }, { - "name": "payment_of_dividends", + "name": "growth_total_stockholders_equity", "type": "float", - "description": "Payment of Dividends", - "default": null, - "optional": true + "description": "Growth rate of total stockholders' equity.", + "default": "", + "optional": false }, { - "name": "repurchase_of_common_equity", + "name": "growth_total_liabilities_and_stockholders_equity", "type": "float", - "description": "Repurchase of Common Equity", - "default": null, - "optional": true + "description": "Growth rate of total liabilities and stockholders' equity.", + "default": "", + "optional": false }, { - "name": "repurchase_of_preferred_equity", + "name": "growth_total_investments", "type": "float", - "description": "Repurchase of Preferred Equity", - "default": null, - "optional": true + "description": "Growth rate of total investments.", + "default": "", + "optional": false }, { - "name": "issuance_of_common_equity", + "name": "growth_total_debt", "type": "float", - "description": "Issuance of Common Equity", - "default": null, - "optional": true + "description": "Growth rate of total debt.", + "default": "", + "optional": false }, { - "name": "issuance_of_preferred_equity", + "name": "growth_net_debt", "type": "float", - "description": "Issuance of Preferred Equity", + "description": "Growth rate of net debt.", + "default": "", + "optional": false + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "issuance_of_debt", - "type": "float", - "description": "Issuance of Debt", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "repayment_of_debt", - "type": "float", - "description": "Repayment of Debt", - "default": null, - "optional": true + "name": "period", + "type": "str", + "description": "Reporting period.", + "default": "", + "optional": false }, { - "name": "other_financing_activities", + "name": "growth_cash_and_cash_equivalents", "type": "float", - "description": "Other Financing Activities (Net)", - "default": null, - "optional": true + "description": "Growth rate of cash and cash equivalents.", + "default": "", + "optional": false }, { - "name": "cash_interest_received", + "name": "growth_short_term_investments", "type": "float", - "description": "Cash Interest Received", - "default": null, - "optional": true + "description": "Growth rate of short-term investments.", + "default": "", + "optional": false }, { - "name": "net_change_in_deposits", + "name": "growth_cash_and_short_term_investments", "type": "float", - "description": "Net Change in Deposits", - "default": null, - "optional": true + "description": "Growth rate of cash and short-term investments.", + "default": "", + "optional": false }, { - "name": "net_increase_in_fed_funds_sold", + "name": "growth_net_receivables", "type": "float", - "description": "Net Increase in Fed Funds Sold", - "default": null, - "optional": true + "description": "Growth rate of net receivables.", + "default": "", + "optional": false }, { - "name": "net_cash_from_continuing_financing_activities", + "name": "growth_inventory", "type": "float", - "description": "Net Cash from Continuing Financing Activities", - "default": null, - "optional": true + "description": "Growth rate of inventory.", + "default": "", + "optional": false }, { - "name": "net_cash_from_discontinued_financing_activities", + "name": "growth_other_current_assets", "type": "float", - "description": "Net Cash from Discontinued Financing Activities", - "default": null, - "optional": true + "description": "Growth rate of other current assets.", + "default": "", + "optional": false }, { - "name": "net_cash_from_financing_activities", + "name": "growth_total_current_assets", "type": "float", - "description": "Net Cash from Financing Activities", - "default": null, - "optional": true + "description": "Growth rate of total current assets.", + "default": "", + "optional": false }, { - "name": "effect_of_exchange_rate_changes", + "name": "growth_property_plant_equipment_net", "type": "float", - "description": "Effect of Exchange Rate Changes", - "default": null, - "optional": true + "description": "Growth rate of net property, plant, and equipment.", + "default": "", + "optional": false }, { - "name": "other_net_changes_in_cash", + "name": "growth_goodwill", "type": "float", - "description": "Other Net Changes in Cash", - "default": null, - "optional": true + "description": "Growth rate of goodwill.", + "default": "", + "optional": false }, { - "name": "net_change_in_cash_and_equivalents", + "name": "growth_intangible_assets", "type": "float", - "description": "Net Change in Cash and Equivalents", - "default": null, - "optional": true + "description": "Growth rate of intangible assets.", + "default": "", + "optional": false }, { - "name": "cash_income_taxes_paid", + "name": "growth_goodwill_and_intangible_assets", "type": "float", - "description": "Cash Income Taxes Paid", - "default": null, - "optional": true + "description": "Growth rate of goodwill and intangible assets.", + "default": "", + "optional": false }, { - "name": "cash_interest_paid", + "name": "growth_long_term_investments", "type": "float", - "description": "Cash Interest Paid", - "default": null, - "optional": true - } - ], - "polygon": [ - { - "name": "net_cash_flow_from_operating_activities_continuing", - "type": "int", - "description": "Net cash flow from operating activities continuing.", - "default": null, - "optional": true + "description": "Growth rate of long-term investments.", + "default": "", + "optional": false }, { - "name": "net_cash_flow_from_operating_activities_discontinued", - "type": "int", - "description": "Net cash flow from operating activities discontinued.", - "default": null, - "optional": true + "name": "growth_tax_assets", + "type": "float", + "description": "Growth rate of tax assets.", + "default": "", + "optional": false }, { - "name": "net_cash_flow_from_operating_activities", - "type": "int", - "description": "Net cash flow from operating activities.", - "default": null, - "optional": true + "name": "growth_other_non_current_assets", + "type": "float", + "description": "Growth rate of other non-current assets.", + "default": "", + "optional": false }, { - "name": "net_cash_flow_from_investing_activities_continuing", - "type": "int", - "description": "Net cash flow from investing activities continuing.", - "default": null, - "optional": true + "name": "growth_total_non_current_assets", + "type": "float", + "description": "Growth rate of total non-current assets.", + "default": "", + "optional": false }, { - "name": "net_cash_flow_from_investing_activities_discontinued", - "type": "int", - "description": "Net cash flow from investing activities discontinued.", - "default": null, - "optional": true + "name": "growth_other_assets", + "type": "float", + "description": "Growth rate of other assets.", + "default": "", + "optional": false }, { - "name": "net_cash_flow_from_investing_activities", - "type": "int", - "description": "Net cash flow from investing activities.", - "default": null, - "optional": true + "name": "growth_total_assets", + "type": "float", + "description": "Growth rate of total assets.", + "default": "", + "optional": false }, { - "name": "net_cash_flow_from_financing_activities_continuing", - "type": "int", - "description": "Net cash flow from financing activities continuing.", - "default": null, - "optional": true + "name": "growth_account_payables", + "type": "float", + "description": "Growth rate of accounts payable.", + "default": "", + "optional": false }, { - "name": "net_cash_flow_from_financing_activities_discontinued", - "type": "int", - "description": "Net cash flow from financing activities discontinued.", - "default": null, - "optional": true + "name": "growth_short_term_debt", + "type": "float", + "description": "Growth rate of short-term debt.", + "default": "", + "optional": false }, { - "name": "net_cash_flow_from_financing_activities", - "type": "int", - "description": "Net cash flow from financing activities.", - "default": null, - "optional": true + "name": "growth_tax_payables", + "type": "float", + "description": "Growth rate of tax payables.", + "default": "", + "optional": false }, { - "name": "net_cash_flow_continuing", - "type": "int", - "description": "Net cash flow continuing.", - "default": null, - "optional": true + "name": "growth_deferred_revenue", + "type": "float", + "description": "Growth rate of deferred revenue.", + "default": "", + "optional": false }, { - "name": "net_cash_flow_discontinued", - "type": "int", - "description": "Net cash flow discontinued.", - "default": null, - "optional": true + "name": "growth_other_current_liabilities", + "type": "float", + "description": "Growth rate of other current liabilities.", + "default": "", + "optional": false }, { - "name": "exchange_gains_losses", - "type": "int", - "description": "Exchange gains losses.", - "default": null, - "optional": true + "name": "growth_total_current_liabilities", + "type": "float", + "description": "Growth rate of total current liabilities.", + "default": "", + "optional": false }, { - "name": "net_cash_flow", - "type": "int", - "description": "Net cash flow.", - "default": null, - "optional": true - } - ], - "yfinance": [] - }, - "model": "CashFlowStatement" - }, - "/equity/fundamental/reported_financials": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get financial statements as reported by the company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.reported_financials(symbol='AAPL', provider='intrinio')\n# Get AAPL balance sheet with a limit of 10 items.\nobb.equity.fundamental.reported_financials(symbol='AAPL', period='annual', statement_type='balance', limit=10, provider='intrinio')\n# Get reported income statement\nobb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='income', provider='intrinio')\n# Get reported cash flow statement\nobb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='cash', provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "name": "growth_long_term_debt", + "type": "float", + "description": "Growth rate of long-term debt.", "default": "", "optional": false }, { - "name": "period", - "type": "str", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true + "name": "growth_deferred_revenue_non_current", + "type": "float", + "description": "Growth rate of non-current deferred revenue.", + "default": "", + "optional": false }, { - "name": "statement_type", - "type": "str", - "description": "The type of financial statement - i.e, balance, income, cash.", - "default": "balance", - "optional": true + "name": "growth_deferrred_tax_liabilities_non_current", + "type": "float", + "description": "Growth rate of non-current deferred tax liabilities.", + "default": "", + "optional": false }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. Although the response object contains multiple results, because of the variance in the fields, year-to-year and quarter-to-quarter, it is recommended to view results in small chunks.", - "default": 100, - "optional": true + "name": "growth_other_non_current_liabilities", + "type": "float", + "description": "Growth rate of other non-current liabilities.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Literal['intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", - "optional": true - } - ], - "intrinio": [ - { - "name": "fiscal_year", - "type": "int", - "description": "The specific fiscal year. Reports do not go beyond 2008.", - "default": null, - "optional": true - } - ] - }, - "returns": { - "OBBject": [ + "name": "growth_total_non_current_liabilities", + "type": "float", + "description": "Growth rate of total non-current liabilities.", + "default": "", + "optional": false + }, { - "name": "results", - "type": "List[ReportedFinancials]", - "description": "Serializable results." + "name": "growth_other_liabilities", + "type": "float", + "description": "Growth rate of other liabilities.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Optional[Literal['intrinio']]", - "description": "Provider name." + "name": "growth_total_liabilities", + "type": "float", + "description": "Growth rate of total liabilities.", + "default": "", + "optional": false }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "growth_common_stock", + "type": "float", + "description": "Growth rate of common stock.", + "default": "", + "optional": false }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "growth_retained_earnings", + "type": "float", + "description": "Growth rate of retained earnings.", + "default": "", + "optional": false }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "growth_accumulated_other_comprehensive_income_loss", + "type": "float", + "description": "Growth rate of accumulated other comprehensive income/loss.", + "default": "", + "optional": false + }, { - "name": "period_ending", - "type": "date", - "description": "The ending date of the reporting period.", + "name": "growth_othertotal_stockholders_equity", + "type": "float", + "description": "Growth rate of other total stockholders' equity.", "default": "", "optional": false }, { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the report (e.g. FY, Q1, etc.).", + "name": "growth_total_stockholders_equity", + "type": "float", + "description": "Growth rate of total stockholders' equity.", "default": "", "optional": false }, { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the fiscal period.", - "default": null, - "optional": true + "name": "growth_total_liabilities_and_stockholders_equity", + "type": "float", + "description": "Growth rate of total liabilities and stockholders' equity.", + "default": "", + "optional": false + }, + { + "name": "growth_total_investments", + "type": "float", + "description": "Growth rate of total investments.", + "default": "", + "optional": false + }, + { + "name": "growth_total_debt", + "type": "float", + "description": "Growth rate of total debt.", + "default": "", + "optional": false + }, + { + "name": "growth_net_debt", + "type": "float", + "description": "Growth rate of net debt.", + "default": "", + "optional": false } - ], - "intrinio": [] + ] }, - "model": "ReportedFinancials" + "model": "BalanceSheetGrowth" }, - "/equity/fundamental/cash_growth": { + "/equity/fundamental/cash": { "deprecated": { "flag": null, "message": null }, - "description": "Get the growth of a company's cash flow statement items over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.cash_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.cash_growth(symbol='AAPL', limit=10, provider='fmp')\n```\n\n", + "description": "Get the cash flow statement for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.cash(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.cash(symbol='AAPL', period='annual', limit=5, provider='intrinio')\n```\n\n", "parameters": { "standard": [ { @@ -10949,33 +12125,173 @@ "default": "", "optional": false }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, { "name": "limit", - "type": "int", + "type": "Annotated[int, Ge(ge=0)]", "description": "The number of data entries to return.", - "default": 10, + "default": 5, "optional": true }, { "name": "provider", - "type": "Literal['fmp']", + "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", "description": "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.", "default": "fmp", "optional": true } ], - "fmp": [] + "fmp": [ + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true + } + ], + "intrinio": [ + { + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", + "description": "None", + "default": "annual", + "optional": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true + }, + { + "name": "filing_date", + "type": "date", + "description": "Filing date of the financial statement.", + "default": null, + "optional": true + }, + { + "name": "filing_date_lt", + "type": "date", + "description": "Filing date less than the given date.", + "default": null, + "optional": true + }, + { + "name": "filing_date_lte", + "type": "date", + "description": "Filing date less than or equal to the given date.", + "default": null, + "optional": true + }, + { + "name": "filing_date_gt", + "type": "date", + "description": "Filing date greater than the given date.", + "default": null, + "optional": true + }, + { + "name": "filing_date_gte", + "type": "date", + "description": "Filing date greater than or equal to the given date.", + "default": null, + "optional": true + }, + { + "name": "period_of_report_date", + "type": "date", + "description": "Period of report date of the financial statement.", + "default": null, + "optional": true + }, + { + "name": "period_of_report_date_lt", + "type": "date", + "description": "Period of report date less than the given date.", + "default": null, + "optional": true + }, + { + "name": "period_of_report_date_lte", + "type": "date", + "description": "Period of report date less than or equal to the given date.", + "default": null, + "optional": true + }, + { + "name": "period_of_report_date_gt", + "type": "date", + "description": "Period of report date greater than the given date.", + "default": null, + "optional": true + }, + { + "name": "period_of_report_date_gte", + "type": "date", + "description": "Period of report date greater than or equal to the given date.", + "default": null, + "optional": true + }, + { + "name": "include_sources", + "type": "bool", + "description": "Whether to include the sources of the financial statement.", + "default": false, + "optional": true + }, + { + "name": "order", + "type": "Literal[None, 'asc', 'desc']", + "description": "Order of the financial statement.", + "default": null, + "optional": true + }, + { + "name": "sort", + "type": "Literal[None, 'filing_date', 'period_of_report_date']", + "description": "Sort of the financial statement.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true + } + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[CashFlowStatementGrowth]", + "type": "List[CashFlowStatement]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", "description": "Provider name." }, { @@ -10998,835 +12314,753 @@ "data": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": null, - "optional": true - }, - { - "name": "date", + "name": "period_ending", "type": "date", - "description": "The date of the data.", + "description": "The end date of the reporting period.", "default": "", "optional": false }, { - "name": "period", + "name": "fiscal_period", "type": "str", - "description": "Period the statement is returned for.", - "default": "", - "optional": false + "description": "The fiscal period of the report.", + "default": null, + "optional": true }, { - "name": "growth_net_income", - "type": "float", - "description": "Growth rate of net income.", - "default": "", - "optional": false + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true }, { - "name": "growth_depreciation_and_amortization", + "name": "filing_date", + "type": "date", + "description": "The date of the filing.", + "default": null, + "optional": true + }, + { + "name": "accepted_date", + "type": "datetime", + "description": "The date the filing was accepted.", + "default": null, + "optional": true + }, + { + "name": "reported_currency", + "type": "str", + "description": "The currency in which the cash flow statement was reported.", + "default": null, + "optional": true + }, + { + "name": "net_income", "type": "float", - "description": "Growth rate of depreciation and amortization.", - "default": "", - "optional": false + "description": "Net income.", + "default": null, + "optional": true }, { - "name": "growth_deferred_income_tax", + "name": "depreciation_and_amortization", "type": "float", - "description": "Growth rate of deferred income tax.", - "default": "", - "optional": false + "description": "Depreciation and amortization.", + "default": null, + "optional": true }, { - "name": "growth_stock_based_compensation", + "name": "deferred_income_tax", "type": "float", - "description": "Growth rate of stock-based compensation.", - "default": "", - "optional": false + "description": "Deferred income tax.", + "default": null, + "optional": true }, { - "name": "growth_change_in_working_capital", + "name": "stock_based_compensation", "type": "float", - "description": "Growth rate of change in working capital.", - "default": "", - "optional": false + "description": "Stock-based compensation.", + "default": null, + "optional": true }, { - "name": "growth_accounts_receivables", + "name": "change_in_working_capital", "type": "float", - "description": "Growth rate of accounts receivables.", - "default": "", - "optional": false + "description": "Change in working capital.", + "default": null, + "optional": true }, { - "name": "growth_inventory", + "name": "change_in_account_receivables", "type": "float", - "description": "Growth rate of inventory.", - "default": "", - "optional": false + "description": "Change in account receivables.", + "default": null, + "optional": true }, { - "name": "growth_accounts_payables", + "name": "change_in_inventory", "type": "float", - "description": "Growth rate of accounts payables.", - "default": "", - "optional": false + "description": "Change in inventory.", + "default": null, + "optional": true }, { - "name": "growth_other_working_capital", + "name": "change_in_account_payable", "type": "float", - "description": "Growth rate of other working capital.", - "default": "", - "optional": false + "description": "Change in account payable.", + "default": null, + "optional": true }, { - "name": "growth_other_non_cash_items", + "name": "change_in_other_working_capital", "type": "float", - "description": "Growth rate of other non-cash items.", - "default": "", - "optional": false + "description": "Change in other working capital.", + "default": null, + "optional": true }, { - "name": "growth_net_cash_provided_by_operating_activities", + "name": "change_in_other_non_cash_items", "type": "float", - "description": "Growth rate of net cash provided by operating activities.", - "default": "", - "optional": false + "description": "Change in other non-cash items.", + "default": null, + "optional": true }, { - "name": "growth_investments_in_property_plant_and_equipment", + "name": "net_cash_from_operating_activities", "type": "float", - "description": "Growth rate of investments in property, plant, and equipment.", - "default": "", - "optional": false + "description": "Net cash from operating activities.", + "default": null, + "optional": true }, { - "name": "growth_acquisitions_net", + "name": "purchase_of_property_plant_and_equipment", "type": "float", - "description": "Growth rate of net acquisitions.", - "default": "", - "optional": false + "description": "Purchase of property, plant and equipment.", + "default": null, + "optional": true }, { - "name": "growth_purchases_of_investments", + "name": "acquisitions", "type": "float", - "description": "Growth rate of purchases of investments.", - "default": "", - "optional": false + "description": "Acquisitions.", + "default": null, + "optional": true }, { - "name": "growth_sales_maturities_of_investments", + "name": "purchase_of_investment_securities", "type": "float", - "description": "Growth rate of sales maturities of investments.", - "default": "", - "optional": false + "description": "Purchase of investment securities.", + "default": null, + "optional": true }, { - "name": "growth_other_investing_activities", + "name": "sale_and_maturity_of_investments", "type": "float", - "description": "Growth rate of other investing activities.", - "default": "", - "optional": false + "description": "Sale and maturity of investments.", + "default": null, + "optional": true }, { - "name": "growth_net_cash_used_for_investing_activities", + "name": "other_investing_activities", "type": "float", - "description": "Growth rate of net cash used for investing activities.", - "default": "", - "optional": false + "description": "Other investing activities.", + "default": null, + "optional": true }, { - "name": "growth_debt_repayment", + "name": "net_cash_from_investing_activities", "type": "float", - "description": "Growth rate of debt repayment.", - "default": "", - "optional": false + "description": "Net cash from investing activities.", + "default": null, + "optional": true }, { - "name": "growth_common_stock_issued", + "name": "repayment_of_debt", "type": "float", - "description": "Growth rate of common stock issued.", - "default": "", - "optional": false + "description": "Repayment of debt.", + "default": null, + "optional": true }, { - "name": "growth_common_stock_repurchased", + "name": "issuance_of_common_equity", "type": "float", - "description": "Growth rate of common stock repurchased.", - "default": "", - "optional": false + "description": "Issuance of common equity.", + "default": null, + "optional": true }, { - "name": "growth_dividends_paid", + "name": "repurchase_of_common_equity", "type": "float", - "description": "Growth rate of dividends paid.", - "default": "", - "optional": false + "description": "Repurchase of common equity.", + "default": null, + "optional": true }, { - "name": "growth_other_financing_activities", + "name": "payment_of_dividends", "type": "float", - "description": "Growth rate of other financing activities.", - "default": "", - "optional": false + "description": "Payment of dividends.", + "default": null, + "optional": true }, { - "name": "growth_net_cash_used_provided_by_financing_activities", + "name": "other_financing_activities", "type": "float", - "description": "Growth rate of net cash used/provided by financing activities.", - "default": "", - "optional": false + "description": "Other financing activities.", + "default": null, + "optional": true }, { - "name": "growth_effect_of_forex_changes_on_cash", + "name": "net_cash_from_financing_activities", "type": "float", - "description": "Growth rate of the effect of foreign exchange changes on cash.", - "default": "", - "optional": false + "description": "Net cash from financing activities.", + "default": null, + "optional": true }, { - "name": "growth_net_change_in_cash", + "name": "effect_of_exchange_rate_changes_on_cash", "type": "float", - "description": "Growth rate of net change in cash.", - "default": "", - "optional": false + "description": "Effect of exchange rate changes on cash.", + "default": null, + "optional": true }, { - "name": "growth_cash_at_end_of_period", + "name": "net_change_in_cash_and_equivalents", "type": "float", - "description": "Growth rate of cash at the end of the period.", - "default": "", - "optional": false + "description": "Net change in cash and equivalents.", + "default": null, + "optional": true }, { - "name": "growth_cash_at_beginning_of_period", + "name": "cash_at_beginning_of_period", "type": "float", - "description": "Growth rate of cash at the beginning of the period.", - "default": "", - "optional": false + "description": "Cash at beginning of period.", + "default": null, + "optional": true }, { - "name": "growth_operating_cash_flow", + "name": "cash_at_end_of_period", "type": "float", - "description": "Growth rate of operating cash flow.", - "default": "", - "optional": false + "description": "Cash at end of period.", + "default": null, + "optional": true }, { - "name": "growth_capital_expenditure", + "name": "operating_cash_flow", "type": "float", - "description": "Growth rate of capital expenditure.", - "default": "", - "optional": false + "description": "Operating cash flow.", + "default": null, + "optional": true }, { - "name": "growth_free_cash_flow", + "name": "capital_expenditure", "type": "float", - "description": "Growth rate of free cash flow.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "CashFlowStatementGrowth" - }, - "/equity/fundamental/dividends": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get historical dividend data for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.dividends(symbol='AAPL', provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false + "description": "Capital expenditure.", + "default": null, + "optional": true }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "free_cash_flow", + "type": "float", + "description": "None", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "link", + "type": "str", + "description": "Link to the filing.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'yfinance']", - "description": "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.", - "default": "fmp", + "name": "final_link", + "type": "str", + "description": "Link to the filing document.", + "default": null, "optional": true } ], - "fmp": [], "intrinio": [ { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 100, + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet is reported.", + "default": null, "optional": true - } - ], - "yfinance": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[HistoricalDividends]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "ex_dividend_date", - "type": "date", - "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", - "default": "", - "optional": false }, { - "name": "amount", + "name": "net_income_continuing_operations", "type": "float", - "description": "The dividend amount per share.", - "default": "", - "optional": false - } - ], - "fmp": [ - { - "name": "label", - "type": "str", - "description": "Label of the historical dividends.", - "default": "", - "optional": false + "description": "Net Income (Continuing Operations)", + "default": null, + "optional": true }, { - "name": "adj_dividend", + "name": "net_income_discontinued_operations", "type": "float", - "description": "Adjusted dividend of the historical dividends.", - "default": "", - "optional": false - }, - { - "name": "record_date", - "type": "date", - "description": "Record date of the historical dividends.", + "description": "Net Income (Discontinued Operations)", "default": null, "optional": true }, { - "name": "payment_date", - "type": "date", - "description": "Payment date of the historical dividends.", + "name": "net_income", + "type": "float", + "description": "Consolidated Net Income.", "default": null, "optional": true }, { - "name": "declaration_date", - "type": "date", - "description": "Declaration date of the historical dividends.", + "name": "provision_for_loan_losses", + "type": "float", + "description": "Provision for Loan Losses", "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "factor", + "name": "provision_for_credit_losses", "type": "float", - "description": "factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.", + "description": "Provision for credit losses", "default": null, "optional": true }, { - "name": "currency", - "type": "str", - "description": "The currency in which the dividend is paid.", + "name": "depreciation_expense", + "type": "float", + "description": "Depreciation Expense.", "default": null, "optional": true }, { - "name": "split_ratio", + "name": "amortization_expense", "type": "float", - "description": "The ratio of the stock split, if a stock split occurred.", + "description": "Amortization Expense.", "default": null, "optional": true - } - ], - "yfinance": [] - }, - "model": "HistoricalDividends" - }, - "/equity/fundamental/historical_eps": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get historical earnings per share data for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_eps(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", + "name": "share_based_compensation", + "type": "float", + "description": "Share-based compensation.", "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[HistoricalEps]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "non_cash_adjustments_to_reconcile_net_income", + "type": "float", + "description": "Non-Cash Adjustments to Reconcile Net Income.", "default": null, "optional": true }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "announce_time", - "type": "str", - "description": "Timing of the earnings announcement.", + "name": "changes_in_operating_assets_and_liabilities", + "type": "float", + "description": "Changes in Operating Assets and Liabilities (Net)", "default": null, "optional": true }, { - "name": "eps_actual", + "name": "net_cash_from_continuing_operating_activities", "type": "float", - "description": "Actual EPS from the earnings date.", + "description": "Net Cash from Continuing Operating Activities", "default": null, "optional": true }, { - "name": "eps_estimated", + "name": "net_cash_from_discontinued_operating_activities", "type": "float", - "description": "Estimated EPS for the earnings date.", + "description": "Net Cash from Discontinued Operating Activities", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "revenue_estimated", + "name": "net_cash_from_operating_activities", "type": "float", - "description": "Estimated consensus revenue for the reporting period.", + "description": "Net Cash from Operating Activities", "default": null, "optional": true }, { - "name": "revenue_actual", + "name": "divestitures", "type": "float", - "description": "The actual reported revenue.", + "description": "Divestitures", "default": null, "optional": true }, { - "name": "reporting_time", - "type": "str", - "description": "The reporting time - e.g. after market close.", + "name": "sale_of_property_plant_and_equipment", + "type": "float", + "description": "Sale of Property, Plant, and Equipment", "default": null, "optional": true }, { - "name": "updated_at", - "type": "date", - "description": "The date when the data was last updated.", + "name": "acquisitions", + "type": "float", + "description": "Acquisitions", "default": null, "optional": true }, { - "name": "period_ending", - "type": "date", - "description": "The fiscal period end date.", + "name": "purchase_of_investments", + "type": "float", + "description": "Purchase of Investments", "default": null, "optional": true - } - ] - }, - "model": "HistoricalEps" - }, - "/equity/fundamental/employee_count": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get historical employee count data for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.employee_count(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", + "name": "purchase_of_investment_securities", + "type": "float", + "description": "Purchase of Investment Securities", + "default": null, "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[HistoricalEmployees]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "sale_and_maturity_of_investments", + "type": "float", + "description": "Sale and Maturity of Investments", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "loans_held_for_sale", + "type": "float", + "description": "Loans Held for Sale (Net)", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "purchase_of_property_plant_and_equipment", + "type": "float", + "description": "Purchase of Property, Plant, and Equipment", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "other_investing_activities", + "type": "float", + "description": "Other Investing Activities (Net)", + "default": null, + "optional": true }, { - "name": "cik", - "type": "int", - "description": "Central Index Key (CIK) for the requested entity.", - "default": "", - "optional": false + "name": "net_cash_from_continuing_investing_activities", + "type": "float", + "description": "Net Cash from Continuing Investing Activities", + "default": null, + "optional": true }, { - "name": "acceptance_time", - "type": "datetime", - "description": "Time of acceptance of the company employee.", - "default": "", - "optional": false + "name": "net_cash_from_discontinued_investing_activities", + "type": "float", + "description": "Net Cash from Discontinued Investing Activities", + "default": null, + "optional": true }, { - "name": "period_of_report", - "type": "date", - "description": "Date of reporting of the company employee.", - "default": "", - "optional": false + "name": "net_cash_from_investing_activities", + "type": "float", + "description": "Net Cash from Investing Activities", + "default": null, + "optional": true }, { - "name": "company_name", - "type": "str", - "description": "Registered name of the company to retrieve the historical employees of.", - "default": "", - "optional": false + "name": "payment_of_dividends", + "type": "float", + "description": "Payment of Dividends", + "default": null, + "optional": true }, { - "name": "form_type", - "type": "str", - "description": "Form type of the company employee.", - "default": "", - "optional": false + "name": "repurchase_of_common_equity", + "type": "float", + "description": "Repurchase of Common Equity", + "default": null, + "optional": true }, { - "name": "filing_date", - "type": "date", - "description": "Filing date of the company employee", - "default": "", - "optional": false + "name": "repurchase_of_preferred_equity", + "type": "float", + "description": "Repurchase of Preferred Equity", + "default": null, + "optional": true }, { - "name": "employee_count", - "type": "int", - "description": "Count of employees of the company.", - "default": "", - "optional": false + "name": "issuance_of_common_equity", + "type": "float", + "description": "Issuance of Common Equity", + "default": null, + "optional": true }, { - "name": "source", - "type": "str", - "description": "Source URL which retrieves this data for the company.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "HistoricalEmployees" - }, - "/equity/fundamental/search_attributes": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Search Intrinio data tags to search in latest or historical attributes.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.search_attributes(query='ebitda', provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "query", - "type": "str", - "description": "Query to search for.", - "default": "", - "optional": false + "name": "issuance_of_preferred_equity", + "type": "float", + "description": "Issuance of Preferred Equity", + "default": null, + "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 1000, + "name": "issuance_of_debt", + "type": "float", + "description": "Issuance of Debt", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", + "name": "repayment_of_debt", + "type": "float", + "description": "Repayment of Debt", + "default": null, "optional": true - } - ], - "intrinio": [] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[SearchAttributes]", - "description": "Serializable results." + "name": "other_financing_activities", + "type": "float", + "description": "Other Financing Activities (Net)", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['intrinio']]", - "description": "Provider name." + "name": "cash_interest_received", + "type": "float", + "description": "Cash Interest Received", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "net_change_in_deposits", + "type": "float", + "description": "Net Change in Deposits", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "net_increase_in_fed_funds_sold", + "type": "float", + "description": "Net Increase in Fed Funds Sold", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "net_cash_from_continuing_financing_activities", + "type": "float", + "description": "Net Cash from Continuing Financing Activities", + "default": null, + "optional": true + }, { - "name": "id", - "type": "str", - "description": "ID of the financial attribute.", - "default": "", - "optional": false + "name": "net_cash_from_discontinued_financing_activities", + "type": "float", + "description": "Net Cash from Discontinued Financing Activities", + "default": null, + "optional": true }, { - "name": "name", - "type": "str", - "description": "Name of the financial attribute.", - "default": "", - "optional": false + "name": "net_cash_from_financing_activities", + "type": "float", + "description": "Net Cash from Financing Activities", + "default": null, + "optional": true }, { - "name": "tag", - "type": "str", - "description": "Tag of the financial attribute.", - "default": "", - "optional": false + "name": "effect_of_exchange_rate_changes", + "type": "float", + "description": "Effect of Exchange Rate Changes", + "default": null, + "optional": true }, { - "name": "statement_code", - "type": "str", - "description": "Code of the financial statement.", - "default": "", - "optional": false + "name": "other_net_changes_in_cash", + "type": "float", + "description": "Other Net Changes in Cash", + "default": null, + "optional": true }, { - "name": "statement_type", - "type": "str", - "description": "Type of the financial statement.", + "name": "net_change_in_cash_and_equivalents", + "type": "float", + "description": "Net Change in Cash and Equivalents", "default": null, "optional": true }, { - "name": "parent_name", - "type": "str", - "description": "Parent's name of the financial attribute.", + "name": "cash_income_taxes_paid", + "type": "float", + "description": "Cash Income Taxes Paid", "default": null, "optional": true }, { - "name": "sequence", + "name": "cash_interest_paid", + "type": "float", + "description": "Cash Interest Paid", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "net_cash_flow_from_operating_activities_continuing", "type": "int", - "description": "Sequence of the financial statement.", + "description": "Net cash flow from operating activities continuing.", "default": null, "optional": true }, { - "name": "factor", - "type": "str", - "description": "Unit of the financial attribute.", + "name": "net_cash_flow_from_operating_activities_discontinued", + "type": "int", + "description": "Net cash flow from operating activities discontinued.", "default": null, "optional": true }, { - "name": "transaction", - "type": "str", - "description": "Transaction type (credit/debit) of the financial attribute.", + "name": "net_cash_flow_from_operating_activities", + "type": "int", + "description": "Net cash flow from operating activities.", "default": null, "optional": true }, { - "name": "type", - "type": "str", - "description": "Type of the financial attribute.", + "name": "net_cash_flow_from_investing_activities_continuing", + "type": "int", + "description": "Net cash flow from investing activities continuing.", "default": null, "optional": true }, { - "name": "unit", - "type": "str", - "description": "Unit of the financial attribute.", + "name": "net_cash_flow_from_investing_activities_discontinued", + "type": "int", + "description": "Net cash flow from investing activities discontinued.", + "default": null, + "optional": true + }, + { + "name": "net_cash_flow_from_investing_activities", + "type": "int", + "description": "Net cash flow from investing activities.", + "default": null, + "optional": true + }, + { + "name": "net_cash_flow_from_financing_activities_continuing", + "type": "int", + "description": "Net cash flow from financing activities continuing.", + "default": null, + "optional": true + }, + { + "name": "net_cash_flow_from_financing_activities_discontinued", + "type": "int", + "description": "Net cash flow from financing activities discontinued.", + "default": null, + "optional": true + }, + { + "name": "net_cash_flow_from_financing_activities", + "type": "int", + "description": "Net cash flow from financing activities.", + "default": null, + "optional": true + }, + { + "name": "net_cash_flow_continuing", + "type": "int", + "description": "Net cash flow continuing.", + "default": null, + "optional": true + }, + { + "name": "net_cash_flow_discontinued", + "type": "int", + "description": "Net cash flow discontinued.", + "default": null, + "optional": true + }, + { + "name": "exchange_gains_losses", + "type": "int", + "description": "Exchange gains losses.", + "default": null, + "optional": true + }, + { + "name": "net_cash_flow", + "type": "int", + "description": "Net cash flow.", "default": null, "optional": true } ], - "intrinio": [] + "yfinance": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", + "default": null, + "optional": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true + } + ] }, - "model": "SearchAttributes" + "model": "CashFlowStatement" }, - "/equity/fundamental/latest_attributes": { + "/equity/fundamental/reported_financials": { "deprecated": { "flag": null, "message": null }, - "description": "Get the latest value of a data tag from Intrinio.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.latest_attributes(symbol='AAPL', tag='ceo', provider='intrinio')\n```\n\n", + "description": "Get financial statements as reported by the company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.reported_financials(symbol='AAPL', provider='intrinio')\n# Get AAPL balance sheet with a limit of 10 items.\nobb.equity.fundamental.reported_financials(symbol='AAPL', period='annual', statement_type='balance', limit=10, provider='intrinio')\n# Get reported income statement\nobb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='income', provider='intrinio')\n# Get reported cash flow statement\nobb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='cash', provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", + "type": "str", + "description": "Symbol to get data for.", "default": "", "optional": false }, { - "name": "tag", - "type": "Union[str, List[str]]", - "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", - "default": "", - "optional": false + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "statement_type", + "type": "str", + "description": "The type of financial statement - i.e, balance, income, cash.", + "default": "balance", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return. Although the response object contains multiple results, because of the variance in the fields, year-to-year and quarter-to-quarter, it is recommended to view results in small chunks.", + "default": 100, + "optional": true }, { "name": "provider", @@ -11836,13 +13070,35 @@ "optional": true } ], - "intrinio": [] + "intrinio": [ + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true + }, + { + "name": "statement_type", + "type": "Literal['balance', 'income', 'cash']", + "description": "Cash flow statements are reported as YTD, Q4 is the same as FY.", + "default": "income", + "optional": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", + "default": null, + "optional": true + } + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[LatestAttributes]", + "type": "List[ReportedFinancials]", "description": "Serializable results." }, { @@ -11870,116 +13126,111 @@ "data": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "period_ending", + "type": "date", + "description": "The ending date of the reporting period.", "default": "", "optional": false }, { - "name": "tag", + "name": "fiscal_period", "type": "str", - "description": "Tag name for the fetched data.", - "default": null, - "optional": true + "description": "The fiscal period of the report (e.g. FY, Q1, etc.).", + "default": "", + "optional": false }, { - "name": "value", - "type": "Union[str, float]", - "description": "The value of the data.", + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", "default": null, "optional": true } ], - "intrinio": [] - }, - "model": "LatestAttributes" - }, - "/equity/fundamental/historical_attributes": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the historical values of a data tag from Intrinio.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_attributes(symbol='AAPL', tag='ebitda', provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ + "intrinio": [ { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", + "name": "period_ending", + "type": "date", + "description": "The ending date of the reporting period.", "default": "", "optional": false }, { - "name": "tag", - "type": "Union[str, List[str]]", - "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report (e.g. FY, Q1, etc.).", "default": "", "optional": false }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", "default": null, "optional": true - }, + } + ] + }, + "model": "ReportedFinancials" + }, + "/equity/fundamental/cash_growth": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the growth of a company's cash flow statement items over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.cash_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.cash_growth(symbol='AAPL', limit=10, provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "frequency", - "type": "Literal['daily', 'weekly', 'monthly', 'quarterly', 'yearly']", - "description": "The frequency of the data.", - "default": "yearly", - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", - "default": 1000, + "default": 10, "optional": true }, { - "name": "tag_type", - "type": "str", - "description": "Filter by type, when applicable.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order.", - "default": "desc", - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Literal['intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10, "optional": true } - ], - "intrinio": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[HistoricalAttributes]", + "type": "List[CashFlowStatementGrowth]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['intrinio']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -12001,6 +13252,13 @@ }, "data": { "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, { "name": "date", "type": "date", @@ -12009,1331 +13267,1456 @@ "optional": false }, { - "name": "symbol", + "name": "period", "type": "str", - "description": "Symbol representing the entity requested in the data.", + "description": "Period the statement is returned for.", "default": "", "optional": false }, { - "name": "tag", - "type": "str", - "description": "Tag name for the fetched data.", - "default": null, - "optional": true + "name": "growth_net_income", + "type": "float", + "description": "Growth rate of net income.", + "default": "", + "optional": false }, { - "name": "value", + "name": "growth_depreciation_and_amortization", "type": "float", - "description": "The value of the data.", - "default": null, - "optional": true - } - ], - "intrinio": [] - }, - "model": "HistoricalAttributes" - }, - "/equity/fundamental/income": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the income statement for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.income(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.income(symbol='AAPL', period='annual', limit=5, provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "description": "Growth rate of depreciation and amortization.", "default": "", "optional": false }, { - "name": "period", - "type": "str", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true + "name": "growth_deferred_income_tax", + "type": "float", + "description": "Growth rate of deferred income tax.", + "default": "", + "optional": false }, { - "name": "limit", - "type": "Annotated[int, Ge(ge=0)]", - "description": "The number of data entries to return.", - "default": 5, - "optional": true + "name": "growth_stock_based_compensation", + "type": "float", + "description": "Growth rate of stock-based compensation.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", - "description": "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.", - "default": "fmp", - "optional": true - } - ], - "fmp": [], - "intrinio": [ - { - "name": "fiscal_year", - "type": "int", - "description": "The specific fiscal year. Reports do not go beyond 2008.", - "default": null, - "optional": true - } - ], - "polygon": [ + "name": "growth_change_in_working_capital", + "type": "float", + "description": "Growth rate of change in working capital.", + "default": "", + "optional": false + }, { - "name": "filing_date", - "type": "date", - "description": "Filing date of the financial statement.", - "default": null, - "optional": true + "name": "growth_accounts_receivables", + "type": "float", + "description": "Growth rate of accounts receivables.", + "default": "", + "optional": false }, { - "name": "filing_date_lt", - "type": "date", - "description": "Filing date less than the given date.", - "default": null, - "optional": true + "name": "growth_inventory", + "type": "float", + "description": "Growth rate of inventory.", + "default": "", + "optional": false }, { - "name": "filing_date_lte", - "type": "date", - "description": "Filing date less than or equal to the given date.", - "default": null, - "optional": true + "name": "growth_accounts_payables", + "type": "float", + "description": "Growth rate of accounts payables.", + "default": "", + "optional": false }, { - "name": "filing_date_gt", - "type": "date", - "description": "Filing date greater than the given date.", - "default": null, - "optional": true + "name": "growth_other_working_capital", + "type": "float", + "description": "Growth rate of other working capital.", + "default": "", + "optional": false }, { - "name": "filing_date_gte", - "type": "date", - "description": "Filing date greater than or equal to the given date.", - "default": null, - "optional": true + "name": "growth_other_non_cash_items", + "type": "float", + "description": "Growth rate of other non-cash items.", + "default": "", + "optional": false }, { - "name": "period_of_report_date", - "type": "date", - "description": "Period of report date of the financial statement.", - "default": null, - "optional": true + "name": "growth_net_cash_provided_by_operating_activities", + "type": "float", + "description": "Growth rate of net cash provided by operating activities.", + "default": "", + "optional": false }, { - "name": "period_of_report_date_lt", - "type": "date", - "description": "Period of report date less than the given date.", - "default": null, - "optional": true + "name": "growth_investments_in_property_plant_and_equipment", + "type": "float", + "description": "Growth rate of investments in property, plant, and equipment.", + "default": "", + "optional": false }, { - "name": "period_of_report_date_lte", - "type": "date", - "description": "Period of report date less than or equal to the given date.", - "default": null, - "optional": true - }, - { - "name": "period_of_report_date_gt", - "type": "date", - "description": "Period of report date greater than the given date.", - "default": null, - "optional": true + "name": "growth_acquisitions_net", + "type": "float", + "description": "Growth rate of net acquisitions.", + "default": "", + "optional": false }, { - "name": "period_of_report_date_gte", - "type": "date", - "description": "Period of report date greater than or equal to the given date.", - "default": null, - "optional": true + "name": "growth_purchases_of_investments", + "type": "float", + "description": "Growth rate of purchases of investments.", + "default": "", + "optional": false }, { - "name": "include_sources", - "type": "bool", - "description": "Whether to include the sources of the financial statement.", - "default": null, - "optional": true + "name": "growth_sales_maturities_of_investments", + "type": "float", + "description": "Growth rate of sales maturities of investments.", + "default": "", + "optional": false }, { - "name": "order", - "type": "Literal['asc', 'desc']", - "description": "Order of the financial statement.", - "default": null, - "optional": true + "name": "growth_other_investing_activities", + "type": "float", + "description": "Growth rate of other investing activities.", + "default": "", + "optional": false }, { - "name": "sort", - "type": "Literal['filing_date', 'period_of_report_date']", - "description": "Sort of the financial statement.", - "default": null, - "optional": true - } - ], - "yfinance": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[IncomeStatement]", - "description": "Serializable results." + "name": "growth_net_cash_used_for_investing_activities", + "type": "float", + "description": "Growth rate of net cash used for investing activities.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", - "description": "Provider name." + "name": "growth_debt_repayment", + "type": "float", + "description": "Growth rate of debt repayment.", + "default": "", + "optional": false }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "growth_common_stock_issued", + "type": "float", + "description": "Growth rate of common stock issued.", + "default": "", + "optional": false }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "growth_common_stock_repurchased", + "type": "float", + "description": "Growth rate of common stock repurchased.", + "default": "", + "optional": false }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "period_ending", - "type": "date", - "description": "The end date of the reporting period.", + "name": "growth_dividends_paid", + "type": "float", + "description": "Growth rate of dividends paid.", "default": "", "optional": false }, { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the report.", - "default": null, - "optional": true + "name": "growth_other_financing_activities", + "type": "float", + "description": "Growth rate of other financing activities.", + "default": "", + "optional": false }, { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the fiscal period.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "filing_date", - "type": "date", - "description": "The date when the filing was made.", - "default": null, - "optional": true + "name": "growth_net_cash_used_provided_by_financing_activities", + "type": "float", + "description": "Growth rate of net cash used/provided by financing activities.", + "default": "", + "optional": false }, { - "name": "accepted_date", - "type": "datetime", - "description": "The date and time when the filing was accepted.", - "default": null, - "optional": true + "name": "growth_effect_of_forex_changes_on_cash", + "type": "float", + "description": "Growth rate of the effect of foreign exchange changes on cash.", + "default": "", + "optional": false }, { - "name": "reported_currency", - "type": "str", - "description": "The currency in which the balance sheet was reported.", - "default": null, - "optional": true + "name": "growth_net_change_in_cash", + "type": "float", + "description": "Growth rate of net change in cash.", + "default": "", + "optional": false }, { - "name": "revenue", + "name": "growth_cash_at_end_of_period", "type": "float", - "description": "Total revenue.", - "default": null, - "optional": true + "description": "Growth rate of cash at the end of the period.", + "default": "", + "optional": false }, { - "name": "cost_of_revenue", + "name": "growth_cash_at_beginning_of_period", "type": "float", - "description": "Cost of revenue.", - "default": null, - "optional": true + "description": "Growth rate of cash at the beginning of the period.", + "default": "", + "optional": false }, { - "name": "gross_profit", + "name": "growth_operating_cash_flow", "type": "float", - "description": "Gross profit.", - "default": null, - "optional": true + "description": "Growth rate of operating cash flow.", + "default": "", + "optional": false }, { - "name": "gross_profit_margin", + "name": "growth_capital_expenditure", "type": "float", - "description": "Gross profit margin.", - "default": null, - "optional": true + "description": "Growth rate of capital expenditure.", + "default": "", + "optional": false }, { - "name": "general_and_admin_expense", + "name": "growth_free_cash_flow", "type": "float", - "description": "General and administrative expenses.", + "description": "Growth rate of free cash flow.", + "default": "", + "optional": false + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "research_and_development_expense", - "type": "float", - "description": "Research and development expenses.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "selling_and_marketing_expense", - "type": "float", - "description": "Selling and marketing expenses.", - "default": null, - "optional": true + "name": "period", + "type": "str", + "description": "Period the statement is returned for.", + "default": "", + "optional": false }, { - "name": "selling_general_and_admin_expense", + "name": "growth_net_income", "type": "float", - "description": "Selling, general and administrative expenses.", - "default": null, - "optional": true + "description": "Growth rate of net income.", + "default": "", + "optional": false }, { - "name": "other_expenses", + "name": "growth_depreciation_and_amortization", "type": "float", - "description": "Other expenses.", - "default": null, - "optional": true + "description": "Growth rate of depreciation and amortization.", + "default": "", + "optional": false }, { - "name": "total_operating_expenses", + "name": "growth_deferred_income_tax", "type": "float", - "description": "Total operating expenses.", - "default": null, - "optional": true + "description": "Growth rate of deferred income tax.", + "default": "", + "optional": false }, { - "name": "cost_and_expenses", + "name": "growth_stock_based_compensation", "type": "float", - "description": "Cost and expenses.", - "default": null, - "optional": true + "description": "Growth rate of stock-based compensation.", + "default": "", + "optional": false }, { - "name": "interest_income", + "name": "growth_change_in_working_capital", "type": "float", - "description": "Interest income.", - "default": null, - "optional": true + "description": "Growth rate of change in working capital.", + "default": "", + "optional": false }, { - "name": "total_interest_expense", + "name": "growth_accounts_receivables", "type": "float", - "description": "Total interest expenses.", - "default": null, - "optional": true + "description": "Growth rate of accounts receivables.", + "default": "", + "optional": false }, { - "name": "depreciation_and_amortization", + "name": "growth_inventory", "type": "float", - "description": "Depreciation and amortization.", - "default": null, - "optional": true + "description": "Growth rate of inventory.", + "default": "", + "optional": false }, { - "name": "ebitda", + "name": "growth_accounts_payables", "type": "float", - "description": "EBITDA.", - "default": null, - "optional": true + "description": "Growth rate of accounts payables.", + "default": "", + "optional": false }, { - "name": "ebitda_margin", + "name": "growth_other_working_capital", "type": "float", - "description": "EBITDA margin.", - "default": null, - "optional": true + "description": "Growth rate of other working capital.", + "default": "", + "optional": false }, { - "name": "total_operating_income", + "name": "growth_other_non_cash_items", "type": "float", - "description": "Total operating income.", - "default": null, - "optional": true + "description": "Growth rate of other non-cash items.", + "default": "", + "optional": false }, { - "name": "operating_income_margin", + "name": "growth_net_cash_provided_by_operating_activities", "type": "float", - "description": "Operating income margin.", - "default": null, - "optional": true + "description": "Growth rate of net cash provided by operating activities.", + "default": "", + "optional": false }, { - "name": "total_other_income_expenses", + "name": "growth_investments_in_property_plant_and_equipment", "type": "float", - "description": "Total other income and expenses.", - "default": null, - "optional": true + "description": "Growth rate of investments in property, plant, and equipment.", + "default": "", + "optional": false }, { - "name": "total_pre_tax_income", + "name": "growth_acquisitions_net", "type": "float", - "description": "Total pre-tax income.", - "default": null, - "optional": true + "description": "Growth rate of net acquisitions.", + "default": "", + "optional": false }, { - "name": "pre_tax_income_margin", + "name": "growth_purchases_of_investments", "type": "float", - "description": "Pre-tax income margin.", - "default": null, - "optional": true + "description": "Growth rate of purchases of investments.", + "default": "", + "optional": false }, { - "name": "income_tax_expense", + "name": "growth_sales_maturities_of_investments", "type": "float", - "description": "Income tax expense.", - "default": null, - "optional": true + "description": "Growth rate of sales maturities of investments.", + "default": "", + "optional": false }, { - "name": "consolidated_net_income", + "name": "growth_other_investing_activities", "type": "float", - "description": "Consolidated net income.", - "default": null, - "optional": true + "description": "Growth rate of other investing activities.", + "default": "", + "optional": false }, { - "name": "net_income_margin", + "name": "growth_net_cash_used_for_investing_activities", "type": "float", - "description": "Net income margin.", - "default": null, - "optional": true + "description": "Growth rate of net cash used for investing activities.", + "default": "", + "optional": false }, { - "name": "basic_earnings_per_share", + "name": "growth_debt_repayment", "type": "float", - "description": "Basic earnings per share.", - "default": null, - "optional": true + "description": "Growth rate of debt repayment.", + "default": "", + "optional": false }, { - "name": "diluted_earnings_per_share", + "name": "growth_common_stock_issued", "type": "float", - "description": "Diluted earnings per share.", - "default": null, - "optional": true + "description": "Growth rate of common stock issued.", + "default": "", + "optional": false }, { - "name": "weighted_average_basic_shares_outstanding", + "name": "growth_common_stock_repurchased", "type": "float", - "description": "Weighted average basic shares outstanding.", - "default": null, - "optional": true + "description": "Growth rate of common stock repurchased.", + "default": "", + "optional": false }, { - "name": "weighted_average_diluted_shares_outstanding", + "name": "growth_dividends_paid", "type": "float", - "description": "Weighted average diluted shares outstanding.", - "default": null, - "optional": true - }, - { - "name": "link", - "type": "str", - "description": "Link to the filing.", - "default": null, - "optional": true - }, - { - "name": "final_link", - "type": "str", - "description": "Link to the filing document.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "reported_currency", - "type": "str", - "description": "The currency in which the balance sheet is reported.", - "default": null, - "optional": true + "description": "Growth rate of dividends paid.", + "default": "", + "optional": false }, { - "name": "revenue", + "name": "growth_other_financing_activities", "type": "float", - "description": "Total revenue", - "default": null, - "optional": true + "description": "Growth rate of other financing activities.", + "default": "", + "optional": false }, { - "name": "operating_revenue", + "name": "growth_net_cash_used_provided_by_financing_activities", "type": "float", - "description": "Total operating revenue", - "default": null, - "optional": true + "description": "Growth rate of net cash used/provided by financing activities.", + "default": "", + "optional": false }, { - "name": "cost_of_revenue", + "name": "growth_effect_of_forex_changes_on_cash", "type": "float", - "description": "Total cost of revenue", - "default": null, - "optional": true + "description": "Growth rate of the effect of foreign exchange changes on cash.", + "default": "", + "optional": false }, { - "name": "operating_cost_of_revenue", + "name": "growth_net_change_in_cash", "type": "float", - "description": "Total operating cost of revenue", - "default": null, - "optional": true + "description": "Growth rate of net change in cash.", + "default": "", + "optional": false }, { - "name": "gross_profit", + "name": "growth_cash_at_end_of_period", "type": "float", - "description": "Total gross profit", - "default": null, - "optional": true + "description": "Growth rate of cash at the end of the period.", + "default": "", + "optional": false }, { - "name": "gross_profit_margin", + "name": "growth_cash_at_beginning_of_period", "type": "float", - "description": "Gross margin ratio.", - "default": null, - "optional": true + "description": "Growth rate of cash at the beginning of the period.", + "default": "", + "optional": false }, { - "name": "provision_for_credit_losses", + "name": "growth_operating_cash_flow", "type": "float", - "description": "Provision for credit losses", - "default": null, - "optional": true + "description": "Growth rate of operating cash flow.", + "default": "", + "optional": false }, { - "name": "research_and_development_expense", + "name": "growth_capital_expenditure", "type": "float", - "description": "Research and development expense", - "default": null, - "optional": true + "description": "Growth rate of capital expenditure.", + "default": "", + "optional": false }, { - "name": "selling_general_and_admin_expense", + "name": "growth_free_cash_flow", "type": "float", - "description": "Selling, general, and admin expense", - "default": null, - "optional": true + "description": "Growth rate of free cash flow.", + "default": "", + "optional": false + } + ] + }, + "model": "CashFlowStatementGrowth" + }, + "/equity/fundamental/dividends": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical dividend data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.dividends(symbol='AAPL', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "salaries_and_employee_benefits", - "type": "float", - "description": "Salaries and employee benefits", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "marketing_expense", - "type": "float", - "description": "Marketing expense", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "net_occupancy_and_equipment_expense", - "type": "float", - "description": "Net occupancy and equipment expense", - "default": null, + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'yfinance']", + "description": "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.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "other_operating_expenses", - "type": "float", - "description": "Other operating expenses", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "depreciation_expense", - "type": "float", - "description": "Depreciation expense", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "amortization_expense", - "type": "float", - "description": "Amortization expense", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "amortization_of_deferred_policy_acquisition_costs", - "type": "float", - "description": "Amortization of deferred policy acquisition costs", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100, "optional": true - }, + } + ], + "yfinance": [ { - "name": "exploration_expense", - "type": "float", - "description": "Exploration expense", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "depletion_expense", - "type": "float", - "description": "Depletion expense", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "total_operating_expenses", - "type": "float", - "description": "Total operating expenses", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[HistoricalDividends]", + "description": "Serializable results." }, { - "name": "total_operating_income", - "type": "float", - "description": "Total operating income", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "description": "Provider name." }, { - "name": "deposits_and_money_market_investments_interest_income", - "type": "float", - "description": "Deposits and money market investments interest income", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "federal_funds_sold_and_securities_borrowed_interest_income", - "type": "float", - "description": "Federal funds sold and securities borrowed interest income", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "investment_securities_interest_income", - "type": "float", - "description": "Investment securities interest income", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "ex_dividend_date", + "type": "date", + "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", + "default": "", + "optional": false }, { - "name": "loans_and_leases_interest_income", + "name": "amount", "type": "float", - "description": "Loans and leases interest income", - "default": null, - "optional": true + "description": "The dividend amount per share.", + "default": "", + "optional": false + } + ], + "fmp": [ + { + "name": "label", + "type": "str", + "description": "Label of the historical dividends.", + "default": "", + "optional": false }, { - "name": "trading_account_interest_income", + "name": "adj_dividend", "type": "float", - "description": "Trading account interest income", - "default": null, - "optional": true + "description": "Adjusted dividend of the historical dividends.", + "default": "", + "optional": false }, { - "name": "other_interest_income", - "type": "float", - "description": "Other interest income", + "name": "record_date", + "type": "date", + "description": "Record date of the historical dividends.", "default": null, "optional": true }, { - "name": "total_non_interest_income", - "type": "float", - "description": "Total non-interest income", + "name": "payment_date", + "type": "date", + "description": "Payment date of the historical dividends.", "default": null, "optional": true }, { - "name": "interest_and_investment_income", - "type": "float", - "description": "Interest and investment income", + "name": "declaration_date", + "type": "date", + "description": "Declaration date of the historical dividends.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "short_term_borrowings_interest_expense", + "name": "factor", "type": "float", - "description": "Short-term borrowings interest expense", + "description": "factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.", "default": null, "optional": true }, { - "name": "long_term_debt_interest_expense", - "type": "float", - "description": "Long-term debt interest expense", + "name": "currency", + "type": "str", + "description": "The currency in which the dividend is paid.", "default": null, "optional": true }, { - "name": "capitalized_lease_obligations_interest_expense", + "name": "split_ratio", "type": "float", - "description": "Capitalized lease obligations interest expense", + "description": "The ratio of the stock split, if a stock split occurred.", "default": null, "optional": true + } + ], + "yfinance": [ + { + "name": "ex_dividend_date", + "type": "date", + "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", + "default": "", + "optional": false }, { - "name": "deposits_interest_expense", + "name": "amount", "type": "float", - "description": "Deposits interest expense", - "default": null, - "optional": true + "description": "The dividend amount per share.", + "default": "", + "optional": false + } + ] + }, + "model": "HistoricalDividends" + }, + "/equity/fundamental/historical_eps": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical earnings per share data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_eps(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "federal_funds_purchased_and_securities_sold_interest_expense", - "type": "float", - "description": "Federal funds purchased and securities sold interest expense", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "other_interest_expense", - "type": "float", - "description": "Other interest expense", + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", "default": null, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[HistoricalEps]", + "description": "Serializable results." }, { - "name": "total_interest_expense", - "type": "float", - "description": "Total interest expense", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "net_interest_income", - "type": "float", - "description": "Net interest income", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "other_non_interest_income", - "type": "float", - "description": "Other non-interest income", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "investment_banking_income", - "type": "float", - "description": "Investment banking income", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "trust_fees_by_commissions", - "type": "float", - "description": "Trust fees by commissions", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": null, "optional": true }, { - "name": "premiums_earned", - "type": "float", - "description": "Premiums earned", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "insurance_policy_acquisition_costs", - "type": "float", - "description": "Insurance policy acquisition costs", + "name": "announce_time", + "type": "str", + "description": "Timing of the earnings announcement.", "default": null, "optional": true }, { - "name": "current_and_future_benefits", + "name": "eps_actual", "type": "float", - "description": "Current and future benefits", + "description": "Actual EPS from the earnings date.", "default": null, "optional": true }, { - "name": "property_and_liability_insurance_claims", + "name": "eps_estimated", "type": "float", - "description": "Property and liability insurance claims", + "description": "Estimated EPS for the earnings date.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "total_non_interest_expense", + "name": "revenue_estimated", "type": "float", - "description": "Total non-interest expense", + "description": "Estimated consensus revenue for the reporting period.", "default": null, "optional": true }, { - "name": "net_realized_and_unrealized_capital_gains_on_investments", + "name": "revenue_actual", "type": "float", - "description": "Net realized and unrealized capital gains on investments", + "description": "The actual reported revenue.", "default": null, "optional": true }, { - "name": "other_gains", - "type": "float", - "description": "Other gains", + "name": "reporting_time", + "type": "str", + "description": "The reporting time - e.g. after market close.", "default": null, "optional": true }, { - "name": "non_operating_income", - "type": "float", - "description": "Non-operating income", + "name": "updated_at", + "type": "date", + "description": "The date when the data was last updated.", "default": null, "optional": true }, { - "name": "other_income", - "type": "float", - "description": "Other income", + "name": "period_ending", + "type": "date", + "description": "The fiscal period end date.", "default": null, "optional": true - }, + } + ] + }, + "model": "HistoricalEps" + }, + "/equity/fundamental/employee_count": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical employee count data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.employee_count(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "other_revenue", - "type": "float", - "description": "Other revenue", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "extraordinary_income", - "type": "float", - "description": "Extraordinary income", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "total_other_income", - "type": "float", - "description": "Total other income", - "default": null, - "optional": true - }, + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ { - "name": "ebitda", - "type": "float", - "description": "Earnings Before Interest, Taxes, Depreciation and Amortization.", - "default": null, - "optional": true + "name": "results", + "type": "List[HistoricalEmployees]", + "description": "Serializable results." }, { - "name": "ebitda_margin", - "type": "float", - "description": "Margin on Earnings Before Interest, Taxes, Depreciation and Amortization.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "total_pre_tax_income", - "type": "float", - "description": "Total pre-tax income", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "ebit", - "type": "float", - "description": "Earnings Before Interest and Taxes.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "pre_tax_income_margin", - "type": "float", - "description": "Pre-Tax Income Margin.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "income_tax_expense", - "type": "float", - "description": "Income tax expense", - "default": null, - "optional": true + "name": "cik", + "type": "int", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "", + "optional": false }, { - "name": "impairment_charge", - "type": "float", - "description": "Impairment charge", - "default": null, - "optional": true + "name": "acceptance_time", + "type": "datetime", + "description": "Time of acceptance of the company employee.", + "default": "", + "optional": false }, { - "name": "restructuring_charge", - "type": "float", - "description": "Restructuring charge", - "default": null, - "optional": true + "name": "period_of_report", + "type": "date", + "description": "Date of reporting of the company employee.", + "default": "", + "optional": false }, { - "name": "service_charges_on_deposit_accounts", - "type": "float", - "description": "Service charges on deposit accounts", - "default": null, - "optional": true + "name": "company_name", + "type": "str", + "description": "Registered name of the company to retrieve the historical employees of.", + "default": "", + "optional": false }, { - "name": "other_service_charges", - "type": "float", - "description": "Other service charges", - "default": null, - "optional": true + "name": "form_type", + "type": "str", + "description": "Form type of the company employee.", + "default": "", + "optional": false }, { - "name": "other_special_charges", - "type": "float", - "description": "Other special charges", - "default": null, - "optional": true + "name": "filing_date", + "type": "date", + "description": "Filing date of the company employee", + "default": "", + "optional": false }, { - "name": "other_cost_of_revenue", - "type": "float", - "description": "Other cost of revenue", - "default": null, - "optional": true + "name": "employee_count", + "type": "int", + "description": "Count of employees of the company.", + "default": "", + "optional": false }, { - "name": "net_income_continuing_operations", - "type": "float", - "description": "Net income (continuing operations)", - "default": null, - "optional": true + "name": "source", + "type": "str", + "description": "Source URL which retrieves this data for the company.", + "default": "", + "optional": false + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "net_income_discontinued_operations", - "type": "float", - "description": "Net income (discontinued operations)", - "default": null, - "optional": true + "name": "cik", + "type": "int", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "", + "optional": false }, { - "name": "consolidated_net_income", - "type": "float", - "description": "Consolidated net income", - "default": null, - "optional": true + "name": "acceptance_time", + "type": "datetime", + "description": "Time of acceptance of the company employee.", + "default": "", + "optional": false }, { - "name": "other_adjustments_to_consolidated_net_income", - "type": "float", - "description": "Other adjustments to consolidated net income", - "default": null, - "optional": true + "name": "period_of_report", + "type": "date", + "description": "Date of reporting of the company employee.", + "default": "", + "optional": false }, { - "name": "other_adjustment_to_net_income_attributable_to_common_shareholders", - "type": "float", - "description": "Other adjustment to net income attributable to common shareholders", - "default": null, - "optional": true + "name": "company_name", + "type": "str", + "description": "Registered name of the company to retrieve the historical employees of.", + "default": "", + "optional": false }, { - "name": "net_income_attributable_to_noncontrolling_interest", - "type": "float", - "description": "Net income attributable to noncontrolling interest", - "default": null, - "optional": true + "name": "form_type", + "type": "str", + "description": "Form type of the company employee.", + "default": "", + "optional": false }, { - "name": "net_income_attributable_to_common_shareholders", - "type": "float", - "description": "Net income attributable to common shareholders", - "default": null, - "optional": true + "name": "filing_date", + "type": "date", + "description": "Filing date of the company employee", + "default": "", + "optional": false }, { - "name": "basic_earnings_per_share", - "type": "float", - "description": "Basic earnings per share", - "default": null, - "optional": true + "name": "employee_count", + "type": "int", + "description": "Count of employees of the company.", + "default": "", + "optional": false }, { - "name": "diluted_earnings_per_share", - "type": "float", - "description": "Diluted earnings per share", - "default": null, - "optional": true + "name": "source", + "type": "str", + "description": "Source URL which retrieves this data for the company.", + "default": "", + "optional": false + } + ] + }, + "model": "HistoricalEmployees" + }, + "/equity/fundamental/search_attributes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search Intrinio data tags to search in latest or historical attributes.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.search_attributes(query='ebitda', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str", + "description": "Query to search for.", + "default": "", + "optional": false }, { - "name": "basic_and_diluted_earnings_per_share", - "type": "float", - "description": "Basic and diluted earnings per share", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 1000, "optional": true }, { - "name": "cash_dividends_to_common_per_share", - "type": "float", - "description": "Cash dividends to common per share", - "default": null, + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", "optional": true + } + ], + "intrinio": [ + { + "name": "query", + "type": "str", + "description": "Query to search for.", + "default": "", + "optional": false }, { - "name": "preferred_stock_dividends_declared", - "type": "float", - "description": "Preferred stock dividends declared", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 1000, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[SearchAttributes]", + "description": "Serializable results." }, { - "name": "weighted_average_basic_shares_outstanding", - "type": "float", - "description": "Weighted average basic shares outstanding", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['intrinio']]", + "description": "Provider name." }, { - "name": "weighted_average_diluted_shares_outstanding", - "type": "float", - "description": "Weighted average diluted shares outstanding", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "weighted_average_basic_and_diluted_shares_outstanding", - "type": "float", - "description": "Weighted average basic and diluted shares outstanding", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } - ], - "polygon": [ + ] + }, + "data": { + "standard": [ { - "name": "revenue", - "type": "float", - "description": "Total Revenue", - "default": null, - "optional": true + "name": "id", + "type": "str", + "description": "ID of the financial attribute.", + "default": "", + "optional": false }, { - "name": "cost_of_revenue_goods", - "type": "float", - "description": "Cost of Revenue - Goods", - "default": null, - "optional": true + "name": "name", + "type": "str", + "description": "Name of the financial attribute.", + "default": "", + "optional": false }, { - "name": "cost_of_revenue_services", - "type": "float", - "description": "Cost of Revenue - Services", - "default": null, - "optional": true + "name": "tag", + "type": "str", + "description": "Tag of the financial attribute.", + "default": "", + "optional": false }, { - "name": "cost_of_revenue", - "type": "float", - "description": "Cost of Revenue", - "default": null, - "optional": true + "name": "statement_code", + "type": "str", + "description": "Code of the financial statement.", + "default": "", + "optional": false }, { - "name": "gross_profit", - "type": "float", - "description": "Gross Profit", + "name": "statement_type", + "type": "str", + "description": "Type of the financial statement.", "default": null, "optional": true }, { - "name": "provisions_for_loan_lease_and_other_losses", - "type": "float", - "description": "Provisions for loan lease and other losses", + "name": "parent_name", + "type": "str", + "description": "Parent's name of the financial attribute.", "default": null, "optional": true }, { - "name": "depreciation_and_amortization", - "type": "float", - "description": "Depreciation and Amortization", + "name": "sequence", + "type": "int", + "description": "Sequence of the financial statement.", "default": null, "optional": true }, { - "name": "income_tax_expense_benefit_current", - "type": "float", - "description": "Income tax expense benefit current", + "name": "factor", + "type": "str", + "description": "Unit of the financial attribute.", "default": null, "optional": true }, { - "name": "deferred_tax_benefit", - "type": "float", - "description": "Deferred tax benefit", + "name": "transaction", + "type": "str", + "description": "Transaction type (credit/debit) of the financial attribute.", "default": null, "optional": true }, { - "name": "benefits_costs_expenses", - "type": "float", - "description": "Benefits, costs and expenses", + "name": "type", + "type": "str", + "description": "Type of the financial attribute.", "default": null, "optional": true }, { - "name": "selling_general_and_administrative_expense", - "type": "float", - "description": "Selling, general and administrative expense", + "name": "unit", + "type": "str", + "description": "Unit of the financial attribute.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "research_and_development", - "type": "float", - "description": "Research and development", - "default": null, - "optional": true + "name": "id", + "type": "str", + "description": "ID of the financial attribute.", + "default": "", + "optional": false }, { - "name": "costs_and_expenses", - "type": "float", - "description": "Costs and expenses", - "default": null, - "optional": true + "name": "name", + "type": "str", + "description": "Name of the financial attribute.", + "default": "", + "optional": false }, { - "name": "other_operating_expenses", - "type": "float", - "description": "Other Operating Expenses", - "default": null, - "optional": true + "name": "tag", + "type": "str", + "description": "Tag of the financial attribute.", + "default": "", + "optional": false }, { - "name": "operating_expenses", - "type": "float", - "description": "Operating expenses", - "default": null, - "optional": true + "name": "statement_code", + "type": "str", + "description": "Code of the financial statement.", + "default": "", + "optional": false }, { - "name": "operating_income", - "type": "float", - "description": "Operating Income/Loss", + "name": "statement_type", + "type": "str", + "description": "Type of the financial statement.", "default": null, "optional": true }, { - "name": "non_operating_income", - "type": "float", - "description": "Non Operating Income/Loss", + "name": "parent_name", + "type": "str", + "description": "Parent's name of the financial attribute.", "default": null, "optional": true }, { - "name": "interest_and_dividend_income", - "type": "float", - "description": "Interest and Dividend Income", + "name": "sequence", + "type": "int", + "description": "Sequence of the financial statement.", "default": null, "optional": true }, { - "name": "total_interest_expense", - "type": "float", - "description": "Interest Expense", + "name": "factor", + "type": "str", + "description": "Unit of the financial attribute.", "default": null, "optional": true }, { - "name": "interest_and_debt_expense", - "type": "float", - "description": "Interest and Debt Expense", + "name": "transaction", + "type": "str", + "description": "Transaction type (credit/debit) of the financial attribute.", "default": null, "optional": true }, { - "name": "net_interest_income", - "type": "float", - "description": "Interest Income Net", + "name": "type", + "type": "str", + "description": "Type of the financial attribute.", "default": null, "optional": true }, { - "name": "interest_income_after_provision_for_losses", - "type": "float", - "description": "Interest Income After Provision for Losses", + "name": "unit", + "type": "str", + "description": "Unit of the financial attribute.", "default": null, "optional": true + } + ] + }, + "model": "SearchAttributes" + }, + "/equity/fundamental/latest_attributes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the latest value of a data tag from Intrinio.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.latest_attributes(symbol='AAPL', tag='ceo', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "non_interest_expense", - "type": "float", - "description": "Non-Interest Expense", - "default": null, - "optional": true + "name": "tag", + "type": "str", + "description": "Intrinio data tag ID or code.", + "default": "", + "optional": false }, { - "name": "non_interest_income", - "type": "float", - "description": "Non-Interest Income", - "default": null, + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", "optional": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "income_from_discontinued_operations_net_of_tax_on_disposal", - "type": "float", - "description": "Income From Discontinued Operations Net of Tax on Disposal", - "default": null, - "optional": true + "name": "tag", + "type": "str", + "description": "Intrinio data tag ID or code.", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[LatestAttributes]", + "description": "Serializable results." }, { - "name": "income_from_discontinued_operations_net_of_tax", - "type": "float", - "description": "Income From Discontinued Operations Net of Tax", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['intrinio']]", + "description": "Provider name." }, { - "name": "income_before_equity_method_investments", - "type": "float", - "description": "Income Before Equity Method Investments", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "income_from_equity_method_investments", - "type": "float", - "description": "Income From Equity Method Investments", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "total_pre_tax_income", - "type": "float", - "description": "Income Before Tax", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "income_tax_expense", - "type": "float", - "description": "Income Tax Expense", + "name": "tag", + "type": "str", + "description": "Tag name for the fetched data.", "default": null, "optional": true }, { - "name": "income_after_tax", - "type": "float", - "description": "Income After Tax", + "name": "value", + "type": "Union[str, float]", + "description": "The value of the data.", "default": null, "optional": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "consolidated_net_income", - "type": "float", - "description": "Net Income/Loss", + "name": "tag", + "type": "str", + "description": "Tag name for the fetched data.", "default": null, "optional": true }, { - "name": "net_income_attributable_noncontrolling_interest", - "type": "float", - "description": "Net income (loss) attributable to noncontrolling interest", + "name": "value", + "type": "Union[str, float]", + "description": "The value of the data.", "default": null, "optional": true - }, - { - "name": "net_income_attributable_to_parent", - "type": "float", - "description": "Net income (loss) attributable to parent", - "default": null, - "optional": true - }, + } + ] + }, + "model": "LatestAttributes" + }, + "/equity/fundamental/historical_attributes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the historical values of a data tag from Intrinio.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_attributes(symbol='AAPL', tag='ebitda', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ { - "name": "net_income_attributable_to_common_shareholders", - "type": "float", - "description": "Net Income/Loss Available To Common Stockholders Basic", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "participating_securities_earnings", - "type": "float", - "description": "Participating Securities Distributed And Undistributed Earnings Loss Basic", - "default": null, - "optional": true + "name": "tag", + "type": "str", + "description": "Intrinio data tag ID or code.", + "default": "", + "optional": false }, { - "name": "undistributed_earnings_allocated_to_participating_securities", - "type": "float", - "description": "Undistributed Earnings Allocated To Participating Securities", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "common_stock_dividends", - "type": "float", - "description": "Common Stock Dividends", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "preferred_stock_dividends_and_other_adjustments", - "type": "float", - "description": "Preferred stock dividends and other adjustments", - "default": null, + "name": "frequency", + "type": "Literal['daily', 'weekly', 'monthly', 'quarterly', 'yearly']", + "description": "The frequency of the data.", + "default": "yearly", "optional": true }, { - "name": "basic_earnings_per_share", - "type": "float", - "description": "Earnings Per Share", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 1000, "optional": true }, { - "name": "diluted_earnings_per_share", - "type": "float", - "description": "Diluted Earnings Per Share", + "name": "tag_type", + "type": "str", + "description": "Filter by type, when applicable.", "default": null, "optional": true }, { - "name": "weighted_average_basic_shares_outstanding", - "type": "float", - "description": "Basic Average Shares", - "default": null, + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order.", + "default": "desc", "optional": true }, { - "name": "weighted_average_diluted_shares_outstanding", - "type": "float", - "description": "Diluted Average Shares", - "default": null, + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", "optional": true } ], - "yfinance": [] - }, - "model": "IncomeStatement" - }, - "/equity/fundamental/income_growth": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the growth of a company's income statement items over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.income_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.income_growth(symbol='AAPL', limit=10, period='annual', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ + "intrinio": [ { "name": "symbol", "type": "str", @@ -13341,40 +14724,67 @@ "default": "", "optional": false }, + { + "name": "tag", + "type": "str", + "description": "Intrinio data tag ID or code.", + "default": "", + "optional": false + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "frequency", + "type": "Literal['daily', 'weekly', 'monthly', 'quarterly', 'yearly']", + "description": "The frequency of the data.", + "default": "yearly", + "optional": true + }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", - "default": 10, + "default": 1000, "optional": true }, { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "Time period of the data to return.", - "default": "annual", + "name": "tag_type", + "type": "str", + "description": "Filter by type, when applicable.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order.", + "default": "desc", "optional": true } - ], - "fmp": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[IncomeStatementGrowth]", + "type": "List[HistoricalAttributes]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['intrinio']]", "description": "Provider name." }, { @@ -13396,13 +14806,6 @@ }, "data": { "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": null, - "optional": true - }, { "name": "date", "type": "date", @@ -13411,259 +14814,243 @@ "optional": false }, { - "name": "period", + "name": "symbol", "type": "str", - "description": "Period the statement is returned for.", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "growth_revenue", - "type": "float", - "description": "Growth rate of total revenue.", - "default": "", - "optional": false + "name": "tag", + "type": "str", + "description": "Tag name for the fetched data.", + "default": null, + "optional": true }, { - "name": "growth_cost_of_revenue", + "name": "value", "type": "float", - "description": "Growth rate of cost of goods sold.", - "default": "", - "optional": false - }, + "description": "The value of the data.", + "default": null, + "optional": true + } + ], + "intrinio": [ { - "name": "growth_gross_profit", - "type": "float", - "description": "Growth rate of gross profit.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "growth_gross_profit_ratio", - "type": "float", - "description": "Growth rate of gross profit as a percentage of revenue.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "growth_research_and_development_expenses", - "type": "float", - "description": "Growth rate of expenses on research and development.", - "default": "", - "optional": false + "name": "tag", + "type": "str", + "description": "Tag name for the fetched data.", + "default": null, + "optional": true }, { - "name": "growth_general_and_administrative_expenses", + "name": "value", "type": "float", - "description": "Growth rate of general and administrative expenses.", + "description": "The value of the data.", + "default": null, + "optional": true + } + ] + }, + "model": "HistoricalAttributes" + }, + "/equity/fundamental/income": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the income statement for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.income(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.income(symbol='AAPL', period='annual', limit=5, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", "default": "", "optional": false }, { - "name": "growth_selling_and_marketing_expenses", - "type": "float", - "description": "Growth rate of expenses on selling and marketing activities.", - "default": "", - "optional": false + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true }, { - "name": "growth_other_expenses", - "type": "float", - "description": "Growth rate of other operating expenses.", - "default": "", - "optional": false + "name": "limit", + "type": "Annotated[int, Ge(ge=0)]", + "description": "The number of data entries to return.", + "default": 5, + "optional": true }, { - "name": "growth_operating_expenses", - "type": "float", - "description": "Growth rate of total operating expenses.", - "default": "", - "optional": false - }, - { - "name": "growth_cost_and_expenses", - "type": "float", - "description": "Growth rate of total costs and expenses.", - "default": "", - "optional": false - }, - { - "name": "growth_interest_expense", - "type": "float", - "description": "Growth rate of interest expenses.", - "default": "", - "optional": false - }, - { - "name": "growth_depreciation_and_amortization", - "type": "float", - "description": "Growth rate of depreciation and amortization expenses.", - "default": "", - "optional": false - }, + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ { - "name": "growth_ebitda", - "type": "float", - "description": "Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization.", - "default": "", - "optional": false - }, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true + } + ], + "intrinio": [ { - "name": "growth_ebitda_ratio", - "type": "float", - "description": "Growth rate of EBITDA as a percentage of revenue.", - "default": "", - "optional": false + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", + "description": "None", + "default": "annual", + "optional": true }, { - "name": "growth_operating_income", - "type": "float", - "description": "Growth rate of operating income.", - "default": "", - "optional": false - }, + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", + "default": null, + "optional": true + } + ], + "polygon": [ { - "name": "growth_operating_income_ratio", - "type": "float", - "description": "Growth rate of operating income as a percentage of revenue.", - "default": "", - "optional": false + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm']", + "description": "None", + "default": "annual", + "optional": true }, { - "name": "growth_total_other_income_expenses_net", - "type": "float", - "description": "Growth rate of net total other income and expenses.", - "default": "", - "optional": false + "name": "filing_date", + "type": "date", + "description": "Filing date of the financial statement.", + "default": null, + "optional": true }, { - "name": "growth_income_before_tax", - "type": "float", - "description": "Growth rate of income before taxes.", - "default": "", - "optional": false + "name": "filing_date_lt", + "type": "date", + "description": "Filing date less than the given date.", + "default": null, + "optional": true }, { - "name": "growth_income_before_tax_ratio", - "type": "float", - "description": "Growth rate of income before taxes as a percentage of revenue.", - "default": "", - "optional": false + "name": "filing_date_lte", + "type": "date", + "description": "Filing date less than or equal to the given date.", + "default": null, + "optional": true }, { - "name": "growth_income_tax_expense", - "type": "float", - "description": "Growth rate of income tax expenses.", - "default": "", - "optional": false + "name": "filing_date_gt", + "type": "date", + "description": "Filing date greater than the given date.", + "default": null, + "optional": true }, { - "name": "growth_net_income", - "type": "float", - "description": "Growth rate of net income.", - "default": "", - "optional": false + "name": "filing_date_gte", + "type": "date", + "description": "Filing date greater than or equal to the given date.", + "default": null, + "optional": true }, { - "name": "growth_net_income_ratio", - "type": "float", - "description": "Growth rate of net income as a percentage of revenue.", - "default": "", - "optional": false + "name": "period_of_report_date", + "type": "date", + "description": "Period of report date of the financial statement.", + "default": null, + "optional": true }, { - "name": "growth_eps", - "type": "float", - "description": "Growth rate of Earnings Per Share (EPS).", - "default": "", - "optional": false + "name": "period_of_report_date_lt", + "type": "date", + "description": "Period of report date less than the given date.", + "default": null, + "optional": true }, { - "name": "growth_eps_diluted", - "type": "float", - "description": "Growth rate of diluted Earnings Per Share (EPS).", - "default": "", - "optional": false + "name": "period_of_report_date_lte", + "type": "date", + "description": "Period of report date less than or equal to the given date.", + "default": null, + "optional": true }, { - "name": "growth_weighted_average_shs_out", - "type": "float", - "description": "Growth rate of weighted average shares outstanding.", - "default": "", - "optional": false + "name": "period_of_report_date_gt", + "type": "date", + "description": "Period of report date greater than the given date.", + "default": null, + "optional": true }, { - "name": "growth_weighted_average_shs_out_dil", - "type": "float", - "description": "Growth rate of diluted weighted average shares outstanding.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "IncomeStatementGrowth" - }, - "/equity/fundamental/metrics": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get fundamental metrics for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.metrics(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.metrics(symbol='AAPL', period='annual', limit=100, provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", - "default": "", - "optional": false + "name": "period_of_report_date_gte", + "type": "date", + "description": "Period of report date greater than or equal to the given date.", + "default": null, + "optional": true }, { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "Time period of the data to return.", - "default": "annual", + "name": "include_sources", + "type": "bool", + "description": "Whether to include the sources of the financial statement.", + "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 100, + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order of the financial statement.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'yfinance']", - "description": "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.", - "default": "fmp", + "name": "sort", + "type": "Literal['filing_date', 'period_of_report_date']", + "description": "Sort of the financial statement.", + "default": null, "optional": true } ], - "fmp": [ + "yfinance": [ { - "name": "with_ttm", - "type": "bool", - "description": "Include trailing twelve months (TTM) data.", - "default": false, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", "optional": true } - ], - "intrinio": [], - "yfinance": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[KeyMetrics]", + "type": "List[IncomeStatement]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", "description": "Provider name." }, { @@ -13686,1250 +15073,1151 @@ "data": { "standard": [ { - "name": "symbol", + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false + }, + { + "name": "fiscal_period", "type": "str", - "description": "Symbol representing the entity requested in the data.", + "description": "The fiscal period of the report.", "default": null, "optional": true }, { - "name": "market_cap", - "type": "float", - "description": "Market capitalization", - "default": null, - "optional": true - }, - { - "name": "pe_ratio", - "type": "float", - "description": "Price-to-earnings ratio (P/E ratio)", + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", "default": null, "optional": true } ], "fmp": [ { - "name": "date", + "name": "filing_date", "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "description": "The date when the filing was made.", + "default": null, + "optional": true }, { - "name": "period", - "type": "str", - "description": "Period of the data.", - "default": "", - "optional": false + "name": "accepted_date", + "type": "datetime", + "description": "The date and time when the filing was accepted.", + "default": null, + "optional": true }, { - "name": "calendar_year", - "type": "int", - "description": "Calendar year.", + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet was reported.", "default": null, "optional": true }, { - "name": "revenue_per_share", + "name": "revenue", "type": "float", - "description": "Revenue per share", + "description": "Total revenue.", "default": null, "optional": true }, { - "name": "net_income_per_share", + "name": "cost_of_revenue", "type": "float", - "description": "Net income per share", + "description": "Cost of revenue.", "default": null, "optional": true }, { - "name": "operating_cash_flow_per_share", + "name": "gross_profit", "type": "float", - "description": "Operating cash flow per share", + "description": "Gross profit.", "default": null, "optional": true }, { - "name": "free_cash_flow_per_share", + "name": "gross_profit_margin", "type": "float", - "description": "Free cash flow per share", + "description": "Gross profit margin.", "default": null, "optional": true }, { - "name": "cash_per_share", + "name": "general_and_admin_expense", "type": "float", - "description": "Cash per share", + "description": "General and administrative expenses.", "default": null, "optional": true }, { - "name": "book_value_per_share", + "name": "research_and_development_expense", "type": "float", - "description": "Book value per share", + "description": "Research and development expenses.", "default": null, "optional": true }, { - "name": "tangible_book_value_per_share", + "name": "selling_and_marketing_expense", "type": "float", - "description": "Tangible book value per share", + "description": "Selling and marketing expenses.", "default": null, "optional": true }, { - "name": "shareholders_equity_per_share", + "name": "selling_general_and_admin_expense", "type": "float", - "description": "Shareholders equity per share", + "description": "Selling, general and administrative expenses.", "default": null, "optional": true }, { - "name": "interest_debt_per_share", + "name": "other_expenses", "type": "float", - "description": "Interest debt per share", + "description": "Other expenses.", "default": null, "optional": true }, { - "name": "enterprise_value", + "name": "total_operating_expenses", "type": "float", - "description": "Enterprise value", + "description": "Total operating expenses.", "default": null, "optional": true }, { - "name": "price_to_sales_ratio", + "name": "cost_and_expenses", "type": "float", - "description": "Price-to-sales ratio", + "description": "Cost and expenses.", "default": null, "optional": true }, { - "name": "pocf_ratio", + "name": "interest_income", "type": "float", - "description": "Price-to-operating cash flow ratio", + "description": "Interest income.", "default": null, "optional": true }, { - "name": "pfcf_ratio", + "name": "total_interest_expense", "type": "float", - "description": "Price-to-free cash flow ratio", + "description": "Total interest expenses.", "default": null, "optional": true }, { - "name": "pb_ratio", + "name": "depreciation_and_amortization", "type": "float", - "description": "Price-to-book ratio", + "description": "Depreciation and amortization.", "default": null, "optional": true }, { - "name": "ptb_ratio", + "name": "ebitda", "type": "float", - "description": "Price-to-tangible book ratio", + "description": "EBITDA.", "default": null, "optional": true }, { - "name": "ev_to_sales", + "name": "ebitda_margin", "type": "float", - "description": "Enterprise value-to-sales ratio", + "description": "EBITDA margin.", "default": null, "optional": true }, { - "name": "enterprise_value_over_ebitda", + "name": "total_operating_income", "type": "float", - "description": "Enterprise value-to-EBITDA ratio", + "description": "Total operating income.", "default": null, "optional": true }, { - "name": "ev_to_operating_cash_flow", + "name": "operating_income_margin", "type": "float", - "description": "Enterprise value-to-operating cash flow ratio", + "description": "Operating income margin.", "default": null, "optional": true }, { - "name": "ev_to_free_cash_flow", + "name": "total_other_income_expenses", "type": "float", - "description": "Enterprise value-to-free cash flow ratio", + "description": "Total other income and expenses.", "default": null, "optional": true }, { - "name": "earnings_yield", + "name": "total_pre_tax_income", "type": "float", - "description": "Earnings yield", + "description": "Total pre-tax income.", "default": null, "optional": true }, { - "name": "free_cash_flow_yield", + "name": "pre_tax_income_margin", "type": "float", - "description": "Free cash flow yield", + "description": "Pre-tax income margin.", "default": null, "optional": true }, { - "name": "debt_to_equity", + "name": "income_tax_expense", "type": "float", - "description": "Debt-to-equity ratio", + "description": "Income tax expense.", "default": null, "optional": true }, { - "name": "debt_to_assets", + "name": "consolidated_net_income", "type": "float", - "description": "Debt-to-assets ratio", + "description": "Consolidated net income.", "default": null, "optional": true }, { - "name": "net_debt_to_ebitda", + "name": "net_income_margin", "type": "float", - "description": "Net debt-to-EBITDA ratio", + "description": "Net income margin.", "default": null, "optional": true }, { - "name": "current_ratio", + "name": "basic_earnings_per_share", "type": "float", - "description": "Current ratio", + "description": "Basic earnings per share.", "default": null, "optional": true }, { - "name": "interest_coverage", + "name": "diluted_earnings_per_share", "type": "float", - "description": "Interest coverage", + "description": "Diluted earnings per share.", "default": null, "optional": true }, { - "name": "income_quality", + "name": "weighted_average_basic_shares_outstanding", "type": "float", - "description": "Income quality", + "description": "Weighted average basic shares outstanding.", "default": null, "optional": true }, { - "name": "dividend_yield", + "name": "weighted_average_diluted_shares_outstanding", "type": "float", - "description": "Dividend yield, as a normalized percent.", + "description": "Weighted average diluted shares outstanding.", "default": null, "optional": true }, { - "name": "payout_ratio", - "type": "float", - "description": "Payout ratio", + "name": "link", + "type": "str", + "description": "Link to the filing.", "default": null, "optional": true }, { - "name": "sales_general_and_administrative_to_revenue", - "type": "float", - "description": "Sales general and administrative expenses-to-revenue ratio", + "name": "final_link", + "type": "str", + "description": "Link to the filing document.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "research_and_development_to_revenue", - "type": "float", - "description": "Research and development expenses-to-revenue ratio", + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet is reported.", "default": null, "optional": true }, { - "name": "intangibles_to_total_assets", + "name": "revenue", "type": "float", - "description": "Intangibles-to-total assets ratio", + "description": "Total revenue", "default": null, "optional": true }, { - "name": "capex_to_operating_cash_flow", + "name": "operating_revenue", "type": "float", - "description": "Capital expenditures-to-operating cash flow ratio", + "description": "Total operating revenue", "default": null, "optional": true }, { - "name": "capex_to_revenue", + "name": "cost_of_revenue", "type": "float", - "description": "Capital expenditures-to-revenue ratio", + "description": "Total cost of revenue", "default": null, "optional": true }, { - "name": "capex_to_depreciation", + "name": "operating_cost_of_revenue", "type": "float", - "description": "Capital expenditures-to-depreciation ratio", + "description": "Total operating cost of revenue", "default": null, "optional": true }, { - "name": "stock_based_compensation_to_revenue", + "name": "gross_profit", "type": "float", - "description": "Stock-based compensation-to-revenue ratio", + "description": "Total gross profit", "default": null, "optional": true }, { - "name": "graham_number", + "name": "gross_profit_margin", "type": "float", - "description": "Graham number", + "description": "Gross margin ratio.", "default": null, "optional": true }, { - "name": "roic", + "name": "provision_for_credit_losses", "type": "float", - "description": "Return on invested capital", + "description": "Provision for credit losses", "default": null, "optional": true }, { - "name": "return_on_tangible_assets", + "name": "research_and_development_expense", "type": "float", - "description": "Return on tangible assets", + "description": "Research and development expense", "default": null, "optional": true }, { - "name": "graham_net_net", + "name": "selling_general_and_admin_expense", "type": "float", - "description": "Graham net-net working capital", + "description": "Selling, general, and admin expense", "default": null, "optional": true }, { - "name": "working_capital", + "name": "salaries_and_employee_benefits", "type": "float", - "description": "Working capital", + "description": "Salaries and employee benefits", "default": null, "optional": true }, { - "name": "tangible_asset_value", + "name": "marketing_expense", "type": "float", - "description": "Tangible asset value", + "description": "Marketing expense", "default": null, "optional": true }, { - "name": "net_current_asset_value", + "name": "net_occupancy_and_equipment_expense", "type": "float", - "description": "Net current asset value", + "description": "Net occupancy and equipment expense", "default": null, "optional": true }, { - "name": "invested_capital", + "name": "other_operating_expenses", "type": "float", - "description": "Invested capital", + "description": "Other operating expenses", "default": null, "optional": true }, { - "name": "average_receivables", + "name": "depreciation_expense", "type": "float", - "description": "Average receivables", + "description": "Depreciation expense", "default": null, "optional": true }, { - "name": "average_payables", + "name": "amortization_expense", "type": "float", - "description": "Average payables", + "description": "Amortization expense", "default": null, "optional": true }, { - "name": "average_inventory", + "name": "amortization_of_deferred_policy_acquisition_costs", "type": "float", - "description": "Average inventory", + "description": "Amortization of deferred policy acquisition costs", "default": null, "optional": true }, { - "name": "days_sales_outstanding", + "name": "exploration_expense", "type": "float", - "description": "Days sales outstanding", + "description": "Exploration expense", "default": null, "optional": true }, { - "name": "days_payables_outstanding", + "name": "depletion_expense", "type": "float", - "description": "Days payables outstanding", + "description": "Depletion expense", "default": null, "optional": true }, { - "name": "days_of_inventory_on_hand", + "name": "total_operating_expenses", "type": "float", - "description": "Days of inventory on hand", + "description": "Total operating expenses", "default": null, "optional": true }, { - "name": "receivables_turnover", + "name": "total_operating_income", "type": "float", - "description": "Receivables turnover", + "description": "Total operating income", "default": null, "optional": true }, { - "name": "payables_turnover", + "name": "deposits_and_money_market_investments_interest_income", "type": "float", - "description": "Payables turnover", + "description": "Deposits and money market investments interest income", "default": null, "optional": true }, { - "name": "inventory_turnover", + "name": "federal_funds_sold_and_securities_borrowed_interest_income", "type": "float", - "description": "Inventory turnover", + "description": "Federal funds sold and securities borrowed interest income", "default": null, "optional": true }, { - "name": "roe", + "name": "investment_securities_interest_income", "type": "float", - "description": "Return on equity", + "description": "Investment securities interest income", "default": null, "optional": true }, { - "name": "capex_per_share", + "name": "loans_and_leases_interest_income", "type": "float", - "description": "Capital expenditures per share", + "description": "Loans and leases interest income", "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "price_to_book", + "name": "trading_account_interest_income", "type": "float", - "description": "Price to book ratio.", + "description": "Trading account interest income", "default": null, "optional": true }, { - "name": "price_to_tangible_book", + "name": "other_interest_income", "type": "float", - "description": "Price to tangible book ratio.", + "description": "Other interest income", "default": null, "optional": true }, { - "name": "price_to_revenue", + "name": "total_non_interest_income", "type": "float", - "description": "Price to revenue ratio.", + "description": "Total non-interest income", "default": null, "optional": true }, { - "name": "quick_ratio", + "name": "interest_and_investment_income", "type": "float", - "description": "Quick ratio.", + "description": "Interest and investment income", "default": null, "optional": true }, { - "name": "gross_margin", + "name": "short_term_borrowings_interest_expense", "type": "float", - "description": "Gross margin, as a normalized percent.", + "description": "Short-term borrowings interest expense", "default": null, "optional": true }, { - "name": "ebit_margin", + "name": "long_term_debt_interest_expense", "type": "float", - "description": "EBIT margin, as a normalized percent.", + "description": "Long-term debt interest expense", "default": null, "optional": true }, { - "name": "profit_margin", + "name": "capitalized_lease_obligations_interest_expense", "type": "float", - "description": "Profit margin, as a normalized percent.", + "description": "Capitalized lease obligations interest expense", "default": null, "optional": true }, { - "name": "eps", + "name": "deposits_interest_expense", "type": "float", - "description": "Basic earnings per share.", + "description": "Deposits interest expense", "default": null, "optional": true }, { - "name": "eps_growth", + "name": "federal_funds_purchased_and_securities_sold_interest_expense", "type": "float", - "description": "EPS growth, as a normalized percent.", + "description": "Federal funds purchased and securities sold interest expense", "default": null, "optional": true }, { - "name": "revenue_growth", + "name": "other_interest_expense", "type": "float", - "description": "Revenue growth, as a normalized percent.", + "description": "Other interest expense", "default": null, "optional": true }, { - "name": "ebitda_growth", + "name": "total_interest_expense", "type": "float", - "description": "EBITDA growth, as a normalized percent.", + "description": "Total interest expense", "default": null, "optional": true }, { - "name": "ebit_growth", + "name": "net_interest_income", "type": "float", - "description": "EBIT growth, as a normalized percent.", + "description": "Net interest income", "default": null, "optional": true }, { - "name": "net_income_growth", + "name": "other_non_interest_income", "type": "float", - "description": "Net income growth, as a normalized percent.", + "description": "Other non-interest income", "default": null, "optional": true }, { - "name": "free_cash_flow_to_firm_growth", + "name": "investment_banking_income", "type": "float", - "description": "Free cash flow to firm growth, as a normalized percent.", + "description": "Investment banking income", "default": null, "optional": true }, { - "name": "invested_capital_growth", + "name": "trust_fees_by_commissions", "type": "float", - "description": "Invested capital growth, as a normalized percent.", + "description": "Trust fees by commissions", "default": null, "optional": true }, { - "name": "return_on_assets", + "name": "premiums_earned", "type": "float", - "description": "Return on assets, as a normalized percent.", + "description": "Premiums earned", "default": null, "optional": true }, { - "name": "return_on_equity", + "name": "insurance_policy_acquisition_costs", "type": "float", - "description": "Return on equity, as a normalized percent.", + "description": "Insurance policy acquisition costs", "default": null, "optional": true }, { - "name": "return_on_invested_capital", + "name": "current_and_future_benefits", "type": "float", - "description": "Return on invested capital, as a normalized percent.", + "description": "Current and future benefits", "default": null, "optional": true }, { - "name": "ebitda", - "type": "int", - "description": "Earnings before interest, taxes, depreciation, and amortization.", + "name": "property_and_liability_insurance_claims", + "type": "float", + "description": "Property and liability insurance claims", "default": null, "optional": true }, { - "name": "ebit", - "type": "int", - "description": "Earnings before interest and taxes.", + "name": "total_non_interest_expense", + "type": "float", + "description": "Total non-interest expense", "default": null, "optional": true }, { - "name": "long_term_debt", - "type": "int", - "description": "Long-term debt.", + "name": "net_realized_and_unrealized_capital_gains_on_investments", + "type": "float", + "description": "Net realized and unrealized capital gains on investments", "default": null, "optional": true }, { - "name": "total_debt", - "type": "int", - "description": "Total debt.", + "name": "other_gains", + "type": "float", + "description": "Other gains", "default": null, "optional": true }, { - "name": "total_capital", - "type": "int", - "description": "The sum of long-term debt and total shareholder equity.", + "name": "non_operating_income", + "type": "float", + "description": "Non-operating income", "default": null, "optional": true }, { - "name": "enterprise_value", - "type": "int", - "description": "Enterprise value.", + "name": "other_income", + "type": "float", + "description": "Other income", "default": null, "optional": true }, { - "name": "free_cash_flow_to_firm", - "type": "int", - "description": "Free cash flow to firm.", + "name": "other_revenue", + "type": "float", + "description": "Other revenue", "default": null, "optional": true }, { - "name": "altman_z_score", + "name": "extraordinary_income", "type": "float", - "description": "Altman Z-score.", + "description": "Extraordinary income", "default": null, "optional": true }, { - "name": "beta", + "name": "total_other_income", "type": "float", - "description": "Beta relative to the broad market (rolling three-year).", + "description": "Total other income", "default": null, "optional": true }, { - "name": "dividend_yield", + "name": "ebitda", "type": "float", - "description": "Dividend yield, as a normalized percent.", + "description": "Earnings Before Interest, Taxes, Depreciation and Amortization.", "default": null, "optional": true }, { - "name": "earnings_yield", + "name": "ebitda_margin", "type": "float", - "description": "Earnings yield, as a normalized percent.", + "description": "Margin on Earnings Before Interest, Taxes, Depreciation and Amortization.", "default": null, "optional": true }, { - "name": "last_price", + "name": "total_pre_tax_income", "type": "float", - "description": "Last price of the stock.", + "description": "Total pre-tax income", "default": null, "optional": true }, { - "name": "year_high", + "name": "ebit", "type": "float", - "description": "52 week high", + "description": "Earnings Before Interest and Taxes.", "default": null, "optional": true }, { - "name": "year_low", + "name": "pre_tax_income_margin", "type": "float", - "description": "52 week low", + "description": "Pre-Tax Income Margin.", "default": null, "optional": true }, { - "name": "volume_avg", - "type": "int", - "description": "Average daily volume.", + "name": "income_tax_expense", + "type": "float", + "description": "Income tax expense", "default": null, "optional": true }, { - "name": "short_interest", - "type": "int", - "description": "Number of shares reported as sold short.", + "name": "impairment_charge", + "type": "float", + "description": "Impairment charge", "default": null, "optional": true }, { - "name": "shares_outstanding", - "type": "int", - "description": "Weighted average shares outstanding (TTM).", + "name": "restructuring_charge", + "type": "float", + "description": "Restructuring charge", "default": null, "optional": true }, { - "name": "days_to_cover", + "name": "service_charges_on_deposit_accounts", "type": "float", - "description": "Days to cover short interest, based on average daily volume.", + "description": "Service charges on deposit accounts", "default": null, "optional": true - } - ], - "yfinance": [ + }, { - "name": "forward_pe", + "name": "other_service_charges", "type": "float", - "description": "Forward price-to-earnings ratio.", + "description": "Other service charges", "default": null, "optional": true }, { - "name": "peg_ratio", + "name": "other_special_charges", "type": "float", - "description": "PEG ratio (5-year expected).", + "description": "Other special charges", "default": null, "optional": true }, { - "name": "peg_ratio_ttm", + "name": "other_cost_of_revenue", "type": "float", - "description": "PEG ratio (TTM).", + "description": "Other cost of revenue", "default": null, "optional": true }, { - "name": "eps_ttm", + "name": "net_income_continuing_operations", "type": "float", - "description": "Earnings per share (TTM).", + "description": "Net income (continuing operations)", "default": null, "optional": true }, { - "name": "eps_forward", + "name": "net_income_discontinued_operations", "type": "float", - "description": "Forward earnings per share.", + "description": "Net income (discontinued operations)", "default": null, "optional": true }, { - "name": "enterprise_to_ebitda", + "name": "consolidated_net_income", "type": "float", - "description": "Enterprise value to EBITDA ratio.", + "description": "Consolidated net income", "default": null, "optional": true }, { - "name": "earnings_growth", + "name": "other_adjustments_to_consolidated_net_income", "type": "float", - "description": "Earnings growth (Year Over Year), as a normalized percent.", + "description": "Other adjustments to consolidated net income", "default": null, "optional": true }, { - "name": "earnings_growth_quarterly", + "name": "other_adjustment_to_net_income_attributable_to_common_shareholders", "type": "float", - "description": "Quarterly earnings growth (Year Over Year), as a normalized percent.", + "description": "Other adjustment to net income attributable to common shareholders", "default": null, "optional": true }, { - "name": "revenue_per_share", + "name": "net_income_attributable_to_noncontrolling_interest", "type": "float", - "description": "Revenue per share (TTM).", + "description": "Net income attributable to noncontrolling interest", "default": null, "optional": true }, { - "name": "revenue_growth", + "name": "net_income_attributable_to_common_shareholders", "type": "float", - "description": "Revenue growth (Year Over Year), as a normalized percent.", + "description": "Net income attributable to common shareholders", "default": null, "optional": true }, { - "name": "enterprise_to_revenue", + "name": "basic_earnings_per_share", "type": "float", - "description": "Enterprise value to revenue ratio.", + "description": "Basic earnings per share", "default": null, "optional": true }, { - "name": "cash_per_share", + "name": "diluted_earnings_per_share", "type": "float", - "description": "Cash per share.", + "description": "Diluted earnings per share", "default": null, "optional": true }, { - "name": "quick_ratio", + "name": "basic_and_diluted_earnings_per_share", "type": "float", - "description": "Quick ratio.", + "description": "Basic and diluted earnings per share", "default": null, "optional": true }, { - "name": "current_ratio", + "name": "cash_dividends_to_common_per_share", "type": "float", - "description": "Current ratio.", + "description": "Cash dividends to common per share", "default": null, "optional": true }, { - "name": "debt_to_equity", + "name": "preferred_stock_dividends_declared", "type": "float", - "description": "Debt-to-equity ratio.", + "description": "Preferred stock dividends declared", "default": null, "optional": true }, { - "name": "gross_margin", + "name": "weighted_average_basic_shares_outstanding", "type": "float", - "description": "Gross margin, as a normalized percent.", + "description": "Weighted average basic shares outstanding", "default": null, "optional": true }, { - "name": "operating_margin", + "name": "weighted_average_diluted_shares_outstanding", "type": "float", - "description": "Operating margin, as a normalized percent.", + "description": "Weighted average diluted shares outstanding", "default": null, "optional": true }, { - "name": "ebitda_margin", + "name": "weighted_average_basic_and_diluted_shares_outstanding", "type": "float", - "description": "EBITDA margin, as a normalized percent.", + "description": "Weighted average basic and diluted shares outstanding", "default": null, "optional": true - }, + } + ], + "polygon": [ { - "name": "profit_margin", + "name": "revenue", "type": "float", - "description": "Profit margin, as a normalized percent.", + "description": "Total Revenue", "default": null, "optional": true }, { - "name": "return_on_assets", + "name": "cost_of_revenue_goods", "type": "float", - "description": "Return on assets, as a normalized percent.", + "description": "Cost of Revenue - Goods", "default": null, "optional": true }, { - "name": "return_on_equity", + "name": "cost_of_revenue_services", "type": "float", - "description": "Return on equity, as a normalized percent.", + "description": "Cost of Revenue - Services", "default": null, "optional": true }, { - "name": "dividend_yield", + "name": "cost_of_revenue", "type": "float", - "description": "Dividend yield, as a normalized percent.", + "description": "Cost of Revenue", "default": null, "optional": true }, { - "name": "dividend_yield_5y_avg", + "name": "gross_profit", "type": "float", - "description": "5-year average dividend yield, as a normalized percent.", + "description": "Gross Profit", "default": null, "optional": true }, { - "name": "payout_ratio", + "name": "provisions_for_loan_lease_and_other_losses", "type": "float", - "description": "Payout ratio.", + "description": "Provisions for loan lease and other losses", "default": null, "optional": true }, { - "name": "book_value", + "name": "depreciation_and_amortization", "type": "float", - "description": "Book value per share.", + "description": "Depreciation and Amortization", "default": null, "optional": true }, { - "name": "price_to_book", + "name": "income_tax_expense_benefit_current", "type": "float", - "description": "Price-to-book ratio.", + "description": "Income tax expense benefit current", "default": null, "optional": true }, { - "name": "enterprise_value", - "type": "int", - "description": "Enterprise value.", + "name": "deferred_tax_benefit", + "type": "float", + "description": "Deferred tax benefit", "default": null, "optional": true }, { - "name": "overall_risk", + "name": "benefits_costs_expenses", "type": "float", - "description": "Overall risk score.", + "description": "Benefits, costs and expenses", "default": null, "optional": true }, { - "name": "audit_risk", + "name": "selling_general_and_administrative_expense", "type": "float", - "description": "Audit risk score.", + "description": "Selling, general and administrative expense", "default": null, "optional": true }, { - "name": "board_risk", + "name": "research_and_development", "type": "float", - "description": "Board risk score.", + "description": "Research and development", "default": null, "optional": true }, { - "name": "compensation_risk", + "name": "costs_and_expenses", "type": "float", - "description": "Compensation risk score.", + "description": "Costs and expenses", "default": null, "optional": true }, { - "name": "shareholder_rights_risk", + "name": "other_operating_expenses", "type": "float", - "description": "Shareholder rights risk score.", + "description": "Other Operating Expenses", "default": null, "optional": true }, { - "name": "beta", + "name": "operating_expenses", "type": "float", - "description": "Beta relative to the broad market (5-year monthly).", + "description": "Operating expenses", "default": null, "optional": true }, { - "name": "price_return_1y", + "name": "operating_income", "type": "float", - "description": "One-year price return, as a normalized percent.", + "description": "Operating Income/Loss", "default": null, "optional": true }, { - "name": "currency", - "type": "str", - "description": "Currency in which the data is presented.", + "name": "non_operating_income", + "type": "float", + "description": "Non Operating Income/Loss", "default": null, "optional": true - } - ] - }, - "model": "KeyMetrics" - }, - "/equity/fundamental/management": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get executive management team data for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.management(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "provider", - "type": "Literal['fmp', 'yfinance']", - "description": "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.", - "default": "fmp", + "name": "interest_and_dividend_income", + "type": "float", + "description": "Interest and Dividend Income", + "default": null, "optional": true - } - ], - "fmp": [], - "yfinance": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[KeyExecutives]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp', 'yfinance']]", - "description": "Provider name." + "name": "total_interest_expense", + "type": "float", + "description": "Interest Expense", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "interest_and_debt_expense", + "type": "float", + "description": "Interest and Debt Expense", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "net_interest_income", + "type": "float", + "description": "Interest Income Net", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "title", - "type": "str", - "description": "Designation of the key executive.", - "default": "", - "optional": false + "name": "interest_income_after_provision_for_losses", + "type": "float", + "description": "Interest Income After Provision for Losses", + "default": null, + "optional": true }, { - "name": "name", - "type": "str", - "description": "Name of the key executive.", - "default": "", - "optional": false + "name": "non_interest_expense", + "type": "float", + "description": "Non-Interest Expense", + "default": null, + "optional": true }, { - "name": "pay", - "type": "int", - "description": "Pay of the key executive.", + "name": "non_interest_income", + "type": "float", + "description": "Non-Interest Income", "default": null, "optional": true }, { - "name": "currency_pay", - "type": "str", - "description": "Currency of the pay.", + "name": "income_from_discontinued_operations_net_of_tax_on_disposal", + "type": "float", + "description": "Income From Discontinued Operations Net of Tax on Disposal", "default": null, "optional": true }, { - "name": "gender", - "type": "str", - "description": "Gender of the key executive.", + "name": "income_from_discontinued_operations_net_of_tax", + "type": "float", + "description": "Income From Discontinued Operations Net of Tax", "default": null, "optional": true }, { - "name": "year_born", - "type": "int", - "description": "Birth year of the key executive.", + "name": "income_before_equity_method_investments", + "type": "float", + "description": "Income Before Equity Method Investments", "default": null, "optional": true }, { - "name": "title_since", - "type": "int", - "description": "Date the tile was held since.", + "name": "income_from_equity_method_investments", + "type": "float", + "description": "Income From Equity Method Investments", "default": null, "optional": true - } - ], - "fmp": [], - "yfinance": [ + }, { - "name": "exercised_value", - "type": "int", - "description": "Value of shares exercised.", + "name": "total_pre_tax_income", + "type": "float", + "description": "Income Before Tax", "default": null, "optional": true }, { - "name": "unexercised_value", - "type": "int", - "description": "Value of shares not exercised.", + "name": "income_tax_expense", + "type": "float", + "description": "Income Tax Expense", "default": null, "optional": true - } - ] - }, - "model": "KeyExecutives" - }, - "/equity/fundamental/management_compensation": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get executive management team compensation for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.management_compensation(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", - "default": "", - "optional": false }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", + "name": "income_after_tax", + "type": "float", + "description": "Income After Tax", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "year", - "type": "int", - "description": "Year of the compensation.", + "name": "consolidated_net_income", + "type": "float", + "description": "Net Income/Loss", "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[ExecutiveCompensation]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "cik", - "type": "str", - "description": "Central Index Key (CIK) for the requested entity.", + "name": "net_income_attributable_noncontrolling_interest", + "type": "float", + "description": "Net income (loss) attributable to noncontrolling interest", "default": null, "optional": true }, { - "name": "company_name", - "type": "str", - "description": "The name of the company.", + "name": "net_income_attributable_to_parent", + "type": "float", + "description": "Net income (loss) attributable to parent", "default": null, "optional": true }, { - "name": "industry", - "type": "str", - "description": "The industry of the company.", + "name": "net_income_attributable_to_common_shareholders", + "type": "float", + "description": "Net Income/Loss Available To Common Stockholders Basic", "default": null, "optional": true }, { - "name": "year", - "type": "int", - "description": "Year of the compensation.", + "name": "participating_securities_earnings", + "type": "float", + "description": "Participating Securities Distributed And Undistributed Earnings Loss Basic", "default": null, "optional": true }, { - "name": "name_and_position", - "type": "str", - "description": "Name and position.", + "name": "undistributed_earnings_allocated_to_participating_securities", + "type": "float", + "description": "Undistributed Earnings Allocated To Participating Securities", "default": null, "optional": true }, { - "name": "salary", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Salary.", + "name": "common_stock_dividends", + "type": "float", + "description": "Common Stock Dividends", "default": null, "optional": true }, { - "name": "bonus", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Bonus payments.", + "name": "preferred_stock_dividends_and_other_adjustments", + "type": "float", + "description": "Preferred stock dividends and other adjustments", "default": null, "optional": true }, { - "name": "stock_award", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Stock awards.", + "name": "basic_earnings_per_share", + "type": "float", + "description": "Earnings Per Share", "default": null, "optional": true }, { - "name": "incentive_plan_compensation", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Incentive plan compensation.", + "name": "diluted_earnings_per_share", + "type": "float", + "description": "Diluted Earnings Per Share", "default": null, "optional": true }, { - "name": "all_other_compensation", - "type": "Annotated[float, Ge(ge=0)]", - "description": "All other compensation.", + "name": "weighted_average_basic_shares_outstanding", + "type": "float", + "description": "Basic Average Shares", "default": null, "optional": true }, { - "name": "total", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Total compensation.", + "name": "weighted_average_diluted_shares_outstanding", + "type": "float", + "description": "Diluted Average Shares", "default": null, "optional": true } ], - "fmp": [ + "yfinance": [ { - "name": "filing_date", + "name": "period_ending", "type": "date", - "description": "Date of the filing.", - "default": null, - "optional": true + "description": "The end date of the reporting period.", + "default": "", + "optional": false }, { - "name": "accepted_date", - "type": "datetime", - "description": "Date the filing was accepted.", + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", "default": null, "optional": true }, { - "name": "url", - "type": "str", - "description": "URL to the filing data.", + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", "default": null, "optional": true } ] }, - "model": "ExecutiveCompensation" + "model": "IncomeStatement" }, - "/equity/fundamental/overview": { + "/equity/fundamental/income_growth": { "deprecated": { - "flag": true, - "message": "This endpoint is deprecated; use `/equity/profile` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.3." + "flag": null, + "message": null }, - "description": "Get company general business and stock data for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.overview(symbol='AAPL', provider='fmp')\n```\n\n", + "description": "Get the growth of a company's income statement items over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.income_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.income_growth(symbol='AAPL', limit=10, period='annual', provider='fmp')\n```\n\n", "parameters": { "standard": [ { @@ -14939,6 +16227,20 @@ "default": "", "optional": false }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10, + "optional": true + }, + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, { "name": "provider", "type": "Literal['fmp']", @@ -14947,13 +16249,35 @@ "optional": true } ], - "fmp": [] + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10, + "optional": true + }, + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + } + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[CompanyOverview]", + "type": "List[IncomeStatementGrowth]", "description": "Serializable results." }, { @@ -14984,1483 +16308,1480 @@ "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "price", - "type": "float", - "description": "Price of the company.", - "default": null, - "optional": true + "name": "period", + "type": "str", + "description": "Period the statement is returned for.", + "default": "", + "optional": false }, { - "name": "beta", + "name": "growth_revenue", "type": "float", - "description": "Beta of the company.", - "default": null, - "optional": true + "description": "Growth rate of total revenue.", + "default": "", + "optional": false }, { - "name": "vol_avg", - "type": "int", - "description": "Volume average of the company.", - "default": null, - "optional": true + "name": "growth_cost_of_revenue", + "type": "float", + "description": "Growth rate of cost of goods sold.", + "default": "", + "optional": false }, { - "name": "mkt_cap", - "type": "int", - "description": "Market capitalization of the company.", - "default": null, - "optional": true + "name": "growth_gross_profit", + "type": "float", + "description": "Growth rate of gross profit.", + "default": "", + "optional": false }, { - "name": "last_div", + "name": "growth_gross_profit_ratio", "type": "float", - "description": "Last dividend of the company.", - "default": null, - "optional": true + "description": "Growth rate of gross profit as a percentage of revenue.", + "default": "", + "optional": false }, { - "name": "range", - "type": "str", - "description": "Range of the company.", - "default": null, - "optional": true + "name": "growth_research_and_development_expenses", + "type": "float", + "description": "Growth rate of expenses on research and development.", + "default": "", + "optional": false }, { - "name": "changes", + "name": "growth_general_and_administrative_expenses", "type": "float", - "description": "Changes of the company.", - "default": null, - "optional": true + "description": "Growth rate of general and administrative expenses.", + "default": "", + "optional": false }, { - "name": "company_name", - "type": "str", - "description": "Company name of the company.", - "default": null, - "optional": true + "name": "growth_selling_and_marketing_expenses", + "type": "float", + "description": "Growth rate of expenses on selling and marketing activities.", + "default": "", + "optional": false }, { - "name": "currency", - "type": "str", - "description": "Currency of the company.", - "default": null, - "optional": true - }, - { - "name": "cik", - "type": "str", - "description": "Central Index Key (CIK) for the requested entity.", - "default": null, - "optional": true + "name": "growth_other_expenses", + "type": "float", + "description": "Growth rate of other operating expenses.", + "default": "", + "optional": false }, { - "name": "isin", - "type": "str", - "description": "ISIN of the company.", - "default": null, - "optional": true + "name": "growth_operating_expenses", + "type": "float", + "description": "Growth rate of total operating expenses.", + "default": "", + "optional": false }, { - "name": "cusip", - "type": "str", - "description": "CUSIP of the company.", - "default": null, - "optional": true + "name": "growth_cost_and_expenses", + "type": "float", + "description": "Growth rate of total costs and expenses.", + "default": "", + "optional": false }, { - "name": "exchange", - "type": "str", - "description": "Exchange of the company.", - "default": null, - "optional": true + "name": "growth_interest_expense", + "type": "float", + "description": "Growth rate of interest expenses.", + "default": "", + "optional": false }, { - "name": "exchange_short_name", - "type": "str", - "description": "Exchange short name of the company.", - "default": null, - "optional": true + "name": "growth_depreciation_and_amortization", + "type": "float", + "description": "Growth rate of depreciation and amortization expenses.", + "default": "", + "optional": false }, { - "name": "industry", - "type": "str", - "description": "Industry of the company.", - "default": null, - "optional": true + "name": "growth_ebitda", + "type": "float", + "description": "Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization.", + "default": "", + "optional": false }, { - "name": "website", - "type": "str", - "description": "Website of the company.", - "default": null, - "optional": true + "name": "growth_ebitda_ratio", + "type": "float", + "description": "Growth rate of EBITDA as a percentage of revenue.", + "default": "", + "optional": false }, { - "name": "description", - "type": "str", - "description": "Description of the company.", - "default": null, - "optional": true + "name": "growth_operating_income", + "type": "float", + "description": "Growth rate of operating income.", + "default": "", + "optional": false }, { - "name": "ceo", - "type": "str", - "description": "CEO of the company.", - "default": null, - "optional": true + "name": "growth_operating_income_ratio", + "type": "float", + "description": "Growth rate of operating income as a percentage of revenue.", + "default": "", + "optional": false }, { - "name": "sector", - "type": "str", - "description": "Sector of the company.", - "default": null, - "optional": true + "name": "growth_total_other_income_expenses_net", + "type": "float", + "description": "Growth rate of net total other income and expenses.", + "default": "", + "optional": false }, { - "name": "country", - "type": "str", - "description": "Country of the company.", - "default": null, - "optional": true + "name": "growth_income_before_tax", + "type": "float", + "description": "Growth rate of income before taxes.", + "default": "", + "optional": false }, { - "name": "full_time_employees", - "type": "str", - "description": "Full time employees of the company.", - "default": null, - "optional": true + "name": "growth_income_before_tax_ratio", + "type": "float", + "description": "Growth rate of income before taxes as a percentage of revenue.", + "default": "", + "optional": false }, { - "name": "phone", - "type": "str", - "description": "Phone of the company.", - "default": null, - "optional": true + "name": "growth_income_tax_expense", + "type": "float", + "description": "Growth rate of income tax expenses.", + "default": "", + "optional": false }, { - "name": "address", - "type": "str", - "description": "Address of the company.", - "default": null, - "optional": true + "name": "growth_net_income", + "type": "float", + "description": "Growth rate of net income.", + "default": "", + "optional": false }, { - "name": "city", - "type": "str", - "description": "City of the company.", - "default": null, - "optional": true + "name": "growth_net_income_ratio", + "type": "float", + "description": "Growth rate of net income as a percentage of revenue.", + "default": "", + "optional": false }, { - "name": "state", - "type": "str", - "description": "State of the company.", - "default": null, - "optional": true + "name": "growth_eps", + "type": "float", + "description": "Growth rate of Earnings Per Share (EPS).", + "default": "", + "optional": false }, { - "name": "zip", - "type": "str", - "description": "Zip of the company.", - "default": null, - "optional": true + "name": "growth_eps_diluted", + "type": "float", + "description": "Growth rate of diluted Earnings Per Share (EPS).", + "default": "", + "optional": false }, { - "name": "dcf_diff", + "name": "growth_weighted_average_shs_out", "type": "float", - "description": "Discounted cash flow difference of the company.", - "default": null, - "optional": true + "description": "Growth rate of weighted average shares outstanding.", + "default": "", + "optional": false }, { - "name": "dcf", + "name": "growth_weighted_average_shs_out_dil", "type": "float", - "description": "Discounted cash flow of the company.", - "default": null, - "optional": true - }, + "description": "Growth rate of diluted weighted average shares outstanding.", + "default": "", + "optional": false + } + ], + "fmp": [ { - "name": "image", + "name": "symbol", "type": "str", - "description": "Image of the company.", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "ipo_date", + "name": "date", "type": "date", - "description": "IPO date of the company.", - "default": null, - "optional": true - }, - { - "name": "default_image", - "type": "bool", - "description": "If the image is the default image.", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "is_etf", - "type": "bool", - "description": "If the company is an ETF.", + "name": "period", + "type": "str", + "description": "Period the statement is returned for.", "default": "", "optional": false }, { - "name": "is_actively_trading", - "type": "bool", - "description": "If the company is actively trading.", + "name": "growth_revenue", + "type": "float", + "description": "Growth rate of total revenue.", "default": "", "optional": false }, { - "name": "is_adr", - "type": "bool", - "description": "If the company is an ADR.", + "name": "growth_cost_of_revenue", + "type": "float", + "description": "Growth rate of cost of goods sold.", "default": "", "optional": false }, { - "name": "is_fund", - "type": "bool", - "description": "If the company is a fund.", + "name": "growth_gross_profit", + "type": "float", + "description": "Growth rate of gross profit.", "default": "", "optional": false - } - ], - "fmp": [] - }, - "model": "CompanyOverview" - }, - "/equity/fundamental/ratios": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get an extensive set of financial and accounting ratios for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.ratios(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.ratios(symbol='AAPL', period='annual', limit=12, provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "name": "growth_gross_profit_ratio", + "type": "float", + "description": "Growth rate of gross profit as a percentage of revenue.", "default": "", "optional": false }, { - "name": "period", - "type": "str", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 12, - "optional": true + "name": "growth_research_and_development_expenses", + "type": "float", + "description": "Growth rate of expenses on research and development.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio']", - "description": "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.", - "default": "fmp", - "optional": true - } - ], - "fmp": [], - "intrinio": [ - { - "name": "fiscal_year", - "type": "int", - "description": "The specific fiscal year. Reports do not go beyond 2008.", - "default": null, - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[FinancialRatios]", - "description": "Serializable results." + "name": "growth_general_and_administrative_expenses", + "type": "float", + "description": "Growth rate of general and administrative expenses.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio']]", - "description": "Provider name." + "name": "growth_selling_and_marketing_expenses", + "type": "float", + "description": "Growth rate of expenses on selling and marketing activities.", + "default": "", + "optional": false }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "growth_other_expenses", + "type": "float", + "description": "Growth rate of other operating expenses.", + "default": "", + "optional": false }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "growth_operating_expenses", + "type": "float", + "description": "Growth rate of total operating expenses.", + "default": "", + "optional": false }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "period_ending", - "type": "str", - "description": "The date of the data.", + "name": "growth_cost_and_expenses", + "type": "float", + "description": "Growth rate of total costs and expenses.", "default": "", "optional": false }, { - "name": "fiscal_period", - "type": "str", - "description": "Period of the financial ratios.", + "name": "growth_interest_expense", + "type": "float", + "description": "Growth rate of interest expenses.", "default": "", "optional": false }, { - "name": "fiscal_year", - "type": "int", - "description": "Fiscal year.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "current_ratio", + "name": "growth_depreciation_and_amortization", "type": "float", - "description": "Current ratio.", - "default": null, - "optional": true + "description": "Growth rate of depreciation and amortization expenses.", + "default": "", + "optional": false }, { - "name": "quick_ratio", + "name": "growth_ebitda", "type": "float", - "description": "Quick ratio.", - "default": null, - "optional": true + "description": "Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization.", + "default": "", + "optional": false }, { - "name": "cash_ratio", + "name": "growth_ebitda_ratio", "type": "float", - "description": "Cash ratio.", - "default": null, - "optional": true + "description": "Growth rate of EBITDA as a percentage of revenue.", + "default": "", + "optional": false }, { - "name": "days_of_sales_outstanding", + "name": "growth_operating_income", "type": "float", - "description": "Days of sales outstanding.", - "default": null, - "optional": true + "description": "Growth rate of operating income.", + "default": "", + "optional": false }, { - "name": "days_of_inventory_outstanding", + "name": "growth_operating_income_ratio", "type": "float", - "description": "Days of inventory outstanding.", - "default": null, - "optional": true + "description": "Growth rate of operating income as a percentage of revenue.", + "default": "", + "optional": false }, { - "name": "operating_cycle", + "name": "growth_total_other_income_expenses_net", "type": "float", - "description": "Operating cycle.", - "default": null, - "optional": true + "description": "Growth rate of net total other income and expenses.", + "default": "", + "optional": false }, { - "name": "days_of_payables_outstanding", + "name": "growth_income_before_tax", "type": "float", - "description": "Days of payables outstanding.", - "default": null, - "optional": true + "description": "Growth rate of income before taxes.", + "default": "", + "optional": false }, { - "name": "cash_conversion_cycle", + "name": "growth_income_before_tax_ratio", "type": "float", - "description": "Cash conversion cycle.", - "default": null, - "optional": true + "description": "Growth rate of income before taxes as a percentage of revenue.", + "default": "", + "optional": false }, { - "name": "gross_profit_margin", + "name": "growth_income_tax_expense", "type": "float", - "description": "Gross profit margin.", - "default": null, - "optional": true + "description": "Growth rate of income tax expenses.", + "default": "", + "optional": false }, { - "name": "operating_profit_margin", + "name": "growth_net_income", "type": "float", - "description": "Operating profit margin.", - "default": null, - "optional": true + "description": "Growth rate of net income.", + "default": "", + "optional": false }, { - "name": "pretax_profit_margin", + "name": "growth_net_income_ratio", "type": "float", - "description": "Pretax profit margin.", - "default": null, - "optional": true + "description": "Growth rate of net income as a percentage of revenue.", + "default": "", + "optional": false }, { - "name": "net_profit_margin", + "name": "growth_eps", "type": "float", - "description": "Net profit margin.", - "default": null, - "optional": true + "description": "Growth rate of Earnings Per Share (EPS).", + "default": "", + "optional": false }, { - "name": "effective_tax_rate", + "name": "growth_eps_diluted", "type": "float", - "description": "Effective tax rate.", - "default": null, - "optional": true + "description": "Growth rate of diluted Earnings Per Share (EPS).", + "default": "", + "optional": false }, { - "name": "return_on_assets", + "name": "growth_weighted_average_shs_out", "type": "float", - "description": "Return on assets.", - "default": null, - "optional": true + "description": "Growth rate of weighted average shares outstanding.", + "default": "", + "optional": false }, { - "name": "return_on_equity", + "name": "growth_weighted_average_shs_out_dil", "type": "float", - "description": "Return on equity.", - "default": null, - "optional": true + "description": "Growth rate of diluted weighted average shares outstanding.", + "default": "", + "optional": false + } + ] + }, + "model": "IncomeStatementGrowth" + }, + "/equity/fundamental/metrics": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get fundamental metrics for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.metrics(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.metrics(symbol='AAPL', period='annual', limit=100, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "return_on_capital_employed", - "type": "float", - "description": "Return on capital employed.", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "Time period of the data to return.", + "default": "annual", "optional": true }, { - "name": "net_income_per_ebt", - "type": "float", - "description": "Net income per EBT.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100, "optional": true }, { - "name": "ebt_per_ebit", - "type": "float", - "description": "EBT per EBIT.", - "default": null, + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "with_ttm", + "type": "bool", + "description": "Include trailing twelve months (TTM) data.", + "default": false, "optional": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "ebit_per_revenue", - "type": "float", - "description": "EBIT per revenue.", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "Time period of the data to return.", + "default": "annual", "optional": true }, { - "name": "debt_ratio", - "type": "float", - "description": "Debt ratio.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100, + "optional": true + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "Time period of the data to return.", + "default": "annual", "optional": true }, { - "name": "debt_equity_ratio", - "type": "float", - "description": "Debt equity ratio.", + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[KeyMetrics]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "long_term_debt_to_capitalization", + "name": "market_cap", "type": "float", - "description": "Long term debt to capitalization.", + "description": "Market capitalization", "default": null, "optional": true }, { - "name": "total_debt_to_capitalization", + "name": "pe_ratio", "type": "float", - "description": "Total debt to capitalization.", + "description": "Price-to-earnings ratio (P/E ratio)", "default": null, "optional": true + } + ], + "fmp": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "interest_coverage", - "type": "float", - "description": "Interest coverage.", + "name": "period", + "type": "str", + "description": "Period of the data.", + "default": "", + "optional": false + }, + { + "name": "calendar_year", + "type": "int", + "description": "Calendar year.", "default": null, "optional": true }, { - "name": "cash_flow_to_debt_ratio", + "name": "revenue_per_share", "type": "float", - "description": "Cash flow to debt ratio.", + "description": "Revenue per share", "default": null, "optional": true }, { - "name": "company_equity_multiplier", + "name": "net_income_per_share", "type": "float", - "description": "Company equity multiplier.", + "description": "Net income per share", "default": null, "optional": true }, { - "name": "receivables_turnover", + "name": "operating_cash_flow_per_share", "type": "float", - "description": "Receivables turnover.", + "description": "Operating cash flow per share", "default": null, "optional": true }, { - "name": "payables_turnover", + "name": "free_cash_flow_per_share", "type": "float", - "description": "Payables turnover.", + "description": "Free cash flow per share", "default": null, "optional": true }, { - "name": "inventory_turnover", + "name": "cash_per_share", "type": "float", - "description": "Inventory turnover.", + "description": "Cash per share", "default": null, "optional": true }, { - "name": "fixed_asset_turnover", + "name": "book_value_per_share", "type": "float", - "description": "Fixed asset turnover.", + "description": "Book value per share", "default": null, "optional": true }, { - "name": "asset_turnover", + "name": "tangible_book_value_per_share", "type": "float", - "description": "Asset turnover.", + "description": "Tangible book value per share", "default": null, "optional": true }, { - "name": "operating_cash_flow_per_share", + "name": "shareholders_equity_per_share", "type": "float", - "description": "Operating cash flow per share.", + "description": "Shareholders equity per share", "default": null, "optional": true }, { - "name": "free_cash_flow_per_share", + "name": "interest_debt_per_share", "type": "float", - "description": "Free cash flow per share.", + "description": "Interest debt per share", "default": null, "optional": true }, { - "name": "cash_per_share", + "name": "enterprise_value", "type": "float", - "description": "Cash per share.", + "description": "Enterprise value", "default": null, "optional": true }, { - "name": "payout_ratio", + "name": "price_to_sales_ratio", "type": "float", - "description": "Payout ratio.", + "description": "Price-to-sales ratio", "default": null, "optional": true }, { - "name": "operating_cash_flow_sales_ratio", + "name": "pocf_ratio", "type": "float", - "description": "Operating cash flow sales ratio.", + "description": "Price-to-operating cash flow ratio", "default": null, "optional": true }, { - "name": "free_cash_flow_operating_cash_flow_ratio", + "name": "pfcf_ratio", "type": "float", - "description": "Free cash flow operating cash flow ratio.", + "description": "Price-to-free cash flow ratio", "default": null, "optional": true }, { - "name": "cash_flow_coverage_ratios", + "name": "pb_ratio", "type": "float", - "description": "Cash flow coverage ratios.", + "description": "Price-to-book ratio", "default": null, "optional": true }, { - "name": "short_term_coverage_ratios", + "name": "ptb_ratio", "type": "float", - "description": "Short term coverage ratios.", + "description": "Price-to-tangible book ratio", "default": null, "optional": true }, { - "name": "capital_expenditure_coverage_ratio", + "name": "ev_to_sales", "type": "float", - "description": "Capital expenditure coverage ratio.", + "description": "Enterprise value-to-sales ratio", "default": null, "optional": true }, { - "name": "dividend_paid_and_capex_coverage_ratio", + "name": "enterprise_value_over_ebitda", "type": "float", - "description": "Dividend paid and capex coverage ratio.", + "description": "Enterprise value-to-EBITDA ratio", "default": null, "optional": true }, { - "name": "dividend_payout_ratio", + "name": "ev_to_operating_cash_flow", "type": "float", - "description": "Dividend payout ratio.", + "description": "Enterprise value-to-operating cash flow ratio", "default": null, "optional": true }, { - "name": "price_book_value_ratio", + "name": "ev_to_free_cash_flow", "type": "float", - "description": "Price book value ratio.", + "description": "Enterprise value-to-free cash flow ratio", "default": null, "optional": true }, { - "name": "price_to_book_ratio", + "name": "earnings_yield", "type": "float", - "description": "Price to book ratio.", + "description": "Earnings yield", "default": null, "optional": true }, { - "name": "price_to_sales_ratio", + "name": "free_cash_flow_yield", "type": "float", - "description": "Price to sales ratio.", + "description": "Free cash flow yield", "default": null, "optional": true }, { - "name": "price_earnings_ratio", + "name": "debt_to_equity", "type": "float", - "description": "Price earnings ratio.", + "description": "Debt-to-equity ratio", "default": null, "optional": true }, { - "name": "price_to_free_cash_flows_ratio", + "name": "debt_to_assets", "type": "float", - "description": "Price to free cash flows ratio.", + "description": "Debt-to-assets ratio", "default": null, "optional": true }, { - "name": "price_to_operating_cash_flows_ratio", + "name": "net_debt_to_ebitda", "type": "float", - "description": "Price to operating cash flows ratio.", + "description": "Net debt-to-EBITDA ratio", "default": null, "optional": true }, { - "name": "price_cash_flow_ratio", + "name": "current_ratio", "type": "float", - "description": "Price cash flow ratio.", + "description": "Current ratio", "default": null, "optional": true }, { - "name": "price_earnings_to_growth_ratio", + "name": "interest_coverage", "type": "float", - "description": "Price earnings to growth ratio.", + "description": "Interest coverage", "default": null, "optional": true }, { - "name": "price_sales_ratio", + "name": "income_quality", "type": "float", - "description": "Price sales ratio.", + "description": "Income quality", "default": null, "optional": true }, { "name": "dividend_yield", "type": "float", - "description": "Dividend yield.", + "description": "Dividend yield, as a normalized percent.", "default": null, "optional": true }, { - "name": "dividend_yield_percentage", + "name": "payout_ratio", "type": "float", - "description": "Dividend yield percentage.", + "description": "Payout ratio", "default": null, "optional": true }, { - "name": "dividend_per_share", + "name": "sales_general_and_administrative_to_revenue", "type": "float", - "description": "Dividend per share.", + "description": "Sales general and administrative expenses-to-revenue ratio", "default": null, "optional": true }, { - "name": "enterprise_value_multiple", + "name": "research_and_development_to_revenue", "type": "float", - "description": "Enterprise value multiple.", + "description": "Research and development expenses-to-revenue ratio", "default": null, "optional": true }, { - "name": "price_fair_value", + "name": "intangibles_to_total_assets", "type": "float", - "description": "Price fair value.", + "description": "Intangibles-to-total assets ratio", "default": null, "optional": true - } - ], - "intrinio": [] - }, - "model": "FinancialRatios" - }, - "/equity/fundamental/revenue_per_geography": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the revenue geographic breakdown for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.revenue_per_geography(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.revenue_per_geography(symbol='AAPL', period='annual', structure='flat', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "period", - "type": "Literal['quarter', 'annual']", - "description": "Time period of the data to return.", - "default": "annual", + "name": "capex_to_operating_cash_flow", + "type": "float", + "description": "Capital expenditures-to-operating cash flow ratio", + "default": null, "optional": true }, { - "name": "structure", - "type": "Literal['hierarchical', 'flat']", - "description": "Structure of the returned data.", - "default": "flat", + "name": "capex_to_revenue", + "type": "float", + "description": "Capital expenditures-to-revenue ratio", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", + "name": "capex_to_depreciation", + "type": "float", + "description": "Capital expenditures-to-depreciation ratio", + "default": null, "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[RevenueGeographic]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "stock_based_compensation_to_revenue", + "type": "float", + "description": "Stock-based compensation-to-revenue ratio", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "graham_number", + "type": "float", + "description": "Graham number", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "roic", + "type": "float", + "description": "Return on invested capital", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "period_ending", - "type": "date", - "description": "The end date of the reporting period.", - "default": "", - "optional": false + "name": "return_on_tangible_assets", + "type": "float", + "description": "Return on tangible assets", + "default": null, + "optional": true }, { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the reporting period.", + "name": "graham_net_net", + "type": "float", + "description": "Graham net-net working capital", "default": null, "optional": true }, { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the reporting period.", + "name": "working_capital", + "type": "float", + "description": "Working capital", "default": null, "optional": true }, { - "name": "filing_date", - "type": "date", - "description": "The filing date of the report.", + "name": "tangible_asset_value", + "type": "float", + "description": "Tangible asset value", "default": null, "optional": true }, { - "name": "geographic_segment", - "type": "int", - "description": "Dictionary of the revenue by geographic segment.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "RevenueGeographic" - }, - "/equity/fundamental/revenue_per_segment": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the revenue breakdown by business segment for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.revenue_per_segment(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.revenue_per_segment(symbol='AAPL', period='annual', structure='flat', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false + "name": "net_current_asset_value", + "type": "float", + "description": "Net current asset value", + "default": null, + "optional": true }, { - "name": "period", - "type": "Literal['quarter', 'annual']", - "description": "Time period of the data to return.", - "default": "annual", + "name": "invested_capital", + "type": "float", + "description": "Invested capital", + "default": null, "optional": true }, { - "name": "structure", - "type": "Literal['hierarchical', 'flat']", - "description": "Structure of the returned data.", - "default": "flat", + "name": "average_receivables", + "type": "float", + "description": "Average receivables", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", + "name": "average_payables", + "type": "float", + "description": "Average payables", + "default": null, "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[RevenueBusinessLine]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "average_inventory", + "type": "float", + "description": "Average inventory", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "days_sales_outstanding", + "type": "float", + "description": "Days sales outstanding", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "days_payables_outstanding", + "type": "float", + "description": "Days payables outstanding", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "days_of_inventory_on_hand", + "type": "float", + "description": "Days of inventory on hand", + "default": null, + "optional": true + }, { - "name": "period_ending", - "type": "date", - "description": "The end date of the reporting period.", - "default": "", - "optional": false + "name": "receivables_turnover", + "type": "float", + "description": "Receivables turnover", + "default": null, + "optional": true }, { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the reporting period.", + "name": "payables_turnover", + "type": "float", + "description": "Payables turnover", "default": null, "optional": true }, { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the reporting period.", + "name": "inventory_turnover", + "type": "float", + "description": "Inventory turnover", "default": null, "optional": true }, { - "name": "filing_date", - "type": "date", - "description": "The filing date of the report.", + "name": "roe", + "type": "float", + "description": "Return on equity", "default": null, "optional": true }, { - "name": "business_line", - "type": "int", - "description": "Dictionary containing the revenue of the business line.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "RevenueBusinessLine" - }, - "/equity/fundamental/filings": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more. SEC\nfilings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114,\nForeign Investment Disclosures and others. The annual 10-K report is required to be\nfiled annually and includes the company's financial statements, management discussion and analysis,\nand audited financial statements.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.filings(provider='fmp')\nobb.equity.fundamental.filings(limit=100, provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": null, - "optional": true - }, - { - "name": "form_type", - "type": "str", - "description": "Filter by form type. Check the data provider for available types.", + "name": "capex_per_share", + "type": "float", + "description": "Capital expenditures per share", "default": null, "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 100, - "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'sec']", - "description": "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.", - "default": "fmp", - "optional": true } ], - "fmp": [], "intrinio": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "price_to_book", + "type": "float", + "description": "Price to book ratio.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "price_to_tangible_book", + "type": "float", + "description": "Price to tangible book ratio.", "default": null, "optional": true }, { - "name": "thea_enabled", - "type": "bool", - "description": "Return filings that have been read by Intrinio's Thea NLP.", + "name": "price_to_revenue", + "type": "float", + "description": "Price to revenue ratio.", "default": null, "optional": true - } - ], - "sec": [ + }, { - "name": "cik", - "type": "Union[str, int]", - "description": "Lookup filings by Central Index Key (CIK) instead of by symbol.", + "name": "quick_ratio", + "type": "float", + "description": "Quick ratio.", "default": null, "optional": true }, { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache. If True, cache will store for one day.", - "default": true, + "name": "gross_margin", + "type": "float", + "description": "Gross margin, as a normalized percent.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[CompanyFilings]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'sec']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "filing_date", - "type": "date", - "description": "The date of the filing.", - "default": "", - "optional": false - }, - { - "name": "accepted_date", - "type": "datetime", - "description": "Accepted date of the filing.", + "name": "ebit_margin", + "type": "float", + "description": "EBIT margin, as a normalized percent.", "default": null, "optional": true }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "profit_margin", + "type": "float", + "description": "Profit margin, as a normalized percent.", "default": null, "optional": true }, { - "name": "cik", - "type": "str", - "description": "Central Index Key (CIK) for the requested entity.", + "name": "eps", + "type": "float", + "description": "Basic earnings per share.", "default": null, "optional": true }, { - "name": "report_type", - "type": "str", - "description": "Type of filing.", + "name": "eps_growth", + "type": "float", + "description": "EPS growth, as a normalized percent.", "default": null, "optional": true }, { - "name": "filing_url", - "type": "str", - "description": "URL to the filing page.", + "name": "revenue_growth", + "type": "float", + "description": "Revenue growth, as a normalized percent.", "default": null, "optional": true }, { - "name": "report_url", - "type": "str", - "description": "URL to the actual report.", - "default": "", - "optional": false - } - ], - "fmp": [], - "intrinio": [ - { - "name": "id", - "type": "str", - "description": "Intrinio ID of the filing.", - "default": "", - "optional": false - }, - { - "name": "period_end_date", - "type": "date", - "description": "Ending date of the fiscal period for the filing.", + "name": "ebitda_growth", + "type": "float", + "description": "EBITDA growth, as a normalized percent.", "default": null, "optional": true }, { - "name": "sec_unique_id", - "type": "str", - "description": "SEC unique ID of the filing.", - "default": "", - "optional": false - }, - { - "name": "instance_url", - "type": "str", - "description": "URL for the XBRL filing for the report.", + "name": "ebit_growth", + "type": "float", + "description": "EBIT growth, as a normalized percent.", "default": null, "optional": true }, { - "name": "industry_group", - "type": "str", - "description": "Industry group of the company.", - "default": "", - "optional": false + "name": "net_income_growth", + "type": "float", + "description": "Net income growth, as a normalized percent.", + "default": null, + "optional": true }, { - "name": "industry_category", - "type": "str", - "description": "Industry category of the company.", - "default": "", - "optional": false - } - ], - "sec": [ - { - "name": "report_date", - "type": "date", - "description": "The date of the filing.", + "name": "free_cash_flow_to_firm_growth", + "type": "float", + "description": "Free cash flow to firm growth, as a normalized percent.", "default": null, "optional": true }, { - "name": "act", - "type": "Union[str, int]", - "description": "The SEC Act number.", + "name": "invested_capital_growth", + "type": "float", + "description": "Invested capital growth, as a normalized percent.", "default": null, "optional": true }, { - "name": "items", - "type": "Union[str, float]", - "description": "The SEC Item numbers.", + "name": "return_on_assets", + "type": "float", + "description": "Return on assets, as a normalized percent.", "default": null, "optional": true }, { - "name": "primary_doc_description", - "type": "str", - "description": "The description of the primary document.", + "name": "return_on_equity", + "type": "float", + "description": "Return on equity, as a normalized percent.", "default": null, "optional": true }, { - "name": "primary_doc", - "type": "str", - "description": "The filename of the primary document.", + "name": "return_on_invested_capital", + "type": "float", + "description": "Return on invested capital, as a normalized percent.", "default": null, "optional": true }, { - "name": "accession_number", - "type": "Union[str, int]", - "description": "The accession number.", + "name": "ebitda", + "type": "int", + "description": "Earnings before interest, taxes, depreciation, and amortization.", "default": null, "optional": true }, { - "name": "file_number", - "type": "Union[str, int]", - "description": "The file number.", + "name": "ebit", + "type": "int", + "description": "Earnings before interest and taxes.", "default": null, "optional": true }, { - "name": "film_number", - "type": "Union[str, int]", - "description": "The film number.", + "name": "long_term_debt", + "type": "int", + "description": "Long-term debt.", "default": null, "optional": true }, { - "name": "is_inline_xbrl", - "type": "Union[str, int]", - "description": "Whether the filing is an inline XBRL filing.", + "name": "total_debt", + "type": "int", + "description": "Total debt.", "default": null, "optional": true }, { - "name": "is_xbrl", - "type": "Union[str, int]", - "description": "Whether the filing is an XBRL filing.", + "name": "total_capital", + "type": "int", + "description": "The sum of long-term debt and total shareholder equity.", "default": null, "optional": true }, { - "name": "size", - "type": "Union[str, int]", - "description": "The size of the filing.", + "name": "enterprise_value", + "type": "int", + "description": "Enterprise value.", "default": null, "optional": true }, { - "name": "complete_submission_url", - "type": "str", - "description": "The URL to the complete filing submission.", + "name": "free_cash_flow_to_firm", + "type": "int", + "description": "Free cash flow to firm.", "default": null, "optional": true }, { - "name": "filing_detail_url", - "type": "str", - "description": "The URL to the filing details.", + "name": "altman_z_score", + "type": "float", + "description": "Altman Z-score.", "default": null, "optional": true - } - ] - }, - "model": "CompanyFilings" - }, - "/equity/fundamental/historical_splits": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get historical stock splits for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_splits(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", + "name": "beta", + "type": "float", + "description": "Beta relative to the broad market (rolling three-year).", + "default": null, "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[HistoricalSplits]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "dividend_yield", + "type": "float", + "description": "Dividend yield, as a normalized percent.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "earnings_yield", + "type": "float", + "description": "Earnings yield, as a normalized percent.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "last_price", + "type": "float", + "description": "Last price of the stock.", + "default": null, + "optional": true }, { - "name": "numerator", + "name": "year_high", "type": "float", - "description": "Numerator of the split.", + "description": "52 week high", "default": null, "optional": true }, { - "name": "denominator", + "name": "year_low", "type": "float", - "description": "Denominator of the split.", + "description": "52 week low", "default": null, "optional": true }, { - "name": "split_ratio", - "type": "str", - "description": "Split ratio.", + "name": "volume_avg", + "type": "int", + "description": "Average daily volume.", "default": null, "optional": true - } - ], - "fmp": [] - }, - "model": "HistoricalSplits" - }, - "/equity/fundamental/transcript": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get earnings call transcripts for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.transcript(symbol='AAPL', year=2020, provider='fmp')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false + "name": "short_interest", + "type": "int", + "description": "Number of shares reported as sold short.", + "default": null, + "optional": true }, { - "name": "year", + "name": "shares_outstanding", "type": "int", - "description": "Year of the earnings call transcript.", - "default": "", - "optional": false + "description": "Weighted average shares outstanding (TTM).", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", + "name": "days_to_cover", + "type": "float", + "description": "Days to cover short interest, based on average daily volume.", + "default": null, "optional": true } ], - "fmp": [] - }, - "returns": { - "OBBject": [ + "yfinance": [ { - "name": "results", - "type": "List[EarningsCallTranscript]", - "description": "Serializable results." + "name": "forward_pe", + "type": "float", + "description": "Forward price-to-earnings ratio.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "peg_ratio", + "type": "float", + "description": "PEG ratio (5-year expected).", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "peg_ratio_ttm", + "type": "float", + "description": "PEG ratio (TTM).", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "eps_ttm", + "type": "float", + "description": "Earnings per share (TTM).", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "eps_forward", + "type": "float", + "description": "Forward earnings per share.", + "default": null, + "optional": true + }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "enterprise_to_ebitda", + "type": "float", + "description": "Enterprise value to EBITDA ratio.", + "default": null, + "optional": true }, { - "name": "quarter", - "type": "int", - "description": "Quarter of the earnings call transcript.", - "default": "", - "optional": false + "name": "earnings_growth", + "type": "float", + "description": "Earnings growth (Year Over Year), as a normalized percent.", + "default": null, + "optional": true }, { - "name": "year", - "type": "int", - "description": "Year of the earnings call transcript.", - "default": "", - "optional": false + "name": "earnings_growth_quarterly", + "type": "float", + "description": "Quarterly earnings growth (Year Over Year), as a normalized percent.", + "default": null, + "optional": true }, { - "name": "date", - "type": "datetime", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "revenue_per_share", + "type": "float", + "description": "Revenue per share (TTM).", + "default": null, + "optional": true }, { - "name": "content", - "type": "str", - "description": "Content of the earnings call transcript.", - "default": "", - "optional": false - } - ], - "fmp": [] + "name": "revenue_growth", + "type": "float", + "description": "Revenue growth (Year Over Year), as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "enterprise_to_revenue", + "type": "float", + "description": "Enterprise value to revenue ratio.", + "default": null, + "optional": true + }, + { + "name": "cash_per_share", + "type": "float", + "description": "Cash per share.", + "default": null, + "optional": true + }, + { + "name": "quick_ratio", + "type": "float", + "description": "Quick ratio.", + "default": null, + "optional": true + }, + { + "name": "current_ratio", + "type": "float", + "description": "Current ratio.", + "default": null, + "optional": true + }, + { + "name": "debt_to_equity", + "type": "float", + "description": "Debt-to-equity ratio.", + "default": null, + "optional": true + }, + { + "name": "gross_margin", + "type": "float", + "description": "Gross margin, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "operating_margin", + "type": "float", + "description": "Operating margin, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "ebitda_margin", + "type": "float", + "description": "EBITDA margin, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "profit_margin", + "type": "float", + "description": "Profit margin, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "return_on_assets", + "type": "float", + "description": "Return on assets, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "return_on_equity", + "type": "float", + "description": "Return on equity, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "dividend_yield", + "type": "float", + "description": "Dividend yield, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "dividend_yield_5y_avg", + "type": "float", + "description": "5-year average dividend yield, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "payout_ratio", + "type": "float", + "description": "Payout ratio.", + "default": null, + "optional": true + }, + { + "name": "book_value", + "type": "float", + "description": "Book value per share.", + "default": null, + "optional": true + }, + { + "name": "price_to_book", + "type": "float", + "description": "Price-to-book ratio.", + "default": null, + "optional": true + }, + { + "name": "enterprise_value", + "type": "int", + "description": "Enterprise value.", + "default": null, + "optional": true + }, + { + "name": "overall_risk", + "type": "float", + "description": "Overall risk score.", + "default": null, + "optional": true + }, + { + "name": "audit_risk", + "type": "float", + "description": "Audit risk score.", + "default": null, + "optional": true + }, + { + "name": "board_risk", + "type": "float", + "description": "Board risk score.", + "default": null, + "optional": true + }, + { + "name": "compensation_risk", + "type": "float", + "description": "Compensation risk score.", + "default": null, + "optional": true + }, + { + "name": "shareholder_rights_risk", + "type": "float", + "description": "Shareholder rights risk score.", + "default": null, + "optional": true + }, + { + "name": "beta", + "type": "float", + "description": "Beta relative to the broad market (5-year monthly).", + "default": null, + "optional": true + }, + { + "name": "price_return_1y", + "type": "float", + "description": "One-year price return, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency in which the data is presented.", + "default": null, + "optional": true + } + ] }, - "model": "EarningsCallTranscript" + "model": "KeyMetrics" }, - "/equity/fundamental/trailing_dividend_yield": { + "/equity/fundamental/management": { "deprecated": { "flag": null, "message": null }, - "description": "Get the 1 year trailing dividend yield for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.trailing_dividend_yield(symbol='AAPL', provider='tiingo')\nobb.equity.fundamental.trailing_dividend_yield(symbol='AAPL', limit=252, provider='tiingo')\n```\n\n", + "description": "Get executive management team data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.management(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { @@ -16470,33 +17791,43 @@ "default": "", "optional": false }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. Default is 252, the number of trading days in a year.", - "default": 252, - "optional": true - }, { "name": "provider", - "type": "Literal['tiingo']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tiingo' if there is no default.", - "default": "tiingo", + "type": "Literal['fmp', 'yfinance']", + "description": "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.", + "default": "fmp", "optional": true } ], - "tiingo": [] + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + } + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[TrailingDividendYield]", + "type": "List[KeyExecutives]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['tiingo']]", + "type": "Optional[Literal['fmp', 'yfinance']]", "description": "Provider name." }, { @@ -16519,53 +17850,140 @@ "data": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "title", + "type": "str", + "description": "Designation of the key executive.", "default": "", "optional": false }, { - "name": "trailing_dividend_yield", - "type": "float", - "description": "Trailing dividend yield.", - "default": "", - "optional": false - } - ], - "tiingo": [] - }, - "model": "TrailingDividendYield" - }, - "/equity/ownership/major_holders": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get data about major holders for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.major_holders(symbol='AAPL', provider='fmp')\nobb.equity.ownership.major_holders(symbol='AAPL', page=0, provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", + "name": "name", "type": "str", - "description": "Symbol to get data for.", + "description": "Name of the key executive.", "default": "", "optional": false }, { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", + "name": "pay", + "type": "int", + "description": "Pay of the key executive.", "default": null, "optional": true }, { - "name": "page", + "name": "currency_pay", + "type": "str", + "description": "Currency of the pay.", + "default": null, + "optional": true + }, + { + "name": "gender", + "type": "str", + "description": "Gender of the key executive.", + "default": null, + "optional": true + }, + { + "name": "year_born", "type": "int", - "description": "Page number of the data to fetch.", - "default": 0, + "description": "Birth year of the key executive.", + "default": null, + "optional": true + }, + { + "name": "title_since", + "type": "int", + "description": "Date the tile was held since.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "title", + "type": "str", + "description": "Designation of the key executive.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the key executive.", + "default": "", + "optional": false + }, + { + "name": "pay", + "type": "int", + "description": "Pay of the key executive.", + "default": null, + "optional": true + }, + { + "name": "currency_pay", + "type": "str", + "description": "Currency of the pay.", + "default": null, + "optional": true + }, + { + "name": "gender", + "type": "str", + "description": "Gender of the key executive.", + "default": null, + "optional": true + }, + { + "name": "year_born", + "type": "int", + "description": "Birth year of the key executive.", + "default": null, + "optional": true + }, + { + "name": "title_since", + "type": "int", + "description": "Date the tile was held since.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "exercised_value", + "type": "int", + "description": "Value of shares exercised.", + "default": null, + "optional": true + }, + { + "name": "unexercised_value", + "type": "int", + "description": "Value of shares not exercised.", + "default": null, "optional": true + } + ] + }, + "model": "KeyExecutives" + }, + "/equity/fundamental/management_compensation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get executive management team compensation for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.management_compensation(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { "name": "provider", @@ -16575,13 +17993,21 @@ "optional": true } ], - "fmp": [] + "fmp": [ + { + "name": "year", + "type": "int", + "description": "Year of the compensation.", + "default": null, + "optional": true + } + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EquityOwnership]", + "type": "List[ExecutiveCompensation]", "description": "Serializable results." }, { @@ -16608,34 +18034,6 @@ }, "data": { "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "cik", - "type": "int", - "description": "Central Index Key (CIK) for the requested entity.", - "default": "", - "optional": false - }, - { - "name": "filing_date", - "type": "date", - "description": "Filing date of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "investor_name", - "type": "str", - "description": "Investor name of the stock ownership.", - "default": "", - "optional": false - }, { "name": "symbol", "type": "str", @@ -16644,255 +18042,116 @@ "optional": false }, { - "name": "security_name", + "name": "cik", "type": "str", - "description": "Security name of the stock ownership.", - "default": "", - "optional": false + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true }, { - "name": "type_of_security", + "name": "company_name", "type": "str", - "description": "Type of security of the stock ownership.", - "default": "", - "optional": false + "description": "The name of the company.", + "default": null, + "optional": true }, { - "name": "security_cusip", + "name": "industry", "type": "str", - "description": "Security cusip of the stock ownership.", - "default": "", - "optional": false + "description": "The industry of the company.", + "default": null, + "optional": true }, { - "name": "shares_type", - "type": "str", - "description": "Shares type of the stock ownership.", - "default": "", - "optional": false + "name": "year", + "type": "int", + "description": "Year of the compensation.", + "default": null, + "optional": true }, { - "name": "put_call_share", + "name": "name_and_position", "type": "str", - "description": "Put call share of the stock ownership.", - "default": "", - "optional": false + "description": "Name and position.", + "default": null, + "optional": true }, { - "name": "investment_discretion", - "type": "str", - "description": "Investment discretion of the stock ownership.", - "default": "", - "optional": false + "name": "salary", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Salary.", + "default": null, + "optional": true }, { - "name": "industry_title", - "type": "str", - "description": "Industry title of the stock ownership.", - "default": "", - "optional": false + "name": "bonus", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Bonus payments.", + "default": null, + "optional": true }, { - "name": "weight", - "type": "float", - "description": "Weight of the stock ownership.", - "default": "", - "optional": false + "name": "stock_award", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Stock awards.", + "default": null, + "optional": true }, { - "name": "last_weight", - "type": "float", - "description": "Last weight of the stock ownership.", - "default": "", - "optional": false + "name": "incentive_plan_compensation", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Incentive plan compensation.", + "default": null, + "optional": true }, { - "name": "change_in_weight", - "type": "float", - "description": "Change in weight of the stock ownership.", - "default": "", - "optional": false + "name": "all_other_compensation", + "type": "Annotated[float, Ge(ge=0)]", + "description": "All other compensation.", + "default": null, + "optional": true }, { - "name": "change_in_weight_percentage", - "type": "float", - "description": "Change in weight percentage of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "market_value", - "type": "int", - "description": "Market value of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "last_market_value", - "type": "int", - "description": "Last market value of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "change_in_market_value", - "type": "int", - "description": "Change in market value of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "change_in_market_value_percentage", - "type": "float", - "description": "Change in market value percentage of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "shares_number", - "type": "int", - "description": "Shares number of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "last_shares_number", - "type": "int", - "description": "Last shares number of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "change_in_shares_number", - "type": "float", - "description": "Change in shares number of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "change_in_shares_number_percentage", - "type": "float", - "description": "Change in shares number percentage of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "quarter_end_price", - "type": "float", - "description": "Quarter end price of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "avg_price_paid", - "type": "float", - "description": "Average price paid of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "is_new", - "type": "bool", - "description": "Is the stock ownership new.", - "default": "", - "optional": false - }, - { - "name": "is_sold_out", - "type": "bool", - "description": "Is the stock ownership sold out.", - "default": "", - "optional": false - }, - { - "name": "ownership", - "type": "float", - "description": "How much is the ownership.", - "default": "", - "optional": false - }, - { - "name": "last_ownership", - "type": "float", - "description": "Last ownership amount.", - "default": "", - "optional": false - }, - { - "name": "change_in_ownership", - "type": "float", - "description": "Change in ownership amount.", - "default": "", - "optional": false - }, - { - "name": "change_in_ownership_percentage", - "type": "float", - "description": "Change in ownership percentage.", - "default": "", - "optional": false - }, - { - "name": "holding_period", - "type": "int", - "description": "Holding period of the stock ownership.", - "default": "", - "optional": false - }, + "name": "total", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Total compensation.", + "default": null, + "optional": true + } + ], + "fmp": [ { - "name": "first_added", + "name": "filing_date", "type": "date", - "description": "First added date of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "performance", - "type": "float", - "description": "Performance of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "performance_percentage", - "type": "float", - "description": "Performance percentage of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "last_performance", - "type": "float", - "description": "Last performance of the stock ownership.", - "default": "", - "optional": false + "description": "Date of the filing.", + "default": null, + "optional": true }, { - "name": "change_in_performance", - "type": "float", - "description": "Change in performance of the stock ownership.", - "default": "", - "optional": false + "name": "accepted_date", + "type": "datetime", + "description": "Date the filing was accepted.", + "default": null, + "optional": true }, { - "name": "is_counted_for_performance", - "type": "bool", - "description": "Is the stock ownership counted for performance.", - "default": "", - "optional": false + "name": "url", + "type": "str", + "description": "URL to the filing data.", + "default": null, + "optional": true } - ], - "fmp": [] + ] }, - "model": "EquityOwnership" + "model": "ExecutiveCompensation" }, - "/equity/ownership/institutional": { + "/equity/fundamental/overview": { "deprecated": { - "flag": null, - "message": null + "flag": true, + "message": "This endpoint is deprecated; use `/equity/profile` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.3." }, - "description": "Get data about institutional ownership for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.institutional(symbol='AAPL', provider='fmp')\n```\n\n", + "description": "Get company general business and stock data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.overview(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { @@ -16912,18 +18171,11 @@ ], "fmp": [ { - "name": "include_current_quarter", - "type": "bool", - "description": "Include current quarter data.", - "default": false, - "optional": true - }, - { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false } ] }, @@ -16931,7 +18183,7 @@ "OBBject": [ { "name": "results", - "type": "List[InstitutionalOwnership]", + "type": "List[CompanyOverview]", "description": "Serializable results." }, { @@ -16966,607 +18218,582 @@ "optional": false }, { - "name": "cik", - "type": "str", - "description": "Central Index Key (CIK) for the requested entity.", + "name": "price", + "type": "float", + "description": "Price of the company.", "default": null, "optional": true }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - } - ], - "fmp": [ - { - "name": "investors_holding", - "type": "int", - "description": "Number of investors holding the stock.", - "default": "", - "optional": false - }, - { - "name": "last_investors_holding", - "type": "int", - "description": "Number of investors holding the stock in the last quarter.", - "default": "", - "optional": false + "name": "beta", + "type": "float", + "description": "Beta of the company.", + "default": null, + "optional": true }, { - "name": "investors_holding_change", + "name": "vol_avg", "type": "int", - "description": "Change in the number of investors holding the stock.", - "default": "", - "optional": false + "description": "Volume average of the company.", + "default": null, + "optional": true }, { - "name": "number_of_13f_shares", + "name": "mkt_cap", "type": "int", - "description": "Number of 13F shares.", + "description": "Market capitalization of the company.", "default": null, "optional": true }, { - "name": "last_number_of_13f_shares", - "type": "int", - "description": "Number of 13F shares in the last quarter.", + "name": "last_div", + "type": "float", + "description": "Last dividend of the company.", "default": null, "optional": true }, { - "name": "number_of_13f_shares_change", - "type": "int", - "description": "Change in the number of 13F shares.", + "name": "range", + "type": "str", + "description": "Range of the company.", "default": null, "optional": true }, { - "name": "total_invested", + "name": "changes", "type": "float", - "description": "Total amount invested.", - "default": "", - "optional": false + "description": "Changes of the company.", + "default": null, + "optional": true }, { - "name": "last_total_invested", - "type": "float", - "description": "Total amount invested in the last quarter.", - "default": "", - "optional": false + "name": "company_name", + "type": "str", + "description": "Company name of the company.", + "default": null, + "optional": true }, { - "name": "total_invested_change", - "type": "float", - "description": "Change in the total amount invested.", - "default": "", - "optional": false + "name": "currency", + "type": "str", + "description": "Currency of the company.", + "default": null, + "optional": true }, { - "name": "ownership_percent", - "type": "float", - "description": "Ownership percent.", - "default": "", - "optional": false + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true }, { - "name": "last_ownership_percent", - "type": "float", - "description": "Ownership percent in the last quarter.", - "default": "", - "optional": false + "name": "isin", + "type": "str", + "description": "ISIN of the company.", + "default": null, + "optional": true }, { - "name": "ownership_percent_change", - "type": "float", - "description": "Change in the ownership percent.", - "default": "", - "optional": false + "name": "cusip", + "type": "str", + "description": "CUSIP of the company.", + "default": null, + "optional": true }, { - "name": "new_positions", - "type": "int", - "description": "Number of new positions.", - "default": "", - "optional": false + "name": "exchange", + "type": "str", + "description": "Exchange of the company.", + "default": null, + "optional": true }, { - "name": "last_new_positions", - "type": "int", - "description": "Number of new positions in the last quarter.", - "default": "", - "optional": false + "name": "exchange_short_name", + "type": "str", + "description": "Exchange short name of the company.", + "default": null, + "optional": true }, { - "name": "new_positions_change", - "type": "int", - "description": "Change in the number of new positions.", - "default": "", - "optional": false + "name": "industry", + "type": "str", + "description": "Industry of the company.", + "default": null, + "optional": true }, { - "name": "increased_positions", - "type": "int", - "description": "Number of increased positions.", - "default": "", - "optional": false + "name": "website", + "type": "str", + "description": "Website of the company.", + "default": null, + "optional": true }, { - "name": "last_increased_positions", - "type": "int", - "description": "Number of increased positions in the last quarter.", - "default": "", - "optional": false + "name": "description", + "type": "str", + "description": "Description of the company.", + "default": null, + "optional": true }, { - "name": "increased_positions_change", - "type": "int", - "description": "Change in the number of increased positions.", - "default": "", - "optional": false + "name": "ceo", + "type": "str", + "description": "CEO of the company.", + "default": null, + "optional": true }, { - "name": "closed_positions", - "type": "int", - "description": "Number of closed positions.", - "default": "", - "optional": false + "name": "sector", + "type": "str", + "description": "Sector of the company.", + "default": null, + "optional": true }, { - "name": "last_closed_positions", - "type": "int", - "description": "Number of closed positions in the last quarter.", - "default": "", - "optional": false + "name": "country", + "type": "str", + "description": "Country of the company.", + "default": null, + "optional": true }, { - "name": "closed_positions_change", - "type": "int", - "description": "Change in the number of closed positions.", - "default": "", - "optional": false + "name": "full_time_employees", + "type": "str", + "description": "Full time employees of the company.", + "default": null, + "optional": true }, { - "name": "reduced_positions", - "type": "int", - "description": "Number of reduced positions.", - "default": "", - "optional": false + "name": "phone", + "type": "str", + "description": "Phone of the company.", + "default": null, + "optional": true }, { - "name": "last_reduced_positions", - "type": "int", - "description": "Number of reduced positions in the last quarter.", - "default": "", - "optional": false + "name": "address", + "type": "str", + "description": "Address of the company.", + "default": null, + "optional": true }, { - "name": "reduced_positions_change", - "type": "int", - "description": "Change in the number of reduced positions.", - "default": "", - "optional": false + "name": "city", + "type": "str", + "description": "City of the company.", + "default": null, + "optional": true }, { - "name": "total_calls", - "type": "int", - "description": "Total number of call options contracts traded for Apple Inc. on the specified date.", - "default": "", - "optional": false + "name": "state", + "type": "str", + "description": "State of the company.", + "default": null, + "optional": true }, { - "name": "last_total_calls", - "type": "int", - "description": "Total number of call options contracts traded for Apple Inc. on the previous reporting date.", - "default": "", - "optional": false + "name": "zip", + "type": "str", + "description": "Zip of the company.", + "default": null, + "optional": true }, { - "name": "total_calls_change", - "type": "int", - "description": "Change in the total number of call options contracts traded between the current and previous reporting dates.", - "default": "", - "optional": false + "name": "dcf_diff", + "type": "float", + "description": "Discounted cash flow difference of the company.", + "default": null, + "optional": true }, { - "name": "total_puts", - "type": "int", - "description": "Total number of put options contracts traded for Apple Inc. on the specified date.", - "default": "", - "optional": false + "name": "dcf", + "type": "float", + "description": "Discounted cash flow of the company.", + "default": null, + "optional": true }, { - "name": "last_total_puts", - "type": "int", - "description": "Total number of put options contracts traded for Apple Inc. on the previous reporting date.", - "default": "", - "optional": false + "name": "image", + "type": "str", + "description": "Image of the company.", + "default": null, + "optional": true }, { - "name": "total_puts_change", - "type": "int", - "description": "Change in the total number of put options contracts traded between the current and previous reporting dates.", - "default": "", - "optional": false + "name": "ipo_date", + "type": "date", + "description": "IPO date of the company.", + "default": null, + "optional": true }, { - "name": "put_call_ratio", - "type": "float", - "description": "Put-call ratio, which is the ratio of the total number of put options to call options traded on the specified date.", + "name": "default_image", + "type": "bool", + "description": "If the image is the default image.", "default": "", "optional": false }, { - "name": "last_put_call_ratio", - "type": "float", - "description": "Put-call ratio on the previous reporting date.", + "name": "is_etf", + "type": "bool", + "description": "If the company is an ETF.", "default": "", "optional": false }, { - "name": "put_call_ratio_change", - "type": "float", - "description": "Change in the put-call ratio between the current and previous reporting dates.", + "name": "is_actively_trading", + "type": "bool", + "description": "If the company is actively trading.", "default": "", "optional": false - } - ] - }, - "model": "InstitutionalOwnership" - }, - "/equity/ownership/insider_trading": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get data about trading by a company's management team and board of directors.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.insider_trading(symbol='AAPL', provider='fmp')\nobb.equity.ownership.insider_trading(symbol='AAPL', limit=500, provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "name": "is_adr", + "type": "bool", + "description": "If the company is an ADR.", "default": "", "optional": false }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 500, - "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp', 'intrinio']", - "description": "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.", - "default": "fmp", - "optional": true + "name": "is_fund", + "type": "bool", + "description": "If the company is a fund.", + "default": "", + "optional": false } ], "fmp": [ { - "name": "transaction_type", - "type": "Literal[None, 'award', 'conversion', 'return', 'expire_short', 'in_kind', 'gift', 'expire_long', 'discretionary', 'other', 'small', 'exempt', 'otm', 'purchase', 'sale', 'tender', 'will', 'itm', 'trust']", - "description": "Type of the transaction.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": "", - "optional": false - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "ownership_type", - "type": "Literal['D', 'I']", - "description": "Type of ownership.", + "name": "price", + "type": "float", + "description": "Price of the company.", "default": null, "optional": true }, { - "name": "sort_by", - "type": "Literal['filing_date', 'updated_on']", - "description": "Field to sort by.", - "default": "updated_on", + "name": "beta", + "type": "float", + "description": "Beta of the company.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[InsiderTrading]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio']]", - "description": "Provider name." + "name": "vol_avg", + "type": "int", + "description": "Volume average of the company.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "mkt_cap", + "type": "int", + "description": "Market capitalization of the company.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "last_div", + "type": "float", + "description": "Last dividend of the company.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", + "name": "range", "type": "str", - "description": "Symbol representing the entity requested in the data.", + "description": "Range of the company.", "default": null, "optional": true }, { - "name": "company_cik", - "type": "Union[int, str]", - "description": "CIK number of the company.", + "name": "changes", + "type": "float", + "description": "Changes of the company.", "default": null, "optional": true }, { - "name": "filing_date", - "type": "Union[date, datetime]", - "description": "Filing date of the trade.", + "name": "company_name", + "type": "str", + "description": "Company name of the company.", "default": null, "optional": true }, { - "name": "transaction_date", - "type": "date", - "description": "Date of the transaction.", + "name": "currency", + "type": "str", + "description": "Currency of the company.", "default": null, "optional": true }, { - "name": "owner_cik", - "type": "Union[int, str]", - "description": "Reporting individual's CIK.", + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", "default": null, "optional": true }, { - "name": "owner_name", + "name": "isin", "type": "str", - "description": "Name of the reporting individual.", + "description": "ISIN of the company.", "default": null, "optional": true }, { - "name": "owner_title", + "name": "cusip", "type": "str", - "description": "The title held by the reporting individual.", + "description": "CUSIP of the company.", "default": null, "optional": true }, { - "name": "transaction_type", + "name": "exchange", "type": "str", - "description": "Type of transaction being reported.", + "description": "Exchange of the company.", "default": null, "optional": true }, { - "name": "acquisition_or_disposition", + "name": "exchange_short_name", "type": "str", - "description": "Acquisition or disposition of the shares.", + "description": "Exchange short name of the company.", "default": null, "optional": true }, { - "name": "security_type", + "name": "industry", "type": "str", - "description": "The type of security transacted.", + "description": "Industry of the company.", "default": null, "optional": true }, { - "name": "securities_owned", - "type": "float", - "description": "Number of securities owned by the reporting individual.", + "name": "website", + "type": "str", + "description": "Website of the company.", "default": null, "optional": true }, { - "name": "securities_transacted", - "type": "float", - "description": "Number of securities transacted by the reporting individual.", + "name": "description", + "type": "str", + "description": "Description of the company.", "default": null, "optional": true }, { - "name": "transaction_price", - "type": "float", - "description": "The price of the transaction.", + "name": "ceo", + "type": "str", + "description": "CEO of the company.", "default": null, "optional": true }, { - "name": "filing_url", + "name": "sector", "type": "str", - "description": "Link to the filing.", + "description": "Sector of the company.", "default": null, "optional": true - } - ], - "fmp": [ - { - "name": "form_type", - "type": "str", - "description": "Form type of the insider trading.", - "default": "", - "optional": false - } - ], - "intrinio": [ - { - "name": "company_name", - "type": "str", - "description": "Name of the company.", - "default": "", - "optional": false }, { - "name": "conversion_exercise_price", - "type": "float", - "description": "Conversion/Exercise price of the shares.", + "name": "country", + "type": "str", + "description": "Country of the company.", "default": null, "optional": true }, { - "name": "deemed_execution_date", - "type": "date", - "description": "Deemed execution date of the trade.", + "name": "full_time_employees", + "type": "str", + "description": "Full time employees of the company.", "default": null, "optional": true }, { - "name": "exercise_date", - "type": "date", - "description": "Exercise date of the trade.", + "name": "phone", + "type": "str", + "description": "Phone of the company.", "default": null, "optional": true }, { - "name": "expiration_date", - "type": "date", - "description": "Expiration date of the derivative.", + "name": "address", + "type": "str", + "description": "Address of the company.", "default": null, "optional": true }, { - "name": "underlying_security_title", + "name": "city", "type": "str", - "description": "Name of the underlying non-derivative security related to this derivative transaction.", + "description": "City of the company.", "default": null, "optional": true }, { - "name": "underlying_shares", - "type": "Union[int, float]", - "description": "Number of underlying shares related to this derivative transaction.", + "name": "state", + "type": "str", + "description": "State of the company.", "default": null, "optional": true }, { - "name": "nature_of_ownership", + "name": "zip", "type": "str", - "description": "Nature of ownership of the insider trading.", + "description": "Zip of the company.", "default": null, "optional": true }, { - "name": "director", - "type": "bool", - "description": "Whether the owner is a director.", + "name": "dcf_diff", + "type": "float", + "description": "Discounted cash flow difference of the company.", "default": null, "optional": true }, { - "name": "officer", - "type": "bool", - "description": "Whether the owner is an officer.", + "name": "dcf", + "type": "float", + "description": "Discounted cash flow of the company.", "default": null, "optional": true }, { - "name": "ten_percent_owner", - "type": "bool", - "description": "Whether the owner is a 10% owner.", + "name": "image", + "type": "str", + "description": "Image of the company.", "default": null, "optional": true }, { - "name": "other_relation", - "type": "bool", - "description": "Whether the owner is having another relation.", + "name": "ipo_date", + "type": "date", + "description": "IPO date of the company.", "default": null, "optional": true }, { - "name": "derivative_transaction", + "name": "default_image", "type": "bool", - "description": "Whether the owner is having a derivative transaction.", - "default": null, - "optional": true + "description": "If the image is the default image.", + "default": "", + "optional": false }, { - "name": "report_line_number", - "type": "int", - "description": "Report line number of the insider trading.", - "default": null, - "optional": true + "name": "is_etf", + "type": "bool", + "description": "If the company is an ETF.", + "default": "", + "optional": false + }, + { + "name": "is_actively_trading", + "type": "bool", + "description": "If the company is actively trading.", + "default": "", + "optional": false + }, + { + "name": "is_adr", + "type": "bool", + "description": "If the company is an ADR.", + "default": "", + "optional": false + }, + { + "name": "is_fund", + "type": "bool", + "description": "If the company is a fund.", + "default": "", + "optional": false } ] }, - "model": "InsiderTrading" + "model": "CompanyOverview" }, - "/equity/ownership/share_statistics": { + "/equity/fundamental/ratios": { "deprecated": { "flag": null, "message": null }, - "description": "Get data about share float for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.share_statistics(symbol='AAPL', provider='fmp')\n```\n\n", + "description": "Get an extensive set of financial and accounting ratios for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.ratios(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.ratios(symbol='AAPL', period='annual', limit=12, provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "type": "str", + "description": "Symbol to get data for.", "default": "", "optional": false }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 12, + "optional": true + }, { "name": "provider", - "type": "Literal['fmp', 'intrinio', 'yfinance']", + "type": "Literal['fmp', 'intrinio']", "description": "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.", "default": "fmp", "optional": true } ], - "fmp": [], - "intrinio": [], - "yfinance": [] + "fmp": [ + { + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + } + ], + "intrinio": [ + { + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", + "default": null, + "optional": true + } + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[ShareStatistics]", + "type": "List[FinancialRatios]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "type": "Optional[Literal['fmp', 'intrinio']]", "description": "Provider name." }, { @@ -17589,735 +18816,454 @@ "data": { "standard": [ { - "name": "symbol", + "name": "period_ending", "type": "str", - "description": "Symbol representing the entity requested in the data.", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "fiscal_period", + "type": "str", + "description": "Period of the financial ratios.", + "default": "", + "optional": false + }, + { + "name": "fiscal_year", + "type": "int", + "description": "Fiscal year.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "free_float", + "name": "current_ratio", "type": "float", - "description": "Percentage of unrestricted shares of a publicly-traded company.", + "description": "Current ratio.", "default": null, "optional": true }, { - "name": "float_shares", + "name": "quick_ratio", "type": "float", - "description": "Number of shares available for trading by the general public.", + "description": "Quick ratio.", "default": null, "optional": true }, { - "name": "outstanding_shares", + "name": "cash_ratio", "type": "float", - "description": "Total number of shares of a publicly-traded company.", + "description": "Cash ratio.", "default": null, "optional": true }, { - "name": "source", - "type": "str", - "description": "Source of the received data.", + "name": "days_of_sales_outstanding", + "type": "float", + "description": "Days of sales outstanding.", "default": null, "optional": true - } - ], - "fmp": [], - "intrinio": [ + }, { - "name": "adjusted_outstanding_shares", + "name": "days_of_inventory_outstanding", "type": "float", - "description": "Total number of shares of a publicly-traded company, adjusted for splits.", + "description": "Days of inventory outstanding.", "default": null, "optional": true }, { - "name": "public_float", + "name": "operating_cycle", "type": "float", - "description": "Aggregate market value of the shares of a publicly-traded company.", + "description": "Operating cycle.", "default": null, "optional": true - } - ], - "yfinance": [ + }, { - "name": "implied_shares_outstanding", - "type": "int", - "description": "Implied Shares Outstanding of common equity, assuming the conversion of all convertible subsidiary equity into common.", + "name": "days_of_payables_outstanding", + "type": "float", + "description": "Days of payables outstanding.", "default": null, "optional": true }, { - "name": "short_interest", - "type": "int", - "description": "Number of shares that are reported short.", + "name": "cash_conversion_cycle", + "type": "float", + "description": "Cash conversion cycle.", "default": null, "optional": true }, { - "name": "short_percent_of_float", + "name": "gross_profit_margin", "type": "float", - "description": "Percentage of shares that are reported short, as a normalized percent.", + "description": "Gross profit margin.", "default": null, "optional": true }, { - "name": "days_to_cover", + "name": "operating_profit_margin", "type": "float", - "description": "Number of days to repurchase the shares as a ratio of average daily volume", + "description": "Operating profit margin.", "default": null, "optional": true }, { - "name": "short_interest_prev_month", - "type": "int", - "description": "Number of shares that were reported short in the previous month.", + "name": "pretax_profit_margin", + "type": "float", + "description": "Pretax profit margin.", "default": null, "optional": true }, { - "name": "short_interest_prev_date", - "type": "date", - "description": "Date of the previous month's report.", + "name": "net_profit_margin", + "type": "float", + "description": "Net profit margin.", "default": null, "optional": true }, { - "name": "insider_ownership", + "name": "effective_tax_rate", "type": "float", - "description": "Percentage of shares held by insiders, as a normalized percent.", + "description": "Effective tax rate.", "default": null, "optional": true }, { - "name": "institution_ownership", + "name": "return_on_assets", "type": "float", - "description": "Percentage of shares held by institutions, as a normalized percent.", + "description": "Return on assets.", "default": null, "optional": true }, { - "name": "institution_float_ownership", + "name": "return_on_equity", "type": "float", - "description": "Percentage of float held by institutions, as a normalized percent.", + "description": "Return on equity.", "default": null, "optional": true }, { - "name": "institutions_count", - "type": "int", - "description": "Number of institutions holding shares.", + "name": "return_on_capital_employed", + "type": "float", + "description": "Return on capital employed.", "default": null, "optional": true - } - ] - }, - "model": "ShareStatistics" - }, - "/equity/ownership/form_13f": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the form 13F.\n\nThe Securities and Exchange Commission's (SEC) Form 13F is a quarterly report\nthat is required to be filed by all institutional investment managers with at least\n$100 million in assets under management.\nManagers are required to file Form 13F within 45 days after the last day of the calendar quarter.\nMost funds wait until the end of this period in order to conceal\ntheir investment strategy from competitors and the public.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.form_13f(symbol='NVDA', provider='sec')\n# Enter a date (calendar quarter ending) for a specific report.\nobb.equity.ownership.form_13f(symbol='BRK-A', date='2016-09-30', provider='sec')\n# Example finding Michael Burry's filings.\ncik = obb.regulators.sec.institutions_search(\"Scion Asset Management\").results[0].cik\n# Use the `limit` parameter to return N number of reports from the most recent.\nobb.equity.ownership.form_13f(cik, limit=2).to_df()\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for. A CIK or Symbol can be used.", - "default": "", - "optional": false + "name": "net_income_per_ebt", + "type": "float", + "description": "Net income per EBT.", + "default": null, + "optional": true }, { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported.", + "name": "ebt_per_ebit", + "type": "float", + "description": "EBT per EBIT.", "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter.", - "default": 1, + "name": "ebit_per_revenue", + "type": "float", + "description": "EBIT per revenue.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", - "default": "sec", + "name": "debt_ratio", + "type": "float", + "description": "Debt ratio.", + "default": null, "optional": true - } - ], - "sec": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[Form13FHR]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['sec']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "period_ending", - "type": "date", - "description": "The end-of-quarter date of the filing.", - "default": "", - "optional": false - }, - { - "name": "issuer", - "type": "str", - "description": "The name of the issuer.", - "default": "", - "optional": false - }, - { - "name": "cusip", - "type": "str", - "description": "The CUSIP of the security.", - "default": "", - "optional": false - }, - { - "name": "asset_class", - "type": "str", - "description": "The title of the asset class for the security.", - "default": "", - "optional": false }, { - "name": "security_type", - "type": "Literal['SH', 'PRN']", - "description": "The total number of shares of the class of security or the principal amount of such class. 'SH' for shares. 'PRN' for principal amount. Convertible debt securities are reported as 'PRN'.", + "name": "debt_equity_ratio", + "type": "float", + "description": "Debt equity ratio.", "default": null, "optional": true }, { - "name": "option_type", - "type": "Literal['call', 'put']", - "description": "Defined when the holdings being reported are put or call options. Only long positions are reported.", + "name": "long_term_debt_to_capitalization", + "type": "float", + "description": "Long term debt to capitalization.", "default": null, "optional": true }, { - "name": "voting_authority_sole", - "type": "int", - "description": "The number of shares for which the Manager exercises sole voting authority (none).", + "name": "total_debt_to_capitalization", + "type": "float", + "description": "Total debt to capitalization.", "default": null, "optional": true }, { - "name": "voting_authority_shared", - "type": "int", - "description": "The number of shares for which the Manager exercises a defined shared voting authority (none).", + "name": "interest_coverage", + "type": "float", + "description": "Interest coverage.", "default": null, "optional": true }, { - "name": "voting_authority_other", - "type": "int", - "description": "The number of shares for which the Manager exercises other shared voting authority (none).", + "name": "cash_flow_to_debt_ratio", + "type": "float", + "description": "Cash flow to debt ratio.", "default": null, "optional": true }, { - "name": "principal_amount", - "type": "int", - "description": "The total number of shares of the class of security or the principal amount of such class. Only long positions are reported", - "default": "", - "optional": false - }, - { - "name": "value", - "type": "int", - "description": "The fair market value of the holding of the particular class of security. The value reported for options is the fair market value of the underlying security with respect to the number of shares controlled. Values are rounded to the nearest US dollar and use the closing price of the last trading day of the calendar year or quarter.", - "default": "", - "optional": false - } - ], - "sec": [ - { - "name": "weight", + "name": "company_equity_multiplier", "type": "float", - "description": "The weight of the security relative to the market value of all securities in the filing , as a normalized percent.", - "default": "", - "optional": false - } - ] - }, - "model": "Form13FHR" - }, - "/equity/price/quote": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the latest quote for a given stock. Quote includes price, volume, and other data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.quote(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'yfinance']", - "description": "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.", - "default": "fmp", - "optional": true - } - ], - "fmp": [], - "intrinio": [ - { - "name": "source", - "type": "Literal['iex', 'bats', 'bats_delayed', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed', 'intrinio_mx', 'intrinio_mx_plus', 'delayed_sip']", - "description": "Source of the data.", - "default": "iex", + "description": "Company equity multiplier.", + "default": null, "optional": true - } - ], - "yfinance": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EquityQuote]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false }, { - "name": "asset_type", - "type": "str", - "description": "Type of asset - i.e, stock, ETF, etc.", + "name": "receivables_turnover", + "type": "float", + "description": "Receivables turnover.", "default": null, "optional": true }, { - "name": "name", - "type": "str", - "description": "Name of the company or asset.", + "name": "payables_turnover", + "type": "float", + "description": "Payables turnover.", "default": null, "optional": true }, { - "name": "exchange", - "type": "str", - "description": "The name or symbol of the venue where the data is from.", + "name": "inventory_turnover", + "type": "float", + "description": "Inventory turnover.", "default": null, "optional": true }, { - "name": "bid", + "name": "fixed_asset_turnover", "type": "float", - "description": "Price of the top bid order.", + "description": "Fixed asset turnover.", "default": null, "optional": true }, { - "name": "bid_size", - "type": "int", - "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", + "name": "asset_turnover", + "type": "float", + "description": "Asset turnover.", "default": null, "optional": true }, { - "name": "bid_exchange", - "type": "str", - "description": "The specific trading venue where the purchase order was placed.", + "name": "operating_cash_flow_per_share", + "type": "float", + "description": "Operating cash flow per share.", "default": null, "optional": true }, { - "name": "ask", + "name": "free_cash_flow_per_share", "type": "float", - "description": "Price of the top ask order.", + "description": "Free cash flow per share.", "default": null, "optional": true }, { - "name": "ask_size", - "type": "int", - "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", + "name": "cash_per_share", + "type": "float", + "description": "Cash per share.", "default": null, "optional": true }, { - "name": "ask_exchange", - "type": "str", - "description": "The specific trading venue where the sale order was placed.", + "name": "payout_ratio", + "type": "float", + "description": "Payout ratio.", "default": null, "optional": true }, { - "name": "quote_conditions", - "type": "Union[str, int, List[str], List[int]]", - "description": "Conditions or condition codes applicable to the quote.", - "default": null, - "optional": true - }, - { - "name": "quote_indicators", - "type": "Union[str, int, List[str], List[int]]", - "description": "Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO.", - "default": null, - "optional": true - }, - { - "name": "sales_conditions", - "type": "Union[str, int, List[str], List[int]]", - "description": "Conditions or condition codes applicable to the sale.", - "default": null, - "optional": true - }, - { - "name": "sequence_number", - "type": "int", - "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11).", - "default": null, - "optional": true - }, - { - "name": "market_center", - "type": "str", - "description": "The ID of the UTP participant that originated the message.", - "default": null, - "optional": true - }, - { - "name": "participant_timestamp", - "type": "datetime", - "description": "Timestamp for when the quote was generated by the exchange.", - "default": null, - "optional": true - }, - { - "name": "trf_timestamp", - "type": "datetime", - "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message.", - "default": null, - "optional": true - }, - { - "name": "sip_timestamp", - "type": "datetime", - "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange.", - "default": null, - "optional": true - }, - { - "name": "last_price", + "name": "operating_cash_flow_sales_ratio", "type": "float", - "description": "Price of the last trade.", - "default": null, - "optional": true - }, - { - "name": "last_tick", - "type": "str", - "description": "Whether the last sale was an up or down tick.", - "default": null, - "optional": true - }, - { - "name": "last_size", - "type": "int", - "description": "Size of the last trade.", + "description": "Operating cash flow sales ratio.", "default": null, "optional": true }, { - "name": "last_timestamp", - "type": "datetime", - "description": "Date and Time when the last price was recorded.", + "name": "free_cash_flow_operating_cash_flow_ratio", + "type": "float", + "description": "Free cash flow operating cash flow ratio.", "default": null, "optional": true }, { - "name": "open", + "name": "cash_flow_coverage_ratios", "type": "float", - "description": "The open price.", + "description": "Cash flow coverage ratios.", "default": null, "optional": true }, { - "name": "high", + "name": "short_term_coverage_ratios", "type": "float", - "description": "The high price.", + "description": "Short term coverage ratios.", "default": null, "optional": true }, { - "name": "low", + "name": "capital_expenditure_coverage_ratio", "type": "float", - "description": "The low price.", + "description": "Capital expenditure coverage ratio.", "default": null, "optional": true }, { - "name": "close", + "name": "dividend_paid_and_capex_coverage_ratio", "type": "float", - "description": "The close price.", + "description": "Dividend paid and capex coverage ratio.", "default": null, "optional": true }, { - "name": "volume", - "type": "Union[int, float]", - "description": "The trading volume.", + "name": "dividend_payout_ratio", + "type": "float", + "description": "Dividend payout ratio.", "default": null, "optional": true }, { - "name": "exchange_volume", - "type": "Union[int, float]", - "description": "Volume of shares exchanged during the trading day on the specific exchange.", + "name": "price_book_value_ratio", + "type": "float", + "description": "Price book value ratio.", "default": null, "optional": true }, { - "name": "prev_close", + "name": "price_to_book_ratio", "type": "float", - "description": "The previous close price.", + "description": "Price to book ratio.", "default": null, "optional": true }, { - "name": "change", + "name": "price_to_sales_ratio", "type": "float", - "description": "Change in price from previous close.", + "description": "Price to sales ratio.", "default": null, "optional": true }, { - "name": "change_percent", + "name": "price_earnings_ratio", "type": "float", - "description": "Change in price as a normalized percentage.", + "description": "Price earnings ratio.", "default": null, "optional": true }, { - "name": "year_high", + "name": "price_to_free_cash_flows_ratio", "type": "float", - "description": "The one year high (52W High).", + "description": "Price to free cash flows ratio.", "default": null, "optional": true }, { - "name": "year_low", + "name": "price_to_operating_cash_flows_ratio", "type": "float", - "description": "The one year low (52W Low).", + "description": "Price to operating cash flows ratio.", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "price_avg50", + "name": "price_cash_flow_ratio", "type": "float", - "description": "50 day moving average price.", + "description": "Price cash flow ratio.", "default": null, "optional": true }, { - "name": "price_avg200", + "name": "price_earnings_to_growth_ratio", "type": "float", - "description": "200 day moving average price.", + "description": "Price earnings to growth ratio.", "default": null, "optional": true }, { - "name": "avg_volume", - "type": "int", - "description": "Average volume over the last 10 trading days.", + "name": "price_sales_ratio", + "type": "float", + "description": "Price sales ratio.", "default": null, "optional": true }, { - "name": "market_cap", + "name": "dividend_yield", "type": "float", - "description": "Market cap of the company.", + "description": "Dividend yield.", "default": null, "optional": true }, { - "name": "shares_outstanding", - "type": "int", - "description": "Number of shares outstanding.", + "name": "dividend_yield_percentage", + "type": "float", + "description": "Dividend yield percentage.", "default": null, "optional": true }, { - "name": "eps", + "name": "dividend_per_share", "type": "float", - "description": "Earnings per share.", + "description": "Dividend per share.", "default": null, "optional": true }, { - "name": "pe", + "name": "enterprise_value_multiple", "type": "float", - "description": "Price earnings ratio.", + "description": "Enterprise value multiple.", "default": null, "optional": true }, { - "name": "earnings_announcement", - "type": "datetime", - "description": "Upcoming earnings announcement date.", + "name": "price_fair_value", + "type": "float", + "description": "Price fair value.", "default": null, "optional": true } ], "intrinio": [ { - "name": "is_darkpool", - "type": "bool", - "description": "Whether or not the current trade is from a darkpool.", - "default": null, - "optional": true - }, - { - "name": "source", + "name": "period_ending", "type": "str", - "description": "Source of the Intrinio data.", - "default": null, - "optional": true - }, - { - "name": "updated_on", - "type": "datetime", - "description": "Date and Time when the data was last updated.", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "security", - "type": "IntrinioSecurity", - "description": "Security details related to the quote.", - "default": null, - "optional": true - } - ], - "yfinance": [ - { - "name": "ma_50d", - "type": "float", - "description": "50-day moving average price.", - "default": null, - "optional": true - }, - { - "name": "ma_200d", - "type": "float", - "description": "200-day moving average price.", - "default": null, - "optional": true - }, - { - "name": "volume_average", - "type": "float", - "description": "Average daily trading volume.", - "default": null, - "optional": true - }, - { - "name": "volume_average_10d", - "type": "float", - "description": "Average daily trading volume in the last 10 days.", - "default": null, - "optional": true + "name": "fiscal_period", + "type": "str", + "description": "Period of the financial ratios.", + "default": "", + "optional": false }, { - "name": "currency", - "type": "str", - "description": "Currency of the price.", + "name": "fiscal_year", + "type": "int", + "description": "Fiscal year.", "default": null, "optional": true } ] }, - "model": "EquityQuote" + "model": "FinancialRatios" }, - "/equity/price/nbbo": { + "/equity/fundamental/revenue_per_geography": { "deprecated": { "flag": null, "message": null }, - "description": "Get the National Best Bid and Offer for a given stock.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.nbbo(symbol='AAPL', provider='polygon')\n```\n\n", + "description": "Get the revenue geographic breakdown for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.revenue_per_geography(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.revenue_per_geography(symbol='AAPL', period='annual', structure='flat', provider='fmp')\n```\n\n", "parameters": { "standard": [ { @@ -18328,54 +19274,47 @@ "optional": false }, { - "name": "provider", - "type": "Literal['polygon']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'polygon' if there is no default.", - "default": "polygon", + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return.", + "default": "annual", "optional": true - } - ], - "polygon": [ + }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. Up to ten million records will be returned. Pagination occurs in groups of 50,000. Remaining limit values will always return 50,000 more records unless it is the last page. High volume tickers will require multiple max requests for a single day's NBBO records. Expect stocks, like SPY, to approach 1GB in size, per day, as a raw CSV. Splitting large requests into chunks is recommended for full-day requests of high-volume symbols.", - "default": 50000, - "optional": true - }, - { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for. Use bracketed the timestamp parameters to specify exact time ranges.", - "default": null, + "name": "structure", + "type": "Literal['hierarchical', 'flat']", + "description": "Structure of the returned data.", + "default": "flat", "optional": true }, { - "name": "timestamp_lt", - "type": "Union[datetime, str]", - "description": "Query by datetime, less than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "timestamp_gt", - "type": "Union[datetime, str]", - "description": "Query by datetime, greater than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "timestamp_lte", - "type": "Union[datetime, str]", - "description": "Query by datetime, less than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", - "default": null, + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return.", + "default": "annual", "optional": true }, { - "name": "timestamp_gte", - "type": "Union[datetime, str]", - "description": "Query by datetime, greater than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", - "default": null, + "name": "structure", + "type": "Literal['hierarchical', 'flat']", + "description": "Structure of the returned data.", + "default": "flat", "optional": true } ] @@ -18384,12 +19323,12 @@ "OBBject": [ { "name": "results", - "type": "List[EquityNBBO]", + "type": "List[RevenueGeographic]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['polygon']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -18412,263 +19351,159 @@ "data": { "standard": [ { - "name": "ask_exchange", - "type": "str", - "description": "The exchange ID for the ask.", - "default": "", - "optional": false - }, - { - "name": "ask", - "type": "float", - "description": "The last ask price.", + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", "default": "", "optional": false }, { - "name": "ask_size", - "type": "int", - "description": "The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price.", - "default": "", - "optional": false + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the reporting period.", + "default": null, + "optional": true }, { - "name": "bid_size", + "name": "fiscal_year", "type": "int", - "description": "The bid size in round lots.", - "default": "", - "optional": false + "description": "The fiscal year of the reporting period.", + "default": null, + "optional": true }, { - "name": "bid", - "type": "float", - "description": "The last bid price.", - "default": "", - "optional": false + "name": "filing_date", + "type": "date", + "description": "The filing date of the report.", + "default": null, + "optional": true }, { - "name": "bid_exchange", - "type": "str", - "description": "The exchange ID for the bid.", + "name": "geographic_segment", + "type": "int", + "description": "Dictionary of the revenue by geographic segment.", "default": "", "optional": false } ], - "polygon": [ - { - "name": "tape", - "type": "str", - "description": "The exchange tape.", - "default": null, - "optional": true - }, + "fmp": [ { - "name": "conditions", - "type": "Union[str, List[int], List[str]]", - "description": "A list of condition codes.", - "default": null, - "optional": true + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false }, { - "name": "indicators", - "type": "List[int]", - "description": "A list of indicator codes.", + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the reporting period.", "default": null, "optional": true }, { - "name": "sequence_num", + "name": "fiscal_year", "type": "int", - "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11)", - "default": null, - "optional": true - }, - { - "name": "participant_timestamp", - "type": "datetime", - "description": "The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.", + "description": "The fiscal year of the reporting period.", "default": null, "optional": true }, { - "name": "sip_timestamp", - "type": "datetime", - "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it.", + "name": "filing_date", + "type": "date", + "description": "The filing date of the report.", "default": null, "optional": true }, { - "name": "trf_timestamp", - "type": "datetime", - "description": "The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this quote.", - "default": null, - "optional": true + "name": "geographic_segment", + "type": "int", + "description": "Dictionary of the revenue by geographic segment.", + "default": "", + "optional": false } ] }, - "model": "EquityNBBO" + "model": "RevenueGeographic" }, - "/equity/price/historical": { + "/equity/fundamental/revenue_per_segment": { "deprecated": { "flag": null, "message": null }, - "description": "Get historical price data for a given stock. This includes open, high, low, close, and volume.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.historical(symbol='AAPL', provider='fmp')\nobb.equity.price.historical(symbol='AAPL', interval='1d', provider='intrinio')\n```\n\n", + "description": "Get the revenue breakdown by business segment for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.revenue_per_segment(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.revenue_per_segment(symbol='AAPL', period='annual', structure='flat', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", + "type": "str", + "description": "Symbol to get data for.", "default": "", "optional": false }, { - "name": "interval", - "type": "str", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - }, - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return.", + "default": "annual", "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, + "name": "structure", + "type": "Literal['hierarchical', 'flat']", + "description": "Structure of the returned data.", + "default": "flat", "optional": true }, { "name": "provider", - "type": "Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']", + "type": "Literal['fmp']", "description": "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.", "default": "fmp", "optional": true } ], - "fmp": [], - "intrinio": [ - { - "name": "start_time", - "type": "datetime.time", - "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'.", - "default": null, - "optional": true - }, + "fmp": [ { - "name": "end_time", - "type": "datetime.time", - "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "timezone", - "type": "str", - "description": "Timezone of the data, in the IANA format (Continent/City).", - "default": "America/New_York", + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return.", + "default": "annual", "optional": true }, { - "name": "source", - "type": "Literal['realtime', 'delayed', 'nasdaq_basic']", - "description": "The source of the data.", - "default": "realtime", + "name": "structure", + "type": "Literal['hierarchical', 'flat']", + "description": "Structure of the returned data.", + "default": "flat", "optional": true } - ], - "polygon": [ + ] + }, + "returns": { + "OBBject": [ { - "name": "adjustment", - "type": "Literal['splits_only', 'unadjusted']", - "description": "The adjustment factor to apply. Default is splits only.", - "default": "splits_only", - "optional": true + "name": "results", + "type": "List[RevenueBusinessLine]", + "description": "Serializable results." }, { - "name": "extended_hours", - "type": "bool", - "description": "Include Pre and Post market data.", - "default": false, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", - "default": "asc", - "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 49999, - "optional": true - } - ], - "tiingo": [], - "yfinance": [ - { - "name": "extended_hours", - "type": "bool", - "description": "Include Pre and Post market data.", - "default": false, - "optional": true - }, - { - "name": "include_actions", - "type": "bool", - "description": "Include dividends and stock splits in results.", - "default": true, - "optional": true - }, - { - "name": "adjustment", - "type": "Literal['splits_only', 'splits_and_dividends']", - "description": "The adjustment factor to apply. Default is splits only.", - "default": "splits_only", - "optional": true - }, - { - "name": "adjusted", - "type": "bool", - "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead.", - "default": false, - "optional": true - }, - { - "name": "prepost", - "type": "bool", - "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead.", - "default": false, - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EquityHistorical]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { "name": "chart", @@ -18685,466 +19520,475 @@ "data": { "standard": [ { - "name": "date", - "type": "Union[date, datetime]", - "description": "The date of the data.", + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", "default": "", "optional": false }, { - "name": "open", - "type": "float", - "description": "The open price.", - "default": "", - "optional": false + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the reporting period.", + "default": null, + "optional": true }, { - "name": "high", - "type": "float", - "description": "The high price.", - "default": "", - "optional": false + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the reporting period.", + "default": null, + "optional": true }, { - "name": "low", - "type": "float", - "description": "The low price.", + "name": "filing_date", + "type": "date", + "description": "The filing date of the report.", + "default": null, + "optional": true + }, + { + "name": "business_line", + "type": "int", + "description": "Dictionary containing the revenue of the business line.", "default": "", "optional": false - }, + } + ], + "fmp": [ { - "name": "close", - "type": "float", - "description": "The close price.", + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", "default": "", "optional": false }, { - "name": "volume", - "type": "Union[int, float]", - "description": "The trading volume.", + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the reporting period.", "default": null, "optional": true }, { - "name": "vwap", - "type": "float", - "description": "Volume Weighted Average Price over the period.", + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the reporting period.", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "adj_close", - "type": "float", - "description": "The adjusted close price.", + "name": "filing_date", + "type": "date", + "description": "The filing date of the report.", "default": null, "optional": true }, { - "name": "unadjusted_volume", - "type": "float", - "description": "Unadjusted volume of the symbol.", + "name": "business_line", + "type": "int", + "description": "Dictionary containing the revenue of the business line.", + "default": "", + "optional": false + } + ] + }, + "model": "RevenueBusinessLine" + }, + "/equity/fundamental/filings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more. SEC\nfilings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114,\nForeign Investment Disclosures and others. The annual 10-K report is required to be\nfiled annually and includes the company's financial statements, management discussion and analysis,\nand audited financial statements.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.filings(provider='fmp')\nobb.equity.fundamental.filings(limit=100, provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", "default": null, "optional": true }, { - "name": "change", - "type": "float", - "description": "Change in the price from the previous close.", + "name": "form_type", + "type": "str", + "description": "Filter by form type. Check the data provider for available types.", "default": null, "optional": true }, { - "name": "change_percent", - "type": "float", - "description": "Change in the price from the previous close, as a normalized percent.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'sec']", + "description": "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.", + "default": "fmp", "optional": true } ], - "intrinio": [ + "fmp": [ { - "name": "average", - "type": "float", - "description": "Average trade price of an individual equity during the interval.", + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", "default": null, "optional": true }, { - "name": "change", - "type": "float", - "description": "Change in the price of the symbol from the previous day.", + "name": "form_type", + "type": "str", + "description": "Filter by form type. Check the data provider for available types.", "default": null, "optional": true }, { - "name": "change_percent", - "type": "float", - "description": "Percent change in the price of the symbol from the previous day.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100, "optional": true - }, + } + ], + "intrinio": [ { - "name": "adj_open", - "type": "float", - "description": "The adjusted open price.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "adj_high", - "type": "float", - "description": "The adjusted high price.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "adj_low", - "type": "float", - "description": "The adjusted low price.", + "name": "thea_enabled", + "type": "bool", + "description": "Return filings that have been read by Intrinio's Thea NLP.", "default": null, "optional": true - }, + } + ], + "sec": [ { - "name": "adj_close", - "type": "float", - "description": "The adjusted close price.", + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", "default": null, "optional": true }, { - "name": "adj_volume", - "type": "float", - "description": "The adjusted volume.", + "name": "form_type", + "type": "Literal['1', '1-A', '1-A POS', '1-A-W', '1-E', '1-E AD', '1-K', '1-SA', '1-U', '1-Z', '1-Z-W', '10-12B', '10-12G', '10-D', '10-K', '10-KT', '10-Q', '10-QT', '11-K', '11-KT', '13F-HR', '13F-NT', '13FCONP', '144', '15-12B', '15-12G', '15-15D', '15F-12B', '15F-12G', '15F-15D', '18-12B', '18-K', '19B-4E', '2-A', '2-AF', '2-E', '20-F', '20FR12B', '20FR12G', '24F-2NT', '25', '25-NSE', '253G1', '253G2', '253G3', '253G4', '3', '305B2', '34-12H', '4', '40-17F1', '40-17F2', '40-17G', '40-17GCS', '40-202A', '40-203A', '40-206A', '40-24B2', '40-33', '40-6B', '40-8B25', '40-8F-2', '40-APP', '40-F', '40-OIP', '40FR12B', '40FR12G', '424A', '424B1', '424B2', '424B3', '424B4', '424B5', '424B7', '424B8', '424H', '425', '485APOS', '485BPOS', '485BXT', '486APOS', '486BPOS', '486BXT', '487', '497', '497AD', '497H2', '497J', '497K', '497VPI', '497VPU', '5', '6-K', '6B NTC', '6B ORDR', '8-A12B', '8-A12G', '8-K', '8-K12B', '8-K12G3', '8-K15D5', '8-M', '8F-2 NTC', '8F-2 ORDR', '9-M', 'ABS-15G', 'ABS-EE', 'ADN-MTL', 'ADV-E', 'ADV-H-C', 'ADV-H-T', 'ADV-NR', 'ANNLRPT', 'APP NTC', 'APP ORDR', 'APP WD', 'APP WDG', 'ARS', 'ATS-N', 'ATS-N-C', 'ATS-N/UA', 'AW', 'AW WD', 'C', 'C-AR', 'C-AR-W', 'C-TR', 'C-TR-W', 'C-U', 'C-U-W', 'C-W', 'CB', 'CERT', 'CERTARCA', 'CERTBATS', 'CERTCBO', 'CERTNAS', 'CERTNYS', 'CERTPAC', 'CFPORTAL', 'CFPORTAL-W', 'CORRESP', 'CT ORDER', 'D', 'DEF 14A', 'DEF 14C', 'DEFA14A', 'DEFA14C', 'DEFC14A', 'DEFC14C', 'DEFM14A', 'DEFM14C', 'DEFN14A', 'DEFR14A', 'DEFR14C', 'DEL AM', 'DFAN14A', 'DFRN14A', 'DOS', 'DOSLTR', 'DRS', 'DRSLTR', 'DSTRBRPT', 'EFFECT', 'F-1', 'F-10', 'F-10EF', 'F-10POS', 'F-1MEF', 'F-3', 'F-3ASR', 'F-3D', 'F-3DPOS', 'F-3MEF', 'F-4', 'F-4 POS', 'F-4MEF', 'F-6', 'F-6 POS', 'F-6EF', 'F-7', 'F-7 POS', 'F-8', 'F-8 POS', 'F-80', 'F-80POS', 'F-9', 'F-9 POS', 'F-N', 'F-X', 'FOCUSN', 'FWP', 'G-405', 'G-405N', 'G-FIN', 'G-FINW', 'IRANNOTICE', 'MA', 'MA-A', 'MA-I', 'MA-W', 'MSD', 'MSDCO', 'MSDW', 'N-1', 'N-14', 'N-14 8C', 'N-14MEF', 'N-18F1', 'N-1A', 'N-2', 'N-2 POSASR', 'N-23C-2', 'N-23C3A', 'N-23C3B', 'N-23C3C', 'N-2ASR', 'N-2MEF', 'N-30B-2', 'N-30D', 'N-4', 'N-5', 'N-54A', 'N-54C', 'N-6', 'N-6F', 'N-8A', 'N-8B-2', 'N-8F', 'N-8F NTC', 'N-8F ORDR', 'N-CEN', 'N-CR', 'N-CSR', 'N-CSRS', 'N-MFP', 'N-MFP1', 'N-MFP2', 'N-PX', 'N-Q', 'N-VP', 'N-VPFS', 'NO ACT', 'NPORT-EX', 'NPORT-NP', 'NPORT-P', 'NRSRO-CE', 'NRSRO-UPD', 'NSAR-A', 'NSAR-AT', 'NSAR-B', 'NSAR-BT', 'NSAR-U', 'NT 10-D', 'NT 10-K', 'NT 10-Q', 'NT 11-K', 'NT 20-F', 'NT N-CEN', 'NT N-MFP', 'NT N-MFP1', 'NT N-MFP2', 'NT NPORT-EX', 'NT NPORT-P', 'NT-NCEN', 'NT-NCSR', 'NT-NSAR', 'NTFNCEN', 'NTFNCSR', 'NTFNSAR', 'NTN 10D', 'NTN 10K', 'NTN 10Q', 'NTN 20F', 'OIP NTC', 'OIP ORDR', 'POS 8C', 'POS AM', 'POS AMI', 'POS EX', 'POS462B', 'POS462C', 'POSASR', 'PRE 14A', 'PRE 14C', 'PREC14A', 'PREC14C', 'PREM14A', 'PREM14C', 'PREN14A', 'PRER14A', 'PRER14C', 'PRRN14A', 'PX14A6G', 'PX14A6N', 'QRTLYRPT', 'QUALIF', 'REG-NR', 'REVOKED', 'RW', 'RW WD', 'S-1', 'S-11', 'S-11MEF', 'S-1MEF', 'S-20', 'S-3', 'S-3ASR', 'S-3D', 'S-3DPOS', 'S-3MEF', 'S-4', 'S-4 POS', 'S-4EF', 'S-4MEF', 'S-6', 'S-8', 'S-8 POS', 'S-B', 'S-BMEF', 'SBSE', 'SBSE-A', 'SBSE-BD', 'SBSE-C', 'SBSE-W', 'SC 13D', 'SC 13E1', 'SC 13E3', 'SC 13G', 'SC 14D9', 'SC 14F1', 'SC 14N', 'SC TO-C', 'SC TO-I', 'SC TO-T', 'SC13E4F', 'SC14D1F', 'SC14D9C', 'SC14D9F', 'SD', 'SDR', 'SE', 'SEC ACTION', 'SEC STAFF ACTION', 'SEC STAFF LETTER', 'SF-1', 'SF-3', 'SL', 'SP 15D2', 'STOP ORDER', 'SUPPL', 'T-3', 'TA-1', 'TA-2', 'TA-W', 'TACO', 'TH', 'TTW', 'UNDER', 'UPLOAD', 'WDL-REQ', 'X-17A-5']", + "description": "Type of the SEC filing form.", "default": null, "optional": true }, { - "name": "fifty_two_week_high", - "type": "float", - "description": "52 week high price for the symbol.", + "name": "cik", + "type": "Union[int, str]", + "description": "Lookup filings by Central Index Key (CIK) instead of by symbol.", "default": null, "optional": true }, { - "name": "fifty_two_week_low", - "type": "float", - "description": "52 week low price for the symbol.", - "default": null, + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache. If True, cache will store for one day.", + "default": true, "optional": true - }, + } + ] + }, + "returns": { + "OBBject": [ { - "name": "factor", - "type": "float", - "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices.", - "default": null, - "optional": true + "name": "results", + "type": "List[CompanyFilings]", + "description": "Serializable results." }, { - "name": "split_ratio", - "type": "float", - "description": "Ratio of the equity split, if a split occurred.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'sec']]", + "description": "Provider name." }, { - "name": "dividend", - "type": "float", - "description": "Dividend amount, if a dividend was paid.", + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "filing_date", + "type": "date", + "description": "The date of the filing.", + "default": "", + "optional": false + }, + { + "name": "accepted_date", + "type": "datetime", + "description": "Accepted date of the filing.", "default": null, "optional": true }, { - "name": "close_time", - "type": "datetime", - "description": "The timestamp that represents the end of the interval span.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "interval", + "name": "cik", "type": "str", - "description": "The data time frequency.", + "description": "Central Index Key (CIK) for the requested entity.", "default": null, "optional": true }, { - "name": "intra_period", - "type": "bool", - "description": "If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period", + "name": "report_type", + "type": "str", + "description": "Type of filing.", "default": null, "optional": true - } - ], - "polygon": [ + }, { - "name": "transactions", - "type": "Annotated[int, Gt(gt=0)]", - "description": "Number of transactions for the symbol in the time period.", + "name": "filing_url", + "type": "str", + "description": "URL to the filing page.", "default": null, "optional": true + }, + { + "name": "report_url", + "type": "str", + "description": "URL to the actual report.", + "default": "", + "optional": false } ], - "tiingo": [ + "fmp": [ { - "name": "adj_open", - "type": "float", - "description": "The adjusted open price.", - "default": null, - "optional": true + "name": "filing_date", + "type": "date", + "description": "The date of the filing.", + "default": "", + "optional": false }, { - "name": "adj_high", - "type": "float", - "description": "The adjusted high price.", + "name": "accepted_date", + "type": "datetime", + "description": "Accepted date of the filing.", "default": null, "optional": true }, { - "name": "adj_low", - "type": "float", - "description": "The adjusted low price.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "adj_close", - "type": "float", - "description": "The adjusted close price.", + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", "default": null, "optional": true }, { - "name": "adj_volume", - "type": "float", - "description": "The adjusted volume.", + "name": "report_type", + "type": "str", + "description": "Type of filing.", "default": null, "optional": true }, { - "name": "split_ratio", - "type": "float", - "description": "Ratio of the equity split, if a split occurred.", + "name": "filing_url", + "type": "str", + "description": "URL to the filing page.", "default": null, "optional": true }, { - "name": "dividend", - "type": "float", - "description": "Dividend amount, if a dividend was paid.", - "default": null, - "optional": true + "name": "report_url", + "type": "str", + "description": "URL to the actual report.", + "default": "", + "optional": false } ], - "yfinance": [ + "intrinio": [ { - "name": "split_ratio", - "type": "float", - "description": "Ratio of the equity split, if a split occurred.", - "default": null, - "optional": true + "name": "id", + "type": "str", + "description": "Intrinio ID of the filing.", + "default": "", + "optional": false }, { - "name": "dividend", - "type": "float", - "description": "Dividend amount (split-adjusted), if a dividend was paid.", + "name": "period_end_date", + "type": "date", + "description": "Ending date of the fiscal period for the filing.", "default": null, "optional": true - } - ] - }, - "model": "EquityHistorical" - }, - "/equity/price/performance": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get price performance data for a given stock. This includes price changes for different time periods.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.performance(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "name": "sec_unique_id", + "type": "str", + "description": "SEC unique ID of the filing.", "default": "", "optional": false }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", + "name": "instance_url", + "type": "str", + "description": "URL for the XBRL filing for the report.", + "default": null, "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[PricePerformance]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "industry_group", + "type": "str", + "description": "Industry group of the company.", + "default": "", + "optional": false }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "industry_category", + "type": "str", + "description": "Industry category of the company.", + "default": "", + "optional": false } - ] - }, - "data": { - "standard": [ + ], + "sec": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "report_date", + "type": "date", + "description": "The date of the filing.", "default": null, "optional": true }, { - "name": "one_day", - "type": "float", - "description": "One-day return.", + "name": "act", + "type": "Union[int, str]", + "description": "The SEC Act number.", "default": null, "optional": true }, { - "name": "wtd", - "type": "float", - "description": "Week to date return.", + "name": "items", + "type": "Union[str, float]", + "description": "The SEC Item numbers.", "default": null, "optional": true }, { - "name": "one_week", - "type": "float", - "description": "One-week return.", + "name": "primary_doc_description", + "type": "str", + "description": "The description of the primary document.", "default": null, "optional": true }, { - "name": "mtd", - "type": "float", - "description": "Month to date return.", + "name": "primary_doc", + "type": "str", + "description": "The filename of the primary document.", "default": null, "optional": true }, { - "name": "one_month", - "type": "float", - "description": "One-month return.", + "name": "accession_number", + "type": "Union[int, str]", + "description": "The accession number.", "default": null, "optional": true }, { - "name": "qtd", - "type": "float", - "description": "Quarter to date return.", - "default": null, - "optional": true - }, - { - "name": "three_month", - "type": "float", - "description": "Three-month return.", - "default": null, - "optional": true - }, - { - "name": "six_month", - "type": "float", - "description": "Six-month return.", - "default": null, - "optional": true - }, - { - "name": "ytd", - "type": "float", - "description": "Year to date return.", - "default": null, - "optional": true - }, - { - "name": "one_year", - "type": "float", - "description": "One-year return.", + "name": "file_number", + "type": "Union[int, str]", + "description": "The file number.", "default": null, "optional": true }, { - "name": "two_year", - "type": "float", - "description": "Two-year return.", + "name": "film_number", + "type": "Union[int, str]", + "description": "The film number.", "default": null, "optional": true }, { - "name": "three_year", - "type": "float", - "description": "Three-year return.", + "name": "is_inline_xbrl", + "type": "Union[int, str]", + "description": "Whether the filing is an inline XBRL filing.", "default": null, "optional": true }, { - "name": "four_year", - "type": "float", - "description": "Four-year", + "name": "is_xbrl", + "type": "Union[int, str]", + "description": "Whether the filing is an XBRL filing.", "default": null, "optional": true }, { - "name": "five_year", - "type": "float", - "description": "Five-year return.", + "name": "size", + "type": "Union[int, str]", + "description": "The size of the filing.", "default": null, "optional": true }, { - "name": "ten_year", - "type": "float", - "description": "Ten-year return.", + "name": "complete_submission_url", + "type": "str", + "description": "The URL to the complete filing submission.", "default": null, "optional": true }, { - "name": "max", - "type": "float", - "description": "Return from the beginning of the time series.", + "name": "filing_detail_url", + "type": "str", + "description": "The URL to the filing details.", "default": null, "optional": true } - ], - "fmp": [] + ] }, - "model": "PricePerformance" + "model": "CompanyFilings" }, - "/equity/shorts/fails_to_deliver": { + "/equity/fundamental/historical_splits": { "deprecated": { "flag": null, "message": null }, - "description": "Get reported Fail-to-deliver (FTD) data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.shorts.fails_to_deliver(symbol='AAPL', provider='sec')\n```\n\n", + "description": "Get historical stock splits for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_splits(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { @@ -19156,33 +20000,19 @@ }, { "name": "provider", - "type": "Literal['sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", - "default": "sec", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true } ], - "sec": [ - { - "name": "limit", - "type": "int", - "description": "Limit the number of reports to parse, from most recent. Approximately 24 reports per year, going back to 2009.", - "default": 24, - "optional": true - }, - { - "name": "skip_reports", - "type": "int", - "description": "Skip N number of reports from current. A value of 1 will skip the most recent report.", - "default": 0, - "optional": true - }, + "fmp": [ { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache for the request, default is True. Each reporting period is a separate URL, new reports will be added to the cache.", - "default": true, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false } ] }, @@ -19190,12 +20020,12 @@ "OBBject": [ { "name": "results", - "type": "List[EquityFTD]", + "type": "List[HistoricalSplits]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['sec']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -19218,113 +20048,112 @@ "data": { "standard": [ { - "name": "settlement_date", + "name": "date", "type": "date", - "description": "The settlement date of the fail.", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "numerator", + "type": "float", + "description": "Numerator of the split.", "default": null, "optional": true }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "denominator", + "type": "float", + "description": "Denominator of the split.", "default": null, "optional": true }, { - "name": "cusip", + "name": "split_ratio", "type": "str", - "description": "CUSIP of the Security.", + "description": "Split ratio.", "default": null, "optional": true + } + ], + "fmp": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "quantity", - "type": "int", - "description": "The number of fails on that settlement date.", + "name": "numerator", + "type": "float", + "description": "Numerator of the split.", "default": null, "optional": true }, { - "name": "price", + "name": "denominator", "type": "float", - "description": "The price at the previous closing price from the settlement date.", + "description": "Denominator of the split.", "default": null, "optional": true }, { - "name": "description", + "name": "split_ratio", "type": "str", - "description": "The description of the Security.", + "description": "Split ratio.", "default": null, "optional": true } - ], - "sec": [] + ] }, - "model": "EquityFTD" + "model": "HistoricalSplits" }, - "/equity/search": { + "/equity/fundamental/transcript": { "deprecated": { "flag": null, "message": null }, - "description": "Search for stock symbol, CIK, LEI, or company name.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.search(provider='intrinio')\n```\n\n", + "description": "Get earnings call transcripts for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.transcript(symbol='AAPL', year=2020, provider='fmp')\n```\n\n", "parameters": { "standard": [ { - "name": "query", + "name": "symbol", "type": "str", - "description": "Search query.", + "description": "Symbol to get data for.", "default": "", - "optional": true - }, - { - "name": "is_symbol", - "type": "bool", - "description": "Whether to search by ticker symbol.", - "default": false, - "optional": true + "optional": false }, { - "name": "use_cache", - "type": "bool", - "description": "Whether to use the cache or not.", - "default": true, - "optional": true + "name": "year", + "type": "int", + "description": "Year of the earnings call transcript.", + "default": "", + "optional": false }, { "name": "provider", - "type": "Literal['intrinio', 'sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true } ], - "intrinio": [ + "fmp": [ { - "name": "active", - "type": "bool", - "description": "When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded.", - "default": true, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "limit", + "name": "year", "type": "int", - "description": "The number of data entries to return.", - "default": 10000, - "optional": true - } - ], - "sec": [ - { - "name": "is_fund", - "type": "bool", - "description": "Whether to direct the search to the list of mutual funds and ETFs.", - "default": false, - "optional": true + "description": "Year of the earnings call transcript.", + "default": "", + "optional": false } ] }, @@ -19332,12 +20161,12 @@ "OBBject": [ { "name": "results", - "type": "List[EquitySearch]", + "type": "List[EarningsCallTranscript]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['intrinio', 'sec']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -19363,187 +20192,122 @@ "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", - "default": null, - "optional": true - }, - { - "name": "name", - "type": "str", - "description": "Name of the company.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "cik", - "type": "str", - "description": "", "default": "", "optional": false }, { - "name": "lei", - "type": "str", - "description": "The Legal Entity Identifier (LEI) of the company.", + "name": "quarter", + "type": "int", + "description": "Quarter of the earnings call transcript.", "default": "", "optional": false }, { - "name": "intrinio_id", - "type": "str", - "description": "The Intrinio ID of the company.", + "name": "year", + "type": "int", + "description": "Year of the earnings call transcript.", "default": "", "optional": false - } - ], - "sec": [ + }, { - "name": "cik", - "type": "str", - "description": "Central Index Key", + "name": "date", + "type": "datetime", + "description": "The date of the data.", "default": "", "optional": false - } - ] - }, - "model": "EquitySearch" - }, - "/equity/screener": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Screen for companies meeting various criteria.\n\nThese criteria include market cap, price, beta, volume, and dividend yield.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.screener(provider='fmp')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", - "optional": true + "name": "content", + "type": "str", + "description": "Content of the earnings call transcript.", + "default": "", + "optional": false } ], "fmp": [ { - "name": "mktcap_min", - "type": "int", - "description": "Filter by market cap greater than this value.", - "default": null, - "optional": true - }, - { - "name": "mktcap_max", - "type": "int", - "description": "Filter by market cap less than this value.", - "default": null, - "optional": true - }, - { - "name": "price_min", - "type": "float", - "description": "Filter by price greater than this value.", - "default": null, - "optional": true - }, - { - "name": "price_max", - "type": "float", - "description": "Filter by price less than this value.", - "default": null, - "optional": true - }, - { - "name": "beta_min", - "type": "float", - "description": "Filter by a beta greater than this value.", - "default": null, - "optional": true - }, - { - "name": "beta_max", - "type": "float", - "description": "Filter by a beta less than this value.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "volume_min", + "name": "quarter", "type": "int", - "description": "Filter by volume greater than this value.", - "default": null, - "optional": true + "description": "Quarter of the earnings call transcript.", + "default": "", + "optional": false }, { - "name": "volume_max", + "name": "year", "type": "int", - "description": "Filter by volume less than this value.", - "default": null, - "optional": true - }, - { - "name": "dividend_min", - "type": "float", - "description": "Filter by dividend amount greater than this value.", - "default": null, - "optional": true + "description": "Year of the earnings call transcript.", + "default": "", + "optional": false }, { - "name": "dividend_max", - "type": "float", - "description": "Filter by dividend amount less than this value.", - "default": null, - "optional": true + "name": "date", + "type": "datetime", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "is_etf", - "type": "bool", - "description": "If true, returns only ETFs.", - "default": false, - "optional": true - }, + "name": "content", + "type": "str", + "description": "Content of the earnings call transcript.", + "default": "", + "optional": false + } + ] + }, + "model": "EarningsCallTranscript" + }, + "/equity/fundamental/trailing_dividend_yield": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the 1 year trailing dividend yield for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.trailing_dividend_yield(symbol='AAPL', provider='tiingo')\nobb.equity.fundamental.trailing_dividend_yield(symbol='AAPL', limit=252, provider='tiingo')\n```\n\n", + "parameters": { + "standard": [ { - "name": "is_active", - "type": "bool", - "description": "If false, returns only inactive tickers.", - "default": true, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "sector", - "type": "Literal['Consumer Cyclical', 'Energy', 'Technology', 'Industrials', 'Financial Services', 'Basic Materials', 'Communication Services', 'Consumer Defensive', 'Healthcare', 'Real Estate', 'Utilities', 'Industrial Goods', 'Financial', 'Services', 'Conglomerates']", - "description": "Filter by sector.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return. Default is 252, the number of trading days in a year.", + "default": 252, "optional": true }, { - "name": "industry", - "type": "str", - "description": "Filter by industry.", - "default": null, + "name": "provider", + "type": "Literal['tiingo']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tiingo' if there is no default.", + "default": "tiingo", "optional": true - }, + } + ], + "tiingo": [ { - "name": "country", + "name": "symbol", "type": "str", - "description": "Filter by country, as a two-letter country code.", - "default": null, - "optional": true - }, - { - "name": "exchange", - "type": "Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra']", - "description": "Filter by exchange.", - "default": null, - "optional": true + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { "name": "limit", "type": "int", - "description": "Limit the number of results to return.", - "default": 50000, + "description": "The number of data entries to return. Default is 252, the number of trading days in a year.", + "default": 252, "optional": true } ] @@ -19552,12 +20316,12 @@ "OBBject": [ { "name": "results", - "type": "List[EquityScreener]", + "type": "List[TrailingDividendYield]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['tiingo']]", "description": "Provider name." }, { @@ -19580,147 +20344,111 @@ "data": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "name", - "type": "str", - "description": "Name of the company.", + "name": "trailing_dividend_yield", + "type": "float", + "description": "Trailing dividend yield.", "default": "", "optional": false } ], - "fmp": [ + "tiingo": [ { - "name": "market_cap", - "type": "int", - "description": "The market cap of ticker.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "sector", + "name": "trailing_dividend_yield", + "type": "float", + "description": "Trailing dividend yield.", + "default": "", + "optional": false + } + ] + }, + "model": "TrailingDividendYield" + }, + "/equity/ownership/major_holders": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get data about major holders for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.major_holders(symbol='AAPL', provider='fmp')\nobb.equity.ownership.major_holders(symbol='AAPL', page=0, provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", "type": "str", - "description": "The sector the ticker belongs to.", - "default": null, - "optional": true + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "industry", - "type": "str", - "description": "The industry ticker belongs to.", + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", "default": null, "optional": true }, { - "name": "beta", - "type": "float", - "description": "The beta of the ETF.", - "default": null, - "optional": true - }, - { - "name": "price", - "type": "float", - "description": "The current price.", - "default": null, - "optional": true - }, - { - "name": "last_annual_dividend", - "type": "float", - "description": "The last annual amount dividend paid.", - "default": null, - "optional": true - }, - { - "name": "volume", + "name": "page", "type": "int", - "description": "The current trading volume.", - "default": null, - "optional": true - }, - { - "name": "exchange", - "type": "str", - "description": "The exchange code the asset trades on.", - "default": null, + "description": "Page number of the data to fetch.", + "default": 0, "optional": true }, { - "name": "exchange_name", - "type": "str", - "description": "The full name of the primary exchange.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "country", + "name": "symbol", "type": "str", - "description": "The two-letter country abbreviation where the head office is located.", - "default": null, - "optional": true + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "is_etf", - "type": "Literal[True, False]", - "description": "Whether the ticker is an ETF.", + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", "default": null, "optional": true }, { - "name": "actively_trading", - "type": "Literal[True, False]", - "description": "Whether the ETF is actively trading.", - "default": null, + "name": "page", + "type": "int", + "description": "Page number of the data to fetch.", + "default": 0, "optional": true } ] }, - "model": "EquityScreener" - }, - "/equity/profile": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get general information about a company. This includes company name, industry, sector and price data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.profile(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'yfinance']", - "description": "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.", - "default": "fmp", - "optional": true - } - ], - "fmp": [], - "intrinio": [], - "yfinance": [] - }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EquityInfo]", + "type": "List[EquityOwnership]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -19743,898 +20471,908 @@ "data": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, - { - "name": "name", - "type": "str", - "description": "Common name of the company.", - "default": null, - "optional": true - }, { "name": "cik", - "type": "str", + "type": "int", "description": "Central Index Key (CIK) for the requested entity.", - "default": null, - "optional": true + "default": "", + "optional": false }, { - "name": "cusip", - "type": "str", - "description": "CUSIP identifier for the company.", - "default": null, - "optional": true + "name": "filing_date", + "type": "date", + "description": "Filing date of the stock ownership.", + "default": "", + "optional": false }, { - "name": "isin", + "name": "investor_name", "type": "str", - "description": "International Securities Identification Number.", - "default": null, - "optional": true + "description": "Investor name of the stock ownership.", + "default": "", + "optional": false }, { - "name": "lei", + "name": "symbol", "type": "str", - "description": "Legal Entity Identifier assigned to the company.", - "default": null, - "optional": true + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "legal_name", + "name": "security_name", "type": "str", - "description": "Official legal name of the company.", - "default": null, - "optional": true + "description": "Security name of the stock ownership.", + "default": "", + "optional": false }, { - "name": "stock_exchange", + "name": "type_of_security", "type": "str", - "description": "Stock exchange where the company is traded.", - "default": null, - "optional": true + "description": "Type of security of the stock ownership.", + "default": "", + "optional": false }, { - "name": "sic", - "type": "int", - "description": "Standard Industrial Classification code for the company.", - "default": null, - "optional": true + "name": "security_cusip", + "type": "str", + "description": "Security cusip of the stock ownership.", + "default": "", + "optional": false }, { - "name": "short_description", + "name": "shares_type", "type": "str", - "description": "Short description of the company.", - "default": null, - "optional": true + "description": "Shares type of the stock ownership.", + "default": "", + "optional": false }, { - "name": "long_description", + "name": "put_call_share", "type": "str", - "description": "Long description of the company.", - "default": null, - "optional": true + "description": "Put call share of the stock ownership.", + "default": "", + "optional": false }, { - "name": "ceo", + "name": "investment_discretion", "type": "str", - "description": "Chief Executive Officer of the company.", - "default": null, - "optional": true + "description": "Investment discretion of the stock ownership.", + "default": "", + "optional": false }, { - "name": "company_url", + "name": "industry_title", "type": "str", - "description": "URL of the company's website.", - "default": null, - "optional": true + "description": "Industry title of the stock ownership.", + "default": "", + "optional": false }, { - "name": "business_address", - "type": "str", - "description": "Address of the company's headquarters.", - "default": null, - "optional": true + "name": "weight", + "type": "float", + "description": "Weight of the stock ownership.", + "default": "", + "optional": false }, { - "name": "mailing_address", - "type": "str", - "description": "Mailing address of the company.", - "default": null, - "optional": true + "name": "last_weight", + "type": "float", + "description": "Last weight of the stock ownership.", + "default": "", + "optional": false }, { - "name": "business_phone_no", - "type": "str", - "description": "Phone number of the company's headquarters.", - "default": null, - "optional": true + "name": "change_in_weight", + "type": "float", + "description": "Change in weight of the stock ownership.", + "default": "", + "optional": false }, { - "name": "hq_address1", - "type": "str", - "description": "Address of the company's headquarters.", - "default": null, - "optional": true + "name": "change_in_weight_percentage", + "type": "float", + "description": "Change in weight percentage of the stock ownership.", + "default": "", + "optional": false }, { - "name": "hq_address2", - "type": "str", - "description": "Address of the company's headquarters.", - "default": null, - "optional": true + "name": "market_value", + "type": "int", + "description": "Market value of the stock ownership.", + "default": "", + "optional": false }, { - "name": "hq_address_city", - "type": "str", - "description": "City of the company's headquarters.", - "default": null, - "optional": true + "name": "last_market_value", + "type": "int", + "description": "Last market value of the stock ownership.", + "default": "", + "optional": false }, { - "name": "hq_address_postal_code", - "type": "str", - "description": "Zip code of the company's headquarters.", - "default": null, - "optional": true + "name": "change_in_market_value", + "type": "int", + "description": "Change in market value of the stock ownership.", + "default": "", + "optional": false }, { - "name": "hq_state", - "type": "str", - "description": "State of the company's headquarters.", - "default": null, - "optional": true + "name": "change_in_market_value_percentage", + "type": "float", + "description": "Change in market value percentage of the stock ownership.", + "default": "", + "optional": false }, { - "name": "hq_country", - "type": "str", - "description": "Country of the company's headquarters.", - "default": null, - "optional": true + "name": "shares_number", + "type": "int", + "description": "Shares number of the stock ownership.", + "default": "", + "optional": false }, { - "name": "inc_state", - "type": "str", - "description": "State in which the company is incorporated.", - "default": null, - "optional": true + "name": "last_shares_number", + "type": "int", + "description": "Last shares number of the stock ownership.", + "default": "", + "optional": false }, { - "name": "inc_country", - "type": "str", - "description": "Country in which the company is incorporated.", - "default": null, - "optional": true + "name": "change_in_shares_number", + "type": "float", + "description": "Change in shares number of the stock ownership.", + "default": "", + "optional": false }, { - "name": "employees", - "type": "int", - "description": "Number of employees working for the company.", - "default": null, - "optional": true + "name": "change_in_shares_number_percentage", + "type": "float", + "description": "Change in shares number percentage of the stock ownership.", + "default": "", + "optional": false }, { - "name": "entity_legal_form", - "type": "str", - "description": "Legal form of the company.", - "default": null, - "optional": true + "name": "quarter_end_price", + "type": "float", + "description": "Quarter end price of the stock ownership.", + "default": "", + "optional": false }, { - "name": "entity_status", - "type": "str", - "description": "Status of the company.", - "default": null, - "optional": true + "name": "avg_price_paid", + "type": "float", + "description": "Average price paid of the stock ownership.", + "default": "", + "optional": false }, { - "name": "latest_filing_date", - "type": "date", - "description": "Date of the company's latest filing.", - "default": null, - "optional": true + "name": "is_new", + "type": "bool", + "description": "Is the stock ownership new.", + "default": "", + "optional": false }, { - "name": "irs_number", - "type": "str", - "description": "IRS number assigned to the company.", - "default": null, - "optional": true + "name": "is_sold_out", + "type": "bool", + "description": "Is the stock ownership sold out.", + "default": "", + "optional": false }, { - "name": "sector", - "type": "str", - "description": "Sector in which the company operates.", - "default": null, - "optional": true + "name": "ownership", + "type": "float", + "description": "How much is the ownership.", + "default": "", + "optional": false }, { - "name": "industry_category", - "type": "str", - "description": "Category of industry in which the company operates.", - "default": null, - "optional": true + "name": "last_ownership", + "type": "float", + "description": "Last ownership amount.", + "default": "", + "optional": false }, { - "name": "industry_group", - "type": "str", - "description": "Group of industry in which the company operates.", - "default": null, - "optional": true + "name": "change_in_ownership", + "type": "float", + "description": "Change in ownership amount.", + "default": "", + "optional": false }, { - "name": "template", - "type": "str", - "description": "Template used to standardize the company's financial statements.", - "default": null, - "optional": true + "name": "change_in_ownership_percentage", + "type": "float", + "description": "Change in ownership percentage.", + "default": "", + "optional": false }, { - "name": "standardized_active", - "type": "bool", - "description": "Whether the company is active or not.", - "default": null, - "optional": true + "name": "holding_period", + "type": "int", + "description": "Holding period of the stock ownership.", + "default": "", + "optional": false }, { - "name": "first_fundamental_date", + "name": "first_added", "type": "date", - "description": "Date of the company's first fundamental.", - "default": null, - "optional": true + "description": "First added date of the stock ownership.", + "default": "", + "optional": false }, { - "name": "last_fundamental_date", - "type": "date", - "description": "Date of the company's last fundamental.", - "default": null, - "optional": true + "name": "performance", + "type": "float", + "description": "Performance of the stock ownership.", + "default": "", + "optional": false }, { - "name": "first_stock_price_date", - "type": "date", - "description": "Date of the company's first stock price.", - "default": null, - "optional": true + "name": "performance_percentage", + "type": "float", + "description": "Performance percentage of the stock ownership.", + "default": "", + "optional": false }, { - "name": "last_stock_price_date", - "type": "date", - "description": "Date of the company's last stock price.", - "default": null, - "optional": true - } - ], - "fmp": [ + "name": "last_performance", + "type": "float", + "description": "Last performance of the stock ownership.", + "default": "", + "optional": false + }, { - "name": "is_etf", - "type": "bool", - "description": "If the symbol is an ETF.", + "name": "change_in_performance", + "type": "float", + "description": "Change in performance of the stock ownership.", "default": "", "optional": false }, { - "name": "is_actively_trading", + "name": "is_counted_for_performance", "type": "bool", - "description": "If the company is actively trading.", + "description": "Is the stock ownership counted for performance.", + "default": "", + "optional": false + } + ], + "fmp": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "is_adr", - "type": "bool", - "description": "If the stock is an ADR.", + "name": "cik", + "type": "int", + "description": "Central Index Key (CIK) for the requested entity.", "default": "", "optional": false }, { - "name": "is_fund", - "type": "bool", - "description": "If the company is a fund.", + "name": "filing_date", + "type": "date", + "description": "Filing date of the stock ownership.", "default": "", "optional": false }, { - "name": "image", + "name": "investor_name", "type": "str", - "description": "Image of the company.", - "default": null, - "optional": true + "description": "Investor name of the stock ownership.", + "default": "", + "optional": false }, { - "name": "currency", + "name": "symbol", "type": "str", - "description": "Currency in which the stock is traded.", - "default": null, - "optional": true + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "market_cap", - "type": "int", - "description": "Market capitalization of the company.", - "default": null, - "optional": true + "name": "security_name", + "type": "str", + "description": "Security name of the stock ownership.", + "default": "", + "optional": false }, { - "name": "last_price", - "type": "float", - "description": "The last traded price.", - "default": null, - "optional": true + "name": "type_of_security", + "type": "str", + "description": "Type of security of the stock ownership.", + "default": "", + "optional": false }, { - "name": "year_high", - "type": "float", - "description": "The one-year high of the price.", - "default": null, - "optional": true + "name": "security_cusip", + "type": "str", + "description": "Security cusip of the stock ownership.", + "default": "", + "optional": false }, { - "name": "year_low", - "type": "float", - "description": "The one-year low of the price.", - "default": null, - "optional": true + "name": "shares_type", + "type": "str", + "description": "Shares type of the stock ownership.", + "default": "", + "optional": false }, { - "name": "volume_avg", - "type": "int", - "description": "Average daily trading volume.", - "default": null, - "optional": true + "name": "put_call_share", + "type": "str", + "description": "Put call share of the stock ownership.", + "default": "", + "optional": false }, { - "name": "annualized_dividend_amount", - "type": "float", - "description": "The annualized dividend payment based on the most recent regular dividend payment.", - "default": null, - "optional": true + "name": "investment_discretion", + "type": "str", + "description": "Investment discretion of the stock ownership.", + "default": "", + "optional": false }, { - "name": "beta", - "type": "float", - "description": "Beta of the stock relative to the market.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "id", + "name": "industry_title", "type": "str", - "description": "Intrinio ID for the company.", - "default": null, - "optional": true + "description": "Industry title of the stock ownership.", + "default": "", + "optional": false }, { - "name": "thea_enabled", - "type": "bool", - "description": "Whether the company has been enabled for Thea.", - "default": null, - "optional": true - } - ], - "yfinance": [ + "name": "weight", + "type": "float", + "description": "Weight of the stock ownership.", + "default": "", + "optional": false + }, { - "name": "exchange_timezone", - "type": "str", - "description": "The timezone of the exchange.", - "default": null, - "optional": true + "name": "last_weight", + "type": "float", + "description": "Last weight of the stock ownership.", + "default": "", + "optional": false }, { - "name": "issue_type", - "type": "str", - "description": "The issuance type of the asset.", - "default": null, - "optional": true + "name": "change_in_weight", + "type": "float", + "description": "Change in weight of the stock ownership.", + "default": "", + "optional": false }, { - "name": "currency", - "type": "str", - "description": "The currency in which the asset is traded.", - "default": null, - "optional": true + "name": "change_in_weight_percentage", + "type": "float", + "description": "Change in weight percentage of the stock ownership.", + "default": "", + "optional": false }, { - "name": "market_cap", + "name": "market_value", "type": "int", - "description": "The market capitalization of the asset.", - "default": null, - "optional": true + "description": "Market value of the stock ownership.", + "default": "", + "optional": false }, { - "name": "shares_outstanding", + "name": "last_market_value", "type": "int", - "description": "The number of listed shares outstanding.", - "default": null, - "optional": true + "description": "Last market value of the stock ownership.", + "default": "", + "optional": false }, { - "name": "shares_float", + "name": "change_in_market_value", "type": "int", - "description": "The number of shares in the public float.", - "default": null, - "optional": true + "description": "Change in market value of the stock ownership.", + "default": "", + "optional": false }, { - "name": "shares_implied_outstanding", + "name": "change_in_market_value_percentage", + "type": "float", + "description": "Change in market value percentage of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "shares_number", "type": "int", - "description": "Implied shares outstanding of common equityassuming the conversion of all convertible subsidiary equity into common.", - "default": null, - "optional": true + "description": "Shares number of the stock ownership.", + "default": "", + "optional": false }, { - "name": "shares_short", + "name": "last_shares_number", "type": "int", - "description": "The reported number of shares short.", - "default": null, - "optional": true + "description": "Last shares number of the stock ownership.", + "default": "", + "optional": false }, { - "name": "dividend_yield", + "name": "change_in_shares_number", "type": "float", - "description": "The dividend yield of the asset, as a normalized percent.", - "default": null, - "optional": true + "description": "Change in shares number of the stock ownership.", + "default": "", + "optional": false }, { - "name": "beta", + "name": "change_in_shares_number_percentage", "type": "float", - "description": "The beta of the asset relative to the broad market.", - "default": null, - "optional": true - } - ] - }, - "model": "EquityInfo" - }, - "/equity/market_snapshots": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get an updated equity market snapshot. This includes price data for thousands of stocks.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.market_snapshots(provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'polygon']", - "description": "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.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "market", - "type": "Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra']", - "description": "The market to fetch data for.", - "default": "nasdaq", - "optional": true - } - ], - "intrinio": [ + "description": "Change in shares number percentage of the stock ownership.", + "default": "", + "optional": false + }, { - "name": "date", - "type": "Union[Union[date, datetime, str], str]", - "description": "The date of the data. Can be a datetime or an ISO datetime string. Historical data appears to go back to mid-June 2022. Example: '2024-03-08T12:15:00+0400'", - "default": null, - "optional": true - } - ], - "polygon": [] - }, - "returns": { - "OBBject": [ + "name": "quarter_end_price", + "type": "float", + "description": "Quarter end price of the stock ownership.", + "default": "", + "optional": false + }, { - "name": "results", - "type": "List[MarketSnapshots]", - "description": "Serializable results." + "name": "avg_price_paid", + "type": "float", + "description": "Average price paid of the stock ownership.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon']]", - "description": "Provider name." + "name": "is_new", + "type": "bool", + "description": "Is the stock ownership new.", + "default": "", + "optional": false }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "is_sold_out", + "type": "bool", + "description": "Is the stock ownership sold out.", + "default": "", + "optional": false }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "ownership", + "type": "float", + "description": "How much is the ownership.", + "default": "", + "optional": false }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "last_ownership", + "type": "float", + "description": "Last ownership amount.", "default": "", "optional": false }, { - "name": "open", + "name": "change_in_ownership", "type": "float", - "description": "The open price.", - "default": null, - "optional": true + "description": "Change in ownership amount.", + "default": "", + "optional": false }, { - "name": "high", + "name": "change_in_ownership_percentage", "type": "float", - "description": "The high price.", - "default": null, - "optional": true + "description": "Change in ownership percentage.", + "default": "", + "optional": false }, { - "name": "low", - "type": "float", - "description": "The low price.", - "default": null, - "optional": true + "name": "holding_period", + "type": "int", + "description": "Holding period of the stock ownership.", + "default": "", + "optional": false }, { - "name": "close", - "type": "float", - "description": "The close price.", - "default": null, - "optional": true + "name": "first_added", + "type": "date", + "description": "First added date of the stock ownership.", + "default": "", + "optional": false }, { - "name": "volume", - "type": "int", - "description": "The trading volume.", - "default": null, - "optional": true + "name": "performance", + "type": "float", + "description": "Performance of the stock ownership.", + "default": "", + "optional": false }, { - "name": "prev_close", + "name": "performance_percentage", "type": "float", - "description": "The previous close price.", - "default": null, - "optional": true + "description": "Performance percentage of the stock ownership.", + "default": "", + "optional": false }, { - "name": "change", + "name": "last_performance", "type": "float", - "description": "The change in price from the previous close.", - "default": null, - "optional": true + "description": "Last performance of the stock ownership.", + "default": "", + "optional": false }, { - "name": "change_percent", + "name": "change_in_performance", "type": "float", - "description": "The change in price from the previous close, as a normalized percent.", - "default": null, + "description": "Change in performance of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "is_counted_for_performance", + "type": "bool", + "description": "Is the stock ownership counted for performance.", + "default": "", + "optional": false + } + ] + }, + "model": "EquityOwnership" + }, + "/equity/ownership/institutional": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get data about institutional ownership for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.institutional(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true } ], "fmp": [ { - "name": "last_price", - "type": "float", - "description": "The last price of the stock.", - "default": null, + "name": "include_current_quarter", + "type": "bool", + "description": "Include current quarter data.", + "default": false, "optional": true }, { - "name": "last_price_timestamp", - "type": "Union[date, datetime]", - "description": "The timestamp of the last price.", + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", "default": null, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[InstitutionalOwnership]", + "description": "Serializable results." }, { - "name": "ma50", - "type": "float", - "description": "The 50-day moving average.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "ma200", - "type": "float", - "description": "The 200-day moving average.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "year_high", - "type": "float", - "description": "The 52-week high.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "year_low", - "type": "float", - "description": "The 52-week low.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "volume_avg", - "type": "int", - "description": "Average daily trading volume.", + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", "default": null, "optional": true }, { - "name": "market_cap", + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + } + ], + "fmp": [ + { + "name": "investors_holding", "type": "int", - "description": "Market cap of the stock.", - "default": null, - "optional": true + "description": "Number of investors holding the stock.", + "default": "", + "optional": false }, { - "name": "eps", - "type": "float", - "description": "Earnings per share.", - "default": null, - "optional": true + "name": "last_investors_holding", + "type": "int", + "description": "Number of investors holding the stock in the last quarter.", + "default": "", + "optional": false }, { - "name": "pe", - "type": "float", - "description": "Price to earnings ratio.", - "default": null, - "optional": true + "name": "investors_holding_change", + "type": "int", + "description": "Change in the number of investors holding the stock.", + "default": "", + "optional": false }, { - "name": "shares_outstanding", + "name": "number_of_13f_shares", "type": "int", - "description": "Number of shares outstanding.", + "description": "Number of 13F shares.", "default": null, "optional": true }, { - "name": "name", - "type": "str", - "description": "The company name associated with the symbol.", + "name": "last_number_of_13f_shares", + "type": "int", + "description": "Number of 13F shares in the last quarter.", "default": null, "optional": true }, { - "name": "exchange", - "type": "str", - "description": "The exchange of the stock.", + "name": "number_of_13f_shares_change", + "type": "int", + "description": "Change in the number of 13F shares.", "default": null, "optional": true }, { - "name": "earnings_date", - "type": "Union[date, datetime]", - "description": "The upcoming earnings announcement date.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "last_price", + "name": "total_invested", "type": "float", - "description": "The last trade price.", - "default": null, - "optional": true - }, - { - "name": "last_size", - "type": "int", - "description": "The last trade size.", - "default": null, - "optional": true + "description": "Total amount invested.", + "default": "", + "optional": false }, { - "name": "last_volume", - "type": "int", - "description": "The last trade volume.", - "default": null, - "optional": true + "name": "last_total_invested", + "type": "float", + "description": "Total amount invested in the last quarter.", + "default": "", + "optional": false }, { - "name": "last_trade_timestamp", - "type": "datetime", - "description": "The timestamp of the last trade.", - "default": null, - "optional": true + "name": "total_invested_change", + "type": "float", + "description": "Change in the total amount invested.", + "default": "", + "optional": false }, { - "name": "bid_size", - "type": "int", - "description": "The size of the last bid price. Bid price and size is not always available.", - "default": null, - "optional": true + "name": "ownership_percent", + "type": "float", + "description": "Ownership percent.", + "default": "", + "optional": false }, { - "name": "bid_price", + "name": "last_ownership_percent", "type": "float", - "description": "The last bid price. Bid price and size is not always available.", - "default": null, - "optional": true + "description": "Ownership percent in the last quarter.", + "default": "", + "optional": false }, { - "name": "ask_price", + "name": "ownership_percent_change", "type": "float", - "description": "The last ask price. Ask price and size is not always available.", - "default": null, - "optional": true + "description": "Change in the ownership percent.", + "default": "", + "optional": false }, { - "name": "ask_size", + "name": "new_positions", "type": "int", - "description": "The size of the last ask price. Ask price and size is not always available.", - "default": null, - "optional": true + "description": "Number of new positions.", + "default": "", + "optional": false }, { - "name": "last_bid_timestamp", - "type": "datetime", - "description": "The timestamp of the last bid price. Bid price and size is not always available.", - "default": null, - "optional": true + "name": "last_new_positions", + "type": "int", + "description": "Number of new positions in the last quarter.", + "default": "", + "optional": false }, { - "name": "last_ask_timestamp", - "type": "datetime", - "description": "The timestamp of the last ask price. Ask price and size is not always available.", - "default": null, - "optional": true - } - ], - "polygon": [ - { - "name": "vwap", - "type": "float", - "description": "The volume weighted average price of the stock on the current trading day.", - "default": null, - "optional": true + "name": "new_positions_change", + "type": "int", + "description": "Change in the number of new positions.", + "default": "", + "optional": false }, { - "name": "prev_open", - "type": "float", - "description": "The previous trading session opening price.", - "default": null, - "optional": true + "name": "increased_positions", + "type": "int", + "description": "Number of increased positions.", + "default": "", + "optional": false }, { - "name": "prev_high", - "type": "float", - "description": "The previous trading session high price.", - "default": null, - "optional": true + "name": "last_increased_positions", + "type": "int", + "description": "Number of increased positions in the last quarter.", + "default": "", + "optional": false }, { - "name": "prev_low", - "type": "float", - "description": "The previous trading session low price.", - "default": null, - "optional": true + "name": "increased_positions_change", + "type": "int", + "description": "Change in the number of increased positions.", + "default": "", + "optional": false }, { - "name": "prev_volume", - "type": "float", - "description": "The previous trading session volume.", - "default": null, - "optional": true + "name": "closed_positions", + "type": "int", + "description": "Number of closed positions.", + "default": "", + "optional": false }, { - "name": "prev_vwap", - "type": "float", - "description": "The previous trading session VWAP.", - "default": null, - "optional": true + "name": "last_closed_positions", + "type": "int", + "description": "Number of closed positions in the last quarter.", + "default": "", + "optional": false }, { - "name": "last_updated", - "type": "datetime", - "description": "The last time the data was updated.", + "name": "closed_positions_change", + "type": "int", + "description": "Change in the number of closed positions.", "default": "", "optional": false }, { - "name": "bid", - "type": "float", - "description": "The current bid price.", - "default": null, - "optional": true + "name": "reduced_positions", + "type": "int", + "description": "Number of reduced positions.", + "default": "", + "optional": false }, { - "name": "bid_size", + "name": "last_reduced_positions", "type": "int", - "description": "The current bid size.", - "default": null, - "optional": true + "description": "Number of reduced positions in the last quarter.", + "default": "", + "optional": false }, { - "name": "ask_size", + "name": "reduced_positions_change", "type": "int", - "description": "The current ask size.", - "default": null, - "optional": true + "description": "Change in the number of reduced positions.", + "default": "", + "optional": false }, { - "name": "ask", - "type": "float", - "description": "The current ask price.", - "default": null, - "optional": true + "name": "total_calls", + "type": "int", + "description": "Total number of call options contracts traded for Apple Inc. on the specified date.", + "default": "", + "optional": false }, { - "name": "quote_timestamp", - "type": "datetime", - "description": "The timestamp of the last quote.", - "default": null, - "optional": true + "name": "last_total_calls", + "type": "int", + "description": "Total number of call options contracts traded for Apple Inc. on the previous reporting date.", + "default": "", + "optional": false }, { - "name": "last_trade_price", - "type": "float", - "description": "The last trade price.", - "default": null, - "optional": true + "name": "total_calls_change", + "type": "int", + "description": "Change in the total number of call options contracts traded between the current and previous reporting dates.", + "default": "", + "optional": false }, { - "name": "last_trade_size", + "name": "total_puts", "type": "int", - "description": "The last trade size.", - "default": null, - "optional": true + "description": "Total number of put options contracts traded for Apple Inc. on the specified date.", + "default": "", + "optional": false }, { - "name": "last_trade_conditions", - "type": "List[int]", - "description": "The last trade condition codes.", - "default": null, - "optional": true + "name": "last_total_puts", + "type": "int", + "description": "Total number of put options contracts traded for Apple Inc. on the previous reporting date.", + "default": "", + "optional": false }, { - "name": "last_trade_exchange", + "name": "total_puts_change", "type": "int", - "description": "The last trade exchange ID code.", - "default": null, - "optional": true + "description": "Change in the total number of put options contracts traded between the current and previous reporting dates.", + "default": "", + "optional": false }, { - "name": "last_trade_timestamp", - "type": "datetime", - "description": "The last trade timestamp.", - "default": null, - "optional": true + "name": "put_call_ratio", + "type": "float", + "description": "Put-call ratio, which is the ratio of the total number of put options to call options traded on the specified date.", + "default": "", + "optional": false + }, + { + "name": "last_put_call_ratio", + "type": "float", + "description": "Put-call ratio on the previous reporting date.", + "default": "", + "optional": false + }, + { + "name": "put_call_ratio_change", + "type": "float", + "description": "Change in the put-call ratio between the current and previous reporting dates.", + "default": "", + "optional": false } ] }, - "model": "MarketSnapshots" + "model": "InstitutionalOwnership" }, - "/etf/search": { + "/equity/ownership/insider_trading": { "deprecated": { "flag": null, "message": null }, - "description": "Search for ETFs.\n\nAn empty query returns the full list of ETFs from the provider.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# An empty query returns the full list of ETFs from the provider.\nobb.etf.search(provider='fmp')\n# The query will return results from text-based fields containing the term.\nobb.etf.search(query='commercial real estate', provider='fmp')\n```\n\n", + "description": "Get data about trading by a company's management team and board of directors.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.insider_trading(symbol='AAPL', provider='fmp')\nobb.equity.ownership.insider_trading(symbol='AAPL', limit=500, provider='intrinio')\n```\n\n", "parameters": { "standard": [ { - "name": "query", + "name": "symbol", "type": "str", - "description": "Search query.", + "description": "Symbol to get data for.", "default": "", + "optional": false + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 500, "optional": true }, { @@ -20647,27 +21385,41 @@ ], "fmp": [ { - "name": "exchange", - "type": "Literal['AMEX', 'NYSE', 'NASDAQ', 'ETF', 'TSX', 'EURONEXT']", - "description": "The exchange code the ETF trades on.", - "default": null, - "optional": true - }, - { - "name": "is_active", - "type": "Literal[True, False]", - "description": "Whether the ETF is actively trading.", + "name": "transaction_type", + "type": "Literal[None, 'award', 'conversion', 'return', 'expire_short', 'in_kind', 'gift', 'expire_long', 'discretionary', 'other', 'small', 'exempt', 'otm', 'purchase', 'sale', 'tender', 'will', 'itm', 'trust']", + "description": "Type of the transaction.", "default": null, "optional": true } ], "intrinio": [ { - "name": "exchange", - "type": "Literal['xnas', 'arcx', 'bats', 'xnys', 'bvmf', 'xshg', 'xshe', 'xhkg', 'xbom', 'xnse', 'xidx', 'tase', 'xkrx', 'xkls', 'xmex', 'xses', 'roco', 'xtai', 'xbkk', 'xist']", - "description": "Target a specific exchange by providing the MIC code.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "", + "optional": false + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "", + "optional": false + }, + { + "name": "ownership_type", + "type": "Literal['D', 'I']", + "description": "Type of ownership.", "default": null, "optional": true + }, + { + "name": "sort_by", + "type": "Literal['filing_date', 'updated_on']", + "description": "Field to sort by.", + "default": "updated_on", + "optional": true } ] }, @@ -20675,7 +21427,7 @@ "OBBject": [ { "name": "results", - "type": "List[EtfSearch]", + "type": "List[InsiderTrading]", "description": "Serializable results." }, { @@ -20705,286 +21457,270 @@ { "name": "symbol", "type": "str", - "description": "Symbol representing the entity requested in the data.(ETF)", - "default": "", - "optional": false + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true }, { - "name": "name", - "type": "str", - "description": "Name of the ETF.", + "name": "company_cik", + "type": "Union[int, str]", + "description": "CIK number of the company.", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "market_cap", - "type": "float", - "description": "The market cap of the ETF.", + "name": "filing_date", + "type": "Union[date, datetime]", + "description": "Filing date of the trade.", "default": null, "optional": true }, { - "name": "sector", - "type": "str", - "description": "The sector of the ETF.", + "name": "transaction_date", + "type": "date", + "description": "Date of the transaction.", "default": null, "optional": true }, { - "name": "industry", - "type": "str", - "description": "The industry of the ETF.", + "name": "owner_cik", + "type": "Union[int, str]", + "description": "Reporting individual's CIK.", "default": null, "optional": true }, { - "name": "beta", - "type": "float", - "description": "The beta of the ETF.", + "name": "owner_name", + "type": "str", + "description": "Name of the reporting individual.", "default": null, "optional": true }, { - "name": "price", - "type": "float", - "description": "The current price of the ETF.", + "name": "owner_title", + "type": "str", + "description": "The title held by the reporting individual.", "default": null, "optional": true }, { - "name": "last_annual_dividend", - "type": "float", - "description": "The last annual dividend paid.", + "name": "transaction_type", + "type": "str", + "description": "Type of transaction being reported.", "default": null, "optional": true }, { - "name": "volume", - "type": "float", - "description": "The current trading volume of the ETF.", + "name": "acquisition_or_disposition", + "type": "str", + "description": "Acquisition or disposition of the shares.", "default": null, "optional": true }, { - "name": "exchange", + "name": "security_type", "type": "str", - "description": "The exchange code the ETF trades on.", + "description": "The type of security transacted.", "default": null, "optional": true }, { - "name": "exchange_name", - "type": "str", - "description": "The full name of the exchange the ETF trades on.", + "name": "securities_owned", + "type": "float", + "description": "Number of securities owned by the reporting individual.", "default": null, "optional": true }, { - "name": "country", - "type": "str", - "description": "The country the ETF is registered in.", + "name": "securities_transacted", + "type": "float", + "description": "Number of securities transacted by the reporting individual.", "default": null, "optional": true }, { - "name": "actively_trading", - "type": "Literal[True, False]", - "description": "Whether the ETF is actively trading.", + "name": "transaction_price", + "type": "float", + "description": "The price of the transaction.", + "default": null, + "optional": true + }, + { + "name": "filing_url", + "type": "str", + "description": "Link to the filing.", "default": null, "optional": true } ], + "fmp": [ + { + "name": "form_type", + "type": "str", + "description": "Form type of the insider trading.", + "default": "", + "optional": false + } + ], "intrinio": [ { - "name": "exchange", + "name": "filing_url", "type": "str", - "description": "The exchange MIC code.", + "description": "URL of the filing.", "default": null, "optional": true }, { - "name": "figi_ticker", + "name": "company_name", "type": "str", - "description": "The OpenFIGI ticker.", + "description": "Name of the company.", + "default": "", + "optional": false + }, + { + "name": "conversion_exercise_price", + "type": "float", + "description": "Conversion/Exercise price of the shares.", "default": null, "optional": true }, { - "name": "ric", - "type": "str", - "description": "The Reuters Instrument Code.", + "name": "deemed_execution_date", + "type": "date", + "description": "Deemed execution date of the trade.", "default": null, "optional": true }, { - "name": "isin", - "type": "str", - "description": "The International Securities Identification Number.", + "name": "exercise_date", + "type": "date", + "description": "Exercise date of the trade.", "default": null, "optional": true }, { - "name": "sedol", - "type": "str", - "description": "The Stock Exchange Daily Official List.", + "name": "expiration_date", + "type": "date", + "description": "Expiration date of the derivative.", "default": null, "optional": true }, { - "name": "intrinio_id", + "name": "underlying_security_title", "type": "str", - "description": "The unique Intrinio ID for the security.", + "description": "Name of the underlying non-derivative security related to this derivative transaction.", "default": null, "optional": true - } - ] - }, - "model": "EtfSearch" - }, - "/etf/historical": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "ETF Historical Market Price.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.historical(symbol='SPY', provider='fmp')\nobb.etf.historical(symbol='SPY', provider='yfinance')\n# This function accepts multiple tickers.\nobb.etf.historical(symbol='SPY,IWM,QQQ,DJIA', provider='yfinance')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", - "default": "", - "optional": false }, { - "name": "interval", - "type": "str", - "description": "Time interval of the data to return.", - "default": "1d", + "name": "underlying_shares", + "type": "Union[int, float]", + "description": "Number of underlying shares related to this derivative transaction.", + "default": null, "optional": true }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "nature_of_ownership", + "type": "str", + "description": "Nature of ownership of the insider trading.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "director", + "type": "bool", + "description": "Whether the owner is a director.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']", - "description": "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.", - "default": "fmp", + "name": "officer", + "type": "bool", + "description": "Whether the owner is an officer.", + "default": null, "optional": true - } - ], - "fmp": [], - "intrinio": [ + }, { - "name": "start_time", - "type": "datetime.time", - "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'.", + "name": "ten_percent_owner", + "type": "bool", + "description": "Whether the owner is a 10% owner.", "default": null, "optional": true }, { - "name": "end_time", - "type": "datetime.time", - "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'.", + "name": "other_relation", + "type": "bool", + "description": "Whether the owner is having another relation.", "default": null, "optional": true }, { - "name": "timezone", - "type": "str", - "description": "Timezone of the data, in the IANA format (Continent/City).", - "default": "America/New_York", + "name": "derivative_transaction", + "type": "bool", + "description": "Whether the owner is having a derivative transaction.", + "default": null, "optional": true }, { - "name": "source", - "type": "Literal['realtime', 'delayed', 'nasdaq_basic']", - "description": "The source of the data.", - "default": "realtime", + "name": "report_line_number", + "type": "int", + "description": "Report line number of the insider trading.", + "default": null, "optional": true } - ], - "polygon": [ + ] + }, + "model": "InsiderTrading" + }, + "/equity/ownership/share_statistics": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get data about share float for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.share_statistics(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "adjustment", - "type": "Literal['splits_only', 'unadjusted']", - "description": "The adjustment factor to apply. Default is splits only.", - "default": "splits_only", - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "extended_hours", - "type": "bool", - "description": "Include Pre and Post market data.", - "default": false, + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'yfinance']", + "description": "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.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", - "default": "asc", - "optional": true - }, + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + } + ], + "intrinio": [ { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 49999, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false } ], - "tiingo": [], "yfinance": [ { - "name": "extended_hours", - "type": "bool", - "description": "Include Pre and Post market data.", - "default": false, - "optional": true - }, - { - "name": "include_actions", - "type": "bool", - "description": "Include dividends and stock splits in results.", - "default": true, - "optional": true - }, - { - "name": "adjustment", - "type": "Literal['splits_only', 'splits_and_dividends']", - "description": "The adjustment factor to apply. Default is splits only.", - "default": "splits_only", - "optional": true - }, - { - "name": "adjusted", - "type": "bool", - "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead.", - "default": false, - "optional": true - }, - { - "name": "prepost", - "type": "bool", - "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead.", - "default": false, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false } ] }, @@ -20992,12 +21728,12 @@ "OBBject": [ { "name": "results", - "type": "List[EtfHistorical]", + "type": "List[ShareStatistics]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']]", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", "description": "Provider name." }, { @@ -21020,291 +21756,379 @@ "data": { "standard": [ { - "name": "date", - "type": "Union[date, datetime]", - "description": "The date of the data.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "open", - "type": "float", - "description": "The open price.", - "default": "", - "optional": false + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": null, + "optional": true }, { - "name": "high", + "name": "free_float", "type": "float", - "description": "The high price.", - "default": "", - "optional": false + "description": "Percentage of unrestricted shares of a publicly-traded company.", + "default": null, + "optional": true }, { - "name": "low", + "name": "float_shares", "type": "float", - "description": "The low price.", - "default": "", - "optional": false + "description": "Number of shares available for trading by the general public.", + "default": null, + "optional": true }, { - "name": "close", + "name": "outstanding_shares", "type": "float", - "description": "The close price.", - "default": "", - "optional": false - }, - { - "name": "volume", - "type": "Union[int, float]", - "description": "The trading volume.", + "description": "Total number of shares of a publicly-traded company.", "default": null, "optional": true }, { - "name": "vwap", - "type": "float", - "description": "Volume Weighted Average Price over the period.", + "name": "source", + "type": "str", + "description": "Source of the received data.", "default": null, "optional": true } ], "fmp": [ { - "name": "adj_close", - "type": "float", - "description": "The adjusted close price.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", "default": null, "optional": true }, { - "name": "unadjusted_volume", + "name": "free_float", "type": "float", - "description": "Unadjusted volume of the symbol.", + "description": "Percentage of unrestricted shares of a publicly-traded company.", "default": null, "optional": true }, { - "name": "change", + "name": "float_shares", "type": "float", - "description": "Change in the price from the previous close.", + "description": "Number of shares available for trading by the general public.", "default": null, "optional": true }, { - "name": "change_percent", + "name": "outstanding_shares", "type": "float", - "description": "Change in the price from the previous close, as a normalized percent.", + "description": "Total number of shares of a publicly-traded company.", + "default": null, + "optional": true + }, + { + "name": "source", + "type": "str", + "description": "Source of the received data.", "default": null, "optional": true } ], "intrinio": [ { - "name": "average", + "name": "adjusted_outstanding_shares", "type": "float", - "description": "Average trade price of an individual equity during the interval.", + "description": "Total number of shares of a publicly-traded company, adjusted for splits.", "default": null, "optional": true }, { - "name": "change", + "name": "public_float", "type": "float", - "description": "Change in the price of the symbol from the previous day.", + "description": "Aggregate market value of the shares of a publicly-traded company.", "default": null, "optional": true - }, + } + ], + "yfinance": [ { - "name": "change_percent", - "type": "float", - "description": "Percent change in the price of the symbol from the previous day.", + "name": "implied_shares_outstanding", + "type": "int", + "description": "Implied Shares Outstanding of common equity, assuming the conversion of all convertible subsidiary equity into common.", "default": null, "optional": true }, { - "name": "adj_open", - "type": "float", - "description": "The adjusted open price.", + "name": "short_interest", + "type": "int", + "description": "Number of shares that are reported short.", "default": null, "optional": true }, { - "name": "adj_high", + "name": "short_percent_of_float", "type": "float", - "description": "The adjusted high price.", + "description": "Percentage of shares that are reported short, as a normalized percent.", "default": null, "optional": true }, { - "name": "adj_low", + "name": "days_to_cover", "type": "float", - "description": "The adjusted low price.", + "description": "Number of days to repurchase the shares as a ratio of average daily volume", "default": null, "optional": true }, { - "name": "adj_close", - "type": "float", - "description": "The adjusted close price.", + "name": "short_interest_prev_month", + "type": "int", + "description": "Number of shares that were reported short in the previous month.", "default": null, "optional": true }, { - "name": "adj_volume", - "type": "float", - "description": "The adjusted volume.", + "name": "short_interest_prev_date", + "type": "date", + "description": "Date of the previous month's report.", "default": null, "optional": true }, { - "name": "fifty_two_week_high", + "name": "insider_ownership", "type": "float", - "description": "52 week high price for the symbol.", + "description": "Percentage of shares held by insiders, as a normalized percent.", "default": null, "optional": true }, { - "name": "fifty_two_week_low", + "name": "institution_ownership", "type": "float", - "description": "52 week low price for the symbol.", + "description": "Percentage of shares held by institutions, as a normalized percent.", "default": null, "optional": true }, { - "name": "factor", + "name": "institution_float_ownership", "type": "float", - "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices.", + "description": "Percentage of float held by institutions, as a normalized percent.", "default": null, "optional": true }, { - "name": "split_ratio", - "type": "float", - "description": "Ratio of the equity split, if a split occurred.", + "name": "institutions_count", + "type": "int", + "description": "Number of institutions holding shares.", "default": null, "optional": true + } + ] + }, + "model": "ShareStatistics" + }, + "/equity/ownership/form_13f": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the form 13F.\n\nThe Securities and Exchange Commission's (SEC) Form 13F is a quarterly report\nthat is required to be filed by all institutional investment managers with at least\n$100 million in assets under management.\nManagers are required to file Form 13F within 45 days after the last day of the calendar quarter.\nMost funds wait until the end of this period in order to conceal\ntheir investment strategy from competitors and the public.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.form_13f(symbol='NVDA', provider='sec')\n# Enter a date (calendar quarter ending) for a specific report.\nobb.equity.ownership.form_13f(symbol='BRK-A', date='2016-09-30', provider='sec')\n# Example finding Michael Burry's filings.\ncik = obb.regulators.sec.institutions_search(\"Scion Asset Management\").results[0].cik\n# Use the `limit` parameter to return N number of reports from the most recent.\nobb.equity.ownership.form_13f(cik, limit=2).to_df()\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. A CIK or Symbol can be used.", + "default": "", + "optional": false }, { - "name": "dividend", - "type": "float", - "description": "Dividend amount, if a dividend was paid.", + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported.", "default": null, "optional": true }, { - "name": "close_time", - "type": "datetime", - "description": "The timestamp that represents the end of the interval span.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter.", + "default": 1, "optional": true }, { - "name": "interval", + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", + "optional": true + } + ], + "sec": [ + { + "name": "symbol", "type": "str", - "description": "The data time frequency.", + "description": "Symbol to get data for. A CIK or Symbol can be used.", + "default": "", + "optional": false + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported.", "default": null, "optional": true }, { - "name": "intra_period", - "type": "bool", - "description": "If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter.", + "default": 1, "optional": true } - ], - "polygon": [ + ] + }, + "returns": { + "OBBject": [ { - "name": "transactions", - "type": "Annotated[int, Gt(gt=0)]", - "description": "Number of transactions for the symbol in the time period.", - "default": null, - "optional": true + "name": "results", + "type": "List[Form13FHR]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['sec']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } - ], - "tiingo": [ + ] + }, + "data": { + "standard": [ { - "name": "adj_open", - "type": "float", - "description": "The adjusted open price.", - "default": null, - "optional": true + "name": "period_ending", + "type": "date", + "description": "The end-of-quarter date of the filing.", + "default": "", + "optional": false }, { - "name": "adj_high", - "type": "float", - "description": "The adjusted high price.", - "default": null, - "optional": true + "name": "issuer", + "type": "str", + "description": "The name of the issuer.", + "default": "", + "optional": false }, { - "name": "adj_low", - "type": "float", - "description": "The adjusted low price.", - "default": null, - "optional": true + "name": "cusip", + "type": "str", + "description": "The CUSIP of the security.", + "default": "", + "optional": false }, { - "name": "adj_close", - "type": "float", - "description": "The adjusted close price.", + "name": "asset_class", + "type": "str", + "description": "The title of the asset class for the security.", + "default": "", + "optional": false + }, + { + "name": "security_type", + "type": "Literal['SH', 'PRN']", + "description": "The total number of shares of the class of security or the principal amount of such class. 'SH' for shares. 'PRN' for principal amount. Convertible debt securities are reported as 'PRN'.", "default": null, "optional": true }, { - "name": "adj_volume", - "type": "float", - "description": "The adjusted volume.", + "name": "option_type", + "type": "Literal['call', 'put']", + "description": "Defined when the holdings being reported are put or call options. Only long positions are reported.", "default": null, "optional": true }, { - "name": "split_ratio", - "type": "float", - "description": "Ratio of the equity split, if a split occurred.", + "name": "voting_authority_sole", + "type": "int", + "description": "The number of shares for which the Manager exercises sole voting authority (none).", "default": null, "optional": true }, { - "name": "dividend", - "type": "float", - "description": "Dividend amount, if a dividend was paid.", + "name": "voting_authority_shared", + "type": "int", + "description": "The number of shares for which the Manager exercises a defined shared voting authority (none).", "default": null, "optional": true - } - ], - "yfinance": [ + }, { - "name": "split_ratio", - "type": "float", - "description": "Ratio of the equity split, if a split occurred.", + "name": "voting_authority_other", + "type": "int", + "description": "The number of shares for which the Manager exercises other shared voting authority (none).", "default": null, "optional": true }, { - "name": "dividend", + "name": "principal_amount", + "type": "int", + "description": "The total number of shares of the class of security or the principal amount of such class. Only long positions are reported", + "default": "", + "optional": false + }, + { + "name": "value", + "type": "int", + "description": "The fair market value of the holding of the particular class of security. The value reported for options is the fair market value of the underlying security with respect to the number of shares controlled. Values are rounded to the nearest US dollar and use the closing price of the last trading day of the calendar year or quarter.", + "default": "", + "optional": false + } + ], + "sec": [ + { + "name": "weight", "type": "float", - "description": "Dividend amount (split-adjusted), if a dividend was paid.", - "default": null, - "optional": true + "description": "The weight of the security relative to the market value of all securities in the filing , as a normalized percent.", + "default": "", + "optional": false } ] }, - "model": "EtfHistorical" + "model": "Form13FHR" }, - "/etf/info": { + "/equity/price/quote": { "deprecated": { "flag": null, "message": null }, - "description": "ETF Information Overview.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.info(symbol='SPY', provider='fmp')\n# This function accepts multiple tickers.\nobb.etf.info(symbol='SPY,IWM,QQQ,DJIA', provider='fmp')\n```\n\n", + "description": "Get the latest quote for a given stock. Quote includes price, volume, and other data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.quote(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, intrinio, yfinance.", + "type": "str", + "description": "Symbol to get data for.", "default": "", "optional": false }, @@ -21316,15 +22140,46 @@ "optional": true } ], - "fmp": [], - "intrinio": [], - "yfinance": [] + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", + "default": "", + "optional": false + }, + { + "name": "source", + "type": "Literal['iex', 'bats', 'bats_delayed', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed', 'intrinio_mx', 'intrinio_mx_plus', 'delayed_sip']", + "description": "Source of the data.", + "default": "iex", + "optional": true + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + } + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EtfInfo]", + "type": "List[EquityQuote]", "description": "Serializable results." }, { @@ -21354,1323 +22209,5301 @@ { "name": "symbol", "type": "str", - "description": "Symbol representing the entity requested in the data. (ETF)", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "name", + "name": "asset_type", "type": "str", - "description": "Name of the ETF.", - "default": "", - "optional": false - }, - { - "name": "description", - "type": "str", - "description": "Description of the fund.", + "description": "Type of asset - i.e, stock, ETF, etc.", "default": null, "optional": true }, { - "name": "inception_date", - "type": "str", - "description": "Inception date of the ETF.", - "default": "", - "optional": false - } - ], - "fmp": [ - { - "name": "issuer", + "name": "name", "type": "str", - "description": "Company of the ETF.", + "description": "Name of the company or asset.", "default": null, "optional": true }, { - "name": "cusip", + "name": "exchange", "type": "str", - "description": "CUSIP of the ETF.", + "description": "The name or symbol of the venue where the data is from.", "default": null, "optional": true }, { - "name": "isin", - "type": "str", - "description": "ISIN of the ETF.", + "name": "bid", + "type": "float", + "description": "Price of the top bid order.", "default": null, "optional": true }, { - "name": "domicile", - "type": "str", - "description": "Domicile of the ETF.", + "name": "bid_size", + "type": "int", + "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", "default": null, "optional": true }, { - "name": "asset_class", + "name": "bid_exchange", "type": "str", - "description": "Asset class of the ETF.", + "description": "The specific trading venue where the purchase order was placed.", "default": null, "optional": true }, { - "name": "aum", + "name": "ask", "type": "float", - "description": "Assets under management.", + "description": "Price of the top ask order.", "default": null, "optional": true }, { - "name": "nav", - "type": "float", - "description": "Net asset value of the ETF.", + "name": "ask_size", + "type": "int", + "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", "default": null, "optional": true }, { - "name": "nav_currency", + "name": "ask_exchange", "type": "str", - "description": "Currency of the ETF's net asset value.", + "description": "The specific trading venue where the sale order was placed.", "default": null, "optional": true }, { - "name": "expense_ratio", - "type": "float", - "description": "The expense ratio, as a normalized percent.", + "name": "quote_conditions", + "type": "Union[str, int, List[str], List[int]]", + "description": "Conditions or condition codes applicable to the quote.", "default": null, "optional": true }, { - "name": "holdings_count", - "type": "int", - "description": "Number of holdings.", + "name": "quote_indicators", + "type": "Union[str, int, List[str], List[int]]", + "description": "Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO.", "default": null, "optional": true }, { - "name": "avg_volume", - "type": "float", - "description": "Average daily trading volume.", + "name": "sales_conditions", + "type": "Union[str, int, List[str], List[int]]", + "description": "Conditions or condition codes applicable to the sale.", "default": null, "optional": true }, { - "name": "website", - "type": "str", - "description": "Website of the issuer.", + "name": "sequence_number", + "type": "int", + "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11).", "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "fund_listing_date", - "type": "date", - "description": "The date on which the Exchange Traded Product (ETP) or share class of the ETP is listed on a specific exchange.", + "name": "market_center", + "type": "str", + "description": "The ID of the UTP participant that originated the message.", "default": null, "optional": true }, { - "name": "data_change_date", - "type": "date", - "description": "The last date on which there was a change in a classifications data field for this ETF.", + "name": "participant_timestamp", + "type": "datetime", + "description": "Timestamp for when the quote was generated by the exchange.", "default": null, "optional": true }, { - "name": "etn_maturity_date", - "type": "date", - "description": "If the product is an ETN, this field identifies the maturity date for the ETN.", + "name": "trf_timestamp", + "type": "datetime", + "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message.", "default": null, "optional": true }, { - "name": "is_listed", - "type": "bool", - "description": "If true, the ETF is still listed on an exchange.", + "name": "sip_timestamp", + "type": "datetime", + "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange.", "default": null, "optional": true }, { - "name": "close_date", - "type": "date", - "description": "The date on which the ETF was de-listed if it is no longer listed.", + "name": "last_price", + "type": "float", + "description": "Price of the last trade.", "default": null, "optional": true }, { - "name": "exchange", + "name": "last_tick", "type": "str", - "description": "The exchange Market Identifier Code (MIC).", + "description": "Whether the last sale was an up or down tick.", "default": null, "optional": true }, { - "name": "isin", - "type": "str", - "description": "International Securities Identification Number (ISIN).", + "name": "last_size", + "type": "int", + "description": "Size of the last trade.", "default": null, "optional": true }, { - "name": "ric", - "type": "str", - "description": "Reuters Instrument Code (RIC).", + "name": "last_timestamp", + "type": "datetime", + "description": "Date and Time when the last price was recorded.", "default": null, "optional": true }, { - "name": "sedol", - "type": "str", - "description": "Stock Exchange Daily Official List (SEDOL).", + "name": "open", + "type": "float", + "description": "The open price.", "default": null, "optional": true }, { - "name": "figi_symbol", - "type": "str", - "description": "Financial Instrument Global Identifier (FIGI) symbol.", + "name": "high", + "type": "float", + "description": "The high price.", "default": null, "optional": true }, { - "name": "share_class_figi", - "type": "str", - "description": "Financial Instrument Global Identifier (FIGI).", + "name": "low", + "type": "float", + "description": "The low price.", "default": null, "optional": true }, { - "name": "firstbridge_id", - "type": "str", - "description": "The FirstBridge unique identifier for the Exchange Traded Fund (ETF).", + "name": "close", + "type": "float", + "description": "The close price.", "default": null, "optional": true }, { - "name": "firstbridge_parent_id", - "type": "str", - "description": "The FirstBridge unique identifier for the parent Exchange Traded Fund (ETF), if applicable.", + "name": "volume", + "type": "Union[int, float]", + "description": "The trading volume.", "default": null, "optional": true }, { - "name": "intrinio_id", - "type": "str", - "description": "Intrinio unique identifier for the security.", + "name": "exchange_volume", + "type": "Union[int, float]", + "description": "Volume of shares exchanged during the trading day on the specific exchange.", "default": null, "optional": true }, { - "name": "intraday_nav_symbol", - "type": "str", - "description": "Intraday Net Asset Value (NAV) symbol.", + "name": "prev_close", + "type": "float", + "description": "The previous close price.", "default": null, "optional": true }, { - "name": "primary_symbol", - "type": "str", - "description": "The primary ticker field is used for Exchange Traded Products (ETPs) that have multiple listings and share classes. If an ETP has multiple listings or share classes, the same primary ticker is assigned to all the listings and share classes.", + "name": "change", + "type": "float", + "description": "Change in price from previous close.", "default": null, "optional": true }, { - "name": "etp_structure_type", - "type": "str", - "description": "Classifies Exchange Traded Products (ETPs) into very broad categories based on its legal structure.", + "name": "change_percent", + "type": "float", + "description": "Change in price as a normalized percentage.", "default": null, "optional": true }, { - "name": "legal_structure", - "type": "str", - "description": "Legal structure of the fund.", + "name": "year_high", + "type": "float", + "description": "The one year high (52W High).", "default": null, "optional": true }, { - "name": "issuer", - "type": "str", - "description": "Issuer of the ETF.", + "name": "year_low", + "type": "float", + "description": "The one year low (52W Low).", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "etn_issuing_bank", - "type": "str", - "description": "If the product is an Exchange Traded Note (ETN), this field identifies the issuing bank.", + "name": "price_avg50", + "type": "float", + "description": "50 day moving average price.", "default": null, "optional": true }, { - "name": "fund_family", - "type": "str", - "description": "This field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor.", + "name": "price_avg200", + "type": "float", + "description": "200 day moving average price.", "default": null, "optional": true }, { - "name": "investment_style", - "type": "str", - "description": "Investment style of the ETF.", + "name": "avg_volume", + "type": "int", + "description": "Average volume over the last 10 trading days.", "default": null, "optional": true }, { - "name": "derivatives_based", - "type": "str", - "description": "This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio.", + "name": "market_cap", + "type": "float", + "description": "Market cap of the company.", "default": null, "optional": true }, { - "name": "income_category", - "type": "str", - "description": "Identifies if an Exchange Traded Fund (ETF) falls into a category that is specifically designed to provide a high yield or income", + "name": "shares_outstanding", + "type": "int", + "description": "Number of shares outstanding.", "default": null, "optional": true }, { - "name": "asset_class", - "type": "str", - "description": "Captures the underlying nature of the securities in the Exchanged Traded Product (ETP).", + "name": "eps", + "type": "float", + "description": "Earnings per share.", "default": null, "optional": true }, { - "name": "other_asset_types", - "type": "str", - "description": "If 'asset_class' field is classified as 'Other Asset Types' this field captures the specific category of the underlying assets.", + "name": "pe", + "type": "float", + "description": "Price earnings ratio.", "default": null, "optional": true }, { - "name": "single_category_designation", - "type": "str", - "description": "This categorization is created for those users who want every ETF to be 'forced' into a single bucket, so that the assets for all categories will always sum to the total market.", + "name": "earnings_announcement", + "type": "datetime", + "description": "Upcoming earnings announcement date.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "beta_type", - "type": "str", - "description": "This field identifies whether an ETF provides 'Traditional' beta exposure or 'Smart' beta exposure. ETFs that are active (i.e. non-indexed), leveraged / inverse or have a proprietary quant model (i.e. that don't provide indexed exposure to a targeted factor) are classified separately.", + "name": "is_darkpool", + "type": "bool", + "description": "Whether or not the current trade is from a darkpool.", "default": null, "optional": true }, { - "name": "beta_details", + "name": "source", "type": "str", - "description": "This field provides further detail within the traditional and smart beta categories.", + "description": "Source of the Intrinio data.", "default": null, "optional": true }, { - "name": "market_cap_range", - "type": "str", - "description": "Equity ETFs are classified as falling into categories based on the description of their investment strategy in the prospectus. Examples ('Mega Cap', 'Large Cap', 'Mid Cap', etc.)", - "default": null, - "optional": true + "name": "updated_on", + "type": "datetime", + "description": "Date and Time when the data was last updated.", + "default": "", + "optional": false }, { - "name": "market_cap_weighting_type", - "type": "str", - "description": "For ETFs that take the value 'Market Cap Weighted' in the 'index_weighting_scheme' field, this field provides detail on the market cap weighting type.", + "name": "security", + "type": "IntrinioSecurity", + "description": "Security details related to the quote.", "default": null, "optional": true - }, + } + ], + "yfinance": [ { - "name": "index_weighting_scheme", - "type": "str", - "description": "For ETFs that track an underlying index, this field provides detail on the index weighting type.", + "name": "ma_50d", + "type": "float", + "description": "50-day moving average price.", "default": null, "optional": true }, { - "name": "index_linked", - "type": "str", - "description": "This field identifies whether an ETF is index linked or active.", + "name": "ma_200d", + "type": "float", + "description": "200-day moving average price.", "default": null, "optional": true }, { - "name": "index_name", - "type": "str", - "description": "This field identifies the name of the underlying index tracked by the ETF, if applicable.", + "name": "volume_average", + "type": "float", + "description": "Average daily trading volume.", "default": null, "optional": true }, { - "name": "index_symbol", - "type": "str", - "description": "This field identifies the OpenFIGI ticker for the Index underlying the ETF.", + "name": "volume_average_10d", + "type": "float", + "description": "Average daily trading volume in the last 10 days.", "default": null, "optional": true }, { - "name": "parent_index", + "name": "currency", "type": "str", - "description": "This field identifies the name of the parent index, which represents the broader universe from which the index underlying the ETF is created, if applicable.", + "description": "Currency of the price.", "default": null, "optional": true - }, + } + ] + }, + "model": "EquityQuote" + }, + "/equity/price/nbbo": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the National Best Bid and Offer for a given stock.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.nbbo(symbol='AAPL', provider='polygon')\n```\n\n", + "parameters": { + "standard": [ { - "name": "index_family", + "name": "symbol", "type": "str", - "description": "This field identifies the index family to which the index underlying the ETF belongs. The index family is represented as categorized by the index provider.", - "default": null, - "optional": true + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "broader_index_family", - "type": "str", - "description": "This field identifies the broader index family to which the index underlying the ETF belongs. The broader index family is represented as categorized by the index provider.", - "default": null, + "name": "provider", + "type": "Literal['polygon']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'polygon' if there is no default.", + "default": "polygon", "optional": true - }, + } + ], + "polygon": [ { - "name": "index_provider", - "type": "str", - "description": "This field identifies the Index provider for the index underlying the ETF, if applicable.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return. Up to ten million records will be returned. Pagination occurs in groups of 50,000. Remaining limit values will always return 50,000 more records unless it is the last page. High volume tickers will require multiple max requests for a single day's NBBO records. Expect stocks, like SPY, to approach 1GB in size, per day, as a raw CSV. Splitting large requests into chunks is recommended for full-day requests of high-volume symbols.", + "default": 50000, "optional": true }, { - "name": "index_provider_code", - "type": "str", - "description": "This field provides the First Bridge code for each Index provider, corresponding to the index underlying the ETF if applicable.", + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for. Use bracketed the timestamp parameters to specify exact time ranges.", "default": null, "optional": true }, { - "name": "replication_structure", - "type": "str", - "description": "The replication structure of the Exchange Traded Product (ETP).", + "name": "timestamp_lt", + "type": "Union[datetime, str]", + "description": "Query by datetime, less than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", "default": null, "optional": true }, { - "name": "growth_value_tilt", - "type": "str", - "description": "Classifies equity ETFs as either 'Growth' or Value' based on the stated style tilt in the ETF prospectus. Equity ETFs that do not have a stated style tilt are classified as 'Core / Blend'.", + "name": "timestamp_gt", + "type": "Union[datetime, str]", + "description": "Query by datetime, greater than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", "default": null, "optional": true }, { - "name": "growth_type", - "type": "str", - "description": "For ETFs that are classified as 'Growth' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their growth (style factor) scores.", + "name": "timestamp_lte", + "type": "Union[datetime, str]", + "description": "Query by datetime, less than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", "default": null, "optional": true }, { - "name": "value_type", - "type": "str", - "description": "For ETFs that are classified as 'Value' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their value (style factor) scores.", + "name": "timestamp_gte", + "type": "Union[datetime, str]", + "description": "Query by datetime, greater than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", "default": null, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityNBBO]", + "description": "Serializable results." }, { - "name": "sector", - "type": "str", - "description": "For equity ETFs that aim to provide targeted exposure to a sector or industry, this field identifies the Sector that it provides the exposure to.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['polygon']]", + "description": "Provider name." }, { - "name": "industry", - "type": "str", - "description": "For equity ETFs that aim to provide targeted exposure to an industry, this field identifies the Industry that it provides the exposure to.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "industry_group", - "type": "str", - "description": "For equity ETFs that aim to provide targeted exposure to a sub-industry, this field identifies the sub-Industry that it provides the exposure to.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "cross_sector_theme", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "ask_exchange", "type": "str", - "description": "For equity ETFs that aim to provide targeted exposure to a specific investment theme that cuts across GICS sectors, this field identifies the specific cross-sector theme. Examples ('Agri-business', 'Natural Resources', 'Green Investing', etc.)", - "default": null, - "optional": true + "description": "The exchange ID for the ask.", + "default": "", + "optional": false }, { - "name": "natural_resources_type", - "type": "str", - "description": "For ETFs that are classified as 'Natural Resources' in the 'cross_sector_theme' field, this field provides further detail on the type of Natural Resources exposure.", - "default": null, - "optional": true + "name": "ask", + "type": "float", + "description": "The last ask price.", + "default": "", + "optional": false }, { - "name": "us_or_excludes_us", - "type": "str", - "description": "Takes the value of 'Domestic' for US exposure, 'International' for non-US exposure and 'Global' for exposure that includes all regions including the US.", - "default": null, - "optional": true + "name": "ask_size", + "type": "int", + "description": "The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price.", + "default": "", + "optional": false }, { - "name": "developed_emerging", - "type": "str", - "description": "This field identifies the stage of development of the markets that the ETF provides exposure to.", - "default": null, - "optional": true + "name": "bid_size", + "type": "int", + "description": "The bid size in round lots.", + "default": "", + "optional": false }, { - "name": "specialized_region", - "type": "str", - "description": "This field is populated if the ETF provides targeted exposure to a specific type of geography-based grouping that does not fall into a specific country or continent grouping. Examples ('BRIC', 'Chindia', etc.)", - "default": null, - "optional": true + "name": "bid", + "type": "float", + "description": "The last bid price.", + "default": "", + "optional": false }, { - "name": "continent", + "name": "bid_exchange", "type": "str", - "description": "This field is populated if the ETF provides targeted exposure to a specific continent or country within that Continent.", - "default": null, - "optional": true - }, + "description": "The exchange ID for the bid.", + "default": "", + "optional": false + } + ], + "polygon": [ { - "name": "latin_america_sub_group", + "name": "tape", "type": "str", - "description": "For ETFs that are classified as 'Latin America' in the 'continent' field, this field provides further detail on the type of regional exposure.", + "description": "The exchange tape.", "default": null, "optional": true }, { - "name": "europe_sub_group", - "type": "str", - "description": "For ETFs that are classified as 'Europe' in the 'continent' field, this field provides further detail on the type of regional exposure.", + "name": "conditions", + "type": "Union[str, List[int], List[str]]", + "description": "A list of condition codes.", "default": null, "optional": true }, { - "name": "asia_sub_group", - "type": "str", - "description": "For ETFs that are classified as 'Asia' in the 'continent' field, this field provides further detail on the type of regional exposure.", + "name": "indicators", + "type": "List[int]", + "description": "A list of indicator codes.", "default": null, "optional": true }, { - "name": "specific_country", - "type": "str", - "description": "This field is populated if the ETF provides targeted exposure to a specific country.", + "name": "sequence_num", + "type": "int", + "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11)", "default": null, "optional": true }, { - "name": "china_listing_location", - "type": "str", - "description": "For ETFs that are classified as 'China' in the 'country' field, this field provides further detail on the type of exposure in the underlying securities.", + "name": "participant_timestamp", + "type": "datetime", + "description": "The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.", "default": null, "optional": true }, { - "name": "us_state", - "type": "str", - "description": "Takes the value of a US state if the ETF provides targeted exposure to the municipal bonds or equities of companies.", + "name": "sip_timestamp", + "type": "datetime", + "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it.", "default": null, "optional": true }, { - "name": "real_estate", - "type": "str", - "description": "For ETFs that provide targeted real estate exposure, this field is populated if the ETF provides targeted exposure to a specific segment of the real estate market.", + "name": "trf_timestamp", + "type": "datetime", + "description": "The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this quote.", "default": null, "optional": true - }, + } + ] + }, + "model": "EquityNBBO" + }, + "/equity/price/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical price data for a given stock. This includes open, high, low, close, and volume.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.historical(symbol='AAPL', provider='fmp')\nobb.equity.price.historical(symbol='AAPL', interval='1d', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ { - "name": "fundamental_weighting_type", + "name": "symbol", "type": "str", - "description": "For ETFs that take the value 'Fundamental Weighted' in the 'index_weighting_scheme' field, this field provides detail on the fundamental weighting methodology.", - "default": null, - "optional": true + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "dividend_weighting_type", + "name": "interval", "type": "str", - "description": "For ETFs that take the value 'Dividend Weighted' in the 'index_weighting_scheme' field, this field provides detail on the dividend weighting methodology.", - "default": null, + "description": "Time interval of the data to return.", + "default": "1d", "optional": true }, { - "name": "bond_type", - "type": "str", - "description": "For ETFs where 'asset_class_type' is 'Bonds', this field provides detail on the type of bonds held in the ETF.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "government_bond_types", - "type": "str", - "description": "For bond ETFs that take the value 'Treasury & Government' in 'bond_type', this field provides detail on the exposure.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "municipal_bond_region", - "type": "str", - "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field provides additional detail on the geographic exposure.", - "default": null, + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']", + "description": "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.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "municipal_vrdo", - "type": "bool", - "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field identifies those ETFs that specifically provide exposure to Variable Rate Demand Obligations.", - "default": null, + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", "optional": true - }, + } + ], + "intrinio": [ { - "name": "mortgage_bond_types", + "name": "symbol", "type": "str", - "description": "For bond ETFs that take the value 'Mortgage' in 'bond_type', this field provides additional detail on the type of underlying securities.", - "default": null, - "optional": true + "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", + "default": "", + "optional": false }, { - "name": "bond_tax_status", - "type": "str", - "description": "For all US bond ETFs, this field provides additional detail on the tax treatment of the underlying securities.", - "default": null, + "name": "interval", + "type": "Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y']", + "description": "Time interval of the data to return.", + "default": "1d", "optional": true }, { - "name": "credit_quality", - "type": "str", - "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific credit quality range.", + "name": "start_time", + "type": "datetime.time", + "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'.", "default": null, "optional": true }, { - "name": "average_maturity", - "type": "str", - "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific maturity range.", + "name": "end_time", + "type": "datetime.time", + "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'.", "default": null, "optional": true }, { - "name": "specific_maturity_year", - "type": "int", - "description": "For all bond ETFs that take the value 'Specific Maturity Year' in the 'average_maturity' field, this field specifies the calendar year.", - "default": null, + "name": "timezone", + "type": "str", + "description": "Timezone of the data, in the IANA format (Continent/City).", + "default": "America/New_York", "optional": true }, { - "name": "commodity_types", - "type": "str", - "description": "For ETFs where 'asset_class_type' is 'Commodities', this field provides detail on the type of commodities held in the ETF.", - "default": null, + "name": "source", + "type": "Literal['realtime', 'delayed', 'nasdaq_basic']", + "description": "The source of the data.", + "default": "realtime", "optional": true - }, + } + ], + "polygon": [ { - "name": "energy_type", + "name": "interval", "type": "str", - "description": "For ETFs where 'commodity_type' is 'Energy', this field provides detail on the type of energy exposure provided by the ETF.", - "default": null, + "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", + "default": "1d", "optional": true }, { - "name": "agricultural_type", - "type": "str", - "description": "For ETFs where 'commodity_type' is 'Agricultural', this field provides detail on the type of agricultural exposure provided by the ETF.", - "default": null, + "name": "adjustment", + "type": "Literal['splits_only', 'unadjusted']", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", "optional": true }, { - "name": "livestock_type", - "type": "str", - "description": "For ETFs where 'commodity_type' is 'Livestock', this field provides detail on the type of livestock exposure provided by the ETF.", - "default": null, + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": false, "optional": true }, { - "name": "metal_type", - "type": "str", - "description": "For ETFs where 'commodity_type' is 'Gold & Metals', this field provides detail on the type of exposure provided by the ETF.", - "default": null, + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", + "default": "asc", "optional": true }, { - "name": "inverse_leveraged", - "type": "str", - "description": "This field is populated if the ETF provides inverse or leveraged exposure.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 49999, "optional": true - }, + } + ], + "tiingo": [ { - "name": "target_date_multi_asset_type", - "type": "str", - "description": "For ETFs where 'asset_class_type' is 'Target Date / MultiAsset', this field provides detail on the type of commodities held in the ETF.", - "default": null, + "name": "interval", + "type": "Literal['1d', '1W', '1M', '1Y']", + "description": "Time interval of the data to return.", + "default": "1d", "optional": true - }, + } + ], + "yfinance": [ { - "name": "currency_pair", - "type": "str", - "description": "This field is populated if the ETF's strategy involves providing exposure to the movements of a currency or involves hedging currency exposure.", - "default": null, + "name": "interval", + "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", + "description": "Time interval of the data to return.", + "default": "1d", "optional": true }, { - "name": "social_environmental_type", - "type": "str", - "description": "This field is populated if the ETF's strategy involves providing exposure to a specific social or environmental theme.", - "default": null, + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": false, "optional": true }, { - "name": "clean_energy_type", - "type": "str", - "description": "This field is populated if the ETF has a value of 'Clean Energy' in the 'social_environmental_type' field.", - "default": null, + "name": "include_actions", + "type": "bool", + "description": "Include dividends and stock splits in results.", + "default": true, "optional": true }, { - "name": "dividend_type", - "type": "str", - "description": "This field is populated if the ETF has an intended investment objective of holding dividend-oriented stocks as stated in the prospectus.", - "default": null, + "name": "adjustment", + "type": "Literal['splits_only', 'splits_and_dividends']", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", "optional": true }, { - "name": "regular_dividend_payor_type", - "type": "str", - "description": "This field is populated if the ETF has a value of'Dividend - Regular Payors' in the 'dividend_type' field.", - "default": null, + "name": "adjusted", + "type": "bool", + "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead.", + "default": false, "optional": true }, { - "name": "quant_strategies_type", - "type": "str", - "description": "This field is populated if the ETF has either an index-linked or active strategy that is based on a proprietary quantitative strategy.", - "default": null, + "name": "prepost", + "type": "bool", + "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead.", + "default": false, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityHistorical]", + "description": "Serializable results." }, { - "name": "other_quant_models", - "type": "str", - "description": "For ETFs where 'quant_strategies_type' is 'Other Quant Model', this field provides the name of the specific proprietary quant model used as the underlying strategy for the ETF.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']]", + "description": "Provider name." }, { - "name": "hedge_fund_type", - "type": "str", - "description": "For ETFs where 'other_asset_types' is 'Hedge Fund Replication', this field provides detail on the type of hedge fund replication strategy.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "excludes_financials", - "type": "bool", - "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold financials stocks, based on the funds intended objective.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "excludes_technology", - "type": "bool", - "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold technology stocks, based on the funds intended objective.", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "Union[int, float]", + "description": "The trading volume.", "default": null, "optional": true }, { - "name": "holds_only_nyse_stocks", - "type": "bool", - "description": "If true, the ETF is an equity ETF and holds only stocks listed on NYSE.", + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "holds_only_nasdaq_stocks", - "type": "bool", - "description": "If true, the ETF is an equity ETF and holds only stocks listed on Nasdaq.", + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", "default": null, "optional": true }, { - "name": "holds_mlp", - "type": "bool", - "description": "If true, the ETF's investment objective explicitly specifies that it holds MLPs as an intended part of its investment strategy.", + "name": "unadjusted_volume", + "type": "float", + "description": "Unadjusted volume of the symbol.", "default": null, "optional": true }, { - "name": "holds_preferred_stock", - "type": "bool", - "description": "If true, the ETF's investment objective explicitly specifies that it holds preferred stock as an intended part of its investment strategy.", + "name": "change", + "type": "float", + "description": "Change in the price from the previous close.", "default": null, "optional": true }, { - "name": "holds_closed_end_funds", - "type": "bool", - "description": "If true, the ETF's investment objective explicitly specifies that it holds closed end funds as an intended part of its investment strategy.", + "name": "change_percent", + "type": "float", + "description": "Change in the price from the previous close, as a normalized percent.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "average", + "type": "float", + "description": "Average trade price of an individual equity during the interval.", "default": null, "optional": true }, { - "name": "holds_adr", - "type": "bool", - "description": "If true, he ETF's investment objective explicitly specifies that it holds American Depositary Receipts (ADRs) as an intended part of its investment strategy.", + "name": "change", + "type": "float", + "description": "Change in the price of the symbol from the previous day.", "default": null, "optional": true }, { - "name": "laddered", - "type": "bool", - "description": "For bond ETFs, this field identifies those ETFs that specifically hold bonds in a laddered structure, where the bonds are scheduled to mature in an annual, sequential structure.", + "name": "change_percent", + "type": "float", + "description": "Percent change in the price of the symbol from the previous day.", "default": null, "optional": true }, { - "name": "zero_coupon", - "type": "bool", - "description": "For bond ETFs, this field identifies those ETFs that specifically hold zero coupon Treasury Bills.", + "name": "adj_open", + "type": "float", + "description": "The adjusted open price.", "default": null, "optional": true }, { - "name": "floating_rate", - "type": "bool", - "description": "For bond ETFs, this field identifies those ETFs that specifically hold floating rate bonds.", + "name": "adj_high", + "type": "float", + "description": "The adjusted high price.", "default": null, "optional": true }, { - "name": "build_america_bonds", - "type": "bool", - "description": "For municipal bond ETFs, this field identifies those ETFs that specifically hold Build America Bonds.", + "name": "adj_low", + "type": "float", + "description": "The adjusted low price.", "default": null, "optional": true }, { - "name": "dynamic_futures_roll", - "type": "bool", - "description": "If the product holds futures contracts, this field identifies those products where the roll strategy is dynamic (rather than entirely rules based), so as to minimize roll costs.", + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", "default": null, "optional": true }, { - "name": "currency_hedged", - "type": "bool", - "description": "This field is populated if the ETF's strategy involves hedging currency exposure.", + "name": "adj_volume", + "type": "float", + "description": "The adjusted volume.", "default": null, "optional": true }, { - "name": "includes_short_exposure", - "type": "bool", - "description": "This field is populated if the ETF has short exposure in any of its holdings e.g. in a long/short or inverse ETF.", + "name": "fifty_two_week_high", + "type": "float", + "description": "52 week high price for the symbol.", "default": null, "optional": true }, { - "name": "ucits", - "type": "bool", - "description": "If true, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant", + "name": "fifty_two_week_low", + "type": "float", + "description": "52 week low price for the symbol.", "default": null, "optional": true }, { - "name": "registered_countries", - "type": "str", - "description": "The list of countries where the ETF is legally registered for sale. This may differ from where the ETF is domiciled or traded, particularly in Europe.", + "name": "factor", + "type": "float", + "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices.", "default": null, "optional": true }, { - "name": "issuer_country", - "type": "str", - "description": "2 letter ISO country code for the country where the issuer is located.", + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", "default": null, "optional": true }, { - "name": "domicile", - "type": "str", - "description": "2 letter ISO country code for the country where the ETP is domiciled.", + "name": "dividend", + "type": "float", + "description": "Dividend amount, if a dividend was paid.", "default": null, "optional": true }, { - "name": "listing_country", - "type": "str", - "description": "2 letter ISO country code for the country of the primary listing.", + "name": "close_time", + "type": "datetime", + "description": "The timestamp that represents the end of the interval span.", "default": null, "optional": true }, { - "name": "listing_region", + "name": "interval", "type": "str", - "description": "Geographic region in the country of the primary listing falls.", + "description": "The data time frequency.", "default": null, "optional": true }, { - "name": "bond_currency_denomination", - "type": "str", - "description": "For all bond ETFs, this field provides additional detail on the currency denomination of the underlying securities.", + "name": "intra_period", + "type": "bool", + "description": "If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "transactions", + "type": "Annotated[int, Gt(gt=0)]", + "description": "Number of transactions for the symbol in the time period.", + "default": null, + "optional": true + } + ], + "tiingo": [ + { + "name": "adj_open", + "type": "float", + "description": "The adjusted open price.", "default": null, "optional": true }, { - "name": "base_currency", - "type": "str", - "description": "Base currency in which NAV is reported.", + "name": "adj_high", + "type": "float", + "description": "The adjusted high price.", "default": null, "optional": true }, { - "name": "listing_currency", - "type": "str", - "description": "Listing currency of the Exchange Traded Product (ETP) in which it is traded. Reported using the 3-digit ISO currency code.", + "name": "adj_low", + "type": "float", + "description": "The adjusted low price.", "default": null, "optional": true }, { - "name": "number_of_holdings", - "type": "int", - "description": "The number of holdings in the ETF.", + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", "default": null, "optional": true }, { - "name": "month_end_assets", + "name": "adj_volume", "type": "float", - "description": "Net assets in millions of dollars as of the most recent month end.", + "description": "The adjusted volume.", "default": null, "optional": true }, { - "name": "net_expense_ratio", + "name": "split_ratio", "type": "float", - "description": "Gross expense net of Fee Waivers, as a percentage of net assets as published by the ETF issuer.", + "description": "Ratio of the equity split, if a split occurred.", "default": null, "optional": true }, { - "name": "etf_portfolio_turnover", + "name": "dividend", "type": "float", - "description": "The percentage of positions turned over in the last 12 months.", + "description": "Dividend amount, if a dividend was paid.", "default": null, "optional": true } ], "yfinance": [ { - "name": "fund_type", - "type": "str", - "description": "The legal type of fund.", + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", "default": null, "optional": true }, { - "name": "fund_family", - "type": "str", - "description": "The fund family.", + "name": "dividend", + "type": "float", + "description": "Dividend amount (split-adjusted), if a dividend was paid.", "default": null, "optional": true - }, + } + ] + }, + "model": "EquityHistorical" + }, + "/equity/price/performance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get price performance data for a given stock. This includes price changes for different time periods.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.performance(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "category", + "name": "symbol", "type": "str", - "description": "The fund category.", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[PricePerformance]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "one_day", + "type": "float", + "description": "One-day return.", + "default": null, + "optional": true + }, + { + "name": "wtd", + "type": "float", + "description": "Week to date return.", + "default": null, + "optional": true + }, + { + "name": "one_week", + "type": "float", + "description": "One-week return.", + "default": null, + "optional": true + }, + { + "name": "mtd", + "type": "float", + "description": "Month to date return.", + "default": null, + "optional": true + }, + { + "name": "one_month", + "type": "float", + "description": "One-month return.", + "default": null, + "optional": true + }, + { + "name": "qtd", + "type": "float", + "description": "Quarter to date return.", + "default": null, + "optional": true + }, + { + "name": "three_month", + "type": "float", + "description": "Three-month return.", + "default": null, + "optional": true + }, + { + "name": "six_month", + "type": "float", + "description": "Six-month return.", + "default": null, + "optional": true + }, + { + "name": "ytd", + "type": "float", + "description": "Year to date return.", + "default": null, + "optional": true + }, + { + "name": "one_year", + "type": "float", + "description": "One-year return.", + "default": null, + "optional": true + }, + { + "name": "two_year", + "type": "float", + "description": "Two-year return.", + "default": null, + "optional": true + }, + { + "name": "three_year", + "type": "float", + "description": "Three-year return.", + "default": null, + "optional": true + }, + { + "name": "four_year", + "type": "float", + "description": "Four-year", + "default": null, + "optional": true + }, + { + "name": "five_year", + "type": "float", + "description": "Five-year return.", + "default": null, + "optional": true + }, + { + "name": "ten_year", + "type": "float", + "description": "Ten-year return.", + "default": null, + "optional": true + }, + { + "name": "max", + "type": "float", + "description": "Return from the beginning of the time series.", "default": null, "optional": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": "", + "optional": false + } + ] + }, + "model": "PricePerformance" + }, + "/equity/shorts/fails_to_deliver": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get reported Fail-to-deliver (FTD) data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.shorts.fails_to_deliver(symbol='AAPL', provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", + "optional": true + } + ], + "sec": [ + { + "name": "limit", + "type": "int", + "description": "Limit the number of reports to parse, from most recent. Approximately 24 reports per year, going back to 2009.", + "default": 24, + "optional": true + }, + { + "name": "skip_reports", + "type": "int", + "description": "Skip N number of reports from current. A value of 1 will skip the most recent report.", + "default": 0, + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache for the request, default is True. Each reporting period is a separate URL, new reports will be added to the cache.", + "default": true, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityFTD]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['sec']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "exchange", + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "settlement_date", + "type": "date", + "description": "The settlement date of the fail.", + "default": null, + "optional": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "cusip", + "type": "str", + "description": "CUSIP of the Security.", + "default": null, + "optional": true + }, + { + "name": "quantity", + "type": "int", + "description": "The number of fails on that settlement date.", + "default": null, + "optional": true + }, + { + "name": "price", + "type": "float", + "description": "The price at the previous closing price from the settlement date.", + "default": null, + "optional": true + }, + { + "name": "description", + "type": "str", + "description": "The description of the Security.", + "default": null, + "optional": true + } + ], + "sec": [ + { + "name": "settlement_date", + "type": "date", + "description": "The settlement date of the fail.", + "default": null, + "optional": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "cusip", + "type": "str", + "description": "CUSIP of the Security.", + "default": null, + "optional": true + }, + { + "name": "quantity", + "type": "int", + "description": "The number of fails on that settlement date.", + "default": null, + "optional": true + }, + { + "name": "price", + "type": "float", + "description": "The price at the previous closing price from the settlement date.", + "default": null, + "optional": true + }, + { + "name": "description", + "type": "str", + "description": "The description of the Security.", + "default": null, + "optional": true + } + ] + }, + "model": "EquityFTD" + }, + "/equity/search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search for stock symbol, CIK, LEI, or company name.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.search(provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", + "optional": true + }, + { + "name": "is_symbol", + "type": "bool", + "description": "Whether to search by ticker symbol.", + "default": false, + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether to use the cache or not.", + "default": true, + "optional": true + }, + { + "name": "provider", + "type": "Literal['intrinio', 'sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", + "optional": true + } + ], + "intrinio": [ + { + "name": "active", + "type": "bool", + "description": "When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded.", + "default": true, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10000, + "optional": true + } + ], + "sec": [ + { + "name": "is_fund", + "type": "bool", + "description": "Whether to direct the search to the list of mutual funds and ETFs.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquitySearch]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['intrinio', 'sec']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the company.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "cik", + "type": "str", + "description": "", + "default": "", + "optional": false + }, + { + "name": "lei", + "type": "str", + "description": "The Legal Entity Identifier (LEI) of the company.", + "default": "", + "optional": false + }, + { + "name": "intrinio_id", + "type": "str", + "description": "The Intrinio ID of the company.", + "default": "", + "optional": false + } + ], + "sec": [ + { + "name": "cik", + "type": "str", + "description": "Central Index Key", + "default": "", + "optional": false + } + ] + }, + "model": "EquitySearch" + }, + "/equity/screener": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Screen for companies meeting various criteria.\n\nThese criteria include market cap, price, beta, volume, and dividend yield.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.screener(provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "mktcap_min", + "type": "int", + "description": "Filter by market cap greater than this value.", + "default": null, + "optional": true + }, + { + "name": "mktcap_max", + "type": "int", + "description": "Filter by market cap less than this value.", + "default": null, + "optional": true + }, + { + "name": "price_min", + "type": "float", + "description": "Filter by price greater than this value.", + "default": null, + "optional": true + }, + { + "name": "price_max", + "type": "float", + "description": "Filter by price less than this value.", + "default": null, + "optional": true + }, + { + "name": "beta_min", + "type": "float", + "description": "Filter by a beta greater than this value.", + "default": null, + "optional": true + }, + { + "name": "beta_max", + "type": "float", + "description": "Filter by a beta less than this value.", + "default": null, + "optional": true + }, + { + "name": "volume_min", + "type": "int", + "description": "Filter by volume greater than this value.", + "default": null, + "optional": true + }, + { + "name": "volume_max", + "type": "int", + "description": "Filter by volume less than this value.", + "default": null, + "optional": true + }, + { + "name": "dividend_min", + "type": "float", + "description": "Filter by dividend amount greater than this value.", + "default": null, + "optional": true + }, + { + "name": "dividend_max", + "type": "float", + "description": "Filter by dividend amount less than this value.", + "default": null, + "optional": true + }, + { + "name": "is_etf", + "type": "bool", + "description": "If true, returns only ETFs.", + "default": false, + "optional": true + }, + { + "name": "is_active", + "type": "bool", + "description": "If false, returns only inactive tickers.", + "default": true, + "optional": true + }, + { + "name": "sector", + "type": "Literal['Consumer Cyclical', 'Energy', 'Technology', 'Industrials', 'Financial Services', 'Basic Materials', 'Communication Services', 'Consumer Defensive', 'Healthcare', 'Real Estate', 'Utilities', 'Industrial Goods', 'Financial', 'Services', 'Conglomerates']", + "description": "Filter by sector.", + "default": null, + "optional": true + }, + { + "name": "industry", + "type": "str", + "description": "Filter by industry.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Filter by country, as a two-letter country code.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra']", + "description": "Filter by exchange.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "Limit the number of results to return.", + "default": 50000, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityScreener]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the company.", + "default": "", + "optional": false + } + ], + "fmp": [ + { + "name": "market_cap", + "type": "int", + "description": "The market cap of ticker.", + "default": null, + "optional": true + }, + { + "name": "sector", + "type": "str", + "description": "The sector the ticker belongs to.", + "default": null, + "optional": true + }, + { + "name": "industry", + "type": "str", + "description": "The industry ticker belongs to.", + "default": null, + "optional": true + }, + { + "name": "beta", + "type": "float", + "description": "The beta of the ETF.", + "default": null, + "optional": true + }, + { + "name": "price", + "type": "float", + "description": "The current price.", + "default": null, + "optional": true + }, + { + "name": "last_annual_dividend", + "type": "float", + "description": "The last annual amount dividend paid.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "int", + "description": "The current trading volume.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "The exchange code the asset trades on.", + "default": null, + "optional": true + }, + { + "name": "exchange_name", + "type": "str", + "description": "The full name of the primary exchange.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "The two-letter country abbreviation where the head office is located.", + "default": null, + "optional": true + }, + { + "name": "is_etf", + "type": "Literal[True, False]", + "description": "Whether the ticker is an ETF.", + "default": null, + "optional": true + }, + { + "name": "actively_trading", + "type": "Literal[True, False]", + "description": "Whether the ETF is actively trading.", + "default": null, + "optional": true + } + ] + }, + "model": "EquityScreener" + }, + "/equity/profile": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get general information about a company. This includes company name, industry, sector and price data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.profile(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityInfo]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Common name of the company.", + "default": null, + "optional": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true + }, + { + "name": "cusip", + "type": "str", + "description": "CUSIP identifier for the company.", + "default": null, + "optional": true + }, + { + "name": "isin", + "type": "str", + "description": "International Securities Identification Number.", + "default": null, + "optional": true + }, + { + "name": "lei", + "type": "str", + "description": "Legal Entity Identifier assigned to the company.", + "default": null, + "optional": true + }, + { + "name": "legal_name", + "type": "str", + "description": "Official legal name of the company.", + "default": null, + "optional": true + }, + { + "name": "stock_exchange", + "type": "str", + "description": "Stock exchange where the company is traded.", + "default": null, + "optional": true + }, + { + "name": "sic", + "type": "int", + "description": "Standard Industrial Classification code for the company.", + "default": null, + "optional": true + }, + { + "name": "short_description", + "type": "str", + "description": "Short description of the company.", + "default": null, + "optional": true + }, + { + "name": "long_description", + "type": "str", + "description": "Long description of the company.", + "default": null, + "optional": true + }, + { + "name": "ceo", + "type": "str", + "description": "Chief Executive Officer of the company.", + "default": null, + "optional": true + }, + { + "name": "company_url", + "type": "str", + "description": "URL of the company's website.", + "default": null, + "optional": true + }, + { + "name": "business_address", + "type": "str", + "description": "Address of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "mailing_address", + "type": "str", + "description": "Mailing address of the company.", + "default": null, + "optional": true + }, + { + "name": "business_phone_no", + "type": "str", + "description": "Phone number of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "hq_address1", + "type": "str", + "description": "Address of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "hq_address2", + "type": "str", + "description": "Address of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "hq_address_city", + "type": "str", + "description": "City of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "hq_address_postal_code", + "type": "str", + "description": "Zip code of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "hq_state", + "type": "str", + "description": "State of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "hq_country", + "type": "str", + "description": "Country of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "inc_state", + "type": "str", + "description": "State in which the company is incorporated.", + "default": null, + "optional": true + }, + { + "name": "inc_country", + "type": "str", + "description": "Country in which the company is incorporated.", + "default": null, + "optional": true + }, + { + "name": "employees", + "type": "int", + "description": "Number of employees working for the company.", + "default": null, + "optional": true + }, + { + "name": "entity_legal_form", + "type": "str", + "description": "Legal form of the company.", + "default": null, + "optional": true + }, + { + "name": "entity_status", + "type": "str", + "description": "Status of the company.", + "default": null, + "optional": true + }, + { + "name": "latest_filing_date", + "type": "date", + "description": "Date of the company's latest filing.", + "default": null, + "optional": true + }, + { + "name": "irs_number", + "type": "str", + "description": "IRS number assigned to the company.", + "default": null, + "optional": true + }, + { + "name": "sector", + "type": "str", + "description": "Sector in which the company operates.", + "default": null, + "optional": true + }, + { + "name": "industry_category", + "type": "str", + "description": "Category of industry in which the company operates.", + "default": null, + "optional": true + }, + { + "name": "industry_group", + "type": "str", + "description": "Group of industry in which the company operates.", + "default": null, + "optional": true + }, + { + "name": "template", + "type": "str", + "description": "Template used to standardize the company's financial statements.", + "default": null, + "optional": true + }, + { + "name": "standardized_active", + "type": "bool", + "description": "Whether the company is active or not.", + "default": null, + "optional": true + }, + { + "name": "first_fundamental_date", + "type": "date", + "description": "Date of the company's first fundamental.", + "default": null, + "optional": true + }, + { + "name": "last_fundamental_date", + "type": "date", + "description": "Date of the company's last fundamental.", + "default": null, + "optional": true + }, + { + "name": "first_stock_price_date", + "type": "date", + "description": "Date of the company's first stock price.", + "default": null, + "optional": true + }, + { + "name": "last_stock_price_date", + "type": "date", + "description": "Date of the company's last stock price.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "is_etf", + "type": "bool", + "description": "If the symbol is an ETF.", + "default": "", + "optional": false + }, + { + "name": "is_actively_trading", + "type": "bool", + "description": "If the company is actively trading.", + "default": "", + "optional": false + }, + { + "name": "is_adr", + "type": "bool", + "description": "If the stock is an ADR.", + "default": "", + "optional": false + }, + { + "name": "is_fund", + "type": "bool", + "description": "If the company is a fund.", + "default": "", + "optional": false + }, + { + "name": "image", + "type": "str", + "description": "Image of the company.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency in which the stock is traded.", + "default": null, + "optional": true + }, + { + "name": "market_cap", + "type": "int", + "description": "Market capitalization of the company.", + "default": null, + "optional": true + }, + { + "name": "last_price", + "type": "float", + "description": "The last traded price.", + "default": null, + "optional": true + }, + { + "name": "year_high", + "type": "float", + "description": "The one-year high of the price.", + "default": null, + "optional": true + }, + { + "name": "year_low", + "type": "float", + "description": "The one-year low of the price.", + "default": null, + "optional": true + }, + { + "name": "volume_avg", + "type": "int", + "description": "Average daily trading volume.", + "default": null, + "optional": true + }, + { + "name": "annualized_dividend_amount", + "type": "float", + "description": "The annualized dividend payment based on the most recent regular dividend payment.", + "default": null, + "optional": true + }, + { + "name": "beta", + "type": "float", + "description": "Beta of the stock relative to the market.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "id", + "type": "str", + "description": "Intrinio ID for the company.", + "default": null, + "optional": true + }, + { + "name": "thea_enabled", + "type": "bool", + "description": "Whether the company has been enabled for Thea.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "exchange_timezone", + "type": "str", + "description": "The timezone of the exchange.", + "default": null, + "optional": true + }, + { + "name": "issue_type", + "type": "str", + "description": "The issuance type of the asset.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "The currency in which the asset is traded.", + "default": null, + "optional": true + }, + { + "name": "market_cap", + "type": "int", + "description": "The market capitalization of the asset.", + "default": null, + "optional": true + }, + { + "name": "shares_outstanding", + "type": "int", + "description": "The number of listed shares outstanding.", + "default": null, + "optional": true + }, + { + "name": "shares_float", + "type": "int", + "description": "The number of shares in the public float.", + "default": null, + "optional": true + }, + { + "name": "shares_implied_outstanding", + "type": "int", + "description": "Implied shares outstanding of common equityassuming the conversion of all convertible subsidiary equity into common.", + "default": null, + "optional": true + }, + { + "name": "shares_short", + "type": "int", + "description": "The reported number of shares short.", + "default": null, + "optional": true + }, + { + "name": "dividend_yield", + "type": "float", + "description": "The dividend yield of the asset, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "beta", + "type": "float", + "description": "The beta of the asset relative to the broad market.", + "default": null, + "optional": true + } + ] + }, + "model": "EquityInfo" + }, + "/equity/market_snapshots": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get an updated equity market snapshot. This includes price data for thousands of stocks.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.market_snapshots(provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "market", + "type": "Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra']", + "description": "The market to fetch data for.", + "default": "nasdaq", + "optional": true + } + ], + "intrinio": [ + { + "name": "date", + "type": "Union[Union[date, datetime, str], str]", + "description": "The date of the data. Can be a datetime or an ISO datetime string. Historical data appears to go back to mid-June 2022. Example: '2024-03-08T12:15:00+0400'", + "default": null, + "optional": true + } + ], + "polygon": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[MarketSnapshots]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": null, + "optional": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": null, + "optional": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": null, + "optional": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": null, + "optional": true + }, + { + "name": "prev_close", + "type": "float", + "description": "The previous close price.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "The change in price from the previous close.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "The change in price from the previous close, as a normalized percent.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "last_price", + "type": "float", + "description": "The last price of the stock.", + "default": null, + "optional": true + }, + { + "name": "last_price_timestamp", + "type": "Union[date, datetime]", + "description": "The timestamp of the last price.", + "default": null, + "optional": true + }, + { + "name": "ma50", + "type": "float", + "description": "The 50-day moving average.", + "default": null, + "optional": true + }, + { + "name": "ma200", + "type": "float", + "description": "The 200-day moving average.", + "default": null, + "optional": true + }, + { + "name": "year_high", + "type": "float", + "description": "The 52-week high.", + "default": null, + "optional": true + }, + { + "name": "year_low", + "type": "float", + "description": "The 52-week low.", + "default": null, + "optional": true + }, + { + "name": "volume_avg", + "type": "int", + "description": "Average daily trading volume.", + "default": null, + "optional": true + }, + { + "name": "market_cap", + "type": "int", + "description": "Market cap of the stock.", + "default": null, + "optional": true + }, + { + "name": "eps", + "type": "float", + "description": "Earnings per share.", + "default": null, + "optional": true + }, + { + "name": "pe", + "type": "float", + "description": "Price to earnings ratio.", + "default": null, + "optional": true + }, + { + "name": "shares_outstanding", + "type": "int", + "description": "Number of shares outstanding.", + "default": null, + "optional": true + }, + { + "name": "name", + "type": "str", + "description": "The company name associated with the symbol.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "The exchange of the stock.", + "default": null, + "optional": true + }, + { + "name": "earnings_date", + "type": "Union[date, datetime]", + "description": "The upcoming earnings announcement date.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "last_price", + "type": "float", + "description": "The last trade price.", + "default": null, + "optional": true + }, + { + "name": "last_size", + "type": "int", + "description": "The last trade size.", + "default": null, + "optional": true + }, + { + "name": "last_volume", + "type": "int", + "description": "The last trade volume.", + "default": null, + "optional": true + }, + { + "name": "last_trade_timestamp", + "type": "datetime", + "description": "The timestamp of the last trade.", + "default": null, + "optional": true + }, + { + "name": "bid_size", + "type": "int", + "description": "The size of the last bid price. Bid price and size is not always available.", + "default": null, + "optional": true + }, + { + "name": "bid_price", + "type": "float", + "description": "The last bid price. Bid price and size is not always available.", + "default": null, + "optional": true + }, + { + "name": "ask_price", + "type": "float", + "description": "The last ask price. Ask price and size is not always available.", + "default": null, + "optional": true + }, + { + "name": "ask_size", + "type": "int", + "description": "The size of the last ask price. Ask price and size is not always available.", + "default": null, + "optional": true + }, + { + "name": "last_bid_timestamp", + "type": "datetime", + "description": "The timestamp of the last bid price. Bid price and size is not always available.", + "default": null, + "optional": true + }, + { + "name": "last_ask_timestamp", + "type": "datetime", + "description": "The timestamp of the last ask price. Ask price and size is not always available.", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "vwap", + "type": "float", + "description": "The volume weighted average price of the stock on the current trading day.", + "default": null, + "optional": true + }, + { + "name": "prev_open", + "type": "float", + "description": "The previous trading session opening price.", + "default": null, + "optional": true + }, + { + "name": "prev_high", + "type": "float", + "description": "The previous trading session high price.", + "default": null, + "optional": true + }, + { + "name": "prev_low", + "type": "float", + "description": "The previous trading session low price.", + "default": null, + "optional": true + }, + { + "name": "prev_volume", + "type": "float", + "description": "The previous trading session volume.", + "default": null, + "optional": true + }, + { + "name": "prev_vwap", + "type": "float", + "description": "The previous trading session VWAP.", + "default": null, + "optional": true + }, + { + "name": "last_updated", + "type": "datetime", + "description": "The last time the data was updated.", + "default": "", + "optional": false + }, + { + "name": "bid", + "type": "float", + "description": "The current bid price.", + "default": null, + "optional": true + }, + { + "name": "bid_size", + "type": "int", + "description": "The current bid size.", + "default": null, + "optional": true + }, + { + "name": "ask_size", + "type": "int", + "description": "The current ask size.", + "default": null, + "optional": true + }, + { + "name": "ask", + "type": "float", + "description": "The current ask price.", + "default": null, + "optional": true + }, + { + "name": "quote_timestamp", + "type": "datetime", + "description": "The timestamp of the last quote.", + "default": null, + "optional": true + }, + { + "name": "last_trade_price", + "type": "float", + "description": "The last trade price.", + "default": null, + "optional": true + }, + { + "name": "last_trade_size", + "type": "int", + "description": "The last trade size.", + "default": null, + "optional": true + }, + { + "name": "last_trade_conditions", + "type": "List[int]", + "description": "The last trade condition codes.", + "default": null, + "optional": true + }, + { + "name": "last_trade_exchange", + "type": "int", + "description": "The last trade exchange ID code.", + "default": null, + "optional": true + }, + { + "name": "last_trade_timestamp", + "type": "datetime", + "description": "The last trade timestamp.", + "default": null, + "optional": true + } + ] + }, + "model": "MarketSnapshots" + }, + "/etf/search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search for ETFs.\n\nAn empty query returns the full list of ETFs from the provider.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# An empty query returns the full list of ETFs from the provider.\nobb.etf.search(provider='fmp')\n# The query will return results from text-based fields containing the term.\nobb.etf.search(query='commercial real estate', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "exchange", + "type": "Literal['AMEX', 'NYSE', 'NASDAQ', 'ETF', 'TSX', 'EURONEXT']", + "description": "The exchange code the ETF trades on.", + "default": null, + "optional": true + }, + { + "name": "is_active", + "type": "Literal[True, False]", + "description": "Whether the ETF is actively trading.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "exchange", + "type": "Literal['xnas', 'arcx', 'bats', 'xnys', 'bvmf', 'xshg', 'xshe', 'xhkg', 'xbom', 'xnse', 'xidx', 'tase', 'xkrx', 'xkls', 'xmex', 'xses', 'roco', 'xtai', 'xbkk', 'xist']", + "description": "Target a specific exchange by providing the MIC code.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfSearch]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.(ETF)", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the ETF.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "market_cap", + "type": "float", + "description": "The market cap of the ETF.", + "default": null, + "optional": true + }, + { + "name": "sector", + "type": "str", + "description": "The sector of the ETF.", + "default": null, + "optional": true + }, + { + "name": "industry", + "type": "str", + "description": "The industry of the ETF.", + "default": null, + "optional": true + }, + { + "name": "beta", + "type": "float", + "description": "The beta of the ETF.", + "default": null, + "optional": true + }, + { + "name": "price", + "type": "float", + "description": "The current price of the ETF.", + "default": null, + "optional": true + }, + { + "name": "last_annual_dividend", + "type": "float", + "description": "The last annual dividend paid.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "float", + "description": "The current trading volume of the ETF.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "The exchange code the ETF trades on.", + "default": null, + "optional": true + }, + { + "name": "exchange_name", + "type": "str", + "description": "The full name of the exchange the ETF trades on.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "The country the ETF is registered in.", + "default": null, + "optional": true + }, + { + "name": "actively_trading", + "type": "Literal[True, False]", + "description": "Whether the ETF is actively trading.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "exchange", + "type": "str", + "description": "The exchange MIC code.", + "default": null, + "optional": true + }, + { + "name": "figi_ticker", + "type": "str", + "description": "The OpenFIGI ticker.", + "default": null, + "optional": true + }, + { + "name": "ric", + "type": "str", + "description": "The Reuters Instrument Code.", + "default": null, + "optional": true + }, + { + "name": "isin", + "type": "str", + "description": "The International Securities Identification Number.", + "default": null, + "optional": true + }, + { + "name": "sedol", + "type": "str", + "description": "The Stock Exchange Daily Official List.", + "default": null, + "optional": true + }, + { + "name": "intrinio_id", + "type": "str", + "description": "The unique Intrinio ID for the security.", + "default": null, + "optional": true + } + ] + }, + "model": "EtfSearch" + }, + "/etf/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "ETF Historical Market Price.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.historical(symbol='SPY', provider='fmp')\nobb.etf.historical(symbol='SPY', provider='yfinance')\n# This function accepts multiple tickers.\nobb.etf.historical(symbol='SPY,IWM,QQQ,DJIA', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", + "default": "", + "optional": false + }, + { + "name": "interval", + "type": "Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "start_time", + "type": "datetime.time", + "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'.", + "default": null, + "optional": true + }, + { + "name": "end_time", + "type": "datetime.time", + "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'.", + "default": null, + "optional": true + }, + { + "name": "timezone", + "type": "str", + "description": "Timezone of the data, in the IANA format (Continent/City).", + "default": "America/New_York", + "optional": true + }, + { + "name": "source", + "type": "Literal['realtime', 'delayed', 'nasdaq_basic']", + "description": "The source of the data.", + "default": "realtime", + "optional": true + } + ], + "polygon": [ + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", + "default": "1d", + "optional": true + }, + { + "name": "adjustment", + "type": "Literal['splits_only', 'unadjusted']", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", + "optional": true + }, + { + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": false, + "optional": true + }, + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", + "default": "asc", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 49999, + "optional": true + } + ], + "tiingo": [ + { + "name": "interval", + "type": "Literal['1d', '1W', '1M', '1Y']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ], + "yfinance": [ + { + "name": "interval", + "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": false, + "optional": true + }, + { + "name": "include_actions", + "type": "bool", + "description": "Include dividends and stock splits in results.", + "default": true, + "optional": true + }, + { + "name": "adjustment", + "type": "Literal['splits_only', 'splits_and_dividends']", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", + "optional": true + }, + { + "name": "adjusted", + "type": "bool", + "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead.", + "default": false, + "optional": true + }, + { + "name": "prepost", + "type": "bool", + "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfHistorical]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "Union[int, float]", + "description": "The trading volume.", + "default": null, + "optional": true + }, + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": null, + "optional": true + }, + { + "name": "unadjusted_volume", + "type": "float", + "description": "Unadjusted volume of the symbol.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "Change in the price from the previous close.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in the price from the previous close, as a normalized percent.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "average", + "type": "float", + "description": "Average trade price of an individual equity during the interval.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "Change in the price of the symbol from the previous day.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Percent change in the price of the symbol from the previous day.", + "default": null, + "optional": true + }, + { + "name": "adj_open", + "type": "float", + "description": "The adjusted open price.", + "default": null, + "optional": true + }, + { + "name": "adj_high", + "type": "float", + "description": "The adjusted high price.", + "default": null, + "optional": true + }, + { + "name": "adj_low", + "type": "float", + "description": "The adjusted low price.", + "default": null, + "optional": true + }, + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": null, + "optional": true + }, + { + "name": "adj_volume", + "type": "float", + "description": "The adjusted volume.", + "default": null, + "optional": true + }, + { + "name": "fifty_two_week_high", + "type": "float", + "description": "52 week high price for the symbol.", + "default": null, + "optional": true + }, + { + "name": "fifty_two_week_low", + "type": "float", + "description": "52 week low price for the symbol.", + "default": null, + "optional": true + }, + { + "name": "factor", + "type": "float", + "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices.", + "default": null, + "optional": true + }, + { + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", + "default": null, + "optional": true + }, + { + "name": "dividend", + "type": "float", + "description": "Dividend amount, if a dividend was paid.", + "default": null, + "optional": true + }, + { + "name": "close_time", + "type": "datetime", + "description": "The timestamp that represents the end of the interval span.", + "default": null, + "optional": true + }, + { + "name": "interval", + "type": "str", + "description": "The data time frequency.", + "default": null, + "optional": true + }, + { + "name": "intra_period", + "type": "bool", + "description": "If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "transactions", + "type": "Annotated[int, Gt(gt=0)]", + "description": "Number of transactions for the symbol in the time period.", + "default": null, + "optional": true + } + ], + "tiingo": [ + { + "name": "adj_open", + "type": "float", + "description": "The adjusted open price.", + "default": null, + "optional": true + }, + { + "name": "adj_high", + "type": "float", + "description": "The adjusted high price.", + "default": null, + "optional": true + }, + { + "name": "adj_low", + "type": "float", + "description": "The adjusted low price.", + "default": null, + "optional": true + }, + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": null, + "optional": true + }, + { + "name": "adj_volume", + "type": "float", + "description": "The adjusted volume.", + "default": null, + "optional": true + }, + { + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", + "default": null, + "optional": true + }, + { + "name": "dividend", + "type": "float", + "description": "Dividend amount, if a dividend was paid.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", + "default": null, + "optional": true + }, + { + "name": "dividend", + "type": "float", + "description": "Dividend amount (split-adjusted), if a dividend was paid.", + "default": null, + "optional": true + } + ] + }, + "model": "EtfHistorical" + }, + "/etf/info": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "ETF Information Overview.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.info(symbol='SPY', provider='fmp')\n# This function accepts multiple tickers.\nobb.etf.info(symbol='SPY,IWM,QQQ,DJIA', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfInfo]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. (ETF)", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the ETF.", + "default": "", + "optional": false + }, + { + "name": "description", + "type": "str", + "description": "Description of the fund.", + "default": null, + "optional": true + }, + { + "name": "inception_date", + "type": "str", + "description": "Inception date of the ETF.", + "default": "", + "optional": false + } + ], + "fmp": [ + { + "name": "issuer", + "type": "str", + "description": "Company of the ETF.", + "default": null, + "optional": true + }, + { + "name": "cusip", + "type": "str", + "description": "CUSIP of the ETF.", + "default": null, + "optional": true + }, + { + "name": "isin", + "type": "str", + "description": "ISIN of the ETF.", + "default": null, + "optional": true + }, + { + "name": "domicile", + "type": "str", + "description": "Domicile of the ETF.", + "default": null, + "optional": true + }, + { + "name": "asset_class", + "type": "str", + "description": "Asset class of the ETF.", + "default": null, + "optional": true + }, + { + "name": "aum", + "type": "float", + "description": "Assets under management.", + "default": null, + "optional": true + }, + { + "name": "nav", + "type": "float", + "description": "Net asset value of the ETF.", + "default": null, + "optional": true + }, + { + "name": "nav_currency", + "type": "str", + "description": "Currency of the ETF's net asset value.", + "default": null, + "optional": true + }, + { + "name": "expense_ratio", + "type": "float", + "description": "The expense ratio, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "holdings_count", + "type": "int", + "description": "Number of holdings.", + "default": null, + "optional": true + }, + { + "name": "avg_volume", + "type": "float", + "description": "Average daily trading volume.", + "default": null, + "optional": true + }, + { + "name": "website", + "type": "str", + "description": "Website of the issuer.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "fund_listing_date", + "type": "date", + "description": "The date on which the Exchange Traded Product (ETP) or share class of the ETP is listed on a specific exchange.", + "default": null, + "optional": true + }, + { + "name": "data_change_date", + "type": "date", + "description": "The last date on which there was a change in a classifications data field for this ETF.", + "default": null, + "optional": true + }, + { + "name": "etn_maturity_date", + "type": "date", + "description": "If the product is an ETN, this field identifies the maturity date for the ETN.", + "default": null, + "optional": true + }, + { + "name": "is_listed", + "type": "bool", + "description": "If true, the ETF is still listed on an exchange.", + "default": null, + "optional": true + }, + { + "name": "close_date", + "type": "date", + "description": "The date on which the ETF was de-listed if it is no longer listed.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "The exchange Market Identifier Code (MIC).", + "default": null, + "optional": true + }, + { + "name": "isin", + "type": "str", + "description": "International Securities Identification Number (ISIN).", + "default": null, + "optional": true + }, + { + "name": "ric", + "type": "str", + "description": "Reuters Instrument Code (RIC).", + "default": null, + "optional": true + }, + { + "name": "sedol", + "type": "str", + "description": "Stock Exchange Daily Official List (SEDOL).", + "default": null, + "optional": true + }, + { + "name": "figi_symbol", + "type": "str", + "description": "Financial Instrument Global Identifier (FIGI) symbol.", + "default": null, + "optional": true + }, + { + "name": "share_class_figi", + "type": "str", + "description": "Financial Instrument Global Identifier (FIGI).", + "default": null, + "optional": true + }, + { + "name": "firstbridge_id", + "type": "str", + "description": "The FirstBridge unique identifier for the Exchange Traded Fund (ETF).", + "default": null, + "optional": true + }, + { + "name": "firstbridge_parent_id", + "type": "str", + "description": "The FirstBridge unique identifier for the parent Exchange Traded Fund (ETF), if applicable.", + "default": null, + "optional": true + }, + { + "name": "intrinio_id", + "type": "str", + "description": "Intrinio unique identifier for the security.", + "default": null, + "optional": true + }, + { + "name": "intraday_nav_symbol", + "type": "str", + "description": "Intraday Net Asset Value (NAV) symbol.", + "default": null, + "optional": true + }, + { + "name": "primary_symbol", + "type": "str", + "description": "The primary ticker field is used for Exchange Traded Products (ETPs) that have multiple listings and share classes. If an ETP has multiple listings or share classes, the same primary ticker is assigned to all the listings and share classes.", + "default": null, + "optional": true + }, + { + "name": "etp_structure_type", + "type": "str", + "description": "Classifies Exchange Traded Products (ETPs) into very broad categories based on its legal structure.", + "default": null, + "optional": true + }, + { + "name": "legal_structure", + "type": "str", + "description": "Legal structure of the fund.", + "default": null, + "optional": true + }, + { + "name": "issuer", + "type": "str", + "description": "Issuer of the ETF.", + "default": null, + "optional": true + }, + { + "name": "etn_issuing_bank", + "type": "str", + "description": "If the product is an Exchange Traded Note (ETN), this field identifies the issuing bank.", + "default": null, + "optional": true + }, + { + "name": "fund_family", + "type": "str", + "description": "This field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor.", + "default": null, + "optional": true + }, + { + "name": "investment_style", + "type": "str", + "description": "Investment style of the ETF.", + "default": null, + "optional": true + }, + { + "name": "derivatives_based", + "type": "str", + "description": "This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio.", + "default": null, + "optional": true + }, + { + "name": "income_category", + "type": "str", + "description": "Identifies if an Exchange Traded Fund (ETF) falls into a category that is specifically designed to provide a high yield or income", + "default": null, + "optional": true + }, + { + "name": "asset_class", + "type": "str", + "description": "Captures the underlying nature of the securities in the Exchanged Traded Product (ETP).", + "default": null, + "optional": true + }, + { + "name": "other_asset_types", + "type": "str", + "description": "If 'asset_class' field is classified as 'Other Asset Types' this field captures the specific category of the underlying assets.", + "default": null, + "optional": true + }, + { + "name": "single_category_designation", + "type": "str", + "description": "This categorization is created for those users who want every ETF to be 'forced' into a single bucket, so that the assets for all categories will always sum to the total market.", + "default": null, + "optional": true + }, + { + "name": "beta_type", + "type": "str", + "description": "This field identifies whether an ETF provides 'Traditional' beta exposure or 'Smart' beta exposure. ETFs that are active (i.e. non-indexed), leveraged / inverse or have a proprietary quant model (i.e. that don't provide indexed exposure to a targeted factor) are classified separately.", + "default": null, + "optional": true + }, + { + "name": "beta_details", + "type": "str", + "description": "This field provides further detail within the traditional and smart beta categories.", + "default": null, + "optional": true + }, + { + "name": "market_cap_range", + "type": "str", + "description": "Equity ETFs are classified as falling into categories based on the description of their investment strategy in the prospectus. Examples ('Mega Cap', 'Large Cap', 'Mid Cap', etc.)", + "default": null, + "optional": true + }, + { + "name": "market_cap_weighting_type", + "type": "str", + "description": "For ETFs that take the value 'Market Cap Weighted' in the 'index_weighting_scheme' field, this field provides detail on the market cap weighting type.", + "default": null, + "optional": true + }, + { + "name": "index_weighting_scheme", + "type": "str", + "description": "For ETFs that track an underlying index, this field provides detail on the index weighting type.", + "default": null, + "optional": true + }, + { + "name": "index_linked", + "type": "str", + "description": "This field identifies whether an ETF is index linked or active.", + "default": null, + "optional": true + }, + { + "name": "index_name", + "type": "str", + "description": "This field identifies the name of the underlying index tracked by the ETF, if applicable.", + "default": null, + "optional": true + }, + { + "name": "index_symbol", + "type": "str", + "description": "This field identifies the OpenFIGI ticker for the Index underlying the ETF.", + "default": null, + "optional": true + }, + { + "name": "parent_index", + "type": "str", + "description": "This field identifies the name of the parent index, which represents the broader universe from which the index underlying the ETF is created, if applicable.", + "default": null, + "optional": true + }, + { + "name": "index_family", + "type": "str", + "description": "This field identifies the index family to which the index underlying the ETF belongs. The index family is represented as categorized by the index provider.", + "default": null, + "optional": true + }, + { + "name": "broader_index_family", + "type": "str", + "description": "This field identifies the broader index family to which the index underlying the ETF belongs. The broader index family is represented as categorized by the index provider.", + "default": null, + "optional": true + }, + { + "name": "index_provider", + "type": "str", + "description": "This field identifies the Index provider for the index underlying the ETF, if applicable.", + "default": null, + "optional": true + }, + { + "name": "index_provider_code", + "type": "str", + "description": "This field provides the First Bridge code for each Index provider, corresponding to the index underlying the ETF if applicable.", + "default": null, + "optional": true + }, + { + "name": "replication_structure", + "type": "str", + "description": "The replication structure of the Exchange Traded Product (ETP).", + "default": null, + "optional": true + }, + { + "name": "growth_value_tilt", + "type": "str", + "description": "Classifies equity ETFs as either 'Growth' or Value' based on the stated style tilt in the ETF prospectus. Equity ETFs that do not have a stated style tilt are classified as 'Core / Blend'.", + "default": null, + "optional": true + }, + { + "name": "growth_type", + "type": "str", + "description": "For ETFs that are classified as 'Growth' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their growth (style factor) scores.", + "default": null, + "optional": true + }, + { + "name": "value_type", + "type": "str", + "description": "For ETFs that are classified as 'Value' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their value (style factor) scores.", + "default": null, + "optional": true + }, + { + "name": "sector", + "type": "str", + "description": "For equity ETFs that aim to provide targeted exposure to a sector or industry, this field identifies the Sector that it provides the exposure to.", + "default": null, + "optional": true + }, + { + "name": "industry", + "type": "str", + "description": "For equity ETFs that aim to provide targeted exposure to an industry, this field identifies the Industry that it provides the exposure to.", + "default": null, + "optional": true + }, + { + "name": "industry_group", + "type": "str", + "description": "For equity ETFs that aim to provide targeted exposure to a sub-industry, this field identifies the sub-Industry that it provides the exposure to.", + "default": null, + "optional": true + }, + { + "name": "cross_sector_theme", + "type": "str", + "description": "For equity ETFs that aim to provide targeted exposure to a specific investment theme that cuts across GICS sectors, this field identifies the specific cross-sector theme. Examples ('Agri-business', 'Natural Resources', 'Green Investing', etc.)", + "default": null, + "optional": true + }, + { + "name": "natural_resources_type", + "type": "str", + "description": "For ETFs that are classified as 'Natural Resources' in the 'cross_sector_theme' field, this field provides further detail on the type of Natural Resources exposure.", + "default": null, + "optional": true + }, + { + "name": "us_or_excludes_us", + "type": "str", + "description": "Takes the value of 'Domestic' for US exposure, 'International' for non-US exposure and 'Global' for exposure that includes all regions including the US.", + "default": null, + "optional": true + }, + { + "name": "developed_emerging", + "type": "str", + "description": "This field identifies the stage of development of the markets that the ETF provides exposure to.", + "default": null, + "optional": true + }, + { + "name": "specialized_region", + "type": "str", + "description": "This field is populated if the ETF provides targeted exposure to a specific type of geography-based grouping that does not fall into a specific country or continent grouping. Examples ('BRIC', 'Chindia', etc.)", + "default": null, + "optional": true + }, + { + "name": "continent", + "type": "str", + "description": "This field is populated if the ETF provides targeted exposure to a specific continent or country within that Continent.", + "default": null, + "optional": true + }, + { + "name": "latin_america_sub_group", + "type": "str", + "description": "For ETFs that are classified as 'Latin America' in the 'continent' field, this field provides further detail on the type of regional exposure.", + "default": null, + "optional": true + }, + { + "name": "europe_sub_group", + "type": "str", + "description": "For ETFs that are classified as 'Europe' in the 'continent' field, this field provides further detail on the type of regional exposure.", + "default": null, + "optional": true + }, + { + "name": "asia_sub_group", + "type": "str", + "description": "For ETFs that are classified as 'Asia' in the 'continent' field, this field provides further detail on the type of regional exposure.", + "default": null, + "optional": true + }, + { + "name": "specific_country", + "type": "str", + "description": "This field is populated if the ETF provides targeted exposure to a specific country.", + "default": null, + "optional": true + }, + { + "name": "china_listing_location", + "type": "str", + "description": "For ETFs that are classified as 'China' in the 'country' field, this field provides further detail on the type of exposure in the underlying securities.", + "default": null, + "optional": true + }, + { + "name": "us_state", + "type": "str", + "description": "Takes the value of a US state if the ETF provides targeted exposure to the municipal bonds or equities of companies.", + "default": null, + "optional": true + }, + { + "name": "real_estate", + "type": "str", + "description": "For ETFs that provide targeted real estate exposure, this field is populated if the ETF provides targeted exposure to a specific segment of the real estate market.", + "default": null, + "optional": true + }, + { + "name": "fundamental_weighting_type", + "type": "str", + "description": "For ETFs that take the value 'Fundamental Weighted' in the 'index_weighting_scheme' field, this field provides detail on the fundamental weighting methodology.", + "default": null, + "optional": true + }, + { + "name": "dividend_weighting_type", + "type": "str", + "description": "For ETFs that take the value 'Dividend Weighted' in the 'index_weighting_scheme' field, this field provides detail on the dividend weighting methodology.", + "default": null, + "optional": true + }, + { + "name": "bond_type", + "type": "str", + "description": "For ETFs where 'asset_class_type' is 'Bonds', this field provides detail on the type of bonds held in the ETF.", + "default": null, + "optional": true + }, + { + "name": "government_bond_types", + "type": "str", + "description": "For bond ETFs that take the value 'Treasury & Government' in 'bond_type', this field provides detail on the exposure.", + "default": null, + "optional": true + }, + { + "name": "municipal_bond_region", + "type": "str", + "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field provides additional detail on the geographic exposure.", + "default": null, + "optional": true + }, + { + "name": "municipal_vrdo", + "type": "bool", + "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field identifies those ETFs that specifically provide exposure to Variable Rate Demand Obligations.", + "default": null, + "optional": true + }, + { + "name": "mortgage_bond_types", + "type": "str", + "description": "For bond ETFs that take the value 'Mortgage' in 'bond_type', this field provides additional detail on the type of underlying securities.", + "default": null, + "optional": true + }, + { + "name": "bond_tax_status", + "type": "str", + "description": "For all US bond ETFs, this field provides additional detail on the tax treatment of the underlying securities.", + "default": null, + "optional": true + }, + { + "name": "credit_quality", + "type": "str", + "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific credit quality range.", + "default": null, + "optional": true + }, + { + "name": "average_maturity", + "type": "str", + "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific maturity range.", + "default": null, + "optional": true + }, + { + "name": "specific_maturity_year", + "type": "int", + "description": "For all bond ETFs that take the value 'Specific Maturity Year' in the 'average_maturity' field, this field specifies the calendar year.", + "default": null, + "optional": true + }, + { + "name": "commodity_types", + "type": "str", + "description": "For ETFs where 'asset_class_type' is 'Commodities', this field provides detail on the type of commodities held in the ETF.", + "default": null, + "optional": true + }, + { + "name": "energy_type", + "type": "str", + "description": "For ETFs where 'commodity_type' is 'Energy', this field provides detail on the type of energy exposure provided by the ETF.", + "default": null, + "optional": true + }, + { + "name": "agricultural_type", + "type": "str", + "description": "For ETFs where 'commodity_type' is 'Agricultural', this field provides detail on the type of agricultural exposure provided by the ETF.", + "default": null, + "optional": true + }, + { + "name": "livestock_type", + "type": "str", + "description": "For ETFs where 'commodity_type' is 'Livestock', this field provides detail on the type of livestock exposure provided by the ETF.", + "default": null, + "optional": true + }, + { + "name": "metal_type", + "type": "str", + "description": "For ETFs where 'commodity_type' is 'Gold & Metals', this field provides detail on the type of exposure provided by the ETF.", + "default": null, + "optional": true + }, + { + "name": "inverse_leveraged", + "type": "str", + "description": "This field is populated if the ETF provides inverse or leveraged exposure.", + "default": null, + "optional": true + }, + { + "name": "target_date_multi_asset_type", + "type": "str", + "description": "For ETFs where 'asset_class_type' is 'Target Date / MultiAsset', this field provides detail on the type of commodities held in the ETF.", + "default": null, + "optional": true + }, + { + "name": "currency_pair", + "type": "str", + "description": "This field is populated if the ETF's strategy involves providing exposure to the movements of a currency or involves hedging currency exposure.", + "default": null, + "optional": true + }, + { + "name": "social_environmental_type", + "type": "str", + "description": "This field is populated if the ETF's strategy involves providing exposure to a specific social or environmental theme.", + "default": null, + "optional": true + }, + { + "name": "clean_energy_type", + "type": "str", + "description": "This field is populated if the ETF has a value of 'Clean Energy' in the 'social_environmental_type' field.", + "default": null, + "optional": true + }, + { + "name": "dividend_type", + "type": "str", + "description": "This field is populated if the ETF has an intended investment objective of holding dividend-oriented stocks as stated in the prospectus.", + "default": null, + "optional": true + }, + { + "name": "regular_dividend_payor_type", + "type": "str", + "description": "This field is populated if the ETF has a value of'Dividend - Regular Payors' in the 'dividend_type' field.", + "default": null, + "optional": true + }, + { + "name": "quant_strategies_type", + "type": "str", + "description": "This field is populated if the ETF has either an index-linked or active strategy that is based on a proprietary quantitative strategy.", + "default": null, + "optional": true + }, + { + "name": "other_quant_models", + "type": "str", + "description": "For ETFs where 'quant_strategies_type' is 'Other Quant Model', this field provides the name of the specific proprietary quant model used as the underlying strategy for the ETF.", + "default": null, + "optional": true + }, + { + "name": "hedge_fund_type", + "type": "str", + "description": "For ETFs where 'other_asset_types' is 'Hedge Fund Replication', this field provides detail on the type of hedge fund replication strategy.", + "default": null, + "optional": true + }, + { + "name": "excludes_financials", + "type": "bool", + "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold financials stocks, based on the funds intended objective.", + "default": null, + "optional": true + }, + { + "name": "excludes_technology", + "type": "bool", + "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold technology stocks, based on the funds intended objective.", + "default": null, + "optional": true + }, + { + "name": "holds_only_nyse_stocks", + "type": "bool", + "description": "If true, the ETF is an equity ETF and holds only stocks listed on NYSE.", + "default": null, + "optional": true + }, + { + "name": "holds_only_nasdaq_stocks", + "type": "bool", + "description": "If true, the ETF is an equity ETF and holds only stocks listed on Nasdaq.", + "default": null, + "optional": true + }, + { + "name": "holds_mlp", + "type": "bool", + "description": "If true, the ETF's investment objective explicitly specifies that it holds MLPs as an intended part of its investment strategy.", + "default": null, + "optional": true + }, + { + "name": "holds_preferred_stock", + "type": "bool", + "description": "If true, the ETF's investment objective explicitly specifies that it holds preferred stock as an intended part of its investment strategy.", + "default": null, + "optional": true + }, + { + "name": "holds_closed_end_funds", + "type": "bool", + "description": "If true, the ETF's investment objective explicitly specifies that it holds closed end funds as an intended part of its investment strategy.", + "default": null, + "optional": true + }, + { + "name": "holds_adr", + "type": "bool", + "description": "If true, he ETF's investment objective explicitly specifies that it holds American Depositary Receipts (ADRs) as an intended part of its investment strategy.", + "default": null, + "optional": true + }, + { + "name": "laddered", + "type": "bool", + "description": "For bond ETFs, this field identifies those ETFs that specifically hold bonds in a laddered structure, where the bonds are scheduled to mature in an annual, sequential structure.", + "default": null, + "optional": true + }, + { + "name": "zero_coupon", + "type": "bool", + "description": "For bond ETFs, this field identifies those ETFs that specifically hold zero coupon Treasury Bills.", + "default": null, + "optional": true + }, + { + "name": "floating_rate", + "type": "bool", + "description": "For bond ETFs, this field identifies those ETFs that specifically hold floating rate bonds.", + "default": null, + "optional": true + }, + { + "name": "build_america_bonds", + "type": "bool", + "description": "For municipal bond ETFs, this field identifies those ETFs that specifically hold Build America Bonds.", + "default": null, + "optional": true + }, + { + "name": "dynamic_futures_roll", + "type": "bool", + "description": "If the product holds futures contracts, this field identifies those products where the roll strategy is dynamic (rather than entirely rules based), so as to minimize roll costs.", + "default": null, + "optional": true + }, + { + "name": "currency_hedged", + "type": "bool", + "description": "This field is populated if the ETF's strategy involves hedging currency exposure.", + "default": null, + "optional": true + }, + { + "name": "includes_short_exposure", + "type": "bool", + "description": "This field is populated if the ETF has short exposure in any of its holdings e.g. in a long/short or inverse ETF.", + "default": null, + "optional": true + }, + { + "name": "ucits", + "type": "bool", + "description": "If true, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant", + "default": null, + "optional": true + }, + { + "name": "registered_countries", + "type": "str", + "description": "The list of countries where the ETF is legally registered for sale. This may differ from where the ETF is domiciled or traded, particularly in Europe.", + "default": null, + "optional": true + }, + { + "name": "issuer_country", + "type": "str", + "description": "2 letter ISO country code for the country where the issuer is located.", + "default": null, + "optional": true + }, + { + "name": "domicile", + "type": "str", + "description": "2 letter ISO country code for the country where the ETP is domiciled.", + "default": null, + "optional": true + }, + { + "name": "listing_country", + "type": "str", + "description": "2 letter ISO country code for the country of the primary listing.", + "default": null, + "optional": true + }, + { + "name": "listing_region", + "type": "str", + "description": "Geographic region in the country of the primary listing falls.", + "default": null, + "optional": true + }, + { + "name": "bond_currency_denomination", + "type": "str", + "description": "For all bond ETFs, this field provides additional detail on the currency denomination of the underlying securities.", + "default": null, + "optional": true + }, + { + "name": "base_currency", + "type": "str", + "description": "Base currency in which NAV is reported.", + "default": null, + "optional": true + }, + { + "name": "listing_currency", + "type": "str", + "description": "Listing currency of the Exchange Traded Product (ETP) in which it is traded. Reported using the 3-digit ISO currency code.", + "default": null, + "optional": true + }, + { + "name": "number_of_holdings", + "type": "int", + "description": "The number of holdings in the ETF.", + "default": null, + "optional": true + }, + { + "name": "month_end_assets", + "type": "float", + "description": "Net assets in millions of dollars as of the most recent month end.", + "default": null, + "optional": true + }, + { + "name": "net_expense_ratio", + "type": "float", + "description": "Gross expense net of Fee Waivers, as a percentage of net assets as published by the ETF issuer.", + "default": null, + "optional": true + }, + { + "name": "etf_portfolio_turnover", + "type": "float", + "description": "The percentage of positions turned over in the last 12 months.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "fund_type", + "type": "str", + "description": "The legal type of fund.", + "default": null, + "optional": true + }, + { + "name": "fund_family", + "type": "str", + "description": "The fund family.", + "default": null, + "optional": true + }, + { + "name": "category", + "type": "str", + "description": "The fund category.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "The exchange the fund is listed on.", + "default": null, + "optional": true + }, + { + "name": "exchange_timezone", + "type": "str", + "description": "The timezone of the exchange.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "The currency in which the fund is listed.", + "default": null, + "optional": true + }, + { + "name": "nav_price", + "type": "float", + "description": "The net asset value per unit of the fund.", + "default": null, + "optional": true + }, + { + "name": "total_assets", + "type": "int", + "description": "The total value of assets held by the fund.", + "default": null, + "optional": true + }, + { + "name": "trailing_pe", + "type": "float", + "description": "The trailing twelve month P/E ratio of the fund's assets.", + "default": null, + "optional": true + }, + { + "name": "dividend_yield", + "type": "float", + "description": "The dividend yield of the fund, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "dividend_rate_ttm", + "type": "float", + "description": "The trailing twelve month annual dividend rate of the fund, in currency units.", + "default": null, + "optional": true + }, + { + "name": "dividend_yield_ttm", + "type": "float", + "description": "The trailing twelve month annual dividend yield of the fund, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "year_high", + "type": "float", + "description": "The fifty-two week high price.", + "default": null, + "optional": true + }, + { + "name": "year_low", + "type": "float", + "description": "The fifty-two week low price.", + "default": null, + "optional": true + }, + { + "name": "ma_50d", + "type": "float", + "description": "50-day moving average price.", + "default": null, + "optional": true + }, + { + "name": "ma_200d", + "type": "float", + "description": "200-day moving average price.", + "default": null, + "optional": true + }, + { + "name": "return_ytd", + "type": "float", + "description": "The year-to-date return of the fund, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "return_3y_avg", + "type": "float", + "description": "The three year average return of the fund, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "return_5y_avg", + "type": "float", + "description": "The five year average return of the fund, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "beta_3y_avg", + "type": "float", + "description": "The three year average beta of the fund.", + "default": null, + "optional": true + }, + { + "name": "volume_avg", + "type": "float", + "description": "The average daily trading volume of the fund.", + "default": null, + "optional": true + }, + { + "name": "volume_avg_10d", + "type": "float", + "description": "The average daily trading volume of the fund over the past ten days.", + "default": null, + "optional": true + }, + { + "name": "bid", + "type": "float", + "description": "The current bid price.", + "default": null, + "optional": true + }, + { + "name": "bid_size", + "type": "float", + "description": "The current bid size.", + "default": null, + "optional": true + }, + { + "name": "ask", + "type": "float", + "description": "The current ask price.", + "default": null, + "optional": true + }, + { + "name": "ask_size", + "type": "float", + "description": "The current ask size.", + "default": null, + "optional": true + }, + { + "name": "open", + "type": "float", + "description": "The open price of the most recent trading session.", + "default": null, + "optional": true + }, + { + "name": "high", + "type": "float", + "description": "The highest price of the most recent trading session.", + "default": null, + "optional": true + }, + { + "name": "low", + "type": "float", + "description": "The lowest price of the most recent trading session.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume of the most recent trading session.", + "default": null, + "optional": true + }, + { + "name": "prev_close", + "type": "float", + "description": "The previous closing price.", + "default": null, + "optional": true + } + ] + }, + "model": "EtfInfo" + }, + "/etf/sectors": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "ETF Sector weighting.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.sectors(symbol='SPY', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfSectors]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "sector", + "type": "str", + "description": "Sector of exposure.", + "default": "", + "optional": false + }, + { + "name": "weight", + "type": "float", + "description": "Exposure of the ETF to the sector in normalized percentage points.", + "default": "", + "optional": false + } + ], + "fmp": [ + { + "name": "sector", + "type": "str", + "description": "Sector of exposure.", + "default": "", + "optional": false + }, + { + "name": "weight", + "type": "float", + "description": "Exposure of the ETF to the sector in normalized percentage points.", + "default": "", + "optional": false + } + ] + }, + "model": "EtfSectors" + }, + "/etf/countries": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "ETF Country weighting.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.countries(symbol='VT', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfCountries]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "country", + "type": "str", + "description": "The country of the exposure. Corresponding values are normalized percentage points.", + "default": "", + "optional": false + } + ], + "fmp": [ + { + "name": "country", + "type": "str", + "description": "The country of the exposure. Corresponding values are normalized percentage points.", + "default": "", + "optional": false + } + ] + }, + "model": "EtfCountries" + }, + "/etf/price_performance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Price performance as a return, over different periods.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.price_performance(symbol='QQQ', provider='fmp')\nobb.etf.price_performance(symbol='SPY,QQQ,IWM,DJIA', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + } + ], + "intrinio": [ + { + "name": "return_type", + "type": "Literal['trailing', 'calendar']", + "description": "The type of returns to return, a trailing or calendar window.", + "default": "trailing", + "optional": true + }, + { + "name": "adjustment", + "type": "Literal['splits_only', 'splits_and_dividends']", + "description": "The adjustment factor, 'splits_only' will return pure price performance.", + "default": "splits_and_dividends", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfPricePerformance]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", "type": "str", - "description": "The exchange the fund is listed on.", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "exchange_timezone", - "type": "str", - "description": "The timezone of the exchange.", + "name": "one_day", + "type": "float", + "description": "One-day return.", "default": null, "optional": true }, { - "name": "currency", - "type": "str", - "description": "The currency in which the fund is listed.", + "name": "wtd", + "type": "float", + "description": "Week to date return.", "default": null, "optional": true }, { - "name": "nav_price", + "name": "one_week", "type": "float", - "description": "The net asset value per unit of the fund.", + "description": "One-week return.", "default": null, "optional": true }, { - "name": "total_assets", - "type": "int", - "description": "The total value of assets held by the fund.", + "name": "mtd", + "type": "float", + "description": "Month to date return.", "default": null, "optional": true }, { - "name": "trailing_pe", + "name": "one_month", "type": "float", - "description": "The trailing twelve month P/E ratio of the fund's assets.", + "description": "One-month return.", "default": null, "optional": true }, { - "name": "dividend_yield", + "name": "qtd", "type": "float", - "description": "The dividend yield of the fund, as a normalized percent.", + "description": "Quarter to date return.", "default": null, "optional": true }, { - "name": "dividend_rate_ttm", + "name": "three_month", "type": "float", - "description": "The trailing twelve month annual dividend rate of the fund, in currency units.", + "description": "Three-month return.", "default": null, "optional": true }, { - "name": "dividend_yield_ttm", + "name": "six_month", "type": "float", - "description": "The trailing twelve month annual dividend yield of the fund, as a normalized percent.", + "description": "Six-month return.", "default": null, "optional": true }, { - "name": "year_high", + "name": "ytd", "type": "float", - "description": "The fifty-two week high price.", + "description": "Year to date return.", "default": null, "optional": true }, { - "name": "year_low", + "name": "one_year", "type": "float", - "description": "The fifty-two week low price.", + "description": "One-year return.", "default": null, "optional": true }, { - "name": "ma_50d", + "name": "two_year", "type": "float", - "description": "50-day moving average price.", + "description": "Two-year return.", "default": null, "optional": true }, { - "name": "ma_200d", + "name": "three_year", "type": "float", - "description": "200-day moving average price.", + "description": "Three-year return.", "default": null, "optional": true }, { - "name": "return_ytd", + "name": "four_year", "type": "float", - "description": "The year-to-date return of the fund, as a normalized percent.", + "description": "Four-year", "default": null, "optional": true }, { - "name": "return_3y_avg", + "name": "five_year", "type": "float", - "description": "The three year average return of the fund, as a normalized percent.", + "description": "Five-year return.", "default": null, "optional": true }, { - "name": "return_5y_avg", + "name": "ten_year", "type": "float", - "description": "The five year average return of the fund, as a normalized percent.", + "description": "Ten-year return.", "default": null, "optional": true }, { - "name": "beta_3y_avg", + "name": "max", "type": "float", - "description": "The three year average beta of the fund.", + "description": "Return from the beginning of the time series.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "volume_avg", + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": "", + "optional": false + } + ], + "intrinio": [ + { + "name": "max_annualized", "type": "float", - "description": "The average daily trading volume of the fund.", + "description": "Annualized rate of return from inception.", "default": null, "optional": true }, { - "name": "volume_avg_10d", + "name": "volatility_one_year", "type": "float", - "description": "The average daily trading volume of the fund over the past ten days.", + "description": "Trailing one-year annualized volatility.", "default": null, "optional": true }, { - "name": "bid", + "name": "volatility_three_year", "type": "float", - "description": "The current bid price.", + "description": "Trailing three-year annualized volatility.", "default": null, "optional": true }, { - "name": "bid_size", + "name": "volatility_five_year", "type": "float", - "description": "The current bid size.", + "description": "Trailing five-year annualized volatility.", "default": null, "optional": true }, { - "name": "ask", - "type": "float", - "description": "The current ask price.", + "name": "volume", + "type": "int", + "description": "The trading volume.", "default": null, "optional": true }, { - "name": "ask_size", + "name": "volume_avg_30", "type": "float", - "description": "The current ask size.", + "description": "The one-month average daily volume.", "default": null, "optional": true }, { - "name": "open", + "name": "volume_avg_90", "type": "float", - "description": "The open price of the most recent trading session.", + "description": "The three-month average daily volume.", "default": null, "optional": true }, { - "name": "high", + "name": "volume_avg_180", "type": "float", - "description": "The highest price of the most recent trading session.", + "description": "The six-month average daily volume.", "default": null, "optional": true }, { - "name": "low", + "name": "beta", "type": "float", - "description": "The lowest price of the most recent trading session.", + "description": "Beta compared to the S&P 500.", "default": null, "optional": true }, { - "name": "volume", - "type": "int", - "description": "The trading volume of the most recent trading session.", + "name": "nav", + "type": "float", + "description": "Net asset value per share.", "default": null, "optional": true }, { - "name": "prev_close", + "name": "year_high", "type": "float", - "description": "The previous closing price.", + "description": "The 52-week high price.", "default": null, "optional": true - } - ] - }, - "model": "EtfInfo" - }, - "/etf/sectors": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "ETF Sector weighting.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.sectors(symbol='SPY', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for. (ETF)", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", - "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EtfSectors]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "sector", - "type": "str", - "description": "Sector of exposure.", - "default": "", - "optional": false }, { - "name": "weight", + "name": "year_low", "type": "float", - "description": "Exposure of the ETF to the sector in normalized percentage points.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "EtfSectors" - }, - "/etf/countries": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "ETF Country weighting.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.countries(symbol='VT', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp.", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", + "description": "The 52-week low price.", + "default": null, "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EtfCountries]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "market_cap", + "type": "float", + "description": "The market capitalization.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "shares_outstanding", + "type": "int", + "description": "The number of shares outstanding.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "updated", + "type": "date", + "description": "The date of the data.", + "default": null, + "optional": true } ] }, - "data": { - "standard": [ - { - "name": "country", - "type": "str", - "description": "The country of the exposure. Corresponding values are normalized percentage points.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "EtfCountries" + "model": "EtfPricePerformance" }, - "/etf/price_performance": { + "/etf/holdings": { "deprecated": { "flag": null, "message": null }, - "description": "Price performance as a return, over different periods.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.price_performance(symbol='QQQ', provider='fmp')\nobb.etf.price_performance(symbol='SPY,QQQ,IWM,DJIA', provider='fmp')\n```\n\n", + "description": "Get the holdings for an individual ETF.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings(symbol='XLK', provider='fmp')\n# Including a date (FMP, SEC) will return the holdings as per NPORT-P filings.\nobb.etf.holdings(symbol='XLK', date=2022-03-31, provider='fmp')\n# The same data can be returned from the SEC directly.\nobb.etf.holdings(symbol='XLK', date=2022-03-31, provider='sec')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", + "type": "str", + "description": "Symbol to get data for. (ETF)", "default": "", "optional": false }, { "name": "provider", - "type": "Literal['fmp', 'intrinio']", + "type": "Literal['fmp', 'intrinio', 'sec']", "description": "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.", "default": "fmp", "optional": true } ], - "fmp": [], + "fmp": [ + { + "name": "date", + "type": "Union[Union[str, date], str]", + "description": "A specific date to get data for. Entering a date will attempt to return the NPORT-P filing for the entered date. This needs to be _exactly_ the date of the filing. Use the holdings_date command/endpoint to find available filing dates for the ETF.", + "default": null, + "optional": true + }, + { + "name": "cik", + "type": "str", + "description": "The CIK of the filing entity. Overrides symbol.", + "default": null, + "optional": true + } + ], "intrinio": [ { - "name": "return_type", - "type": "Literal['trailing', 'calendar']", - "description": "The type of returns to return, a trailing or calendar window.", - "default": "trailing", + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": null, + "optional": true + } + ], + "sec": [ + { + "name": "date", + "type": "Union[Union[str, date], str]", + "description": "A specific date to get data for. The date represents the period ending. The date entered will return the closest filing.", + "default": null, "optional": true }, { - "name": "adjustment", - "type": "Literal['splits_only', 'splits_and_dividends']", - "description": "The adjustment factor, 'splits_only' will return pure price performance.", - "default": "splits_and_dividends", + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache for the request.", + "default": true, "optional": true } ] @@ -22679,12 +27512,12 @@ "OBBject": [ { "name": "results", - "type": "List[EtfPricePerformance]", + "type": "List[EtfHoldings]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio']]", + "type": "Optional[Literal['fmp', 'intrinio', 'sec']]", "description": "Provider name." }, { @@ -22709,347 +27542,296 @@ { "name": "symbol", "type": "str", - "description": "Symbol representing the entity requested in the data.", + "description": "Symbol representing the entity requested in the data. (ETF)", "default": null, "optional": true }, { - "name": "one_day", - "type": "float", - "description": "One-day return.", + "name": "name", + "type": "str", + "description": "Name of the ETF holding.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "wtd", - "type": "float", - "description": "Week to date return.", + "name": "lei", + "type": "str", + "description": "The LEI of the holding.", "default": null, "optional": true }, { - "name": "one_week", - "type": "float", - "description": "One-week return.", + "name": "title", + "type": "str", + "description": "The title of the holding.", "default": null, "optional": true }, { - "name": "mtd", - "type": "float", - "description": "Month to date return.", + "name": "cusip", + "type": "str", + "description": "The CUSIP of the holding.", "default": null, "optional": true }, { - "name": "one_month", - "type": "float", - "description": "One-month return.", + "name": "isin", + "type": "str", + "description": "The ISIN of the holding.", "default": null, "optional": true }, { - "name": "qtd", - "type": "float", - "description": "Quarter to date return.", + "name": "balance", + "type": "int", + "description": "The balance of the holding, in shares or units.", "default": null, "optional": true }, { - "name": "three_month", - "type": "float", - "description": "Three-month return.", + "name": "units", + "type": "Union[str, float]", + "description": "The type of units.", "default": null, "optional": true }, { - "name": "six_month", - "type": "float", - "description": "Six-month return.", + "name": "currency", + "type": "str", + "description": "The currency of the holding.", "default": null, "optional": true }, { - "name": "ytd", + "name": "value", "type": "float", - "description": "Year to date return.", + "description": "The value of the holding, in dollars.", "default": null, "optional": true }, { - "name": "one_year", + "name": "weight", "type": "float", - "description": "One-year return.", + "description": "The weight of the holding, as a normalized percent.", "default": null, "optional": true }, { - "name": "two_year", - "type": "float", - "description": "Two-year return.", + "name": "payoff_profile", + "type": "str", + "description": "The payoff profile of the holding.", "default": null, "optional": true }, { - "name": "three_year", - "type": "float", - "description": "Three-year return.", + "name": "asset_category", + "type": "str", + "description": "The asset category of the holding.", "default": null, "optional": true }, { - "name": "four_year", - "type": "float", - "description": "Four-year", + "name": "issuer_category", + "type": "str", + "description": "The issuer category of the holding.", "default": null, "optional": true }, { - "name": "five_year", - "type": "float", - "description": "Five-year return.", + "name": "country", + "type": "str", + "description": "The country of the holding.", "default": null, "optional": true }, { - "name": "ten_year", - "type": "float", - "description": "Ten-year return.", + "name": "is_restricted", + "type": "str", + "description": "Whether the holding is restricted.", "default": null, "optional": true }, { - "name": "max", - "type": "float", - "description": "Return from the beginning of the time series.", + "name": "fair_value_level", + "type": "int", + "description": "The fair value level of the holding.", "default": null, "optional": true - } - ], - "fmp": [], - "intrinio": [ + }, { - "name": "max_annualized", - "type": "float", - "description": "Annualized rate of return from inception.", + "name": "is_cash_collateral", + "type": "str", + "description": "Whether the holding is cash collateral.", "default": null, "optional": true }, { - "name": "volatility_one_year", - "type": "float", - "description": "Trailing one-year annualized volatility.", + "name": "is_non_cash_collateral", + "type": "str", + "description": "Whether the holding is non-cash collateral.", "default": null, "optional": true }, { - "name": "volatility_three_year", - "type": "float", - "description": "Trailing three-year annualized volatility.", + "name": "is_loan_by_fund", + "type": "str", + "description": "Whether the holding is loan by fund.", "default": null, "optional": true }, { - "name": "volatility_five_year", - "type": "float", - "description": "Trailing five-year annualized volatility.", + "name": "cik", + "type": "str", + "description": "The CIK of the filing.", "default": null, "optional": true }, { - "name": "volume", - "type": "int", - "description": "The trading volume.", + "name": "acceptance_datetime", + "type": "str", + "description": "The acceptance datetime of the filing.", "default": null, "optional": true }, { - "name": "volume_avg_30", - "type": "float", - "description": "The one-month average daily volume.", + "name": "updated", + "type": "Union[date, datetime]", + "description": "The date the data was updated.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "volume_avg_90", - "type": "float", - "description": "The three-month average daily volume.", + "name": "name", + "type": "str", + "description": "The common name for the holding.", "default": null, "optional": true }, { - "name": "volume_avg_180", - "type": "float", - "description": "The six-month average daily volume.", + "name": "security_type", + "type": "str", + "description": "The type of instrument for this holding. Examples(Bond='BOND', Equity='EQUI')", "default": null, "optional": true }, { - "name": "beta", - "type": "float", - "description": "Beta compared to the S&P 500.", + "name": "isin", + "type": "str", + "description": "The International Securities Identification Number.", "default": null, "optional": true }, { - "name": "nav", - "type": "float", - "description": "Net asset value per share.", + "name": "ric", + "type": "str", + "description": "The Reuters Instrument Code.", "default": null, "optional": true }, { - "name": "year_high", - "type": "float", - "description": "The 52-week high price.", + "name": "sedol", + "type": "str", + "description": "The Stock Exchange Daily Official List.", "default": null, "optional": true }, { - "name": "year_low", - "type": "float", - "description": "The 52-week low price.", + "name": "share_class_figi", + "type": "str", + "description": "The OpenFIGI symbol for the holding.", "default": null, "optional": true }, { - "name": "market_cap", - "type": "float", - "description": "The market capitalization.", + "name": "country", + "type": "str", + "description": "The country or region of the holding.", "default": null, "optional": true }, { - "name": "shares_outstanding", - "type": "int", - "description": "The number of shares outstanding.", + "name": "maturity_date", + "type": "date", + "description": "The maturity date for the debt security, if available.", "default": null, "optional": true }, { - "name": "updated", + "name": "contract_expiry_date", "type": "date", - "description": "The date of the data.", + "description": "Expiry date for the futures contract held, if available.", "default": null, "optional": true - } - ] - }, - "model": "EtfPricePerformance" - }, - "/etf/holdings": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the holdings for an individual ETF.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings(symbol='XLK', provider='fmp')\n# Including a date (FMP, SEC) will return the holdings as per NPORT-P filings.\nobb.etf.holdings(symbol='XLK', date=2022-03-31, provider='fmp')\n# The same data can be returned from the SEC directly.\nobb.etf.holdings(symbol='XLK', date=2022-03-31, provider='sec')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for. (ETF)", - "default": "", - "optional": false }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'sec']", - "description": "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.", - "default": "fmp", + "name": "coupon", + "type": "float", + "description": "The coupon rate of the debt security, if available.", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "date", - "type": "Union[Union[str, date], str]", - "description": "A specific date to get data for. Entering a date will attempt to return the NPORT-P filing for the entered date. This needs to be _exactly_ the date of the filing. Use the holdings_date command/endpoint to find available filing dates for the ETF.", + "name": "balance", + "type": "Union[int, float]", + "description": "The number of units of the security held, if available.", "default": null, "optional": true }, { - "name": "cik", + "name": "unit", "type": "str", - "description": "The CIK of the filing entity. Overrides symbol.", + "description": "The units of the 'balance' field.", "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", + "name": "units_per_share", + "type": "float", + "description": "Number of units of the security held per share outstanding of the ETF, if available.", "default": null, "optional": true - } - ], - "sec": [ + }, { - "name": "date", - "type": "Union[Union[str, date], str]", - "description": "A specific date to get data for. The date represents the period ending. The date entered will return the closest filing.", + "name": "face_value", + "type": "float", + "description": "The face value of the debt security, if available.", "default": null, "optional": true }, { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache for the request.", - "default": true, + "name": "derivatives_value", + "type": "float", + "description": "The notional value of derivatives contracts held.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EtfHoldings]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'sec']]", - "description": "Provider name." }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "value", + "type": "float", + "description": "The market value of the holding, on the 'as_of' date.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data. (ETF)", + "name": "weight", + "type": "float", + "description": "The weight of the holding, as a normalized percent.", "default": null, "optional": true }, { - "name": "name", - "type": "str", - "description": "Name of the ETF holding.", + "name": "updated", + "type": "date", + "description": "The 'as_of' date for the holding.", "default": null, "optional": true } ], - "fmp": [ + "sec": [ { "name": "lei", "type": "str", @@ -23057,13 +27839,6 @@ "default": null, "optional": true }, - { - "name": "title", - "type": "str", - "description": "The title of the holding.", - "default": null, - "optional": true - }, { "name": "cusip", "type": "str", @@ -23079,44 +27854,51 @@ "optional": true }, { - "name": "balance", - "type": "int", - "description": "The balance of the holding, in shares or units.", + "name": "other_id", + "type": "str", + "description": "Internal identifier for the holding.", "default": null, "optional": true }, { - "name": "units", - "type": "Union[str, float]", - "description": "The type of units.", + "name": "balance", + "type": "float", + "description": "The balance of the holding.", "default": null, "optional": true }, { - "name": "currency", - "type": "str", - "description": "The currency of the holding.", + "name": "weight", + "type": "float", + "description": "The weight of the holding in ETF in %.", "default": null, "optional": true }, { "name": "value", "type": "float", - "description": "The value of the holding, in dollars.", + "description": "The value of the holding in USD.", "default": null, "optional": true }, { - "name": "weight", - "type": "float", - "description": "The weight of the holding, as a normalized percent.", + "name": "payoff_profile", + "type": "str", + "description": "The payoff profile of the holding.", "default": null, "optional": true }, { - "name": "payoff_profile", + "name": "units", + "type": "Union[str, float]", + "description": "The units of the holding.", + "default": null, + "optional": true + }, + { + "name": "currency", "type": "str", - "description": "The payoff profile of the holding.", + "description": "The currency of the holding.", "default": null, "optional": true }, @@ -23177,694 +27959,854 @@ "optional": true }, { - "name": "cik", + "name": "loan_value", + "type": "float", + "description": "The loan value of the holding.", + "default": null, + "optional": true + }, + { + "name": "issuer_conditional", "type": "str", - "description": "The CIK of the filing.", + "description": "The issuer conditions of the holding.", "default": null, "optional": true }, { - "name": "acceptance_datetime", + "name": "asset_conditional", "type": "str", - "description": "The acceptance datetime of the filing.", + "description": "The asset conditions of the holding.", "default": null, "optional": true }, { - "name": "updated", - "type": "Union[date, datetime]", - "description": "The date the data was updated.", + "name": "maturity_date", + "type": "date", + "description": "The maturity date of the debt security.", "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "security_type", + "name": "coupon_kind", "type": "str", - "description": "The type of instrument for this holding. Examples(Bond='BOND', Equity='EQUI')", + "description": "The type of coupon for the debt security.", + "default": null, + "optional": true + }, + { + "name": "rate_type", + "type": "str", + "description": "The type of rate for the debt security, floating or fixed.", + "default": null, + "optional": true + }, + { + "name": "annualized_return", + "type": "float", + "description": "The annualized return on the debt security.", + "default": null, + "optional": true + }, + { + "name": "is_default", + "type": "str", + "description": "If the debt security is defaulted.", + "default": null, + "optional": true + }, + { + "name": "in_arrears", + "type": "str", + "description": "If the debt security is in arrears.", + "default": null, + "optional": true + }, + { + "name": "is_paid_kind", + "type": "str", + "description": "If the debt security payments are paid in kind.", "default": null, "optional": true }, { - "name": "isin", + "name": "derivative_category", "type": "str", - "description": "The International Securities Identification Number.", + "description": "The derivative category of the holding.", "default": null, "optional": true }, { - "name": "ric", + "name": "counterparty", "type": "str", - "description": "The Reuters Instrument Code.", + "description": "The counterparty of the derivative.", "default": null, "optional": true }, { - "name": "sedol", + "name": "underlying_name", "type": "str", - "description": "The Stock Exchange Daily Official List.", + "description": "The name of the underlying asset associated with the derivative.", "default": null, "optional": true }, { - "name": "share_class_figi", + "name": "option_type", "type": "str", - "description": "The OpenFIGI symbol for the holding.", + "description": "The type of option.", "default": null, "optional": true }, { - "name": "country", + "name": "derivative_payoff", "type": "str", - "description": "The country or region of the holding.", + "description": "The payoff profile of the derivative.", "default": null, "optional": true }, { - "name": "maturity_date", + "name": "expiry_date", "type": "date", - "description": "The maturity date for the debt security, if available.", + "description": "The expiry or termination date of the derivative.", "default": null, "optional": true }, { - "name": "contract_expiry_date", - "type": "date", - "description": "Expiry date for the futures contract held, if available.", + "name": "exercise_price", + "type": "float", + "description": "The exercise price of the option.", "default": null, "optional": true }, { - "name": "coupon", + "name": "exercise_currency", + "type": "str", + "description": "The currency of the option exercise price.", + "default": null, + "optional": true + }, + { + "name": "shares_per_contract", "type": "float", - "description": "The coupon rate of the debt security, if available.", + "description": "The number of shares per contract.", "default": null, "optional": true }, { - "name": "balance", - "type": "Union[int, float]", - "description": "The number of units of the security held, if available.", + "name": "delta", + "type": "Union[str, float]", + "description": "The delta of the option.", "default": null, "optional": true }, { - "name": "unit", + "name": "rate_type_rec", "type": "str", - "description": "The units of the 'balance' field.", + "description": "The type of rate for receivable portion of the swap.", "default": null, "optional": true }, { - "name": "units_per_share", - "type": "float", - "description": "Number of units of the security held per share outstanding of the ETF, if available.", + "name": "receive_currency", + "type": "str", + "description": "The receive currency of the swap.", "default": null, "optional": true }, { - "name": "face_value", + "name": "upfront_receive", "type": "float", - "description": "The face value of the debt security, if available.", + "description": "The upfront amount received of the swap.", "default": null, "optional": true }, { - "name": "derivatives_value", - "type": "float", - "description": "The notional value of derivatives contracts held.", + "name": "floating_rate_index_rec", + "type": "str", + "description": "The floating rate index for receivable portion of the swap.", "default": null, "optional": true }, { - "name": "value", + "name": "floating_rate_spread_rec", "type": "float", - "description": "The market value of the holding, on the 'as_of' date.", + "description": "The floating rate spread for reveivable portion of the swap.", "default": null, "optional": true }, { - "name": "weight", - "type": "float", - "description": "The weight of the holding, as a normalized percent.", + "name": "rate_tenor_rec", + "type": "str", + "description": "The rate tenor for receivable portion of the swap.", "default": null, "optional": true }, { - "name": "updated", - "type": "date", - "description": "The 'as_of' date for the holding.", + "name": "rate_tenor_unit_rec", + "type": "Union[int, str]", + "description": "The rate tenor unit for receivable portion of the swap.", "default": null, "optional": true - } - ], - "sec": [ + }, { - "name": "lei", + "name": "reset_date_rec", "type": "str", - "description": "The LEI of the holding.", + "description": "The reset date for receivable portion of the swap.", "default": null, "optional": true }, { - "name": "cusip", - "type": "str", - "description": "The CUSIP of the holding.", + "name": "reset_date_unit_rec", + "type": "Union[int, str]", + "description": "The reset date unit for receivable portion of the swap.", "default": null, "optional": true }, { - "name": "isin", + "name": "rate_type_pmnt", "type": "str", - "description": "The ISIN of the holding.", + "description": "The type of rate for payment portion of the swap.", "default": null, "optional": true }, { - "name": "other_id", + "name": "payment_currency", "type": "str", - "description": "Internal identifier for the holding.", + "description": "The payment currency of the swap.", "default": null, "optional": true }, { - "name": "balance", + "name": "upfront_payment", "type": "float", - "description": "The balance of the holding.", + "description": "The upfront amount received of the swap.", "default": null, "optional": true }, { - "name": "weight", - "type": "float", - "description": "The weight of the holding in ETF in %.", + "name": "floating_rate_index_pmnt", + "type": "str", + "description": "The floating rate index for payment portion of the swap.", "default": null, "optional": true }, { - "name": "value", + "name": "floating_rate_spread_pmnt", "type": "float", - "description": "The value of the holding in USD.", + "description": "The floating rate spread for payment portion of the swap.", "default": null, "optional": true }, { - "name": "payoff_profile", + "name": "rate_tenor_pmnt", "type": "str", - "description": "The payoff profile of the holding.", + "description": "The rate tenor for payment portion of the swap.", "default": null, "optional": true }, { - "name": "units", - "type": "Union[str, float]", - "description": "The units of the holding.", + "name": "rate_tenor_unit_pmnt", + "type": "Union[int, str]", + "description": "The rate tenor unit for payment portion of the swap.", "default": null, "optional": true }, { - "name": "currency", + "name": "reset_date_pmnt", "type": "str", - "description": "The currency of the holding.", + "description": "The reset date for payment portion of the swap.", "default": null, "optional": true }, { - "name": "asset_category", - "type": "str", - "description": "The asset category of the holding.", + "name": "reset_date_unit_pmnt", + "type": "Union[int, str]", + "description": "The reset date unit for payment portion of the swap.", "default": null, "optional": true }, { - "name": "issuer_category", + "name": "repo_type", "type": "str", - "description": "The issuer category of the holding.", + "description": "The type of repo.", "default": null, "optional": true }, { - "name": "country", + "name": "is_cleared", "type": "str", - "description": "The country of the holding.", + "description": "If the repo is cleared.", "default": null, "optional": true }, { - "name": "is_restricted", + "name": "is_tri_party", "type": "str", - "description": "Whether the holding is restricted.", + "description": "If the repo is tri party.", "default": null, "optional": true }, { - "name": "fair_value_level", - "type": "int", - "description": "The fair value level of the holding.", + "name": "principal_amount", + "type": "float", + "description": "The principal amount of the repo.", "default": null, "optional": true }, { - "name": "is_cash_collateral", + "name": "principal_currency", "type": "str", - "description": "Whether the holding is cash collateral.", + "description": "The currency of the principal amount.", "default": null, "optional": true }, { - "name": "is_non_cash_collateral", + "name": "collateral_type", "type": "str", - "description": "Whether the holding is non-cash collateral.", + "description": "The collateral type of the repo.", "default": null, "optional": true }, { - "name": "is_loan_by_fund", - "type": "str", - "description": "Whether the holding is loan by fund.", + "name": "collateral_amount", + "type": "float", + "description": "The collateral amount of the repo.", "default": null, "optional": true }, { - "name": "loan_value", - "type": "float", - "description": "The loan value of the holding.", + "name": "collateral_currency", + "type": "str", + "description": "The currency of the collateral amount.", "default": null, "optional": true }, { - "name": "issuer_conditional", + "name": "exchange_currency", "type": "str", - "description": "The issuer conditions of the holding.", + "description": "The currency of the exchange rate.", "default": null, "optional": true }, { - "name": "asset_conditional", - "type": "str", - "description": "The asset conditions of the holding.", + "name": "exchange_rate", + "type": "float", + "description": "The exchange rate.", "default": null, "optional": true }, { - "name": "maturity_date", - "type": "date", - "description": "The maturity date of the debt security.", + "name": "currency_sold", + "type": "str", + "description": "The currency sold in a Forward Derivative.", "default": null, "optional": true }, { - "name": "coupon_kind", - "type": "str", - "description": "The type of coupon for the debt security.", + "name": "currency_amount_sold", + "type": "float", + "description": "The amount of currency sold in a Forward Derivative.", "default": null, "optional": true }, { - "name": "rate_type", + "name": "currency_bought", "type": "str", - "description": "The type of rate for the debt security, floating or fixed.", + "description": "The currency bought in a Forward Derivative.", "default": null, "optional": true }, { - "name": "annualized_return", + "name": "currency_amount_bought", "type": "float", - "description": "The annualized return on the debt security.", + "description": "The amount of currency bought in a Forward Derivative.", "default": null, "optional": true }, { - "name": "is_default", - "type": "str", - "description": "If the debt security is defaulted.", + "name": "notional_amount", + "type": "float", + "description": "The notional amount of the derivative.", "default": null, "optional": true }, { - "name": "in_arrears", + "name": "notional_currency", "type": "str", - "description": "If the debt security is in arrears.", + "description": "The currency of the derivative's notional amount.", "default": null, "optional": true }, { - "name": "is_paid_kind", - "type": "str", - "description": "If the debt security payments are paid in kind.", + "name": "unrealized_gain", + "type": "float", + "description": "The unrealized gain or loss on the derivative.", "default": null, "optional": true - }, + } + ] + }, + "model": "EtfHoldings" + }, + "/etf/holdings_date": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Use this function to get the holdings dates, if available.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings_date(symbol='XLK', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "derivative_category", + "name": "symbol", "type": "str", - "description": "The derivative category of the holding.", - "default": null, - "optional": true + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false }, { - "name": "counterparty", + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "cik", "type": "str", - "description": "The counterparty of the derivative.", + "description": "The CIK of the filing entity. Overrides symbol.", "default": null, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfHoldingsDate]", + "description": "Serializable results." }, { - "name": "underlying_name", - "type": "str", - "description": "The name of the underlying asset associated with the derivative.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "option_type", - "type": "str", - "description": "The type of option.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "derivative_payoff", - "type": "str", - "description": "The payoff profile of the derivative.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "expiry_date", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", "type": "date", - "description": "The expiry or termination date of the derivative.", - "default": null, - "optional": true + "description": "The date of the data.", + "default": "", + "optional": false + } + ], + "fmp": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + } + ] + }, + "model": "EtfHoldingsDate" + }, + "/etf/holdings_performance": { + "deprecated": { + "flag": true, + "message": "This endpoint is deprecated; pass a list of holdings symbols directly to `/equity/price/performance` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.2." + }, + "description": "Get the recent price performance of each ticker held in the ETF.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings_performance(symbol='XLK', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "exercise_price", - "type": "float", - "description": "The exercise price of the option.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "exercise_currency", + "name": "symbol", "type": "str", - "description": "The currency of the option exercise price.", - "default": null, - "optional": true + "description": "Symbol to get data for.", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfHoldingsPerformance]", + "description": "Serializable results." }, { - "name": "shares_per_contract", - "type": "float", - "description": "The number of shares per contract.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "delta", - "type": "Union[str, float]", - "description": "The delta of the option.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "rate_type_rec", - "type": "str", - "description": "The type of rate for receivable portion of the swap.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "receive_currency", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", "type": "str", - "description": "The receive currency of the swap.", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "upfront_receive", + "name": "one_day", "type": "float", - "description": "The upfront amount received of the swap.", + "description": "One-day return.", "default": null, "optional": true }, { - "name": "floating_rate_index_rec", - "type": "str", - "description": "The floating rate index for receivable portion of the swap.", + "name": "wtd", + "type": "float", + "description": "Week to date return.", "default": null, "optional": true }, { - "name": "floating_rate_spread_rec", + "name": "one_week", "type": "float", - "description": "The floating rate spread for reveivable portion of the swap.", + "description": "One-week return.", "default": null, "optional": true }, { - "name": "rate_tenor_rec", - "type": "str", - "description": "The rate tenor for receivable portion of the swap.", + "name": "mtd", + "type": "float", + "description": "Month to date return.", "default": null, "optional": true }, { - "name": "rate_tenor_unit_rec", - "type": "Union[str, int]", - "description": "The rate tenor unit for receivable portion of the swap.", + "name": "one_month", + "type": "float", + "description": "One-month return.", "default": null, "optional": true }, { - "name": "reset_date_rec", - "type": "str", - "description": "The reset date for receivable portion of the swap.", + "name": "qtd", + "type": "float", + "description": "Quarter to date return.", "default": null, "optional": true }, { - "name": "reset_date_unit_rec", - "type": "Union[str, int]", - "description": "The reset date unit for receivable portion of the swap.", + "name": "three_month", + "type": "float", + "description": "Three-month return.", "default": null, "optional": true }, { - "name": "rate_type_pmnt", - "type": "str", - "description": "The type of rate for payment portion of the swap.", + "name": "six_month", + "type": "float", + "description": "Six-month return.", "default": null, "optional": true }, { - "name": "payment_currency", - "type": "str", - "description": "The payment currency of the swap.", + "name": "ytd", + "type": "float", + "description": "Year to date return.", "default": null, "optional": true }, { - "name": "upfront_payment", + "name": "one_year", "type": "float", - "description": "The upfront amount received of the swap.", + "description": "One-year return.", "default": null, "optional": true }, { - "name": "floating_rate_index_pmnt", - "type": "str", - "description": "The floating rate index for payment portion of the swap.", + "name": "two_year", + "type": "float", + "description": "Two-year return.", "default": null, "optional": true }, { - "name": "floating_rate_spread_pmnt", + "name": "three_year", "type": "float", - "description": "The floating rate spread for payment portion of the swap.", + "description": "Three-year return.", "default": null, "optional": true }, { - "name": "rate_tenor_pmnt", - "type": "str", - "description": "The rate tenor for payment portion of the swap.", + "name": "four_year", + "type": "float", + "description": "Four-year", "default": null, "optional": true }, { - "name": "rate_tenor_unit_pmnt", - "type": "Union[str, int]", - "description": "The rate tenor unit for payment portion of the swap.", + "name": "five_year", + "type": "float", + "description": "Five-year return.", "default": null, "optional": true }, { - "name": "reset_date_pmnt", - "type": "str", - "description": "The reset date for payment portion of the swap.", + "name": "ten_year", + "type": "float", + "description": "Ten-year return.", "default": null, "optional": true }, { - "name": "reset_date_unit_pmnt", - "type": "Union[str, int]", - "description": "The reset date unit for payment portion of the swap.", + "name": "max", + "type": "float", + "description": "Return from the beginning of the time series.", "default": null, "optional": true - }, + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": "", + "optional": false + } + ] + }, + "model": "EtfHoldingsPerformance" + }, + "/etf/equity_exposure": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the exposure to ETFs for a specific stock.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.equity_exposure(symbol='MSFT', provider='fmp')\n# This function accepts multiple tickers.\nobb.etf.equity_exposure(symbol='MSFT,AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "repo_type", + "name": "symbol", "type": "str", - "description": "The type of repo.", - "default": null, - "optional": true + "description": "Symbol to get data for. (Stock)", + "default": "", + "optional": false }, { - "name": "is_cleared", - "type": "str", - "description": "If the repo is cleared.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "is_tri_party", + "name": "symbol", "type": "str", - "description": "If the repo is tri party.", - "default": null, - "optional": true - }, + "description": "Symbol to get data for. (Stock)", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ { - "name": "principal_amount", - "type": "float", - "description": "The principal amount of the repo.", - "default": null, - "optional": true + "name": "results", + "type": "List[EtfEquityExposure]", + "description": "Serializable results." }, { - "name": "principal_currency", - "type": "str", - "description": "The currency of the principal amount.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "collateral_type", - "type": "str", - "description": "The collateral type of the repo.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "collateral_amount", - "type": "float", - "description": "The collateral amount of the repo.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "collateral_currency", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "equity_symbol", "type": "str", - "description": "The currency of the collateral amount.", - "default": null, - "optional": true + "description": "The symbol of the equity requested.", + "default": "", + "optional": false }, { - "name": "exchange_currency", + "name": "etf_symbol", "type": "str", - "description": "The currency of the exchange rate.", - "default": null, - "optional": true + "description": "The symbol of the ETF with exposure to the requested equity.", + "default": "", + "optional": false }, { - "name": "exchange_rate", + "name": "shares", "type": "float", - "description": "The exchange rate.", + "description": "The number of shares held in the ETF.", "default": null, "optional": true }, { - "name": "currency_sold", - "type": "str", - "description": "The currency sold in a Forward Derivative.", + "name": "weight", + "type": "float", + "description": "The weight of the equity in the ETF, as a normalized percent.", "default": null, "optional": true }, { - "name": "currency_amount_sold", - "type": "float", - "description": "The amount of currency sold in a Forward Derivative.", + "name": "market_value", + "type": "Union[int, float]", + "description": "The market value of the equity position in the ETF.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "currency_bought", + "name": "equity_symbol", "type": "str", - "description": "The currency bought in a Forward Derivative.", - "default": null, - "optional": true + "description": "The symbol of the equity requested.", + "default": "", + "optional": false }, { - "name": "currency_amount_bought", - "type": "float", - "description": "The amount of currency bought in a Forward Derivative.", - "default": null, - "optional": true + "name": "etf_symbol", + "type": "str", + "description": "The symbol of the ETF with exposure to the requested equity.", + "default": "", + "optional": false }, { - "name": "notional_amount", + "name": "shares", "type": "float", - "description": "The notional amount of the derivative.", + "description": "The number of shares held in the ETF.", "default": null, "optional": true }, { - "name": "notional_currency", - "type": "str", - "description": "The currency of the derivative's notional amount.", + "name": "weight", + "type": "float", + "description": "The weight of the equity in the ETF, as a normalized percent.", "default": null, "optional": true }, { - "name": "unrealized_gain", - "type": "float", - "description": "The unrealized gain or loss on the derivative.", + "name": "market_value", + "type": "Union[int, float]", + "description": "The market value of the equity position in the ETF.", "default": null, "optional": true } ] }, - "model": "EtfHoldings" + "model": "EtfEquityExposure" }, - "/etf/holdings_date": { + "/fixedincome/rate/ameribor": { "deprecated": { "flag": null, "message": null }, - "description": "Use this function to get the holdings dates, if available.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings_date(symbol='XLK', provider='fmp')\n```\n\n", + "description": "Ameribor.\n\nAmeribor (short for the American interbank offered rate) is a benchmark interest rate that reflects the true cost of\nshort-term interbank borrowing. This rate is based on transactions in overnight unsecured loans conducted on the\nAmerican Financial Exchange (AFX).", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.ameribor(provider='fred')\nobb.fixedincome.rate.ameribor(parameter=30_day_ma, provider='fred')\n```\n\n", "parameters": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for. (ETF)", - "default": "", - "optional": false + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true }, { "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", "optional": true } ], - "fmp": [ + "fred": [ { - "name": "cik", - "type": "str", - "description": "The CIK of the filing entity. Overrides symbol.", - "default": null, + "name": "parameter", + "type": "Literal['overnight', 'term_30', 'term_90', '1_week_term_structure', '1_month_term_structure', '3_month_term_structure', '6_month_term_structure', '1_year_term_structure', '2_year_term_structure', '30_day_ma', '90_day_ma']", + "description": "Period of AMERIBOR rate.", + "default": "overnight", "optional": true } ] @@ -23873,12 +28815,12 @@ "OBBject": [ { "name": "results", - "type": "List[EtfHoldingsDate]", + "type": "List[AMERIBOR]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['fred']]", "description": "Provider name." }, { @@ -23906,48 +28848,85 @@ "description": "The date of the data.", "default": "", "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "AMERIBOR rate.", + "default": "", + "optional": false } ], - "fmp": [] + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "AMERIBOR rate.", + "default": "", + "optional": false + } + ] }, - "model": "EtfHoldingsDate" + "model": "AMERIBOR" }, - "/etf/holdings_performance": { + "/fixedincome/rate/sonia": { "deprecated": { - "flag": true, - "message": "This endpoint is deprecated; pass a list of holdings symbols directly to `/equity/price/performance` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.2." + "flag": null, + "message": null }, - "description": "Get the recent price performance of each ticker held in the ETF.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings_performance(symbol='XLK', provider='fmp')\n```\n\n", + "description": "Sterling Overnight Index Average.\n\nSONIA (Sterling Overnight Index Average) is an important interest rate benchmark. SONIA is based on actual\ntransactions and reflects the average of the interest rates that banks pay to borrow sterling overnight from other\nfinancial institutions and other institutional investors.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.sonia(provider='fred')\nobb.fixedincome.rate.sonia(parameter=total_nominal_value, provider='fred')\n```\n\n", "parameters": { "standard": [ { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", - "default": "", - "optional": false + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true }, { "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", "optional": true } ], - "fmp": [] + "fred": [ + { + "name": "parameter", + "type": "Literal['rate', 'index', '10th_percentile', '25th_percentile', '75th_percentile', '90th_percentile', 'total_nominal_value']", + "description": "Period of SONIA rate.", + "default": "rate", + "optional": true + } + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EtfHoldingsPerformance]", + "type": "List[SONIA]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['fred']]", "description": "Provider name." }, { @@ -23970,165 +28949,97 @@ "data": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": null, - "optional": true - }, - { - "name": "one_day", - "type": "float", - "description": "One-day return.", - "default": null, - "optional": true - }, - { - "name": "wtd", - "type": "float", - "description": "Week to date return.", - "default": null, - "optional": true - }, - { - "name": "one_week", - "type": "float", - "description": "One-week return.", - "default": null, - "optional": true - }, - { - "name": "mtd", - "type": "float", - "description": "Month to date return.", - "default": null, - "optional": true - }, - { - "name": "one_month", - "type": "float", - "description": "One-month return.", - "default": null, - "optional": true - }, - { - "name": "qtd", - "type": "float", - "description": "Quarter to date return.", - "default": null, - "optional": true - }, - { - "name": "three_month", - "type": "float", - "description": "Three-month return.", - "default": null, - "optional": true - }, - { - "name": "six_month", - "type": "float", - "description": "Six-month return.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "ytd", + "name": "rate", "type": "float", - "description": "Year to date return.", - "default": null, - "optional": true - }, + "description": "SONIA rate.", + "default": "", + "optional": false + } + ], + "fred": [ { - "name": "one_year", - "type": "float", - "description": "One-year return.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "two_year", + "name": "rate", "type": "float", - "description": "Two-year return.", - "default": null, - "optional": true - }, + "description": "SONIA rate.", + "default": "", + "optional": false + } + ] + }, + "model": "SONIA" + }, + "/fixedincome/rate/iorb": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Interest on Reserve Balances.\n\nGet Interest Rate on Reserve Balances data A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.iorb(provider='fred')\n```\n\n", + "parameters": { + "standard": [ { - "name": "three_year", - "type": "float", - "description": "Three-year return.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "four_year", - "type": "float", - "description": "Four-year", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "five_year", - "type": "float", - "description": "Five-year return.", - "default": null, + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", "optional": true - }, + } + ], + "fred": [ { - "name": "ten_year", - "type": "float", - "description": "Ten-year return.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "max", - "type": "float", - "description": "Return from the beginning of the time series.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true } - ], - "fmp": [] - }, - "model": "EtfHoldingsPerformance" - }, - "/etf/equity_exposure": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the exposure to ETFs for a specific stock.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.equity_exposure(symbol='MSFT', provider='fmp')\n# This function accepts multiple tickers.\nobb.etf.equity_exposure(symbol='MSFT,AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp.", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", - "optional": true - } - ], - "fmp": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EtfEquityExposure]", + "type": "List[IORB]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['fred']]", "description": "Provider name." }, { @@ -24151,52 +29062,46 @@ "data": { "standard": [ { - "name": "equity_symbol", - "type": "str", - "description": "The symbol of the equity requested.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "etf_symbol", - "type": "str", - "description": "The symbol of the ETF with exposure to the requested equity.", + "name": "rate", + "type": "float", + "description": "IORB rate.", "default": "", "optional": false - }, + } + ], + "fred": [ { - "name": "shares", - "type": "float", - "description": "The number of shares held in the ETF.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "weight", + "name": "rate", "type": "float", - "description": "The weight of the equity in the ETF, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "market_value", - "type": "Union[int, float]", - "description": "The market value of the equity position in the ETF.", - "default": null, - "optional": true + "description": "IORB rate.", + "default": "", + "optional": false } - ], - "fmp": [] + ] }, - "model": "EtfEquityExposure" + "model": "IORB" }, - "/fixedincome/rate/ameribor": { + "/fixedincome/rate/effr": { "deprecated": { "flag": null, "message": null }, - "description": "Ameribor.\n\nAmeribor (short for the American interbank offered rate) is a benchmark interest rate that reflects the true cost of\nshort-term interbank borrowing. This rate is based on transactions in overnight unsecured loans conducted on the\nAmerican Financial Exchange (AFX).", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.ameribor(provider='fred')\nobb.fixedincome.rate.ameribor(parameter=30_day_ma, provider='fred')\n```\n\n", + "description": "Fed Funds Rate.\n\nGet Effective Federal Funds Rate data. A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.effr(provider='fred')\nobb.fixedincome.rate.effr(parameter=daily, provider='fred')\n```\n\n", "parameters": { "standard": [ { @@ -24215,18 +29120,34 @@ }, { "name": "provider", - "type": "Literal['fred']", - "description": "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.", - "default": "fred", + "type": "Literal['federal_reserve', 'fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default.", + "default": "federal_reserve", + "optional": true + } + ], + "federal_reserve": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, "optional": true } ], "fred": [ { "name": "parameter", - "type": "Literal['overnight', 'term_30', 'term_90', '1_week_term_structure', '1_month_term_structure', '3_month_term_structure', '6_month_term_structure', '1_year_term_structure', '2_year_term_structure', '30_day_ma', '90_day_ma']", - "description": "Period of AMERIBOR rate.", - "default": "overnight", + "type": "Literal['monthly', 'daily', 'weekly', 'daily_excl_weekend', 'annual', 'biweekly', 'volume']", + "description": "Period of FED rate.", + "default": "weekly", "optional": true } ] @@ -24235,12 +29156,12 @@ "OBBject": [ { "name": "results", - "type": "List[AMERIBOR]", + "type": "List[FEDFUNDS]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fred']]", + "type": "Optional[Literal['federal_reserve', 'fred']]", "description": "Provider name." }, { @@ -24272,38 +29193,55 @@ { "name": "rate", "type": "float", - "description": "AMERIBOR rate.", + "description": "FED rate.", + "default": "", + "optional": false + } + ], + "federal_reserve": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "FED rate.", "default": "", "optional": false } ], - "fred": [] + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "FED rate.", + "default": "", + "optional": false + } + ] }, - "model": "AMERIBOR" + "model": "FEDFUNDS" }, - "/fixedincome/rate/sonia": { + "/fixedincome/rate/effr_forecast": { "deprecated": { "flag": null, "message": null }, - "description": "Sterling Overnight Index Average.\n\nSONIA (Sterling Overnight Index Average) is an important interest rate benchmark. SONIA is based on actual\ntransactions and reflects the average of the interest rates that banks pay to borrow sterling overnight from other\nfinancial institutions and other institutional investors.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.sonia(provider='fred')\nobb.fixedincome.rate.sonia(parameter=total_nominal_value, provider='fred')\n```\n\n", + "description": "Fed Funds Rate Projections.\n\nThe projections for the federal funds rate are the value of the midpoint of the\nprojected appropriate target range for the federal funds rate or the projected\nappropriate target level for the federal funds rate at the end of the specified\ncalendar year or over the longer run.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.effr_forecast(provider='fred')\nobb.fixedincome.rate.effr_forecast(long_run=True, provider='fred')\n```\n\n", "parameters": { "standard": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, { "name": "provider", "type": "Literal['fred']", @@ -24314,10 +29252,10 @@ ], "fred": [ { - "name": "parameter", - "type": "Literal['rate', 'index', '10th_percentile', '25th_percentile', '75th_percentile', '90th_percentile', 'total_nominal_value']", - "description": "Period of SONIA rate.", - "default": "rate", + "name": "long_run", + "type": "bool", + "description": "Flag to show long run projections", + "default": false, "optional": true } ] @@ -24326,7 +29264,7 @@ "OBBject": [ { "name": "results", - "type": "List[SONIA]", + "type": "List[PROJECTIONS]", "description": "Serializable results." }, { @@ -24361,24 +29299,123 @@ "optional": false }, { - "name": "rate", + "name": "range_high", "type": "float", - "description": "SONIA rate.", + "description": "High projection of rates.", + "default": "", + "optional": false + }, + { + "name": "central_tendency_high", + "type": "float", + "description": "Central tendency of high projection of rates.", + "default": "", + "optional": false + }, + { + "name": "median", + "type": "float", + "description": "Median projection of rates.", + "default": "", + "optional": false + }, + { + "name": "range_midpoint", + "type": "float", + "description": "Midpoint projection of rates.", + "default": "", + "optional": false + }, + { + "name": "central_tendency_midpoint", + "type": "float", + "description": "Central tendency of midpoint projection of rates.", + "default": "", + "optional": false + }, + { + "name": "range_low", + "type": "float", + "description": "Low projection of rates.", + "default": "", + "optional": false + }, + { + "name": "central_tendency_low", + "type": "float", + "description": "Central tendency of low projection of rates.", "default": "", "optional": false } ], - "fred": [] + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "range_high", + "type": "float", + "description": "High projection of rates.", + "default": "", + "optional": false + }, + { + "name": "central_tendency_high", + "type": "float", + "description": "Central tendency of high projection of rates.", + "default": "", + "optional": false + }, + { + "name": "median", + "type": "float", + "description": "Median projection of rates.", + "default": "", + "optional": false + }, + { + "name": "range_midpoint", + "type": "float", + "description": "Midpoint projection of rates.", + "default": "", + "optional": false + }, + { + "name": "central_tendency_midpoint", + "type": "float", + "description": "Central tendency of midpoint projection of rates.", + "default": "", + "optional": false + }, + { + "name": "range_low", + "type": "float", + "description": "Low projection of rates.", + "default": "", + "optional": false + }, + { + "name": "central_tendency_low", + "type": "float", + "description": "Central tendency of low projection of rates.", + "default": "", + "optional": false + } + ] }, - "model": "SONIA" + "model": "PROJECTIONS" }, - "/fixedincome/rate/iorb": { + "/fixedincome/rate/estr": { "deprecated": { "flag": null, "message": null }, - "description": "Interest on Reserve Balances.\n\nGet Interest Rate on Reserve Balances data A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.iorb(provider='fred')\n```\n\n", + "description": "Euro Short-Term Rate.\n\nThe euro short-term rate (\u20acSTR) reflects the wholesale euro unsecured overnight borrowing costs of banks located in\nthe euro area. The \u20acSTR is published on each TARGET2 business day based on transactions conducted and settled on\nthe previous TARGET2 business day (the reporting date \u201cT\u201d) with a maturity date of T+1 which are deemed to have been\nexecuted at arm\u2019s length and thus reflect market rates in an unbiased way.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.estr(provider='fred')\nobb.fixedincome.rate.estr(parameter=number_of_active_banks, provider='fred')\n```\n\n", "parameters": { "standard": [ { @@ -24403,13 +29440,21 @@ "optional": true } ], - "fred": [] + "fred": [ + { + "name": "parameter", + "type": "Literal['volume_weighted_trimmed_mean_rate', 'number_of_transactions', 'number_of_active_banks', 'total_volume', 'share_of_volume_of_the_5_largest_active_banks', 'rate_at_75th_percentile_of_volume', 'rate_at_25th_percentile_of_volume']", + "description": "Period of ESTR rate.", + "default": "volume_weighted_trimmed_mean_rate", + "optional": true + } + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[IORB]", + "type": "List[ESTR]", "description": "Serializable results." }, { @@ -24446,22 +29491,37 @@ { "name": "rate", "type": "float", - "description": "IORB rate.", + "description": "ESTR rate.", "default": "", "optional": false } ], - "fred": [] + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "ESTR rate.", + "default": "", + "optional": false + } + ] }, - "model": "IORB" + "model": "ESTR" }, - "/fixedincome/rate/effr": { + "/fixedincome/rate/ecb": { "deprecated": { "flag": null, "message": null }, - "description": "Fed Funds Rate.\n\nGet Effective Federal Funds Rate data. A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.effr(provider='fred')\nobb.fixedincome.rate.effr(parameter=daily, provider='fred')\n```\n\n", + "description": "European Central Bank Interest Rates.\n\nThe Governing Council of the ECB sets the key interest rates for the euro area:\n\n- The interest rate on the main refinancing operations (MRO), which provide\nthe bulk of liquidity to the banking system.\n- The rate on the deposit facility, which banks may use to make overnight deposits with the Eurosystem.\n- The rate on the marginal lending facility, which offers overnight credit to banks from the Eurosystem.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.ecb(provider='fred')\nobb.fixedincome.rate.ecb(interest_rate_type='refinancing', provider='fred')\n```\n\n", "parameters": { "standard": [ { @@ -24478,21 +29538,41 @@ "default": null, "optional": true }, + { + "name": "interest_rate_type", + "type": "Literal['deposit', 'lending', 'refinancing']", + "description": "The type of interest rate.", + "default": "lending", + "optional": true + }, { "name": "provider", - "type": "Literal['federal_reserve', 'fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default.", - "default": "federal_reserve", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", "optional": true } ], - "federal_reserve": [], "fred": [ { - "name": "parameter", - "type": "Literal['monthly', 'daily', 'weekly', 'daily_excl_weekend', 'annual', 'biweekly', 'volume']", - "description": "Period of FED rate.", - "default": "weekly", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "interest_rate_type", + "type": "Literal['deposit', 'lending', 'refinancing']", + "description": "The type of interest rate.", + "default": "lending", "optional": true } ] @@ -24501,12 +29581,12 @@ "OBBject": [ { "name": "results", - "type": "List[FEDFUNDS]", + "type": "List[EuropeanCentralBankInterestRates]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['federal_reserve', 'fred']]", + "type": "Optional[Literal['fred']]", "description": "Provider name." }, { @@ -24538,25 +29618,53 @@ { "name": "rate", "type": "float", - "description": "FED rate.", + "description": "European Central Bank Interest Rate.", "default": "", "optional": false } ], - "federal_reserve": [], - "fred": [] + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "European Central Bank Interest Rate.", + "default": "", + "optional": false + } + ] }, - "model": "FEDFUNDS" + "model": "EuropeanCentralBankInterestRates" }, - "/fixedincome/rate/effr_forecast": { + "/fixedincome/rate/dpcredit": { "deprecated": { "flag": null, "message": null }, - "description": "Fed Funds Rate Projections.\n\nThe projections for the federal funds rate are the value of the midpoint of the\nprojected appropriate target range for the federal funds rate or the projected\nappropriate target level for the federal funds rate at the end of the specified\ncalendar year or over the longer run.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.effr_forecast(provider='fred')\nobb.fixedincome.rate.effr_forecast(long_run=True, provider='fred')\n```\n\n", + "description": "Discount Window Primary Credit Rate.\n\nA bank rate is the interest rate a nation's central bank charges to its domestic banks to borrow money.\nThe rates central banks charge are set to stabilize the economy.\nIn the United States, the Federal Reserve System's Board of Governors set the bank rate,\nalso known as the discount rate.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.dpcredit(provider='fred')\nobb.fixedincome.rate.dpcredit(start_date='2023-02-01', end_date='2023-05-01', provider='fred')\n```\n\n", "parameters": { "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, { "name": "provider", "type": "Literal['fred']", @@ -24567,10 +29675,10 @@ ], "fred": [ { - "name": "long_run", - "type": "bool", - "description": "Flag to show long run projections", - "default": false, + "name": "parameter", + "type": "Literal['daily_excl_weekend', 'monthly', 'weekly', 'daily', 'annual']", + "description": "FRED series ID of DWPCR data.", + "default": "daily_excl_weekend", "optional": true } ] @@ -24579,7 +29687,7 @@ "OBBject": [ { "name": "results", - "type": "List[PROJECTIONS]", + "type": "List[DiscountWindowPrimaryCreditRate]", "description": "Serializable results." }, { @@ -24614,66 +29722,39 @@ "optional": false }, { - "name": "range_high", - "type": "float", - "description": "High projection of rates.", - "default": "", - "optional": false - }, - { - "name": "central_tendency_high", - "type": "float", - "description": "Central tendency of high projection of rates.", - "default": "", - "optional": false - }, - { - "name": "median", - "type": "float", - "description": "Median projection of rates.", - "default": "", - "optional": false - }, - { - "name": "range_midpoint", - "type": "float", - "description": "Midpoint projection of rates.", - "default": "", - "optional": false - }, - { - "name": "central_tendency_midpoint", + "name": "rate", "type": "float", - "description": "Central tendency of midpoint projection of rates.", + "description": "Discount Window Primary Credit Rate.", "default": "", "optional": false - }, + } + ], + "fred": [ { - "name": "range_low", - "type": "float", - "description": "Low projection of rates.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "central_tendency_low", + "name": "rate", "type": "float", - "description": "Central tendency of low projection of rates.", + "description": "Discount Window Primary Credit Rate.", "default": "", "optional": false } - ], - "fred": [] + ] }, - "model": "PROJECTIONS" + "model": "DiscountWindowPrimaryCreditRate" }, - "/fixedincome/rate/estr": { + "/fixedincome/spreads/tcm": { "deprecated": { "flag": null, "message": null }, - "description": "Euro Short-Term Rate.\n\nThe euro short-term rate (\u20acSTR) reflects the wholesale euro unsecured overnight borrowing costs of banks located in\nthe euro area. The \u20acSTR is published on each TARGET2 business day based on transactions conducted and settled on\nthe previous TARGET2 business day (the reporting date \u201cT\u201d) with a maturity date of T+1 which are deemed to have been\nexecuted at arm\u2019s length and thus reflect market rates in an unbiased way.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.estr(provider='fred')\nobb.fixedincome.rate.estr(parameter=number_of_active_banks, provider='fred')\n```\n\n", + "description": "Treasury Constant Maturity.\n\nGet data for 10-Year Treasury Constant Maturity Minus Selected Treasury Constant Maturity.\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S.\nTreasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.tcm(provider='fred')\nobb.fixedincome.spreads.tcm(maturity='2y', provider='fred')\n```\n\n", "parameters": { "standard": [ { @@ -24690,6 +29771,13 @@ "default": null, "optional": true }, + { + "name": "maturity", + "type": "Literal['3m', '2y']", + "description": "The maturity", + "default": "3m", + "optional": true + }, { "name": "provider", "type": "Literal['fred']", @@ -24700,10 +29788,24 @@ ], "fred": [ { - "name": "parameter", - "type": "Literal['volume_weighted_trimmed_mean_rate', 'number_of_transactions', 'number_of_active_banks', 'total_volume', 'share_of_volume_of_the_5_largest_active_banks', 'rate_at_75th_percentile_of_volume', 'rate_at_25th_percentile_of_volume']", - "description": "Period of ESTR rate.", - "default": "volume_weighted_trimmed_mean_rate", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "maturity", + "type": "Literal['3m', '2y']", + "description": "The maturity", + "default": "3m", "optional": true } ] @@ -24712,7 +29814,7 @@ "OBBject": [ { "name": "results", - "type": "List[ESTR]", + "type": "List[TreasuryConstantMaturity]", "description": "Serializable results." }, { @@ -24749,22 +29851,37 @@ { "name": "rate", "type": "float", - "description": "ESTR rate.", + "description": "TreasuryConstantMaturity Rate.", "default": "", "optional": false } ], - "fred": [] + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "TreasuryConstantMaturity Rate.", + "default": "", + "optional": false + } + ] }, - "model": "ESTR" + "model": "TreasuryConstantMaturity" }, - "/fixedincome/rate/ecb": { + "/fixedincome/spreads/tcm_effr": { "deprecated": { "flag": null, "message": null }, - "description": "European Central Bank Interest Rates.\n\nThe Governing Council of the ECB sets the key interest rates for the euro area:\n\n- The interest rate on the main refinancing operations (MRO), which provide\nthe bulk of liquidity to the banking system.\n- The rate on the deposit facility, which banks may use to make overnight deposits with the Eurosystem.\n- The rate on the marginal lending facility, which offers overnight credit to banks from the Eurosystem.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.ecb(provider='fred')\nobb.fixedincome.rate.ecb(interest_rate_type='refinancing', provider='fred')\n```\n\n", + "description": "Select Treasury Constant Maturity.\n\nGet data for Selected Treasury Constant Maturity Minus Federal Funds Rate\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S.\nTreasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.tcm_effr(provider='fred')\nobb.fixedincome.spreads.tcm_effr(maturity='10y', provider='fred')\n```\n\n", "parameters": { "standard": [ { @@ -24782,10 +29899,10 @@ "optional": true }, { - "name": "interest_rate_type", - "type": "Literal['deposit', 'lending', 'refinancing']", - "description": "The type of interest rate.", - "default": "lending", + "name": "maturity", + "type": "Literal['10y', '5y', '1y', '6m', '3m']", + "description": "The maturity", + "default": "10y", "optional": true }, { @@ -24796,13 +29913,35 @@ "optional": true } ], - "fred": [] + "fred": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "maturity", + "type": "Literal['10y', '5y', '1y', '6m', '3m']", + "description": "The maturity", + "default": "10y", + "optional": true + } + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EuropeanCentralBankInterestRates]", + "type": "List[SelectedTreasuryConstantMaturity]", "description": "Serializable results." }, { @@ -24839,22 +29978,37 @@ { "name": "rate", "type": "float", - "description": "European Central Bank Interest Rate.", + "description": "Selected Treasury Constant Maturity Rate.", "default": "", "optional": false } ], - "fred": [] + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "Selected Treasury Constant Maturity Rate.", + "default": "", + "optional": false + } + ] }, - "model": "EuropeanCentralBankInterestRates" + "model": "SelectedTreasuryConstantMaturity" }, - "/fixedincome/rate/dpcredit": { + "/fixedincome/spreads/treasury_effr": { "deprecated": { "flag": null, "message": null }, - "description": "Discount Window Primary Credit Rate.\n\nA bank rate is the interest rate a nation's central bank charges to its domestic banks to borrow money.\nThe rates central banks charge are set to stabilize the economy.\nIn the United States, the Federal Reserve System's Board of Governors set the bank rate,\nalso known as the discount rate.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.dpcredit(provider='fred')\nobb.fixedincome.rate.dpcredit(start_date='2023-02-01', end_date='2023-05-01', provider='fred')\n```\n\n", + "description": "Select Treasury Bill.\n\nGet Selected Treasury Bill Minus Federal Funds Rate.\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of\nauctioned U.S. Treasuries.\nThe value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.treasury_effr(provider='fred')\nobb.fixedincome.spreads.treasury_effr(maturity='6m', provider='fred')\n```\n\n", "parameters": { "standard": [ { @@ -24872,19 +30026,40 @@ "optional": true }, { - "name": "provider", - "type": "Literal['fred']", - "description": "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.", - "default": "fred", - "optional": true - } - ], - "fred": [ - { - "name": "parameter", - "type": "Literal['daily_excl_weekend', 'monthly', 'weekly', 'daily', 'annual']", - "description": "FRED series ID of DWPCR data.", - "default": "daily_excl_weekend", + "name": "maturity", + "type": "Literal['3m', '6m']", + "description": "The maturity", + "default": "3m", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "maturity", + "type": "Literal['3m', '6m']", + "description": "The maturity", + "default": "3m", "optional": true } ] @@ -24893,7 +30068,7 @@ "OBBject": [ { "name": "results", - "type": "List[DiscountWindowPrimaryCreditRate]", + "type": "List[SelectedTreasuryBill]", "description": "Serializable results." }, { @@ -24930,43 +30105,51 @@ { "name": "rate", "type": "float", - "description": "Discount Window Primary Credit Rate.", + "description": "SelectedTreasuryBill Rate.", "default": "", "optional": false } ], - "fred": [] + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "SelectedTreasuryBill Rate.", + "default": "", + "optional": false + } + ] }, - "model": "DiscountWindowPrimaryCreditRate" + "model": "SelectedTreasuryBill" }, - "/fixedincome/spreads/tcm": { + "/fixedincome/government/us_yield_curve": { "deprecated": { "flag": null, "message": null }, - "description": "Treasury Constant Maturity.\n\nGet data for 10-Year Treasury Constant Maturity Minus Selected Treasury Constant Maturity.\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S.\nTreasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.tcm(provider='fred')\nobb.fixedincome.spreads.tcm(maturity='2y', provider='fred')\n```\n\n", + "description": "US Yield Curve. Get United States yield curve.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.us_yield_curve(provider='fred')\nobb.fixedincome.government.us_yield_curve(inflation_adjusted=True, provider='fred')\n```\n\n", "parameters": { "standard": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", + "name": "date", "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "description": "A specific date to get data for. Defaults to the most recent FRED entry.", "default": null, "optional": true }, { - "name": "maturity", - "type": "Literal['3m', '2y']", - "description": "The maturity", - "default": "3m", + "name": "inflation_adjusted", + "type": "bool", + "description": "Get inflation adjusted rates.", + "default": false, "optional": true }, { @@ -24977,13 +30160,28 @@ "optional": true } ], - "fred": [] + "fred": [ + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for. Defaults to the most recent FRED entry.", + "default": null, + "optional": true + }, + { + "name": "inflation_adjusted", + "type": "bool", + "description": "Get inflation adjusted rates.", + "default": false, + "optional": true + } + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[TreasuryConstantMaturity]", + "type": "List[USYieldCurve]", "description": "Serializable results." }, { @@ -25011,31 +30209,46 @@ "data": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "maturity", + "type": "float", + "description": "Maturity of the treasury rate in years.", "default": "", "optional": false }, { "name": "rate", "type": "float", - "description": "TreasuryConstantMaturity Rate.", + "description": "Associated rate given in decimal form (0.05 is 5%)", "default": "", "optional": false } ], - "fred": [] + "fred": [ + { + "name": "maturity", + "type": "float", + "description": "Maturity of the treasury rate in years.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "Associated rate given in decimal form (0.05 is 5%)", + "default": "", + "optional": false + } + ] }, - "model": "TreasuryConstantMaturity" + "model": "USYieldCurve" }, - "/fixedincome/spreads/tcm_effr": { + "/fixedincome/government/treasury_rates": { "deprecated": { "flag": null, "message": null }, - "description": "Select Treasury Constant Maturity.\n\nGet data for Selected Treasury Constant Maturity Minus Federal Funds Rate\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S.\nTreasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.tcm_effr(provider='fred')\nobb.fixedincome.spreads.tcm_effr(maturity='10y', provider='fred')\n```\n\n", + "description": "Government Treasury Rates.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.treasury_rates(provider='fmp')\n```\n\n", "parameters": { "standard": [ { @@ -25053,32 +30266,56 @@ "optional": true }, { - "name": "maturity", - "type": "Literal['10y', '5y', '1y', '6m', '3m']", - "description": "The maturity", - "default": "10y", + "name": "provider", + "type": "Literal['federal_reserve', 'fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default.", + "default": "federal_reserve", + "optional": true + } + ], + "federal_reserve": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fred']", - "description": "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.", - "default": "fred", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, "optional": true } ], - "fred": [] + "fmp": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + } + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[SelectedTreasuryConstantMaturity]", + "type": "List[TreasuryRates]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fred']]", + "type": "Optional[Literal['federal_reserve', 'fmp']]", "description": "Provider name." }, { @@ -25108,88 +30345,98 @@ "optional": false }, { - "name": "rate", + "name": "week_4", "type": "float", - "description": "Selected Treasury Constant Maturity Rate.", - "default": "", - "optional": false - } - ], - "fred": [] - }, - "model": "SelectedTreasuryConstantMaturity" - }, - "/fixedincome/spreads/treasury_effr": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Select Treasury Bill.\n\nGet Selected Treasury Bill Minus Federal Funds Rate.\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of\nauctioned U.S. Treasuries.\nThe value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.treasury_effr(provider='fred')\nobb.fixedincome.spreads.treasury_effr(maturity='6m', provider='fred')\n```\n\n", - "parameters": { - "standard": [ + "description": "4 week Treasury bills rate (secondary market).", + "default": null, + "optional": true + }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "month_1", + "type": "float", + "description": "1 month Treasury rate.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "month_2", + "type": "float", + "description": "2 month Treasury rate.", "default": null, "optional": true }, { - "name": "maturity", - "type": "Literal['3m', '6m']", - "description": "The maturity", - "default": "3m", + "name": "month_3", + "type": "float", + "description": "3 month Treasury rate.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fred']", - "description": "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.", - "default": "fred", + "name": "month_6", + "type": "float", + "description": "6 month Treasury rate.", + "default": null, "optional": true - } - ], - "fred": [] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[SelectedTreasuryBill]", - "description": "Serializable results." + "name": "year_1", + "type": "float", + "description": "1 year Treasury rate.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." + "name": "year_2", + "type": "float", + "description": "2 year Treasury rate.", + "default": null, + "optional": true + }, + { + "name": "year_3", + "type": "float", + "description": "3 year Treasury rate.", + "default": null, + "optional": true + }, + { + "name": "year_5", + "type": "float", + "description": "5 year Treasury rate.", + "default": null, + "optional": true + }, + { + "name": "year_7", + "type": "float", + "description": "7 year Treasury rate.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "year_10", + "type": "float", + "description": "10 year Treasury rate.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "year_20", + "type": "float", + "description": "20 year Treasury rate.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "year_30", + "type": "float", + "description": "30 year Treasury rate.", + "default": null, + "optional": true } - ] - }, - "data": { - "standard": [ + ], + "federal_reserve": [ { "name": "date", "type": "date", @@ -25198,165 +30445,98 @@ "optional": false }, { - "name": "rate", + "name": "week_4", "type": "float", - "description": "SelectedTreasuryBill Rate.", - "default": "", - "optional": false - } - ], - "fred": [] - }, - "model": "SelectedTreasuryBill" - }, - "/fixedincome/government/us_yield_curve": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "US Yield Curve. Get United States yield curve.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.us_yield_curve(provider='fred')\nobb.fixedincome.government.us_yield_curve(inflation_adjusted=True, provider='fred')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for. Defaults to the most recent FRED entry.", + "description": "4 week Treasury bills rate (secondary market).", "default": null, "optional": true }, { - "name": "inflation_adjusted", - "type": "bool", - "description": "Get inflation adjusted rates.", - "default": false, + "name": "month_1", + "type": "float", + "description": "1 month Treasury rate.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fred']", - "description": "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.", - "default": "fred", + "name": "month_2", + "type": "float", + "description": "2 month Treasury rate.", + "default": null, "optional": true - } - ], - "fred": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[USYieldCurve]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "month_3", + "type": "float", + "description": "3 month Treasury rate.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "month_6", + "type": "float", + "description": "6 month Treasury rate.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "maturity", + "name": "year_1", "type": "float", - "description": "Maturity of the treasury rate in years.", - "default": "", - "optional": false + "description": "1 year Treasury rate.", + "default": null, + "optional": true }, { - "name": "rate", + "name": "year_2", "type": "float", - "description": "Associated rate given in decimal form (0.05 is 5%)", - "default": "", - "optional": false - } - ], - "fred": [] - }, - "model": "USYieldCurve" - }, - "/fixedincome/government/treasury_rates": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Government Treasury Rates.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.treasury_rates(provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "description": "2 year Treasury rate.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "year_3", + "type": "float", + "description": "3 year Treasury rate.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['federal_reserve', 'fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default.", - "default": "federal_reserve", + "name": "year_5", + "type": "float", + "description": "5 year Treasury rate.", + "default": null, "optional": true - } - ], - "federal_reserve": [], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[TreasuryRates]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['federal_reserve', 'fmp']]", - "description": "Provider name." + "name": "year_7", + "type": "float", + "description": "7 year Treasury rate.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "year_10", + "type": "float", + "description": "10 year Treasury rate.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "year_20", + "type": "float", + "description": "20 year Treasury rate.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "year_30", + "type": "float", + "description": "30 year Treasury rate.", + "default": null, + "optional": true } - ] - }, - "data": { - "standard": [ + ], + "fmp": [ { "name": "date", "type": "date", @@ -25455,9 +30635,7 @@ "default": null, "optional": true } - ], - "federal_reserve": [], - "fmp": [] + ] }, "model": "TreasuryRates" }, @@ -25576,7 +30754,22 @@ "optional": false } ], - "fred": [] + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "ICE BofA US Corporate Bond Indices Rate.", + "default": "", + "optional": false + } + ] }, "model": "ICEBofA" }, @@ -25674,7 +30867,22 @@ "optional": false } ], - "fred": [] + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "Moody Corporate Bond Index Rate.", + "default": "", + "optional": false + } + ] }, "model": "MoodyCorporateBondIndex" }, @@ -25700,16 +30908,31 @@ "description": "The yield curve type.", "default": "spot", "optional": true - }, - { - "name": "provider", - "type": "Literal['fred']", - "description": "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.", - "default": "fred", - "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [ + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": null, + "optional": true + }, + { + "name": "yield_curve", + "type": "Literal['spot', 'par']", + "description": "The yield curve type.", + "default": "spot", + "optional": true } - ], - "fred": [] + ] }, "returns": { "OBBject": [ @@ -25808,15 +31031,15 @@ }, { "name": "maturity", - "type": "Union[Union[float, str], List[Union[float, str]]]", - "description": "Maturities in years. Multiple items allowed for provider(s): fred.", + "type": "Union[float, str]", + "description": "Maturities in years.", "default": 10.0, "optional": true }, { "name": "category", - "type": "Union[str, List[str]]", - "description": "Rate category. Options: spot_rate, par_yield. Multiple items allowed for provider(s): fred.", + "type": "str", + "description": "Rate category. Options: spot_rate, par_yield.", "default": "spot_rate", "optional": true }, @@ -25828,7 +31051,36 @@ "optional": true } ], - "fred": [] + "fred": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "maturity", + "type": "Union[float, str]", + "description": "Maturities in years.", + "default": 10.0, + "optional": true + }, + { + "name": "category", + "type": "str", + "description": "Rate category. Options: spot_rate, par_yield.", + "default": "spot_rate", + "optional": true + } + ] }, "returns": { "OBBject": [ @@ -25876,7 +31128,22 @@ "optional": false } ], - "fred": [] + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "Spot Rate.", + "default": "", + "optional": false + } + ] }, "model": "SpotRate" }, @@ -25932,7 +31199,43 @@ "optional": true } ], - "fred": [] + "fred": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "maturity", + "type": "Literal['overnight', '7d', '15d', '30d', '60d', '90d']", + "description": "The maturity.", + "default": "30d", + "optional": true + }, + { + "name": "category", + "type": "Literal['asset_backed', 'financial', 'nonfinancial']", + "description": "The category.", + "default": "financial", + "optional": true + }, + { + "name": "grade", + "type": "Literal['aa', 'a2_p2']", + "description": "The grade.", + "default": "aa", + "optional": true + } + ] }, "returns": { "OBBject": [ @@ -25980,7 +31283,22 @@ "optional": false } ], - "fred": [] + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "Commercial Paper Rate.", + "default": "", + "optional": false + } + ] }, "model": "CommercialPaper" }, @@ -26071,7 +31389,22 @@ "optional": false } ], - "fred": [] + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "SOFR rate.", + "default": "", + "optional": false + } + ] }, "model": "SOFR" }, @@ -26086,8 +31419,8 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, polygon, yfinance.", + "type": "str", + "description": "Symbol to get data for.", "default": "", "optional": false }, @@ -26120,7 +31453,15 @@ "optional": true } ], - "fmp": [], + "fmp": [ + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ], "intrinio": [ { "name": "limit", @@ -26131,6 +31472,13 @@ } ], "polygon": [ + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", + "default": "1d", + "optional": true + }, { "name": "sort", "type": "Literal['asc', 'desc']", @@ -26146,7 +31494,15 @@ "optional": true } ], - "yfinance": [] + "yfinance": [ + { + "name": "interval", + "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ] }, "returns": { "OBBject": [ @@ -26245,7 +31601,50 @@ "optional": true } ], - "intrinio": [], + "intrinio": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "open", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The open price.", + "default": null, + "optional": true + }, + { + "name": "high", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The high price.", + "default": null, + "optional": true + }, + { + "name": "low", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The low price.", + "default": null, + "optional": true + }, + { + "name": "close", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The close price.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": null, + "optional": true + } + ], "polygon": [ { "name": "transactions", @@ -26255,7 +31654,50 @@ "optional": true } ], - "yfinance": [] + "yfinance": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "open", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The open price.", + "default": null, + "optional": true + }, + { + "name": "high", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The high price.", + "default": null, + "optional": true + }, + { + "name": "low", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The low price.", + "default": null, + "optional": true + }, + { + "name": "close", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The close price.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": null, + "optional": true + } + ] }, "model": "IndexHistorical" }, @@ -26270,8 +31712,8 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, polygon, yfinance.", + "type": "str", + "description": "Symbol to get data for.", "default": "", "optional": false }, @@ -26304,7 +31746,15 @@ "optional": true } ], - "fmp": [], + "fmp": [ + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ], "intrinio": [ { "name": "limit", @@ -26315,6 +31765,13 @@ } ], "polygon": [ + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", + "default": "1d", + "optional": true + }, { "name": "sort", "type": "Literal['asc', 'desc']", @@ -26330,7 +31787,15 @@ "optional": true } ], - "yfinance": [] + "yfinance": [ + { + "name": "interval", + "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ] }, "returns": { "OBBject": [ @@ -26429,7 +31894,50 @@ "optional": true } ], - "intrinio": [], + "intrinio": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "open", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The open price.", + "default": null, + "optional": true + }, + { + "name": "high", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The high price.", + "default": null, + "optional": true + }, + { + "name": "low", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The low price.", + "default": null, + "optional": true + }, + { + "name": "close", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The close price.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": null, + "optional": true + } + ], "polygon": [ { "name": "transactions", @@ -26439,7 +31947,50 @@ "optional": true } ], - "yfinance": [] + "yfinance": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "open", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The open price.", + "default": null, + "optional": true + }, + { + "name": "high", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The high price.", + "default": null, + "optional": true + }, + { + "name": "low", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The low price.", + "default": null, + "optional": true + }, + { + "name": "close", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The close price.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": null, + "optional": true + } + ] }, "model": "MarketIndices" }, @@ -26467,7 +32018,15 @@ "optional": true } ], - "fmp": [] + "fmp": [ + { + "name": "symbol", + "type": "Literal['dowjones', 'sp500', 'nasdaq']", + "description": "None", + "default": "dowjones", + "optional": true + } + ] }, "returns": { "OBBject": [ @@ -26787,8 +32346,94 @@ "optional": true } ], - "fmp": [], - "intrinio": [], + "fmp": [ + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return. The number of articles to return.", + "default": 2500, + "optional": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "source", + "type": "Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases']", + "description": "The source of the news article.", + "default": null, + "optional": true + }, + { + "name": "sentiment", + "type": "Literal['positive', 'neutral', 'negative']", + "description": "Return news only from this source.", + "default": null, + "optional": true + }, + { + "name": "language", + "type": "str", + "description": "Filter by language. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "topic", + "type": "str", + "description": "Filter by topic. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "word_count_greater_than", + "type": "int", + "description": "News stories will have a word count greater than this value. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "word_count_less_than", + "type": "int", + "description": "News stories will have a word count less than this value. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "is_spam", + "type": "bool", + "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "business_relevance_greater_than", + "type": "float", + "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "business_relevance_less_than", + "type": "float", + "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source.", + "default": null, + "optional": true + } + ], "tiingo": [ { "name": "offset", @@ -26889,51 +32534,121 @@ "optional": true }, { - "name": "teaser", - "type": "str", - "description": "Teaser of the news.", + "name": "teaser", + "type": "str", + "description": "Teaser of the news.", + "default": null, + "optional": true + }, + { + "name": "channels", + "type": "str", + "description": "Channels associated with the news.", + "default": null, + "optional": true + }, + { + "name": "stocks", + "type": "str", + "description": "Stocks associated with the news.", + "default": null, + "optional": true + }, + { + "name": "tags", + "type": "str", + "description": "Tags associated with the news.", + "default": null, + "optional": true + }, + { + "name": "updated", + "type": "datetime", + "description": "Updated date of the news.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "site", + "type": "str", + "description": "News source.", + "default": "", + "optional": false + } + ], + "intrinio": [ + { + "name": "source", + "type": "str", + "description": "The source of the news article.", + "default": null, + "optional": true + }, + { + "name": "summary", + "type": "str", + "description": "The summary of the news article.", + "default": null, + "optional": true + }, + { + "name": "topics", + "type": "str", + "description": "The topics related to the news article.", + "default": null, + "optional": true + }, + { + "name": "word_count", + "type": "int", + "description": "The word count of the news article.", + "default": null, + "optional": true + }, + { + "name": "business_relevance", + "type": "float", + "description": "How strongly correlated the news article is to the business", "default": null, "optional": true }, { - "name": "channels", + "name": "sentiment", "type": "str", - "description": "Channels associated with the news.", + "description": "The sentiment of the news article - i.e, negative, positive.", "default": null, "optional": true }, { - "name": "stocks", - "type": "str", - "description": "Stocks associated with the news.", + "name": "sentiment_confidence", + "type": "float", + "description": "The confidence score of the sentiment rating.", "default": null, "optional": true }, { - "name": "tags", + "name": "language", "type": "str", - "description": "Tags associated with the news.", + "description": "The language of the news article.", "default": null, "optional": true }, { - "name": "updated", - "type": "datetime", - "description": "Updated date of the news.", + "name": "spam", + "type": "bool", + "description": "Whether the news article is spam.", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "site", + "name": "copyright", "type": "str", - "description": "News source.", - "default": "", - "optional": false - } - ], - "intrinio": [ + "description": "The copyright notice of the news article.", + "default": null, + "optional": true + }, { "name": "id", "type": "str", @@ -26943,10 +32658,17 @@ }, { "name": "company", - "type": "Dict[str, Any]", - "description": "Company details related to the news article.", - "default": "", - "optional": false + "type": "IntrinioCompany", + "description": "The Intrinio Company object. Contains details company reference data.", + "default": null, + "optional": true + }, + { + "name": "security", + "type": "IntrinioSecurity", + "description": "The Intrinio Security object. Contains the security details related to the news article.", + "default": null, + "optional": true } ], "tiingo": [ @@ -27000,8 +32722,8 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, yfinance.", + "type": "str", + "description": "Symbol to get data for.", "default": null, "optional": true }, @@ -27129,7 +32851,71 @@ "optional": true } ], - "intrinio": [], + "intrinio": [ + { + "name": "source", + "type": "Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases']", + "description": "The source of the news article.", + "default": null, + "optional": true + }, + { + "name": "sentiment", + "type": "Literal['positive', 'neutral', 'negative']", + "description": "Return news only from this source.", + "default": null, + "optional": true + }, + { + "name": "language", + "type": "str", + "description": "Filter by language. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "topic", + "type": "str", + "description": "Filter by topic. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "word_count_greater_than", + "type": "int", + "description": "News stories will have a word count greater than this value. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "word_count_less_than", + "type": "int", + "description": "News stories will have a word count less than this value. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "is_spam", + "type": "bool", + "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "business_relevance_greater_than", + "type": "float", + "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "business_relevance_less_than", + "type": "float", + "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source.", + "default": null, + "optional": true + } + ], "polygon": [ { "name": "order", @@ -27155,7 +32941,36 @@ "optional": true } ], - "yfinance": [] + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "Annotated[int, Ge(ge=0)]", + "description": "The number of data entries to return.", + "default": 2500, + "optional": true + } + ] }, "returns": { "OBBject": [ @@ -27232,6 +33047,13 @@ } ], "benzinga": [ + { + "name": "images", + "type": "List[Dict[str, str]]", + "description": "URL to the images of the news.", + "default": null, + "optional": true + }, { "name": "id", "type": "str", @@ -27292,12 +33114,89 @@ } ], "intrinio": [ + { + "name": "source", + "type": "str", + "description": "The source of the news article.", + "default": null, + "optional": true + }, + { + "name": "summary", + "type": "str", + "description": "The summary of the news article.", + "default": null, + "optional": true + }, + { + "name": "topics", + "type": "str", + "description": "The topics related to the news article.", + "default": null, + "optional": true + }, + { + "name": "word_count", + "type": "int", + "description": "The word count of the news article.", + "default": null, + "optional": true + }, + { + "name": "business_relevance", + "type": "float", + "description": "How strongly correlated the news article is to the business", + "default": null, + "optional": true + }, + { + "name": "sentiment", + "type": "str", + "description": "The sentiment of the news article - i.e, negative, positive.", + "default": null, + "optional": true + }, + { + "name": "sentiment_confidence", + "type": "float", + "description": "The confidence score of the sentiment rating.", + "default": null, + "optional": true + }, + { + "name": "language", + "type": "str", + "description": "The language of the news article.", + "default": null, + "optional": true + }, + { + "name": "spam", + "type": "bool", + "description": "Whether the news article is spam.", + "default": null, + "optional": true + }, + { + "name": "copyright", + "type": "str", + "description": "The copyright notice of the news article.", + "default": null, + "optional": true + }, { "name": "id", "type": "str", "description": "Article ID.", "default": "", "optional": false + }, + { + "name": "security", + "type": "IntrinioSecurity", + "description": "The Intrinio Security object. Contains the security details related to the news article.", + "default": null, + "optional": true } ], "polygon": [ @@ -27452,7 +33351,15 @@ "optional": true } ], - "sec": [] + "sec": [ + { + "name": "cik", + "type": "Union[int, str]", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true + } + ] }, "model": "CikMap" }, @@ -27487,7 +33394,22 @@ "optional": true } ], - "sec": [] + "sec": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache.", + "default": true, + "optional": true + } + ] }, "returns": { "OBBject": [ @@ -27530,7 +33452,7 @@ }, { "name": "cik", - "type": "Union[str, int]", + "type": "Union[int, str]", "description": "Central Index Key (CIK)", "default": null, "optional": true @@ -27654,7 +33576,22 @@ "optional": true } ], - "sec": [] + "sec": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", + "optional": false + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache. If True, cache will store for seven days.", + "default": true, + "optional": true + } + ] }, "returns": { "OBBject": [ @@ -27820,7 +33757,22 @@ "optional": true } ], - "sec": [] + "sec": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache.", + "default": true, + "optional": true + } + ] }, "returns": { "OBBject": [ diff --git a/openbb_platform/openbb/package/crypto_price.py b/openbb_platform/openbb/package/crypto_price.py index 7c3bedbb3622..bbd332f8d18b 100644 --- a/openbb_platform/openbb/package/crypto_price.py +++ b/openbb_platform/openbb/package/crypto_price.py @@ -137,12 +137,10 @@ def historical( extra_params=kwargs, info={ "symbol": { - "multiple_items_allowed": [ - "fmp", - "polygon", - "tiingo", - "yfinance", - ] + "fmp": {"multiple_items_allowed": True}, + "polygon": {"multiple_items_allowed": True}, + "tiingo": {"multiple_items_allowed": True}, + "yfinance": {"multiple_items_allowed": True}, } }, ) diff --git a/openbb_platform/openbb/package/currency.py b/openbb_platform/openbb/package/currency.py index b2a90cfa9bc5..eb06ace1b25a 100644 --- a/openbb_platform/openbb/package/currency.py +++ b/openbb_platform/openbb/package/currency.py @@ -302,6 +302,11 @@ def snapshots( "counter_currencies": counter_currencies, }, extra_params=kwargs, - info={"base": {"multiple_items_allowed": ["fmp", "polygon"]}}, + info={ + "base": { + "fmp": {"multiple_items_allowed": True}, + "polygon": {"multiple_items_allowed": True}, + } + }, ) ) diff --git a/openbb_platform/openbb/package/currency_price.py b/openbb_platform/openbb/package/currency_price.py index 396977d04434..251e422f05d8 100644 --- a/openbb_platform/openbb/package/currency_price.py +++ b/openbb_platform/openbb/package/currency_price.py @@ -140,12 +140,10 @@ def historical( extra_params=kwargs, info={ "symbol": { - "multiple_items_allowed": [ - "fmp", - "polygon", - "tiingo", - "yfinance", - ] + "fmp": {"multiple_items_allowed": True}, + "polygon": {"multiple_items_allowed": True}, + "tiingo": {"multiple_items_allowed": True}, + "yfinance": {"multiple_items_allowed": True}, } }, ) diff --git a/openbb_platform/openbb/package/derivatives_options.py b/openbb_platform/openbb/package/derivatives_options.py index 4e95763ec5f9..4490181503de 100644 --- a/openbb_platform/openbb/package/derivatives_options.py +++ b/openbb_platform/openbb/package/derivatives_options.py @@ -209,9 +209,9 @@ def unusual( The type of unusual activity to query for. (provider: intrinio) sentiment : Optional[Literal['bullish', 'bearish', 'neutral']] The sentiment type to query for. (provider: intrinio) - min_value : Optional[Union[float, int]] + min_value : Optional[Union[int, float]] The inclusive minimum total value for the unusual activity. (provider: intrinio) - max_value : Optional[Union[float, int]] + max_value : Optional[Union[int, float]] The inclusive maximum total value for the unusual activity. (provider: intrinio) limit : int The number of data entries to return. A typical day for all symbols will yield 50-80K records. The API will paginate at 1000 records. The high default limit (100K) is to be able to reliably capture the most days. The high absolute limit (1.25M) is to allow for outlier days. Queries at the absolute limit will take a long time, and might be unreliable. Apply filters to improve performance. (provider: intrinio) diff --git a/openbb_platform/openbb/package/economy.py b/openbb_platform/openbb/package/economy.py index dd5c0cfb118f..449558f05c5b 100644 --- a/openbb_platform/openbb/package/economy.py +++ b/openbb_platform/openbb/package/economy.py @@ -237,7 +237,9 @@ def calendar( "end_date": end_date, }, extra_params=kwargs, - info={"country": {"multiple_items_allowed": ["tradingeconomics"]}}, + info={ + "country": {"tradingeconomics": {"multiple_items_allowed": True}} + }, ) ) @@ -337,7 +339,7 @@ def country_profile( country: Annotated[ Union[str, List[str]], OpenBBField( - description="The country to get data. Multiple comma separated items allowed for provider(s): econdb." + description="The country to get data. Multiple comma separated items allowed." ), ], provider: Annotated[ @@ -353,7 +355,7 @@ def country_profile( Parameters ---------- country : Union[str, List[str]] - The country to get data. Multiple comma separated items allowed for provider(s): econdb. + The country to get data. Multiple comma separated items allowed. provider : Optional[Literal['econdb']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'econdb' if there is @@ -430,7 +432,7 @@ def country_profile( "country": country, }, extra_params=kwargs, - info={"country": {"multiple_items_allowed": ["econdb"]}}, + info={"country": {"econdb": {"multiple_items_allowed": True}}}, ) ) @@ -441,7 +443,7 @@ def cpi( country: Annotated[ Union[str, List[str]], OpenBBField( - description="The country to get data. Multiple comma separated items allowed for provider(s): fred.", + description="The country to get data. Multiple comma separated items allowed.", choices=[ "australia", "austria", @@ -534,7 +536,7 @@ def cpi( Parameters ---------- country : Union[str, List[str]] - The country to get data. Multiple comma separated items allowed for provider(s): fred. + The country to get data. Multiple comma separated items allowed. units : Literal['growth_previous', 'growth_same', 'index_2015'] The unit of measurement for the data. Options: @@ -603,7 +605,7 @@ def cpi( "end_date": end_date, }, extra_params=kwargs, - info={"country": {"multiple_items_allowed": ["fred"]}}, + info={"country": {"fred": {"multiple_items_allowed": True}}}, ) ) @@ -892,7 +894,7 @@ def fred_series( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fred." + description="Symbol to get data for. Multiple comma separated items allowed." ), ], start_date: Annotated[ @@ -920,7 +922,7 @@ def fred_series( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fred. + Symbol to get data for. Multiple comma separated items allowed. start_date : Union[datetime.date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] @@ -1024,7 +1026,10 @@ def fred_series( "limit": limit, }, extra_params=kwargs, - info={"symbol": {"multiple_items_allowed": ["fred"]}}, + info={ + "symbol": {"fred": {"multiple_items_allowed": True}}, + "limit": {"fred": {}}, + }, ) ) @@ -1042,13 +1047,13 @@ def indicators( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Multiple comma separated items allowed for provider(s): econdb." + description="Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Multiple comma separated items allowed." ), ], country: Annotated[ Union[str, None, List[Optional[str]]], OpenBBField( - description="The country to get data. The country represented by the indicator, if available. Multiple comma separated items allowed for provider(s): econdb." + description="The country to get data. The country represented by the indicator, if available. Multiple comma separated items allowed." ), ] = None, start_date: Annotated[ @@ -1072,9 +1077,9 @@ def indicators( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Multiple comma separated items allowed for provider(s): econdb. + Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Multiple comma separated items allowed. country : Union[str, None, List[Optional[str]]] - The country to get data. The country represented by the indicator, if available. Multiple comma separated items allowed for provider(s): econdb. + The country to get data. The country represented by the indicator, if available. Multiple comma separated items allowed. start_date : Union[datetime.date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] @@ -1150,8 +1155,8 @@ def indicators( }, extra_params=kwargs, info={ - "symbol": {"multiple_items_allowed": ["econdb"]}, - "country": {"multiple_items_allowed": ["econdb"]}, + "symbol": {"econdb": {"multiple_items_allowed": True}}, + "country": {"econdb": {"multiple_items_allowed": True}}, }, ) ) diff --git a/openbb_platform/openbb/package/equity.py b/openbb_platform/openbb/package/equity.py index 07564859dbb7..c67112ac8a1c 100644 --- a/openbb_platform/openbb/package/equity.py +++ b/openbb_platform/openbb/package/equity.py @@ -436,7 +436,9 @@ def profile( extra_params=kwargs, info={ "symbol": { - "multiple_items_allowed": ["fmp", "intrinio", "yfinance"] + "fmp": {"multiple_items_allowed": True}, + "intrinio": {"multiple_items_allowed": True}, + "yfinance": {"multiple_items_allowed": True}, } }, ) diff --git a/openbb_platform/openbb/package/equity_estimates.py b/openbb_platform/openbb/package/equity_estimates.py index 36212035e8bc..bfe7da2a2549 100644 --- a/openbb_platform/openbb/package/equity_estimates.py +++ b/openbb_platform/openbb/package/equity_estimates.py @@ -30,13 +30,13 @@ def analyst_search( analyst_name: Annotated[ Union[str, None, List[Optional[str]]], OpenBBField( - description="Analyst names to return. Omitting will return all available analysts. Multiple comma separated items allowed for provider(s): benzinga." + description="Analyst names to return. Omitting will return all available analysts. Multiple comma separated items allowed." ), ] = None, firm_name: Annotated[ Union[str, None, List[Optional[str]]], OpenBBField( - description="Firm names to return. Omitting will return all available firms. Multiple comma separated items allowed for provider(s): benzinga." + description="Firm names to return. Omitting will return all available firms. Multiple comma separated items allowed." ), ] = None, provider: Annotated[ @@ -52,9 +52,9 @@ def analyst_search( Parameters ---------- analyst_name : Union[str, None, List[Optional[str]]] - Analyst names to return. Omitting will return all available analysts. Multiple comma separated items allowed for provider(s): benzinga. + Analyst names to return. Omitting will return all available analysts. Multiple comma separated items allowed. firm_name : Union[str, None, List[Optional[str]]] - Firm names to return. Omitting will return all available firms. Multiple comma separated items allowed for provider(s): benzinga. + Firm names to return. Omitting will return all available firms. Multiple comma separated items allowed. provider : Optional[Literal['benzinga']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is @@ -222,11 +222,11 @@ def analyst_search( }, extra_params=kwargs, info={ - "analyst_name": {"multiple_items_allowed": ["benzinga"]}, - "firm_name": {"multiple_items_allowed": ["benzinga"]}, - "analyst_ids": {"multiple_items_allowed": ["benzinga"]}, - "firm_ids": {"multiple_items_allowed": ["benzinga"]}, - "fields": {"multiple_items_allowed": ["benzinga"]}, + "analyst_name": {"benzinga": {"multiple_items_allowed": True}}, + "firm_name": {"benzinga": {"multiple_items_allowed": True}}, + "analyst_ids": {"benzinga": {"multiple_items_allowed": True}}, + "firm_ids": {"benzinga": {"multiple_items_allowed": True}}, + "fields": {"benzinga": {"multiple_items_allowed": True}}, }, ) ) @@ -336,7 +336,9 @@ def consensus( extra_params=kwargs, info={ "symbol": { - "multiple_items_allowed": ["fmp", "intrinio", "yfinance"] + "fmp": {"multiple_items_allowed": True}, + "intrinio": {"multiple_items_allowed": True}, + "yfinance": {"multiple_items_allowed": True}, } }, ) @@ -457,7 +459,12 @@ def forward_eps( "symbol": symbol, }, extra_params=kwargs, - info={"symbol": {"multiple_items_allowed": ["fmp", "intrinio"]}}, + info={ + "symbol": { + "fmp": {"multiple_items_allowed": True}, + "intrinio": {"multiple_items_allowed": True}, + } + }, ) ) @@ -468,7 +475,7 @@ def forward_sales( symbol: Annotated[ Union[str, None, List[Optional[str]]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio." + description="Symbol to get data for. Multiple comma separated items allowed." ), ] = None, provider: Annotated[ @@ -484,7 +491,7 @@ def forward_sales( Parameters ---------- symbol : Union[str, None, List[Optional[str]]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio. + Symbol to get data for. Multiple comma separated items allowed. provider : Optional[Literal['intrinio']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is @@ -580,7 +587,7 @@ def forward_sales( "symbol": symbol, }, extra_params=kwargs, - info={"symbol": {"multiple_items_allowed": ["intrinio"]}}, + info={"symbol": {"intrinio": {"multiple_items_allowed": True}}}, ) ) @@ -591,7 +598,7 @@ def historical( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." + description="Symbol to get data for. Multiple comma separated items allowed." ), ], provider: Annotated[ @@ -607,7 +614,7 @@ def historical( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. + Symbol to get data for. Multiple comma separated items allowed. provider : Optional[Literal['fmp']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is @@ -698,7 +705,7 @@ def historical( "symbol": symbol, }, extra_params=kwargs, - info={"symbol": {"multiple_items_allowed": ["fmp"]}}, + info={"symbol": {"fmp": {"multiple_items_allowed": True}}}, ) ) @@ -854,6 +861,11 @@ def price_target( "limit": limit, }, extra_params=kwargs, - info={"symbol": {"multiple_items_allowed": ["benzinga", "fmp"]}}, + info={ + "symbol": { + "benzinga": {"multiple_items_allowed": True}, + "fmp": {"multiple_items_allowed": True}, + } + }, ) ) diff --git a/openbb_platform/openbb/package/equity_fundamental.py b/openbb_platform/openbb/package/equity_fundamental.py index 0ed3fc957b8f..8449ff71fe1c 100644 --- a/openbb_platform/openbb/package/equity_fundamental.py +++ b/openbb_platform/openbb/package/equity_fundamental.py @@ -403,6 +403,9 @@ def balance( "limit": limit, }, extra_params=kwargs, + info={ + "period": {"fmp": {}, "intrinio": {}, "polygon": {}, "yfinance": {}} + }, ) ) @@ -826,6 +829,9 @@ def cash( "limit": limit, }, extra_params=kwargs, + info={ + "period": {"fmp": {}, "intrinio": {}, "polygon": {}, "yfinance": {}} + }, ) ) @@ -1197,7 +1203,7 @@ def filings( End date of the data, in YYYY-MM-DD format. (provider: intrinio) thea_enabled : Optional[bool] Return filings that have been read by Intrinio's Thea NLP. (provider: intrinio) - cik : Optional[Union[str, int]] + cik : Optional[Union[int, str]] Lookup filings by Central Index Key (CIK) instead of by symbol. (provider: sec) use_cache : bool Whether or not to use cache. If True, cache will store for one day. (provider: sec) @@ -1246,7 +1252,7 @@ def filings( Industry category of the company. (provider: intrinio) report_date : Optional[date] The date of the filing. (provider: sec) - act : Optional[Union[str, int]] + act : Optional[Union[int, str]] The SEC Act number. (provider: sec) items : Optional[Union[str, float]] The SEC Item numbers. (provider: sec) @@ -1254,17 +1260,17 @@ def filings( The description of the primary document. (provider: sec) primary_doc : Optional[str] The filename of the primary document. (provider: sec) - accession_number : Optional[Union[str, int]] + accession_number : Optional[Union[int, str]] The accession number. (provider: sec) - file_number : Optional[Union[str, int]] + file_number : Optional[Union[int, str]] The file number. (provider: sec) - film_number : Optional[Union[str, int]] + film_number : Optional[Union[int, str]] The film number. (provider: sec) - is_inline_xbrl : Optional[Union[str, int]] + is_inline_xbrl : Optional[Union[int, str]] Whether the filing is an inline XBRL filing. (provider: sec) - is_xbrl : Optional[Union[str, int]] + is_xbrl : Optional[Union[int, str]] Whether the filing is an XBRL filing. (provider: sec) - size : Optional[Union[str, int]] + size : Optional[Union[int, str]] The size of the filing. (provider: sec) complete_submission_url : Optional[str] The URL to the complete filing submission. (provider: sec) @@ -1294,6 +1300,7 @@ def filings( "limit": limit, }, extra_params=kwargs, + info={"form_type": {"sec": {}}}, ) ) @@ -1304,13 +1311,13 @@ def historical_attributes( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio." + description="Symbol to get data for. Multiple comma separated items allowed." ), ], tag: Annotated[ Union[str, List[str]], OpenBBField( - description="Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio." + description="Intrinio data tag ID or code. Multiple comma separated items allowed." ), ], start_date: Annotated[ @@ -1348,9 +1355,9 @@ def historical_attributes( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio. + Symbol to get data for. Multiple comma separated items allowed. tag : Union[str, List[str]] - Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio. + Intrinio data tag ID or code. Multiple comma separated items allowed. start_date : Union[datetime.date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] @@ -1421,8 +1428,8 @@ def historical_attributes( }, extra_params=kwargs, info={ - "symbol": {"multiple_items_allowed": ["intrinio"]}, - "tag": {"multiple_items_allowed": ["intrinio"]}, + "symbol": {"intrinio": {"multiple_items_allowed": True}}, + "tag": {"intrinio": {"multiple_items_allowed": True}}, }, ) ) @@ -1944,6 +1951,9 @@ def income( "limit": limit, }, extra_params=kwargs, + info={ + "period": {"fmp": {}, "intrinio": {}, "polygon": {}, "yfinance": {}} + }, ) ) @@ -2090,13 +2100,13 @@ def latest_attributes( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio." + description="Symbol to get data for. Multiple comma separated items allowed." ), ], tag: Annotated[ Union[str, List[str]], OpenBBField( - description="Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio." + description="Intrinio data tag ID or code. Multiple comma separated items allowed." ), ], provider: Annotated[ @@ -2112,9 +2122,9 @@ def latest_attributes( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio. + Symbol to get data for. Multiple comma separated items allowed. tag : Union[str, List[str]] - Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio. + Intrinio data tag ID or code. Multiple comma separated items allowed. provider : Optional[Literal['intrinio']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is @@ -2165,8 +2175,8 @@ def latest_attributes( }, extra_params=kwargs, info={ - "symbol": {"multiple_items_allowed": ["intrinio"]}, - "tag": {"multiple_items_allowed": ["intrinio"]}, + "symbol": {"intrinio": {"multiple_items_allowed": True}}, + "tag": {"intrinio": {"multiple_items_allowed": True}}, }, ) ) @@ -2260,7 +2270,7 @@ def management_compensation( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." + description="Symbol to get data for. Multiple comma separated items allowed." ), ], provider: Annotated[ @@ -2276,7 +2286,7 @@ def management_compensation( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. + Symbol to get data for. Multiple comma separated items allowed. provider : Optional[Literal['fmp']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is @@ -2351,7 +2361,7 @@ def management_compensation( "symbol": symbol, }, extra_params=kwargs, - info={"symbol": {"multiple_items_allowed": ["fmp"]}}, + info={"symbol": {"fmp": {"multiple_items_allowed": True}}}, ) ) @@ -2670,7 +2680,9 @@ def metrics( extra_params=kwargs, info={ "symbol": { - "multiple_items_allowed": ["fmp", "intrinio", "yfinance"] + "fmp": {"multiple_items_allowed": True}, + "intrinio": {"multiple_items_allowed": True}, + "yfinance": {"multiple_items_allowed": True}, } }, ) @@ -2683,7 +2695,7 @@ def multiples( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." + description="Symbol to get data for. Multiple comma separated items allowed." ), ], provider: Annotated[ @@ -2699,7 +2711,7 @@ def multiples( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. + Symbol to get data for. Multiple comma separated items allowed. provider : Optional[Literal['fmp']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is @@ -2864,7 +2876,7 @@ def multiples( "symbol": symbol, }, extra_params=kwargs, - info={"symbol": {"multiple_items_allowed": ["fmp"]}}, + info={"symbol": {"fmp": {"multiple_items_allowed": True}}}, ) ) @@ -3209,6 +3221,7 @@ def ratios( "limit": limit, }, extra_params=kwargs, + info={"period": {"fmp": {}, "intrinio": {}}}, ) ) @@ -3311,6 +3324,7 @@ def reported_financials( "limit": limit, }, extra_params=kwargs, + info={"period": {"intrinio": {}}, "statement_type": {"intrinio": {}}}, ) ) diff --git a/openbb_platform/openbb/package/equity_ownership.py b/openbb_platform/openbb/package/equity_ownership.py index 7311c9aa7ebc..26341a562a55 100644 --- a/openbb_platform/openbb/package/equity_ownership.py +++ b/openbb_platform/openbb/package/equity_ownership.py @@ -245,7 +245,7 @@ def insider_trading( Expiration date of the derivative. (provider: intrinio) underlying_security_title : Optional[str] Name of the underlying non-derivative security related to this derivative transaction. (provider: intrinio) - underlying_shares : Optional[Union[float, int]] + underlying_shares : Optional[Union[int, float]] Number of underlying shares related to this derivative transaction. (provider: intrinio) nature_of_ownership : Optional[str] Nature of ownership of the insider trading. (provider: intrinio) @@ -590,7 +590,7 @@ def share_statistics( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): yfinance." + description="Symbol to get data for. Multiple comma separated items allowed." ), ], provider: Annotated[ @@ -606,7 +606,7 @@ def share_statistics( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): yfinance. + Symbol to get data for. Multiple comma separated items allowed. provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is @@ -685,6 +685,6 @@ def share_statistics( "symbol": symbol, }, extra_params=kwargs, - info={"symbol": {"multiple_items_allowed": ["yfinance"]}}, + info={"symbol": {"yfinance": {"multiple_items_allowed": True}}}, ) ) diff --git a/openbb_platform/openbb/package/equity_price.py b/openbb_platform/openbb/package/equity_price.py index 369b2c14646d..21a4888478b8 100644 --- a/openbb_platform/openbb/package/equity_price.py +++ b/openbb_platform/openbb/package/equity_price.py @@ -117,7 +117,7 @@ def historical( The low price. close : float The close price. - volume : Optional[Union[float, int]] + volume : Optional[Union[int, float]] The trading volume. vwap : Optional[float] Volume Weighted Average Price over the period. @@ -186,12 +186,17 @@ def historical( extra_params=kwargs, info={ "symbol": { - "multiple_items_allowed": [ - "fmp", - "polygon", - "tiingo", - "yfinance", - ] + "fmp": {"multiple_items_allowed": True}, + "polygon": {"multiple_items_allowed": True}, + "tiingo": {"multiple_items_allowed": True}, + "yfinance": {"multiple_items_allowed": True}, + }, + "interval": { + "fmp": {}, + "intrinio": {}, + "polygon": {}, + "tiingo": {}, + "yfinance": {}, }, "adjusted": {"deprecated": True}, "prepost": {"deprecated": True}, @@ -312,7 +317,7 @@ def performance( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." + description="Symbol to get data for. Multiple comma separated items allowed." ), ], provider: Annotated[ @@ -328,7 +333,7 @@ def performance( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. + Symbol to get data for. Multiple comma separated items allowed. provider : Optional[Literal['fmp']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is @@ -405,7 +410,7 @@ def performance( "symbol": symbol, }, extra_params=kwargs, - info={"symbol": {"multiple_items_allowed": ["fmp"]}}, + info={"symbol": {"fmp": {"multiple_items_allowed": True}}}, ) ) @@ -508,9 +513,9 @@ def quote( The low price. close : Optional[float] The close price. - volume : Optional[Union[float, int]] + volume : Optional[Union[int, float]] The trading volume. - exchange_volume : Optional[Union[float, int]] + exchange_volume : Optional[Union[int, float]] Volume of shares exchanged during the trading day on the specific exchange. prev_close : Optional[float] The previous close price. @@ -579,7 +584,9 @@ def quote( extra_params=kwargs, info={ "symbol": { - "multiple_items_allowed": ["fmp", "intrinio", "yfinance"] + "fmp": {"multiple_items_allowed": True}, + "intrinio": {"multiple_items_allowed": True}, + "yfinance": {"multiple_items_allowed": True}, } }, ) diff --git a/openbb_platform/openbb/package/etf.py b/openbb_platform/openbb/package/etf.py index fba228608680..893c941a2c3e 100644 --- a/openbb_platform/openbb/package/etf.py +++ b/openbb_platform/openbb/package/etf.py @@ -37,7 +37,7 @@ def countries( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp." + description="Symbol to get data for. (ETF) Multiple comma separated items allowed." ), ], provider: Annotated[ @@ -53,7 +53,7 @@ def countries( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp. + Symbol to get data for. (ETF) Multiple comma separated items allowed. provider : Optional[Literal['fmp']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is @@ -98,7 +98,7 @@ def countries( "symbol": symbol, }, extra_params=kwargs, - info={"symbol": {"multiple_items_allowed": ["fmp"]}}, + info={"symbol": {"fmp": {"multiple_items_allowed": True}}}, ) ) @@ -109,7 +109,7 @@ def equity_exposure( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. (Stock) Multiple comma separated items allowed for provider(s): fmp." + description="Symbol to get data for. (Stock) Multiple comma separated items allowed." ), ], provider: Annotated[ @@ -125,7 +125,7 @@ def equity_exposure( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. (Stock) Multiple comma separated items allowed for provider(s): fmp. + Symbol to get data for. (Stock) Multiple comma separated items allowed. provider : Optional[Literal['fmp']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is @@ -155,7 +155,7 @@ def equity_exposure( The number of shares held in the ETF. weight : Optional[float] The weight of the equity in the ETF, as a normalized percent. - market_value : Optional[Union[float, int]] + market_value : Optional[Union[int, float]] The market value of the equity position in the ETF. Examples @@ -180,7 +180,7 @@ def equity_exposure( "symbol": symbol, }, extra_params=kwargs, - info={"symbol": {"multiple_items_allowed": ["fmp"]}}, + info={"symbol": {"fmp": {"multiple_items_allowed": True}}}, ) ) @@ -279,7 +279,7 @@ def historical( The low price. close : float The close price. - volume : Optional[Union[float, int]] + volume : Optional[Union[int, float]] The trading volume. vwap : Optional[float] Volume Weighted Average Price over the period. @@ -350,12 +350,17 @@ def historical( extra_params=kwargs, info={ "symbol": { - "multiple_items_allowed": [ - "fmp", - "polygon", - "tiingo", - "yfinance", - ] + "fmp": {"multiple_items_allowed": True}, + "polygon": {"multiple_items_allowed": True}, + "tiingo": {"multiple_items_allowed": True}, + "yfinance": {"multiple_items_allowed": True}, + }, + "interval": { + "fmp": {}, + "intrinio": {}, + "polygon": {}, + "tiingo": {}, + "yfinance": {}, }, "adjusted": {"deprecated": True}, "prepost": {"deprecated": True}, @@ -538,11 +543,11 @@ def holdings( The floating rate spread for reveivable portion of the swap. (provider: sec) rate_tenor_rec : Optional[str] The rate tenor for receivable portion of the swap. (provider: sec) - rate_tenor_unit_rec : Optional[Union[str, int]] + rate_tenor_unit_rec : Optional[Union[int, str]] The rate tenor unit for receivable portion of the swap. (provider: sec) reset_date_rec : Optional[str] The reset date for receivable portion of the swap. (provider: sec) - reset_date_unit_rec : Optional[Union[str, int]] + reset_date_unit_rec : Optional[Union[int, str]] The reset date unit for receivable portion of the swap. (provider: sec) rate_type_pmnt : Optional[str] The type of rate for payment portion of the swap. (provider: sec) @@ -556,11 +561,11 @@ def holdings( The floating rate spread for payment portion of the swap. (provider: sec) rate_tenor_pmnt : Optional[str] The rate tenor for payment portion of the swap. (provider: sec) - rate_tenor_unit_pmnt : Optional[Union[str, int]] + rate_tenor_unit_pmnt : Optional[Union[int, str]] The rate tenor unit for payment portion of the swap. (provider: sec) reset_date_pmnt : Optional[str] The reset date for payment portion of the swap. (provider: sec) - reset_date_unit_pmnt : Optional[Union[str, int]] + reset_date_unit_pmnt : Optional[Union[int, str]] The reset date unit for payment portion of the swap. (provider: sec) repo_type : Optional[str] The type of repo. (provider: sec) @@ -705,7 +710,7 @@ def holdings_performance( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." + description="Symbol to get data for. Multiple comma separated items allowed." ), ], provider: Annotated[ @@ -721,7 +726,7 @@ def holdings_performance( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. + Symbol to get data for. Multiple comma separated items allowed. provider : Optional[Literal['fmp']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is @@ -805,7 +810,7 @@ def holdings_performance( "symbol": symbol, }, extra_params=kwargs, - info={"symbol": {"multiple_items_allowed": ["fmp"]}}, + info={"symbol": {"fmp": {"multiple_items_allowed": True}}}, ) ) @@ -1195,7 +1200,9 @@ def info( extra_params=kwargs, info={ "symbol": { - "multiple_items_allowed": ["fmp", "intrinio", "yfinance"] + "fmp": {"multiple_items_allowed": True}, + "intrinio": {"multiple_items_allowed": True}, + "yfinance": {"multiple_items_allowed": True}, } }, ) @@ -1336,7 +1343,12 @@ def price_performance( "symbol": symbol, }, extra_params=kwargs, - info={"symbol": {"multiple_items_allowed": ["fmp", "intrinio"]}}, + info={ + "symbol": { + "fmp": {"multiple_items_allowed": True}, + "intrinio": {"multiple_items_allowed": True}, + } + }, ) ) diff --git a/openbb_platform/openbb/package/fixedincome_corporate.py b/openbb_platform/openbb/package/fixedincome_corporate.py index 7f3a1e19957c..1298263d4bcf 100644 --- a/openbb_platform/openbb/package/fixedincome_corporate.py +++ b/openbb_platform/openbb/package/fixedincome_corporate.py @@ -427,13 +427,13 @@ def spot_rates( maturity: Annotated[ Union[float, str, List[Union[float, str]]], OpenBBField( - description="Maturities in years. Multiple comma separated items allowed for provider(s): fred." + description="Maturities in years. Multiple comma separated items allowed." ), ] = 10.0, category: Annotated[ Union[str, List[str]], OpenBBField( - description="Rate category. Options: spot_rate, par_yield. Multiple comma separated items allowed for provider(s): fred.", + description="Rate category. Options: spot_rate, par_yield. Multiple comma separated items allowed.", choices=["par_yield", "spot_rate"], ), ] = "spot_rate", @@ -460,9 +460,9 @@ def spot_rates( end_date : Union[datetime.date, None, str] End date of the data, in YYYY-MM-DD format. maturity : Union[float, str, List[Union[float, str]]] - Maturities in years. Multiple comma separated items allowed for provider(s): fred. + Maturities in years. Multiple comma separated items allowed. category : Union[str, List[str]] - Rate category. Options: spot_rate, par_yield. Multiple comma separated items allowed for provider(s): fred. + Rate category. Options: spot_rate, par_yield. Multiple comma separated items allowed. provider : Optional[Literal['fred']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is @@ -514,8 +514,8 @@ def spot_rates( }, extra_params=kwargs, info={ - "maturity": {"multiple_items_allowed": ["fred"]}, - "category": {"multiple_items_allowed": ["fred"]}, + "maturity": {"fred": {"multiple_items_allowed": True}}, + "category": {"fred": {"multiple_items_allowed": True}}, }, ) ) diff --git a/openbb_platform/openbb/package/index.py b/openbb_platform/openbb/package/index.py index babec4f8c964..a5fe0bd92f6e 100644 --- a/openbb_platform/openbb/package/index.py +++ b/openbb_platform/openbb/package/index.py @@ -173,6 +173,7 @@ def constituents( "symbol": symbol, }, extra_params=kwargs, + info={"symbol": {"fmp": {}}}, ) ) @@ -300,13 +301,12 @@ def market( extra_params=kwargs, info={ "symbol": { - "multiple_items_allowed": [ - "fmp", - "intrinio", - "polygon", - "yfinance", - ] - } + "fmp": {"multiple_items_allowed": True}, + "intrinio": {"multiple_items_allowed": True}, + "polygon": {"multiple_items_allowed": True}, + "yfinance": {"multiple_items_allowed": True}, + }, + "interval": {"fmp": {}, "polygon": {}, "yfinance": {}}, }, ) ) diff --git a/openbb_platform/openbb/package/news.py b/openbb_platform/openbb/package/news.py index d137098644da..b0e65cd2ab25 100644 --- a/openbb_platform/openbb/package/news.py +++ b/openbb_platform/openbb/package/news.py @@ -96,10 +96,27 @@ def company( Content types of the news to retrieve. (provider: benzinga) page : Optional[int] Page number of the results. Use in combination with limit. (provider: fmp) + source : Optional[Union[Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases'], str]] + The source of the news article. (provider: intrinio); + A comma-separated list of the domains requested. (provider: tiingo) + sentiment : Optional[Literal['positive', 'neutral', 'negative']] + Return news only from this source. (provider: intrinio) + language : Optional[str] + Filter by language. Unsupported for yahoo source. (provider: intrinio) + topic : Optional[str] + Filter by topic. Unsupported for yahoo source. (provider: intrinio) + word_count_greater_than : Optional[int] + News stories will have a word count greater than this value. Unsupported for yahoo source. (provider: intrinio) + word_count_less_than : Optional[int] + News stories will have a word count less than this value. Unsupported for yahoo source. (provider: intrinio) + is_spam : Optional[bool] + Filter whether it is marked as spam or not. Unsupported for yahoo source. (provider: intrinio) + business_relevance_greater_than : Optional[float] + News stories will have a business relevance score more than this value. Unsupported for yahoo source. (provider: intrinio) + business_relevance_less_than : Optional[float] + News stories will have a business relevance score less than this value. Unsupported for yahoo source. (provider: intrinio) offset : Optional[int] Page offset, used in conjunction with limit. (provider: tiingo) - source : Optional[str] - A comma-separated list of the domains requested. (provider: tiingo) Returns ------- @@ -145,9 +162,30 @@ def company( Updated date of the news. (provider: benzinga) source : Optional[str] Name of the news source. (provider: fmp); + The source of the news article. (provider: intrinio); Source of the article. (provider: polygon); News source. (provider: tiingo); Source of the news article (provider: yfinance) + summary : Optional[str] + The summary of the news article. (provider: intrinio) + topics : Optional[str] + The topics related to the news article. (provider: intrinio) + word_count : Optional[int] + The word count of the news article. (provider: intrinio) + business_relevance : Optional[float] + How strongly correlated the news article is to the business (provider: intrinio) + sentiment : Optional[str] + The sentiment of the news article - i.e, negative, positive. (provider: intrinio) + sentiment_confidence : Optional[float] + The confidence score of the sentiment rating. (provider: intrinio) + language : Optional[str] + The language of the news article. (provider: intrinio) + spam : Optional[bool] + Whether the news article is spam. (provider: intrinio) + copyright : Optional[str] + The copyright notice of the news article. (provider: intrinio) + security : Optional[IntrinioSecurity] + The Intrinio Security object. Contains the security details related to the news article. (provider: intrinio) amp_url : Optional[str] AMP URL. (provider: polygon) publisher : Optional[PolygonPublisher] @@ -198,14 +236,12 @@ def company( extra_params=kwargs, info={ "symbol": { - "multiple_items_allowed": [ - "benzinga", - "fmp", - "intrinio", - "polygon", - "tiingo", - "yfinance", - ] + "benzinga": {"multiple_items_allowed": True}, + "fmp": {"multiple_items_allowed": True}, + "intrinio": {"multiple_items_allowed": True}, + "polygon": {"multiple_items_allowed": True}, + "tiingo": {"multiple_items_allowed": True}, + "yfinance": {"multiple_items_allowed": True}, } }, ) @@ -275,10 +311,27 @@ def world( Authors of the news to retrieve. (provider: benzinga) content_types : Optional[str] Content types of the news to retrieve. (provider: benzinga) + source : Optional[Union[Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases'], str]] + The source of the news article. (provider: intrinio); + A comma-separated list of the domains requested. (provider: tiingo) + sentiment : Optional[Literal['positive', 'neutral', 'negative']] + Return news only from this source. (provider: intrinio) + language : Optional[str] + Filter by language. Unsupported for yahoo source. (provider: intrinio) + topic : Optional[str] + Filter by topic. Unsupported for yahoo source. (provider: intrinio) + word_count_greater_than : Optional[int] + News stories will have a word count greater than this value. Unsupported for yahoo source. (provider: intrinio) + word_count_less_than : Optional[int] + News stories will have a word count less than this value. Unsupported for yahoo source. (provider: intrinio) + is_spam : Optional[bool] + Filter whether it is marked as spam or not. Unsupported for yahoo source. (provider: intrinio) + business_relevance_greater_than : Optional[float] + News stories will have a business relevance score more than this value. Unsupported for yahoo source. (provider: intrinio) + business_relevance_less_than : Optional[float] + News stories will have a business relevance score less than this value. Unsupported for yahoo source. (provider: intrinio) offset : Optional[int] Page offset, used in conjunction with limit. (provider: tiingo) - source : Optional[str] - A comma-separated list of the domains requested. (provider: tiingo) Returns ------- @@ -322,8 +375,30 @@ def world( Updated date of the news. (provider: benzinga) site : Optional[str] News source. (provider: fmp, tiingo) - company : Optional[Dict[str, Any]] - Company details related to the news article. (provider: intrinio) + source : Optional[str] + The source of the news article. (provider: intrinio) + summary : Optional[str] + The summary of the news article. (provider: intrinio) + topics : Optional[str] + The topics related to the news article. (provider: intrinio) + word_count : Optional[int] + The word count of the news article. (provider: intrinio) + business_relevance : Optional[float] + How strongly correlated the news article is to the business (provider: intrinio) + sentiment : Optional[str] + The sentiment of the news article - i.e, negative, positive. (provider: intrinio) + sentiment_confidence : Optional[float] + The confidence score of the sentiment rating. (provider: intrinio) + language : Optional[str] + The language of the news article. (provider: intrinio) + spam : Optional[bool] + Whether the news article is spam. (provider: intrinio) + copyright : Optional[str] + The copyright notice of the news article. (provider: intrinio) + company : Optional[IntrinioCompany] + The Intrinio Company object. Contains details company reference data. (provider: intrinio) + security : Optional[IntrinioSecurity] + The Intrinio Security object. Contains the security details related to the news article. (provider: intrinio) symbols : Optional[str] Ticker tagged in the fetched news. (provider: tiingo) article_id : Optional[int] diff --git a/openbb_platform/openbb/package/regulators_sec.py b/openbb_platform/openbb/package/regulators_sec.py index b0d674356e83..9c61fa5ea77d 100644 --- a/openbb_platform/openbb/package/regulators_sec.py +++ b/openbb_platform/openbb/package/regulators_sec.py @@ -97,10 +97,7 @@ def institutions_search( self, query: Annotated[str, OpenBBField(description="Search query.")] = "", use_cache: Annotated[ - Optional[bool], - OpenBBField( - description="Whether or not to use cache. If True, cache will store for seven days." - ), + Optional[bool], OpenBBField(description="Whether or not to use cache.") ] = True, provider: Annotated[ Optional[Literal["sec"]], @@ -141,7 +138,7 @@ def institutions_search( ------------------ name : Optional[str] The name of the institution. (provider: sec) - cik : Optional[Union[str, int]] + cik : Optional[Union[int, str]] Central Index Key (CIK) (provider: sec) Examples @@ -244,10 +241,7 @@ def schema_files( self, query: Annotated[str, OpenBBField(description="Search query.")] = "", use_cache: Annotated[ - Optional[bool], - OpenBBField( - description="Whether or not to use cache. If True, cache will store for seven days." - ), + Optional[bool], OpenBBField(description="Whether or not to use cache.") ] = True, provider: Annotated[ Optional[Literal["sec"]], @@ -339,10 +333,7 @@ def sic_search( self, query: Annotated[str, OpenBBField(description="Search query.")] = "", use_cache: Annotated[ - Optional[bool], - OpenBBField( - description="Whether or not to use cache. If True, cache will store for seven days." - ), + Optional[bool], OpenBBField(description="Whether or not to use cache.") ] = True, provider: Annotated[ Optional[Literal["sec"]], diff --git a/openbb_platform/providers/alpha_vantage/openbb_alpha_vantage/models/equity_historical.py b/openbb_platform/providers/alpha_vantage/openbb_alpha_vantage/models/equity_historical.py index 91e20c2d7268..e7b663d64bde 100644 --- a/openbb_platform/providers/alpha_vantage/openbb_alpha_vantage/models/equity_historical.py +++ b/openbb_platform/providers/alpha_vantage/openbb_alpha_vantage/models/equity_historical.py @@ -43,7 +43,7 @@ class AVEquityHistoricalQueryParams(EquityHistoricalQueryParams): Source: https://www.alphavantage.co/documentation/#time-series-data """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} interval: Literal["1m", "5m", "15m", "30m", "60m", "1d", "1W", "1M"] = Field( default="1d", diff --git a/openbb_platform/providers/alpha_vantage/openbb_alpha_vantage/models/historical_eps.py b/openbb_platform/providers/alpha_vantage/openbb_alpha_vantage/models/historical_eps.py index ccb38ec5f6f1..dc1a7d23c075 100644 --- a/openbb_platform/providers/alpha_vantage/openbb_alpha_vantage/models/historical_eps.py +++ b/openbb_platform/providers/alpha_vantage/openbb_alpha_vantage/models/historical_eps.py @@ -30,7 +30,7 @@ class AlphaVantageHistoricalEpsQueryParams(HistoricalEpsQueryParams): Source: https://www.alphavantage.co/documentation/#earnings """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} period: Literal["annual", "quarter"] = Field( default="quarter", description=QUERY_DESCRIPTIONS.get("period", "") diff --git a/openbb_platform/providers/benzinga/openbb_benzinga/models/analyst_search.py b/openbb_platform/providers/benzinga/openbb_benzinga/models/analyst_search.py index f5cf40a2a5a8..fb4b448b46a8 100644 --- a/openbb_platform/providers/benzinga/openbb_benzinga/models/analyst_search.py +++ b/openbb_platform/providers/benzinga/openbb_benzinga/models/analyst_search.py @@ -34,11 +34,11 @@ class BenzingaAnalystSearchQueryParams(AnalystSearchQueryParams): "limit": "pageSize", } __json_schema_extra__ = { - "analyst_name": ["multiple_items_allowed"], - "firm_name": ["multiple_items_allowed"], - "analyst_ids": ["multiple_items_allowed"], - "firm_ids": ["multiple_items_allowed"], - "fields": ["multiple_items_allowed"], + "analyst_name": {"multiple_items_allowed": True}, + "firm_name": {"multiple_items_allowed": True}, + "analyst_ids": {"multiple_items_allowed": True}, + "firm_ids": {"multiple_items_allowed": True}, + "fields": {"multiple_items_allowed": True}, } analyst_ids: Optional[str] = Field( diff --git a/openbb_platform/providers/benzinga/openbb_benzinga/models/company_news.py b/openbb_platform/providers/benzinga/openbb_benzinga/models/company_news.py index eb7723da3ddf..2e8190ccaaa6 100644 --- a/openbb_platform/providers/benzinga/openbb_benzinga/models/company_news.py +++ b/openbb_platform/providers/benzinga/openbb_benzinga/models/company_news.py @@ -32,7 +32,7 @@ class BenzingaCompanyNewsQueryParams(CompanyNewsQueryParams): "updated_since": "updatedSince", "published_since": "publishedSince", } - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} date: Optional[dateType] = Field( default=None, description=QUERY_DESCRIPTIONS.get("date", "") diff --git a/openbb_platform/providers/benzinga/openbb_benzinga/models/price_target.py b/openbb_platform/providers/benzinga/openbb_benzinga/models/price_target.py index d799e3410d88..49666ac18c50 100644 --- a/openbb_platform/providers/benzinga/openbb_benzinga/models/price_target.py +++ b/openbb_platform/providers/benzinga/openbb_benzinga/models/price_target.py @@ -49,7 +49,7 @@ class BenzingaPriceTargetQueryParams(PriceTargetQueryParams): "limit": "pagesize", "symbol": "parameters[tickers]", } - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} page: Optional[int] = Field( default=0, diff --git a/openbb_platform/providers/cboe/openbb_cboe/models/equity_historical.py b/openbb_platform/providers/cboe/openbb_cboe/models/equity_historical.py index c74afc3430a1..dd74cdba493a 100644 --- a/openbb_platform/providers/cboe/openbb_cboe/models/equity_historical.py +++ b/openbb_platform/providers/cboe/openbb_cboe/models/equity_historical.py @@ -30,7 +30,7 @@ class CboeEquityHistoricalQueryParams(EquityHistoricalQueryParams): Source: https://www.cboe.com/ """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} interval: Literal["1m", "1d"] = Field( default="1d", diff --git a/openbb_platform/providers/cboe/openbb_cboe/models/equity_quote.py b/openbb_platform/providers/cboe/openbb_cboe/models/equity_quote.py index bd311c5d2d4d..b62ae9f4a957 100644 --- a/openbb_platform/providers/cboe/openbb_cboe/models/equity_quote.py +++ b/openbb_platform/providers/cboe/openbb_cboe/models/equity_quote.py @@ -25,7 +25,7 @@ class CboeEquityQuoteQueryParams(EquityQuoteQueryParams): Source: https://www.cboe.com/ """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} use_cache: bool = Field( default=True, diff --git a/openbb_platform/providers/cboe/openbb_cboe/models/index_historical.py b/openbb_platform/providers/cboe/openbb_cboe/models/index_historical.py index ce468e2eafc4..38c579dd9e33 100644 --- a/openbb_platform/providers/cboe/openbb_cboe/models/index_historical.py +++ b/openbb_platform/providers/cboe/openbb_cboe/models/index_historical.py @@ -28,7 +28,7 @@ class CboeIndexHistoricalQueryParams(IndexHistoricalQueryParams): Source: https://www.cboe.com/ """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} interval: Literal["1m", "1d"] = Field( default="1d", diff --git a/openbb_platform/providers/econdb/openbb_econdb/models/country_profile.py b/openbb_platform/providers/econdb/openbb_econdb/models/country_profile.py index 20d156000385..00267d8e3de6 100644 --- a/openbb_platform/providers/econdb/openbb_econdb/models/country_profile.py +++ b/openbb_platform/providers/econdb/openbb_econdb/models/country_profile.py @@ -27,7 +27,7 @@ class EconDbCountryProfileQueryParams(CountryProfileQueryParams): """Country Profile Query.""" - __json_schema_extra__ = {"country": ["multiple_items_allowed"]} + __json_schema_extra__ = {"country": {"multiple_items_allowed": True}} latest: bool = Field( default=True, diff --git a/openbb_platform/providers/econdb/openbb_econdb/models/economic_indicators.py b/openbb_platform/providers/econdb/openbb_econdb/models/economic_indicators.py index ffbadbc0a674..0cd09ec3c858 100644 --- a/openbb_platform/providers/econdb/openbb_econdb/models/economic_indicators.py +++ b/openbb_platform/providers/econdb/openbb_econdb/models/economic_indicators.py @@ -24,8 +24,8 @@ class EconDbEconomicIndicatorsQueryParams(EconomicIndicatorsQueryParams): """EconDB Economic Indicators Query.""" __json_schema_extra__ = { - "symbol": ["multiple_items_allowed"], - "country": ["multiple_items_allowed"], + "symbol": {"multiple_items_allowed": True}, + "country": {"multiple_items_allowed": True}, } transform: Literal["toya", "tpop", "tusd", "tpgp"] = Field( diff --git a/openbb_platform/providers/finviz/openbb_finviz/models/equity_profile.py b/openbb_platform/providers/finviz/openbb_finviz/models/equity_profile.py index f6f29c1791a3..eb99529d54ce 100644 --- a/openbb_platform/providers/finviz/openbb_finviz/models/equity_profile.py +++ b/openbb_platform/providers/finviz/openbb_finviz/models/equity_profile.py @@ -22,7 +22,7 @@ class FinvizEquityProfileQueryParams(EquityInfoQueryParams): Source: https://finviz.com/screener.ashx """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class FinvizEquityProfileData(EquityInfoData): diff --git a/openbb_platform/providers/finviz/openbb_finviz/models/key_metrics.py b/openbb_platform/providers/finviz/openbb_finviz/models/key_metrics.py index ec7096dc6a17..96af9453d101 100644 --- a/openbb_platform/providers/finviz/openbb_finviz/models/key_metrics.py +++ b/openbb_platform/providers/finviz/openbb_finviz/models/key_metrics.py @@ -22,7 +22,7 @@ class FinvizKeyMetricsQueryParams(KeyMetricsQueryParams): Source: https://finviz.com/screener.ashx """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class FinvizKeyMetricsData(KeyMetricsData): diff --git a/openbb_platform/providers/finviz/openbb_finviz/models/price_performance.py b/openbb_platform/providers/finviz/openbb_finviz/models/price_performance.py index 020c43f88524..8a9cea94b0c3 100644 --- a/openbb_platform/providers/finviz/openbb_finviz/models/price_performance.py +++ b/openbb_platform/providers/finviz/openbb_finviz/models/price_performance.py @@ -21,7 +21,7 @@ class FinvizPricePerformanceQueryParams(RecentPerformanceQueryParams): Source: https://finviz.com/screener.ashx """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class FinvizPricePerformanceData(RecentPerformanceData): diff --git a/openbb_platform/providers/finviz/openbb_finviz/models/price_target.py b/openbb_platform/providers/finviz/openbb_finviz/models/price_target.py index e33c04037dd1..b3633510518d 100644 --- a/openbb_platform/providers/finviz/openbb_finviz/models/price_target.py +++ b/openbb_platform/providers/finviz/openbb_finviz/models/price_target.py @@ -23,7 +23,7 @@ class FinvizPriceTargetQueryParams(PriceTargetQueryParams): Source: https://finviz.com/quote.ashx? """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class FinvizPriceTargetData(PriceTargetData): diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/analyst_estimates.py b/openbb_platform/providers/fmp/openbb_fmp/models/analyst_estimates.py index 6d1e5c9e335e..72d0b49d03de 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/analyst_estimates.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/analyst_estimates.py @@ -22,7 +22,7 @@ class FMPAnalystEstimatesQueryParams(AnalystEstimatesQueryParams): Source: https://site.financialmodelingprep.com/developer/docs/analyst-estimates-api/ """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} period: Literal["quarter", "annual"] = Field( default="annual", description=QUERY_DESCRIPTIONS.get("period", "") diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/company_news.py b/openbb_platform/providers/fmp/openbb_fmp/models/company_news.py index b773a0177d80..13d62a26904f 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/company_news.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/company_news.py @@ -19,7 +19,7 @@ class FMPCompanyNewsQueryParams(CompanyNewsQueryParams): Source: https://site.financialmodelingprep.com/developer/docs/stock-news-api/ """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} page: Optional[int] = Field( default=0, diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/crypto_historical.py b/openbb_platform/providers/fmp/openbb_fmp/models/crypto_historical.py index 8486d46f69a3..ad528255c0df 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/crypto_historical.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/crypto_historical.py @@ -35,7 +35,7 @@ class FMPCryptoHistoricalQueryParams(CryptoHistoricalQueryParams): """ __alias_dict__ = {"start_date": "from", "end_date": "to"} - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} interval: Literal["1m", "5m", "15m", "30m", "1h", "4h", "1d"] = Field( default="1d", description=QUERY_DESCRIPTIONS.get("interval", "") diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/currency_historical.py b/openbb_platform/providers/fmp/openbb_fmp/models/currency_historical.py index 02fceedc5ee2..697c3d0395db 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/currency_historical.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/currency_historical.py @@ -33,7 +33,7 @@ class FMPCurrencyHistoricalQueryParams(CurrencyHistoricalQueryParams): """ __alias_dict__ = {"start_date": "from", "end_date": "to"} - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} interval: Literal["1m", "5m", "15m", "30m", "1h", "4h", "1d"] = Field( default="1d", description=QUERY_DESCRIPTIONS.get("interval", "") diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/currency_snapshots.py b/openbb_platform/providers/fmp/openbb_fmp/models/currency_snapshots.py index 6276e23ed737..dcc34f6beb43 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/currency_snapshots.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/currency_snapshots.py @@ -25,7 +25,7 @@ class FMPCurrencySnapshotsQueryParams(CurrencySnapshotsQueryParams): Source: https://site.financialmodelingprep.com/developer/docs#exchange-prices-quote """ - __json_schema_extra__ = {"base": ["multiple_items_allowed"]} + __json_schema_extra__ = {"base": {"multiple_items_allowed": True}} class FMPCurrencySnapshotsData(CurrencySnapshotsData): diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/equity_historical.py b/openbb_platform/providers/fmp/openbb_fmp/models/equity_historical.py index 5225a0daa183..fa4660c25ff6 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/equity_historical.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/equity_historical.py @@ -33,7 +33,7 @@ class FMPEquityHistoricalQueryParams(EquityHistoricalQueryParams): """ __alias_dict__ = {"start_date": "from", "end_date": "to"} - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} interval: Literal["1m", "5m", "15m", "30m", "1h", "4h", "1d"] = Field( default="1d", description=QUERY_DESCRIPTIONS.get("interval", "") diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/equity_profile.py b/openbb_platform/providers/fmp/openbb_fmp/models/equity_profile.py index 95a460fff792..015e3ad24977 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/equity_profile.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/equity_profile.py @@ -27,7 +27,7 @@ class FMPEquityProfileQueryParams(EquityInfoQueryParams): Source: https://site.financialmodelingprep.com/developer/docs/companies-key-stats-free-api/ """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class FMPEquityProfileData(EquityInfoData): @@ -48,7 +48,7 @@ class FMPEquityProfileData(EquityInfoData): "long_description": "description", "first_stock_price_date": "ipoDate", } - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} is_etf: bool = Field(description="If the symbol is an ETF.") is_actively_trading: bool = Field(description="If the company is actively trading.") diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/equity_quote.py b/openbb_platform/providers/fmp/openbb_fmp/models/equity_quote.py index 3830466770ad..824c9a31eafb 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/equity_quote.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/equity_quote.py @@ -29,7 +29,7 @@ class FMPEquityQuoteQueryParams(EquityQuoteQueryParams): Source: https://financialmodelingprep.com/developer/docs/#Stock-Historical-Price """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class FMPEquityQuoteData(EquityQuoteData): diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/equity_valuation_multiples.py b/openbb_platform/providers/fmp/openbb_fmp/models/equity_valuation_multiples.py index ea48b84b9db6..5a1b05ba503f 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/equity_valuation_multiples.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/equity_valuation_multiples.py @@ -22,7 +22,7 @@ class FMPEquityValuationMultiplesQueryParams(EquityValuationMultiplesQueryParams Source: https://site.financialmodelingprep.com/developer/docs/#Company-Key-Metrics """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class FMPEquityValuationMultiplesData(EquityValuationMultiplesData): diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/etf_countries.py b/openbb_platform/providers/fmp/openbb_fmp/models/etf_countries.py index 13803e791d22..5eea88402933 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/etf_countries.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/etf_countries.py @@ -18,7 +18,7 @@ class FMPEtfCountriesQueryParams(EtfCountriesQueryParams): """FMP ETF Countries Query.""" - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class FMPEtfCountriesData(EtfCountriesData): diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/etf_equity_exposure.py b/openbb_platform/providers/fmp/openbb_fmp/models/etf_equity_exposure.py index f204d2fa5e11..393702d87085 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/etf_equity_exposure.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/etf_equity_exposure.py @@ -24,7 +24,7 @@ class FMPEtfEquityExposureQueryParams(EtfEquityExposureQueryParams): Source: https://site.financialmodelingprep.com/developer/docs/etf-stock-exposure-api/ """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class FMPEtfEquityExposureData(EtfEquityExposureData): diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/etf_info.py b/openbb_platform/providers/fmp/openbb_fmp/models/etf_info.py index 21cfab00a8aa..fcb542886a9c 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/etf_info.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/etf_info.py @@ -18,7 +18,7 @@ class FMPEtfInfoQueryParams(EtfInfoQueryParams): """FMP ETF Info Query.""" - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class FMPEtfInfoData(EtfInfoData): diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/executive_compensation.py b/openbb_platform/providers/fmp/openbb_fmp/models/executive_compensation.py index 5914828ed024..358cab94c635 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/executive_compensation.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/executive_compensation.py @@ -25,7 +25,7 @@ class FMPExecutiveCompensationQueryParams(ExecutiveCompensationQueryParams): Source: https://site.financialmodelingprep.com/developer/docs/executive-compensation-api/ """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} year: Optional[int] = Field(default=None, description="Year of the compensation.") diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/forward_eps_estimates.py b/openbb_platform/providers/fmp/openbb_fmp/models/forward_eps_estimates.py index f0e2c5cdf60e..8a3a714e33c8 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/forward_eps_estimates.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/forward_eps_estimates.py @@ -25,7 +25,7 @@ class FMPForwardEpsEstimatesQueryParams(ForwardEpsEstimatesQueryParams): Source: https://site.financialmodelingprep.com/developer/docs/analyst-estimates-api/ """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} __alias_dict__ = {"fiscal_period": "period"} diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/index_historical.py b/openbb_platform/providers/fmp/openbb_fmp/models/index_historical.py index 33eabd6f5b3f..20a5523a1e21 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/index_historical.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/index_historical.py @@ -33,7 +33,7 @@ class FMPIndexHistoricalQueryParams(IndexHistoricalQueryParams): """ __alias_dict__ = {"start_date": "from", "end_date": "to"} - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} interval: Literal["1m", "5m", "15m", "30m", "1h", "4h", "1d"] = Field( default="1d", description=QUERY_DESCRIPTIONS.get("interval", "") diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/key_metrics.py b/openbb_platform/providers/fmp/openbb_fmp/models/key_metrics.py index 3f7f7b0ce3f9..124e2eb3f66a 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/key_metrics.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/key_metrics.py @@ -27,7 +27,7 @@ class FMPKeyMetricsQueryParams(KeyMetricsQueryParams): Source: https://site.financialmodelingprep.com/developer/docs/company-key-metrics-api/ """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} with_ttm: Optional[bool] = Field( default=False, description="Include trailing twelve months (TTM) data." diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/price_performance.py b/openbb_platform/providers/fmp/openbb_fmp/models/price_performance.py index aee89b084fb4..adc184131515 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/price_performance.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/price_performance.py @@ -19,7 +19,7 @@ class FMPPricePerformanceQueryParams(RecentPerformanceQueryParams): Source: https://site.financialmodelingprep.com/developer/docs/stock-split-calendar-api/ """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class FMPPricePerformanceData(RecentPerformanceData): diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/price_target.py b/openbb_platform/providers/fmp/openbb_fmp/models/price_target.py index 92589fc6c002..6c0ecede2070 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/price_target.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/price_target.py @@ -24,7 +24,7 @@ class FMPPriceTargetQueryParams(PriceTargetQueryParams): Source: https://site.financialmodelingprep.com/developer/docs/#Price-Target """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} with_grade: bool = Field( False, diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/price_target_consensus.py b/openbb_platform/providers/fmp/openbb_fmp/models/price_target_consensus.py index c087bed700f6..0cf0f8d3c54f 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/price_target_consensus.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/price_target_consensus.py @@ -23,7 +23,7 @@ class FMPPriceTargetConsensusQueryParams(PriceTargetConsensusQueryParams): Source: https://site.financialmodelingprep.com/developer/docs/price-target-consensus-api/ """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} @field_validator("symbol", mode="before", check_fields=False) @classmethod diff --git a/openbb_platform/providers/fred/openbb_fred/models/cpi.py b/openbb_platform/providers/fred/openbb_fred/models/cpi.py index 4a86e44869f0..c5878c8f9424 100644 --- a/openbb_platform/providers/fred/openbb_fred/models/cpi.py +++ b/openbb_platform/providers/fred/openbb_fred/models/cpi.py @@ -14,7 +14,7 @@ class FREDConsumerPriceIndexQueryParams(ConsumerPriceIndexQueryParams): """FRED Consumer Price Index Query.""" - __json_schema_extra__ = {"country": ["multiple_items_allowed"]} + __json_schema_extra__ = {"country": {"multiple_items_allowed": True}} class FREDConsumerPriceIndexData(ConsumerPriceIndexData): diff --git a/openbb_platform/providers/fred/openbb_fred/models/series.py b/openbb_platform/providers/fred/openbb_fred/models/series.py index 7c1108e73f3c..7f82eb60fcef 100644 --- a/openbb_platform/providers/fred/openbb_fred/models/series.py +++ b/openbb_platform/providers/fred/openbb_fred/models/series.py @@ -28,7 +28,7 @@ class FredSeriesQueryParams(SeriesQueryParams): "end_date": "observation_end", "transform": "units", } - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} frequency: Literal[ None, diff --git a/openbb_platform/providers/fred/openbb_fred/models/spot.py b/openbb_platform/providers/fred/openbb_fred/models/spot.py index 4db9cebe4e07..31747a67abb3 100644 --- a/openbb_platform/providers/fred/openbb_fred/models/spot.py +++ b/openbb_platform/providers/fred/openbb_fred/models/spot.py @@ -16,8 +16,8 @@ class FREDSpotRateQueryParams(SpotRateQueryParams): """FRED Spot Rate Query.""" __json_schema_extra__ = { - "maturity": ["multiple_items_allowed"], - "category": ["multiple_items_allowed"], + "maturity": {"multiple_items_allowed": True}, + "category": {"multiple_items_allowed": True}, } diff --git a/openbb_platform/providers/intrinio/openbb_intrinio/models/company_news.py b/openbb_platform/providers/intrinio/openbb_intrinio/models/company_news.py index d728cd3384dd..daee4f3c6c96 100644 --- a/openbb_platform/providers/intrinio/openbb_intrinio/models/company_news.py +++ b/openbb_platform/providers/intrinio/openbb_intrinio/models/company_news.py @@ -29,7 +29,7 @@ class IntrinioCompanyNewsQueryParams(CompanyNewsQueryParams): "limit": "page_size", "source": "specific_source", } - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} source: Optional[ Literal["yahoo", "moody", "moody_us_news", "moody_us_press_releases"] diff --git a/openbb_platform/providers/intrinio/openbb_intrinio/models/equity_info.py b/openbb_platform/providers/intrinio/openbb_intrinio/models/equity_info.py index 21c8d7d44aff..97e1f7d351c1 100644 --- a/openbb_platform/providers/intrinio/openbb_intrinio/models/equity_info.py +++ b/openbb_platform/providers/intrinio/openbb_intrinio/models/equity_info.py @@ -20,7 +20,7 @@ class IntrinioEquityInfoQueryParams(EquityInfoQueryParams): Source: https://docs.intrinio.com/documentation/web_api/get_company_v2 """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class IntrinioEquityInfoData(EquityInfoData): diff --git a/openbb_platform/providers/intrinio/openbb_intrinio/models/equity_quote.py b/openbb_platform/providers/intrinio/openbb_intrinio/models/equity_quote.py index fe8320bae103..4571a87e1f5c 100644 --- a/openbb_platform/providers/intrinio/openbb_intrinio/models/equity_quote.py +++ b/openbb_platform/providers/intrinio/openbb_intrinio/models/equity_quote.py @@ -27,7 +27,7 @@ class IntrinioEquityQuoteQueryParams(EquityQuoteQueryParams): Source: https://docs.intrinio.com/documentation/web_api/get_security_realtime_price_v2 """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} symbol: str = Field( description="A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)." diff --git a/openbb_platform/providers/intrinio/openbb_intrinio/models/etf_info.py b/openbb_platform/providers/intrinio/openbb_intrinio/models/etf_info.py index f5c275a571fe..cd6fc9608167 100644 --- a/openbb_platform/providers/intrinio/openbb_intrinio/models/etf_info.py +++ b/openbb_platform/providers/intrinio/openbb_intrinio/models/etf_info.py @@ -23,7 +23,7 @@ class IntrinioEtfInfoQueryParams(EtfInfoQueryParams): Source: https://docs.intrinio.com/documentation/web_api/get_etf_v2 """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class IntrinioEtfInfoData(EtfInfoData): diff --git a/openbb_platform/providers/intrinio/openbb_intrinio/models/etf_price_performance.py b/openbb_platform/providers/intrinio/openbb_intrinio/models/etf_price_performance.py index 8ea7e5c27c0f..927259102172 100644 --- a/openbb_platform/providers/intrinio/openbb_intrinio/models/etf_price_performance.py +++ b/openbb_platform/providers/intrinio/openbb_intrinio/models/etf_price_performance.py @@ -27,7 +27,7 @@ class IntrinioEtfPricePerformanceQueryParams(RecentPerformanceQueryParams): Source: https://docs.intrinio.com/documentation/web_api/get_etf_analytics_v2 """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} return_type: Literal["trailing", "calendar"] = Field( default="trailing", diff --git a/openbb_platform/providers/intrinio/openbb_intrinio/models/forward_eps_estimates.py b/openbb_platform/providers/intrinio/openbb_intrinio/models/forward_eps_estimates.py index 294428c3055f..3fab49a6684e 100644 --- a/openbb_platform/providers/intrinio/openbb_intrinio/models/forward_eps_estimates.py +++ b/openbb_platform/providers/intrinio/openbb_intrinio/models/forward_eps_estimates.py @@ -27,7 +27,7 @@ class IntrinioForwardEpsEstimatesQueryParams(ForwardEpsEstimatesQueryParams): https://docs.intrinio.com/documentation/web_api/get_zacks_sales_estimates_v2 """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} fiscal_year: Optional[int] = Field( default=None, diff --git a/openbb_platform/providers/intrinio/openbb_intrinio/models/forward_sales_estimates.py b/openbb_platform/providers/intrinio/openbb_intrinio/models/forward_sales_estimates.py index c57ad52cfcb5..b50259f00255 100644 --- a/openbb_platform/providers/intrinio/openbb_intrinio/models/forward_sales_estimates.py +++ b/openbb_platform/providers/intrinio/openbb_intrinio/models/forward_sales_estimates.py @@ -27,7 +27,7 @@ class IntrinioForwardSalesEstimatesQueryParams(ForwardSalesEstimatesQueryParams) https://docs.intrinio.com/documentation/web_api/get_zacks_sales_estimates_v2 """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} fiscal_year: Optional[int] = Field( default=None, diff --git a/openbb_platform/providers/intrinio/openbb_intrinio/models/historical_attributes.py b/openbb_platform/providers/intrinio/openbb_intrinio/models/historical_attributes.py index 7c83c3b8d999..b9558ea19c41 100644 --- a/openbb_platform/providers/intrinio/openbb_intrinio/models/historical_attributes.py +++ b/openbb_platform/providers/intrinio/openbb_intrinio/models/historical_attributes.py @@ -29,8 +29,8 @@ class IntrinioHistoricalAttributesQueryParams(HistoricalAttributesQueryParams): __alias_dict__ = {"sort": "sort_order", "limit": "page_size", "tag_type": "type"} __json_schema_extra__ = { - "tag": ["multiple_items_allowed"], - "symbol": ["multiple_items_allowed"], + "tag": {"multiple_items_allowed": True}, + "symbol": {"multiple_items_allowed": True}, } diff --git a/openbb_platform/providers/intrinio/openbb_intrinio/models/index_historical.py b/openbb_platform/providers/intrinio/openbb_intrinio/models/index_historical.py index fc32a1aee41d..33831a175687 100644 --- a/openbb_platform/providers/intrinio/openbb_intrinio/models/index_historical.py +++ b/openbb_platform/providers/intrinio/openbb_intrinio/models/index_historical.py @@ -23,7 +23,7 @@ class IntrinioIndexHistoricalQueryParams(IndexHistoricalQueryParams): """ __alias_dict__ = {"limit": "page_size", "sort": "sort_order"} - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} limit: Optional[int] = Field( default=10000, diff --git a/openbb_platform/providers/intrinio/openbb_intrinio/models/key_metrics.py b/openbb_platform/providers/intrinio/openbb_intrinio/models/key_metrics.py index 2dbecc4a0e30..37820cd35936 100644 --- a/openbb_platform/providers/intrinio/openbb_intrinio/models/key_metrics.py +++ b/openbb_platform/providers/intrinio/openbb_intrinio/models/key_metrics.py @@ -27,7 +27,7 @@ class IntrinioKeyMetricsQueryParams(KeyMetricsQueryParams): Source: https://data.intrinio.com/data-tags/ """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class IntrinioKeyMetricsData(KeyMetricsData): diff --git a/openbb_platform/providers/intrinio/openbb_intrinio/models/latest_attributes.py b/openbb_platform/providers/intrinio/openbb_intrinio/models/latest_attributes.py index 55cf7bc685db..3b0296d7de74 100644 --- a/openbb_platform/providers/intrinio/openbb_intrinio/models/latest_attributes.py +++ b/openbb_platform/providers/intrinio/openbb_intrinio/models/latest_attributes.py @@ -23,8 +23,8 @@ class IntrinioLatestAttributesQueryParams(LatestAttributesQueryParams): """ __json_schema_extra__ = { - "tag": ["multiple_items_allowed"], - "symbol": ["multiple_items_allowed"], + "tag": {"multiple_items_allowed": True}, + "symbol": {"multiple_items_allowed": True}, } diff --git a/openbb_platform/providers/intrinio/openbb_intrinio/models/price_target_consensus.py b/openbb_platform/providers/intrinio/openbb_intrinio/models/price_target_consensus.py index fcf1a99c4a47..fce965c4c7fc 100644 --- a/openbb_platform/providers/intrinio/openbb_intrinio/models/price_target_consensus.py +++ b/openbb_platform/providers/intrinio/openbb_intrinio/models/price_target_consensus.py @@ -27,7 +27,7 @@ class IntrinioPriceTargetConsensusQueryParams(PriceTargetConsensusQueryParams): https://docs.intrinio.com/documentation/web_api/get_zacks_sales__v2 """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} industry_group_number: Optional[int] = Field( default=None, diff --git a/openbb_platform/providers/nasdaq/openbb_nasdaq/models/economic_calendar.py b/openbb_platform/providers/nasdaq/openbb_nasdaq/models/economic_calendar.py index 34ca03ef7a51..f3422bed1067 100644 --- a/openbb_platform/providers/nasdaq/openbb_nasdaq/models/economic_calendar.py +++ b/openbb_platform/providers/nasdaq/openbb_nasdaq/models/economic_calendar.py @@ -22,7 +22,7 @@ class NasdaqEconomicCalendarQueryParams(EconomicCalendarQueryParams): Source: https://www.nasdaq.com/market-activity/economic-calendar """ - __json_schema_extra__ = {"country": ["multiple_items_allowed"]} + __json_schema_extra__ = {"country": {"multiple_items_allowed": True}} country: Optional[str] = Field( default=None, diff --git a/openbb_platform/providers/nasdaq/openbb_nasdaq/models/historical_dividends.py b/openbb_platform/providers/nasdaq/openbb_nasdaq/models/historical_dividends.py index 41dfde661d9b..e2efd476be06 100644 --- a/openbb_platform/providers/nasdaq/openbb_nasdaq/models/historical_dividends.py +++ b/openbb_platform/providers/nasdaq/openbb_nasdaq/models/historical_dividends.py @@ -24,7 +24,7 @@ class NasdaqHistoricalDividendsQueryParams(HistoricalDividendsQueryParams): """Nasdaq Historical Dividends Query Params.""" - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class NasdaqHistoricalDividendsData(HistoricalDividendsData): diff --git a/openbb_platform/providers/polygon/openbb_polygon/models/company_news.py b/openbb_platform/providers/polygon/openbb_polygon/models/company_news.py index b91e7f122391..d83207bc2a07 100644 --- a/openbb_platform/providers/polygon/openbb_polygon/models/company_news.py +++ b/openbb_platform/providers/polygon/openbb_polygon/models/company_news.py @@ -20,7 +20,7 @@ class PolygonCompanyNewsQueryParams(CompanyNewsQueryParams): Source: https://polygon.io/docs/stocks/get_v2_reference_news """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} __alias_dict__ = { "symbol": "ticker", "start_date": "published_utc.gte", diff --git a/openbb_platform/providers/polygon/openbb_polygon/models/crypto_historical.py b/openbb_platform/providers/polygon/openbb_polygon/models/crypto_historical.py index dc9bb95fe2b0..18ea66a3f61c 100644 --- a/openbb_platform/providers/polygon/openbb_polygon/models/crypto_historical.py +++ b/openbb_platform/providers/polygon/openbb_polygon/models/crypto_historical.py @@ -39,7 +39,7 @@ class PolygonCryptoHistoricalQueryParams(CryptoHistoricalQueryParams): Source: https://polygon.io/docs/crypto/get_v2_aggs_ticker__cryptoticker__range__multiplier___timespan___from___to """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} interval: str = Field( default="1d", diff --git a/openbb_platform/providers/polygon/openbb_polygon/models/currency_historical.py b/openbb_platform/providers/polygon/openbb_polygon/models/currency_historical.py index 9a4edcb98b46..9ccac0616fff 100644 --- a/openbb_platform/providers/polygon/openbb_polygon/models/currency_historical.py +++ b/openbb_platform/providers/polygon/openbb_polygon/models/currency_historical.py @@ -39,7 +39,7 @@ class PolygonCurrencyHistoricalQueryParams(CurrencyHistoricalQueryParams): Source: https://polygon.io/docs/forex/get_v2_aggs_ticker__forexticker__range__multiplier___timespan___from___to """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} interval: str = Field( default="1d", diff --git a/openbb_platform/providers/polygon/openbb_polygon/models/currency_snapshots.py b/openbb_platform/providers/polygon/openbb_polygon/models/currency_snapshots.py index 2ac7c3280e54..b476c6e9074e 100644 --- a/openbb_platform/providers/polygon/openbb_polygon/models/currency_snapshots.py +++ b/openbb_platform/providers/polygon/openbb_polygon/models/currency_snapshots.py @@ -23,7 +23,7 @@ class PolygonCurrencySnapshotsQueryParams(CurrencySnapshotsQueryParams): Source: https://polygon.io/docs/forex/get_v2_snapshot_locale_global_markets_forex_tickers """ - __json_schema_extra__ = {"base": ["multiple_items_allowed"]} + __json_schema_extra__ = {"base": {"multiple_items_allowed": True}} class PolygonCurrencySnapshotsData(CurrencySnapshotsData): diff --git a/openbb_platform/providers/polygon/openbb_polygon/models/equity_historical.py b/openbb_platform/providers/polygon/openbb_polygon/models/equity_historical.py index de818d61bfe7..ee30969dfb93 100644 --- a/openbb_platform/providers/polygon/openbb_polygon/models/equity_historical.py +++ b/openbb_platform/providers/polygon/openbb_polygon/models/equity_historical.py @@ -40,7 +40,7 @@ class PolygonEquityHistoricalQueryParams(EquityHistoricalQueryParams): Source: https://polygon.io/docs/stocks/getting-started """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} interval: str = Field( default="1d", diff --git a/openbb_platform/providers/polygon/openbb_polygon/models/index_historical.py b/openbb_platform/providers/polygon/openbb_polygon/models/index_historical.py index 74fa010e8416..77bdf95a4770 100644 --- a/openbb_platform/providers/polygon/openbb_polygon/models/index_historical.py +++ b/openbb_platform/providers/polygon/openbb_polygon/models/index_historical.py @@ -37,7 +37,7 @@ class PolygonIndexHistoricalQueryParams(IndexHistoricalQueryParams): Source: https://polygon.io/docs/indices/getting-started """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} interval: str = Field( default="1d", diff --git a/openbb_platform/providers/tiingo/openbb_tiingo/models/company_news.py b/openbb_platform/providers/tiingo/openbb_tiingo/models/company_news.py index c11e12f424da..a9aa3545f2c6 100644 --- a/openbb_platform/providers/tiingo/openbb_tiingo/models/company_news.py +++ b/openbb_platform/providers/tiingo/openbb_tiingo/models/company_news.py @@ -27,7 +27,7 @@ class TiingoCompanyNewsQueryParams(CompanyNewsQueryParams): "start_date": "startDate", "end_date": "endDate", } - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} offset: Optional[int] = Field( default=0, description="Page offset, used in conjunction with limit." diff --git a/openbb_platform/providers/tiingo/openbb_tiingo/models/crypto_historical.py b/openbb_platform/providers/tiingo/openbb_tiingo/models/crypto_historical.py index bd70bab32cd6..ac1ea2375b21 100644 --- a/openbb_platform/providers/tiingo/openbb_tiingo/models/crypto_historical.py +++ b/openbb_platform/providers/tiingo/openbb_tiingo/models/crypto_historical.py @@ -35,7 +35,7 @@ class TiingoCryptoHistoricalQueryParams(CryptoHistoricalQueryParams): "end_date": "endDate", "interval": "resampleFreq", } - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} interval: Literal["1m", "5m", "15m", "30m", "1h", "4h", "1d"] = Field( default="1d", description=QUERY_DESCRIPTIONS.get("interval", "") diff --git a/openbb_platform/providers/tiingo/openbb_tiingo/models/currency_historical.py b/openbb_platform/providers/tiingo/openbb_tiingo/models/currency_historical.py index aa0387cfd70d..d64070a1d6dc 100644 --- a/openbb_platform/providers/tiingo/openbb_tiingo/models/currency_historical.py +++ b/openbb_platform/providers/tiingo/openbb_tiingo/models/currency_historical.py @@ -35,7 +35,7 @@ class TiingoCurrencyHistoricalQueryParams(CurrencyHistoricalQueryParams): "end_date": "endDate", "interval": "resampleFreq", } - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} interval: Literal["1m", "5m", "15m", "30m", "1h", "4h", "1d"] = Field( default="1d", description=QUERY_DESCRIPTIONS.get("interval", "") diff --git a/openbb_platform/providers/tiingo/openbb_tiingo/models/equity_historical.py b/openbb_platform/providers/tiingo/openbb_tiingo/models/equity_historical.py index 401f1f14c011..56d538c89826 100644 --- a/openbb_platform/providers/tiingo/openbb_tiingo/models/equity_historical.py +++ b/openbb_platform/providers/tiingo/openbb_tiingo/models/equity_historical.py @@ -36,7 +36,7 @@ class TiingoEquityHistoricalQueryParams(EquityHistoricalQueryParams): "start_date": "startDate", "end_date": "endDate", } - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} interval: Literal["1d", "1W", "1M", "1Y"] = Field( default="1d", description=QUERY_DESCRIPTIONS.get("interval", "") diff --git a/openbb_platform/providers/tmx/openbb_tmx/models/company_news.py b/openbb_platform/providers/tmx/openbb_tmx/models/company_news.py index cc8fd504cdc4..b8d8664477f8 100644 --- a/openbb_platform/providers/tmx/openbb_tmx/models/company_news.py +++ b/openbb_platform/providers/tmx/openbb_tmx/models/company_news.py @@ -20,7 +20,7 @@ class TmxCompanyNewsQueryParams(CompanyNewsQueryParams): """TMX Stock News query.""" - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} page: Optional[int] = Field( default=1, description="The page number to start from. Use with limit." diff --git a/openbb_platform/providers/tmx/openbb_tmx/models/equity_historical.py b/openbb_platform/providers/tmx/openbb_tmx/models/equity_historical.py index f81c10e06f93..ac3fa3660cbb 100644 --- a/openbb_platform/providers/tmx/openbb_tmx/models/equity_historical.py +++ b/openbb_platform/providers/tmx/openbb_tmx/models/equity_historical.py @@ -44,7 +44,7 @@ class TmxEquityHistoricalQueryParams(EquityHistoricalQueryParams): source: https://money.tmx.com """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} interval: Union[ Literal["1m", "2m", "5m", "15m", "30m", "60m", "1h", "1d", "1W", "1M"], str, int diff --git a/openbb_platform/providers/tmx/openbb_tmx/models/equity_profile.py b/openbb_platform/providers/tmx/openbb_tmx/models/equity_profile.py index ddce1445ef71..de58b0daeb21 100644 --- a/openbb_platform/providers/tmx/openbb_tmx/models/equity_profile.py +++ b/openbb_platform/providers/tmx/openbb_tmx/models/equity_profile.py @@ -18,7 +18,7 @@ class TmxEquityProfileQueryParams(EquityInfoQueryParams): """TMX Equity Profile query params.""" - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class TmxEquityProfileData(EquityInfoData): diff --git a/openbb_platform/providers/tmx/openbb_tmx/models/equity_quote.py b/openbb_platform/providers/tmx/openbb_tmx/models/equity_quote.py index a97659e5f7a6..4f115d8a85df 100644 --- a/openbb_platform/providers/tmx/openbb_tmx/models/equity_quote.py +++ b/openbb_platform/providers/tmx/openbb_tmx/models/equity_quote.py @@ -28,7 +28,7 @@ class TmxEquityQuoteQueryParams(EquityQuoteQueryParams): """TMX Equity Profile query params.""" - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class TmxEquityQuoteData(EquityQuoteData): diff --git a/openbb_platform/providers/tmx/openbb_tmx/models/etf_countries.py b/openbb_platform/providers/tmx/openbb_tmx/models/etf_countries.py index 008b0d47103f..c135d804732f 100644 --- a/openbb_platform/providers/tmx/openbb_tmx/models/etf_countries.py +++ b/openbb_platform/providers/tmx/openbb_tmx/models/etf_countries.py @@ -20,7 +20,7 @@ class TmxEtfCountriesQueryParams(EtfCountriesQueryParams): """TMX ETF Countries Query Params""" - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} use_cache: bool = Field( default=True, diff --git a/openbb_platform/providers/tmx/openbb_tmx/models/etf_info.py b/openbb_platform/providers/tmx/openbb_tmx/models/etf_info.py index da1b720c9091..74503b81b283 100644 --- a/openbb_platform/providers/tmx/openbb_tmx/models/etf_info.py +++ b/openbb_platform/providers/tmx/openbb_tmx/models/etf_info.py @@ -16,7 +16,7 @@ class TmxEtfInfoQueryParams(EtfInfoQueryParams): """TMX ETF Info Query Params""" - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} use_cache: bool = Field( default=True, diff --git a/openbb_platform/providers/tmx/openbb_tmx/models/price_target_consensus.py b/openbb_platform/providers/tmx/openbb_tmx/models/price_target_consensus.py index 1ee9a9f71353..5ccc13985325 100644 --- a/openbb_platform/providers/tmx/openbb_tmx/models/price_target_consensus.py +++ b/openbb_platform/providers/tmx/openbb_tmx/models/price_target_consensus.py @@ -18,7 +18,7 @@ class TmxPriceTargetConsensusQueryParams(PriceTargetConsensusQueryParams): """TMX Price Target Consensus Query.""" - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} @field_validator("symbol", mode="before", check_fields=False) @classmethod diff --git a/openbb_platform/providers/tradier/openbb_tradier/models/equity_historical.py b/openbb_platform/providers/tradier/openbb_tradier/models/equity_historical.py index eed0d09d93a1..32b5bc1c7a6b 100644 --- a/openbb_platform/providers/tradier/openbb_tradier/models/equity_historical.py +++ b/openbb_platform/providers/tradier/openbb_tradier/models/equity_historical.py @@ -26,7 +26,7 @@ class TradierEquityHistoricalQueryParams(EquityHistoricalQueryParams): """Tradier Equity Historical Query.""" - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} interval: Literal["1m", "5m", "15m", "1d", "1W", "1M"] = Field( description=QUERY_DESCRIPTIONS.get("interval", ""), diff --git a/openbb_platform/providers/tradier/openbb_tradier/models/equity_quote.py b/openbb_platform/providers/tradier/openbb_tradier/models/equity_quote.py index d3a2abef9fa6..88829f5faaa2 100644 --- a/openbb_platform/providers/tradier/openbb_tradier/models/equity_quote.py +++ b/openbb_platform/providers/tradier/openbb_tradier/models/equity_quote.py @@ -24,7 +24,7 @@ class TradierEquityQuoteQueryParams(EquityQuoteQueryParams): """Tradier Equity Quote Query.""" - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class TradierEquityQuoteData(EquityQuoteData): diff --git a/openbb_platform/providers/tradingeconomics/openbb_tradingeconomics/models/economic_calendar.py b/openbb_platform/providers/tradingeconomics/openbb_tradingeconomics/models/economic_calendar.py index ec3d2ffac08d..25a2a0457986 100644 --- a/openbb_platform/providers/tradingeconomics/openbb_tradingeconomics/models/economic_calendar.py +++ b/openbb_platform/providers/tradingeconomics/openbb_tradingeconomics/models/economic_calendar.py @@ -41,7 +41,7 @@ class TEEconomicCalendarQueryParams(EconomicCalendarQueryParams): Source: https://docs.tradingeconomics.com/economic_calendar/ """ - __json_schema_extra__ = {"country": ["multiple_items_allowed"]} + __json_schema_extra__ = {"country": {"multiple_items_allowed": True}} # TODO: Probably want to figure out the list we can use. country: Optional[str] = Field(default=None, description="Country of the event.") diff --git a/openbb_platform/providers/yfinance/openbb_yfinance/models/company_news.py b/openbb_platform/providers/yfinance/openbb_yfinance/models/company_news.py index 29209ebd5b43..a313f63ff319 100644 --- a/openbb_platform/providers/yfinance/openbb_yfinance/models/company_news.py +++ b/openbb_platform/providers/yfinance/openbb_yfinance/models/company_news.py @@ -21,7 +21,7 @@ class YFinanceCompanyNewsQueryParams(CompanyNewsQueryParams): Source: https://finance.yahoo.com/news/ """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class YFinanceCompanyNewsData(CompanyNewsData): diff --git a/openbb_platform/providers/yfinance/openbb_yfinance/models/crypto_historical.py b/openbb_platform/providers/yfinance/openbb_yfinance/models/crypto_historical.py index e6958bcf5cbf..00ca5fd7b0ee 100644 --- a/openbb_platform/providers/yfinance/openbb_yfinance/models/crypto_historical.py +++ b/openbb_platform/providers/yfinance/openbb_yfinance/models/crypto_historical.py @@ -26,7 +26,7 @@ class YFinanceCryptoHistoricalQueryParams(CryptoHistoricalQueryParams): Source: https://finance.yahoo.com/crypto/ """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} interval: Literal[ "1m", diff --git a/openbb_platform/providers/yfinance/openbb_yfinance/models/currency_historical.py b/openbb_platform/providers/yfinance/openbb_yfinance/models/currency_historical.py index 1c93f165b1e7..af4d32791504 100644 --- a/openbb_platform/providers/yfinance/openbb_yfinance/models/currency_historical.py +++ b/openbb_platform/providers/yfinance/openbb_yfinance/models/currency_historical.py @@ -25,7 +25,7 @@ class YFinanceCurrencyHistoricalQueryParams(CurrencyHistoricalQueryParams): Source: https://finance.yahoo.com/currencies/ """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} interval: Literal[ "1m", diff --git a/openbb_platform/providers/yfinance/openbb_yfinance/models/equity_historical.py b/openbb_platform/providers/yfinance/openbb_yfinance/models/equity_historical.py index bf9dceecdb50..c7e5a2239db6 100644 --- a/openbb_platform/providers/yfinance/openbb_yfinance/models/equity_historical.py +++ b/openbb_platform/providers/yfinance/openbb_yfinance/models/equity_historical.py @@ -27,7 +27,7 @@ class YFinanceEquityHistoricalQueryParams(EquityHistoricalQueryParams): Source: https://finance.yahoo.com/ """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} interval: Literal[ "1m", diff --git a/openbb_platform/providers/yfinance/openbb_yfinance/models/equity_profile.py b/openbb_platform/providers/yfinance/openbb_yfinance/models/equity_profile.py index 7150bc7be502..ec1c3add6400 100644 --- a/openbb_platform/providers/yfinance/openbb_yfinance/models/equity_profile.py +++ b/openbb_platform/providers/yfinance/openbb_yfinance/models/equity_profile.py @@ -24,7 +24,7 @@ class YFinanceEquityProfileQueryParams(EquityInfoQueryParams): """YFinance Equity Profile Query.""" - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class YFinanceEquityProfileData(EquityInfoData): diff --git a/openbb_platform/providers/yfinance/openbb_yfinance/models/equity_quote.py b/openbb_platform/providers/yfinance/openbb_yfinance/models/equity_quote.py index a8a88b96e6c4..0e704cb2b5ec 100644 --- a/openbb_platform/providers/yfinance/openbb_yfinance/models/equity_quote.py +++ b/openbb_platform/providers/yfinance/openbb_yfinance/models/equity_quote.py @@ -19,7 +19,7 @@ class YFinanceEquityQuoteQueryParams(EquityQuoteQueryParams): """YFinance Equity Quote Query.""" - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class YFinanceEquityQuoteData(EquityQuoteData): diff --git a/openbb_platform/providers/yfinance/openbb_yfinance/models/etf_info.py b/openbb_platform/providers/yfinance/openbb_yfinance/models/etf_info.py index 915fb44bf4f5..5ff8b6490590 100644 --- a/openbb_platform/providers/yfinance/openbb_yfinance/models/etf_info.py +++ b/openbb_platform/providers/yfinance/openbb_yfinance/models/etf_info.py @@ -21,7 +21,7 @@ class YFinanceEtfInfoQueryParams(EtfInfoQueryParams): """YFinance ETF Info Query.""" - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class YFinanceEtfInfoData(EtfInfoData): diff --git a/openbb_platform/providers/yfinance/openbb_yfinance/models/futures_historical.py b/openbb_platform/providers/yfinance/openbb_yfinance/models/futures_historical.py index 55637fde0b72..f7715d2dcd66 100644 --- a/openbb_platform/providers/yfinance/openbb_yfinance/models/futures_historical.py +++ b/openbb_platform/providers/yfinance/openbb_yfinance/models/futures_historical.py @@ -26,7 +26,7 @@ class YFinanceFuturesHistoricalQueryParams(FuturesHistoricalQueryParams): Source: https://finance.yahoo.com/crypto/ """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} interval: Literal[ "1m", diff --git a/openbb_platform/providers/yfinance/openbb_yfinance/models/index_historical.py b/openbb_platform/providers/yfinance/openbb_yfinance/models/index_historical.py index ea1ea0d9fbb6..187ec915f7ba 100644 --- a/openbb_platform/providers/yfinance/openbb_yfinance/models/index_historical.py +++ b/openbb_platform/providers/yfinance/openbb_yfinance/models/index_historical.py @@ -29,7 +29,7 @@ class YFinanceIndexHistoricalQueryParams(IndexHistoricalQueryParams): Source: https://finance.yahoo.com/world-indices """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} interval: Literal[ "1m", diff --git a/openbb_platform/providers/yfinance/openbb_yfinance/models/key_metrics.py b/openbb_platform/providers/yfinance/openbb_yfinance/models/key_metrics.py index ae176d2d7631..8423f2c80856 100644 --- a/openbb_platform/providers/yfinance/openbb_yfinance/models/key_metrics.py +++ b/openbb_platform/providers/yfinance/openbb_yfinance/models/key_metrics.py @@ -19,7 +19,7 @@ class YFinanceKeyMetricsQueryParams(KeyMetricsQueryParams): """YFinance Key Metrics Query.""" - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class YFinanceKeyMetricsData(KeyMetricsData): diff --git a/openbb_platform/providers/yfinance/openbb_yfinance/models/market_indices.py b/openbb_platform/providers/yfinance/openbb_yfinance/models/market_indices.py index 163856a5cd3e..5b069b94a30e 100644 --- a/openbb_platform/providers/yfinance/openbb_yfinance/models/market_indices.py +++ b/openbb_platform/providers/yfinance/openbb_yfinance/models/market_indices.py @@ -27,7 +27,7 @@ class YFinanceMarketIndicesQueryParams(MarketIndicesQueryParams): Source: https://finance.yahoo.com/world-indices """ - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} interval: Optional[INTERVALS] = Field(default="1d", description="Data granularity.") period: Optional[PERIODS] = Field( diff --git a/openbb_platform/providers/yfinance/openbb_yfinance/models/price_target_consensus.py b/openbb_platform/providers/yfinance/openbb_yfinance/models/price_target_consensus.py index 15d628580fd9..3ee2e7d8f37c 100644 --- a/openbb_platform/providers/yfinance/openbb_yfinance/models/price_target_consensus.py +++ b/openbb_platform/providers/yfinance/openbb_yfinance/models/price_target_consensus.py @@ -19,7 +19,7 @@ class YFinancePriceTargetConsensusQueryParams(PriceTargetConsensusQueryParams): """YFinance Price Target Consensus Query.""" - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} @field_validator("symbol", mode="before", check_fields=False) @classmethod diff --git a/openbb_platform/providers/yfinance/openbb_yfinance/models/share_statistics.py b/openbb_platform/providers/yfinance/openbb_yfinance/models/share_statistics.py index d7dba5e4589e..e9035cb03dca 100644 --- a/openbb_platform/providers/yfinance/openbb_yfinance/models/share_statistics.py +++ b/openbb_platform/providers/yfinance/openbb_yfinance/models/share_statistics.py @@ -23,7 +23,7 @@ class YFinanceShareStatisticsQueryParams(ShareStatisticsQueryParams): """YFinance Share Statistics Query.""" - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} class YFinanceShareStatisticsData(ShareStatisticsData): From 6038db7455c6c8bf02f7d33105c9be4248957176 Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Wed, 8 May 2024 10:55:09 +0100 Subject: [PATCH 02/24] comments & details --- .pre-commit-config.yaml | 2 +- .../core/openbb_core/provider/registry_map.py | 16 +++++++++------- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index e16417a185ee..5f507829eedd 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -28,7 +28,7 @@ repos: types: [python] files: '^openbb_platform/.*\.py$' exclude: 'tests/.*\.py|openbb_platform/test_.*\.py' - args: ["--config=pyproject.toml"] + args: ["--config=ruff.toml"] - repo: https://github.com/codespell-project/codespell rev: v2.2.5 hooks: diff --git a/openbb_platform/core/openbb_core/provider/registry_map.py b/openbb_platform/core/openbb_core/provider/registry_map.py index a620fd6d45ee..4ea84b11e715 100644 --- a/openbb_platform/core/openbb_core/provider/registry_map.py +++ b/openbb_platform/core/openbb_core/provider/registry_map.py @@ -132,13 +132,13 @@ def _update_json_schema_extra( model_field.json_schema_extra[provider] = properties - # Register annotation for standard fields edited in the provider - for cf in set(standard_fields).intersection(set(extra_fields)): - if standard_fields[cf].json_schema_extra is None: - standard_fields[cf].json_schema_extra = {} - if extra_fields[cf].annotation != standard_fields[cf].annotation: - standard_fields[cf].json_schema_extra.setdefault(provider, {}).update( - {"annotation": extra_fields[cf].annotation} + # Register annotation for standard fields refined in the provider class + for f in set(standard_fields).intersection(set(extra_fields)): + if standard_fields[f].json_schema_extra is None: + standard_fields[f].json_schema_extra = {} + if extra_fields[f].annotation != standard_fields[f].annotation: + standard_fields[f].json_schema_extra.setdefault(provider, {}).update( + {"annotation": extra_fields[f].annotation} ) def _get_models(self, map_: MapType) -> List[str]: @@ -168,11 +168,13 @@ def _extract_info( name: field for name, field in c.model_fields.items() # This ensures fields inherited by c are discarded + # => Only fields defined in c are included if name in c.__annotations__ } if Path(getfile(c)).parent == STANDARD_MODELS_FOLDER: if not found_first_standard: + # If standard uses inheritance we just use the first docstring standard_info["docstring"] = c.__doc__ found_first_standard = True standard_info["fields"].update(fields) From 45d4f8d6aa6e53e19ee2afacf0295bc405375a9d Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Wed, 8 May 2024 13:31:03 +0100 Subject: [PATCH 03/24] fix: fix api & update docs website --- .../core/openbb_core/provider/registry_map.py | 9 ---- website/generate_platform_v4_markdown.py | 48 +++++++++---------- 2 files changed, 24 insertions(+), 33 deletions(-) diff --git a/openbb_platform/core/openbb_core/provider/registry_map.py b/openbb_platform/core/openbb_core/provider/registry_map.py index 4ea84b11e715..782761bc054f 100644 --- a/openbb_platform/core/openbb_core/provider/registry_map.py +++ b/openbb_platform/core/openbb_core/provider/registry_map.py @@ -132,15 +132,6 @@ def _update_json_schema_extra( model_field.json_schema_extra[provider] = properties - # Register annotation for standard fields refined in the provider class - for f in set(standard_fields).intersection(set(extra_fields)): - if standard_fields[f].json_schema_extra is None: - standard_fields[f].json_schema_extra = {} - if extra_fields[f].annotation != standard_fields[f].annotation: - standard_fields[f].json_schema_extra.setdefault(provider, {}).update( - {"annotation": extra_fields[f].annotation} - ) - def _get_models(self, map_: MapType) -> List[str]: """Get available models.""" return list(map_.keys()) diff --git a/website/generate_platform_v4_markdown.py b/website/generate_platform_v4_markdown.py index 083d14e0a3ee..55101930a35d 100644 --- a/website/generate_platform_v4_markdown.py +++ b/website/generate_platform_v4_markdown.py @@ -5,7 +5,7 @@ import shutil import subprocess from pathlib import Path -from typing import Dict, List +from typing import Dict, List, Optional from openbb_core.provider import standard_models from poetry.core.constraints.version import Version, VersionConstraint, parse_constraint @@ -141,7 +141,7 @@ def create_reference_markdown_intro( def create_reference_markdown_tabular_section( - parameters: Dict[str, List[Dict[str, str]]], heading: str + parameters: Dict[str, List[Dict[str, Optional[str]]]], heading: str ) -> str: """Create the tabular section for the markdown file. @@ -158,45 +158,41 @@ def create_reference_markdown_tabular_section( Tabular section for the markdown file """ - standard_params_list = [] tables_list = [] # params_list is a list of dictionaries containing the # information for all the parameters of the provider. for provider, params_list in parameters.items(): - # Exclude the standard parameters from the table - filtered_params = [ - {k: v for k, v in params.items() if k != "standard"} - for params in params_list - ] + + if provider != "standard": + result = {v.get("name"): v for v in parameters["standard"]} + provider_params = {v.get("name"): v for v in params_list} + result.update(provider_params) + params = [{**{"name": k}, **v} for k, v in result.items()] + else: + params = params_list # Exclude default and optional columns in the Data section - if heading == "Data": - filtered_params = [ - {k: v for k, v in params.items() if k not in ["default", "optional"]} - for params in filtered_params + filtered = ( + [ + {k: v for k, v in p.items() if k not in ["default", "optional"]} + for p in params ] - - if provider == "standard": - standard_params_list = filtered_params - else: - filtered_params = standard_params_list + filtered_params + if heading == "Data" + else params + ) # Parameter information for every provider is extracted from the dictionary # and joined to form a row of the table. # A `|` is added at the start and end of the row to create the table cell. - params_table_rows = [ - f"| {' | '.join(map(str, params.values()))} |" for params in filtered_params - ] - # All rows are joined to form the table. - params_table_rows_str = "\n".join(params_table_rows) + rows = "\n".join([f"| {' | '.join(map(str, p.values()))} |" for p in filtered]) if heading == "Parameters": tables_list.append( f"\n\n\n" "| Name | Type | Description | Default | Optional |\n" "| ---- | ---- | ----------- | ------- | -------- |\n" - f"{params_table_rows_str}\n" + f"{rows}\n" "\n" ) elif heading == "Data": @@ -204,7 +200,7 @@ def create_reference_markdown_tabular_section( f"\n\n\n" "| Name | Type | Description |\n" "| ---- | ---- | ----------- |\n" - f"{params_table_rows_str}\n" + f"{rows}\n" "\n" ) @@ -597,6 +593,10 @@ def generate_platform_markdown(paths: Dict) -> None: console.log(f"\n[INFO] Generating the markdown files for the {PLATFORM_DATA_MODELS_PATH} directory...") # fmt: skip for path, path_data in paths.items(): + + if path != "/equity/price/historical": + continue + reference_markdown_content = "" data_markdown_content = "" From 41167d6e9508a9d31546dac1c322e0fb20bb1eef Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Wed, 8 May 2024 13:35:07 +0100 Subject: [PATCH 04/24] ^ --- openbb_platform/core/openbb_core/app/static/package_builder.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/openbb_platform/core/openbb_core/app/static/package_builder.py b/openbb_platform/core/openbb_core/app/static/package_builder.py index c96a6c28c3a7..6e6c37d769e9 100644 --- a/openbb_platform/core/openbb_core/app/static/package_builder.py +++ b/openbb_platform/core/openbb_core/app/static/package_builder.py @@ -524,9 +524,6 @@ def get_extra(field: FieldInfo) -> dict: # Getting json_schema_extra without changing the original dict json_schema_extra = getattr(field_default, "json_schema_extra", {}).copy() json_schema_extra.pop("choices", None) - for v in json_schema_extra.values(): - if isinstance(v, dict): - v.pop("annotation", None) return json_schema_extra return {} From 95285171f3be1fdc2ef8a499a7870de6a4c0393b Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Wed, 8 May 2024 13:40:58 +0100 Subject: [PATCH 05/24] remove empty info --- .../core/openbb_core/provider/registry_map.py | 23 ++++++++++--------- openbb_platform/openbb/package/economy.py | 5 +--- .../openbb/package/equity_fundamental.py | 12 ---------- .../openbb/package/equity_price.py | 7 ------ openbb_platform/openbb/package/etf.py | 7 ------ openbb_platform/openbb/package/index.py | 4 +--- 6 files changed, 14 insertions(+), 44 deletions(-) diff --git a/openbb_platform/core/openbb_core/provider/registry_map.py b/openbb_platform/core/openbb_core/provider/registry_map.py index 782761bc054f..5a59afc83abd 100644 --- a/openbb_platform/core/openbb_core/provider/registry_map.py +++ b/openbb_platform/core/openbb_core/provider/registry_map.py @@ -120,17 +120,18 @@ def _update_json_schema_extra( extra_fields = model_map[provider]["QueryParams"]["fields"] for field, properties in getattr(model, "__json_schema_extra__", {}).items(): - if field in standard_fields: - model_field = standard_fields[field] - elif field in extra_fields: - model_field = extra_fields[field] - else: - continue - - if model_field.json_schema_extra is None: - model_field.json_schema_extra = {} - - model_field.json_schema_extra[provider] = properties + if properties: + if field in standard_fields: + model_field = standard_fields[field] + elif field in extra_fields: + model_field = extra_fields[field] + else: + continue + + if model_field.json_schema_extra is None: + model_field.json_schema_extra = {} + + model_field.json_schema_extra[provider] = properties def _get_models(self, map_: MapType) -> List[str]: """Get available models.""" diff --git a/openbb_platform/openbb/package/economy.py b/openbb_platform/openbb/package/economy.py index 449558f05c5b..566ee70b0c86 100644 --- a/openbb_platform/openbb/package/economy.py +++ b/openbb_platform/openbb/package/economy.py @@ -1026,10 +1026,7 @@ def fred_series( "limit": limit, }, extra_params=kwargs, - info={ - "symbol": {"fred": {"multiple_items_allowed": True}}, - "limit": {"fred": {}}, - }, + info={"symbol": {"fred": {"multiple_items_allowed": True}}}, ) ) diff --git a/openbb_platform/openbb/package/equity_fundamental.py b/openbb_platform/openbb/package/equity_fundamental.py index 8449ff71fe1c..60a853435705 100644 --- a/openbb_platform/openbb/package/equity_fundamental.py +++ b/openbb_platform/openbb/package/equity_fundamental.py @@ -403,9 +403,6 @@ def balance( "limit": limit, }, extra_params=kwargs, - info={ - "period": {"fmp": {}, "intrinio": {}, "polygon": {}, "yfinance": {}} - }, ) ) @@ -829,9 +826,6 @@ def cash( "limit": limit, }, extra_params=kwargs, - info={ - "period": {"fmp": {}, "intrinio": {}, "polygon": {}, "yfinance": {}} - }, ) ) @@ -1300,7 +1294,6 @@ def filings( "limit": limit, }, extra_params=kwargs, - info={"form_type": {"sec": {}}}, ) ) @@ -1951,9 +1944,6 @@ def income( "limit": limit, }, extra_params=kwargs, - info={ - "period": {"fmp": {}, "intrinio": {}, "polygon": {}, "yfinance": {}} - }, ) ) @@ -3221,7 +3211,6 @@ def ratios( "limit": limit, }, extra_params=kwargs, - info={"period": {"fmp": {}, "intrinio": {}}}, ) ) @@ -3324,7 +3313,6 @@ def reported_financials( "limit": limit, }, extra_params=kwargs, - info={"period": {"intrinio": {}}, "statement_type": {"intrinio": {}}}, ) ) diff --git a/openbb_platform/openbb/package/equity_price.py b/openbb_platform/openbb/package/equity_price.py index 21a4888478b8..d6a9d89f9c86 100644 --- a/openbb_platform/openbb/package/equity_price.py +++ b/openbb_platform/openbb/package/equity_price.py @@ -191,13 +191,6 @@ def historical( "tiingo": {"multiple_items_allowed": True}, "yfinance": {"multiple_items_allowed": True}, }, - "interval": { - "fmp": {}, - "intrinio": {}, - "polygon": {}, - "tiingo": {}, - "yfinance": {}, - }, "adjusted": {"deprecated": True}, "prepost": {"deprecated": True}, }, diff --git a/openbb_platform/openbb/package/etf.py b/openbb_platform/openbb/package/etf.py index 893c941a2c3e..e8d8b9f28e0d 100644 --- a/openbb_platform/openbb/package/etf.py +++ b/openbb_platform/openbb/package/etf.py @@ -355,13 +355,6 @@ def historical( "tiingo": {"multiple_items_allowed": True}, "yfinance": {"multiple_items_allowed": True}, }, - "interval": { - "fmp": {}, - "intrinio": {}, - "polygon": {}, - "tiingo": {}, - "yfinance": {}, - }, "adjusted": {"deprecated": True}, "prepost": {"deprecated": True}, }, diff --git a/openbb_platform/openbb/package/index.py b/openbb_platform/openbb/package/index.py index a5fe0bd92f6e..46f5881f8b4c 100644 --- a/openbb_platform/openbb/package/index.py +++ b/openbb_platform/openbb/package/index.py @@ -173,7 +173,6 @@ def constituents( "symbol": symbol, }, extra_params=kwargs, - info={"symbol": {"fmp": {}}}, ) ) @@ -305,8 +304,7 @@ def market( "intrinio": {"multiple_items_allowed": True}, "polygon": {"multiple_items_allowed": True}, "yfinance": {"multiple_items_allowed": True}, - }, - "interval": {"fmp": {}, "polygon": {}, "yfinance": {}}, + } }, ) ) From 3705fded6bf0ce6386d2247fe46b8a138b421dda Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Wed, 8 May 2024 13:46:59 +0100 Subject: [PATCH 06/24] descriptions --- .../openbb_core/app/provider_interface.py | 4 +--- openbb_platform/openbb/package/economy.py | 22 ++++++++--------- .../openbb/package/equity_estimates.py | 22 ++++++++--------- .../openbb/package/equity_fundamental.py | 24 +++++++++---------- .../openbb/package/equity_ownership.py | 4 ++-- .../openbb/package/equity_price.py | 4 ++-- openbb_platform/openbb/package/etf.py | 12 +++++----- .../openbb/package/fixedincome_corporate.py | 8 +++---- 8 files changed, 49 insertions(+), 51 deletions(-) diff --git a/openbb_platform/core/openbb_core/app/provider_interface.py b/openbb_platform/core/openbb_core/app/provider_interface.py index a4a47a0f2697..7232a9f7afe2 100644 --- a/openbb_platform/core/openbb_core/app/provider_interface.py +++ b/openbb_platform/core/openbb_core/app/provider_interface.py @@ -262,9 +262,7 @@ def _create_field( # For backwards compatibility, before this was a list providers.append(p) - if len(providers) == 1: - additional_description += " Multiple comma separated items allowed." - elif len(providers) > 1: + if providers: additional_description += ( " Multiple comma separated items allowed for provider(s): " + ", ".join(providers) # type: ignore[arg-type] diff --git a/openbb_platform/openbb/package/economy.py b/openbb_platform/openbb/package/economy.py index 566ee70b0c86..ef18e9117dab 100644 --- a/openbb_platform/openbb/package/economy.py +++ b/openbb_platform/openbb/package/economy.py @@ -155,7 +155,7 @@ def calendar( If None, the provider specified in defaults is selected or 'fmp' if there is no default. country : Optional[str] - Country of the event. Multiple comma separated items allowed. (provider: tradingeconomics) + Country of the event. Multiple comma separated items allowed for provider(s): tradingeconomics. (provider: tradingeconomics) importance : Optional[Literal['Low', 'Medium', 'High']] Importance of the event. (provider: tradingeconomics) group : Optional[Literal['interest rate', 'inflation', 'bonds', 'consumer', 'gdp', 'government', 'housing', 'labour', 'markets', 'money', 'prices', 'trade', 'business']] @@ -339,7 +339,7 @@ def country_profile( country: Annotated[ Union[str, List[str]], OpenBBField( - description="The country to get data. Multiple comma separated items allowed." + description="The country to get data. Multiple comma separated items allowed for provider(s): econdb." ), ], provider: Annotated[ @@ -355,7 +355,7 @@ def country_profile( Parameters ---------- country : Union[str, List[str]] - The country to get data. Multiple comma separated items allowed. + The country to get data. Multiple comma separated items allowed for provider(s): econdb. provider : Optional[Literal['econdb']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'econdb' if there is @@ -443,7 +443,7 @@ def cpi( country: Annotated[ Union[str, List[str]], OpenBBField( - description="The country to get data. Multiple comma separated items allowed.", + description="The country to get data. Multiple comma separated items allowed for provider(s): fred.", choices=[ "australia", "austria", @@ -536,7 +536,7 @@ def cpi( Parameters ---------- country : Union[str, List[str]] - The country to get data. Multiple comma separated items allowed. + The country to get data. Multiple comma separated items allowed for provider(s): fred. units : Literal['growth_previous', 'growth_same', 'index_2015'] The unit of measurement for the data. Options: @@ -894,7 +894,7 @@ def fred_series( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fred." ), ], start_date: Annotated[ @@ -922,7 +922,7 @@ def fred_series( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed. + Symbol to get data for. Multiple comma separated items allowed for provider(s): fred. start_date : Union[datetime.date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] @@ -1044,13 +1044,13 @@ def indicators( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Multiple comma separated items allowed." + description="Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Multiple comma separated items allowed for provider(s): econdb." ), ], country: Annotated[ Union[str, None, List[Optional[str]]], OpenBBField( - description="The country to get data. The country represented by the indicator, if available. Multiple comma separated items allowed." + description="The country to get data. The country represented by the indicator, if available. Multiple comma separated items allowed for provider(s): econdb." ), ] = None, start_date: Annotated[ @@ -1074,9 +1074,9 @@ def indicators( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Multiple comma separated items allowed. + Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Multiple comma separated items allowed for provider(s): econdb. country : Union[str, None, List[Optional[str]]] - The country to get data. The country represented by the indicator, if available. Multiple comma separated items allowed. + The country to get data. The country represented by the indicator, if available. Multiple comma separated items allowed for provider(s): econdb. start_date : Union[datetime.date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] diff --git a/openbb_platform/openbb/package/equity_estimates.py b/openbb_platform/openbb/package/equity_estimates.py index bfe7da2a2549..d69c7f3f5443 100644 --- a/openbb_platform/openbb/package/equity_estimates.py +++ b/openbb_platform/openbb/package/equity_estimates.py @@ -30,13 +30,13 @@ def analyst_search( analyst_name: Annotated[ Union[str, None, List[Optional[str]]], OpenBBField( - description="Analyst names to return. Omitting will return all available analysts. Multiple comma separated items allowed." + description="Analyst names to return. Omitting will return all available analysts. Multiple comma separated items allowed for provider(s): benzinga." ), ] = None, firm_name: Annotated[ Union[str, None, List[Optional[str]]], OpenBBField( - description="Firm names to return. Omitting will return all available firms. Multiple comma separated items allowed." + description="Firm names to return. Omitting will return all available firms. Multiple comma separated items allowed for provider(s): benzinga." ), ] = None, provider: Annotated[ @@ -52,23 +52,23 @@ def analyst_search( Parameters ---------- analyst_name : Union[str, None, List[Optional[str]]] - Analyst names to return. Omitting will return all available analysts. Multiple comma separated items allowed. + Analyst names to return. Omitting will return all available analysts. Multiple comma separated items allowed for provider(s): benzinga. firm_name : Union[str, None, List[Optional[str]]] - Firm names to return. Omitting will return all available firms. Multiple comma separated items allowed. + Firm names to return. Omitting will return all available firms. Multiple comma separated items allowed for provider(s): benzinga. provider : Optional[Literal['benzinga']] 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. analyst_ids : Optional[str] - List of analyst IDs to return. Multiple comma separated items allowed. (provider: benzinga) + List of analyst IDs to return. Multiple comma separated items allowed for provider(s): benzinga. (provider: benzinga) firm_ids : Optional[str] - Firm IDs to return. Multiple comma separated items allowed. (provider: benzinga) + Firm IDs to return. Multiple comma separated items allowed for provider(s): benzinga. (provider: benzinga) limit : Optional[int] Number of results returned. Limit 1000. (provider: benzinga) page : Optional[int] Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. (provider: benzinga) fields : Optional[str] - Fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple comma separated items allowed. (provider: benzinga) + Fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple comma separated items allowed for provider(s): benzinga. (provider: benzinga) Returns ------- @@ -475,7 +475,7 @@ def forward_sales( symbol: Annotated[ Union[str, None, List[Optional[str]]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio." ), ] = None, provider: Annotated[ @@ -491,7 +491,7 @@ def forward_sales( Parameters ---------- symbol : Union[str, None, List[Optional[str]]] - Symbol to get data for. Multiple comma separated items allowed. + Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio. provider : Optional[Literal['intrinio']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is @@ -598,7 +598,7 @@ def historical( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." ), ], provider: Annotated[ @@ -614,7 +614,7 @@ def historical( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed. + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. provider : Optional[Literal['fmp']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is diff --git a/openbb_platform/openbb/package/equity_fundamental.py b/openbb_platform/openbb/package/equity_fundamental.py index 60a853435705..4d3833b06523 100644 --- a/openbb_platform/openbb/package/equity_fundamental.py +++ b/openbb_platform/openbb/package/equity_fundamental.py @@ -1304,13 +1304,13 @@ def historical_attributes( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio." ), ], tag: Annotated[ Union[str, List[str]], OpenBBField( - description="Intrinio data tag ID or code. Multiple comma separated items allowed." + description="Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio." ), ], start_date: Annotated[ @@ -1348,9 +1348,9 @@ def historical_attributes( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed. + Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio. tag : Union[str, List[str]] - Intrinio data tag ID or code. Multiple comma separated items allowed. + Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio. start_date : Union[datetime.date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] @@ -2090,13 +2090,13 @@ def latest_attributes( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio." ), ], tag: Annotated[ Union[str, List[str]], OpenBBField( - description="Intrinio data tag ID or code. Multiple comma separated items allowed." + description="Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio." ), ], provider: Annotated[ @@ -2112,9 +2112,9 @@ def latest_attributes( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed. + Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio. tag : Union[str, List[str]] - Intrinio data tag ID or code. Multiple comma separated items allowed. + Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio. provider : Optional[Literal['intrinio']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is @@ -2260,7 +2260,7 @@ def management_compensation( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." ), ], provider: Annotated[ @@ -2276,7 +2276,7 @@ def management_compensation( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed. + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. provider : Optional[Literal['fmp']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is @@ -2685,7 +2685,7 @@ def multiples( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." ), ], provider: Annotated[ @@ -2701,7 +2701,7 @@ def multiples( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed. + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. provider : Optional[Literal['fmp']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is diff --git a/openbb_platform/openbb/package/equity_ownership.py b/openbb_platform/openbb/package/equity_ownership.py index 26341a562a55..c9806627f8e5 100644 --- a/openbb_platform/openbb/package/equity_ownership.py +++ b/openbb_platform/openbb/package/equity_ownership.py @@ -590,7 +590,7 @@ def share_statistics( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): yfinance." ), ], provider: Annotated[ @@ -606,7 +606,7 @@ def share_statistics( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed. + Symbol to get data for. Multiple comma separated items allowed for provider(s): yfinance. provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is diff --git a/openbb_platform/openbb/package/equity_price.py b/openbb_platform/openbb/package/equity_price.py index d6a9d89f9c86..a4327717d3d1 100644 --- a/openbb_platform/openbb/package/equity_price.py +++ b/openbb_platform/openbb/package/equity_price.py @@ -310,7 +310,7 @@ def performance( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." ), ], provider: Annotated[ @@ -326,7 +326,7 @@ def performance( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed. + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. provider : Optional[Literal['fmp']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is diff --git a/openbb_platform/openbb/package/etf.py b/openbb_platform/openbb/package/etf.py index e8d8b9f28e0d..5609ba550160 100644 --- a/openbb_platform/openbb/package/etf.py +++ b/openbb_platform/openbb/package/etf.py @@ -37,7 +37,7 @@ def countries( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. (ETF) Multiple comma separated items allowed." + description="Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp." ), ], provider: Annotated[ @@ -53,7 +53,7 @@ def countries( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. (ETF) Multiple comma separated items allowed. + Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp. provider : Optional[Literal['fmp']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is @@ -109,7 +109,7 @@ def equity_exposure( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. (Stock) Multiple comma separated items allowed." + description="Symbol to get data for. (Stock) Multiple comma separated items allowed for provider(s): fmp." ), ], provider: Annotated[ @@ -125,7 +125,7 @@ def equity_exposure( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. (Stock) Multiple comma separated items allowed. + Symbol to get data for. (Stock) Multiple comma separated items allowed for provider(s): fmp. provider : Optional[Literal['fmp']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is @@ -703,7 +703,7 @@ def holdings_performance( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." ), ], provider: Annotated[ @@ -719,7 +719,7 @@ def holdings_performance( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed. + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. provider : Optional[Literal['fmp']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is diff --git a/openbb_platform/openbb/package/fixedincome_corporate.py b/openbb_platform/openbb/package/fixedincome_corporate.py index 1298263d4bcf..47da6e18862e 100644 --- a/openbb_platform/openbb/package/fixedincome_corporate.py +++ b/openbb_platform/openbb/package/fixedincome_corporate.py @@ -427,13 +427,13 @@ def spot_rates( maturity: Annotated[ Union[float, str, List[Union[float, str]]], OpenBBField( - description="Maturities in years. Multiple comma separated items allowed." + description="Maturities in years. Multiple comma separated items allowed for provider(s): fred." ), ] = 10.0, category: Annotated[ Union[str, List[str]], OpenBBField( - description="Rate category. Options: spot_rate, par_yield. Multiple comma separated items allowed.", + description="Rate category. Options: spot_rate, par_yield. Multiple comma separated items allowed for provider(s): fred.", choices=["par_yield", "spot_rate"], ), ] = "spot_rate", @@ -460,9 +460,9 @@ def spot_rates( end_date : Union[datetime.date, None, str] End date of the data, in YYYY-MM-DD format. maturity : Union[float, str, List[Union[float, str]]] - Maturities in years. Multiple comma separated items allowed. + Maturities in years. Multiple comma separated items allowed for provider(s): fred. category : Union[str, List[str]] - Rate category. Options: spot_rate, par_yield. Multiple comma separated items allowed. + Rate category. Options: spot_rate, par_yield. Multiple comma separated items allowed for provider(s): fred. provider : Optional[Literal['fred']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is From e24b21317a5a92d677a048b8cf1799b4fd780994 Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Wed, 8 May 2024 13:50:06 +0100 Subject: [PATCH 07/24] descriptions --- .../core/openbb_core/app/provider_interface.py | 13 ++++++++----- openbb_platform/openbb/package/economy.py | 2 +- openbb_platform/openbb/package/equity_estimates.py | 6 +++--- 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/openbb_platform/core/openbb_core/app/provider_interface.py b/openbb_platform/core/openbb_core/app/provider_interface.py index 7232a9f7afe2..11bb21d5f776 100644 --- a/openbb_platform/core/openbb_core/app/provider_interface.py +++ b/openbb_platform/core/openbb_core/app/provider_interface.py @@ -263,11 +263,14 @@ def _create_field( providers.append(p) if providers: - additional_description += ( - " Multiple comma separated items allowed for provider(s): " - + ", ".join(providers) # type: ignore[arg-type] - + "." - ) + if provider_name: + additional_description += " Multiple comma separated items allowed." + else: + additional_description += ( + " Multiple comma separated items allowed for provider(s): " + + ", ".join(providers) # type: ignore[arg-type] + + "." + ) provider_field = ( f"(provider: {provider_name})" if provider_name != "openbb" else "" diff --git a/openbb_platform/openbb/package/economy.py b/openbb_platform/openbb/package/economy.py index ef18e9117dab..81ce2527b8f8 100644 --- a/openbb_platform/openbb/package/economy.py +++ b/openbb_platform/openbb/package/economy.py @@ -155,7 +155,7 @@ def calendar( If None, the provider specified in defaults is selected or 'fmp' if there is no default. country : Optional[str] - Country of the event. Multiple comma separated items allowed for provider(s): tradingeconomics. (provider: tradingeconomics) + Country of the event. Multiple comma separated items allowed. (provider: tradingeconomics) importance : Optional[Literal['Low', 'Medium', 'High']] Importance of the event. (provider: tradingeconomics) group : Optional[Literal['interest rate', 'inflation', 'bonds', 'consumer', 'gdp', 'government', 'housing', 'labour', 'markets', 'money', 'prices', 'trade', 'business']] diff --git a/openbb_platform/openbb/package/equity_estimates.py b/openbb_platform/openbb/package/equity_estimates.py index d69c7f3f5443..01b95add7a5d 100644 --- a/openbb_platform/openbb/package/equity_estimates.py +++ b/openbb_platform/openbb/package/equity_estimates.py @@ -60,15 +60,15 @@ def analyst_search( If None, the provider specified in defaults is selected or 'benzinga' if there is no default. analyst_ids : Optional[str] - List of analyst IDs to return. Multiple comma separated items allowed for provider(s): benzinga. (provider: benzinga) + List of analyst IDs to return. Multiple comma separated items allowed. (provider: benzinga) firm_ids : Optional[str] - Firm IDs to return. Multiple comma separated items allowed for provider(s): benzinga. (provider: benzinga) + Firm IDs to return. Multiple comma separated items allowed. (provider: benzinga) limit : Optional[int] Number of results returned. Limit 1000. (provider: benzinga) page : Optional[int] Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. (provider: benzinga) fields : Optional[str] - Fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple comma separated items allowed for provider(s): benzinga. (provider: benzinga) + Fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple comma separated items allowed. (provider: benzinga) Returns ------- From 85aa27c6c3f383b7ff581e54aeba73812fe763df Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Wed, 8 May 2024 14:01:24 +0100 Subject: [PATCH 08/24] fix reference.json --- .../openbb_core/app/static/package_builder.py | 22 ++- openbb_platform/openbb/assets/reference.json | 172 +++++++++--------- 2 files changed, 102 insertions(+), 92 deletions(-) diff --git a/openbb_platform/core/openbb_core/app/static/package_builder.py b/openbb_platform/core/openbb_core/app/static/package_builder.py index 6e6c37d769e9..5db17483a191 100644 --- a/openbb_platform/core/openbb_core/app/static/package_builder.py +++ b/openbb_platform/core/openbb_core/app/static/package_builder.py @@ -1458,6 +1458,10 @@ def _get_provider_field_params( expanded_types = MethodDefinition.TYPE_EXPANSION model_map = cls.pi.map[model] + # TODO: Change this to read the package data instead of pi.map directly + # We change some items (types, descriptions), so the reference.json + # does not reflect entirely the package code. + for field, field_info in model_map[provider][params_type]["fields"].items(): # Determine the field type, expanding it if necessary and if params_type is "Parameters" field_type = field_info.annotation @@ -1478,12 +1482,18 @@ def _get_provider_field_params( ) # fmt: skip # Add information for the providers supporting multiple symbols - if params_type == "QueryParams" and field_info.json_schema_extra: - multiple_items_list = field_info.json_schema_extra.get( - "multiple_items_allowed", None - ) - if multiple_items_list: - multiple_items = ", ".join(multiple_items_list) + if params_type == "QueryParams" and (extra := field_info.json_schema_extra): + + providers = [] + for p, v in extra.items(): # type: ignore[union-attr] + if isinstance(v, dict) and v.get("multiple_items_allowed"): + providers.append(p) + elif isinstance(v, list) and "multiple_items_allowed" in v: + # For backwards compatibility, before this was a list + providers.append(p) + + if providers: + multiple_items = ", ".join(providers) cleaned_description += ( f" Multiple items allowed for provider(s): {multiple_items}." ) diff --git a/openbb_platform/openbb/assets/reference.json b/openbb_platform/openbb/assets/reference.json index 3af8ae342e88..b0396af7d989 100644 --- a/openbb_platform/openbb/assets/reference.json +++ b/openbb_platform/openbb/assets/reference.json @@ -47,8 +47,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", "default": "", "optional": false }, @@ -432,8 +432,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", "default": "", "optional": false }, @@ -963,8 +963,8 @@ "standard": [ { "name": "base", - "type": "str", - "description": "The base currency symbol.", + "type": "Union[str, List[str]]", + "description": "The base currency symbol. Multiple items allowed for provider(s): fmp, polygon.", "default": "usd", "optional": true }, @@ -1915,8 +1915,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", "default": "", "optional": false }, @@ -2589,8 +2589,8 @@ "tradingeconomics": [ { "name": "country", - "type": "str", - "description": "Country of the event.", + "type": "Union[str, List[str]]", + "description": "Country of the event. Multiple items allowed for provider(s): tradingeconomics.", "default": null, "optional": true }, @@ -2884,8 +2884,8 @@ "standard": [ { "name": "country", - "type": "str", - "description": "The country to get data.", + "type": "Union[str, List[str]]", + "description": "The country to get data. Multiple items allowed for provider(s): fred.", "default": "", "optional": false }, @@ -3418,8 +3418,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fred.", "default": "", "optional": false }, @@ -4479,8 +4479,8 @@ "standard": [ { "name": "country", - "type": "str", - "description": "The country to get data.", + "type": "Union[str, List[str]]", + "description": "The country to get data. Multiple items allowed for provider(s): econdb.", "default": "", "optional": false }, @@ -4915,15 +4915,15 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.).", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Multiple items allowed for provider(s): econdb.", "default": "", "optional": false }, { "name": "country", - "type": "str", - "description": "The country to get data. The country represented by the indicator, if available.", + "type": "Union[str, List[str]]", + "description": "The country to get data. The country represented by the indicator, if available. Multiple items allowed for provider(s): econdb.", "default": null, "optional": true }, @@ -5894,8 +5894,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp.", "default": null, "optional": true }, @@ -6249,8 +6249,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": "", "optional": false }, @@ -6635,8 +6635,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": null, "optional": true }, @@ -6889,15 +6889,15 @@ "standard": [ { "name": "analyst_name", - "type": "str", - "description": "Analyst names to return. Omitting will return all available analysts.", + "type": "Union[str, List[str]]", + "description": "Analyst names to return. Omitting will return all available analysts. Multiple items allowed for provider(s): benzinga.", "default": null, "optional": true }, { "name": "firm_name", - "type": "str", - "description": "Firm names to return. Omitting will return all available firms.", + "type": "Union[str, List[str]]", + "description": "Firm names to return. Omitting will return all available firms. Multiple items allowed for provider(s): benzinga.", "default": null, "optional": true }, @@ -6912,15 +6912,15 @@ "benzinga": [ { "name": "analyst_ids", - "type": "str", - "description": "List of analyst IDs to return.", + "type": "Union[str, List[str]]", + "description": "List of analyst IDs to return. Multiple items allowed for provider(s): benzinga.", "default": null, "optional": true }, { "name": "firm_ids", - "type": "str", - "description": "Firm IDs to return.", + "type": "Union[str, List[str]]", + "description": "Firm IDs to return. Multiple items allowed for provider(s): benzinga.", "default": null, "optional": true }, @@ -6940,8 +6940,8 @@ }, { "name": "fields", - "type": "str", - "description": "Fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields.", + "type": "Union[str, List[str]]", + "description": "Fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple items allowed for provider(s): benzinga.", "default": null, "optional": true } @@ -7387,8 +7387,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", "default": null, "optional": true }, @@ -7633,8 +7633,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", "default": null, "optional": true }, @@ -9081,8 +9081,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": "", "optional": false }, @@ -14527,15 +14527,15 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", "default": "", "optional": false }, { "name": "tag", - "type": "str", - "description": "Intrinio data tag ID or code.", + "type": "Union[str, List[str]]", + "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", "default": "", "optional": false }, @@ -14654,15 +14654,15 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", "default": "", "optional": false }, { "name": "tag", - "type": "str", - "description": "Intrinio data tag ID or code.", + "type": "Union[str, List[str]]", + "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", "default": "", "optional": false }, @@ -16727,8 +16727,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": "", "optional": false }, @@ -17980,8 +17980,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": "", "optional": false }, @@ -21683,8 +21683,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", "default": "", "optional": false }, @@ -22127,8 +22127,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": "", "optional": false }, @@ -22774,8 +22774,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", "default": "", "optional": false }, @@ -23267,8 +23267,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": "", "optional": false }, @@ -24052,8 +24052,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": "", "optional": false }, @@ -25236,8 +25236,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", "default": "", "optional": false }, @@ -25729,8 +25729,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for. (ETF)", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": "", "optional": false }, @@ -27048,8 +27048,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for. (ETF)", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp.", "default": "", "optional": false }, @@ -27133,8 +27133,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", "default": "", "optional": false }, @@ -28443,8 +28443,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": "", "optional": false }, @@ -28640,8 +28640,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for. (Stock)", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp.", "default": "", "optional": false }, @@ -31031,15 +31031,15 @@ }, { "name": "maturity", - "type": "Union[float, str]", - "description": "Maturities in years.", + "type": "Union[Union[float, str], List[Union[float, str]]]", + "description": "Maturities in years. Multiple items allowed for provider(s): fred.", "default": 10.0, "optional": true }, { "name": "category", - "type": "str", - "description": "Rate category. Options: spot_rate, par_yield.", + "type": "Union[str, List[str]]", + "description": "Rate category. Options: spot_rate, par_yield. Multiple items allowed for provider(s): fred.", "default": "spot_rate", "optional": true }, @@ -31419,8 +31419,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, polygon, yfinance.", "default": "", "optional": false }, @@ -31712,8 +31712,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, polygon, yfinance.", "default": "", "optional": false }, @@ -32722,8 +32722,8 @@ "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, yfinance.", "default": null, "optional": true }, From c2a369d331725864a38f6d186961961e2e9072de Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Wed, 8 May 2024 14:12:29 +0100 Subject: [PATCH 09/24] remove debug code --- website/generate_platform_v4_markdown.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/website/generate_platform_v4_markdown.py b/website/generate_platform_v4_markdown.py index 55101930a35d..9343841f9366 100644 --- a/website/generate_platform_v4_markdown.py +++ b/website/generate_platform_v4_markdown.py @@ -594,9 +594,6 @@ def generate_platform_markdown(paths: Dict) -> None: for path, path_data in paths.items(): - if path != "/equity/price/historical": - continue - reference_markdown_content = "" data_markdown_content = "" From c656d19a45b415bb8d0567c6b668a1dca10038f5 Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Wed, 8 May 2024 14:13:01 +0100 Subject: [PATCH 10/24] remove debug code --- website/generate_platform_v4_markdown.py | 1 - 1 file changed, 1 deletion(-) diff --git a/website/generate_platform_v4_markdown.py b/website/generate_platform_v4_markdown.py index 9343841f9366..4f6111140fc0 100644 --- a/website/generate_platform_v4_markdown.py +++ b/website/generate_platform_v4_markdown.py @@ -593,7 +593,6 @@ def generate_platform_markdown(paths: Dict) -> None: console.log(f"\n[INFO] Generating the markdown files for the {PLATFORM_DATA_MODELS_PATH} directory...") # fmt: skip for path, path_data in paths.items(): - reference_markdown_content = "" data_markdown_content = "" From 063cea3cf75727eaa87b8e848becabe89552b365 Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Wed, 8 May 2024 14:24:11 +0100 Subject: [PATCH 11/24] docstring --- .../openbb_core/provider/abstract/query_params.py | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/openbb_platform/core/openbb_core/provider/abstract/query_params.py b/openbb_platform/core/openbb_core/provider/abstract/query_params.py index acca98737678..1f1e86ca99ea 100644 --- a/openbb_platform/core/openbb_core/provider/abstract/query_params.py +++ b/openbb_platform/core/openbb_core/provider/abstract/query_params.py @@ -19,22 +19,23 @@ class QueryParams(BaseModel): Merge different json schema extra, identified by provider. Example: FMP fetcher: - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} Intrinio fetcher - __json_schema_extra__ = {"symbol": ["multiple_items_allowed"]} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": False}} - Creates a new field in the `symbol` schema with: + Creates new fields in the `symbol` schema: { ..., - "multiple_items_allowed": ["fmp", "intrinio"], + "fmp": {"multiple_items_allowed": True}, + "intrinio": {"multiple_items_allowed": False} ..., } Multiple fields can be tagged with the same or multiple properties. Example: __json_schema_extra__ = { - "": ["some_prop", "another_prop"], - "": ["yet_another_prop"] + "": {"foo": 123, "bar": 456}, + "": {"foo": 789} } Attributes: From 6081b5ef1646413045873de9045171ff6cf67ecc Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Wed, 8 May 2024 14:26:03 +0100 Subject: [PATCH 12/24] docstring --- .../core/openbb_core/provider/abstract/query_params.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/openbb_platform/core/openbb_core/provider/abstract/query_params.py b/openbb_platform/core/openbb_core/provider/abstract/query_params.py index 1f1e86ca99ea..be10b82f2f37 100644 --- a/openbb_platform/core/openbb_core/provider/abstract/query_params.py +++ b/openbb_platform/core/openbb_core/provider/abstract/query_params.py @@ -19,13 +19,14 @@ class QueryParams(BaseModel): Merge different json schema extra, identified by provider. Example: FMP fetcher: - __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}} Intrinio fetcher - __json_schema_extra__ = {"symbol": {"multiple_items_allowed": False}} + __json_schema_extra__ = {"symbol": {"multiple_items_allowed": False}} Creates new fields in the `symbol` schema: { - ..., + "type": "string", + "description": "Symbol to get data for.", "fmp": {"multiple_items_allowed": True}, "intrinio": {"multiple_items_allowed": False} ..., From 4c63b2fccaad2151216a023e885ce5200abd7733 Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Wed, 8 May 2024 16:51:53 +0100 Subject: [PATCH 13/24] fix: standard fields propagate to providers --- .../core/openbb_core/provider/registry_map.py | 11 +- openbb_platform/openbb/assets/reference.json | 22713 ++++++---------- 2 files changed, 8708 insertions(+), 14016 deletions(-) diff --git a/openbb_platform/core/openbb_core/provider/registry_map.py b/openbb_platform/core/openbb_core/provider/registry_map.py index 5a59afc83abd..12ea7ba13dab 100644 --- a/openbb_platform/core/openbb_core/provider/registry_map.py +++ b/openbb_platform/core/openbb_core/provider/registry_map.py @@ -156,12 +156,19 @@ def _extract_info( if c.__name__ in SKIP: continue + parent = c.__mro__[1] if c.__mro__[1] not in SKIP else BaseModel + fields = { name: field for name, field in c.model_fields.items() - # This ensures fields inherited by c are discarded - # => Only fields defined in c are included + # This ensures fields inherited by c are discarded. + # We need to compare child and parent __annotations__ + # because this attribute is redirected to the parent class + # when the model simply inherits the parent and does not + # define any attributes. + # TLDR: Only fields defined in c are included if name in c.__annotations__ + and c.__annotations__ is not parent.__annotations__ } if Path(getfile(c)).parent == STANDARD_MODELS_FOLDER: diff --git a/openbb_platform/openbb/assets/reference.json b/openbb_platform/openbb/assets/reference.json index f362b1ee5b31..3e074b04332d 100644 --- a/openbb_platform/openbb/assets/reference.json +++ b/openbb_platform/openbb/assets/reference.json @@ -261,57 +261,7 @@ "optional": true } ], - "yfinance": [ - { - "name": "date", - "type": "Union[date, datetime]", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "open", - "type": "float", - "description": "The open price.", - "default": "", - "optional": false - }, - { - "name": "high", - "type": "float", - "description": "The high price.", - "default": "", - "optional": false - }, - { - "name": "low", - "type": "float", - "description": "The low price.", - "default": "", - "optional": false - }, - { - "name": "close", - "type": "float", - "description": "The close price.", - "default": "", - "optional": false - }, - { - "name": "volume", - "type": "float", - "description": "The trading volume.", - "default": "", - "optional": false - }, - { - "name": "vwap", - "type": "Annotated[float, Gt(gt=0)]", - "description": "Volume Weighted Average Price over the period.", - "default": null, - "optional": true - } - ] + "yfinance": [] }, "model": "CryptoHistorical" }, @@ -339,15 +289,7 @@ "optional": true } ], - "fmp": [ - { - "name": "query", - "type": "str", - "description": "Search query.", - "default": null, - "optional": true - } - ] + "fmp": [] }, "returns": { "OBBject": [ @@ -623,108 +565,8 @@ "optional": true } ], - "tiingo": [ - { - "name": "date", - "type": "Union[date, datetime]", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "open", - "type": "float", - "description": "The open price.", - "default": "", - "optional": false - }, - { - "name": "high", - "type": "float", - "description": "The high price.", - "default": "", - "optional": false - }, - { - "name": "low", - "type": "float", - "description": "The low price.", - "default": "", - "optional": false - }, - { - "name": "close", - "type": "float", - "description": "The close price.", - "default": "", - "optional": false - }, - { - "name": "volume", - "type": "float", - "description": "The trading volume.", - "default": null, - "optional": true - }, - { - "name": "vwap", - "type": "Annotated[float, Gt(gt=0)]", - "description": "Volume Weighted Average Price over the period.", - "default": null, - "optional": true - } - ], - "yfinance": [ - { - "name": "date", - "type": "Union[date, datetime]", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "open", - "type": "float", - "description": "The open price.", - "default": "", - "optional": false - }, - { - "name": "high", - "type": "float", - "description": "The high price.", - "default": "", - "optional": false - }, - { - "name": "low", - "type": "float", - "description": "The low price.", - "default": "", - "optional": false - }, - { - "name": "close", - "type": "float", - "description": "The close price.", - "default": "", - "optional": false - }, - { - "name": "volume", - "type": "float", - "description": "The trading volume.", - "default": null, - "optional": true - }, - { - "name": "vwap", - "type": "Annotated[float, Gt(gt=0)]", - "description": "Volume Weighted Average Price over the period.", - "default": null, - "optional": true - } - ] + "tiingo": [], + "yfinance": [] }, "model": "CurrencyHistorical" }, @@ -990,52 +832,8 @@ "optional": true } ], - "fmp": [ - { - "name": "base", - "type": "str", - "description": "The base currency symbol.", - "default": "usd", - "optional": true - }, - { - "name": "quote_type", - "type": "Literal['direct', 'indirect']", - "description": "Whether the quote is direct or indirect. Selecting 'direct' will return the exchange rate as the amount of domestic currency required to buy one unit of the foreign currency. Selecting 'indirect' (default) will return the exchange rate as the amount of foreign currency required to buy one unit of the domestic currency.", - "default": "indirect", - "optional": true - }, - { - "name": "counter_currencies", - "type": "Union[List[str], str]", - "description": "An optional list of counter currency symbols to filter for. None returns all.", - "default": null, - "optional": true - } - ], - "polygon": [ - { - "name": "base", - "type": "str", - "description": "The base currency symbol.", - "default": "usd", - "optional": true - }, - { - "name": "quote_type", - "type": "Literal['direct', 'indirect']", - "description": "Whether the quote is direct or indirect. Selecting 'direct' will return the exchange rate as the amount of domestic currency required to buy one unit of the foreign currency. Selecting 'indirect' (default) will return the exchange rate as the amount of foreign currency required to buy one unit of the domestic currency.", - "default": "indirect", - "optional": true - }, - { - "name": "counter_currencies", - "type": "Union[List[str], str]", - "description": "An optional list of counter currency symbols to filter for. None returns all.", - "default": null, - "optional": true - } - ] + "fmp": [], + "polygon": [] }, "returns": { "OBBject": [ @@ -2033,50 +1831,7 @@ "optional": false } ], - "yfinance": [ - { - "name": "date", - "type": "datetime", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "open", - "type": "float", - "description": "The open price.", - "default": "", - "optional": false - }, - { - "name": "high", - "type": "float", - "description": "The high price.", - "default": "", - "optional": false - }, - { - "name": "low", - "type": "float", - "description": "The low price.", - "default": "", - "optional": false - }, - { - "name": "close", - "type": "float", - "description": "The close price.", - "default": "", - "optional": false - }, - { - "name": "volume", - "type": "float", - "description": "The trading volume.", - "default": "", - "optional": false - } - ] + "yfinance": [] }, "model": "FuturesHistorical" }, @@ -2111,22 +1866,7 @@ "optional": true } ], - "yfinance": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", - "default": null, - "optional": true - } - ] + "yfinance": [] }, "returns": { "OBBject": [ @@ -2174,22 +1914,7 @@ "optional": true } ], - "yfinance": [ - { - "name": "expiration", - "type": "str", - "description": "Futures expiration month.", - "default": "", - "optional": false - }, - { - "name": "price", - "type": "float", - "description": "The close price.", - "default": null, - "optional": true - } - ] + "yfinance": [] }, "model": "FuturesCurve" }, @@ -2294,22 +2019,7 @@ "optional": true } ], - "oecd": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": null, - "optional": true - }, - { - "name": "value", - "type": "float", - "description": "Nominal GDP value on the date.", - "default": null, - "optional": true - } - ] + "oecd": [] }, "model": "GdpForecast" }, @@ -2407,22 +2117,7 @@ "optional": true } ], - "oecd": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": null, - "optional": true - }, - { - "name": "value", - "type": "float", - "description": "Nominal GDP value on the date.", - "default": null, - "optional": true - } - ] + "oecd": [] }, "model": "GdpNominal" }, @@ -2520,22 +2215,7 @@ "optional": true } ], - "oecd": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": null, - "optional": true - }, - { - "name": "value", - "type": "float", - "description": "Nominal GDP value on the date.", - "default": null, - "optional": true - } - ] + "oecd": [] }, "model": "GdpReal" }, @@ -2570,22 +2250,7 @@ "optional": true } ], - "fmp": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - } - ], + "fmp": [], "tradingeconomics": [ { "name": "country", @@ -2770,106 +2435,7 @@ "optional": true } ], - "tradingeconomics": [ - { - "name": "date", - "type": "datetime", - "description": "The date of the data.", - "default": null, - "optional": true - }, - { - "name": "country", - "type": "str", - "description": "Country of event.", - "default": null, - "optional": true - }, - { - "name": "event", - "type": "str", - "description": "Event name.", - "default": null, - "optional": true - }, - { - "name": "reference", - "type": "str", - "description": "Abbreviated period for which released data refers to.", - "default": null, - "optional": true - }, - { - "name": "source", - "type": "str", - "description": "Source of the data.", - "default": null, - "optional": true - }, - { - "name": "sourceurl", - "type": "str", - "description": "Source URL.", - "default": null, - "optional": true - }, - { - "name": "actual", - "type": "Union[str, float]", - "description": "Latest released value.", - "default": null, - "optional": true - }, - { - "name": "previous", - "type": "Union[str, float]", - "description": "Value for the previous period after the revision (if revision is applicable).", - "default": null, - "optional": true - }, - { - "name": "consensus", - "type": "Union[str, float]", - "description": "Average forecast among a representative group of economists.", - "default": null, - "optional": true - }, - { - "name": "forecast", - "type": "Union[str, float]", - "description": "Trading Economics projections", - "default": null, - "optional": true - }, - { - "name": "url", - "type": "str", - "description": "Trading Economics URL", - "default": null, - "optional": true - }, - { - "name": "importance", - "type": "Union[Literal[0, 1, 2, 3], str]", - "description": "Importance of the event. 1-Low, 2-Medium, 3-High", - "default": null, - "optional": true - }, - { - "name": "currency", - "type": "str", - "description": "Currency of the data.", - "default": null, - "optional": true - }, - { - "name": "unit", - "type": "str", - "description": "Unit of the data.", - "default": null, - "optional": true - } - ] + "tradingeconomics": [] }, "model": "EconomicCalendar" }, @@ -2932,50 +2498,7 @@ "optional": true } ], - "fred": [ - { - "name": "country", - "type": "str", - "description": "The country to get data.", - "default": "", - "optional": false - }, - { - "name": "units", - "type": "Literal['growth_previous', 'growth_same', 'index_2015']", - "description": "The unit of measurement for the data. Options: - `growth_previous`: Percent growth from the previous period. If monthly data, this is month-over-month, etc - `growth_same`: Percent growth from the same period in the previous year. If looking at monthly data, this would be year-over-year, etc. - `index_2015`: Rescaled index value, such that the value in 2015 is 100.", - "default": "growth_same", - "optional": true - }, - { - "name": "frequency", - "type": "Literal['monthly', 'quarter', 'annual']", - "description": "The frequency of the data. Options: `monthly`, `quarter`, and `annual`.", - "default": "monthly", - "optional": true - }, - { - "name": "harmonized", - "type": "bool", - "description": "Whether you wish to obtain harmonized data.", - "default": false, - "optional": true - }, - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - } - ] + "fred": [] }, "returns": { "OBBject": [ @@ -3016,15 +2539,7 @@ "optional": false } ], - "fred": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - } - ] + "fred": [] }, "model": "ConsumerPriceIndex" }, @@ -3107,36 +2622,7 @@ "optional": true } ], - "fmp": [ - { - "name": "country", - "type": "str", - "description": "Market country.", - "default": "", - "optional": false - }, - { - "name": "continent", - "type": "str", - "description": "Continent of the country.", - "default": null, - "optional": true - }, - { - "name": "total_equity_risk_premium", - "type": "Annotated[float, Gt(gt=0)]", - "description": "Total equity risk premium for the country.", - "default": null, - "optional": true - }, - { - "name": "country_risk_premium", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Country-specific risk premium.", - "default": null, - "optional": true - } - ] + "fmp": [] }, "model": "RiskPremium" }, @@ -3538,15 +3024,7 @@ "optional": false } ], - "fred": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - } - ], + "fred": [], "intrinio": [ { "name": "value", @@ -3597,29 +3075,7 @@ "optional": true } ], - "federal_reserve": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "adjusted", - "type": "bool", - "description": "Whether to return seasonally adjusted data.", - "default": true, - "optional": true - } - ] + "federal_reserve": [] }, "returns": { "OBBject": [ @@ -3709,64 +3165,7 @@ "optional": true } ], - "federal_reserve": [ - { - "name": "month", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "M1", - "type": "float", - "description": "Value of the M1 money supply in billions.", - "default": "", - "optional": false - }, - { - "name": "M2", - "type": "float", - "description": "Value of the M2 money supply in billions.", - "default": "", - "optional": false - }, - { - "name": "currency", - "type": "float", - "description": "Value of currency in circulation in billions.", - "default": null, - "optional": true - }, - { - "name": "demand_deposits", - "type": "float", - "description": "Value of demand deposits in billions.", - "default": null, - "optional": true - }, - { - "name": "retail_money_market_funds", - "type": "float", - "description": "Value of retail money market funds in billions.", - "default": null, - "optional": true - }, - { - "name": "other_liquid_deposits", - "type": "float", - "description": "Value of other liquid deposits in billions.", - "default": null, - "optional": true - }, - { - "name": "small_denomination_time_deposits", - "type": "float", - "description": "Value of small denomination time deposits in billions.", - "default": null, - "optional": true - } - ] + "federal_reserve": [] }, "model": "MoneyMeasures" }, @@ -3892,29 +3291,7 @@ "optional": true } ], - "oecd": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": null, - "optional": true - }, - { - "name": "value", - "type": "float", - "description": "Unemployment rate (given as a whole number, i.e 10=10%)", - "default": null, - "optional": true - }, - { - "name": "country", - "type": "str", - "description": "Country for which unemployment rate is given", - "default": null, - "optional": true - } - ] + "oecd": [] }, "model": "Unemployment" }, @@ -4012,29 +3389,7 @@ "optional": true } ], - "oecd": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": null, - "optional": true - }, - { - "name": "value", - "type": "float", - "description": "CLI value", - "default": null, - "optional": true - }, - { - "name": "country", - "type": "str", - "description": "Country for which CLI is given", - "default": null, - "optional": true - } - ] + "oecd": [] }, "model": "CLI" }, @@ -4139,29 +3494,7 @@ "optional": true } ], - "oecd": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": null, - "optional": true - }, - { - "name": "value", - "type": "float", - "description": "Interest rate (given as a whole number, i.e 10=10%)", - "default": null, - "optional": true - }, - { - "name": "country", - "type": "str", - "description": "Country for which interest rate is given", - "default": null, - "optional": true - } - ] + "oecd": [] }, "model": "STIR" }, @@ -4266,29 +3599,7 @@ "optional": true } ], - "oecd": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": null, - "optional": true - }, - { - "name": "value", - "type": "float", - "description": "Interest rate (given as a whole number, i.e 10=10%)", - "default": null, - "optional": true - }, - { - "name": "country", - "type": "str", - "description": "Country for which interest rate is given", - "default": null, - "optional": true - } - ] + "oecd": [] }, "model": "LTIR" }, @@ -4639,142 +3950,43 @@ "optional": true } ], - "econdb": [ - { - "name": "country", - "type": "str", - "description": "", - "default": "", - "optional": false - }, + "econdb": [] + }, + "model": "CountryProfile" + }, + "/economy/available_indicators": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the available economic indicators for a provider.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.available_indicators(provider='econdb')\n```\n\n", + "parameters": { + "standard": [ { - "name": "population", - "type": "int", - "description": "Population.", - "default": null, + "name": "provider", + "type": "Literal['econdb']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'econdb' if there is no default.", + "default": "econdb", "optional": true - }, + } + ], + "econdb": [ { - "name": "gdp_usd", - "type": "float", - "description": "Gross Domestic Product, in billions of USD.", - "default": null, + "name": "use_cache", + "type": "bool", + "description": "Whether to use cache or not, by default is True The cache of indicator symbols will persist for one week.", + "default": true, "optional": true - }, - { - "name": "gdp_qoq", - "type": "float", - "description": "GDP growth quarter-over-quarter change, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "gdp_yoy", - "type": "float", - "description": "GDP growth year-over-year change, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "cpi_yoy", - "type": "float", - "description": "Consumer Price Index year-over-year change, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "core_yoy", - "type": "float", - "description": "Core Consumer Price Index year-over-year change, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "retail_sales_yoy", - "type": "float", - "description": "Retail Sales year-over-year change, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "industrial_production_yoy", - "type": "float", - "description": "Industrial Production year-over-year change, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "policy_rate", - "type": "float", - "description": "Short term policy rate, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "yield_10y", - "type": "float", - "description": "10-year government bond yield, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "govt_debt_gdp", - "type": "float", - "description": "Government debt as a percent (normalized) of GDP.", - "default": null, - "optional": true - }, - { - "name": "current_account_gdp", - "type": "float", - "description": "Current account balance as a percent (normalized) of GDP.", - "default": null, - "optional": true - }, - { - "name": "jobless_rate", - "type": "float", - "description": "Unemployment rate, as a normalized percent.", - "default": null, - "optional": true - } - ] - }, - "model": "CountryProfile" - }, - "/economy/available_indicators": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the available economic indicators for a provider.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.available_indicators(provider='econdb')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "provider", - "type": "Literal['econdb']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'econdb' if there is no default.", - "default": "econdb", - "optional": true - } - ], - "econdb": [ - { - "name": "use_cache", - "type": "bool", - "description": "Whether to use cache or not, by default is True The cache of indicator symbols will persist for one week.", - "default": true, - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[AvailableIndicators]", - "description": "Serializable results." + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[AvailableIndicators]", + "description": "Serializable results." }, { "name": "provider", @@ -5040,43 +4252,7 @@ "optional": true } ], - "econdb": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "symbol_root", - "type": "str", - "description": "The root symbol for the indicator (e.g. GDP).", - "default": null, - "optional": true - }, - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": null, - "optional": true - }, - { - "name": "country", - "type": "str", - "description": "The country represented by the data.", - "default": null, - "optional": true - }, - { - "name": "value", - "type": "Union[int, float]", - "description": "", - "default": null, - "optional": true - } - ] + "econdb": [] }, "model": "EconomicIndicators" }, @@ -5371,22 +4547,7 @@ "optional": true } ], - "fmp": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - } - ] + "fmp": [] }, "returns": { "OBBject": [ @@ -5519,22 +4680,7 @@ "optional": true } ], - "fmp": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - } - ] + "fmp": [] }, "returns": { "OBBject": [ @@ -5603,43 +4749,7 @@ "optional": false } ], - "fmp": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "label", - "type": "str", - "description": "Label of the stock splits.", - "default": "", - "optional": false - }, - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "numerator", - "type": "float", - "description": "Numerator of the stock splits.", - "default": "", - "optional": false - }, - { - "name": "denominator", - "type": "float", - "description": "Denominator of the stock splits.", - "default": "", - "optional": false - } - ] + "fmp": [] }, "model": "CalendarSplits" }, @@ -5674,22 +4784,7 @@ "optional": true } ], - "fmp": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - } - ] + "fmp": [] }, "returns": { "OBBject": [ @@ -5829,15 +4924,7 @@ "optional": true } ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - } - ] + "fmp": [] }, "returns": { "OBBject": [ @@ -5878,15 +4965,7 @@ "optional": true } ], - "fmp": [ - { - "name": "peers_list", - "type": "List[str]", - "description": "A list of equity peers based on sector, exchange and market cap.", - "default": "", - "optional": true - } - ] + "fmp": [] }, "model": "EquityPeers" }, @@ -6472,162 +5551,7 @@ "optional": true } ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "estimated_revenue_low", - "type": "int", - "description": "Estimated revenue low.", - "default": null, - "optional": true - }, - { - "name": "estimated_revenue_high", - "type": "int", - "description": "Estimated revenue high.", - "default": null, - "optional": true - }, - { - "name": "estimated_revenue_avg", - "type": "int", - "description": "Estimated revenue average.", - "default": null, - "optional": true - }, - { - "name": "estimated_sga_expense_low", - "type": "int", - "description": "Estimated SGA expense low.", - "default": null, - "optional": true - }, - { - "name": "estimated_sga_expense_high", - "type": "int", - "description": "Estimated SGA expense high.", - "default": null, - "optional": true - }, - { - "name": "estimated_sga_expense_avg", - "type": "int", - "description": "Estimated SGA expense average.", - "default": null, - "optional": true - }, - { - "name": "estimated_ebitda_low", - "type": "int", - "description": "Estimated EBITDA low.", - "default": null, - "optional": true - }, - { - "name": "estimated_ebitda_high", - "type": "int", - "description": "Estimated EBITDA high.", - "default": null, - "optional": true - }, - { - "name": "estimated_ebitda_avg", - "type": "int", - "description": "Estimated EBITDA average.", - "default": null, - "optional": true - }, - { - "name": "estimated_ebit_low", - "type": "int", - "description": "Estimated EBIT low.", - "default": null, - "optional": true - }, - { - "name": "estimated_ebit_high", - "type": "int", - "description": "Estimated EBIT high.", - "default": null, - "optional": true - }, - { - "name": "estimated_ebit_avg", - "type": "int", - "description": "Estimated EBIT average.", - "default": null, - "optional": true - }, - { - "name": "estimated_net_income_low", - "type": "int", - "description": "Estimated net income low.", - "default": null, - "optional": true - }, - { - "name": "estimated_net_income_high", - "type": "int", - "description": "Estimated net income high.", - "default": null, - "optional": true - }, - { - "name": "estimated_net_income_avg", - "type": "int", - "description": "Estimated net income average.", - "default": null, - "optional": true - }, - { - "name": "estimated_eps_avg", - "type": "float", - "description": "Estimated EPS average.", - "default": null, - "optional": true - }, - { - "name": "estimated_eps_high", - "type": "float", - "description": "Estimated EPS high.", - "default": null, - "optional": true - }, - { - "name": "estimated_eps_low", - "type": "float", - "description": "Estimated EPS low.", - "default": null, - "optional": true - }, - { - "name": "number_analyst_estimated_revenue", - "type": "int", - "description": "Number of analysts who estimated revenue.", - "default": null, - "optional": true - }, - { - "name": "number_analysts_estimated_eps", - "type": "int", - "description": "Number of analysts who estimated EPS.", - "default": null, - "optional": true - } - ] + "fmp": [] }, "model": "AnalystEstimates" }, @@ -6655,15 +5579,7 @@ "optional": true } ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": null, - "optional": true - } - ], + "fmp": [], "intrinio": [ { "name": "industry_group_number", @@ -6673,15 +5589,7 @@ "optional": true } ], - "yfinance": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": null, - "optional": true - } - ] + "yfinance": [] }, "returns": { "OBBject": [ @@ -6757,50 +5665,7 @@ "optional": true } ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "name", - "type": "str", - "description": "The company name", - "default": null, - "optional": true - }, - { - "name": "target_high", - "type": "float", - "description": "High target of the price target consensus.", - "default": null, - "optional": true - }, - { - "name": "target_low", - "type": "float", - "description": "Low target of the price target consensus.", - "default": null, - "optional": true - }, - { - "name": "target_consensus", - "type": "float", - "description": "Consensus target of the price target consensus.", - "default": null, - "optional": true - }, - { - "name": "target_median", - "type": "float", - "description": "Median target of the price target consensus.", - "default": null, - "optional": true - } - ], + "fmp": [], "intrinio": [ { "name": "standard_deviation", @@ -7830,111 +6695,19 @@ "optional": true } ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, + "fmp": [], + "intrinio": [ { - "name": "name", - "type": "str", - "description": "Name of the entity.", + "name": "revisions_change_percent", + "type": "float", + "description": "The earnings per share (EPS) percent change in estimate for the period.", "default": null, "optional": true }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "fiscal_year", - "type": "int", - "description": "Fiscal year for the estimate.", - "default": null, - "optional": true - }, - { - "name": "fiscal_period", - "type": "str", - "description": "Fiscal quarter for the estimate.", - "default": null, - "optional": true - }, - { - "name": "calendar_year", - "type": "int", - "description": "Calendar year for the estimate.", - "default": null, - "optional": true - }, - { - "name": "calendar_period", - "type": "str", - "description": "Calendar quarter for the estimate.", - "default": null, - "optional": true - }, - { - "name": "low_estimate", - "type": "float", - "description": "Estimated EPS low for the period.", - "default": null, - "optional": true - }, - { - "name": "high_estimate", - "type": "float", - "description": "Estimated EPS high for the period.", - "default": null, - "optional": true - }, - { - "name": "mean", - "type": "float", - "description": "Estimated EPS mean for the period.", - "default": null, - "optional": true - }, - { - "name": "median", - "type": "float", - "description": "Estimated EPS median for the period.", - "default": null, - "optional": true - }, - { - "name": "standard_deviation", - "type": "float", - "description": "Estimated EPS standard deviation for the period.", - "default": null, - "optional": true - }, - { - "name": "number_of_analysts", - "type": "int", - "description": "Number of analysts providing estimates for the period.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "revisions_change_percent", - "type": "float", - "description": "The earnings per share (EPS) percent change in estimate for the period.", - "default": null, - "optional": true - }, - { - "name": "mean_1w", - "type": "float", - "description": "The mean estimate for the period one week ago.", + "name": "mean_1w", + "type": "float", + "description": "The mean estimate for the period one week ago.", "default": null, "optional": true }, @@ -7987,15 +6760,7 @@ "optional": true } ], - "yfinance": [ - { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", - "default": "desc", - "optional": true - } - ] + "yfinance": [] }, "returns": { "OBBject": [ @@ -8121,15 +6886,7 @@ "optional": true } ], - "yfinance": [ - { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", - "default": "desc", - "optional": true - } - ] + "yfinance": [] }, "returns": { "OBBject": [ @@ -8255,15 +7012,7 @@ "optional": true } ], - "yfinance": [ - { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", - "default": "desc", - "optional": true - } - ] + "yfinance": [] }, "returns": { "OBBject": [ @@ -8389,15 +7138,7 @@ "optional": true } ], - "yfinance": [ - { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", - "default": "desc", - "optional": true - } - ] + "yfinance": [] }, "returns": { "OBBject": [ @@ -8523,15 +7264,7 @@ "optional": true } ], - "yfinance": [ - { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", - "default": "desc", - "optional": true - } - ] + "yfinance": [] }, "returns": { "OBBject": [ @@ -8657,15 +7390,7 @@ "optional": true } ], - "yfinance": [ - { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", - "default": "desc", - "optional": true - } - ] + "yfinance": [] }, "returns": { "OBBject": [ @@ -8791,15 +7516,7 @@ "optional": true } ], - "yfinance": [ - { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", - "default": "desc", - "optional": true - } - ] + "yfinance": [] }, "returns": { "OBBject": [ @@ -9030,50 +7747,7 @@ "optional": false } ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "cik", - "type": "str", - "description": "Central Index Key (CIK) for the requested entity.", - "default": "", - "optional": false - }, - { - "name": "title", - "type": "str", - "description": "Title of the filing.", - "default": "", - "optional": false - }, - { - "name": "date", - "type": "datetime", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "form_type", - "type": "str", - "description": "The form type of the filing", - "default": "", - "optional": false - }, - { - "name": "link", - "type": "str", - "description": "URL to the filing page on the SEC site.", - "default": "", - "optional": false - } - ] + "fmp": [] }, "model": "DiscoveryFilings" }, @@ -9101,15 +7775,7 @@ "optional": true } ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - } - ] + "fmp": [] }, "returns": { "OBBject": [ @@ -9570,725 +8236,740 @@ "optional": true } ], - "fmp": [ + "fmp": [] + }, + "model": "EquityValuationMultiples" + }, + "/equity/fundamental/balance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the balance sheet for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.balance(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.balance(symbol='AAPL', period='annual', limit=5, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ { "name": "symbol", "type": "str", - "description": "Symbol representing the entity requested in the data.", + "description": "Symbol to get data for.", "default": "", "optional": false }, { - "name": "revenue_per_share_ttm", - "type": "float", - "description": "Revenue per share calculated as trailing twelve months.", - "default": null, + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", "optional": true }, { - "name": "net_income_per_share_ttm", - "type": "float", - "description": "Net income per share calculated as trailing twelve months.", - "default": null, + "name": "limit", + "type": "Annotated[int, Ge(ge=0)]", + "description": "The number of data entries to return.", + "default": 5, "optional": true }, { - "name": "operating_cash_flow_per_share_ttm", - "type": "float", - "description": "Operating cash flow per share calculated as trailing twelve months.", - "default": null, + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", + "description": "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.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "free_cash_flow_per_share_ttm", - "type": "float", - "description": "Free cash flow per share calculated as trailing twelve months.", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", "optional": true - }, + } + ], + "intrinio": [ { - "name": "cash_per_share_ttm", - "type": "float", - "description": "Cash per share calculated as trailing twelve months.", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", "optional": true }, { - "name": "book_value_per_share_ttm", - "type": "float", - "description": "Book value per share calculated as trailing twelve months.", + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", "default": null, "optional": true - }, + } + ], + "polygon": [ { - "name": "tangible_book_value_per_share_ttm", - "type": "float", - "description": "Tangible book value per share calculated as trailing twelve months.", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm']", + "description": "None", + "default": "annual", "optional": true }, { - "name": "shareholders_equity_per_share_ttm", - "type": "float", - "description": "Shareholders equity per share calculated as trailing twelve months.", + "name": "filing_date", + "type": "date", + "description": "Filing date of the financial statement.", "default": null, "optional": true }, { - "name": "interest_debt_per_share_ttm", - "type": "float", - "description": "Interest debt per share calculated as trailing twelve months.", + "name": "filing_date_lt", + "type": "date", + "description": "Filing date less than the given date.", "default": null, "optional": true }, { - "name": "market_cap_ttm", - "type": "float", - "description": "Market capitalization calculated as trailing twelve months.", + "name": "filing_date_lte", + "type": "date", + "description": "Filing date less than or equal to the given date.", "default": null, "optional": true }, { - "name": "enterprise_value_ttm", - "type": "float", - "description": "Enterprise value calculated as trailing twelve months.", + "name": "filing_date_gt", + "type": "date", + "description": "Filing date greater than the given date.", "default": null, "optional": true }, { - "name": "pe_ratio_ttm", - "type": "float", - "description": "Price-to-earnings ratio (P/E ratio) calculated as trailing twelve months.", + "name": "filing_date_gte", + "type": "date", + "description": "Filing date greater than or equal to the given date.", "default": null, "optional": true }, { - "name": "price_to_sales_ratio_ttm", - "type": "float", - "description": "Price-to-sales ratio calculated as trailing twelve months.", + "name": "period_of_report_date", + "type": "date", + "description": "Period of report date of the financial statement.", "default": null, "optional": true }, { - "name": "pocf_ratio_ttm", - "type": "float", - "description": "Price-to-operating cash flow ratio calculated as trailing twelve months.", + "name": "period_of_report_date_lt", + "type": "date", + "description": "Period of report date less than the given date.", "default": null, "optional": true }, { - "name": "pfcf_ratio_ttm", - "type": "float", - "description": "Price-to-free cash flow ratio calculated as trailing twelve months.", + "name": "period_of_report_date_lte", + "type": "date", + "description": "Period of report date less than or equal to the given date.", "default": null, "optional": true }, { - "name": "pb_ratio_ttm", - "type": "float", - "description": "Price-to-book ratio calculated as trailing twelve months.", + "name": "period_of_report_date_gt", + "type": "date", + "description": "Period of report date greater than the given date.", "default": null, "optional": true }, { - "name": "ptb_ratio_ttm", - "type": "float", - "description": "Price-to-tangible book ratio calculated as trailing twelve months.", + "name": "period_of_report_date_gte", + "type": "date", + "description": "Period of report date greater than or equal to the given date.", "default": null, "optional": true }, { - "name": "ev_to_sales_ttm", - "type": "float", - "description": "Enterprise value-to-sales ratio calculated as trailing twelve months.", - "default": null, + "name": "include_sources", + "type": "bool", + "description": "Whether to include the sources of the financial statement.", + "default": true, "optional": true }, { - "name": "enterprise_value_over_ebitda_ttm", - "type": "float", - "description": "Enterprise value-to-EBITDA ratio calculated as trailing twelve months.", + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order of the financial statement.", "default": null, "optional": true }, { - "name": "ev_to_operating_cash_flow_ttm", - "type": "float", - "description": "Enterprise value-to-operating cash flow ratio calculated as trailing twelve months.", + "name": "sort", + "type": "Literal['filing_date', 'period_of_report_date']", + "description": "Sort of the financial statement.", "default": null, "optional": true + } + ], + "yfinance": [ + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[BalanceSheet]", + "description": "Serializable results." }, { - "name": "ev_to_free_cash_flow_ttm", - "type": "float", - "description": "Enterprise value-to-free cash flow ratio calculated as trailing twelve months.", + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", "default": null, "optional": true }, { - "name": "earnings_yield_ttm", - "type": "float", - "description": "Earnings yield calculated as trailing twelve months.", + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "free_cash_flow_yield_ttm", - "type": "float", - "description": "Free cash flow yield calculated as trailing twelve months.", + "name": "filing_date", + "type": "date", + "description": "The date when the filing was made.", "default": null, "optional": true }, { - "name": "debt_to_equity_ttm", - "type": "float", - "description": "Debt-to-equity ratio calculated as trailing twelve months.", + "name": "accepted_date", + "type": "datetime", + "description": "The date and time when the filing was accepted.", "default": null, "optional": true }, { - "name": "debt_to_assets_ttm", - "type": "float", - "description": "Debt-to-assets ratio calculated as trailing twelve months.", + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet was reported.", "default": null, "optional": true }, { - "name": "net_debt_to_ebitda_ttm", + "name": "cash_and_cash_equivalents", "type": "float", - "description": "Net debt-to-EBITDA ratio calculated as trailing twelve months.", + "description": "Cash and cash equivalents.", "default": null, "optional": true }, { - "name": "current_ratio_ttm", + "name": "short_term_investments", "type": "float", - "description": "Current ratio calculated as trailing twelve months.", + "description": "Short term investments.", "default": null, "optional": true }, { - "name": "interest_coverage_ttm", + "name": "cash_and_short_term_investments", "type": "float", - "description": "Interest coverage calculated as trailing twelve months.", + "description": "Cash and short term investments.", "default": null, "optional": true }, { - "name": "income_quality_ttm", + "name": "net_receivables", "type": "float", - "description": "Income quality calculated as trailing twelve months.", + "description": "Net receivables.", "default": null, "optional": true }, { - "name": "dividend_yield_ttm", + "name": "inventory", "type": "float", - "description": "Dividend yield calculated as trailing twelve months.", + "description": "Inventory.", "default": null, "optional": true }, { - "name": "dividend_yield_percentage_ttm", + "name": "other_current_assets", "type": "float", - "description": "Dividend yield percentage calculated as trailing twelve months.", + "description": "Other current assets.", "default": null, "optional": true }, { - "name": "dividend_to_market_cap_ttm", + "name": "total_current_assets", "type": "float", - "description": "Dividend to market capitalization ratio calculated as trailing twelve months.", + "description": "Total current assets.", "default": null, "optional": true }, { - "name": "dividend_per_share_ttm", + "name": "plant_property_equipment_net", "type": "float", - "description": "Dividend per share calculated as trailing twelve months.", + "description": "Plant property equipment net.", "default": null, "optional": true }, { - "name": "payout_ratio_ttm", + "name": "goodwill", "type": "float", - "description": "Payout ratio calculated as trailing twelve months.", + "description": "Goodwill.", "default": null, "optional": true }, { - "name": "sales_general_and_administrative_to_revenue_ttm", + "name": "intangible_assets", "type": "float", - "description": "Sales general and administrative expenses-to-revenue ratio calculated as trailing twelve months.", + "description": "Intangible assets.", "default": null, "optional": true }, { - "name": "research_and_development_to_revenue_ttm", + "name": "goodwill_and_intangible_assets", "type": "float", - "description": "Research and development expenses-to-revenue ratio calculated as trailing twelve months.", + "description": "Goodwill and intangible assets.", "default": null, "optional": true }, { - "name": "intangibles_to_total_assets_ttm", + "name": "long_term_investments", "type": "float", - "description": "Intangibles-to-total assets ratio calculated as trailing twelve months.", + "description": "Long term investments.", "default": null, "optional": true }, { - "name": "capex_to_operating_cash_flow_ttm", + "name": "tax_assets", "type": "float", - "description": "Capital expenditures-to-operating cash flow ratio calculated as trailing twelve months.", + "description": "Tax assets.", "default": null, "optional": true }, { - "name": "capex_to_revenue_ttm", + "name": "other_non_current_assets", "type": "float", - "description": "Capital expenditures-to-revenue ratio calculated as trailing twelve months.", + "description": "Other non current assets.", "default": null, "optional": true }, { - "name": "capex_to_depreciation_ttm", + "name": "non_current_assets", "type": "float", - "description": "Capital expenditures-to-depreciation ratio calculated as trailing twelve months.", + "description": "Total non current assets.", "default": null, "optional": true }, { - "name": "stock_based_compensation_to_revenue_ttm", + "name": "other_assets", "type": "float", - "description": "Stock-based compensation-to-revenue ratio calculated as trailing twelve months.", + "description": "Other assets.", "default": null, "optional": true }, { - "name": "graham_number_ttm", + "name": "total_assets", "type": "float", - "description": "Graham number calculated as trailing twelve months.", + "description": "Total assets.", "default": null, "optional": true }, { - "name": "roic_ttm", + "name": "accounts_payable", "type": "float", - "description": "Return on invested capital calculated as trailing twelve months.", + "description": "Accounts payable.", "default": null, "optional": true }, { - "name": "return_on_tangible_assets_ttm", + "name": "short_term_debt", "type": "float", - "description": "Return on tangible assets calculated as trailing twelve months.", + "description": "Short term debt.", "default": null, "optional": true }, { - "name": "graham_net_net_ttm", + "name": "tax_payables", "type": "float", - "description": "Graham net-net working capital calculated as trailing twelve months.", + "description": "Tax payables.", "default": null, "optional": true }, { - "name": "working_capital_ttm", + "name": "current_deferred_revenue", "type": "float", - "description": "Working capital calculated as trailing twelve months.", + "description": "Current deferred revenue.", "default": null, "optional": true }, { - "name": "tangible_asset_value_ttm", + "name": "other_current_liabilities", "type": "float", - "description": "Tangible asset value calculated as trailing twelve months.", + "description": "Other current liabilities.", "default": null, "optional": true }, { - "name": "net_current_asset_value_ttm", + "name": "total_current_liabilities", "type": "float", - "description": "Net current asset value calculated as trailing twelve months.", + "description": "Total current liabilities.", "default": null, "optional": true }, { - "name": "invested_capital_ttm", + "name": "long_term_debt", "type": "float", - "description": "Invested capital calculated as trailing twelve months.", + "description": "Long term debt.", "default": null, "optional": true }, { - "name": "average_receivables_ttm", + "name": "deferred_revenue_non_current", "type": "float", - "description": "Average receivables calculated as trailing twelve months.", + "description": "Non current deferred revenue.", "default": null, "optional": true }, { - "name": "average_payables_ttm", + "name": "deferred_tax_liabilities_non_current", "type": "float", - "description": "Average payables calculated as trailing twelve months.", + "description": "Deferred tax liabilities non current.", "default": null, "optional": true }, { - "name": "average_inventory_ttm", + "name": "other_non_current_liabilities", "type": "float", - "description": "Average inventory calculated as trailing twelve months.", + "description": "Other non current liabilities.", "default": null, "optional": true }, { - "name": "days_sales_outstanding_ttm", + "name": "total_non_current_liabilities", "type": "float", - "description": "Days sales outstanding calculated as trailing twelve months.", + "description": "Total non current liabilities.", "default": null, "optional": true }, { - "name": "days_payables_outstanding_ttm", + "name": "other_liabilities", "type": "float", - "description": "Days payables outstanding calculated as trailing twelve months.", + "description": "Other liabilities.", "default": null, "optional": true }, { - "name": "days_of_inventory_on_hand_ttm", + "name": "capital_lease_obligations", "type": "float", - "description": "Days of inventory on hand calculated as trailing twelve months.", + "description": "Capital lease obligations.", "default": null, "optional": true }, { - "name": "receivables_turnover_ttm", + "name": "total_liabilities", "type": "float", - "description": "Receivables turnover calculated as trailing twelve months.", + "description": "Total liabilities.", "default": null, "optional": true }, { - "name": "payables_turnover_ttm", + "name": "preferred_stock", "type": "float", - "description": "Payables turnover calculated as trailing twelve months.", + "description": "Preferred stock.", "default": null, "optional": true }, { - "name": "inventory_turnover_ttm", + "name": "common_stock", "type": "float", - "description": "Inventory turnover calculated as trailing twelve months.", + "description": "Common stock.", "default": null, "optional": true }, { - "name": "roe_ttm", + "name": "retained_earnings", "type": "float", - "description": "Return on equity calculated as trailing twelve months.", + "description": "Retained earnings.", "default": null, "optional": true }, { - "name": "capex_per_share_ttm", + "name": "accumulated_other_comprehensive_income", "type": "float", - "description": "Capital expenditures per share calculated as trailing twelve months.", + "description": "Accumulated other comprehensive income (loss).", "default": null, "optional": true - } - ] - }, - "model": "EquityValuationMultiples" - }, - "/equity/fundamental/balance": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the balance sheet for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.balance(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.balance(symbol='AAPL', period='annual', limit=5, provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "period", - "type": "str", - "description": "Time period of the data to return.", - "default": "annual", + "name": "other_shareholders_equity", + "type": "float", + "description": "Other shareholders equity.", + "default": null, "optional": true }, { - "name": "limit", - "type": "Annotated[int, Ge(ge=0)]", - "description": "The number of data entries to return.", - "default": 5, + "name": "other_total_shareholders_equity", + "type": "float", + "description": "Other total shareholders equity.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", - "description": "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.", - "default": "fmp", + "name": "total_common_equity", + "type": "float", + "description": "Total common equity.", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", + "name": "total_equity_non_controlling_interests", + "type": "float", + "description": "Total equity non controlling interests.", + "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", + "name": "total_liabilities_and_shareholders_equity", + "type": "float", + "description": "Total liabilities and shareholders equity.", + "default": null, "optional": true }, { - "name": "fiscal_year", - "type": "int", - "description": "The specific fiscal year. Reports do not go beyond 2008.", + "name": "minority_interest", + "type": "float", + "description": "Minority interest.", "default": null, "optional": true - } - ], - "polygon": [ + }, { - "name": "period", - "type": "Literal['annual', 'quarter', 'ttm']", - "description": "None", - "default": "annual", + "name": "total_liabilities_and_total_equity", + "type": "float", + "description": "Total liabilities and total equity.", + "default": null, "optional": true }, { - "name": "filing_date", - "type": "date", - "description": "Filing date of the financial statement.", + "name": "total_investments", + "type": "float", + "description": "Total investments.", "default": null, "optional": true }, { - "name": "filing_date_lt", - "type": "date", - "description": "Filing date less than the given date.", + "name": "total_debt", + "type": "float", + "description": "Total debt.", "default": null, "optional": true }, { - "name": "filing_date_lte", - "type": "date", - "description": "Filing date less than or equal to the given date.", + "name": "net_debt", + "type": "float", + "description": "Net debt.", "default": null, "optional": true }, { - "name": "filing_date_gt", - "type": "date", - "description": "Filing date greater than the given date.", + "name": "link", + "type": "str", + "description": "Link to the filing.", "default": null, "optional": true }, { - "name": "filing_date_gte", - "type": "date", - "description": "Filing date greater than or equal to the given date.", + "name": "final_link", + "type": "str", + "description": "Link to the filing document.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet is reported.", "default": null, "optional": true }, { - "name": "period_of_report_date", - "type": "date", - "description": "Period of report date of the financial statement.", + "name": "cash_and_cash_equivalents", + "type": "float", + "description": "Cash and cash equivalents.", "default": null, "optional": true }, { - "name": "period_of_report_date_lt", - "type": "date", - "description": "Period of report date less than the given date.", + "name": "cash_and_due_from_banks", + "type": "float", + "description": "Cash and due from banks.", "default": null, "optional": true }, { - "name": "period_of_report_date_lte", - "type": "date", - "description": "Period of report date less than or equal to the given date.", + "name": "restricted_cash", + "type": "float", + "description": "Restricted cash.", "default": null, "optional": true }, { - "name": "period_of_report_date_gt", - "type": "date", - "description": "Period of report date greater than the given date.", + "name": "short_term_investments", + "type": "float", + "description": "Short term investments.", "default": null, "optional": true }, { - "name": "period_of_report_date_gte", - "type": "date", - "description": "Period of report date greater than or equal to the given date.", + "name": "federal_funds_sold", + "type": "float", + "description": "Federal funds sold.", "default": null, "optional": true }, { - "name": "include_sources", - "type": "bool", - "description": "Whether to include the sources of the financial statement.", - "default": true, + "name": "accounts_receivable", + "type": "float", + "description": "Accounts receivable.", + "default": null, "optional": true }, { - "name": "order", - "type": "Literal['asc', 'desc']", - "description": "Order of the financial statement.", + "name": "note_and_lease_receivable", + "type": "float", + "description": "Note and lease receivable. (Vendor non-trade receivables)", "default": null, "optional": true }, { - "name": "sort", - "type": "Literal['filing_date', 'period_of_report_date']", - "description": "Sort of the financial statement.", + "name": "inventories", + "type": "float", + "description": "Net Inventories.", "default": null, "optional": true - } - ], - "yfinance": [ + }, { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", + "name": "customer_and_other_receivables", + "type": "float", + "description": "Customer and other receivables.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[BalanceSheet]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "period_ending", - "type": "date", - "description": "The end date of the reporting period.", - "default": "", - "optional": false + "name": "interest_bearing_deposits_at_other_banks", + "type": "float", + "description": "Interest bearing deposits at other banks.", + "default": null, + "optional": true }, { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the report.", + "name": "time_deposits_placed_and_other_short_term_investments", + "type": "float", + "description": "Time deposits placed and other short term investments.", "default": null, "optional": true }, { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the fiscal period.", + "name": "trading_account_securities", + "type": "float", + "description": "Trading account securities.", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "filing_date", - "type": "date", - "description": "The date when the filing was made.", + "name": "loans_and_leases", + "type": "float", + "description": "Loans and leases.", "default": null, "optional": true }, { - "name": "accepted_date", - "type": "datetime", - "description": "The date and time when the filing was accepted.", + "name": "allowance_for_loan_and_lease_losses", + "type": "float", + "description": "Allowance for loan and lease losses.", "default": null, "optional": true }, { - "name": "reported_currency", - "type": "str", - "description": "The currency in which the balance sheet was reported.", + "name": "current_deferred_refundable_income_taxes", + "type": "float", + "description": "Current deferred refundable income taxes.", "default": null, "optional": true }, { - "name": "cash_and_cash_equivalents", + "name": "other_current_assets", "type": "float", - "description": "Cash and cash equivalents.", + "description": "Other current assets.", "default": null, "optional": true }, { - "name": "short_term_investments", + "name": "loans_and_leases_net_of_allowance", "type": "float", - "description": "Short term investments.", + "description": "Loans and leases net of allowance.", "default": null, "optional": true }, { - "name": "cash_and_short_term_investments", + "name": "accrued_investment_income", "type": "float", - "description": "Cash and short term investments.", + "description": "Accrued investment income.", "default": null, "optional": true }, { - "name": "net_receivables", + "name": "other_current_non_operating_assets", "type": "float", - "description": "Net receivables.", + "description": "Other current non-operating assets.", "default": null, "optional": true }, { - "name": "inventory", + "name": "loans_held_for_sale", "type": "float", - "description": "Inventory.", + "description": "Loans held for sale.", "default": null, "optional": true }, { - "name": "other_current_assets", + "name": "prepaid_expenses", "type": "float", - "description": "Other current assets.", + "description": "Prepaid expenses.", "default": null, "optional": true }, @@ -10300,30 +8981,30 @@ "optional": true }, { - "name": "plant_property_equipment_net", + "name": "plant_property_equipment_gross", "type": "float", - "description": "Plant property equipment net.", + "description": "Plant property equipment gross.", "default": null, "optional": true }, { - "name": "goodwill", + "name": "accumulated_depreciation", "type": "float", - "description": "Goodwill.", + "description": "Accumulated depreciation.", "default": null, "optional": true }, { - "name": "intangible_assets", + "name": "premises_and_equipment_net", "type": "float", - "description": "Intangible assets.", + "description": "Net premises and equipment.", "default": null, "optional": true }, { - "name": "goodwill_and_intangible_assets", + "name": "plant_property_equipment_net", "type": "float", - "description": "Goodwill and intangible assets.", + "description": "Net plant property equipment.", "default": null, "optional": true }, @@ -10335,1158 +9016,1181 @@ "optional": true }, { - "name": "tax_assets", + "name": "mortgage_servicing_rights", "type": "float", - "description": "Tax assets.", + "description": "Mortgage servicing rights.", "default": null, "optional": true }, { - "name": "other_non_current_assets", + "name": "unearned_premiums_asset", "type": "float", - "description": "Other non current assets.", + "description": "Unearned premiums asset.", "default": null, "optional": true }, { - "name": "non_current_assets", + "name": "non_current_note_lease_receivables", "type": "float", - "description": "Total non current assets.", + "description": "Non-current note lease receivables.", "default": null, "optional": true }, { - "name": "other_assets", + "name": "deferred_acquisition_cost", "type": "float", - "description": "Other assets.", + "description": "Deferred acquisition cost.", "default": null, "optional": true }, { - "name": "total_assets", + "name": "goodwill", "type": "float", - "description": "Total assets.", + "description": "Goodwill.", "default": null, "optional": true }, { - "name": "accounts_payable", + "name": "separate_account_business_assets", "type": "float", - "description": "Accounts payable.", + "description": "Separate account business assets.", "default": null, "optional": true }, { - "name": "short_term_debt", + "name": "non_current_deferred_refundable_income_taxes", "type": "float", - "description": "Short term debt.", + "description": "Noncurrent deferred refundable income taxes.", "default": null, "optional": true }, { - "name": "tax_payables", + "name": "intangible_assets", "type": "float", - "description": "Tax payables.", + "description": "Intangible assets.", "default": null, "optional": true }, { - "name": "current_deferred_revenue", + "name": "employee_benefit_assets", "type": "float", - "description": "Current deferred revenue.", + "description": "Employee benefit assets.", "default": null, "optional": true }, { - "name": "other_current_liabilities", + "name": "other_assets", "type": "float", - "description": "Other current liabilities.", + "description": "Other assets.", "default": null, "optional": true }, { - "name": "total_current_liabilities", + "name": "other_non_current_operating_assets", "type": "float", - "description": "Total current liabilities.", + "description": "Other noncurrent operating assets.", "default": null, "optional": true }, { - "name": "long_term_debt", + "name": "other_non_current_non_operating_assets", "type": "float", - "description": "Long term debt.", + "description": "Other noncurrent non-operating assets.", "default": null, "optional": true }, { - "name": "deferred_revenue_non_current", + "name": "interest_bearing_deposits", "type": "float", - "description": "Non current deferred revenue.", + "description": "Interest bearing deposits.", "default": null, "optional": true }, { - "name": "deferred_tax_liabilities_non_current", + "name": "total_non_current_assets", "type": "float", - "description": "Deferred tax liabilities non current.", + "description": "Total noncurrent assets.", "default": null, "optional": true }, { - "name": "other_non_current_liabilities", + "name": "total_assets", "type": "float", - "description": "Other non current liabilities.", + "description": "Total assets.", "default": null, "optional": true }, { - "name": "total_non_current_liabilities", + "name": "non_interest_bearing_deposits", "type": "float", - "description": "Total non current liabilities.", + "description": "Non interest bearing deposits.", "default": null, "optional": true }, { - "name": "other_liabilities", + "name": "federal_funds_purchased_and_securities_sold", "type": "float", - "description": "Other liabilities.", + "description": "Federal funds purchased and securities sold.", "default": null, "optional": true }, { - "name": "capital_lease_obligations", + "name": "bankers_acceptance_outstanding", "type": "float", - "description": "Capital lease obligations.", + "description": "Bankers acceptance outstanding.", "default": null, "optional": true }, { - "name": "total_liabilities", + "name": "short_term_debt", "type": "float", - "description": "Total liabilities.", + "description": "Short term debt.", "default": null, "optional": true }, { - "name": "preferred_stock", + "name": "accounts_payable", "type": "float", - "description": "Preferred stock.", + "description": "Accounts payable.", "default": null, "optional": true }, { - "name": "common_stock", + "name": "current_deferred_revenue", "type": "float", - "description": "Common stock.", + "description": "Current deferred revenue.", "default": null, "optional": true }, { - "name": "retained_earnings", + "name": "current_deferred_payable_income_tax_liabilities", "type": "float", - "description": "Retained earnings.", + "description": "Current deferred payable income tax liabilities.", "default": null, "optional": true }, { - "name": "accumulated_other_comprehensive_income", + "name": "accrued_interest_payable", "type": "float", - "description": "Accumulated other comprehensive income (loss).", + "description": "Accrued interest payable.", "default": null, "optional": true }, { - "name": "other_shareholders_equity", + "name": "accrued_expenses", "type": "float", - "description": "Other shareholders equity.", + "description": "Accrued expenses.", "default": null, "optional": true }, { - "name": "other_total_shareholders_equity", + "name": "other_short_term_payables", "type": "float", - "description": "Other total shareholders equity.", + "description": "Other short term payables.", "default": null, "optional": true }, { - "name": "total_common_equity", + "name": "customer_deposits", "type": "float", - "description": "Total common equity.", + "description": "Customer deposits.", "default": null, "optional": true }, { - "name": "total_equity_non_controlling_interests", + "name": "dividends_payable", "type": "float", - "description": "Total equity non controlling interests.", + "description": "Dividends payable.", "default": null, "optional": true }, { - "name": "total_liabilities_and_shareholders_equity", + "name": "claims_and_claim_expense", "type": "float", - "description": "Total liabilities and shareholders equity.", + "description": "Claims and claim expense.", "default": null, "optional": true }, { - "name": "minority_interest", + "name": "future_policy_benefits", "type": "float", - "description": "Minority interest.", + "description": "Future policy benefits.", "default": null, "optional": true }, { - "name": "total_liabilities_and_total_equity", + "name": "current_employee_benefit_liabilities", "type": "float", - "description": "Total liabilities and total equity.", + "description": "Current employee benefit liabilities.", "default": null, "optional": true }, { - "name": "total_investments", + "name": "unearned_premiums_liability", "type": "float", - "description": "Total investments.", + "description": "Unearned premiums liability.", "default": null, "optional": true }, { - "name": "total_debt", + "name": "other_taxes_payable", "type": "float", - "description": "Total debt.", + "description": "Other taxes payable.", "default": null, "optional": true }, { - "name": "net_debt", + "name": "policy_holder_funds", "type": "float", - "description": "Net debt.", + "description": "Policy holder funds.", "default": null, "optional": true }, { - "name": "link", - "type": "str", - "description": "Link to the filing.", + "name": "other_current_liabilities", + "type": "float", + "description": "Other current liabilities.", "default": null, "optional": true }, { - "name": "final_link", - "type": "str", - "description": "Link to the filing document.", + "name": "other_current_non_operating_liabilities", + "type": "float", + "description": "Other current non-operating liabilities.", "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "reported_currency", - "type": "str", - "description": "The currency in which the balance sheet is reported.", + "name": "separate_account_business_liabilities", + "type": "float", + "description": "Separate account business liabilities.", "default": null, "optional": true }, { - "name": "cash_and_cash_equivalents", + "name": "total_current_liabilities", "type": "float", - "description": "Cash and cash equivalents.", + "description": "Total current liabilities.", "default": null, "optional": true }, { - "name": "cash_and_due_from_banks", + "name": "long_term_debt", "type": "float", - "description": "Cash and due from banks.", + "description": "Long term debt.", "default": null, "optional": true }, { - "name": "restricted_cash", + "name": "other_long_term_liabilities", "type": "float", - "description": "Restricted cash.", + "description": "Other long term liabilities.", "default": null, "optional": true }, { - "name": "short_term_investments", + "name": "non_current_deferred_revenue", "type": "float", - "description": "Short term investments.", + "description": "Non-current deferred revenue.", "default": null, "optional": true }, { - "name": "federal_funds_sold", + "name": "non_current_deferred_payable_income_tax_liabilities", "type": "float", - "description": "Federal funds sold.", + "description": "Non-current deferred payable income tax liabilities.", "default": null, "optional": true }, { - "name": "accounts_receivable", + "name": "non_current_employee_benefit_liabilities", "type": "float", - "description": "Accounts receivable.", + "description": "Non-current employee benefit liabilities.", "default": null, "optional": true }, { - "name": "note_and_lease_receivable", + "name": "other_non_current_operating_liabilities", "type": "float", - "description": "Note and lease receivable. (Vendor non-trade receivables)", + "description": "Other non-current operating liabilities.", "default": null, "optional": true }, { - "name": "inventories", + "name": "other_non_current_non_operating_liabilities", "type": "float", - "description": "Net Inventories.", + "description": "Other non-current, non-operating liabilities.", "default": null, "optional": true }, { - "name": "customer_and_other_receivables", + "name": "total_non_current_liabilities", "type": "float", - "description": "Customer and other receivables.", + "description": "Total non-current liabilities.", "default": null, "optional": true }, { - "name": "interest_bearing_deposits_at_other_banks", + "name": "capital_lease_obligations", "type": "float", - "description": "Interest bearing deposits at other banks.", + "description": "Capital lease obligations.", "default": null, "optional": true }, { - "name": "time_deposits_placed_and_other_short_term_investments", + "name": "asset_retirement_reserve_litigation_obligation", "type": "float", - "description": "Time deposits placed and other short term investments.", + "description": "Asset retirement reserve litigation obligation.", "default": null, "optional": true }, { - "name": "trading_account_securities", + "name": "total_liabilities", "type": "float", - "description": "Trading account securities.", + "description": "Total liabilities.", "default": null, "optional": true }, { - "name": "loans_and_leases", + "name": "commitments_contingencies", "type": "float", - "description": "Loans and leases.", + "description": "Commitments contingencies.", "default": null, "optional": true }, { - "name": "allowance_for_loan_and_lease_losses", + "name": "redeemable_non_controlling_interest", "type": "float", - "description": "Allowance for loan and lease losses.", + "description": "Redeemable non-controlling interest.", "default": null, "optional": true }, { - "name": "current_deferred_refundable_income_taxes", + "name": "preferred_stock", "type": "float", - "description": "Current deferred refundable income taxes.", + "description": "Preferred stock.", "default": null, "optional": true }, { - "name": "other_current_assets", + "name": "common_stock", "type": "float", - "description": "Other current assets.", + "description": "Common stock.", "default": null, "optional": true }, { - "name": "loans_and_leases_net_of_allowance", + "name": "retained_earnings", "type": "float", - "description": "Loans and leases net of allowance.", + "description": "Retained earnings.", "default": null, "optional": true }, { - "name": "accrued_investment_income", + "name": "treasury_stock", "type": "float", - "description": "Accrued investment income.", + "description": "Treasury stock.", "default": null, "optional": true }, { - "name": "other_current_non_operating_assets", + "name": "accumulated_other_comprehensive_income", "type": "float", - "description": "Other current non-operating assets.", + "description": "Accumulated other comprehensive income.", "default": null, "optional": true }, { - "name": "loans_held_for_sale", + "name": "participating_policy_holder_equity", "type": "float", - "description": "Loans held for sale.", + "description": "Participating policy holder equity.", "default": null, "optional": true }, { - "name": "prepaid_expenses", + "name": "other_equity_adjustments", "type": "float", - "description": "Prepaid expenses.", + "description": "Other equity adjustments.", "default": null, "optional": true }, { - "name": "total_current_assets", + "name": "total_common_equity", "type": "float", - "description": "Total current assets.", + "description": "Total common equity.", "default": null, "optional": true }, { - "name": "plant_property_equipment_gross", + "name": "total_preferred_common_equity", "type": "float", - "description": "Plant property equipment gross.", + "description": "Total preferred common equity.", "default": null, "optional": true }, { - "name": "accumulated_depreciation", + "name": "non_controlling_interest", "type": "float", - "description": "Accumulated depreciation.", + "description": "Non-controlling interest.", "default": null, "optional": true }, { - "name": "premises_and_equipment_net", + "name": "total_equity_non_controlling_interests", "type": "float", - "description": "Net premises and equipment.", + "description": "Total equity non-controlling interests.", "default": null, "optional": true }, { - "name": "plant_property_equipment_net", + "name": "total_liabilities_shareholders_equity", "type": "float", - "description": "Net plant property equipment.", + "description": "Total liabilities and shareholders equity.", "default": null, "optional": true - }, + } + ], + "polygon": [ { - "name": "long_term_investments", - "type": "float", - "description": "Long term investments.", + "name": "accounts_receivable", + "type": "int", + "description": "Accounts receivable", "default": null, "optional": true }, { - "name": "mortgage_servicing_rights", - "type": "float", - "description": "Mortgage servicing rights.", + "name": "marketable_securities", + "type": "int", + "description": "Marketable securities", "default": null, "optional": true }, { - "name": "unearned_premiums_asset", - "type": "float", - "description": "Unearned premiums asset.", + "name": "prepaid_expenses", + "type": "int", + "description": "Prepaid expenses", "default": null, "optional": true }, { - "name": "non_current_note_lease_receivables", - "type": "float", - "description": "Non-current note lease receivables.", + "name": "other_current_assets", + "type": "int", + "description": "Other current assets", "default": null, "optional": true }, { - "name": "deferred_acquisition_cost", - "type": "float", - "description": "Deferred acquisition cost.", + "name": "total_current_assets", + "type": "int", + "description": "Total current assets", "default": null, "optional": true }, { - "name": "goodwill", - "type": "float", - "description": "Goodwill.", + "name": "property_plant_equipment_net", + "type": "int", + "description": "Property plant and equipment net", "default": null, "optional": true }, { - "name": "separate_account_business_assets", - "type": "float", - "description": "Separate account business assets.", + "name": "inventory", + "type": "int", + "description": "Inventory", "default": null, "optional": true }, { - "name": "non_current_deferred_refundable_income_taxes", - "type": "float", - "description": "Noncurrent deferred refundable income taxes.", + "name": "other_non_current_assets", + "type": "int", + "description": "Other non-current assets", "default": null, "optional": true }, { - "name": "intangible_assets", - "type": "float", - "description": "Intangible assets.", + "name": "total_non_current_assets", + "type": "int", + "description": "Total non-current assets", "default": null, "optional": true }, { - "name": "employee_benefit_assets", - "type": "float", - "description": "Employee benefit assets.", + "name": "intangible_assets", + "type": "int", + "description": "Intangible assets", "default": null, "optional": true }, { - "name": "other_assets", - "type": "float", - "description": "Other assets.", + "name": "total_assets", + "type": "int", + "description": "Total assets", "default": null, "optional": true }, { - "name": "other_non_current_operating_assets", - "type": "float", - "description": "Other noncurrent operating assets.", + "name": "accounts_payable", + "type": "int", + "description": "Accounts payable", "default": null, "optional": true }, { - "name": "other_non_current_non_operating_assets", - "type": "float", - "description": "Other noncurrent non-operating assets.", + "name": "employee_wages", + "type": "int", + "description": "Employee wages", "default": null, "optional": true }, { - "name": "interest_bearing_deposits", - "type": "float", - "description": "Interest bearing deposits.", + "name": "other_current_liabilities", + "type": "int", + "description": "Other current liabilities", "default": null, "optional": true }, { - "name": "total_non_current_assets", - "type": "float", - "description": "Total noncurrent assets.", + "name": "total_current_liabilities", + "type": "int", + "description": "Total current liabilities", "default": null, "optional": true }, { - "name": "total_assets", - "type": "float", - "description": "Total assets.", + "name": "other_non_current_liabilities", + "type": "int", + "description": "Other non-current liabilities", "default": null, "optional": true }, { - "name": "non_interest_bearing_deposits", - "type": "float", - "description": "Non interest bearing deposits.", + "name": "total_non_current_liabilities", + "type": "int", + "description": "Total non-current liabilities", "default": null, "optional": true }, { - "name": "federal_funds_purchased_and_securities_sold", - "type": "float", - "description": "Federal funds purchased and securities sold.", + "name": "long_term_debt", + "type": "int", + "description": "Long term debt", "default": null, "optional": true }, { - "name": "bankers_acceptance_outstanding", - "type": "float", - "description": "Bankers acceptance outstanding.", + "name": "total_liabilities", + "type": "int", + "description": "Total liabilities", "default": null, "optional": true }, { - "name": "short_term_debt", - "type": "float", - "description": "Short term debt.", + "name": "minority_interest", + "type": "int", + "description": "Minority interest", "default": null, "optional": true }, { - "name": "accounts_payable", - "type": "float", - "description": "Accounts payable.", + "name": "temporary_equity_attributable_to_parent", + "type": "int", + "description": "Temporary equity attributable to parent", "default": null, "optional": true }, { - "name": "current_deferred_revenue", - "type": "float", - "description": "Current deferred revenue.", + "name": "equity_attributable_to_parent", + "type": "int", + "description": "Equity attributable to parent", "default": null, "optional": true }, { - "name": "current_deferred_payable_income_tax_liabilities", - "type": "float", - "description": "Current deferred payable income tax liabilities.", + "name": "temporary_equity", + "type": "int", + "description": "Temporary equity", "default": null, "optional": true }, { - "name": "accrued_interest_payable", - "type": "float", - "description": "Accrued interest payable.", + "name": "preferred_stock", + "type": "int", + "description": "Preferred stock", "default": null, "optional": true }, { - "name": "accrued_expenses", - "type": "float", - "description": "Accrued expenses.", + "name": "redeemable_non_controlling_interest", + "type": "int", + "description": "Redeemable non-controlling interest", "default": null, "optional": true }, { - "name": "other_short_term_payables", - "type": "float", - "description": "Other short term payables.", + "name": "redeemable_non_controlling_interest_other", + "type": "int", + "description": "Redeemable non-controlling interest other", "default": null, "optional": true }, { - "name": "customer_deposits", - "type": "float", - "description": "Customer deposits.", + "name": "total_stock_holders_equity", + "type": "int", + "description": "Total stock holders equity", "default": null, "optional": true }, { - "name": "dividends_payable", - "type": "float", - "description": "Dividends payable.", + "name": "total_liabilities_and_stock_holders_equity", + "type": "int", + "description": "Total liabilities and stockholders equity", "default": null, "optional": true }, { - "name": "claims_and_claim_expense", - "type": "float", - "description": "Claims and claim expense.", + "name": "total_equity", + "type": "int", + "description": "Total equity", "default": null, "optional": true - }, + } + ], + "yfinance": [] + }, + "model": "BalanceSheet" + }, + "/equity/fundamental/balance_growth": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the growth of a company's balance sheet items over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.balance_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.balance_growth(symbol='AAPL', limit=10, provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "future_policy_benefits", - "type": "float", - "description": "Future policy benefits.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "current_employee_benefit_liabilities", - "type": "float", - "description": "Current employee benefit liabilities.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10, "optional": true }, { - "name": "unearned_premiums_liability", - "type": "float", - "description": "Unearned premiums liability.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[BalanceSheetGrowth]", + "description": "Serializable results." }, { - "name": "other_taxes_payable", - "type": "float", - "description": "Other taxes payable.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "policy_holder_funds", - "type": "float", - "description": "Policy holder funds.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "other_current_liabilities", - "type": "float", - "description": "Other current liabilities.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "other_current_non_operating_liabilities", - "type": "float", - "description": "Other current non-operating liabilities.", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "separate_account_business_liabilities", - "type": "float", - "description": "Separate account business liabilities.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "total_current_liabilities", - "type": "float", - "description": "Total current liabilities.", - "default": null, - "optional": true + "name": "period", + "type": "str", + "description": "Reporting period.", + "default": "", + "optional": false }, { - "name": "long_term_debt", + "name": "growth_cash_and_cash_equivalents", "type": "float", - "description": "Long term debt.", - "default": null, - "optional": true + "description": "Growth rate of cash and cash equivalents.", + "default": "", + "optional": false }, { - "name": "other_long_term_liabilities", + "name": "growth_short_term_investments", "type": "float", - "description": "Other long term liabilities.", - "default": null, - "optional": true + "description": "Growth rate of short-term investments.", + "default": "", + "optional": false }, { - "name": "non_current_deferred_revenue", + "name": "growth_cash_and_short_term_investments", "type": "float", - "description": "Non-current deferred revenue.", - "default": null, - "optional": true + "description": "Growth rate of cash and short-term investments.", + "default": "", + "optional": false }, { - "name": "non_current_deferred_payable_income_tax_liabilities", + "name": "growth_net_receivables", "type": "float", - "description": "Non-current deferred payable income tax liabilities.", - "default": null, - "optional": true + "description": "Growth rate of net receivables.", + "default": "", + "optional": false }, { - "name": "non_current_employee_benefit_liabilities", + "name": "growth_inventory", "type": "float", - "description": "Non-current employee benefit liabilities.", - "default": null, - "optional": true + "description": "Growth rate of inventory.", + "default": "", + "optional": false }, { - "name": "other_non_current_operating_liabilities", + "name": "growth_other_current_assets", "type": "float", - "description": "Other non-current operating liabilities.", - "default": null, - "optional": true + "description": "Growth rate of other current assets.", + "default": "", + "optional": false }, { - "name": "other_non_current_non_operating_liabilities", + "name": "growth_total_current_assets", "type": "float", - "description": "Other non-current, non-operating liabilities.", - "default": null, - "optional": true + "description": "Growth rate of total current assets.", + "default": "", + "optional": false }, { - "name": "total_non_current_liabilities", + "name": "growth_property_plant_equipment_net", "type": "float", - "description": "Total non-current liabilities.", - "default": null, - "optional": true + "description": "Growth rate of net property, plant, and equipment.", + "default": "", + "optional": false }, { - "name": "capital_lease_obligations", + "name": "growth_goodwill", "type": "float", - "description": "Capital lease obligations.", - "default": null, - "optional": true + "description": "Growth rate of goodwill.", + "default": "", + "optional": false }, { - "name": "asset_retirement_reserve_litigation_obligation", + "name": "growth_intangible_assets", "type": "float", - "description": "Asset retirement reserve litigation obligation.", - "default": null, - "optional": true + "description": "Growth rate of intangible assets.", + "default": "", + "optional": false }, { - "name": "total_liabilities", + "name": "growth_goodwill_and_intangible_assets", "type": "float", - "description": "Total liabilities.", - "default": null, - "optional": true + "description": "Growth rate of goodwill and intangible assets.", + "default": "", + "optional": false }, { - "name": "commitments_contingencies", + "name": "growth_long_term_investments", "type": "float", - "description": "Commitments contingencies.", - "default": null, - "optional": true + "description": "Growth rate of long-term investments.", + "default": "", + "optional": false }, { - "name": "redeemable_non_controlling_interest", + "name": "growth_tax_assets", "type": "float", - "description": "Redeemable non-controlling interest.", - "default": null, - "optional": true + "description": "Growth rate of tax assets.", + "default": "", + "optional": false }, { - "name": "preferred_stock", + "name": "growth_other_non_current_assets", "type": "float", - "description": "Preferred stock.", - "default": null, - "optional": true + "description": "Growth rate of other non-current assets.", + "default": "", + "optional": false }, { - "name": "common_stock", + "name": "growth_total_non_current_assets", "type": "float", - "description": "Common stock.", - "default": null, - "optional": true + "description": "Growth rate of total non-current assets.", + "default": "", + "optional": false }, { - "name": "retained_earnings", + "name": "growth_other_assets", "type": "float", - "description": "Retained earnings.", - "default": null, - "optional": true + "description": "Growth rate of other assets.", + "default": "", + "optional": false }, { - "name": "treasury_stock", + "name": "growth_total_assets", "type": "float", - "description": "Treasury stock.", - "default": null, - "optional": true + "description": "Growth rate of total assets.", + "default": "", + "optional": false }, { - "name": "accumulated_other_comprehensive_income", + "name": "growth_account_payables", "type": "float", - "description": "Accumulated other comprehensive income.", - "default": null, - "optional": true + "description": "Growth rate of accounts payable.", + "default": "", + "optional": false }, { - "name": "participating_policy_holder_equity", + "name": "growth_short_term_debt", "type": "float", - "description": "Participating policy holder equity.", - "default": null, - "optional": true + "description": "Growth rate of short-term debt.", + "default": "", + "optional": false }, { - "name": "other_equity_adjustments", + "name": "growth_tax_payables", "type": "float", - "description": "Other equity adjustments.", - "default": null, - "optional": true + "description": "Growth rate of tax payables.", + "default": "", + "optional": false }, { - "name": "total_common_equity", + "name": "growth_deferred_revenue", "type": "float", - "description": "Total common equity.", - "default": null, - "optional": true + "description": "Growth rate of deferred revenue.", + "default": "", + "optional": false }, { - "name": "total_preferred_common_equity", + "name": "growth_other_current_liabilities", "type": "float", - "description": "Total preferred common equity.", - "default": null, - "optional": true + "description": "Growth rate of other current liabilities.", + "default": "", + "optional": false }, { - "name": "non_controlling_interest", + "name": "growth_total_current_liabilities", "type": "float", - "description": "Non-controlling interest.", - "default": null, - "optional": true + "description": "Growth rate of total current liabilities.", + "default": "", + "optional": false }, { - "name": "total_equity_non_controlling_interests", + "name": "growth_long_term_debt", "type": "float", - "description": "Total equity non-controlling interests.", - "default": null, - "optional": true + "description": "Growth rate of long-term debt.", + "default": "", + "optional": false }, { - "name": "total_liabilities_shareholders_equity", + "name": "growth_deferred_revenue_non_current", "type": "float", - "description": "Total liabilities and shareholders equity.", - "default": null, - "optional": true - } - ], - "polygon": [ - { - "name": "accounts_receivable", - "type": "int", - "description": "Accounts receivable", - "default": null, - "optional": true - }, - { - "name": "marketable_securities", - "type": "int", - "description": "Marketable securities", - "default": null, - "optional": true - }, - { - "name": "prepaid_expenses", - "type": "int", - "description": "Prepaid expenses", - "default": null, - "optional": true + "description": "Growth rate of non-current deferred revenue.", + "default": "", + "optional": false }, { - "name": "other_current_assets", - "type": "int", - "description": "Other current assets", - "default": null, - "optional": true + "name": "growth_deferrred_tax_liabilities_non_current", + "type": "float", + "description": "Growth rate of non-current deferred tax liabilities.", + "default": "", + "optional": false }, { - "name": "total_current_assets", - "type": "int", - "description": "Total current assets", - "default": null, - "optional": true + "name": "growth_other_non_current_liabilities", + "type": "float", + "description": "Growth rate of other non-current liabilities.", + "default": "", + "optional": false }, { - "name": "property_plant_equipment_net", - "type": "int", - "description": "Property plant and equipment net", - "default": null, - "optional": true + "name": "growth_total_non_current_liabilities", + "type": "float", + "description": "Growth rate of total non-current liabilities.", + "default": "", + "optional": false }, { - "name": "inventory", - "type": "int", - "description": "Inventory", - "default": null, - "optional": true + "name": "growth_other_liabilities", + "type": "float", + "description": "Growth rate of other liabilities.", + "default": "", + "optional": false }, { - "name": "other_non_current_assets", - "type": "int", - "description": "Other non-current assets", - "default": null, - "optional": true + "name": "growth_total_liabilities", + "type": "float", + "description": "Growth rate of total liabilities.", + "default": "", + "optional": false }, { - "name": "total_non_current_assets", - "type": "int", - "description": "Total non-current assets", - "default": null, - "optional": true + "name": "growth_common_stock", + "type": "float", + "description": "Growth rate of common stock.", + "default": "", + "optional": false }, { - "name": "intangible_assets", - "type": "int", - "description": "Intangible assets", - "default": null, - "optional": true + "name": "growth_retained_earnings", + "type": "float", + "description": "Growth rate of retained earnings.", + "default": "", + "optional": false }, { - "name": "total_assets", - "type": "int", - "description": "Total assets", - "default": null, - "optional": true + "name": "growth_accumulated_other_comprehensive_income_loss", + "type": "float", + "description": "Growth rate of accumulated other comprehensive income/loss.", + "default": "", + "optional": false }, { - "name": "accounts_payable", - "type": "int", - "description": "Accounts payable", - "default": null, - "optional": true + "name": "growth_othertotal_stockholders_equity", + "type": "float", + "description": "Growth rate of other total stockholders' equity.", + "default": "", + "optional": false }, { - "name": "employee_wages", - "type": "int", - "description": "Employee wages", - "default": null, - "optional": true + "name": "growth_total_stockholders_equity", + "type": "float", + "description": "Growth rate of total stockholders' equity.", + "default": "", + "optional": false }, { - "name": "other_current_liabilities", - "type": "int", - "description": "Other current liabilities", - "default": null, - "optional": true + "name": "growth_total_liabilities_and_stockholders_equity", + "type": "float", + "description": "Growth rate of total liabilities and stockholders' equity.", + "default": "", + "optional": false }, { - "name": "total_current_liabilities", - "type": "int", - "description": "Total current liabilities", - "default": null, - "optional": true + "name": "growth_total_investments", + "type": "float", + "description": "Growth rate of total investments.", + "default": "", + "optional": false }, { - "name": "other_non_current_liabilities", - "type": "int", - "description": "Other non-current liabilities", - "default": null, - "optional": true + "name": "growth_total_debt", + "type": "float", + "description": "Growth rate of total debt.", + "default": "", + "optional": false }, { - "name": "total_non_current_liabilities", - "type": "int", - "description": "Total non-current liabilities", - "default": null, - "optional": true + "name": "growth_net_debt", + "type": "float", + "description": "Growth rate of net debt.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "BalanceSheetGrowth" + }, + "/equity/fundamental/cash": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the cash flow statement for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.cash(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.cash(symbol='AAPL', period='annual', limit=5, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "long_term_debt", - "type": "int", - "description": "Long term debt", - "default": null, + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", "optional": true }, { - "name": "total_liabilities", - "type": "int", - "description": "Total liabilities", - "default": null, + "name": "limit", + "type": "Annotated[int, Ge(ge=0)]", + "description": "The number of data entries to return.", + "default": 5, "optional": true }, { - "name": "minority_interest", - "type": "int", - "description": "Minority interest", - "default": null, + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", + "description": "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.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "temporary_equity_attributable_to_parent", - "type": "int", - "description": "Temporary equity attributable to parent", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true + } + ], + "intrinio": [ + { + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", + "description": "None", + "default": "annual", "optional": true }, { - "name": "equity_attributable_to_parent", + "name": "fiscal_year", "type": "int", - "description": "Equity attributable to parent", + "description": "The specific fiscal year. Reports do not go beyond 2008.", "default": null, "optional": true + } + ], + "polygon": [ + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true }, { - "name": "temporary_equity", - "type": "int", - "description": "Temporary equity", + "name": "filing_date", + "type": "date", + "description": "Filing date of the financial statement.", "default": null, "optional": true }, { - "name": "preferred_stock", - "type": "int", - "description": "Preferred stock", + "name": "filing_date_lt", + "type": "date", + "description": "Filing date less than the given date.", "default": null, "optional": true }, { - "name": "redeemable_non_controlling_interest", - "type": "int", - "description": "Redeemable non-controlling interest", + "name": "filing_date_lte", + "type": "date", + "description": "Filing date less than or equal to the given date.", "default": null, "optional": true }, { - "name": "redeemable_non_controlling_interest_other", - "type": "int", - "description": "Redeemable non-controlling interest other", + "name": "filing_date_gt", + "type": "date", + "description": "Filing date greater than the given date.", "default": null, "optional": true }, { - "name": "total_stock_holders_equity", - "type": "int", - "description": "Total stock holders equity", + "name": "filing_date_gte", + "type": "date", + "description": "Filing date greater than or equal to the given date.", "default": null, "optional": true }, { - "name": "total_liabilities_and_stock_holders_equity", - "type": "int", - "description": "Total liabilities and stockholders equity", + "name": "period_of_report_date", + "type": "date", + "description": "Period of report date of the financial statement.", "default": null, "optional": true }, { - "name": "total_equity", - "type": "int", - "description": "Total equity", + "name": "period_of_report_date_lt", + "type": "date", + "description": "Period of report date less than the given date.", "default": null, "optional": true - } - ], - "yfinance": [ + }, { - "name": "period_ending", + "name": "period_of_report_date_lte", "type": "date", - "description": "The end date of the reporting period.", - "default": "", - "optional": false + "description": "Period of report date less than or equal to the given date.", + "default": null, + "optional": true }, { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the report.", + "name": "period_of_report_date_gt", + "type": "date", + "description": "Period of report date greater than the given date.", "default": null, "optional": true }, { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the fiscal period.", + "name": "period_of_report_date_gte", + "type": "date", + "description": "Period of report date greater than or equal to the given date.", "default": null, "optional": true - } - ] - }, - "model": "BalanceSheet" - }, - "/equity/fundamental/balance_growth": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the growth of a company's balance sheet items over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.balance_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.balance_growth(symbol='AAPL', limit=10, provider='fmp')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false + "name": "include_sources", + "type": "bool", + "description": "Whether to include the sources of the financial statement.", + "default": false, + "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 10, + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order of the financial statement.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", + "name": "sort", + "type": "Literal['filing_date', 'period_of_report_date']", + "description": "Sort of the financial statement.", + "default": null, "optional": true } ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, + "yfinance": [ { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 10, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", "optional": true } ] @@ -11495,12 +10199,12 @@ "OBBject": [ { "name": "results", - "type": "List[BalanceSheetGrowth]", + "type": "List[CashFlowStatement]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", "description": "Provider name." }, { @@ -11523,769 +10227,761 @@ "data": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": null, - "optional": true - }, - { - "name": "date", + "name": "period_ending", "type": "date", - "description": "The date of the data.", + "description": "The end date of the reporting period.", "default": "", "optional": false }, { - "name": "period", + "name": "fiscal_period", "type": "str", - "description": "Reporting period.", - "default": "", - "optional": false + "description": "The fiscal period of the report.", + "default": null, + "optional": true }, { - "name": "growth_cash_and_cash_equivalents", - "type": "float", - "description": "Growth rate of cash and cash equivalents.", - "default": "", - "optional": false + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true }, { - "name": "growth_short_term_investments", - "type": "float", - "description": "Growth rate of short-term investments.", - "default": "", - "optional": false + "name": "filing_date", + "type": "date", + "description": "The date of the filing.", + "default": null, + "optional": true }, { - "name": "growth_cash_and_short_term_investments", - "type": "float", - "description": "Growth rate of cash and short-term investments.", - "default": "", - "optional": false + "name": "accepted_date", + "type": "datetime", + "description": "The date the filing was accepted.", + "default": null, + "optional": true }, { - "name": "growth_net_receivables", - "type": "float", - "description": "Growth rate of net receivables.", - "default": "", - "optional": false + "name": "reported_currency", + "type": "str", + "description": "The currency in which the cash flow statement was reported.", + "default": null, + "optional": true }, { - "name": "growth_inventory", + "name": "net_income", "type": "float", - "description": "Growth rate of inventory.", - "default": "", - "optional": false + "description": "Net income.", + "default": null, + "optional": true }, { - "name": "growth_other_current_assets", + "name": "depreciation_and_amortization", "type": "float", - "description": "Growth rate of other current assets.", - "default": "", - "optional": false + "description": "Depreciation and amortization.", + "default": null, + "optional": true }, { - "name": "growth_total_current_assets", + "name": "deferred_income_tax", "type": "float", - "description": "Growth rate of total current assets.", - "default": "", - "optional": false + "description": "Deferred income tax.", + "default": null, + "optional": true }, { - "name": "growth_property_plant_equipment_net", + "name": "stock_based_compensation", "type": "float", - "description": "Growth rate of net property, plant, and equipment.", - "default": "", - "optional": false + "description": "Stock-based compensation.", + "default": null, + "optional": true }, { - "name": "growth_goodwill", + "name": "change_in_working_capital", "type": "float", - "description": "Growth rate of goodwill.", - "default": "", - "optional": false + "description": "Change in working capital.", + "default": null, + "optional": true }, { - "name": "growth_intangible_assets", + "name": "change_in_account_receivables", "type": "float", - "description": "Growth rate of intangible assets.", - "default": "", - "optional": false + "description": "Change in account receivables.", + "default": null, + "optional": true }, { - "name": "growth_goodwill_and_intangible_assets", + "name": "change_in_inventory", "type": "float", - "description": "Growth rate of goodwill and intangible assets.", - "default": "", - "optional": false + "description": "Change in inventory.", + "default": null, + "optional": true }, { - "name": "growth_long_term_investments", + "name": "change_in_account_payable", "type": "float", - "description": "Growth rate of long-term investments.", - "default": "", - "optional": false + "description": "Change in account payable.", + "default": null, + "optional": true }, { - "name": "growth_tax_assets", + "name": "change_in_other_working_capital", "type": "float", - "description": "Growth rate of tax assets.", - "default": "", - "optional": false + "description": "Change in other working capital.", + "default": null, + "optional": true }, { - "name": "growth_other_non_current_assets", + "name": "change_in_other_non_cash_items", "type": "float", - "description": "Growth rate of other non-current assets.", - "default": "", - "optional": false + "description": "Change in other non-cash items.", + "default": null, + "optional": true }, { - "name": "growth_total_non_current_assets", + "name": "net_cash_from_operating_activities", "type": "float", - "description": "Growth rate of total non-current assets.", - "default": "", - "optional": false + "description": "Net cash from operating activities.", + "default": null, + "optional": true }, { - "name": "growth_other_assets", + "name": "purchase_of_property_plant_and_equipment", "type": "float", - "description": "Growth rate of other assets.", - "default": "", - "optional": false + "description": "Purchase of property, plant and equipment.", + "default": null, + "optional": true }, { - "name": "growth_total_assets", + "name": "acquisitions", "type": "float", - "description": "Growth rate of total assets.", - "default": "", - "optional": false + "description": "Acquisitions.", + "default": null, + "optional": true }, { - "name": "growth_account_payables", + "name": "purchase_of_investment_securities", "type": "float", - "description": "Growth rate of accounts payable.", - "default": "", - "optional": false + "description": "Purchase of investment securities.", + "default": null, + "optional": true }, { - "name": "growth_short_term_debt", + "name": "sale_and_maturity_of_investments", "type": "float", - "description": "Growth rate of short-term debt.", - "default": "", - "optional": false + "description": "Sale and maturity of investments.", + "default": null, + "optional": true }, { - "name": "growth_tax_payables", + "name": "other_investing_activities", "type": "float", - "description": "Growth rate of tax payables.", - "default": "", - "optional": false + "description": "Other investing activities.", + "default": null, + "optional": true }, { - "name": "growth_deferred_revenue", + "name": "net_cash_from_investing_activities", "type": "float", - "description": "Growth rate of deferred revenue.", - "default": "", - "optional": false + "description": "Net cash from investing activities.", + "default": null, + "optional": true }, { - "name": "growth_other_current_liabilities", + "name": "repayment_of_debt", "type": "float", - "description": "Growth rate of other current liabilities.", - "default": "", - "optional": false + "description": "Repayment of debt.", + "default": null, + "optional": true }, { - "name": "growth_total_current_liabilities", + "name": "issuance_of_common_equity", "type": "float", - "description": "Growth rate of total current liabilities.", - "default": "", - "optional": false + "description": "Issuance of common equity.", + "default": null, + "optional": true }, { - "name": "growth_long_term_debt", + "name": "repurchase_of_common_equity", "type": "float", - "description": "Growth rate of long-term debt.", - "default": "", - "optional": false + "description": "Repurchase of common equity.", + "default": null, + "optional": true }, { - "name": "growth_deferred_revenue_non_current", + "name": "payment_of_dividends", "type": "float", - "description": "Growth rate of non-current deferred revenue.", - "default": "", - "optional": false + "description": "Payment of dividends.", + "default": null, + "optional": true }, { - "name": "growth_deferrred_tax_liabilities_non_current", + "name": "other_financing_activities", "type": "float", - "description": "Growth rate of non-current deferred tax liabilities.", - "default": "", - "optional": false + "description": "Other financing activities.", + "default": null, + "optional": true }, { - "name": "growth_other_non_current_liabilities", + "name": "net_cash_from_financing_activities", "type": "float", - "description": "Growth rate of other non-current liabilities.", - "default": "", - "optional": false + "description": "Net cash from financing activities.", + "default": null, + "optional": true }, { - "name": "growth_total_non_current_liabilities", + "name": "effect_of_exchange_rate_changes_on_cash", "type": "float", - "description": "Growth rate of total non-current liabilities.", - "default": "", - "optional": false + "description": "Effect of exchange rate changes on cash.", + "default": null, + "optional": true }, { - "name": "growth_other_liabilities", + "name": "net_change_in_cash_and_equivalents", "type": "float", - "description": "Growth rate of other liabilities.", - "default": "", - "optional": false + "description": "Net change in cash and equivalents.", + "default": null, + "optional": true }, { - "name": "growth_total_liabilities", + "name": "cash_at_beginning_of_period", "type": "float", - "description": "Growth rate of total liabilities.", - "default": "", - "optional": false + "description": "Cash at beginning of period.", + "default": null, + "optional": true }, { - "name": "growth_common_stock", + "name": "cash_at_end_of_period", "type": "float", - "description": "Growth rate of common stock.", - "default": "", - "optional": false + "description": "Cash at end of period.", + "default": null, + "optional": true }, { - "name": "growth_retained_earnings", + "name": "operating_cash_flow", "type": "float", - "description": "Growth rate of retained earnings.", - "default": "", - "optional": false + "description": "Operating cash flow.", + "default": null, + "optional": true }, { - "name": "growth_accumulated_other_comprehensive_income_loss", + "name": "capital_expenditure", "type": "float", - "description": "Growth rate of accumulated other comprehensive income/loss.", - "default": "", - "optional": false - }, - { - "name": "growth_othertotal_stockholders_equity", - "type": "float", - "description": "Growth rate of other total stockholders' equity.", - "default": "", - "optional": false - }, - { - "name": "growth_total_stockholders_equity", - "type": "float", - "description": "Growth rate of total stockholders' equity.", - "default": "", - "optional": false - }, - { - "name": "growth_total_liabilities_and_stockholders_equity", - "type": "float", - "description": "Growth rate of total liabilities and stockholders' equity.", - "default": "", - "optional": false + "description": "Capital expenditure.", + "default": null, + "optional": true }, { - "name": "growth_total_investments", + "name": "free_cash_flow", "type": "float", - "description": "Growth rate of total investments.", - "default": "", - "optional": false + "description": "None", + "default": null, + "optional": true }, { - "name": "growth_total_debt", - "type": "float", - "description": "Growth rate of total debt.", - "default": "", - "optional": false + "name": "link", + "type": "str", + "description": "Link to the filing.", + "default": null, + "optional": true }, { - "name": "growth_net_debt", - "type": "float", - "description": "Growth rate of net debt.", - "default": "", - "optional": false + "name": "final_link", + "type": "str", + "description": "Link to the filing document.", + "default": null, + "optional": true } ], - "fmp": [ + "intrinio": [ { - "name": "symbol", + "name": "reported_currency", "type": "str", - "description": "Symbol representing the entity requested in the data.", + "description": "The currency in which the balance sheet is reported.", "default": null, "optional": true }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "net_income_continuing_operations", + "type": "float", + "description": "Net Income (Continuing Operations)", + "default": null, + "optional": true }, { - "name": "period", - "type": "str", - "description": "Reporting period.", - "default": "", - "optional": false + "name": "net_income_discontinued_operations", + "type": "float", + "description": "Net Income (Discontinued Operations)", + "default": null, + "optional": true }, { - "name": "growth_cash_and_cash_equivalents", + "name": "net_income", "type": "float", - "description": "Growth rate of cash and cash equivalents.", - "default": "", - "optional": false + "description": "Consolidated Net Income.", + "default": null, + "optional": true }, { - "name": "growth_short_term_investments", + "name": "provision_for_loan_losses", "type": "float", - "description": "Growth rate of short-term investments.", - "default": "", - "optional": false + "description": "Provision for Loan Losses", + "default": null, + "optional": true }, { - "name": "growth_cash_and_short_term_investments", + "name": "provision_for_credit_losses", "type": "float", - "description": "Growth rate of cash and short-term investments.", - "default": "", - "optional": false + "description": "Provision for credit losses", + "default": null, + "optional": true }, { - "name": "growth_net_receivables", + "name": "depreciation_expense", "type": "float", - "description": "Growth rate of net receivables.", - "default": "", - "optional": false + "description": "Depreciation Expense.", + "default": null, + "optional": true }, { - "name": "growth_inventory", + "name": "amortization_expense", "type": "float", - "description": "Growth rate of inventory.", - "default": "", - "optional": false + "description": "Amortization Expense.", + "default": null, + "optional": true }, { - "name": "growth_other_current_assets", + "name": "share_based_compensation", "type": "float", - "description": "Growth rate of other current assets.", - "default": "", - "optional": false + "description": "Share-based compensation.", + "default": null, + "optional": true }, { - "name": "growth_total_current_assets", + "name": "non_cash_adjustments_to_reconcile_net_income", "type": "float", - "description": "Growth rate of total current assets.", - "default": "", - "optional": false + "description": "Non-Cash Adjustments to Reconcile Net Income.", + "default": null, + "optional": true }, { - "name": "growth_property_plant_equipment_net", + "name": "changes_in_operating_assets_and_liabilities", "type": "float", - "description": "Growth rate of net property, plant, and equipment.", - "default": "", - "optional": false + "description": "Changes in Operating Assets and Liabilities (Net)", + "default": null, + "optional": true }, { - "name": "growth_goodwill", + "name": "net_cash_from_continuing_operating_activities", "type": "float", - "description": "Growth rate of goodwill.", - "default": "", - "optional": false + "description": "Net Cash from Continuing Operating Activities", + "default": null, + "optional": true }, { - "name": "growth_intangible_assets", + "name": "net_cash_from_discontinued_operating_activities", "type": "float", - "description": "Growth rate of intangible assets.", - "default": "", - "optional": false + "description": "Net Cash from Discontinued Operating Activities", + "default": null, + "optional": true }, { - "name": "growth_goodwill_and_intangible_assets", + "name": "net_cash_from_operating_activities", "type": "float", - "description": "Growth rate of goodwill and intangible assets.", - "default": "", - "optional": false + "description": "Net Cash from Operating Activities", + "default": null, + "optional": true }, { - "name": "growth_long_term_investments", + "name": "divestitures", "type": "float", - "description": "Growth rate of long-term investments.", - "default": "", - "optional": false + "description": "Divestitures", + "default": null, + "optional": true }, { - "name": "growth_tax_assets", + "name": "sale_of_property_plant_and_equipment", "type": "float", - "description": "Growth rate of tax assets.", - "default": "", - "optional": false + "description": "Sale of Property, Plant, and Equipment", + "default": null, + "optional": true }, { - "name": "growth_other_non_current_assets", + "name": "acquisitions", "type": "float", - "description": "Growth rate of other non-current assets.", - "default": "", - "optional": false + "description": "Acquisitions", + "default": null, + "optional": true }, { - "name": "growth_total_non_current_assets", + "name": "purchase_of_investments", "type": "float", - "description": "Growth rate of total non-current assets.", - "default": "", - "optional": false + "description": "Purchase of Investments", + "default": null, + "optional": true }, { - "name": "growth_other_assets", + "name": "purchase_of_investment_securities", "type": "float", - "description": "Growth rate of other assets.", - "default": "", - "optional": false + "description": "Purchase of Investment Securities", + "default": null, + "optional": true }, { - "name": "growth_total_assets", + "name": "sale_and_maturity_of_investments", "type": "float", - "description": "Growth rate of total assets.", - "default": "", - "optional": false + "description": "Sale and Maturity of Investments", + "default": null, + "optional": true }, { - "name": "growth_account_payables", + "name": "loans_held_for_sale", "type": "float", - "description": "Growth rate of accounts payable.", - "default": "", - "optional": false + "description": "Loans Held for Sale (Net)", + "default": null, + "optional": true }, { - "name": "growth_short_term_debt", + "name": "purchase_of_property_plant_and_equipment", "type": "float", - "description": "Growth rate of short-term debt.", - "default": "", - "optional": false + "description": "Purchase of Property, Plant, and Equipment", + "default": null, + "optional": true }, { - "name": "growth_tax_payables", + "name": "other_investing_activities", "type": "float", - "description": "Growth rate of tax payables.", - "default": "", - "optional": false + "description": "Other Investing Activities (Net)", + "default": null, + "optional": true }, { - "name": "growth_deferred_revenue", + "name": "net_cash_from_continuing_investing_activities", "type": "float", - "description": "Growth rate of deferred revenue.", - "default": "", - "optional": false + "description": "Net Cash from Continuing Investing Activities", + "default": null, + "optional": true }, { - "name": "growth_other_current_liabilities", + "name": "net_cash_from_discontinued_investing_activities", "type": "float", - "description": "Growth rate of other current liabilities.", - "default": "", - "optional": false + "description": "Net Cash from Discontinued Investing Activities", + "default": null, + "optional": true }, { - "name": "growth_total_current_liabilities", + "name": "net_cash_from_investing_activities", "type": "float", - "description": "Growth rate of total current liabilities.", - "default": "", - "optional": false + "description": "Net Cash from Investing Activities", + "default": null, + "optional": true }, { - "name": "growth_long_term_debt", + "name": "payment_of_dividends", "type": "float", - "description": "Growth rate of long-term debt.", - "default": "", - "optional": false + "description": "Payment of Dividends", + "default": null, + "optional": true }, { - "name": "growth_deferred_revenue_non_current", + "name": "repurchase_of_common_equity", "type": "float", - "description": "Growth rate of non-current deferred revenue.", - "default": "", - "optional": false + "description": "Repurchase of Common Equity", + "default": null, + "optional": true }, { - "name": "growth_deferrred_tax_liabilities_non_current", + "name": "repurchase_of_preferred_equity", "type": "float", - "description": "Growth rate of non-current deferred tax liabilities.", - "default": "", - "optional": false + "description": "Repurchase of Preferred Equity", + "default": null, + "optional": true }, { - "name": "growth_other_non_current_liabilities", + "name": "issuance_of_common_equity", "type": "float", - "description": "Growth rate of other non-current liabilities.", - "default": "", - "optional": false + "description": "Issuance of Common Equity", + "default": null, + "optional": true }, { - "name": "growth_total_non_current_liabilities", + "name": "issuance_of_preferred_equity", "type": "float", - "description": "Growth rate of total non-current liabilities.", - "default": "", - "optional": false + "description": "Issuance of Preferred Equity", + "default": null, + "optional": true }, { - "name": "growth_other_liabilities", + "name": "issuance_of_debt", "type": "float", - "description": "Growth rate of other liabilities.", - "default": "", - "optional": false + "description": "Issuance of Debt", + "default": null, + "optional": true }, { - "name": "growth_total_liabilities", + "name": "repayment_of_debt", "type": "float", - "description": "Growth rate of total liabilities.", - "default": "", - "optional": false + "description": "Repayment of Debt", + "default": null, + "optional": true }, { - "name": "growth_common_stock", + "name": "other_financing_activities", "type": "float", - "description": "Growth rate of common stock.", - "default": "", - "optional": false + "description": "Other Financing Activities (Net)", + "default": null, + "optional": true }, { - "name": "growth_retained_earnings", + "name": "cash_interest_received", "type": "float", - "description": "Growth rate of retained earnings.", - "default": "", - "optional": false + "description": "Cash Interest Received", + "default": null, + "optional": true }, { - "name": "growth_accumulated_other_comprehensive_income_loss", + "name": "net_change_in_deposits", "type": "float", - "description": "Growth rate of accumulated other comprehensive income/loss.", - "default": "", - "optional": false + "description": "Net Change in Deposits", + "default": null, + "optional": true }, { - "name": "growth_othertotal_stockholders_equity", + "name": "net_increase_in_fed_funds_sold", "type": "float", - "description": "Growth rate of other total stockholders' equity.", - "default": "", - "optional": false + "description": "Net Increase in Fed Funds Sold", + "default": null, + "optional": true }, { - "name": "growth_total_stockholders_equity", + "name": "net_cash_from_continuing_financing_activities", "type": "float", - "description": "Growth rate of total stockholders' equity.", - "default": "", - "optional": false + "description": "Net Cash from Continuing Financing Activities", + "default": null, + "optional": true }, { - "name": "growth_total_liabilities_and_stockholders_equity", + "name": "net_cash_from_discontinued_financing_activities", "type": "float", - "description": "Growth rate of total liabilities and stockholders' equity.", - "default": "", - "optional": false + "description": "Net Cash from Discontinued Financing Activities", + "default": null, + "optional": true }, { - "name": "growth_total_investments", + "name": "net_cash_from_financing_activities", "type": "float", - "description": "Growth rate of total investments.", - "default": "", - "optional": false + "description": "Net Cash from Financing Activities", + "default": null, + "optional": true }, { - "name": "growth_total_debt", + "name": "effect_of_exchange_rate_changes", "type": "float", - "description": "Growth rate of total debt.", - "default": "", - "optional": false + "description": "Effect of Exchange Rate Changes", + "default": null, + "optional": true }, { - "name": "growth_net_debt", + "name": "other_net_changes_in_cash", "type": "float", - "description": "Growth rate of net debt.", - "default": "", - "optional": false - } - ] - }, - "model": "BalanceSheetGrowth" - }, - "/equity/fundamental/cash": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the cash flow statement for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.cash(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.cash(symbol='AAPL', period='annual', limit=5, provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "period", - "type": "str", - "description": "Time period of the data to return.", - "default": "annual", + "description": "Other Net Changes in Cash", + "default": null, "optional": true }, { - "name": "limit", - "type": "Annotated[int, Ge(ge=0)]", - "description": "The number of data entries to return.", - "default": 5, + "name": "net_change_in_cash_and_equivalents", + "type": "float", + "description": "Net Change in Cash and Equivalents", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", - "description": "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.", - "default": "fmp", + "name": "cash_income_taxes_paid", + "type": "float", + "description": "Cash Income Taxes Paid", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", + "name": "cash_interest_paid", + "type": "float", + "description": "Cash Interest Paid", + "default": null, "optional": true } ], - "intrinio": [ + "polygon": [ { - "name": "period", - "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", - "description": "None", - "default": "annual", + "name": "net_cash_flow_from_operating_activities_continuing", + "type": "int", + "description": "Net cash flow from operating activities continuing.", + "default": null, "optional": true }, { - "name": "fiscal_year", + "name": "net_cash_flow_from_operating_activities_discontinued", "type": "int", - "description": "The specific fiscal year. Reports do not go beyond 2008.", + "description": "Net cash flow from operating activities discontinued.", "default": null, "optional": true - } - ], - "polygon": [ - { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", - "optional": true }, { - "name": "filing_date", - "type": "date", - "description": "Filing date of the financial statement.", + "name": "net_cash_flow_from_operating_activities", + "type": "int", + "description": "Net cash flow from operating activities.", "default": null, "optional": true }, { - "name": "filing_date_lt", - "type": "date", - "description": "Filing date less than the given date.", + "name": "net_cash_flow_from_investing_activities_continuing", + "type": "int", + "description": "Net cash flow from investing activities continuing.", "default": null, "optional": true }, { - "name": "filing_date_lte", - "type": "date", - "description": "Filing date less than or equal to the given date.", + "name": "net_cash_flow_from_investing_activities_discontinued", + "type": "int", + "description": "Net cash flow from investing activities discontinued.", "default": null, "optional": true }, { - "name": "filing_date_gt", - "type": "date", - "description": "Filing date greater than the given date.", + "name": "net_cash_flow_from_investing_activities", + "type": "int", + "description": "Net cash flow from investing activities.", "default": null, "optional": true }, { - "name": "filing_date_gte", - "type": "date", - "description": "Filing date greater than or equal to the given date.", + "name": "net_cash_flow_from_financing_activities_continuing", + "type": "int", + "description": "Net cash flow from financing activities continuing.", "default": null, "optional": true }, { - "name": "period_of_report_date", - "type": "date", - "description": "Period of report date of the financial statement.", + "name": "net_cash_flow_from_financing_activities_discontinued", + "type": "int", + "description": "Net cash flow from financing activities discontinued.", "default": null, "optional": true }, { - "name": "period_of_report_date_lt", - "type": "date", - "description": "Period of report date less than the given date.", + "name": "net_cash_flow_from_financing_activities", + "type": "int", + "description": "Net cash flow from financing activities.", "default": null, "optional": true }, { - "name": "period_of_report_date_lte", - "type": "date", - "description": "Period of report date less than or equal to the given date.", + "name": "net_cash_flow_continuing", + "type": "int", + "description": "Net cash flow continuing.", "default": null, "optional": true }, { - "name": "period_of_report_date_gt", - "type": "date", - "description": "Period of report date greater than the given date.", + "name": "net_cash_flow_discontinued", + "type": "int", + "description": "Net cash flow discontinued.", "default": null, "optional": true }, { - "name": "period_of_report_date_gte", - "type": "date", - "description": "Period of report date greater than or equal to the given date.", + "name": "exchange_gains_losses", + "type": "int", + "description": "Exchange gains losses.", "default": null, "optional": true }, { - "name": "include_sources", - "type": "bool", - "description": "Whether to include the sources of the financial statement.", - "default": false, + "name": "net_cash_flow", + "type": "int", + "description": "Net cash flow.", + "default": null, + "optional": true + } + ], + "yfinance": [] + }, + "model": "CashFlowStatement" + }, + "/equity/fundamental/reported_financials": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get financial statements as reported by the company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.reported_financials(symbol='AAPL', provider='intrinio')\n# Get AAPL balance sheet with a limit of 10 items.\nobb.equity.fundamental.reported_financials(symbol='AAPL', period='annual', statement_type='balance', limit=10, provider='intrinio')\n# Get reported income statement\nobb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='income', provider='intrinio')\n# Get reported cash flow statement\nobb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='cash', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", "optional": true }, { - "name": "order", - "type": "Literal['asc', 'desc']", - "description": "Order of the financial statement.", - "default": null, + "name": "statement_type", + "type": "str", + "description": "The type of financial statement - i.e, balance, income, cash.", + "default": "balance", "optional": true }, { - "name": "sort", - "type": "Literal['filing_date', 'period_of_report_date']", - "description": "Sort of the financial statement.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return. Although the response object contains multiple results, because of the variance in the fields, year-to-year and quarter-to-quarter, it is recommended to view results in small chunks.", + "default": 100, + "optional": true + }, + { + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", "optional": true } ], - "yfinance": [ + "intrinio": [ { "name": "period", "type": "Literal['annual', 'quarter']", "description": "None", "default": "annual", "optional": true + }, + { + "name": "statement_type", + "type": "Literal['balance', 'income', 'cash']", + "description": "Cash flow statements are reported as YTD, Q4 is the same as FY.", + "default": "income", + "optional": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", + "default": null, + "optional": true } ] }, @@ -12293,12 +10989,12 @@ "OBBject": [ { "name": "results", - "type": "List[CashFlowStatement]", + "type": "List[ReportedFinancials]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", + "type": "Optional[Literal['intrinio']]", "description": "Provider name." }, { @@ -12323,16 +11019,16 @@ { "name": "period_ending", "type": "date", - "description": "The end date of the reporting period.", + "description": "The ending date of the reporting period.", "default": "", "optional": false }, { "name": "fiscal_period", "type": "str", - "description": "The fiscal period of the report.", - "default": null, - "optional": true + "description": "The fiscal period of the report (e.g. FY, Q1, etc.).", + "default": "", + "optional": false }, { "name": "fiscal_year", @@ -12342,703 +11038,618 @@ "optional": true } ], - "fmp": [ + "intrinio": [] + }, + "model": "ReportedFinancials" + }, + "/equity/fundamental/cash_growth": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the growth of a company's cash flow statement items over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.cash_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.cash_growth(symbol='AAPL', limit=10, provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "fiscal_year", + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "limit", "type": "int", - "description": "The fiscal year of the fiscal period.", - "default": null, + "description": "The number of data entries to return.", + "default": 10, "optional": true }, { - "name": "filing_date", - "type": "date", - "description": "The date of the filing.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CashFlowStatementGrowth]", + "description": "Serializable results." }, { - "name": "accepted_date", - "type": "datetime", - "description": "The date the filing was accepted.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "reported_currency", - "type": "str", - "description": "The currency in which the cash flow statement was reported.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "net_income", - "type": "float", - "description": "Net income.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "depreciation_and_amortization", - "type": "float", - "description": "Depreciation and amortization.", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "deferred_income_tax", - "type": "float", - "description": "Deferred income tax.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "stock_based_compensation", - "type": "float", - "description": "Stock-based compensation.", - "default": null, - "optional": true + "name": "period", + "type": "str", + "description": "Period the statement is returned for.", + "default": "", + "optional": false }, { - "name": "change_in_working_capital", + "name": "growth_net_income", "type": "float", - "description": "Change in working capital.", - "default": null, - "optional": true + "description": "Growth rate of net income.", + "default": "", + "optional": false }, { - "name": "change_in_account_receivables", + "name": "growth_depreciation_and_amortization", "type": "float", - "description": "Change in account receivables.", - "default": null, - "optional": true + "description": "Growth rate of depreciation and amortization.", + "default": "", + "optional": false }, { - "name": "change_in_inventory", + "name": "growth_deferred_income_tax", "type": "float", - "description": "Change in inventory.", - "default": null, - "optional": true + "description": "Growth rate of deferred income tax.", + "default": "", + "optional": false }, { - "name": "change_in_account_payable", + "name": "growth_stock_based_compensation", "type": "float", - "description": "Change in account payable.", - "default": null, - "optional": true + "description": "Growth rate of stock-based compensation.", + "default": "", + "optional": false }, { - "name": "change_in_other_working_capital", + "name": "growth_change_in_working_capital", "type": "float", - "description": "Change in other working capital.", - "default": null, - "optional": true + "description": "Growth rate of change in working capital.", + "default": "", + "optional": false }, { - "name": "change_in_other_non_cash_items", + "name": "growth_accounts_receivables", "type": "float", - "description": "Change in other non-cash items.", - "default": null, - "optional": true + "description": "Growth rate of accounts receivables.", + "default": "", + "optional": false }, { - "name": "net_cash_from_operating_activities", + "name": "growth_inventory", "type": "float", - "description": "Net cash from operating activities.", - "default": null, - "optional": true + "description": "Growth rate of inventory.", + "default": "", + "optional": false }, { - "name": "purchase_of_property_plant_and_equipment", + "name": "growth_accounts_payables", "type": "float", - "description": "Purchase of property, plant and equipment.", - "default": null, - "optional": true + "description": "Growth rate of accounts payables.", + "default": "", + "optional": false }, { - "name": "acquisitions", + "name": "growth_other_working_capital", "type": "float", - "description": "Acquisitions.", - "default": null, - "optional": true + "description": "Growth rate of other working capital.", + "default": "", + "optional": false }, { - "name": "purchase_of_investment_securities", + "name": "growth_other_non_cash_items", "type": "float", - "description": "Purchase of investment securities.", - "default": null, - "optional": true + "description": "Growth rate of other non-cash items.", + "default": "", + "optional": false }, { - "name": "sale_and_maturity_of_investments", + "name": "growth_net_cash_provided_by_operating_activities", "type": "float", - "description": "Sale and maturity of investments.", - "default": null, - "optional": true + "description": "Growth rate of net cash provided by operating activities.", + "default": "", + "optional": false }, { - "name": "other_investing_activities", + "name": "growth_investments_in_property_plant_and_equipment", "type": "float", - "description": "Other investing activities.", - "default": null, - "optional": true + "description": "Growth rate of investments in property, plant, and equipment.", + "default": "", + "optional": false }, { - "name": "net_cash_from_investing_activities", + "name": "growth_acquisitions_net", "type": "float", - "description": "Net cash from investing activities.", - "default": null, - "optional": true + "description": "Growth rate of net acquisitions.", + "default": "", + "optional": false }, { - "name": "repayment_of_debt", + "name": "growth_purchases_of_investments", "type": "float", - "description": "Repayment of debt.", - "default": null, - "optional": true + "description": "Growth rate of purchases of investments.", + "default": "", + "optional": false }, { - "name": "issuance_of_common_equity", + "name": "growth_sales_maturities_of_investments", "type": "float", - "description": "Issuance of common equity.", - "default": null, - "optional": true + "description": "Growth rate of sales maturities of investments.", + "default": "", + "optional": false }, { - "name": "repurchase_of_common_equity", + "name": "growth_other_investing_activities", "type": "float", - "description": "Repurchase of common equity.", - "default": null, - "optional": true + "description": "Growth rate of other investing activities.", + "default": "", + "optional": false }, { - "name": "payment_of_dividends", + "name": "growth_net_cash_used_for_investing_activities", "type": "float", - "description": "Payment of dividends.", - "default": null, - "optional": true + "description": "Growth rate of net cash used for investing activities.", + "default": "", + "optional": false }, { - "name": "other_financing_activities", + "name": "growth_debt_repayment", "type": "float", - "description": "Other financing activities.", - "default": null, - "optional": true + "description": "Growth rate of debt repayment.", + "default": "", + "optional": false }, { - "name": "net_cash_from_financing_activities", + "name": "growth_common_stock_issued", "type": "float", - "description": "Net cash from financing activities.", - "default": null, - "optional": true + "description": "Growth rate of common stock issued.", + "default": "", + "optional": false }, { - "name": "effect_of_exchange_rate_changes_on_cash", + "name": "growth_common_stock_repurchased", "type": "float", - "description": "Effect of exchange rate changes on cash.", - "default": null, - "optional": true + "description": "Growth rate of common stock repurchased.", + "default": "", + "optional": false }, { - "name": "net_change_in_cash_and_equivalents", + "name": "growth_dividends_paid", "type": "float", - "description": "Net change in cash and equivalents.", - "default": null, - "optional": true + "description": "Growth rate of dividends paid.", + "default": "", + "optional": false }, { - "name": "cash_at_beginning_of_period", + "name": "growth_other_financing_activities", "type": "float", - "description": "Cash at beginning of period.", - "default": null, - "optional": true + "description": "Growth rate of other financing activities.", + "default": "", + "optional": false }, { - "name": "cash_at_end_of_period", + "name": "growth_net_cash_used_provided_by_financing_activities", "type": "float", - "description": "Cash at end of period.", - "default": null, - "optional": true + "description": "Growth rate of net cash used/provided by financing activities.", + "default": "", + "optional": false }, { - "name": "operating_cash_flow", + "name": "growth_effect_of_forex_changes_on_cash", "type": "float", - "description": "Operating cash flow.", - "default": null, - "optional": true + "description": "Growth rate of the effect of foreign exchange changes on cash.", + "default": "", + "optional": false }, { - "name": "capital_expenditure", + "name": "growth_net_change_in_cash", "type": "float", - "description": "Capital expenditure.", - "default": null, - "optional": true + "description": "Growth rate of net change in cash.", + "default": "", + "optional": false }, { - "name": "free_cash_flow", + "name": "growth_cash_at_end_of_period", "type": "float", - "description": "None", - "default": null, - "optional": true - }, - { - "name": "link", - "type": "str", - "description": "Link to the filing.", - "default": null, - "optional": true - }, - { - "name": "final_link", - "type": "str", - "description": "Link to the filing document.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "reported_currency", - "type": "str", - "description": "The currency in which the balance sheet is reported.", - "default": null, - "optional": true + "description": "Growth rate of cash at the end of the period.", + "default": "", + "optional": false }, { - "name": "net_income_continuing_operations", + "name": "growth_cash_at_beginning_of_period", "type": "float", - "description": "Net Income (Continuing Operations)", - "default": null, - "optional": true + "description": "Growth rate of cash at the beginning of the period.", + "default": "", + "optional": false }, { - "name": "net_income_discontinued_operations", + "name": "growth_operating_cash_flow", "type": "float", - "description": "Net Income (Discontinued Operations)", - "default": null, - "optional": true + "description": "Growth rate of operating cash flow.", + "default": "", + "optional": false }, { - "name": "net_income", + "name": "growth_capital_expenditure", "type": "float", - "description": "Consolidated Net Income.", - "default": null, - "optional": true + "description": "Growth rate of capital expenditure.", + "default": "", + "optional": false }, { - "name": "provision_for_loan_losses", + "name": "growth_free_cash_flow", "type": "float", - "description": "Provision for Loan Losses", - "default": null, - "optional": true - }, + "description": "Growth rate of free cash flow.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "CashFlowStatementGrowth" + }, + "/equity/fundamental/dividends": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical dividend data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.dividends(symbol='AAPL', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ { - "name": "provision_for_credit_losses", - "type": "float", - "description": "Provision for credit losses", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "depreciation_expense", - "type": "float", - "description": "Depreciation Expense.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "amortization_expense", - "type": "float", - "description": "Amortization Expense.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "share_based_compensation", - "type": "float", - "description": "Share-based compensation.", - "default": null, - "optional": true - }, + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [], + "intrinio": [ { - "name": "non_cash_adjustments_to_reconcile_net_income", - "type": "float", - "description": "Non-Cash Adjustments to Reconcile Net Income.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100, "optional": true + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[HistoricalDividends]", + "description": "Serializable results." }, { - "name": "changes_in_operating_assets_and_liabilities", - "type": "float", - "description": "Changes in Operating Assets and Liabilities (Net)", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "description": "Provider name." }, { - "name": "net_cash_from_continuing_operating_activities", - "type": "float", - "description": "Net Cash from Continuing Operating Activities", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "net_cash_from_discontinued_operating_activities", - "type": "float", - "description": "Net Cash from Discontinued Operating Activities", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "net_cash_from_operating_activities", - "type": "float", - "description": "Net Cash from Operating Activities", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "ex_dividend_date", + "type": "date", + "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", + "default": "", + "optional": false }, { - "name": "divestitures", + "name": "amount", "type": "float", - "description": "Divestitures", - "default": null, - "optional": true + "description": "The dividend amount per share.", + "default": "", + "optional": false + } + ], + "fmp": [ + { + "name": "label", + "type": "str", + "description": "Label of the historical dividends.", + "default": "", + "optional": false }, { - "name": "sale_of_property_plant_and_equipment", + "name": "adj_dividend", "type": "float", - "description": "Sale of Property, Plant, and Equipment", - "default": null, - "optional": true + "description": "Adjusted dividend of the historical dividends.", + "default": "", + "optional": false }, { - "name": "acquisitions", - "type": "float", - "description": "Acquisitions", + "name": "record_date", + "type": "date", + "description": "Record date of the historical dividends.", "default": null, "optional": true }, { - "name": "purchase_of_investments", - "type": "float", - "description": "Purchase of Investments", + "name": "payment_date", + "type": "date", + "description": "Payment date of the historical dividends.", "default": null, "optional": true }, { - "name": "purchase_of_investment_securities", - "type": "float", - "description": "Purchase of Investment Securities", + "name": "declaration_date", + "type": "date", + "description": "Declaration date of the historical dividends.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "sale_and_maturity_of_investments", + "name": "factor", "type": "float", - "description": "Sale and Maturity of Investments", + "description": "factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.", "default": null, "optional": true }, { - "name": "loans_held_for_sale", - "type": "float", - "description": "Loans Held for Sale (Net)", + "name": "currency", + "type": "str", + "description": "The currency in which the dividend is paid.", "default": null, "optional": true }, { - "name": "purchase_of_property_plant_and_equipment", + "name": "split_ratio", "type": "float", - "description": "Purchase of Property, Plant, and Equipment", + "description": "The ratio of the stock split, if a stock split occurred.", "default": null, "optional": true + } + ], + "yfinance": [] + }, + "model": "HistoricalDividends" + }, + "/equity/fundamental/historical_eps": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical earnings per share data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_eps(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "other_investing_activities", - "type": "float", - "description": "Other Investing Activities (Net)", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "net_cash_from_continuing_investing_activities", - "type": "float", - "description": "Net Cash from Continuing Investing Activities", + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", "default": null, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[HistoricalEps]", + "description": "Serializable results." }, { - "name": "net_cash_from_discontinued_investing_activities", - "type": "float", - "description": "Net Cash from Discontinued Investing Activities", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "net_cash_from_investing_activities", - "type": "float", - "description": "Net Cash from Investing Activities", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "payment_of_dividends", - "type": "float", - "description": "Payment of Dividends", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "repurchase_of_common_equity", - "type": "float", - "description": "Repurchase of Common Equity", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", "default": null, "optional": true }, { - "name": "repurchase_of_preferred_equity", - "type": "float", - "description": "Repurchase of Preferred Equity", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "issuance_of_common_equity", - "type": "float", - "description": "Issuance of Common Equity", + "name": "announce_time", + "type": "str", + "description": "Timing of the earnings announcement.", "default": null, "optional": true }, { - "name": "issuance_of_preferred_equity", + "name": "eps_actual", "type": "float", - "description": "Issuance of Preferred Equity", + "description": "Actual EPS from the earnings date.", "default": null, "optional": true }, { - "name": "issuance_of_debt", + "name": "eps_estimated", "type": "float", - "description": "Issuance of Debt", + "description": "Estimated EPS for the earnings date.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "repayment_of_debt", + "name": "revenue_estimated", "type": "float", - "description": "Repayment of Debt", + "description": "Estimated consensus revenue for the reporting period.", "default": null, "optional": true }, { - "name": "other_financing_activities", + "name": "revenue_actual", "type": "float", - "description": "Other Financing Activities (Net)", + "description": "The actual reported revenue.", "default": null, "optional": true }, { - "name": "cash_interest_received", - "type": "float", - "description": "Cash Interest Received", - "default": null, - "optional": true - }, - { - "name": "net_change_in_deposits", - "type": "float", - "description": "Net Change in Deposits", - "default": null, - "optional": true - }, - { - "name": "net_increase_in_fed_funds_sold", - "type": "float", - "description": "Net Increase in Fed Funds Sold", - "default": null, - "optional": true - }, - { - "name": "net_cash_from_continuing_financing_activities", - "type": "float", - "description": "Net Cash from Continuing Financing Activities", - "default": null, - "optional": true - }, - { - "name": "net_cash_from_discontinued_financing_activities", - "type": "float", - "description": "Net Cash from Discontinued Financing Activities", - "default": null, - "optional": true - }, - { - "name": "net_cash_from_financing_activities", - "type": "float", - "description": "Net Cash from Financing Activities", - "default": null, - "optional": true - }, - { - "name": "effect_of_exchange_rate_changes", - "type": "float", - "description": "Effect of Exchange Rate Changes", - "default": null, - "optional": true - }, - { - "name": "other_net_changes_in_cash", - "type": "float", - "description": "Other Net Changes in Cash", - "default": null, - "optional": true - }, - { - "name": "net_change_in_cash_and_equivalents", - "type": "float", - "description": "Net Change in Cash and Equivalents", - "default": null, - "optional": true - }, - { - "name": "cash_income_taxes_paid", - "type": "float", - "description": "Cash Income Taxes Paid", - "default": null, - "optional": true - }, - { - "name": "cash_interest_paid", - "type": "float", - "description": "Cash Interest Paid", - "default": null, - "optional": true - } - ], - "polygon": [ - { - "name": "net_cash_flow_from_operating_activities_continuing", - "type": "int", - "description": "Net cash flow from operating activities continuing.", - "default": null, - "optional": true - }, - { - "name": "net_cash_flow_from_operating_activities_discontinued", - "type": "int", - "description": "Net cash flow from operating activities discontinued.", - "default": null, - "optional": true - }, - { - "name": "net_cash_flow_from_operating_activities", - "type": "int", - "description": "Net cash flow from operating activities.", - "default": null, - "optional": true - }, - { - "name": "net_cash_flow_from_investing_activities_continuing", - "type": "int", - "description": "Net cash flow from investing activities continuing.", - "default": null, - "optional": true - }, - { - "name": "net_cash_flow_from_investing_activities_discontinued", - "type": "int", - "description": "Net cash flow from investing activities discontinued.", - "default": null, - "optional": true - }, - { - "name": "net_cash_flow_from_investing_activities", - "type": "int", - "description": "Net cash flow from investing activities.", - "default": null, - "optional": true - }, - { - "name": "net_cash_flow_from_financing_activities_continuing", - "type": "int", - "description": "Net cash flow from financing activities continuing.", - "default": null, - "optional": true - }, - { - "name": "net_cash_flow_from_financing_activities_discontinued", - "type": "int", - "description": "Net cash flow from financing activities discontinued.", - "default": null, - "optional": true - }, - { - "name": "net_cash_flow_from_financing_activities", - "type": "int", - "description": "Net cash flow from financing activities.", - "default": null, - "optional": true - }, - { - "name": "net_cash_flow_continuing", - "type": "int", - "description": "Net cash flow continuing.", - "default": null, - "optional": true - }, - { - "name": "net_cash_flow_discontinued", - "type": "int", - "description": "Net cash flow discontinued.", + "name": "reporting_time", + "type": "str", + "description": "The reporting time - e.g. after market close.", "default": null, "optional": true }, { - "name": "exchange_gains_losses", - "type": "int", - "description": "Exchange gains losses.", + "name": "updated_at", + "type": "date", + "description": "The date when the data was last updated.", "default": null, "optional": true }, - { - "name": "net_cash_flow", - "type": "int", - "description": "Net cash flow.", - "default": null, - "optional": true - } - ], - "yfinance": [ { "name": "period_ending", "type": "date", - "description": "The end date of the reporting period.", - "default": "", - "optional": false - }, - { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the report.", - "default": null, - "optional": true - }, - { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the fiscal period.", + "description": "The fiscal period end date.", "default": null, "optional": true } ] }, - "model": "CashFlowStatement" + "model": "HistoricalEps" }, - "/equity/fundamental/reported_financials": { + "/equity/fundamental/employee_count": { "deprecated": { "flag": null, "message": null }, - "description": "Get financial statements as reported by the company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.reported_financials(symbol='AAPL', provider='intrinio')\n# Get AAPL balance sheet with a limit of 10 items.\nobb.equity.fundamental.reported_financials(symbol='AAPL', period='annual', statement_type='balance', limit=10, provider='intrinio')\n# Get reported income statement\nobb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='income', provider='intrinio')\n# Get reported cash flow statement\nobb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='cash', provider='intrinio')\n```\n\n", + "description": "Get historical employee count data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.employee_count(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { @@ -13048,69 +11659,26 @@ "default": "", "optional": false }, - { - "name": "period", - "type": "str", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - }, - { - "name": "statement_type", - "type": "str", - "description": "The type of financial statement - i.e, balance, income, cash.", - "default": "balance", - "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. Although the response object contains multiple results, because of the variance in the fields, year-to-year and quarter-to-quarter, it is recommended to view results in small chunks.", - "default": 100, - "optional": true - }, { "name": "provider", - "type": "Literal['intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true } ], - "intrinio": [ - { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", - "optional": true - }, - { - "name": "statement_type", - "type": "Literal['balance', 'income', 'cash']", - "description": "Cash flow statements are reported as YTD, Q4 is the same as FY.", - "default": "income", - "optional": true - }, - { - "name": "fiscal_year", - "type": "int", - "description": "The specific fiscal year. Reports do not go beyond 2008.", - "default": null, - "optional": true - } - ] + "fmp": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[ReportedFinancials]", + "type": "List[HistoricalEmployees]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['intrinio']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -13133,66 +11701,86 @@ "data": { "standard": [ { - "name": "period_ending", - "type": "date", - "description": "The ending date of the reporting period.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the report (e.g. FY, Q1, etc.).", + "name": "cik", + "type": "int", + "description": "Central Index Key (CIK) for the requested entity.", "default": "", "optional": false }, { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the fiscal period.", - "default": null, - "optional": true - } - ], - "intrinio": [ + "name": "acceptance_time", + "type": "datetime", + "description": "Time of acceptance of the company employee.", + "default": "", + "optional": false + }, { - "name": "period_ending", + "name": "period_of_report", "type": "date", - "description": "The ending date of the reporting period.", + "description": "Date of reporting of the company employee.", "default": "", "optional": false }, { - "name": "fiscal_period", + "name": "company_name", "type": "str", - "description": "The fiscal period of the report (e.g. FY, Q1, etc.).", + "description": "Registered name of the company to retrieve the historical employees of.", "default": "", "optional": false }, { - "name": "fiscal_year", + "name": "form_type", + "type": "str", + "description": "Form type of the company employee.", + "default": "", + "optional": false + }, + { + "name": "filing_date", + "type": "date", + "description": "Filing date of the company employee", + "default": "", + "optional": false + }, + { + "name": "employee_count", "type": "int", - "description": "The fiscal year of the fiscal period.", - "default": null, - "optional": true + "description": "Count of employees of the company.", + "default": "", + "optional": false + }, + { + "name": "source", + "type": "str", + "description": "Source URL which retrieves this data for the company.", + "default": "", + "optional": false } - ] + ], + "fmp": [] }, - "model": "ReportedFinancials" + "model": "HistoricalEmployees" }, - "/equity/fundamental/cash_growth": { + "/equity/fundamental/search_attributes": { "deprecated": { "flag": null, "message": null }, - "description": "Get the growth of a company's cash flow statement items over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.cash_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.cash_growth(symbol='AAPL', limit=10, provider='fmp')\n```\n\n", + "description": "Search Intrinio data tags to search in latest or historical attributes.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.search_attributes(query='ebitda', provider='intrinio')\n```\n\n", "parameters": { "standard": [ { - "name": "symbol", + "name": "query", "type": "str", - "description": "Symbol to get data for.", + "description": "Query to search for.", "default": "", "optional": false }, @@ -13200,44 +11788,29 @@ "name": "limit", "type": "int", "description": "The number of data entries to return.", - "default": 10, + "default": 1000, "optional": true }, { "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", "optional": true } ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 10, - "optional": true - } - ] + "intrinio": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[CashFlowStatementGrowth]", + "type": "List[SearchAttributes]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['intrinio']]", "description": "Provider name." }, { @@ -13260,245 +11833,283 @@ "data": { "standard": [ { - "name": "symbol", + "name": "id", "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": null, - "optional": true - }, - { - "name": "date", - "type": "date", - "description": "The date of the data.", + "description": "ID of the financial attribute.", "default": "", "optional": false }, { - "name": "period", + "name": "name", "type": "str", - "description": "Period the statement is returned for.", + "description": "Name of the financial attribute.", "default": "", "optional": false }, { - "name": "growth_net_income", - "type": "float", - "description": "Growth rate of net income.", + "name": "tag", + "type": "str", + "description": "Tag of the financial attribute.", "default": "", "optional": false }, { - "name": "growth_depreciation_and_amortization", - "type": "float", - "description": "Growth rate of depreciation and amortization.", + "name": "statement_code", + "type": "str", + "description": "Code of the financial statement.", "default": "", "optional": false }, { - "name": "growth_deferred_income_tax", - "type": "float", - "description": "Growth rate of deferred income tax.", - "default": "", - "optional": false + "name": "statement_type", + "type": "str", + "description": "Type of the financial statement.", + "default": null, + "optional": true }, { - "name": "growth_stock_based_compensation", - "type": "float", - "description": "Growth rate of stock-based compensation.", - "default": "", - "optional": false + "name": "parent_name", + "type": "str", + "description": "Parent's name of the financial attribute.", + "default": null, + "optional": true }, { - "name": "growth_change_in_working_capital", - "type": "float", - "description": "Growth rate of change in working capital.", - "default": "", - "optional": false + "name": "sequence", + "type": "int", + "description": "Sequence of the financial statement.", + "default": null, + "optional": true }, { - "name": "growth_accounts_receivables", - "type": "float", - "description": "Growth rate of accounts receivables.", - "default": "", - "optional": false + "name": "factor", + "type": "str", + "description": "Unit of the financial attribute.", + "default": null, + "optional": true }, { - "name": "growth_inventory", - "type": "float", - "description": "Growth rate of inventory.", - "default": "", - "optional": false + "name": "transaction", + "type": "str", + "description": "Transaction type (credit/debit) of the financial attribute.", + "default": null, + "optional": true }, { - "name": "growth_accounts_payables", - "type": "float", - "description": "Growth rate of accounts payables.", - "default": "", - "optional": false + "name": "type", + "type": "str", + "description": "Type of the financial attribute.", + "default": null, + "optional": true }, { - "name": "growth_other_working_capital", - "type": "float", - "description": "Growth rate of other working capital.", - "default": "", - "optional": false - }, + "name": "unit", + "type": "str", + "description": "Unit of the financial attribute.", + "default": null, + "optional": true + } + ], + "intrinio": [] + }, + "model": "SearchAttributes" + }, + "/equity/fundamental/latest_attributes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the latest value of a data tag from Intrinio.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.latest_attributes(symbol='AAPL', tag='ceo', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ { - "name": "growth_other_non_cash_items", - "type": "float", - "description": "Growth rate of other non-cash items.", + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", "default": "", "optional": false }, { - "name": "growth_net_cash_provided_by_operating_activities", - "type": "float", - "description": "Growth rate of net cash provided by operating activities.", + "name": "tag", + "type": "Union[str, List[str]]", + "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", "default": "", "optional": false }, { - "name": "growth_investments_in_property_plant_and_equipment", - "type": "float", - "description": "Growth rate of investments in property, plant, and equipment.", - "default": "", - "optional": false - }, + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", + "optional": true + } + ], + "intrinio": [] + }, + "returns": { + "OBBject": [ { - "name": "growth_acquisitions_net", - "type": "float", - "description": "Growth rate of net acquisitions.", - "default": "", - "optional": false + "name": "results", + "type": "List[LatestAttributes]", + "description": "Serializable results." }, { - "name": "growth_purchases_of_investments", - "type": "float", - "description": "Growth rate of purchases of investments.", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['intrinio']]", + "description": "Provider name." }, { - "name": "growth_sales_maturities_of_investments", - "type": "float", - "description": "Growth rate of sales maturities of investments.", - "default": "", - "optional": false + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "growth_other_investing_activities", - "type": "float", - "description": "Growth rate of other investing activities.", - "default": "", - "optional": false + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "growth_net_cash_used_for_investing_activities", - "type": "float", - "description": "Growth rate of net cash used for investing activities.", - "default": "", - "optional": false - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "growth_debt_repayment", - "type": "float", - "description": "Growth rate of debt repayment.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "growth_common_stock_issued", - "type": "float", - "description": "Growth rate of common stock issued.", - "default": "", - "optional": false + "name": "tag", + "type": "str", + "description": "Tag name for the fetched data.", + "default": null, + "optional": true }, { - "name": "growth_common_stock_repurchased", - "type": "float", - "description": "Growth rate of common stock repurchased.", + "name": "value", + "type": "Union[str, float]", + "description": "The value of the data.", + "default": null, + "optional": true + } + ], + "intrinio": [] + }, + "model": "LatestAttributes" + }, + "/equity/fundamental/historical_attributes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the historical values of a data tag from Intrinio.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_attributes(symbol='AAPL', tag='ebitda', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", "default": "", "optional": false }, { - "name": "growth_dividends_paid", - "type": "float", - "description": "Growth rate of dividends paid.", + "name": "tag", + "type": "Union[str, List[str]]", + "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", "default": "", "optional": false }, { - "name": "growth_other_financing_activities", - "type": "float", - "description": "Growth rate of other financing activities.", - "default": "", - "optional": false + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true }, { - "name": "growth_net_cash_used_provided_by_financing_activities", - "type": "float", - "description": "Growth rate of net cash used/provided by financing activities.", - "default": "", - "optional": false + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true }, { - "name": "growth_effect_of_forex_changes_on_cash", - "type": "float", - "description": "Growth rate of the effect of foreign exchange changes on cash.", - "default": "", - "optional": false + "name": "frequency", + "type": "Literal['daily', 'weekly', 'monthly', 'quarterly', 'yearly']", + "description": "The frequency of the data.", + "default": "yearly", + "optional": true }, { - "name": "growth_net_change_in_cash", - "type": "float", - "description": "Growth rate of net change in cash.", - "default": "", - "optional": false + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 1000, + "optional": true }, { - "name": "growth_cash_at_end_of_period", - "type": "float", - "description": "Growth rate of cash at the end of the period.", - "default": "", - "optional": false + "name": "tag_type", + "type": "str", + "description": "Filter by type, when applicable.", + "default": null, + "optional": true }, { - "name": "growth_cash_at_beginning_of_period", - "type": "float", - "description": "Growth rate of cash at the beginning of the period.", - "default": "", - "optional": false + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order.", + "default": "desc", + "optional": true }, { - "name": "growth_operating_cash_flow", - "type": "float", - "description": "Growth rate of operating cash flow.", - "default": "", - "optional": false + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", + "optional": true + } + ], + "intrinio": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[HistoricalAttributes]", + "description": "Serializable results." }, { - "name": "growth_capital_expenditure", - "type": "float", - "description": "Growth rate of capital expenditure.", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['intrinio']]", + "description": "Provider name." }, { - "name": "growth_free_cash_flow", - "type": "float", - "description": "Growth rate of free cash flow.", - "default": "", - "optional": false - } - ], - "fmp": [ + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { "name": "date", "type": "date", @@ -13507,2724 +12118,2653 @@ "optional": false }, { - "name": "period", + "name": "symbol", "type": "str", - "description": "Period the statement is returned for.", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "growth_net_income", - "type": "float", - "description": "Growth rate of net income.", - "default": "", - "optional": false + "name": "tag", + "type": "str", + "description": "Tag name for the fetched data.", + "default": null, + "optional": true }, { - "name": "growth_depreciation_and_amortization", + "name": "value", "type": "float", - "description": "Growth rate of depreciation and amortization.", - "default": "", - "optional": false - }, + "description": "The value of the data.", + "default": null, + "optional": true + } + ], + "intrinio": [] + }, + "model": "HistoricalAttributes" + }, + "/equity/fundamental/income": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the income statement for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.income(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.income(symbol='AAPL', period='annual', limit=5, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ { - "name": "growth_deferred_income_tax", - "type": "float", - "description": "Growth rate of deferred income tax.", + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", "default": "", "optional": false }, { - "name": "growth_stock_based_compensation", - "type": "float", - "description": "Growth rate of stock-based compensation.", - "default": "", - "optional": false + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true }, { - "name": "growth_change_in_working_capital", - "type": "float", - "description": "Growth rate of change in working capital.", - "default": "", - "optional": false + "name": "limit", + "type": "Annotated[int, Ge(ge=0)]", + "description": "The number of data entries to return.", + "default": 5, + "optional": true }, { - "name": "growth_accounts_receivables", - "type": "float", - "description": "Growth rate of accounts receivables.", - "default": "", - "optional": false - }, + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ { - "name": "growth_inventory", - "type": "float", - "description": "Growth rate of inventory.", - "default": "", - "optional": false - }, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true + } + ], + "intrinio": [ { - "name": "growth_accounts_payables", - "type": "float", - "description": "Growth rate of accounts payables.", - "default": "", - "optional": false + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", + "description": "None", + "default": "annual", + "optional": true }, { - "name": "growth_other_working_capital", - "type": "float", - "description": "Growth rate of other working capital.", - "default": "", - "optional": false - }, + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", + "default": null, + "optional": true + } + ], + "polygon": [ { - "name": "growth_other_non_cash_items", - "type": "float", - "description": "Growth rate of other non-cash items.", - "default": "", - "optional": false + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm']", + "description": "None", + "default": "annual", + "optional": true }, { - "name": "growth_net_cash_provided_by_operating_activities", - "type": "float", - "description": "Growth rate of net cash provided by operating activities.", - "default": "", - "optional": false + "name": "filing_date", + "type": "date", + "description": "Filing date of the financial statement.", + "default": null, + "optional": true }, { - "name": "growth_investments_in_property_plant_and_equipment", - "type": "float", - "description": "Growth rate of investments in property, plant, and equipment.", - "default": "", - "optional": false + "name": "filing_date_lt", + "type": "date", + "description": "Filing date less than the given date.", + "default": null, + "optional": true }, { - "name": "growth_acquisitions_net", - "type": "float", - "description": "Growth rate of net acquisitions.", - "default": "", - "optional": false + "name": "filing_date_lte", + "type": "date", + "description": "Filing date less than or equal to the given date.", + "default": null, + "optional": true }, { - "name": "growth_purchases_of_investments", - "type": "float", - "description": "Growth rate of purchases of investments.", - "default": "", - "optional": false + "name": "filing_date_gt", + "type": "date", + "description": "Filing date greater than the given date.", + "default": null, + "optional": true }, { - "name": "growth_sales_maturities_of_investments", - "type": "float", - "description": "Growth rate of sales maturities of investments.", - "default": "", - "optional": false + "name": "filing_date_gte", + "type": "date", + "description": "Filing date greater than or equal to the given date.", + "default": null, + "optional": true }, { - "name": "growth_other_investing_activities", - "type": "float", - "description": "Growth rate of other investing activities.", - "default": "", - "optional": false + "name": "period_of_report_date", + "type": "date", + "description": "Period of report date of the financial statement.", + "default": null, + "optional": true }, { - "name": "growth_net_cash_used_for_investing_activities", - "type": "float", - "description": "Growth rate of net cash used for investing activities.", - "default": "", - "optional": false + "name": "period_of_report_date_lt", + "type": "date", + "description": "Period of report date less than the given date.", + "default": null, + "optional": true }, { - "name": "growth_debt_repayment", - "type": "float", - "description": "Growth rate of debt repayment.", - "default": "", - "optional": false + "name": "period_of_report_date_lte", + "type": "date", + "description": "Period of report date less than or equal to the given date.", + "default": null, + "optional": true }, { - "name": "growth_common_stock_issued", - "type": "float", - "description": "Growth rate of common stock issued.", - "default": "", - "optional": false + "name": "period_of_report_date_gt", + "type": "date", + "description": "Period of report date greater than the given date.", + "default": null, + "optional": true }, { - "name": "growth_common_stock_repurchased", - "type": "float", - "description": "Growth rate of common stock repurchased.", - "default": "", - "optional": false + "name": "period_of_report_date_gte", + "type": "date", + "description": "Period of report date greater than or equal to the given date.", + "default": null, + "optional": true }, { - "name": "growth_dividends_paid", - "type": "float", - "description": "Growth rate of dividends paid.", - "default": "", - "optional": false + "name": "include_sources", + "type": "bool", + "description": "Whether to include the sources of the financial statement.", + "default": null, + "optional": true }, { - "name": "growth_other_financing_activities", - "type": "float", - "description": "Growth rate of other financing activities.", - "default": "", - "optional": false + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order of the financial statement.", + "default": null, + "optional": true }, { - "name": "growth_net_cash_used_provided_by_financing_activities", - "type": "float", - "description": "Growth rate of net cash used/provided by financing activities.", - "default": "", - "optional": false - }, + "name": "sort", + "type": "Literal['filing_date', 'period_of_report_date']", + "description": "Sort of the financial statement.", + "default": null, + "optional": true + } + ], + "yfinance": [ { - "name": "growth_effect_of_forex_changes_on_cash", - "type": "float", - "description": "Growth rate of the effect of foreign exchange changes on cash.", - "default": "", - "optional": false + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[IncomeStatement]", + "description": "Serializable results." }, { - "name": "growth_net_change_in_cash", - "type": "float", - "description": "Growth rate of net change in cash.", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", + "description": "Provider name." }, { - "name": "growth_cash_at_end_of_period", - "type": "float", - "description": "Growth rate of cash at the end of the period.", - "default": "", - "optional": false + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "growth_cash_at_beginning_of_period", - "type": "float", - "description": "Growth rate of cash at the beginning of the period.", - "default": "", - "optional": false + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "growth_operating_cash_flow", - "type": "float", - "description": "Growth rate of operating cash flow.", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", "default": "", "optional": false }, { - "name": "growth_capital_expenditure", - "type": "float", - "description": "Growth rate of capital expenditure.", - "default": "", - "optional": false + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", + "default": null, + "optional": true }, { - "name": "growth_free_cash_flow", - "type": "float", - "description": "Growth rate of free cash flow.", - "default": "", - "optional": false + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true } - ] - }, - "model": "CashFlowStatementGrowth" - }, - "/equity/fundamental/dividends": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get historical dividend data for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.dividends(symbol='AAPL', provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ + ], + "fmp": [ { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false + "name": "filing_date", + "type": "date", + "description": "The date when the filing was made.", + "default": null, + "optional": true }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "accepted_date", + "type": "datetime", + "description": "The date and time when the filing was accepted.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet was reported.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'yfinance']", - "description": "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.", - "default": "fmp", + "name": "revenue", + "type": "float", + "description": "Total revenue.", + "default": null, "optional": true - } - ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "cost_of_revenue", + "type": "float", + "description": "Cost of revenue.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "gross_profit", + "type": "float", + "description": "Gross profit.", "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 100, + "name": "gross_profit_margin", + "type": "float", + "description": "Gross profit margin.", + "default": null, "optional": true - } - ], - "yfinance": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "general_and_admin_expense", + "type": "float", + "description": "General and administrative expenses.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "research_and_development_expense", + "type": "float", + "description": "Research and development expenses.", "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[HistoricalDividends]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", - "description": "Provider name." + "name": "selling_and_marketing_expense", + "type": "float", + "description": "Selling and marketing expenses.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "selling_general_and_admin_expense", + "type": "float", + "description": "Selling, general and administrative expenses.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "other_expenses", + "type": "float", + "description": "Other expenses.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "total_operating_expenses", + "type": "float", + "description": "Total operating expenses.", + "default": null, + "optional": true + }, { - "name": "ex_dividend_date", - "type": "date", - "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", - "default": "", - "optional": false + "name": "cost_and_expenses", + "type": "float", + "description": "Cost and expenses.", + "default": null, + "optional": true }, { - "name": "amount", + "name": "interest_income", "type": "float", - "description": "The dividend amount per share.", - "default": "", - "optional": false - } - ], - "fmp": [ + "description": "Interest income.", + "default": null, + "optional": true + }, { - "name": "label", - "type": "str", - "description": "Label of the historical dividends.", - "default": "", - "optional": false + "name": "total_interest_expense", + "type": "float", + "description": "Total interest expenses.", + "default": null, + "optional": true }, { - "name": "adj_dividend", + "name": "depreciation_and_amortization", "type": "float", - "description": "Adjusted dividend of the historical dividends.", - "default": "", - "optional": false + "description": "Depreciation and amortization.", + "default": null, + "optional": true }, { - "name": "record_date", - "type": "date", - "description": "Record date of the historical dividends.", + "name": "ebitda", + "type": "float", + "description": "EBITDA.", "default": null, "optional": true }, { - "name": "payment_date", - "type": "date", - "description": "Payment date of the historical dividends.", + "name": "ebitda_margin", + "type": "float", + "description": "EBITDA margin.", "default": null, "optional": true }, { - "name": "declaration_date", - "type": "date", - "description": "Declaration date of the historical dividends.", + "name": "total_operating_income", + "type": "float", + "description": "Total operating income.", "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "factor", + "name": "operating_income_margin", "type": "float", - "description": "factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.", + "description": "Operating income margin.", "default": null, "optional": true }, { - "name": "currency", - "type": "str", - "description": "The currency in which the dividend is paid.", + "name": "total_other_income_expenses", + "type": "float", + "description": "Total other income and expenses.", "default": null, "optional": true }, { - "name": "split_ratio", + "name": "total_pre_tax_income", "type": "float", - "description": "The ratio of the stock split, if a stock split occurred.", + "description": "Total pre-tax income.", "default": null, "optional": true - } - ], - "yfinance": [ + }, { - "name": "ex_dividend_date", - "type": "date", - "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", - "default": "", - "optional": false + "name": "pre_tax_income_margin", + "type": "float", + "description": "Pre-tax income margin.", + "default": null, + "optional": true }, { - "name": "amount", + "name": "income_tax_expense", "type": "float", - "description": "The dividend amount per share.", - "default": "", - "optional": false - } - ] - }, - "model": "HistoricalDividends" - }, - "/equity/fundamental/historical_eps": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get historical earnings per share data for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_eps(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false + "description": "Income tax expense.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", + "name": "consolidated_net_income", + "type": "float", + "description": "Consolidated net income.", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", + "name": "net_income_margin", + "type": "float", + "description": "Net income margin.", "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[HistoricalEps]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "basic_earnings_per_share", + "type": "float", + "description": "Basic earnings per share.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "diluted_earnings_per_share", + "type": "float", + "description": "Diluted earnings per share.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "weighted_average_basic_shares_outstanding", + "type": "float", + "description": "Weighted average basic shares outstanding.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "weighted_average_diluted_shares_outstanding", + "type": "float", + "description": "Weighted average diluted shares outstanding.", "default": null, "optional": true }, { - "name": "symbol", + "name": "link", "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "description": "Link to the filing.", + "default": null, + "optional": true }, { - "name": "announce_time", + "name": "final_link", "type": "str", - "description": "Timing of the earnings announcement.", + "description": "Link to the filing document.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet is reported.", "default": null, "optional": true }, { - "name": "eps_actual", + "name": "revenue", "type": "float", - "description": "Actual EPS from the earnings date.", + "description": "Total revenue", "default": null, "optional": true }, { - "name": "eps_estimated", + "name": "operating_revenue", "type": "float", - "description": "Estimated EPS for the earnings date.", + "description": "Total operating revenue", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "revenue_estimated", + "name": "cost_of_revenue", "type": "float", - "description": "Estimated consensus revenue for the reporting period.", + "description": "Total cost of revenue", "default": null, "optional": true }, { - "name": "revenue_actual", + "name": "operating_cost_of_revenue", "type": "float", - "description": "The actual reported revenue.", + "description": "Total operating cost of revenue", "default": null, "optional": true }, { - "name": "reporting_time", - "type": "str", - "description": "The reporting time - e.g. after market close.", + "name": "gross_profit", + "type": "float", + "description": "Total gross profit", "default": null, "optional": true }, { - "name": "updated_at", - "type": "date", - "description": "The date when the data was last updated.", + "name": "gross_profit_margin", + "type": "float", + "description": "Gross margin ratio.", "default": null, "optional": true }, { - "name": "period_ending", - "type": "date", - "description": "The fiscal period end date.", + "name": "provision_for_credit_losses", + "type": "float", + "description": "Provision for credit losses", "default": null, "optional": true - } - ] - }, - "model": "HistoricalEps" - }, - "/equity/fundamental/employee_count": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get historical employee count data for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.employee_count(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", + "name": "research_and_development_expense", + "type": "float", + "description": "Research and development expense", + "default": null, "optional": true - } - ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[HistoricalEmployees]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "selling_general_and_admin_expense", + "type": "float", + "description": "Selling, general, and admin expense", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "salaries_and_employee_benefits", + "type": "float", + "description": "Salaries and employee benefits", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "marketing_expense", + "type": "float", + "description": "Marketing expense", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "net_occupancy_and_equipment_expense", + "type": "float", + "description": "Net occupancy and equipment expense", + "default": null, + "optional": true + }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "other_operating_expenses", + "type": "float", + "description": "Other operating expenses", + "default": null, + "optional": true }, { - "name": "cik", - "type": "int", - "description": "Central Index Key (CIK) for the requested entity.", - "default": "", - "optional": false + "name": "depreciation_expense", + "type": "float", + "description": "Depreciation expense", + "default": null, + "optional": true }, { - "name": "acceptance_time", - "type": "datetime", - "description": "Time of acceptance of the company employee.", - "default": "", - "optional": false + "name": "amortization_expense", + "type": "float", + "description": "Amortization expense", + "default": null, + "optional": true }, { - "name": "period_of_report", - "type": "date", - "description": "Date of reporting of the company employee.", - "default": "", - "optional": false + "name": "amortization_of_deferred_policy_acquisition_costs", + "type": "float", + "description": "Amortization of deferred policy acquisition costs", + "default": null, + "optional": true }, { - "name": "company_name", - "type": "str", - "description": "Registered name of the company to retrieve the historical employees of.", - "default": "", - "optional": false + "name": "exploration_expense", + "type": "float", + "description": "Exploration expense", + "default": null, + "optional": true }, { - "name": "form_type", - "type": "str", - "description": "Form type of the company employee.", - "default": "", - "optional": false + "name": "depletion_expense", + "type": "float", + "description": "Depletion expense", + "default": null, + "optional": true }, { - "name": "filing_date", - "type": "date", - "description": "Filing date of the company employee", - "default": "", - "optional": false + "name": "total_operating_expenses", + "type": "float", + "description": "Total operating expenses", + "default": null, + "optional": true }, { - "name": "employee_count", - "type": "int", - "description": "Count of employees of the company.", - "default": "", - "optional": false + "name": "total_operating_income", + "type": "float", + "description": "Total operating income", + "default": null, + "optional": true }, { - "name": "source", - "type": "str", - "description": "Source URL which retrieves this data for the company.", - "default": "", - "optional": false - } - ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "deposits_and_money_market_investments_interest_income", + "type": "float", + "description": "Deposits and money market investments interest income", + "default": null, + "optional": true }, { - "name": "cik", - "type": "int", - "description": "Central Index Key (CIK) for the requested entity.", - "default": "", - "optional": false + "name": "federal_funds_sold_and_securities_borrowed_interest_income", + "type": "float", + "description": "Federal funds sold and securities borrowed interest income", + "default": null, + "optional": true }, { - "name": "acceptance_time", - "type": "datetime", - "description": "Time of acceptance of the company employee.", - "default": "", - "optional": false + "name": "investment_securities_interest_income", + "type": "float", + "description": "Investment securities interest income", + "default": null, + "optional": true }, { - "name": "period_of_report", - "type": "date", - "description": "Date of reporting of the company employee.", - "default": "", - "optional": false + "name": "loans_and_leases_interest_income", + "type": "float", + "description": "Loans and leases interest income", + "default": null, + "optional": true }, { - "name": "company_name", - "type": "str", - "description": "Registered name of the company to retrieve the historical employees of.", - "default": "", - "optional": false + "name": "trading_account_interest_income", + "type": "float", + "description": "Trading account interest income", + "default": null, + "optional": true }, { - "name": "form_type", - "type": "str", - "description": "Form type of the company employee.", - "default": "", - "optional": false + "name": "other_interest_income", + "type": "float", + "description": "Other interest income", + "default": null, + "optional": true }, { - "name": "filing_date", - "type": "date", - "description": "Filing date of the company employee", - "default": "", - "optional": false + "name": "total_non_interest_income", + "type": "float", + "description": "Total non-interest income", + "default": null, + "optional": true }, { - "name": "employee_count", - "type": "int", - "description": "Count of employees of the company.", - "default": "", - "optional": false + "name": "interest_and_investment_income", + "type": "float", + "description": "Interest and investment income", + "default": null, + "optional": true }, { - "name": "source", - "type": "str", - "description": "Source URL which retrieves this data for the company.", - "default": "", - "optional": false - } - ] - }, - "model": "HistoricalEmployees" - }, - "/equity/fundamental/search_attributes": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Search Intrinio data tags to search in latest or historical attributes.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.search_attributes(query='ebitda', provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "query", - "type": "str", - "description": "Query to search for.", - "default": "", - "optional": false + "name": "short_term_borrowings_interest_expense", + "type": "float", + "description": "Short-term borrowings interest expense", + "default": null, + "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 1000, + "name": "long_term_debt_interest_expense", + "type": "float", + "description": "Long-term debt interest expense", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", + "name": "capitalized_lease_obligations_interest_expense", + "type": "float", + "description": "Capitalized lease obligations interest expense", + "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "query", - "type": "str", - "description": "Query to search for.", - "default": "", - "optional": false + "name": "deposits_interest_expense", + "type": "float", + "description": "Deposits interest expense", + "default": null, + "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 1000, + "name": "federal_funds_purchased_and_securities_sold_interest_expense", + "type": "float", + "description": "Federal funds purchased and securities sold interest expense", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[SearchAttributes]", - "description": "Serializable results." + "name": "other_interest_expense", + "type": "float", + "description": "Other interest expense", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['intrinio']]", - "description": "Provider name." + "name": "total_interest_expense", + "type": "float", + "description": "Total interest expense", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "net_interest_income", + "type": "float", + "description": "Net interest income", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "other_non_interest_income", + "type": "float", + "description": "Other non-interest income", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "id", - "type": "str", - "description": "ID of the financial attribute.", - "default": "", - "optional": false + "name": "investment_banking_income", + "type": "float", + "description": "Investment banking income", + "default": null, + "optional": true }, { - "name": "name", - "type": "str", - "description": "Name of the financial attribute.", - "default": "", - "optional": false + "name": "trust_fees_by_commissions", + "type": "float", + "description": "Trust fees by commissions", + "default": null, + "optional": true }, { - "name": "tag", - "type": "str", - "description": "Tag of the financial attribute.", - "default": "", - "optional": false + "name": "premiums_earned", + "type": "float", + "description": "Premiums earned", + "default": null, + "optional": true }, { - "name": "statement_code", - "type": "str", - "description": "Code of the financial statement.", - "default": "", - "optional": false + "name": "insurance_policy_acquisition_costs", + "type": "float", + "description": "Insurance policy acquisition costs", + "default": null, + "optional": true }, { - "name": "statement_type", - "type": "str", - "description": "Type of the financial statement.", + "name": "current_and_future_benefits", + "type": "float", + "description": "Current and future benefits", "default": null, "optional": true }, { - "name": "parent_name", - "type": "str", - "description": "Parent's name of the financial attribute.", + "name": "property_and_liability_insurance_claims", + "type": "float", + "description": "Property and liability insurance claims", "default": null, "optional": true }, { - "name": "sequence", - "type": "int", - "description": "Sequence of the financial statement.", + "name": "total_non_interest_expense", + "type": "float", + "description": "Total non-interest expense", "default": null, "optional": true }, { - "name": "factor", - "type": "str", - "description": "Unit of the financial attribute.", + "name": "net_realized_and_unrealized_capital_gains_on_investments", + "type": "float", + "description": "Net realized and unrealized capital gains on investments", "default": null, "optional": true }, { - "name": "transaction", - "type": "str", - "description": "Transaction type (credit/debit) of the financial attribute.", + "name": "other_gains", + "type": "float", + "description": "Other gains", "default": null, "optional": true }, { - "name": "type", - "type": "str", - "description": "Type of the financial attribute.", + "name": "non_operating_income", + "type": "float", + "description": "Non-operating income", "default": null, "optional": true }, { - "name": "unit", - "type": "str", - "description": "Unit of the financial attribute.", + "name": "other_income", + "type": "float", + "description": "Other income", "default": null, "optional": true - } - ], - "intrinio": [ - { - "name": "id", - "type": "str", - "description": "ID of the financial attribute.", - "default": "", - "optional": false }, { - "name": "name", - "type": "str", - "description": "Name of the financial attribute.", - "default": "", - "optional": false + "name": "other_revenue", + "type": "float", + "description": "Other revenue", + "default": null, + "optional": true }, { - "name": "tag", - "type": "str", - "description": "Tag of the financial attribute.", - "default": "", - "optional": false + "name": "extraordinary_income", + "type": "float", + "description": "Extraordinary income", + "default": null, + "optional": true }, { - "name": "statement_code", - "type": "str", - "description": "Code of the financial statement.", - "default": "", - "optional": false + "name": "total_other_income", + "type": "float", + "description": "Total other income", + "default": null, + "optional": true }, { - "name": "statement_type", - "type": "str", - "description": "Type of the financial statement.", + "name": "ebitda", + "type": "float", + "description": "Earnings Before Interest, Taxes, Depreciation and Amortization.", "default": null, "optional": true }, { - "name": "parent_name", - "type": "str", - "description": "Parent's name of the financial attribute.", + "name": "ebitda_margin", + "type": "float", + "description": "Margin on Earnings Before Interest, Taxes, Depreciation and Amortization.", "default": null, "optional": true }, { - "name": "sequence", - "type": "int", - "description": "Sequence of the financial statement.", + "name": "total_pre_tax_income", + "type": "float", + "description": "Total pre-tax income", "default": null, "optional": true }, { - "name": "factor", - "type": "str", - "description": "Unit of the financial attribute.", + "name": "ebit", + "type": "float", + "description": "Earnings Before Interest and Taxes.", "default": null, "optional": true }, { - "name": "transaction", - "type": "str", - "description": "Transaction type (credit/debit) of the financial attribute.", + "name": "pre_tax_income_margin", + "type": "float", + "description": "Pre-Tax Income Margin.", "default": null, "optional": true }, { - "name": "type", - "type": "str", - "description": "Type of the financial attribute.", + "name": "income_tax_expense", + "type": "float", + "description": "Income tax expense", "default": null, "optional": true }, { - "name": "unit", - "type": "str", - "description": "Unit of the financial attribute.", + "name": "impairment_charge", + "type": "float", + "description": "Impairment charge", "default": null, "optional": true - } - ] - }, - "model": "SearchAttributes" - }, - "/equity/fundamental/latest_attributes": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the latest value of a data tag from Intrinio.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.latest_attributes(symbol='AAPL', tag='ceo', provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", - "default": "", - "optional": false }, { - "name": "tag", - "type": "Union[str, List[str]]", - "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", - "default": "", - "optional": false + "name": "restructuring_charge", + "type": "float", + "description": "Restructuring charge", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Literal['intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", + "name": "service_charges_on_deposit_accounts", + "type": "float", + "description": "Service charges on deposit accounts", + "default": null, "optional": true - } - ], - "intrinio": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "tag", - "type": "str", - "description": "Intrinio data tag ID or code.", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ + "name": "other_service_charges", + "type": "float", + "description": "Other service charges", + "default": null, + "optional": true + }, { - "name": "results", - "type": "List[LatestAttributes]", - "description": "Serializable results." + "name": "other_special_charges", + "type": "float", + "description": "Other special charges", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['intrinio']]", - "description": "Provider name." + "name": "other_cost_of_revenue", + "type": "float", + "description": "Other cost of revenue", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "net_income_continuing_operations", + "type": "float", + "description": "Net income (continuing operations)", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "net_income_discontinued_operations", + "type": "float", + "description": "Net income (discontinued operations)", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "consolidated_net_income", + "type": "float", + "description": "Consolidated net income", + "default": null, + "optional": true }, { - "name": "tag", - "type": "str", - "description": "Tag name for the fetched data.", + "name": "other_adjustments_to_consolidated_net_income", + "type": "float", + "description": "Other adjustments to consolidated net income", "default": null, "optional": true }, { - "name": "value", - "type": "Union[str, float]", - "description": "The value of the data.", + "name": "other_adjustment_to_net_income_attributable_to_common_shareholders", + "type": "float", + "description": "Other adjustment to net income attributable to common shareholders", "default": null, "optional": true - } - ], - "intrinio": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false }, { - "name": "tag", - "type": "str", - "description": "Tag name for the fetched data.", + "name": "net_income_attributable_to_noncontrolling_interest", + "type": "float", + "description": "Net income attributable to noncontrolling interest", "default": null, "optional": true }, { - "name": "value", - "type": "Union[str, float]", - "description": "The value of the data.", + "name": "net_income_attributable_to_common_shareholders", + "type": "float", + "description": "Net income attributable to common shareholders", "default": null, "optional": true - } - ] - }, - "model": "LatestAttributes" - }, - "/equity/fundamental/historical_attributes": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the historical values of a data tag from Intrinio.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_attributes(symbol='AAPL', tag='ebitda', provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", - "default": "", - "optional": false }, { - "name": "tag", - "type": "Union[str, List[str]]", - "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", - "default": "", - "optional": false + "name": "basic_earnings_per_share", + "type": "float", + "description": "Basic earnings per share", + "default": null, + "optional": true }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "diluted_earnings_per_share", + "type": "float", + "description": "Diluted earnings per share", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "basic_and_diluted_earnings_per_share", + "type": "float", + "description": "Basic and diluted earnings per share", "default": null, "optional": true }, { - "name": "frequency", - "type": "Literal['daily', 'weekly', 'monthly', 'quarterly', 'yearly']", - "description": "The frequency of the data.", - "default": "yearly", + "name": "cash_dividends_to_common_per_share", + "type": "float", + "description": "Cash dividends to common per share", + "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 1000, + "name": "preferred_stock_dividends_declared", + "type": "float", + "description": "Preferred stock dividends declared", + "default": null, "optional": true }, { - "name": "tag_type", - "type": "str", - "description": "Filter by type, when applicable.", + "name": "weighted_average_basic_shares_outstanding", + "type": "float", + "description": "Weighted average basic shares outstanding", "default": null, "optional": true }, { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order.", - "default": "desc", + "name": "weighted_average_diluted_shares_outstanding", + "type": "float", + "description": "Weighted average diluted shares outstanding", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", + "name": "weighted_average_basic_and_diluted_shares_outstanding", + "type": "float", + "description": "Weighted average basic and diluted shares outstanding", + "default": null, "optional": true } ], - "intrinio": [ + "polygon": [ { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false + "name": "revenue", + "type": "float", + "description": "Total Revenue", + "default": null, + "optional": true }, { - "name": "tag", - "type": "str", - "description": "Intrinio data tag ID or code.", - "default": "", - "optional": false + "name": "cost_of_revenue_goods", + "type": "float", + "description": "Cost of Revenue - Goods", + "default": null, + "optional": true }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "cost_of_revenue_services", + "type": "float", + "description": "Cost of Revenue - Services", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "cost_of_revenue", + "type": "float", + "description": "Cost of Revenue", "default": null, "optional": true }, { - "name": "frequency", - "type": "Literal['daily', 'weekly', 'monthly', 'quarterly', 'yearly']", - "description": "The frequency of the data.", - "default": "yearly", + "name": "gross_profit", + "type": "float", + "description": "Gross Profit", + "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 1000, + "name": "provisions_for_loan_lease_and_other_losses", + "type": "float", + "description": "Provisions for loan lease and other losses", + "default": null, "optional": true }, { - "name": "tag_type", - "type": "str", - "description": "Filter by type, when applicable.", + "name": "depreciation_and_amortization", + "type": "float", + "description": "Depreciation and Amortization", "default": null, "optional": true }, { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order.", - "default": "desc", + "name": "income_tax_expense_benefit_current", + "type": "float", + "description": "Income tax expense benefit current", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[HistoricalAttributes]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['intrinio']]", - "description": "Provider name." + "name": "deferred_tax_benefit", + "type": "float", + "description": "Deferred tax benefit", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "benefits_costs_expenses", + "type": "float", + "description": "Benefits, costs and expenses", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "selling_general_and_administrative_expense", + "type": "float", + "description": "Selling, general and administrative expense", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "research_and_development", + "type": "float", + "description": "Research and development", + "default": null, + "optional": true }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "costs_and_expenses", + "type": "float", + "description": "Costs and expenses", + "default": null, + "optional": true }, { - "name": "tag", - "type": "str", - "description": "Tag name for the fetched data.", + "name": "other_operating_expenses", + "type": "float", + "description": "Other Operating Expenses", "default": null, "optional": true }, { - "name": "value", + "name": "operating_expenses", "type": "float", - "description": "The value of the data.", + "description": "Operating expenses", "default": null, "optional": true - } - ], - "intrinio": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "operating_income", + "type": "float", + "description": "Operating Income/Loss", + "default": null, + "optional": true }, { - "name": "tag", - "type": "str", - "description": "Tag name for the fetched data.", + "name": "non_operating_income", + "type": "float", + "description": "Non Operating Income/Loss", "default": null, "optional": true }, { - "name": "value", + "name": "interest_and_dividend_income", "type": "float", - "description": "The value of the data.", + "description": "Interest and Dividend Income", "default": null, "optional": true - } - ] - }, - "model": "HistoricalAttributes" - }, - "/equity/fundamental/income": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the income statement for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.income(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.income(symbol='AAPL', period='annual', limit=5, provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "period", - "type": "str", - "description": "Time period of the data to return.", - "default": "annual", + "name": "total_interest_expense", + "type": "float", + "description": "Interest Expense", + "default": null, "optional": true }, { - "name": "limit", - "type": "Annotated[int, Ge(ge=0)]", - "description": "The number of data entries to return.", - "default": 5, + "name": "interest_and_debt_expense", + "type": "float", + "description": "Interest and Debt Expense", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", - "description": "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.", - "default": "fmp", + "name": "net_interest_income", + "type": "float", + "description": "Interest Income Net", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", + "name": "interest_income_after_provision_for_losses", + "type": "float", + "description": "Interest Income After Provision for Losses", + "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "period", - "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", - "description": "None", - "default": "annual", + "name": "non_interest_expense", + "type": "float", + "description": "Non-Interest Expense", + "default": null, "optional": true }, { - "name": "fiscal_year", - "type": "int", - "description": "The specific fiscal year. Reports do not go beyond 2008.", + "name": "non_interest_income", + "type": "float", + "description": "Non-Interest Income", "default": null, "optional": true - } - ], - "polygon": [ + }, { - "name": "period", - "type": "Literal['annual', 'quarter', 'ttm']", - "description": "None", - "default": "annual", + "name": "income_from_discontinued_operations_net_of_tax_on_disposal", + "type": "float", + "description": "Income From Discontinued Operations Net of Tax on Disposal", + "default": null, "optional": true }, { - "name": "filing_date", - "type": "date", - "description": "Filing date of the financial statement.", + "name": "income_from_discontinued_operations_net_of_tax", + "type": "float", + "description": "Income From Discontinued Operations Net of Tax", "default": null, "optional": true }, { - "name": "filing_date_lt", - "type": "date", - "description": "Filing date less than the given date.", + "name": "income_before_equity_method_investments", + "type": "float", + "description": "Income Before Equity Method Investments", "default": null, "optional": true }, { - "name": "filing_date_lte", - "type": "date", - "description": "Filing date less than or equal to the given date.", + "name": "income_from_equity_method_investments", + "type": "float", + "description": "Income From Equity Method Investments", "default": null, "optional": true }, { - "name": "filing_date_gt", - "type": "date", - "description": "Filing date greater than the given date.", + "name": "total_pre_tax_income", + "type": "float", + "description": "Income Before Tax", "default": null, "optional": true }, { - "name": "filing_date_gte", - "type": "date", - "description": "Filing date greater than or equal to the given date.", + "name": "income_tax_expense", + "type": "float", + "description": "Income Tax Expense", "default": null, "optional": true }, { - "name": "period_of_report_date", - "type": "date", - "description": "Period of report date of the financial statement.", + "name": "income_after_tax", + "type": "float", + "description": "Income After Tax", "default": null, "optional": true }, { - "name": "period_of_report_date_lt", - "type": "date", - "description": "Period of report date less than the given date.", + "name": "consolidated_net_income", + "type": "float", + "description": "Net Income/Loss", "default": null, "optional": true }, { - "name": "period_of_report_date_lte", - "type": "date", - "description": "Period of report date less than or equal to the given date.", + "name": "net_income_attributable_noncontrolling_interest", + "type": "float", + "description": "Net income (loss) attributable to noncontrolling interest", "default": null, "optional": true }, { - "name": "period_of_report_date_gt", - "type": "date", - "description": "Period of report date greater than the given date.", + "name": "net_income_attributable_to_parent", + "type": "float", + "description": "Net income (loss) attributable to parent", "default": null, "optional": true }, { - "name": "period_of_report_date_gte", - "type": "date", - "description": "Period of report date greater than or equal to the given date.", + "name": "net_income_attributable_to_common_shareholders", + "type": "float", + "description": "Net Income/Loss Available To Common Stockholders Basic", "default": null, "optional": true }, { - "name": "include_sources", - "type": "bool", - "description": "Whether to include the sources of the financial statement.", + "name": "participating_securities_earnings", + "type": "float", + "description": "Participating Securities Distributed And Undistributed Earnings Loss Basic", "default": null, "optional": true }, { - "name": "order", - "type": "Literal['asc', 'desc']", - "description": "Order of the financial statement.", + "name": "undistributed_earnings_allocated_to_participating_securities", + "type": "float", + "description": "Undistributed Earnings Allocated To Participating Securities", "default": null, "optional": true }, { - "name": "sort", - "type": "Literal['filing_date', 'period_of_report_date']", - "description": "Sort of the financial statement.", + "name": "common_stock_dividends", + "type": "float", + "description": "Common Stock Dividends", "default": null, "optional": true - } - ], - "yfinance": [ + }, { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", + "name": "preferred_stock_dividends_and_other_adjustments", + "type": "float", + "description": "Preferred stock dividends and other adjustments", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[IncomeStatement]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", - "description": "Provider name." + "name": "basic_earnings_per_share", + "type": "float", + "description": "Earnings Per Share", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "diluted_earnings_per_share", + "type": "float", + "description": "Diluted Earnings Per Share", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "weighted_average_basic_shares_outstanding", + "type": "float", + "description": "Basic Average Shares", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "weighted_average_diluted_shares_outstanding", + "type": "float", + "description": "Diluted Average Shares", + "default": null, + "optional": true } - ] + ], + "yfinance": [] }, - "data": { + "model": "IncomeStatement" + }, + "/equity/fundamental/income_growth": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the growth of a company's income statement items over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.income_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.income_growth(symbol='AAPL', limit=10, period='annual', provider='fmp')\n```\n\n", + "parameters": { "standard": [ { - "name": "period_ending", - "type": "date", - "description": "The end date of the reporting period.", + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", "default": "", "optional": false }, { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the report.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10, "optional": true }, { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the fiscal period.", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true } ], - "fmp": [ + "fmp": [] + }, + "returns": { + "OBBject": [ { - "name": "filing_date", - "type": "date", - "description": "The date when the filing was made.", - "default": null, - "optional": true + "name": "results", + "type": "List[IncomeStatementGrowth]", + "description": "Serializable results." }, { - "name": "accepted_date", - "type": "datetime", - "description": "The date and time when the filing was accepted.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "reported_currency", - "type": "str", - "description": "The currency in which the balance sheet was reported.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "revenue", - "type": "float", - "description": "Total revenue.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "cost_of_revenue", - "type": "float", - "description": "Cost of revenue.", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "gross_profit", - "type": "float", - "description": "Gross profit.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "gross_profit_margin", - "type": "float", - "description": "Gross profit margin.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "general_and_admin_expense", - "type": "float", - "description": "General and administrative expenses.", - "default": null, - "optional": true + "name": "period", + "type": "str", + "description": "Period the statement is returned for.", + "default": "", + "optional": false }, { - "name": "research_and_development_expense", + "name": "growth_revenue", "type": "float", - "description": "Research and development expenses.", - "default": null, - "optional": true + "description": "Growth rate of total revenue.", + "default": "", + "optional": false }, { - "name": "selling_and_marketing_expense", + "name": "growth_cost_of_revenue", "type": "float", - "description": "Selling and marketing expenses.", - "default": null, - "optional": true + "description": "Growth rate of cost of goods sold.", + "default": "", + "optional": false }, { - "name": "selling_general_and_admin_expense", + "name": "growth_gross_profit", "type": "float", - "description": "Selling, general and administrative expenses.", - "default": null, - "optional": true + "description": "Growth rate of gross profit.", + "default": "", + "optional": false }, { - "name": "other_expenses", + "name": "growth_gross_profit_ratio", "type": "float", - "description": "Other expenses.", - "default": null, - "optional": true + "description": "Growth rate of gross profit as a percentage of revenue.", + "default": "", + "optional": false }, { - "name": "total_operating_expenses", + "name": "growth_research_and_development_expenses", "type": "float", - "description": "Total operating expenses.", - "default": null, - "optional": true + "description": "Growth rate of expenses on research and development.", + "default": "", + "optional": false }, { - "name": "cost_and_expenses", + "name": "growth_general_and_administrative_expenses", "type": "float", - "description": "Cost and expenses.", - "default": null, - "optional": true + "description": "Growth rate of general and administrative expenses.", + "default": "", + "optional": false }, { - "name": "interest_income", + "name": "growth_selling_and_marketing_expenses", "type": "float", - "description": "Interest income.", - "default": null, - "optional": true + "description": "Growth rate of expenses on selling and marketing activities.", + "default": "", + "optional": false }, { - "name": "total_interest_expense", + "name": "growth_other_expenses", "type": "float", - "description": "Total interest expenses.", - "default": null, - "optional": true + "description": "Growth rate of other operating expenses.", + "default": "", + "optional": false }, { - "name": "depreciation_and_amortization", + "name": "growth_operating_expenses", "type": "float", - "description": "Depreciation and amortization.", - "default": null, - "optional": true + "description": "Growth rate of total operating expenses.", + "default": "", + "optional": false }, { - "name": "ebitda", + "name": "growth_cost_and_expenses", "type": "float", - "description": "EBITDA.", - "default": null, - "optional": true + "description": "Growth rate of total costs and expenses.", + "default": "", + "optional": false }, { - "name": "ebitda_margin", + "name": "growth_interest_expense", "type": "float", - "description": "EBITDA margin.", - "default": null, - "optional": true + "description": "Growth rate of interest expenses.", + "default": "", + "optional": false }, { - "name": "total_operating_income", + "name": "growth_depreciation_and_amortization", "type": "float", - "description": "Total operating income.", - "default": null, - "optional": true + "description": "Growth rate of depreciation and amortization expenses.", + "default": "", + "optional": false }, { - "name": "operating_income_margin", + "name": "growth_ebitda", "type": "float", - "description": "Operating income margin.", - "default": null, - "optional": true + "description": "Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization.", + "default": "", + "optional": false }, { - "name": "total_other_income_expenses", + "name": "growth_ebitda_ratio", "type": "float", - "description": "Total other income and expenses.", - "default": null, - "optional": true + "description": "Growth rate of EBITDA as a percentage of revenue.", + "default": "", + "optional": false }, { - "name": "total_pre_tax_income", + "name": "growth_operating_income", "type": "float", - "description": "Total pre-tax income.", - "default": null, - "optional": true + "description": "Growth rate of operating income.", + "default": "", + "optional": false }, { - "name": "pre_tax_income_margin", + "name": "growth_operating_income_ratio", "type": "float", - "description": "Pre-tax income margin.", - "default": null, - "optional": true + "description": "Growth rate of operating income as a percentage of revenue.", + "default": "", + "optional": false }, { - "name": "income_tax_expense", + "name": "growth_total_other_income_expenses_net", "type": "float", - "description": "Income tax expense.", - "default": null, - "optional": true + "description": "Growth rate of net total other income and expenses.", + "default": "", + "optional": false }, { - "name": "consolidated_net_income", + "name": "growth_income_before_tax", "type": "float", - "description": "Consolidated net income.", - "default": null, - "optional": true + "description": "Growth rate of income before taxes.", + "default": "", + "optional": false }, { - "name": "net_income_margin", + "name": "growth_income_before_tax_ratio", "type": "float", - "description": "Net income margin.", - "default": null, - "optional": true + "description": "Growth rate of income before taxes as a percentage of revenue.", + "default": "", + "optional": false }, { - "name": "basic_earnings_per_share", + "name": "growth_income_tax_expense", "type": "float", - "description": "Basic earnings per share.", - "default": null, - "optional": true + "description": "Growth rate of income tax expenses.", + "default": "", + "optional": false }, { - "name": "diluted_earnings_per_share", + "name": "growth_net_income", "type": "float", - "description": "Diluted earnings per share.", - "default": null, - "optional": true + "description": "Growth rate of net income.", + "default": "", + "optional": false }, { - "name": "weighted_average_basic_shares_outstanding", + "name": "growth_net_income_ratio", "type": "float", - "description": "Weighted average basic shares outstanding.", - "default": null, - "optional": true + "description": "Growth rate of net income as a percentage of revenue.", + "default": "", + "optional": false }, { - "name": "weighted_average_diluted_shares_outstanding", + "name": "growth_eps", "type": "float", - "description": "Weighted average diluted shares outstanding.", - "default": null, + "description": "Growth rate of Earnings Per Share (EPS).", + "default": "", + "optional": false + }, + { + "name": "growth_eps_diluted", + "type": "float", + "description": "Growth rate of diluted Earnings Per Share (EPS).", + "default": "", + "optional": false + }, + { + "name": "growth_weighted_average_shs_out", + "type": "float", + "description": "Growth rate of weighted average shares outstanding.", + "default": "", + "optional": false + }, + { + "name": "growth_weighted_average_shs_out_dil", + "type": "float", + "description": "Growth rate of diluted weighted average shares outstanding.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "IncomeStatementGrowth" + }, + "/equity/fundamental/metrics": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get fundamental metrics for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.metrics(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.metrics(symbol='AAPL', period='annual', limit=100, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", + "default": "", + "optional": false + }, + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "Time period of the data to return.", + "default": "annual", "optional": true }, { - "name": "link", - "type": "str", - "description": "Link to the filing.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100, "optional": true }, { - "name": "final_link", - "type": "str", - "description": "Link to the filing document.", - "default": null, + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'yfinance']", + "description": "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.", + "default": "fmp", "optional": true } ], - "intrinio": [ + "fmp": [ { - "name": "reported_currency", - "type": "str", - "description": "The currency in which the balance sheet is reported.", - "default": null, + "name": "with_ttm", + "type": "bool", + "description": "Include trailing twelve months (TTM) data.", + "default": false, "optional": true + } + ], + "intrinio": [], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[KeyMetrics]", + "description": "Serializable results." }, { - "name": "revenue", - "type": "float", - "description": "Total revenue", + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "operating_revenue", + "name": "market_cap", "type": "float", - "description": "Total operating revenue", + "description": "Market capitalization", "default": null, "optional": true }, { - "name": "cost_of_revenue", + "name": "pe_ratio", "type": "float", - "description": "Total cost of revenue", + "description": "Price-to-earnings ratio (P/E ratio)", "default": null, "optional": true + } + ], + "fmp": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "operating_cost_of_revenue", - "type": "float", - "description": "Total operating cost of revenue", + "name": "period", + "type": "str", + "description": "Period of the data.", + "default": "", + "optional": false + }, + { + "name": "calendar_year", + "type": "int", + "description": "Calendar year.", "default": null, "optional": true }, { - "name": "gross_profit", + "name": "revenue_per_share", "type": "float", - "description": "Total gross profit", + "description": "Revenue per share", "default": null, "optional": true }, { - "name": "gross_profit_margin", + "name": "net_income_per_share", "type": "float", - "description": "Gross margin ratio.", + "description": "Net income per share", "default": null, "optional": true }, { - "name": "provision_for_credit_losses", + "name": "operating_cash_flow_per_share", "type": "float", - "description": "Provision for credit losses", + "description": "Operating cash flow per share", "default": null, "optional": true }, { - "name": "research_and_development_expense", + "name": "free_cash_flow_per_share", "type": "float", - "description": "Research and development expense", + "description": "Free cash flow per share", "default": null, "optional": true }, { - "name": "selling_general_and_admin_expense", + "name": "cash_per_share", "type": "float", - "description": "Selling, general, and admin expense", + "description": "Cash per share", "default": null, "optional": true }, { - "name": "salaries_and_employee_benefits", + "name": "book_value_per_share", "type": "float", - "description": "Salaries and employee benefits", + "description": "Book value per share", "default": null, "optional": true }, { - "name": "marketing_expense", + "name": "tangible_book_value_per_share", "type": "float", - "description": "Marketing expense", + "description": "Tangible book value per share", "default": null, "optional": true }, { - "name": "net_occupancy_and_equipment_expense", + "name": "shareholders_equity_per_share", "type": "float", - "description": "Net occupancy and equipment expense", + "description": "Shareholders equity per share", "default": null, "optional": true }, { - "name": "other_operating_expenses", + "name": "interest_debt_per_share", "type": "float", - "description": "Other operating expenses", + "description": "Interest debt per share", "default": null, "optional": true }, { - "name": "depreciation_expense", + "name": "enterprise_value", "type": "float", - "description": "Depreciation expense", + "description": "Enterprise value", "default": null, "optional": true }, { - "name": "amortization_expense", + "name": "price_to_sales_ratio", "type": "float", - "description": "Amortization expense", + "description": "Price-to-sales ratio", "default": null, "optional": true }, { - "name": "amortization_of_deferred_policy_acquisition_costs", + "name": "pocf_ratio", "type": "float", - "description": "Amortization of deferred policy acquisition costs", + "description": "Price-to-operating cash flow ratio", "default": null, "optional": true }, { - "name": "exploration_expense", + "name": "pfcf_ratio", "type": "float", - "description": "Exploration expense", + "description": "Price-to-free cash flow ratio", "default": null, "optional": true }, { - "name": "depletion_expense", + "name": "pb_ratio", "type": "float", - "description": "Depletion expense", + "description": "Price-to-book ratio", "default": null, "optional": true }, { - "name": "total_operating_expenses", + "name": "ptb_ratio", "type": "float", - "description": "Total operating expenses", + "description": "Price-to-tangible book ratio", "default": null, "optional": true }, { - "name": "total_operating_income", + "name": "ev_to_sales", "type": "float", - "description": "Total operating income", + "description": "Enterprise value-to-sales ratio", "default": null, "optional": true }, { - "name": "deposits_and_money_market_investments_interest_income", + "name": "enterprise_value_over_ebitda", "type": "float", - "description": "Deposits and money market investments interest income", + "description": "Enterprise value-to-EBITDA ratio", "default": null, "optional": true }, { - "name": "federal_funds_sold_and_securities_borrowed_interest_income", + "name": "ev_to_operating_cash_flow", "type": "float", - "description": "Federal funds sold and securities borrowed interest income", + "description": "Enterprise value-to-operating cash flow ratio", "default": null, "optional": true }, { - "name": "investment_securities_interest_income", + "name": "ev_to_free_cash_flow", "type": "float", - "description": "Investment securities interest income", + "description": "Enterprise value-to-free cash flow ratio", "default": null, "optional": true }, { - "name": "loans_and_leases_interest_income", + "name": "earnings_yield", "type": "float", - "description": "Loans and leases interest income", + "description": "Earnings yield", "default": null, "optional": true }, { - "name": "trading_account_interest_income", + "name": "free_cash_flow_yield", "type": "float", - "description": "Trading account interest income", + "description": "Free cash flow yield", "default": null, "optional": true }, { - "name": "other_interest_income", + "name": "debt_to_equity", "type": "float", - "description": "Other interest income", + "description": "Debt-to-equity ratio", "default": null, "optional": true }, { - "name": "total_non_interest_income", + "name": "debt_to_assets", "type": "float", - "description": "Total non-interest income", + "description": "Debt-to-assets ratio", "default": null, "optional": true }, { - "name": "interest_and_investment_income", + "name": "net_debt_to_ebitda", "type": "float", - "description": "Interest and investment income", + "description": "Net debt-to-EBITDA ratio", "default": null, "optional": true }, { - "name": "short_term_borrowings_interest_expense", + "name": "current_ratio", "type": "float", - "description": "Short-term borrowings interest expense", + "description": "Current ratio", "default": null, "optional": true }, { - "name": "long_term_debt_interest_expense", + "name": "interest_coverage", "type": "float", - "description": "Long-term debt interest expense", + "description": "Interest coverage", "default": null, "optional": true }, { - "name": "capitalized_lease_obligations_interest_expense", + "name": "income_quality", "type": "float", - "description": "Capitalized lease obligations interest expense", + "description": "Income quality", "default": null, "optional": true }, { - "name": "deposits_interest_expense", + "name": "dividend_yield", "type": "float", - "description": "Deposits interest expense", + "description": "Dividend yield, as a normalized percent.", "default": null, "optional": true }, { - "name": "federal_funds_purchased_and_securities_sold_interest_expense", + "name": "payout_ratio", "type": "float", - "description": "Federal funds purchased and securities sold interest expense", + "description": "Payout ratio", "default": null, "optional": true }, { - "name": "other_interest_expense", + "name": "sales_general_and_administrative_to_revenue", "type": "float", - "description": "Other interest expense", + "description": "Sales general and administrative expenses-to-revenue ratio", "default": null, "optional": true }, { - "name": "total_interest_expense", + "name": "research_and_development_to_revenue", "type": "float", - "description": "Total interest expense", + "description": "Research and development expenses-to-revenue ratio", "default": null, "optional": true }, { - "name": "net_interest_income", + "name": "intangibles_to_total_assets", "type": "float", - "description": "Net interest income", + "description": "Intangibles-to-total assets ratio", "default": null, "optional": true }, { - "name": "other_non_interest_income", + "name": "capex_to_operating_cash_flow", "type": "float", - "description": "Other non-interest income", + "description": "Capital expenditures-to-operating cash flow ratio", "default": null, "optional": true }, { - "name": "investment_banking_income", + "name": "capex_to_revenue", "type": "float", - "description": "Investment banking income", + "description": "Capital expenditures-to-revenue ratio", "default": null, "optional": true }, { - "name": "trust_fees_by_commissions", + "name": "capex_to_depreciation", "type": "float", - "description": "Trust fees by commissions", + "description": "Capital expenditures-to-depreciation ratio", "default": null, "optional": true }, { - "name": "premiums_earned", + "name": "stock_based_compensation_to_revenue", "type": "float", - "description": "Premiums earned", + "description": "Stock-based compensation-to-revenue ratio", "default": null, "optional": true }, { - "name": "insurance_policy_acquisition_costs", + "name": "graham_number", "type": "float", - "description": "Insurance policy acquisition costs", + "description": "Graham number", "default": null, "optional": true }, { - "name": "current_and_future_benefits", + "name": "roic", "type": "float", - "description": "Current and future benefits", + "description": "Return on invested capital", "default": null, "optional": true }, { - "name": "property_and_liability_insurance_claims", + "name": "return_on_tangible_assets", "type": "float", - "description": "Property and liability insurance claims", + "description": "Return on tangible assets", "default": null, "optional": true }, { - "name": "total_non_interest_expense", + "name": "graham_net_net", "type": "float", - "description": "Total non-interest expense", + "description": "Graham net-net working capital", "default": null, "optional": true }, { - "name": "net_realized_and_unrealized_capital_gains_on_investments", + "name": "working_capital", "type": "float", - "description": "Net realized and unrealized capital gains on investments", + "description": "Working capital", "default": null, "optional": true }, { - "name": "other_gains", + "name": "tangible_asset_value", "type": "float", - "description": "Other gains", + "description": "Tangible asset value", "default": null, "optional": true }, { - "name": "non_operating_income", + "name": "net_current_asset_value", "type": "float", - "description": "Non-operating income", + "description": "Net current asset value", "default": null, "optional": true }, { - "name": "other_income", + "name": "invested_capital", "type": "float", - "description": "Other income", + "description": "Invested capital", "default": null, "optional": true }, { - "name": "other_revenue", + "name": "average_receivables", "type": "float", - "description": "Other revenue", + "description": "Average receivables", "default": null, "optional": true }, { - "name": "extraordinary_income", + "name": "average_payables", "type": "float", - "description": "Extraordinary income", + "description": "Average payables", "default": null, "optional": true }, { - "name": "total_other_income", + "name": "average_inventory", "type": "float", - "description": "Total other income", + "description": "Average inventory", "default": null, "optional": true }, { - "name": "ebitda", + "name": "days_sales_outstanding", "type": "float", - "description": "Earnings Before Interest, Taxes, Depreciation and Amortization.", + "description": "Days sales outstanding", "default": null, "optional": true }, { - "name": "ebitda_margin", + "name": "days_payables_outstanding", "type": "float", - "description": "Margin on Earnings Before Interest, Taxes, Depreciation and Amortization.", + "description": "Days payables outstanding", "default": null, "optional": true }, { - "name": "total_pre_tax_income", + "name": "days_of_inventory_on_hand", "type": "float", - "description": "Total pre-tax income", + "description": "Days of inventory on hand", "default": null, "optional": true }, { - "name": "ebit", + "name": "receivables_turnover", "type": "float", - "description": "Earnings Before Interest and Taxes.", + "description": "Receivables turnover", "default": null, "optional": true }, { - "name": "pre_tax_income_margin", + "name": "payables_turnover", "type": "float", - "description": "Pre-Tax Income Margin.", + "description": "Payables turnover", "default": null, "optional": true }, { - "name": "income_tax_expense", + "name": "inventory_turnover", "type": "float", - "description": "Income tax expense", + "description": "Inventory turnover", "default": null, "optional": true }, { - "name": "impairment_charge", + "name": "roe", "type": "float", - "description": "Impairment charge", + "description": "Return on equity", "default": null, "optional": true }, { - "name": "restructuring_charge", + "name": "capex_per_share", "type": "float", - "description": "Restructuring charge", + "description": "Capital expenditures per share", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "service_charges_on_deposit_accounts", + "name": "price_to_book", "type": "float", - "description": "Service charges on deposit accounts", + "description": "Price to book ratio.", "default": null, "optional": true }, { - "name": "other_service_charges", + "name": "price_to_tangible_book", "type": "float", - "description": "Other service charges", + "description": "Price to tangible book ratio.", "default": null, "optional": true }, { - "name": "other_special_charges", + "name": "price_to_revenue", "type": "float", - "description": "Other special charges", + "description": "Price to revenue ratio.", "default": null, "optional": true }, { - "name": "other_cost_of_revenue", + "name": "quick_ratio", "type": "float", - "description": "Other cost of revenue", + "description": "Quick ratio.", "default": null, "optional": true }, { - "name": "net_income_continuing_operations", + "name": "gross_margin", "type": "float", - "description": "Net income (continuing operations)", + "description": "Gross margin, as a normalized percent.", "default": null, "optional": true }, { - "name": "net_income_discontinued_operations", + "name": "ebit_margin", "type": "float", - "description": "Net income (discontinued operations)", + "description": "EBIT margin, as a normalized percent.", "default": null, "optional": true }, { - "name": "consolidated_net_income", + "name": "profit_margin", "type": "float", - "description": "Consolidated net income", + "description": "Profit margin, as a normalized percent.", "default": null, "optional": true }, { - "name": "other_adjustments_to_consolidated_net_income", + "name": "eps", "type": "float", - "description": "Other adjustments to consolidated net income", + "description": "Basic earnings per share.", "default": null, "optional": true }, { - "name": "other_adjustment_to_net_income_attributable_to_common_shareholders", + "name": "eps_growth", "type": "float", - "description": "Other adjustment to net income attributable to common shareholders", + "description": "EPS growth, as a normalized percent.", "default": null, "optional": true }, { - "name": "net_income_attributable_to_noncontrolling_interest", + "name": "revenue_growth", "type": "float", - "description": "Net income attributable to noncontrolling interest", + "description": "Revenue growth, as a normalized percent.", "default": null, "optional": true }, { - "name": "net_income_attributable_to_common_shareholders", + "name": "ebitda_growth", "type": "float", - "description": "Net income attributable to common shareholders", + "description": "EBITDA growth, as a normalized percent.", "default": null, "optional": true }, { - "name": "basic_earnings_per_share", + "name": "ebit_growth", "type": "float", - "description": "Basic earnings per share", + "description": "EBIT growth, as a normalized percent.", "default": null, "optional": true }, { - "name": "diluted_earnings_per_share", + "name": "net_income_growth", "type": "float", - "description": "Diluted earnings per share", + "description": "Net income growth, as a normalized percent.", "default": null, "optional": true }, { - "name": "basic_and_diluted_earnings_per_share", + "name": "free_cash_flow_to_firm_growth", "type": "float", - "description": "Basic and diluted earnings per share", + "description": "Free cash flow to firm growth, as a normalized percent.", "default": null, "optional": true }, { - "name": "cash_dividends_to_common_per_share", + "name": "invested_capital_growth", "type": "float", - "description": "Cash dividends to common per share", + "description": "Invested capital growth, as a normalized percent.", "default": null, "optional": true }, { - "name": "preferred_stock_dividends_declared", + "name": "return_on_assets", "type": "float", - "description": "Preferred stock dividends declared", + "description": "Return on assets, as a normalized percent.", "default": null, "optional": true }, { - "name": "weighted_average_basic_shares_outstanding", + "name": "return_on_equity", "type": "float", - "description": "Weighted average basic shares outstanding", + "description": "Return on equity, as a normalized percent.", "default": null, "optional": true }, { - "name": "weighted_average_diluted_shares_outstanding", + "name": "return_on_invested_capital", "type": "float", - "description": "Weighted average diluted shares outstanding", + "description": "Return on invested capital, as a normalized percent.", "default": null, "optional": true }, { - "name": "weighted_average_basic_and_diluted_shares_outstanding", - "type": "float", - "description": "Weighted average basic and diluted shares outstanding", + "name": "ebitda", + "type": "int", + "description": "Earnings before interest, taxes, depreciation, and amortization.", "default": null, "optional": true - } - ], - "polygon": [ + }, { - "name": "revenue", - "type": "float", - "description": "Total Revenue", + "name": "ebit", + "type": "int", + "description": "Earnings before interest and taxes.", "default": null, "optional": true }, { - "name": "cost_of_revenue_goods", - "type": "float", - "description": "Cost of Revenue - Goods", + "name": "long_term_debt", + "type": "int", + "description": "Long-term debt.", "default": null, "optional": true }, { - "name": "cost_of_revenue_services", - "type": "float", - "description": "Cost of Revenue - Services", + "name": "total_debt", + "type": "int", + "description": "Total debt.", "default": null, "optional": true }, { - "name": "cost_of_revenue", - "type": "float", - "description": "Cost of Revenue", + "name": "total_capital", + "type": "int", + "description": "The sum of long-term debt and total shareholder equity.", "default": null, "optional": true }, { - "name": "gross_profit", - "type": "float", - "description": "Gross Profit", + "name": "enterprise_value", + "type": "int", + "description": "Enterprise value.", "default": null, "optional": true }, { - "name": "provisions_for_loan_lease_and_other_losses", + "name": "free_cash_flow_to_firm", + "type": "int", + "description": "Free cash flow to firm.", + "default": null, + "optional": true + }, + { + "name": "altman_z_score", "type": "float", - "description": "Provisions for loan lease and other losses", + "description": "Altman Z-score.", "default": null, "optional": true }, { - "name": "depreciation_and_amortization", + "name": "beta", "type": "float", - "description": "Depreciation and Amortization", + "description": "Beta relative to the broad market (rolling three-year).", "default": null, "optional": true }, { - "name": "income_tax_expense_benefit_current", + "name": "dividend_yield", "type": "float", - "description": "Income tax expense benefit current", + "description": "Dividend yield, as a normalized percent.", "default": null, "optional": true }, { - "name": "deferred_tax_benefit", + "name": "earnings_yield", "type": "float", - "description": "Deferred tax benefit", + "description": "Earnings yield, as a normalized percent.", "default": null, "optional": true }, { - "name": "benefits_costs_expenses", + "name": "last_price", "type": "float", - "description": "Benefits, costs and expenses", + "description": "Last price of the stock.", "default": null, "optional": true }, { - "name": "selling_general_and_administrative_expense", + "name": "year_high", "type": "float", - "description": "Selling, general and administrative expense", + "description": "52 week high", "default": null, "optional": true }, { - "name": "research_and_development", + "name": "year_low", "type": "float", - "description": "Research and development", + "description": "52 week low", "default": null, "optional": true }, { - "name": "costs_and_expenses", + "name": "volume_avg", + "type": "int", + "description": "Average daily volume.", + "default": null, + "optional": true + }, + { + "name": "short_interest", + "type": "int", + "description": "Number of shares reported as sold short.", + "default": null, + "optional": true + }, + { + "name": "shares_outstanding", + "type": "int", + "description": "Weighted average shares outstanding (TTM).", + "default": null, + "optional": true + }, + { + "name": "days_to_cover", "type": "float", - "description": "Costs and expenses", + "description": "Days to cover short interest, based on average daily volume.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "forward_pe", + "type": "float", + "description": "Forward price-to-earnings ratio.", "default": null, "optional": true }, { - "name": "other_operating_expenses", + "name": "peg_ratio", "type": "float", - "description": "Other Operating Expenses", + "description": "PEG ratio (5-year expected).", "default": null, "optional": true }, { - "name": "operating_expenses", + "name": "peg_ratio_ttm", "type": "float", - "description": "Operating expenses", + "description": "PEG ratio (TTM).", "default": null, "optional": true }, { - "name": "operating_income", + "name": "eps_ttm", "type": "float", - "description": "Operating Income/Loss", + "description": "Earnings per share (TTM).", "default": null, "optional": true }, { - "name": "non_operating_income", + "name": "eps_forward", "type": "float", - "description": "Non Operating Income/Loss", + "description": "Forward earnings per share.", "default": null, "optional": true }, { - "name": "interest_and_dividend_income", + "name": "enterprise_to_ebitda", "type": "float", - "description": "Interest and Dividend Income", + "description": "Enterprise value to EBITDA ratio.", "default": null, "optional": true }, { - "name": "total_interest_expense", + "name": "earnings_growth", "type": "float", - "description": "Interest Expense", + "description": "Earnings growth (Year Over Year), as a normalized percent.", "default": null, "optional": true }, { - "name": "interest_and_debt_expense", + "name": "earnings_growth_quarterly", "type": "float", - "description": "Interest and Debt Expense", + "description": "Quarterly earnings growth (Year Over Year), as a normalized percent.", "default": null, "optional": true }, { - "name": "net_interest_income", + "name": "revenue_per_share", "type": "float", - "description": "Interest Income Net", + "description": "Revenue per share (TTM).", "default": null, "optional": true }, { - "name": "interest_income_after_provision_for_losses", + "name": "revenue_growth", "type": "float", - "description": "Interest Income After Provision for Losses", + "description": "Revenue growth (Year Over Year), as a normalized percent.", "default": null, "optional": true }, { - "name": "non_interest_expense", + "name": "enterprise_to_revenue", "type": "float", - "description": "Non-Interest Expense", + "description": "Enterprise value to revenue ratio.", "default": null, "optional": true }, { - "name": "non_interest_income", + "name": "cash_per_share", "type": "float", - "description": "Non-Interest Income", + "description": "Cash per share.", "default": null, "optional": true }, { - "name": "income_from_discontinued_operations_net_of_tax_on_disposal", + "name": "quick_ratio", "type": "float", - "description": "Income From Discontinued Operations Net of Tax on Disposal", + "description": "Quick ratio.", "default": null, "optional": true }, { - "name": "income_from_discontinued_operations_net_of_tax", + "name": "current_ratio", "type": "float", - "description": "Income From Discontinued Operations Net of Tax", + "description": "Current ratio.", "default": null, "optional": true }, { - "name": "income_before_equity_method_investments", + "name": "debt_to_equity", "type": "float", - "description": "Income Before Equity Method Investments", + "description": "Debt-to-equity ratio.", "default": null, "optional": true }, { - "name": "income_from_equity_method_investments", + "name": "gross_margin", "type": "float", - "description": "Income From Equity Method Investments", + "description": "Gross margin, as a normalized percent.", "default": null, "optional": true }, { - "name": "total_pre_tax_income", + "name": "operating_margin", "type": "float", - "description": "Income Before Tax", + "description": "Operating margin, as a normalized percent.", "default": null, "optional": true }, { - "name": "income_tax_expense", + "name": "ebitda_margin", "type": "float", - "description": "Income Tax Expense", + "description": "EBITDA margin, as a normalized percent.", "default": null, "optional": true }, { - "name": "income_after_tax", + "name": "profit_margin", "type": "float", - "description": "Income After Tax", + "description": "Profit margin, as a normalized percent.", "default": null, "optional": true }, { - "name": "consolidated_net_income", + "name": "return_on_assets", "type": "float", - "description": "Net Income/Loss", + "description": "Return on assets, as a normalized percent.", "default": null, "optional": true }, { - "name": "net_income_attributable_noncontrolling_interest", + "name": "return_on_equity", "type": "float", - "description": "Net income (loss) attributable to noncontrolling interest", + "description": "Return on equity, as a normalized percent.", "default": null, "optional": true }, { - "name": "net_income_attributable_to_parent", + "name": "dividend_yield", "type": "float", - "description": "Net income (loss) attributable to parent", + "description": "Dividend yield, as a normalized percent.", "default": null, "optional": true }, { - "name": "net_income_attributable_to_common_shareholders", + "name": "dividend_yield_5y_avg", "type": "float", - "description": "Net Income/Loss Available To Common Stockholders Basic", + "description": "5-year average dividend yield, as a normalized percent.", "default": null, "optional": true }, { - "name": "participating_securities_earnings", + "name": "payout_ratio", "type": "float", - "description": "Participating Securities Distributed And Undistributed Earnings Loss Basic", + "description": "Payout ratio.", "default": null, "optional": true }, { - "name": "undistributed_earnings_allocated_to_participating_securities", + "name": "book_value", "type": "float", - "description": "Undistributed Earnings Allocated To Participating Securities", + "description": "Book value per share.", "default": null, "optional": true }, { - "name": "common_stock_dividends", + "name": "price_to_book", "type": "float", - "description": "Common Stock Dividends", + "description": "Price-to-book ratio.", "default": null, "optional": true }, { - "name": "preferred_stock_dividends_and_other_adjustments", + "name": "enterprise_value", + "type": "int", + "description": "Enterprise value.", + "default": null, + "optional": true + }, + { + "name": "overall_risk", "type": "float", - "description": "Preferred stock dividends and other adjustments", + "description": "Overall risk score.", "default": null, "optional": true }, { - "name": "basic_earnings_per_share", + "name": "audit_risk", "type": "float", - "description": "Earnings Per Share", + "description": "Audit risk score.", "default": null, "optional": true }, { - "name": "diluted_earnings_per_share", + "name": "board_risk", "type": "float", - "description": "Diluted Earnings Per Share", + "description": "Board risk score.", "default": null, "optional": true }, { - "name": "weighted_average_basic_shares_outstanding", + "name": "compensation_risk", "type": "float", - "description": "Basic Average Shares", + "description": "Compensation risk score.", "default": null, "optional": true }, { - "name": "weighted_average_diluted_shares_outstanding", + "name": "shareholder_rights_risk", "type": "float", - "description": "Diluted Average Shares", + "description": "Shareholder rights risk score.", "default": null, "optional": true - } - ], - "yfinance": [ + }, { - "name": "period_ending", - "type": "date", - "description": "The end date of the reporting period.", - "default": "", - "optional": false + "name": "beta", + "type": "float", + "description": "Beta relative to the broad market (5-year monthly).", + "default": null, + "optional": true }, { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the report.", + "name": "price_return_1y", + "type": "float", + "description": "One-year price return, as a normalized percent.", "default": null, "optional": true }, { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the fiscal period.", + "name": "currency", + "type": "str", + "description": "Currency in which the data is presented.", "default": null, "optional": true } ] }, - "model": "IncomeStatement" + "model": "KeyMetrics" }, - "/equity/fundamental/income_growth": { + "/equity/fundamental/management": { "deprecated": { "flag": null, "message": null }, - "description": "Get the growth of a company's income statement items over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.income_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.income_growth(symbol='AAPL', limit=10, period='annual', provider='fmp')\n```\n\n", + "description": "Get executive management team data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.management(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { @@ -16234,62 +14774,27 @@ "default": "", "optional": false }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 10, - "optional": true - }, - { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - }, { "name": "provider", - "type": "Literal['fmp']", + "type": "Literal['fmp', 'yfinance']", "description": "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.", "default": "fmp", "optional": true } ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 10, - "optional": true - }, - { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - } - ] + "fmp": [], + "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[IncomeStatementGrowth]", + "type": "List[KeyExecutives]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['fmp', 'yfinance']]", "description": "Provider name." }, { @@ -16312,436 +14817,584 @@ "data": { "standard": [ { - "name": "symbol", + "name": "title", "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": null, - "optional": true - }, - { - "name": "date", - "type": "date", - "description": "The date of the data.", + "description": "Designation of the key executive.", "default": "", "optional": false }, { - "name": "period", + "name": "name", "type": "str", - "description": "Period the statement is returned for.", + "description": "Name of the key executive.", "default": "", "optional": false }, { - "name": "growth_revenue", - "type": "float", - "description": "Growth rate of total revenue.", - "default": "", - "optional": false + "name": "pay", + "type": "int", + "description": "Pay of the key executive.", + "default": null, + "optional": true }, { - "name": "growth_cost_of_revenue", - "type": "float", - "description": "Growth rate of cost of goods sold.", - "default": "", - "optional": false + "name": "currency_pay", + "type": "str", + "description": "Currency of the pay.", + "default": null, + "optional": true }, { - "name": "growth_gross_profit", - "type": "float", - "description": "Growth rate of gross profit.", - "default": "", - "optional": false + "name": "gender", + "type": "str", + "description": "Gender of the key executive.", + "default": null, + "optional": true }, { - "name": "growth_gross_profit_ratio", - "type": "float", - "description": "Growth rate of gross profit as a percentage of revenue.", - "default": "", - "optional": false + "name": "year_born", + "type": "int", + "description": "Birth year of the key executive.", + "default": null, + "optional": true }, { - "name": "growth_research_and_development_expenses", - "type": "float", - "description": "Growth rate of expenses on research and development.", - "default": "", - "optional": false - }, + "name": "title_since", + "type": "int", + "description": "Date the tile was held since.", + "default": null, + "optional": true + } + ], + "fmp": [], + "yfinance": [ { - "name": "growth_general_and_administrative_expenses", - "type": "float", - "description": "Growth rate of general and administrative expenses.", - "default": "", - "optional": false + "name": "exercised_value", + "type": "int", + "description": "Value of shares exercised.", + "default": null, + "optional": true }, { - "name": "growth_selling_and_marketing_expenses", - "type": "float", - "description": "Growth rate of expenses on selling and marketing activities.", - "default": "", - "optional": false - }, + "name": "unexercised_value", + "type": "int", + "description": "Value of shares not exercised.", + "default": null, + "optional": true + } + ] + }, + "model": "KeyExecutives" + }, + "/equity/fundamental/management_compensation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get executive management team compensation for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.management_compensation(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "growth_other_expenses", - "type": "float", - "description": "Growth rate of other operating expenses.", + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": "", "optional": false }, { - "name": "growth_operating_expenses", - "type": "float", - "description": "Growth rate of total operating expenses.", - "default": "", - "optional": false - }, + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ { - "name": "growth_cost_and_expenses", - "type": "float", - "description": "Growth rate of total costs and expenses.", - "default": "", - "optional": false - }, + "name": "year", + "type": "int", + "description": "Year of the compensation.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ { - "name": "growth_interest_expense", - "type": "float", - "description": "Growth rate of interest expenses.", - "default": "", - "optional": false + "name": "results", + "type": "List[ExecutiveCompensation]", + "description": "Serializable results." }, { - "name": "growth_depreciation_and_amortization", - "type": "float", - "description": "Growth rate of depreciation and amortization expenses.", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "growth_ebitda", - "type": "float", - "description": "Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization.", - "default": "", - "optional": false + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "growth_ebitda_ratio", - "type": "float", - "description": "Growth rate of EBITDA as a percentage of revenue.", - "default": "", - "optional": false + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "growth_operating_income", - "type": "float", - "description": "Growth rate of operating income.", - "default": "", - "optional": false - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "growth_operating_income_ratio", - "type": "float", - "description": "Growth rate of operating income as a percentage of revenue.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "growth_total_other_income_expenses_net", - "type": "float", - "description": "Growth rate of net total other income and expenses.", - "default": "", - "optional": false + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true }, { - "name": "growth_income_before_tax", - "type": "float", - "description": "Growth rate of income before taxes.", - "default": "", - "optional": false + "name": "company_name", + "type": "str", + "description": "The name of the company.", + "default": null, + "optional": true }, { - "name": "growth_income_before_tax_ratio", - "type": "float", - "description": "Growth rate of income before taxes as a percentage of revenue.", - "default": "", - "optional": false + "name": "industry", + "type": "str", + "description": "The industry of the company.", + "default": null, + "optional": true }, { - "name": "growth_income_tax_expense", - "type": "float", - "description": "Growth rate of income tax expenses.", - "default": "", - "optional": false + "name": "year", + "type": "int", + "description": "Year of the compensation.", + "default": null, + "optional": true }, { - "name": "growth_net_income", - "type": "float", - "description": "Growth rate of net income.", - "default": "", - "optional": false + "name": "name_and_position", + "type": "str", + "description": "Name and position.", + "default": null, + "optional": true }, { - "name": "growth_net_income_ratio", - "type": "float", - "description": "Growth rate of net income as a percentage of revenue.", - "default": "", - "optional": false + "name": "salary", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Salary.", + "default": null, + "optional": true }, { - "name": "growth_eps", - "type": "float", - "description": "Growth rate of Earnings Per Share (EPS).", - "default": "", - "optional": false + "name": "bonus", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Bonus payments.", + "default": null, + "optional": true }, { - "name": "growth_eps_diluted", - "type": "float", - "description": "Growth rate of diluted Earnings Per Share (EPS).", - "default": "", - "optional": false + "name": "stock_award", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Stock awards.", + "default": null, + "optional": true }, { - "name": "growth_weighted_average_shs_out", - "type": "float", - "description": "Growth rate of weighted average shares outstanding.", - "default": "", - "optional": false + "name": "incentive_plan_compensation", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Incentive plan compensation.", + "default": null, + "optional": true }, { - "name": "growth_weighted_average_shs_out_dil", - "type": "float", - "description": "Growth rate of diluted weighted average shares outstanding.", - "default": "", - "optional": false + "name": "all_other_compensation", + "type": "Annotated[float, Ge(ge=0)]", + "description": "All other compensation.", + "default": null, + "optional": true + }, + { + "name": "total", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Total compensation.", + "default": null, + "optional": true } ], "fmp": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "filing_date", + "type": "date", + "description": "Date of the filing.", "default": null, "optional": true }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "accepted_date", + "type": "datetime", + "description": "Date the filing was accepted.", + "default": null, + "optional": true }, { - "name": "period", + "name": "url", "type": "str", - "description": "Period the statement is returned for.", - "default": "", - "optional": false - }, + "description": "URL to the filing data.", + "default": null, + "optional": true + } + ] + }, + "model": "ExecutiveCompensation" + }, + "/equity/fundamental/overview": { + "deprecated": { + "flag": true, + "message": "This endpoint is deprecated; use `/equity/profile` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.3." + }, + "description": "Get company general business and stock data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.overview(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "growth_revenue", - "type": "float", - "description": "Growth rate of total revenue.", + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", "default": "", "optional": false }, { - "name": "growth_cost_of_revenue", - "type": "float", - "description": "Growth rate of cost of goods sold.", - "default": "", - "optional": false + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CompanyOverview]", + "description": "Serializable results." }, { - "name": "growth_gross_profit", - "type": "float", - "description": "Growth rate of gross profit.", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "growth_gross_profit_ratio", - "type": "float", - "description": "Growth rate of gross profit as a percentage of revenue.", - "default": "", - "optional": false + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "growth_research_and_development_expenses", - "type": "float", - "description": "Growth rate of expenses on research and development.", - "default": "", - "optional": false + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "growth_general_and_administrative_expenses", - "type": "float", - "description": "Growth rate of general and administrative expenses.", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "growth_selling_and_marketing_expenses", + "name": "price", "type": "float", - "description": "Growth rate of expenses on selling and marketing activities.", - "default": "", - "optional": false + "description": "Price of the company.", + "default": null, + "optional": true }, { - "name": "growth_other_expenses", + "name": "beta", "type": "float", - "description": "Growth rate of other operating expenses.", - "default": "", - "optional": false + "description": "Beta of the company.", + "default": null, + "optional": true }, { - "name": "growth_operating_expenses", - "type": "float", - "description": "Growth rate of total operating expenses.", - "default": "", - "optional": false + "name": "vol_avg", + "type": "int", + "description": "Volume average of the company.", + "default": null, + "optional": true }, { - "name": "growth_cost_and_expenses", - "type": "float", - "description": "Growth rate of total costs and expenses.", - "default": "", - "optional": false + "name": "mkt_cap", + "type": "int", + "description": "Market capitalization of the company.", + "default": null, + "optional": true }, { - "name": "growth_interest_expense", + "name": "last_div", "type": "float", - "description": "Growth rate of interest expenses.", - "default": "", - "optional": false + "description": "Last dividend of the company.", + "default": null, + "optional": true }, { - "name": "growth_depreciation_and_amortization", - "type": "float", - "description": "Growth rate of depreciation and amortization expenses.", - "default": "", - "optional": false + "name": "range", + "type": "str", + "description": "Range of the company.", + "default": null, + "optional": true }, { - "name": "growth_ebitda", + "name": "changes", "type": "float", - "description": "Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization.", - "default": "", - "optional": false + "description": "Changes of the company.", + "default": null, + "optional": true }, { - "name": "growth_ebitda_ratio", - "type": "float", - "description": "Growth rate of EBITDA as a percentage of revenue.", - "default": "", - "optional": false + "name": "company_name", + "type": "str", + "description": "Company name of the company.", + "default": null, + "optional": true }, { - "name": "growth_operating_income", - "type": "float", - "description": "Growth rate of operating income.", - "default": "", - "optional": false + "name": "currency", + "type": "str", + "description": "Currency of the company.", + "default": null, + "optional": true }, { - "name": "growth_operating_income_ratio", - "type": "float", - "description": "Growth rate of operating income as a percentage of revenue.", - "default": "", - "optional": false + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true }, { - "name": "growth_total_other_income_expenses_net", - "type": "float", - "description": "Growth rate of net total other income and expenses.", - "default": "", - "optional": false + "name": "isin", + "type": "str", + "description": "ISIN of the company.", + "default": null, + "optional": true }, { - "name": "growth_income_before_tax", - "type": "float", - "description": "Growth rate of income before taxes.", - "default": "", - "optional": false + "name": "cusip", + "type": "str", + "description": "CUSIP of the company.", + "default": null, + "optional": true }, { - "name": "growth_income_before_tax_ratio", - "type": "float", - "description": "Growth rate of income before taxes as a percentage of revenue.", - "default": "", - "optional": false + "name": "exchange", + "type": "str", + "description": "Exchange of the company.", + "default": null, + "optional": true }, { - "name": "growth_income_tax_expense", - "type": "float", - "description": "Growth rate of income tax expenses.", - "default": "", - "optional": false + "name": "exchange_short_name", + "type": "str", + "description": "Exchange short name of the company.", + "default": null, + "optional": true }, { - "name": "growth_net_income", + "name": "industry", + "type": "str", + "description": "Industry of the company.", + "default": null, + "optional": true + }, + { + "name": "website", + "type": "str", + "description": "Website of the company.", + "default": null, + "optional": true + }, + { + "name": "description", + "type": "str", + "description": "Description of the company.", + "default": null, + "optional": true + }, + { + "name": "ceo", + "type": "str", + "description": "CEO of the company.", + "default": null, + "optional": true + }, + { + "name": "sector", + "type": "str", + "description": "Sector of the company.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Country of the company.", + "default": null, + "optional": true + }, + { + "name": "full_time_employees", + "type": "str", + "description": "Full time employees of the company.", + "default": null, + "optional": true + }, + { + "name": "phone", + "type": "str", + "description": "Phone of the company.", + "default": null, + "optional": true + }, + { + "name": "address", + "type": "str", + "description": "Address of the company.", + "default": null, + "optional": true + }, + { + "name": "city", + "type": "str", + "description": "City of the company.", + "default": null, + "optional": true + }, + { + "name": "state", + "type": "str", + "description": "State of the company.", + "default": null, + "optional": true + }, + { + "name": "zip", + "type": "str", + "description": "Zip of the company.", + "default": null, + "optional": true + }, + { + "name": "dcf_diff", "type": "float", - "description": "Growth rate of net income.", - "default": "", - "optional": false + "description": "Discounted cash flow difference of the company.", + "default": null, + "optional": true }, { - "name": "growth_net_income_ratio", + "name": "dcf", "type": "float", - "description": "Growth rate of net income as a percentage of revenue.", + "description": "Discounted cash flow of the company.", + "default": null, + "optional": true + }, + { + "name": "image", + "type": "str", + "description": "Image of the company.", + "default": null, + "optional": true + }, + { + "name": "ipo_date", + "type": "date", + "description": "IPO date of the company.", + "default": null, + "optional": true + }, + { + "name": "default_image", + "type": "bool", + "description": "If the image is the default image.", "default": "", "optional": false }, { - "name": "growth_eps", - "type": "float", - "description": "Growth rate of Earnings Per Share (EPS).", + "name": "is_etf", + "type": "bool", + "description": "If the company is an ETF.", "default": "", "optional": false }, { - "name": "growth_eps_diluted", - "type": "float", - "description": "Growth rate of diluted Earnings Per Share (EPS).", + "name": "is_actively_trading", + "type": "bool", + "description": "If the company is actively trading.", "default": "", "optional": false }, { - "name": "growth_weighted_average_shs_out", - "type": "float", - "description": "Growth rate of weighted average shares outstanding.", + "name": "is_adr", + "type": "bool", + "description": "If the company is an ADR.", "default": "", "optional": false }, { - "name": "growth_weighted_average_shs_out_dil", - "type": "float", - "description": "Growth rate of diluted weighted average shares outstanding.", + "name": "is_fund", + "type": "bool", + "description": "If the company is a fund.", "default": "", "optional": false } - ] + ], + "fmp": [] }, - "model": "IncomeStatementGrowth" + "model": "CompanyOverview" }, - "/equity/fundamental/metrics": { + "/equity/fundamental/ratios": { "deprecated": { "flag": null, "message": null }, - "description": "Get fundamental metrics for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.metrics(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.metrics(symbol='AAPL', period='annual', limit=100, provider='intrinio')\n```\n\n", + "description": "Get an extensive set of financial and accounting ratios for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.ratios(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.ratios(symbol='AAPL', period='annual', limit=12, provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", + "type": "str", + "description": "Symbol to get data for.", "default": "", "optional": false }, { "name": "period", - "type": "Literal['annual', 'quarter']", + "type": "str", "description": "Time period of the data to return.", "default": "annual", "optional": true @@ -16750,12 +15403,12 @@ "name": "limit", "type": "int", "description": "The number of data entries to return.", - "default": 100, + "default": 12, "optional": true }, { "name": "provider", - "type": "Literal['fmp', 'intrinio', 'yfinance']", + "type": "Literal['fmp', 'intrinio']", "description": "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.", "default": "fmp", "optional": true @@ -16763,56 +15416,26 @@ ], "fmp": [ { - "name": "with_ttm", - "type": "bool", - "description": "Include trailing twelve months (TTM) data.", - "default": false, + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm']", + "description": "Time period of the data to return.", + "default": "annual", "optional": true } ], "intrinio": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, { "name": "period", - "type": "Literal['annual', 'quarter']", + "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", "description": "Time period of the data to return.", "default": "annual", "optional": true }, { - "name": "limit", + "name": "fiscal_year", "type": "int", - "description": "The number of data entries to return.", - "default": 100, - "optional": true - } - ], - "yfinance": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 100, + "description": "The specific fiscal year. Reports do not go beyond 2008.", + "default": null, "optional": true } ] @@ -16821,12 +15444,12 @@ "OBBject": [ { "name": "results", - "type": "List[KeyMetrics]", + "type": "List[FinancialRatios]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "type": "Optional[Literal['fmp', 'intrinio']]", "description": "Provider name." }, { @@ -16849,946 +15472,1059 @@ "data": { "standard": [ { - "name": "symbol", + "name": "period_ending", "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": null, - "optional": true - }, - { - "name": "market_cap", - "type": "float", - "description": "Market capitalization", - "default": null, - "optional": true - }, - { - "name": "pe_ratio", - "type": "float", - "description": "Price-to-earnings ratio (P/E ratio)", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "date", - "type": "date", "description": "The date of the data.", "default": "", "optional": false }, { - "name": "period", + "name": "fiscal_period", "type": "str", - "description": "Period of the data.", + "description": "Period of the financial ratios.", "default": "", "optional": false }, { - "name": "calendar_year", + "name": "fiscal_year", "type": "int", - "description": "Calendar year.", + "description": "Fiscal year.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "revenue_per_share", + "name": "current_ratio", "type": "float", - "description": "Revenue per share", + "description": "Current ratio.", "default": null, "optional": true }, { - "name": "net_income_per_share", + "name": "quick_ratio", "type": "float", - "description": "Net income per share", + "description": "Quick ratio.", "default": null, "optional": true }, { - "name": "operating_cash_flow_per_share", + "name": "cash_ratio", "type": "float", - "description": "Operating cash flow per share", + "description": "Cash ratio.", "default": null, "optional": true }, { - "name": "free_cash_flow_per_share", + "name": "days_of_sales_outstanding", "type": "float", - "description": "Free cash flow per share", + "description": "Days of sales outstanding.", "default": null, "optional": true }, { - "name": "cash_per_share", + "name": "days_of_inventory_outstanding", "type": "float", - "description": "Cash per share", + "description": "Days of inventory outstanding.", "default": null, "optional": true }, { - "name": "book_value_per_share", + "name": "operating_cycle", "type": "float", - "description": "Book value per share", + "description": "Operating cycle.", "default": null, "optional": true }, { - "name": "tangible_book_value_per_share", + "name": "days_of_payables_outstanding", "type": "float", - "description": "Tangible book value per share", + "description": "Days of payables outstanding.", "default": null, "optional": true }, { - "name": "shareholders_equity_per_share", + "name": "cash_conversion_cycle", "type": "float", - "description": "Shareholders equity per share", + "description": "Cash conversion cycle.", "default": null, "optional": true }, { - "name": "interest_debt_per_share", + "name": "gross_profit_margin", "type": "float", - "description": "Interest debt per share", + "description": "Gross profit margin.", "default": null, "optional": true }, { - "name": "enterprise_value", + "name": "operating_profit_margin", "type": "float", - "description": "Enterprise value", + "description": "Operating profit margin.", "default": null, "optional": true }, { - "name": "price_to_sales_ratio", + "name": "pretax_profit_margin", "type": "float", - "description": "Price-to-sales ratio", + "description": "Pretax profit margin.", "default": null, "optional": true }, { - "name": "pocf_ratio", + "name": "net_profit_margin", "type": "float", - "description": "Price-to-operating cash flow ratio", + "description": "Net profit margin.", "default": null, "optional": true }, { - "name": "pfcf_ratio", + "name": "effective_tax_rate", "type": "float", - "description": "Price-to-free cash flow ratio", + "description": "Effective tax rate.", "default": null, "optional": true }, { - "name": "pb_ratio", + "name": "return_on_assets", "type": "float", - "description": "Price-to-book ratio", + "description": "Return on assets.", "default": null, "optional": true }, { - "name": "ptb_ratio", + "name": "return_on_equity", "type": "float", - "description": "Price-to-tangible book ratio", + "description": "Return on equity.", "default": null, "optional": true }, { - "name": "ev_to_sales", + "name": "return_on_capital_employed", "type": "float", - "description": "Enterprise value-to-sales ratio", + "description": "Return on capital employed.", "default": null, "optional": true }, { - "name": "enterprise_value_over_ebitda", + "name": "net_income_per_ebt", "type": "float", - "description": "Enterprise value-to-EBITDA ratio", + "description": "Net income per EBT.", "default": null, "optional": true }, { - "name": "ev_to_operating_cash_flow", + "name": "ebt_per_ebit", "type": "float", - "description": "Enterprise value-to-operating cash flow ratio", + "description": "EBT per EBIT.", "default": null, "optional": true }, { - "name": "ev_to_free_cash_flow", + "name": "ebit_per_revenue", "type": "float", - "description": "Enterprise value-to-free cash flow ratio", + "description": "EBIT per revenue.", "default": null, "optional": true }, { - "name": "earnings_yield", + "name": "debt_ratio", "type": "float", - "description": "Earnings yield", + "description": "Debt ratio.", "default": null, "optional": true }, { - "name": "free_cash_flow_yield", + "name": "debt_equity_ratio", "type": "float", - "description": "Free cash flow yield", + "description": "Debt equity ratio.", "default": null, "optional": true }, { - "name": "debt_to_equity", + "name": "long_term_debt_to_capitalization", "type": "float", - "description": "Debt-to-equity ratio", + "description": "Long term debt to capitalization.", "default": null, "optional": true }, { - "name": "debt_to_assets", + "name": "total_debt_to_capitalization", "type": "float", - "description": "Debt-to-assets ratio", + "description": "Total debt to capitalization.", "default": null, "optional": true }, { - "name": "net_debt_to_ebitda", + "name": "interest_coverage", "type": "float", - "description": "Net debt-to-EBITDA ratio", + "description": "Interest coverage.", "default": null, "optional": true }, { - "name": "current_ratio", + "name": "cash_flow_to_debt_ratio", "type": "float", - "description": "Current ratio", + "description": "Cash flow to debt ratio.", "default": null, "optional": true }, { - "name": "interest_coverage", + "name": "company_equity_multiplier", "type": "float", - "description": "Interest coverage", + "description": "Company equity multiplier.", "default": null, "optional": true }, { - "name": "income_quality", + "name": "receivables_turnover", "type": "float", - "description": "Income quality", + "description": "Receivables turnover.", "default": null, "optional": true }, { - "name": "dividend_yield", + "name": "payables_turnover", "type": "float", - "description": "Dividend yield, as a normalized percent.", + "description": "Payables turnover.", "default": null, "optional": true }, { - "name": "payout_ratio", + "name": "inventory_turnover", "type": "float", - "description": "Payout ratio", + "description": "Inventory turnover.", "default": null, "optional": true }, { - "name": "sales_general_and_administrative_to_revenue", + "name": "fixed_asset_turnover", "type": "float", - "description": "Sales general and administrative expenses-to-revenue ratio", + "description": "Fixed asset turnover.", "default": null, "optional": true }, { - "name": "research_and_development_to_revenue", + "name": "asset_turnover", "type": "float", - "description": "Research and development expenses-to-revenue ratio", + "description": "Asset turnover.", "default": null, "optional": true }, { - "name": "intangibles_to_total_assets", + "name": "operating_cash_flow_per_share", "type": "float", - "description": "Intangibles-to-total assets ratio", + "description": "Operating cash flow per share.", "default": null, "optional": true }, { - "name": "capex_to_operating_cash_flow", + "name": "free_cash_flow_per_share", "type": "float", - "description": "Capital expenditures-to-operating cash flow ratio", + "description": "Free cash flow per share.", "default": null, "optional": true }, { - "name": "capex_to_revenue", + "name": "cash_per_share", "type": "float", - "description": "Capital expenditures-to-revenue ratio", + "description": "Cash per share.", "default": null, "optional": true }, { - "name": "capex_to_depreciation", + "name": "payout_ratio", "type": "float", - "description": "Capital expenditures-to-depreciation ratio", + "description": "Payout ratio.", "default": null, "optional": true }, { - "name": "stock_based_compensation_to_revenue", + "name": "operating_cash_flow_sales_ratio", "type": "float", - "description": "Stock-based compensation-to-revenue ratio", + "description": "Operating cash flow sales ratio.", "default": null, "optional": true }, { - "name": "graham_number", + "name": "free_cash_flow_operating_cash_flow_ratio", "type": "float", - "description": "Graham number", + "description": "Free cash flow operating cash flow ratio.", "default": null, "optional": true }, { - "name": "roic", + "name": "cash_flow_coverage_ratios", "type": "float", - "description": "Return on invested capital", + "description": "Cash flow coverage ratios.", "default": null, "optional": true }, { - "name": "return_on_tangible_assets", + "name": "short_term_coverage_ratios", "type": "float", - "description": "Return on tangible assets", + "description": "Short term coverage ratios.", "default": null, "optional": true }, { - "name": "graham_net_net", + "name": "capital_expenditure_coverage_ratio", "type": "float", - "description": "Graham net-net working capital", + "description": "Capital expenditure coverage ratio.", "default": null, "optional": true }, { - "name": "working_capital", + "name": "dividend_paid_and_capex_coverage_ratio", "type": "float", - "description": "Working capital", + "description": "Dividend paid and capex coverage ratio.", "default": null, "optional": true }, { - "name": "tangible_asset_value", + "name": "dividend_payout_ratio", "type": "float", - "description": "Tangible asset value", + "description": "Dividend payout ratio.", "default": null, "optional": true }, { - "name": "net_current_asset_value", + "name": "price_book_value_ratio", "type": "float", - "description": "Net current asset value", + "description": "Price book value ratio.", "default": null, "optional": true }, { - "name": "invested_capital", + "name": "price_to_book_ratio", "type": "float", - "description": "Invested capital", + "description": "Price to book ratio.", "default": null, "optional": true }, { - "name": "average_receivables", + "name": "price_to_sales_ratio", "type": "float", - "description": "Average receivables", + "description": "Price to sales ratio.", "default": null, "optional": true }, { - "name": "average_payables", + "name": "price_earnings_ratio", "type": "float", - "description": "Average payables", + "description": "Price earnings ratio.", "default": null, "optional": true }, { - "name": "average_inventory", + "name": "price_to_free_cash_flows_ratio", "type": "float", - "description": "Average inventory", + "description": "Price to free cash flows ratio.", "default": null, "optional": true }, { - "name": "days_sales_outstanding", + "name": "price_to_operating_cash_flows_ratio", "type": "float", - "description": "Days sales outstanding", + "description": "Price to operating cash flows ratio.", "default": null, "optional": true }, { - "name": "days_payables_outstanding", + "name": "price_cash_flow_ratio", "type": "float", - "description": "Days payables outstanding", + "description": "Price cash flow ratio.", "default": null, "optional": true }, { - "name": "days_of_inventory_on_hand", + "name": "price_earnings_to_growth_ratio", "type": "float", - "description": "Days of inventory on hand", + "description": "Price earnings to growth ratio.", "default": null, "optional": true }, { - "name": "receivables_turnover", + "name": "price_sales_ratio", "type": "float", - "description": "Receivables turnover", + "description": "Price sales ratio.", "default": null, "optional": true }, { - "name": "payables_turnover", + "name": "dividend_yield", "type": "float", - "description": "Payables turnover", + "description": "Dividend yield.", "default": null, "optional": true }, { - "name": "inventory_turnover", + "name": "dividend_yield_percentage", "type": "float", - "description": "Inventory turnover", + "description": "Dividend yield percentage.", "default": null, "optional": true }, { - "name": "roe", + "name": "dividend_per_share", "type": "float", - "description": "Return on equity", + "description": "Dividend per share.", "default": null, "optional": true }, { - "name": "capex_per_share", - "type": "float", - "description": "Capital expenditures per share", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "price_to_book", + "name": "enterprise_value_multiple", "type": "float", - "description": "Price to book ratio.", + "description": "Enterprise value multiple.", "default": null, "optional": true }, { - "name": "price_to_tangible_book", + "name": "price_fair_value", "type": "float", - "description": "Price to tangible book ratio.", + "description": "Price fair value.", "default": null, "optional": true - }, + } + ], + "intrinio": [] + }, + "model": "FinancialRatios" + }, + "/equity/fundamental/revenue_per_geography": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the revenue geographic breakdown for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.revenue_per_geography(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.revenue_per_geography(symbol='AAPL', period='annual', structure='flat', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "price_to_revenue", - "type": "float", - "description": "Price to revenue ratio.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "quick_ratio", - "type": "float", - "description": "Quick ratio.", - "default": null, + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return.", + "default": "annual", "optional": true }, { - "name": "gross_margin", - "type": "float", - "description": "Gross margin, as a normalized percent.", - "default": null, + "name": "structure", + "type": "Literal['hierarchical', 'flat']", + "description": "Structure of the returned data.", + "default": "flat", "optional": true }, { - "name": "ebit_margin", - "type": "float", - "description": "EBIT margin, as a normalized percent.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ { - "name": "profit_margin", - "type": "float", - "description": "Profit margin, as a normalized percent.", - "default": null, - "optional": true + "name": "results", + "type": "List[RevenueGeographic]", + "description": "Serializable results." }, { - "name": "eps", - "type": "float", - "description": "Basic earnings per share.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "eps_growth", - "type": "float", - "description": "EPS growth, as a normalized percent.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "revenue_growth", - "type": "float", - "description": "Revenue growth, as a normalized percent.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "ebitda_growth", - "type": "float", - "description": "EBITDA growth, as a normalized percent.", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "ebit_growth", - "type": "float", - "description": "EBIT growth, as a normalized percent.", - "default": null, - "optional": true + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false }, { - "name": "net_income_growth", - "type": "float", - "description": "Net income growth, as a normalized percent.", + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the reporting period.", "default": null, "optional": true }, { - "name": "free_cash_flow_to_firm_growth", - "type": "float", - "description": "Free cash flow to firm growth, as a normalized percent.", + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the reporting period.", "default": null, "optional": true }, { - "name": "invested_capital_growth", - "type": "float", - "description": "Invested capital growth, as a normalized percent.", + "name": "filing_date", + "type": "date", + "description": "The filing date of the report.", "default": null, "optional": true }, { - "name": "return_on_assets", - "type": "float", - "description": "Return on assets, as a normalized percent.", - "default": null, - "optional": true + "name": "geographic_segment", + "type": "int", + "description": "Dictionary of the revenue by geographic segment.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "RevenueGeographic" + }, + "/equity/fundamental/revenue_per_segment": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the revenue breakdown by business segment for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.revenue_per_segment(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.revenue_per_segment(symbol='AAPL', period='annual', structure='flat', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "return_on_equity", - "type": "float", - "description": "Return on equity, as a normalized percent.", - "default": null, + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return.", + "default": "annual", "optional": true }, { - "name": "return_on_invested_capital", - "type": "float", - "description": "Return on invested capital, as a normalized percent.", - "default": null, + "name": "structure", + "type": "Literal['hierarchical', 'flat']", + "description": "Structure of the returned data.", + "default": "flat", "optional": true }, { - "name": "ebitda", - "type": "int", - "description": "Earnings before interest, taxes, depreciation, and amortization.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[RevenueBusinessLine]", + "description": "Serializable results." }, { - "name": "ebit", - "type": "int", - "description": "Earnings before interest and taxes.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "long_term_debt", - "type": "int", - "description": "Long-term debt.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "total_debt", - "type": "int", - "description": "Total debt.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "total_capital", - "type": "int", - "description": "The sum of long-term debt and total shareholder equity.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false }, { - "name": "enterprise_value", - "type": "int", - "description": "Enterprise value.", + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the reporting period.", "default": null, "optional": true }, { - "name": "free_cash_flow_to_firm", + "name": "fiscal_year", "type": "int", - "description": "Free cash flow to firm.", + "description": "The fiscal year of the reporting period.", "default": null, "optional": true }, { - "name": "altman_z_score", - "type": "float", - "description": "Altman Z-score.", + "name": "filing_date", + "type": "date", + "description": "The filing date of the report.", "default": null, "optional": true }, { - "name": "beta", - "type": "float", - "description": "Beta relative to the broad market (rolling three-year).", + "name": "business_line", + "type": "int", + "description": "Dictionary containing the revenue of the business line.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "RevenueBusinessLine" + }, + "/equity/fundamental/filings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more. SEC\nfilings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114,\nForeign Investment Disclosures and others. The annual 10-K report is required to be\nfiled annually and includes the company's financial statements, management discussion and analysis,\nand audited financial statements.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.filings(provider='fmp')\nobb.equity.fundamental.filings(limit=100, provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", "default": null, "optional": true }, { - "name": "dividend_yield", - "type": "float", - "description": "Dividend yield, as a normalized percent.", + "name": "form_type", + "type": "str", + "description": "Filter by form type. Check the data provider for available types.", "default": null, "optional": true }, { - "name": "earnings_yield", - "type": "float", - "description": "Earnings yield, as a normalized percent.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100, "optional": true }, { - "name": "last_price", - "type": "float", - "description": "Last price of the stock.", + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'sec']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [], + "intrinio": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "year_high", - "type": "float", - "description": "52 week high", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "year_low", - "type": "float", - "description": "52 week low", + "name": "thea_enabled", + "type": "bool", + "description": "Return filings that have been read by Intrinio's Thea NLP.", "default": null, "optional": true - }, + } + ], + "sec": [ { - "name": "volume_avg", - "type": "int", - "description": "Average daily volume.", + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", "default": null, "optional": true }, { - "name": "short_interest", - "type": "int", - "description": "Number of shares reported as sold short.", + "name": "form_type", + "type": "Literal['1', '1-A', '1-A POS', '1-A-W', '1-E', '1-E AD', '1-K', '1-SA', '1-U', '1-Z', '1-Z-W', '10-12B', '10-12G', '10-D', '10-K', '10-KT', '10-Q', '10-QT', '11-K', '11-KT', '13F-HR', '13F-NT', '13FCONP', '144', '15-12B', '15-12G', '15-15D', '15F-12B', '15F-12G', '15F-15D', '18-12B', '18-K', '19B-4E', '2-A', '2-AF', '2-E', '20-F', '20FR12B', '20FR12G', '24F-2NT', '25', '25-NSE', '253G1', '253G2', '253G3', '253G4', '3', '305B2', '34-12H', '4', '40-17F1', '40-17F2', '40-17G', '40-17GCS', '40-202A', '40-203A', '40-206A', '40-24B2', '40-33', '40-6B', '40-8B25', '40-8F-2', '40-APP', '40-F', '40-OIP', '40FR12B', '40FR12G', '424A', '424B1', '424B2', '424B3', '424B4', '424B5', '424B7', '424B8', '424H', '425', '485APOS', '485BPOS', '485BXT', '486APOS', '486BPOS', '486BXT', '487', '497', '497AD', '497H2', '497J', '497K', '497VPI', '497VPU', '5', '6-K', '6B NTC', '6B ORDR', '8-A12B', '8-A12G', '8-K', '8-K12B', '8-K12G3', '8-K15D5', '8-M', '8F-2 NTC', '8F-2 ORDR', '9-M', 'ABS-15G', 'ABS-EE', 'ADN-MTL', 'ADV-E', 'ADV-H-C', 'ADV-H-T', 'ADV-NR', 'ANNLRPT', 'APP NTC', 'APP ORDR', 'APP WD', 'APP WDG', 'ARS', 'ATS-N', 'ATS-N-C', 'ATS-N/UA', 'AW', 'AW WD', 'C', 'C-AR', 'C-AR-W', 'C-TR', 'C-TR-W', 'C-U', 'C-U-W', 'C-W', 'CB', 'CERT', 'CERTARCA', 'CERTBATS', 'CERTCBO', 'CERTNAS', 'CERTNYS', 'CERTPAC', 'CFPORTAL', 'CFPORTAL-W', 'CORRESP', 'CT ORDER', 'D', 'DEF 14A', 'DEF 14C', 'DEFA14A', 'DEFA14C', 'DEFC14A', 'DEFC14C', 'DEFM14A', 'DEFM14C', 'DEFN14A', 'DEFR14A', 'DEFR14C', 'DEL AM', 'DFAN14A', 'DFRN14A', 'DOS', 'DOSLTR', 'DRS', 'DRSLTR', 'DSTRBRPT', 'EFFECT', 'F-1', 'F-10', 'F-10EF', 'F-10POS', 'F-1MEF', 'F-3', 'F-3ASR', 'F-3D', 'F-3DPOS', 'F-3MEF', 'F-4', 'F-4 POS', 'F-4MEF', 'F-6', 'F-6 POS', 'F-6EF', 'F-7', 'F-7 POS', 'F-8', 'F-8 POS', 'F-80', 'F-80POS', 'F-9', 'F-9 POS', 'F-N', 'F-X', 'FOCUSN', 'FWP', 'G-405', 'G-405N', 'G-FIN', 'G-FINW', 'IRANNOTICE', 'MA', 'MA-A', 'MA-I', 'MA-W', 'MSD', 'MSDCO', 'MSDW', 'N-1', 'N-14', 'N-14 8C', 'N-14MEF', 'N-18F1', 'N-1A', 'N-2', 'N-2 POSASR', 'N-23C-2', 'N-23C3A', 'N-23C3B', 'N-23C3C', 'N-2ASR', 'N-2MEF', 'N-30B-2', 'N-30D', 'N-4', 'N-5', 'N-54A', 'N-54C', 'N-6', 'N-6F', 'N-8A', 'N-8B-2', 'N-8F', 'N-8F NTC', 'N-8F ORDR', 'N-CEN', 'N-CR', 'N-CSR', 'N-CSRS', 'N-MFP', 'N-MFP1', 'N-MFP2', 'N-PX', 'N-Q', 'N-VP', 'N-VPFS', 'NO ACT', 'NPORT-EX', 'NPORT-NP', 'NPORT-P', 'NRSRO-CE', 'NRSRO-UPD', 'NSAR-A', 'NSAR-AT', 'NSAR-B', 'NSAR-BT', 'NSAR-U', 'NT 10-D', 'NT 10-K', 'NT 10-Q', 'NT 11-K', 'NT 20-F', 'NT N-CEN', 'NT N-MFP', 'NT N-MFP1', 'NT N-MFP2', 'NT NPORT-EX', 'NT NPORT-P', 'NT-NCEN', 'NT-NCSR', 'NT-NSAR', 'NTFNCEN', 'NTFNCSR', 'NTFNSAR', 'NTN 10D', 'NTN 10K', 'NTN 10Q', 'NTN 20F', 'OIP NTC', 'OIP ORDR', 'POS 8C', 'POS AM', 'POS AMI', 'POS EX', 'POS462B', 'POS462C', 'POSASR', 'PRE 14A', 'PRE 14C', 'PREC14A', 'PREC14C', 'PREM14A', 'PREM14C', 'PREN14A', 'PRER14A', 'PRER14C', 'PRRN14A', 'PX14A6G', 'PX14A6N', 'QRTLYRPT', 'QUALIF', 'REG-NR', 'REVOKED', 'RW', 'RW WD', 'S-1', 'S-11', 'S-11MEF', 'S-1MEF', 'S-20', 'S-3', 'S-3ASR', 'S-3D', 'S-3DPOS', 'S-3MEF', 'S-4', 'S-4 POS', 'S-4EF', 'S-4MEF', 'S-6', 'S-8', 'S-8 POS', 'S-B', 'S-BMEF', 'SBSE', 'SBSE-A', 'SBSE-BD', 'SBSE-C', 'SBSE-W', 'SC 13D', 'SC 13E1', 'SC 13E3', 'SC 13G', 'SC 14D9', 'SC 14F1', 'SC 14N', 'SC TO-C', 'SC TO-I', 'SC TO-T', 'SC13E4F', 'SC14D1F', 'SC14D9C', 'SC14D9F', 'SD', 'SDR', 'SE', 'SEC ACTION', 'SEC STAFF ACTION', 'SEC STAFF LETTER', 'SF-1', 'SF-3', 'SL', 'SP 15D2', 'STOP ORDER', 'SUPPL', 'T-3', 'TA-1', 'TA-2', 'TA-W', 'TACO', 'TH', 'TTW', 'UNDER', 'UPLOAD', 'WDL-REQ', 'X-17A-5']", + "description": "Type of the SEC filing form.", "default": null, "optional": true }, { - "name": "shares_outstanding", - "type": "int", - "description": "Weighted average shares outstanding (TTM).", + "name": "cik", + "type": "Union[int, str]", + "description": "Lookup filings by Central Index Key (CIK) instead of by symbol.", "default": null, "optional": true }, { - "name": "days_to_cover", - "type": "float", - "description": "Days to cover short interest, based on average daily volume.", - "default": null, + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache. If True, cache will store for one day.", + "default": true, "optional": true } - ], - "yfinance": [ + ] + }, + "returns": { + "OBBject": [ { - "name": "forward_pe", - "type": "float", - "description": "Forward price-to-earnings ratio.", - "default": null, - "optional": true + "name": "results", + "type": "List[CompanyFilings]", + "description": "Serializable results." }, { - "name": "peg_ratio", - "type": "float", - "description": "PEG ratio (5-year expected).", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'sec']]", + "description": "Provider name." }, { - "name": "peg_ratio_ttm", - "type": "float", - "description": "PEG ratio (TTM).", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "eps_ttm", - "type": "float", - "description": "Earnings per share (TTM).", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "eps_forward", - "type": "float", - "description": "Forward earnings per share.", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "enterprise_to_ebitda", - "type": "float", - "description": "Enterprise value to EBITDA ratio.", - "default": null, - "optional": true + "name": "filing_date", + "type": "date", + "description": "The date of the filing.", + "default": "", + "optional": false }, { - "name": "earnings_growth", - "type": "float", - "description": "Earnings growth (Year Over Year), as a normalized percent.", + "name": "accepted_date", + "type": "datetime", + "description": "Accepted date of the filing.", "default": null, "optional": true }, { - "name": "earnings_growth_quarterly", - "type": "float", - "description": "Quarterly earnings growth (Year Over Year), as a normalized percent.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "revenue_per_share", - "type": "float", - "description": "Revenue per share (TTM).", + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", "default": null, "optional": true }, { - "name": "revenue_growth", - "type": "float", - "description": "Revenue growth (Year Over Year), as a normalized percent.", + "name": "report_type", + "type": "str", + "description": "Type of filing.", "default": null, "optional": true }, { - "name": "enterprise_to_revenue", - "type": "float", - "description": "Enterprise value to revenue ratio.", + "name": "filing_url", + "type": "str", + "description": "URL to the filing page.", "default": null, "optional": true }, { - "name": "cash_per_share", - "type": "float", - "description": "Cash per share.", - "default": null, - "optional": true + "name": "report_url", + "type": "str", + "description": "URL to the actual report.", + "default": "", + "optional": false + } + ], + "fmp": [], + "intrinio": [ + { + "name": "id", + "type": "str", + "description": "Intrinio ID of the filing.", + "default": "", + "optional": false }, { - "name": "quick_ratio", - "type": "float", - "description": "Quick ratio.", + "name": "period_end_date", + "type": "date", + "description": "Ending date of the fiscal period for the filing.", "default": null, "optional": true }, { - "name": "current_ratio", - "type": "float", - "description": "Current ratio.", - "default": null, - "optional": true + "name": "sec_unique_id", + "type": "str", + "description": "SEC unique ID of the filing.", + "default": "", + "optional": false }, { - "name": "debt_to_equity", - "type": "float", - "description": "Debt-to-equity ratio.", + "name": "instance_url", + "type": "str", + "description": "URL for the XBRL filing for the report.", "default": null, "optional": true }, { - "name": "gross_margin", - "type": "float", - "description": "Gross margin, as a normalized percent.", - "default": null, - "optional": true + "name": "industry_group", + "type": "str", + "description": "Industry group of the company.", + "default": "", + "optional": false }, { - "name": "operating_margin", - "type": "float", - "description": "Operating margin, as a normalized percent.", + "name": "industry_category", + "type": "str", + "description": "Industry category of the company.", + "default": "", + "optional": false + } + ], + "sec": [ + { + "name": "report_date", + "type": "date", + "description": "The date of the filing.", "default": null, "optional": true }, { - "name": "ebitda_margin", - "type": "float", - "description": "EBITDA margin, as a normalized percent.", + "name": "act", + "type": "Union[int, str]", + "description": "The SEC Act number.", "default": null, "optional": true }, { - "name": "profit_margin", - "type": "float", - "description": "Profit margin, as a normalized percent.", + "name": "items", + "type": "Union[str, float]", + "description": "The SEC Item numbers.", "default": null, "optional": true }, { - "name": "return_on_assets", - "type": "float", - "description": "Return on assets, as a normalized percent.", + "name": "primary_doc_description", + "type": "str", + "description": "The description of the primary document.", "default": null, "optional": true }, { - "name": "return_on_equity", - "type": "float", - "description": "Return on equity, as a normalized percent.", + "name": "primary_doc", + "type": "str", + "description": "The filename of the primary document.", "default": null, "optional": true }, { - "name": "dividend_yield", - "type": "float", - "description": "Dividend yield, as a normalized percent.", + "name": "accession_number", + "type": "Union[int, str]", + "description": "The accession number.", "default": null, "optional": true }, { - "name": "dividend_yield_5y_avg", - "type": "float", - "description": "5-year average dividend yield, as a normalized percent.", + "name": "file_number", + "type": "Union[int, str]", + "description": "The file number.", "default": null, "optional": true }, { - "name": "payout_ratio", - "type": "float", - "description": "Payout ratio.", + "name": "film_number", + "type": "Union[int, str]", + "description": "The film number.", "default": null, "optional": true }, { - "name": "book_value", - "type": "float", - "description": "Book value per share.", + "name": "is_inline_xbrl", + "type": "Union[int, str]", + "description": "Whether the filing is an inline XBRL filing.", "default": null, "optional": true }, { - "name": "price_to_book", - "type": "float", - "description": "Price-to-book ratio.", + "name": "is_xbrl", + "type": "Union[int, str]", + "description": "Whether the filing is an XBRL filing.", "default": null, "optional": true }, { - "name": "enterprise_value", - "type": "int", - "description": "Enterprise value.", + "name": "size", + "type": "Union[int, str]", + "description": "The size of the filing.", "default": null, "optional": true }, { - "name": "overall_risk", - "type": "float", - "description": "Overall risk score.", + "name": "complete_submission_url", + "type": "str", + "description": "The URL to the complete filing submission.", "default": null, "optional": true }, { - "name": "audit_risk", - "type": "float", - "description": "Audit risk score.", + "name": "filing_detail_url", + "type": "str", + "description": "The URL to the filing details.", "default": null, "optional": true + } + ] + }, + "model": "CompanyFilings" + }, + "/equity/fundamental/historical_splits": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical stock splits for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_splits(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "board_risk", - "type": "float", - "description": "Board risk score.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[HistoricalSplits]", + "description": "Serializable results." }, { - "name": "compensation_risk", - "type": "float", - "description": "Compensation risk score.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "shareholder_rights_risk", - "type": "float", - "description": "Shareholder rights risk score.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "beta", + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "numerator", "type": "float", - "description": "Beta relative to the broad market (5-year monthly).", + "description": "Numerator of the split.", "default": null, "optional": true }, { - "name": "price_return_1y", + "name": "denominator", "type": "float", - "description": "One-year price return, as a normalized percent.", + "description": "Denominator of the split.", "default": null, "optional": true }, { - "name": "currency", + "name": "split_ratio", "type": "str", - "description": "Currency in which the data is presented.", + "description": "Split ratio.", "default": null, "optional": true } - ] + ], + "fmp": [] }, - "model": "KeyMetrics" + "model": "HistoricalSplits" }, - "/equity/fundamental/management": { + "/equity/fundamental/transcript": { "deprecated": { "flag": null, "message": null }, - "description": "Get executive management team data for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.management(symbol='AAPL', provider='fmp')\n```\n\n", + "description": "Get earnings call transcripts for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.transcript(symbol='AAPL', year=2020, provider='fmp')\n```\n\n", "parameters": { "standard": [ { @@ -17798,43 +16534,33 @@ "default": "", "optional": false }, + { + "name": "year", + "type": "int", + "description": "Year of the earnings call transcript.", + "default": "", + "optional": false + }, { "name": "provider", - "type": "Literal['fmp', 'yfinance']", + "type": "Literal['fmp']", "description": "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.", "default": "fmp", "optional": true } ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - } - ], - "yfinance": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - } - ] + "fmp": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[KeyExecutives]", + "type": "List[EarningsCallTranscript]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'yfinance']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -17857,141 +16583,158 @@ "data": { "standard": [ { - "name": "title", + "name": "symbol", "type": "str", - "description": "Designation of the key executive.", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "name", - "type": "str", - "description": "Name of the key executive.", + "name": "quarter", + "type": "int", + "description": "Quarter of the earnings call transcript.", "default": "", "optional": false }, { - "name": "pay", + "name": "year", "type": "int", - "description": "Pay of the key executive.", - "default": null, - "optional": true - }, - { - "name": "currency_pay", - "type": "str", - "description": "Currency of the pay.", - "default": null, - "optional": true - }, - { - "name": "gender", - "type": "str", - "description": "Gender of the key executive.", - "default": null, - "optional": true + "description": "Year of the earnings call transcript.", + "default": "", + "optional": false }, { - "name": "year_born", - "type": "int", - "description": "Birth year of the key executive.", - "default": null, - "optional": true + "name": "date", + "type": "datetime", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "title_since", - "type": "int", - "description": "Date the tile was held since.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "title", + "name": "content", "type": "str", - "description": "Designation of the key executive.", + "description": "Content of the earnings call transcript.", "default": "", "optional": false - }, + } + ], + "fmp": [] + }, + "model": "EarningsCallTranscript" + }, + "/equity/fundamental/trailing_dividend_yield": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the 1 year trailing dividend yield for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.trailing_dividend_yield(symbol='AAPL', provider='tiingo')\nobb.equity.fundamental.trailing_dividend_yield(symbol='AAPL', limit=252, provider='tiingo')\n```\n\n", + "parameters": { + "standard": [ { - "name": "name", + "name": "symbol", "type": "str", - "description": "Name of the key executive.", + "description": "Symbol to get data for.", "default": "", "optional": false }, { - "name": "pay", + "name": "limit", "type": "int", - "description": "Pay of the key executive.", - "default": null, + "description": "The number of data entries to return. Default is 252, the number of trading days in a year.", + "default": 252, "optional": true }, { - "name": "currency_pay", - "type": "str", - "description": "Currency of the pay.", - "default": null, + "name": "provider", + "type": "Literal['tiingo']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tiingo' if there is no default.", + "default": "tiingo", "optional": true + } + ], + "tiingo": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[TrailingDividendYield]", + "description": "Serializable results." }, { - "name": "gender", - "type": "str", - "description": "Gender of the key executive.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['tiingo']]", + "description": "Provider name." }, { - "name": "year_born", - "type": "int", - "description": "Birth year of the key executive.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "title_since", - "type": "int", - "description": "Date the tile was held since.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } - ], - "yfinance": [ + ] + }, + "data": { + "standard": [ { - "name": "exercised_value", - "type": "int", - "description": "Value of shares exercised.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "unexercised_value", - "type": "int", - "description": "Value of shares not exercised.", - "default": null, - "optional": true + "name": "trailing_dividend_yield", + "type": "float", + "description": "Trailing dividend yield.", + "default": "", + "optional": false } - ] + ], + "tiingo": [] }, - "model": "KeyExecutives" + "model": "TrailingDividendYield" }, - "/equity/fundamental/management_compensation": { + "/equity/ownership/major_holders": { "deprecated": { "flag": null, "message": null }, - "description": "Get executive management team compensation for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.management_compensation(symbol='AAPL', provider='fmp')\n```\n\n", + "description": "Get data about major holders for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.major_holders(symbol='AAPL', provider='fmp')\nobb.equity.ownership.major_holders(symbol='AAPL', page=0, provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "type": "str", + "description": "Symbol to get data for.", "default": "", "optional": false }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": null, + "optional": true + }, + { + "name": "page", + "type": "int", + "description": "Page number of the data to fetch.", + "default": 0, + "optional": true + }, { "name": "provider", "type": "Literal['fmp']", @@ -18000,21 +16743,13 @@ "optional": true } ], - "fmp": [ - { - "name": "year", - "type": "int", - "description": "Year of the compensation.", - "default": null, - "optional": true - } - ] + "fmp": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[ExecutiveCompensation]", + "type": "List[EquityOwnership]", "description": "Serializable results." }, { @@ -18042,698 +16777,620 @@ "data": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { "name": "cik", - "type": "str", + "type": "int", "description": "Central Index Key (CIK) for the requested entity.", - "default": null, - "optional": true + "default": "", + "optional": false }, { - "name": "company_name", - "type": "str", - "description": "The name of the company.", - "default": null, - "optional": true + "name": "filing_date", + "type": "date", + "description": "Filing date of the stock ownership.", + "default": "", + "optional": false }, { - "name": "industry", + "name": "investor_name", "type": "str", - "description": "The industry of the company.", - "default": null, - "optional": true + "description": "Investor name of the stock ownership.", + "default": "", + "optional": false }, { - "name": "year", - "type": "int", - "description": "Year of the compensation.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "name_and_position", + "name": "security_name", "type": "str", - "description": "Name and position.", - "default": null, - "optional": true + "description": "Security name of the stock ownership.", + "default": "", + "optional": false }, { - "name": "salary", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Salary.", - "default": null, - "optional": true + "name": "type_of_security", + "type": "str", + "description": "Type of security of the stock ownership.", + "default": "", + "optional": false }, { - "name": "bonus", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Bonus payments.", - "default": null, - "optional": true + "name": "security_cusip", + "type": "str", + "description": "Security cusip of the stock ownership.", + "default": "", + "optional": false }, { - "name": "stock_award", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Stock awards.", - "default": null, - "optional": true + "name": "shares_type", + "type": "str", + "description": "Shares type of the stock ownership.", + "default": "", + "optional": false }, { - "name": "incentive_plan_compensation", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Incentive plan compensation.", - "default": null, - "optional": true - }, - { - "name": "all_other_compensation", - "type": "Annotated[float, Ge(ge=0)]", - "description": "All other compensation.", - "default": null, - "optional": true - }, - { - "name": "total", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Total compensation.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "filing_date", - "type": "date", - "description": "Date of the filing.", - "default": null, - "optional": true - }, - { - "name": "accepted_date", - "type": "datetime", - "description": "Date the filing was accepted.", - "default": null, - "optional": true - }, - { - "name": "url", + "name": "put_call_share", "type": "str", - "description": "URL to the filing data.", - "default": null, - "optional": true - } - ] - }, - "model": "ExecutiveCompensation" - }, - "/equity/fundamental/overview": { - "deprecated": { - "flag": true, - "message": "This endpoint is deprecated; use `/equity/profile` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.3." - }, - "description": "Get company general business and stock data for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.overview(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ + "description": "Put call share of the stock ownership.", + "default": "", + "optional": false + }, { - "name": "symbol", + "name": "investment_discretion", "type": "str", - "description": "Symbol to get data for.", + "description": "Investment discretion of the stock ownership.", "default": "", "optional": false }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "symbol", + "name": "industry_title", "type": "str", - "description": "Symbol to get data for.", + "description": "Industry title of the stock ownership.", "default": "", "optional": false - } - ] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[CompanyOverview]", - "description": "Serializable results." + "name": "weight", + "type": "float", + "description": "Weight of the stock ownership.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "last_weight", + "type": "float", + "description": "Last weight of the stock ownership.", + "default": "", + "optional": false }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "change_in_weight", + "type": "float", + "description": "Change in weight of the stock ownership.", + "default": "", + "optional": false }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "change_in_weight_percentage", + "type": "float", + "description": "Change in weight percentage of the stock ownership.", + "default": "", + "optional": false }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "market_value", + "type": "int", + "description": "Market value of the stock ownership.", + "default": "", + "optional": false + }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "last_market_value", + "type": "int", + "description": "Last market value of the stock ownership.", "default": "", "optional": false }, { - "name": "price", - "type": "float", - "description": "Price of the company.", - "default": null, - "optional": true + "name": "change_in_market_value", + "type": "int", + "description": "Change in market value of the stock ownership.", + "default": "", + "optional": false }, { - "name": "beta", + "name": "change_in_market_value_percentage", "type": "float", - "description": "Beta of the company.", - "default": null, - "optional": true + "description": "Change in market value percentage of the stock ownership.", + "default": "", + "optional": false }, { - "name": "vol_avg", + "name": "shares_number", "type": "int", - "description": "Volume average of the company.", - "default": null, - "optional": true + "description": "Shares number of the stock ownership.", + "default": "", + "optional": false }, { - "name": "mkt_cap", + "name": "last_shares_number", "type": "int", - "description": "Market capitalization of the company.", - "default": null, - "optional": true + "description": "Last shares number of the stock ownership.", + "default": "", + "optional": false }, { - "name": "last_div", + "name": "change_in_shares_number", "type": "float", - "description": "Last dividend of the company.", - "default": null, - "optional": true + "description": "Change in shares number of the stock ownership.", + "default": "", + "optional": false }, { - "name": "range", - "type": "str", - "description": "Range of the company.", - "default": null, - "optional": true + "name": "change_in_shares_number_percentage", + "type": "float", + "description": "Change in shares number percentage of the stock ownership.", + "default": "", + "optional": false }, { - "name": "changes", + "name": "quarter_end_price", "type": "float", - "description": "Changes of the company.", - "default": null, - "optional": true + "description": "Quarter end price of the stock ownership.", + "default": "", + "optional": false }, { - "name": "company_name", - "type": "str", - "description": "Company name of the company.", - "default": null, - "optional": true + "name": "avg_price_paid", + "type": "float", + "description": "Average price paid of the stock ownership.", + "default": "", + "optional": false }, { - "name": "currency", - "type": "str", - "description": "Currency of the company.", - "default": null, - "optional": true + "name": "is_new", + "type": "bool", + "description": "Is the stock ownership new.", + "default": "", + "optional": false }, { - "name": "cik", - "type": "str", - "description": "Central Index Key (CIK) for the requested entity.", - "default": null, - "optional": true + "name": "is_sold_out", + "type": "bool", + "description": "Is the stock ownership sold out.", + "default": "", + "optional": false }, { - "name": "isin", - "type": "str", - "description": "ISIN of the company.", - "default": null, - "optional": true + "name": "ownership", + "type": "float", + "description": "How much is the ownership.", + "default": "", + "optional": false }, { - "name": "cusip", - "type": "str", - "description": "CUSIP of the company.", - "default": null, - "optional": true + "name": "last_ownership", + "type": "float", + "description": "Last ownership amount.", + "default": "", + "optional": false }, { - "name": "exchange", - "type": "str", - "description": "Exchange of the company.", - "default": null, - "optional": true + "name": "change_in_ownership", + "type": "float", + "description": "Change in ownership amount.", + "default": "", + "optional": false }, { - "name": "exchange_short_name", - "type": "str", - "description": "Exchange short name of the company.", - "default": null, - "optional": true + "name": "change_in_ownership_percentage", + "type": "float", + "description": "Change in ownership percentage.", + "default": "", + "optional": false }, { - "name": "industry", - "type": "str", - "description": "Industry of the company.", - "default": null, - "optional": true + "name": "holding_period", + "type": "int", + "description": "Holding period of the stock ownership.", + "default": "", + "optional": false }, { - "name": "website", - "type": "str", - "description": "Website of the company.", - "default": null, - "optional": true + "name": "first_added", + "type": "date", + "description": "First added date of the stock ownership.", + "default": "", + "optional": false }, { - "name": "description", - "type": "str", - "description": "Description of the company.", - "default": null, - "optional": true + "name": "performance", + "type": "float", + "description": "Performance of the stock ownership.", + "default": "", + "optional": false }, { - "name": "ceo", - "type": "str", - "description": "CEO of the company.", - "default": null, - "optional": true + "name": "performance_percentage", + "type": "float", + "description": "Performance percentage of the stock ownership.", + "default": "", + "optional": false }, { - "name": "sector", - "type": "str", - "description": "Sector of the company.", - "default": null, - "optional": true + "name": "last_performance", + "type": "float", + "description": "Last performance of the stock ownership.", + "default": "", + "optional": false }, { - "name": "country", - "type": "str", - "description": "Country of the company.", - "default": null, - "optional": true + "name": "change_in_performance", + "type": "float", + "description": "Change in performance of the stock ownership.", + "default": "", + "optional": false }, { - "name": "full_time_employees", - "type": "str", - "description": "Full time employees of the company.", - "default": null, - "optional": true - }, + "name": "is_counted_for_performance", + "type": "bool", + "description": "Is the stock ownership counted for performance.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "EquityOwnership" + }, + "/equity/ownership/institutional": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get data about institutional ownership for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.institutional(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "phone", + "name": "symbol", "type": "str", - "description": "Phone of the company.", - "default": null, - "optional": true + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "address", - "type": "str", - "description": "Address of the company.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "city", - "type": "str", - "description": "City of the company.", - "default": null, + "name": "include_current_quarter", + "type": "bool", + "description": "Include current quarter data.", + "default": false, "optional": true }, { - "name": "state", - "type": "str", - "description": "State of the company.", + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", "default": null, "optional": true - }, + } + ] + }, + "returns": { + "OBBject": [ { - "name": "zip", - "type": "str", - "description": "Zip of the company.", - "default": null, - "optional": true + "name": "results", + "type": "List[InstitutionalOwnership]", + "description": "Serializable results." }, { - "name": "dcf_diff", - "type": "float", - "description": "Discounted cash flow difference of the company.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "dcf", - "type": "float", - "description": "Discounted cash flow of the company.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "image", - "type": "str", - "description": "Image of the company.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "ipo_date", - "type": "date", - "description": "IPO date of the company.", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "default_image", - "type": "bool", - "description": "If the image is the default image.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "is_etf", - "type": "bool", - "description": "If the company is an ETF.", - "default": "", - "optional": false + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true }, { - "name": "is_actively_trading", - "type": "bool", - "description": "If the company is actively trading.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false - }, + } + ], + "fmp": [ { - "name": "is_adr", - "type": "bool", - "description": "If the company is an ADR.", + "name": "investors_holding", + "type": "int", + "description": "Number of investors holding the stock.", "default": "", "optional": false }, { - "name": "is_fund", - "type": "bool", - "description": "If the company is a fund.", + "name": "last_investors_holding", + "type": "int", + "description": "Number of investors holding the stock in the last quarter.", "default": "", "optional": false - } - ], - "fmp": [ + }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "investors_holding_change", + "type": "int", + "description": "Change in the number of investors holding the stock.", "default": "", "optional": false }, { - "name": "price", - "type": "float", - "description": "Price of the company.", - "default": null, - "optional": true - }, - { - "name": "beta", - "type": "float", - "description": "Beta of the company.", + "name": "number_of_13f_shares", + "type": "int", + "description": "Number of 13F shares.", "default": null, "optional": true }, { - "name": "vol_avg", + "name": "last_number_of_13f_shares", "type": "int", - "description": "Volume average of the company.", + "description": "Number of 13F shares in the last quarter.", "default": null, "optional": true }, { - "name": "mkt_cap", + "name": "number_of_13f_shares_change", "type": "int", - "description": "Market capitalization of the company.", + "description": "Change in the number of 13F shares.", "default": null, "optional": true }, { - "name": "last_div", + "name": "total_invested", "type": "float", - "description": "Last dividend of the company.", - "default": null, - "optional": true + "description": "Total amount invested.", + "default": "", + "optional": false }, { - "name": "range", - "type": "str", - "description": "Range of the company.", - "default": null, - "optional": true - }, - { - "name": "changes", + "name": "last_total_invested", "type": "float", - "description": "Changes of the company.", - "default": null, - "optional": true - }, - { - "name": "company_name", - "type": "str", - "description": "Company name of the company.", - "default": null, - "optional": true - }, - { - "name": "currency", - "type": "str", - "description": "Currency of the company.", - "default": null, - "optional": true - }, - { - "name": "cik", - "type": "str", - "description": "Central Index Key (CIK) for the requested entity.", - "default": null, - "optional": true - }, - { - "name": "isin", - "type": "str", - "description": "ISIN of the company.", - "default": null, - "optional": true - }, - { - "name": "cusip", - "type": "str", - "description": "CUSIP of the company.", - "default": null, - "optional": true + "description": "Total amount invested in the last quarter.", + "default": "", + "optional": false }, { - "name": "exchange", - "type": "str", - "description": "Exchange of the company.", - "default": null, - "optional": true + "name": "total_invested_change", + "type": "float", + "description": "Change in the total amount invested.", + "default": "", + "optional": false }, { - "name": "exchange_short_name", - "type": "str", - "description": "Exchange short name of the company.", - "default": null, - "optional": true + "name": "ownership_percent", + "type": "float", + "description": "Ownership percent.", + "default": "", + "optional": false }, { - "name": "industry", - "type": "str", - "description": "Industry of the company.", - "default": null, - "optional": true + "name": "last_ownership_percent", + "type": "float", + "description": "Ownership percent in the last quarter.", + "default": "", + "optional": false }, { - "name": "website", - "type": "str", - "description": "Website of the company.", - "default": null, - "optional": true + "name": "ownership_percent_change", + "type": "float", + "description": "Change in the ownership percent.", + "default": "", + "optional": false }, { - "name": "description", - "type": "str", - "description": "Description of the company.", - "default": null, - "optional": true + "name": "new_positions", + "type": "int", + "description": "Number of new positions.", + "default": "", + "optional": false }, { - "name": "ceo", - "type": "str", - "description": "CEO of the company.", - "default": null, - "optional": true + "name": "last_new_positions", + "type": "int", + "description": "Number of new positions in the last quarter.", + "default": "", + "optional": false }, { - "name": "sector", - "type": "str", - "description": "Sector of the company.", - "default": null, - "optional": true + "name": "new_positions_change", + "type": "int", + "description": "Change in the number of new positions.", + "default": "", + "optional": false }, { - "name": "country", - "type": "str", - "description": "Country of the company.", - "default": null, - "optional": true + "name": "increased_positions", + "type": "int", + "description": "Number of increased positions.", + "default": "", + "optional": false }, { - "name": "full_time_employees", - "type": "str", - "description": "Full time employees of the company.", - "default": null, - "optional": true + "name": "last_increased_positions", + "type": "int", + "description": "Number of increased positions in the last quarter.", + "default": "", + "optional": false }, { - "name": "phone", - "type": "str", - "description": "Phone of the company.", - "default": null, - "optional": true + "name": "increased_positions_change", + "type": "int", + "description": "Change in the number of increased positions.", + "default": "", + "optional": false }, { - "name": "address", - "type": "str", - "description": "Address of the company.", - "default": null, - "optional": true + "name": "closed_positions", + "type": "int", + "description": "Number of closed positions.", + "default": "", + "optional": false }, { - "name": "city", - "type": "str", - "description": "City of the company.", - "default": null, - "optional": true + "name": "last_closed_positions", + "type": "int", + "description": "Number of closed positions in the last quarter.", + "default": "", + "optional": false }, { - "name": "state", - "type": "str", - "description": "State of the company.", - "default": null, - "optional": true + "name": "closed_positions_change", + "type": "int", + "description": "Change in the number of closed positions.", + "default": "", + "optional": false }, { - "name": "zip", - "type": "str", - "description": "Zip of the company.", - "default": null, - "optional": true + "name": "reduced_positions", + "type": "int", + "description": "Number of reduced positions.", + "default": "", + "optional": false }, { - "name": "dcf_diff", - "type": "float", - "description": "Discounted cash flow difference of the company.", - "default": null, - "optional": true + "name": "last_reduced_positions", + "type": "int", + "description": "Number of reduced positions in the last quarter.", + "default": "", + "optional": false }, { - "name": "dcf", - "type": "float", - "description": "Discounted cash flow of the company.", - "default": null, - "optional": true + "name": "reduced_positions_change", + "type": "int", + "description": "Change in the number of reduced positions.", + "default": "", + "optional": false }, { - "name": "image", - "type": "str", - "description": "Image of the company.", - "default": null, - "optional": true + "name": "total_calls", + "type": "int", + "description": "Total number of call options contracts traded for Apple Inc. on the specified date.", + "default": "", + "optional": false }, { - "name": "ipo_date", - "type": "date", - "description": "IPO date of the company.", - "default": null, - "optional": true + "name": "last_total_calls", + "type": "int", + "description": "Total number of call options contracts traded for Apple Inc. on the previous reporting date.", + "default": "", + "optional": false }, { - "name": "default_image", - "type": "bool", - "description": "If the image is the default image.", + "name": "total_calls_change", + "type": "int", + "description": "Change in the total number of call options contracts traded between the current and previous reporting dates.", "default": "", "optional": false }, { - "name": "is_etf", - "type": "bool", - "description": "If the company is an ETF.", + "name": "total_puts", + "type": "int", + "description": "Total number of put options contracts traded for Apple Inc. on the specified date.", "default": "", "optional": false }, { - "name": "is_actively_trading", - "type": "bool", - "description": "If the company is actively trading.", + "name": "last_total_puts", + "type": "int", + "description": "Total number of put options contracts traded for Apple Inc. on the previous reporting date.", "default": "", "optional": false }, { - "name": "is_adr", - "type": "bool", - "description": "If the company is an ADR.", + "name": "total_puts_change", + "type": "int", + "description": "Change in the total number of put options contracts traded between the current and previous reporting dates.", "default": "", "optional": false }, { - "name": "is_fund", - "type": "bool", - "description": "If the company is a fund.", + "name": "put_call_ratio", + "type": "float", + "description": "Put-call ratio, which is the ratio of the total number of put options to call options traded on the specified date.", + "default": "", + "optional": false + }, + { + "name": "last_put_call_ratio", + "type": "float", + "description": "Put-call ratio on the previous reporting date.", + "default": "", + "optional": false + }, + { + "name": "put_call_ratio_change", + "type": "float", + "description": "Change in the put-call ratio between the current and previous reporting dates.", "default": "", "optional": false } ] }, - "model": "CompanyOverview" + "model": "InstitutionalOwnership" }, - "/equity/fundamental/ratios": { + "/equity/ownership/insider_trading": { "deprecated": { "flag": null, "message": null }, - "description": "Get an extensive set of financial and accounting ratios for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.ratios(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.ratios(symbol='AAPL', period='annual', limit=12, provider='intrinio')\n```\n\n", + "description": "Get data about trading by a company's management team and board of directors.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.insider_trading(symbol='AAPL', provider='fmp')\nobb.equity.ownership.insider_trading(symbol='AAPL', limit=500, provider='intrinio')\n```\n\n", "parameters": { "standard": [ { @@ -18743,18 +17400,11 @@ "default": "", "optional": false }, - { - "name": "period", - "type": "str", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", - "default": 12, + "default": 500, "optional": true }, { @@ -18767,27 +17417,41 @@ ], "fmp": [ { - "name": "period", - "type": "Literal['annual', 'quarter', 'ttm']", - "description": "Time period of the data to return.", - "default": "annual", + "name": "transaction_type", + "type": "Literal[None, 'award', 'conversion', 'return', 'expire_short', 'in_kind', 'gift', 'expire_long', 'discretionary', 'other', 'small', 'exempt', 'otm', 'purchase', 'sale', 'tender', 'will', 'itm', 'trust']", + "description": "Type of the transaction.", + "default": null, "optional": true } ], "intrinio": [ { - "name": "period", - "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "", + "optional": false }, { - "name": "fiscal_year", - "type": "int", - "description": "The specific fiscal year. Reports do not go beyond 2008.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "", + "optional": false + }, + { + "name": "ownership_type", + "type": "Literal['D', 'I']", + "description": "Type of ownership.", "default": null, "optional": true + }, + { + "name": "sort_by", + "type": "Literal['filing_date', 'updated_on']", + "description": "Field to sort by.", + "default": "updated_on", + "optional": true } ] }, @@ -18795,7 +17459,7 @@ "OBBject": [ { "name": "results", - "type": "List[FinancialRatios]", + "type": "List[InsiderTrading]", "description": "Serializable results." }, { @@ -18823,519 +17487,467 @@ "data": { "standard": [ { - "name": "period_ending", - "type": "str", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "fiscal_period", + "name": "symbol", "type": "str", - "description": "Period of the financial ratios.", - "default": "", - "optional": false - }, - { - "name": "fiscal_year", - "type": "int", - "description": "Fiscal year.", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "current_ratio", - "type": "float", - "description": "Current ratio.", + "name": "company_cik", + "type": "Union[int, str]", + "description": "CIK number of the company.", "default": null, "optional": true }, { - "name": "quick_ratio", - "type": "float", - "description": "Quick ratio.", + "name": "filing_date", + "type": "Union[date, datetime]", + "description": "Filing date of the trade.", "default": null, "optional": true }, { - "name": "cash_ratio", - "type": "float", - "description": "Cash ratio.", + "name": "transaction_date", + "type": "date", + "description": "Date of the transaction.", "default": null, "optional": true }, { - "name": "days_of_sales_outstanding", - "type": "float", - "description": "Days of sales outstanding.", + "name": "owner_cik", + "type": "Union[int, str]", + "description": "Reporting individual's CIK.", "default": null, "optional": true }, { - "name": "days_of_inventory_outstanding", - "type": "float", - "description": "Days of inventory outstanding.", + "name": "owner_name", + "type": "str", + "description": "Name of the reporting individual.", "default": null, "optional": true }, { - "name": "operating_cycle", - "type": "float", - "description": "Operating cycle.", + "name": "owner_title", + "type": "str", + "description": "The title held by the reporting individual.", "default": null, "optional": true }, { - "name": "days_of_payables_outstanding", - "type": "float", - "description": "Days of payables outstanding.", + "name": "transaction_type", + "type": "str", + "description": "Type of transaction being reported.", "default": null, "optional": true }, { - "name": "cash_conversion_cycle", - "type": "float", - "description": "Cash conversion cycle.", + "name": "acquisition_or_disposition", + "type": "str", + "description": "Acquisition or disposition of the shares.", "default": null, "optional": true }, { - "name": "gross_profit_margin", - "type": "float", - "description": "Gross profit margin.", + "name": "security_type", + "type": "str", + "description": "The type of security transacted.", "default": null, "optional": true }, { - "name": "operating_profit_margin", + "name": "securities_owned", "type": "float", - "description": "Operating profit margin.", + "description": "Number of securities owned by the reporting individual.", "default": null, "optional": true }, { - "name": "pretax_profit_margin", + "name": "securities_transacted", "type": "float", - "description": "Pretax profit margin.", + "description": "Number of securities transacted by the reporting individual.", "default": null, "optional": true }, { - "name": "net_profit_margin", + "name": "transaction_price", "type": "float", - "description": "Net profit margin.", + "description": "The price of the transaction.", "default": null, "optional": true }, { - "name": "effective_tax_rate", - "type": "float", - "description": "Effective tax rate.", + "name": "filing_url", + "type": "str", + "description": "Link to the filing.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "return_on_assets", - "type": "float", - "description": "Return on assets.", + "name": "form_type", + "type": "str", + "description": "Form type of the insider trading.", + "default": "", + "optional": false + } + ], + "intrinio": [ + { + "name": "filing_url", + "type": "str", + "description": "URL of the filing.", "default": null, "optional": true }, { - "name": "return_on_equity", - "type": "float", - "description": "Return on equity.", - "default": null, - "optional": true + "name": "company_name", + "type": "str", + "description": "Name of the company.", + "default": "", + "optional": false }, { - "name": "return_on_capital_employed", + "name": "conversion_exercise_price", "type": "float", - "description": "Return on capital employed.", + "description": "Conversion/Exercise price of the shares.", "default": null, "optional": true }, { - "name": "net_income_per_ebt", - "type": "float", - "description": "Net income per EBT.", + "name": "deemed_execution_date", + "type": "date", + "description": "Deemed execution date of the trade.", "default": null, "optional": true }, { - "name": "ebt_per_ebit", - "type": "float", - "description": "EBT per EBIT.", + "name": "exercise_date", + "type": "date", + "description": "Exercise date of the trade.", "default": null, "optional": true }, { - "name": "ebit_per_revenue", - "type": "float", - "description": "EBIT per revenue.", + "name": "expiration_date", + "type": "date", + "description": "Expiration date of the derivative.", "default": null, "optional": true }, { - "name": "debt_ratio", - "type": "float", - "description": "Debt ratio.", + "name": "underlying_security_title", + "type": "str", + "description": "Name of the underlying non-derivative security related to this derivative transaction.", "default": null, "optional": true }, { - "name": "debt_equity_ratio", - "type": "float", - "description": "Debt equity ratio.", + "name": "underlying_shares", + "type": "Union[int, float]", + "description": "Number of underlying shares related to this derivative transaction.", "default": null, "optional": true }, { - "name": "long_term_debt_to_capitalization", - "type": "float", - "description": "Long term debt to capitalization.", + "name": "nature_of_ownership", + "type": "str", + "description": "Nature of ownership of the insider trading.", "default": null, "optional": true }, { - "name": "total_debt_to_capitalization", - "type": "float", - "description": "Total debt to capitalization.", + "name": "director", + "type": "bool", + "description": "Whether the owner is a director.", "default": null, "optional": true }, { - "name": "interest_coverage", - "type": "float", - "description": "Interest coverage.", + "name": "officer", + "type": "bool", + "description": "Whether the owner is an officer.", "default": null, "optional": true }, { - "name": "cash_flow_to_debt_ratio", - "type": "float", - "description": "Cash flow to debt ratio.", + "name": "ten_percent_owner", + "type": "bool", + "description": "Whether the owner is a 10% owner.", "default": null, "optional": true }, { - "name": "company_equity_multiplier", - "type": "float", - "description": "Company equity multiplier.", + "name": "other_relation", + "type": "bool", + "description": "Whether the owner is having another relation.", "default": null, "optional": true }, { - "name": "receivables_turnover", - "type": "float", - "description": "Receivables turnover.", + "name": "derivative_transaction", + "type": "bool", + "description": "Whether the owner is having a derivative transaction.", "default": null, "optional": true }, { - "name": "payables_turnover", - "type": "float", - "description": "Payables turnover.", + "name": "report_line_number", + "type": "int", + "description": "Report line number of the insider trading.", "default": null, "optional": true - }, + } + ] + }, + "model": "InsiderTrading" + }, + "/equity/ownership/share_statistics": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get data about share float for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.share_statistics(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "inventory_turnover", - "type": "float", - "description": "Inventory turnover.", - "default": null, - "optional": true + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": "", + "optional": false }, { - "name": "fixed_asset_turnover", - "type": "float", - "description": "Fixed asset turnover.", - "default": null, + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'yfinance']", + "description": "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.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [], + "intrinio": [], + "yfinance": [] + }, + "returns": { + "OBBject": [ { - "name": "asset_turnover", - "type": "float", - "description": "Asset turnover.", - "default": null, - "optional": true + "name": "results", + "type": "List[ShareStatistics]", + "description": "Serializable results." }, { - "name": "operating_cash_flow_per_share", - "type": "float", - "description": "Operating cash flow per share.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "description": "Provider name." }, { - "name": "free_cash_flow_per_share", - "type": "float", - "description": "Free cash flow per share.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "cash_per_share", - "type": "float", - "description": "Cash per share.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "payout_ratio", - "type": "float", - "description": "Payout ratio.", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "operating_cash_flow_sales_ratio", - "type": "float", - "description": "Operating cash flow sales ratio.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "free_cash_flow_operating_cash_flow_ratio", - "type": "float", - "description": "Free cash flow operating cash flow ratio.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": null, "optional": true }, { - "name": "cash_flow_coverage_ratios", + "name": "free_float", "type": "float", - "description": "Cash flow coverage ratios.", + "description": "Percentage of unrestricted shares of a publicly-traded company.", "default": null, "optional": true }, { - "name": "short_term_coverage_ratios", + "name": "float_shares", "type": "float", - "description": "Short term coverage ratios.", + "description": "Number of shares available for trading by the general public.", "default": null, "optional": true }, { - "name": "capital_expenditure_coverage_ratio", + "name": "outstanding_shares", "type": "float", - "description": "Capital expenditure coverage ratio.", + "description": "Total number of shares of a publicly-traded company.", "default": null, "optional": true }, { - "name": "dividend_paid_and_capex_coverage_ratio", - "type": "float", - "description": "Dividend paid and capex coverage ratio.", + "name": "source", + "type": "str", + "description": "Source of the received data.", "default": null, "optional": true - }, + } + ], + "fmp": [], + "intrinio": [ { - "name": "dividend_payout_ratio", + "name": "adjusted_outstanding_shares", "type": "float", - "description": "Dividend payout ratio.", + "description": "Total number of shares of a publicly-traded company, adjusted for splits.", "default": null, "optional": true }, { - "name": "price_book_value_ratio", + "name": "public_float", "type": "float", - "description": "Price book value ratio.", + "description": "Aggregate market value of the shares of a publicly-traded company.", "default": null, "optional": true - }, + } + ], + "yfinance": [ { - "name": "price_to_book_ratio", - "type": "float", - "description": "Price to book ratio.", + "name": "implied_shares_outstanding", + "type": "int", + "description": "Implied Shares Outstanding of common equity, assuming the conversion of all convertible subsidiary equity into common.", "default": null, "optional": true }, { - "name": "price_to_sales_ratio", - "type": "float", - "description": "Price to sales ratio.", + "name": "short_interest", + "type": "int", + "description": "Number of shares that are reported short.", "default": null, "optional": true }, { - "name": "price_earnings_ratio", + "name": "short_percent_of_float", "type": "float", - "description": "Price earnings ratio.", + "description": "Percentage of shares that are reported short, as a normalized percent.", "default": null, "optional": true }, { - "name": "price_to_free_cash_flows_ratio", + "name": "days_to_cover", "type": "float", - "description": "Price to free cash flows ratio.", + "description": "Number of days to repurchase the shares as a ratio of average daily volume", "default": null, "optional": true }, { - "name": "price_to_operating_cash_flows_ratio", - "type": "float", - "description": "Price to operating cash flows ratio.", + "name": "short_interest_prev_month", + "type": "int", + "description": "Number of shares that were reported short in the previous month.", "default": null, "optional": true }, { - "name": "price_cash_flow_ratio", - "type": "float", - "description": "Price cash flow ratio.", + "name": "short_interest_prev_date", + "type": "date", + "description": "Date of the previous month's report.", "default": null, "optional": true }, { - "name": "price_earnings_to_growth_ratio", + "name": "insider_ownership", "type": "float", - "description": "Price earnings to growth ratio.", + "description": "Percentage of shares held by insiders, as a normalized percent.", "default": null, "optional": true }, { - "name": "price_sales_ratio", + "name": "institution_ownership", "type": "float", - "description": "Price sales ratio.", + "description": "Percentage of shares held by institutions, as a normalized percent.", "default": null, "optional": true }, { - "name": "dividend_yield", + "name": "institution_float_ownership", "type": "float", - "description": "Dividend yield.", + "description": "Percentage of float held by institutions, as a normalized percent.", "default": null, "optional": true }, { - "name": "dividend_yield_percentage", - "type": "float", - "description": "Dividend yield percentage.", + "name": "institutions_count", + "type": "int", + "description": "Number of institutions holding shares.", "default": null, "optional": true + } + ] + }, + "model": "ShareStatistics" + }, + "/equity/ownership/form_13f": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the form 13F.\n\nThe Securities and Exchange Commission's (SEC) Form 13F is a quarterly report\nthat is required to be filed by all institutional investment managers with at least\n$100 million in assets under management.\nManagers are required to file Form 13F within 45 days after the last day of the calendar quarter.\nMost funds wait until the end of this period in order to conceal\ntheir investment strategy from competitors and the public.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.form_13f(symbol='NVDA', provider='sec')\n# Enter a date (calendar quarter ending) for a specific report.\nobb.equity.ownership.form_13f(symbol='BRK-A', date='2016-09-30', provider='sec')\n# Example finding Michael Burry's filings.\ncik = obb.regulators.sec.institutions_search(\"Scion Asset Management\").results[0].cik\n# Use the `limit` parameter to return N number of reports from the most recent.\nobb.equity.ownership.form_13f(cik, limit=2).to_df()\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. A CIK or Symbol can be used.", + "default": "", + "optional": false }, { - "name": "dividend_per_share", - "type": "float", - "description": "Dividend per share.", + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported.", "default": null, "optional": true }, { - "name": "enterprise_value_multiple", - "type": "float", - "description": "Enterprise value multiple.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter.", + "default": 1, "optional": true }, { - "name": "price_fair_value", - "type": "float", - "description": "Price fair value.", - "default": null, + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", "optional": true } ], - "intrinio": [ - { - "name": "period_ending", - "type": "str", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "fiscal_period", - "type": "str", - "description": "Period of the financial ratios.", - "default": "", - "optional": false - }, - { - "name": "fiscal_year", - "type": "int", - "description": "Fiscal year.", - "default": null, - "optional": true - } - ] - }, - "model": "FinancialRatios" - }, - "/equity/fundamental/revenue_per_geography": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the revenue geographic breakdown for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.revenue_per_geography(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.revenue_per_geography(symbol='AAPL', period='annual', structure='flat', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "period", - "type": "Literal['quarter', 'annual']", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - }, - { - "name": "structure", - "type": "Literal['hierarchical', 'flat']", - "description": "Structure of the returned data.", - "default": "flat", - "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "period", - "type": "Literal['quarter', 'annual']", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - }, - { - "name": "structure", - "type": "Literal['hierarchical', 'flat']", - "description": "Structure of the returned data.", - "default": "flat", - "optional": true - } - ] - }, - "returns": { - "OBBject": [ + "sec": [] + }, + "returns": { + "OBBject": [ { "name": "results", - "type": "List[RevenueGeographic]", + "type": "List[Form13FHR]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['sec']]", "description": "Provider name." }, { @@ -19360,151 +17972,146 @@ { "name": "period_ending", "type": "date", - "description": "The end date of the reporting period.", + "description": "The end-of-quarter date of the filing.", "default": "", "optional": false }, { - "name": "fiscal_period", + "name": "issuer", "type": "str", - "description": "The fiscal period of the reporting period.", - "default": null, - "optional": true + "description": "The name of the issuer.", + "default": "", + "optional": false }, { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the reporting period.", + "name": "cusip", + "type": "str", + "description": "The CUSIP of the security.", + "default": "", + "optional": false + }, + { + "name": "asset_class", + "type": "str", + "description": "The title of the asset class for the security.", + "default": "", + "optional": false + }, + { + "name": "security_type", + "type": "Literal['SH', 'PRN']", + "description": "The total number of shares of the class of security or the principal amount of such class. 'SH' for shares. 'PRN' for principal amount. Convertible debt securities are reported as 'PRN'.", "default": null, "optional": true }, { - "name": "filing_date", - "type": "date", - "description": "The filing date of the report.", + "name": "option_type", + "type": "Literal['call', 'put']", + "description": "Defined when the holdings being reported are put or call options. Only long positions are reported.", "default": null, "optional": true }, { - "name": "geographic_segment", + "name": "voting_authority_sole", "type": "int", - "description": "Dictionary of the revenue by geographic segment.", - "default": "", - "optional": false - } - ], - "fmp": [ - { - "name": "period_ending", - "type": "date", - "description": "The end date of the reporting period.", - "default": "", - "optional": false - }, - { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the reporting period.", + "description": "The number of shares for which the Manager exercises sole voting authority (none).", "default": null, "optional": true }, { - "name": "fiscal_year", + "name": "voting_authority_shared", "type": "int", - "description": "The fiscal year of the reporting period.", + "description": "The number of shares for which the Manager exercises a defined shared voting authority (none).", "default": null, "optional": true }, { - "name": "filing_date", - "type": "date", - "description": "The filing date of the report.", + "name": "voting_authority_other", + "type": "int", + "description": "The number of shares for which the Manager exercises other shared voting authority (none).", "default": null, "optional": true }, { - "name": "geographic_segment", + "name": "principal_amount", "type": "int", - "description": "Dictionary of the revenue by geographic segment.", + "description": "The total number of shares of the class of security or the principal amount of such class. Only long positions are reported", + "default": "", + "optional": false + }, + { + "name": "value", + "type": "int", + "description": "The fair market value of the holding of the particular class of security. The value reported for options is the fair market value of the underlying security with respect to the number of shares controlled. Values are rounded to the nearest US dollar and use the closing price of the last trading day of the calendar year or quarter.", + "default": "", + "optional": false + } + ], + "sec": [ + { + "name": "weight", + "type": "float", + "description": "The weight of the security relative to the market value of all securities in the filing , as a normalized percent.", "default": "", "optional": false } ] }, - "model": "RevenueGeographic" + "model": "Form13FHR" }, - "/equity/fundamental/revenue_per_segment": { + "/equity/price/quote": { "deprecated": { "flag": null, "message": null }, - "description": "Get the revenue breakdown by business segment for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.revenue_per_segment(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.revenue_per_segment(symbol='AAPL', period='annual', structure='flat', provider='fmp')\n```\n\n", + "description": "Get the latest quote for a given stock. Quote includes price, volume, and other data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.quote(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": "", "optional": false }, - { - "name": "period", - "type": "Literal['quarter', 'annual']", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - }, - { - "name": "structure", - "type": "Literal['hierarchical', 'flat']", - "description": "Structure of the returned data.", - "default": "flat", - "optional": true - }, { "name": "provider", - "type": "Literal['fmp']", + "type": "Literal['fmp', 'intrinio', 'yfinance']", "description": "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.", "default": "fmp", "optional": true } ], - "fmp": [ + "fmp": [], + "intrinio": [ { "name": "symbol", "type": "str", - "description": "Symbol to get data for.", + "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", "default": "", "optional": false }, { - "name": "period", - "type": "Literal['quarter', 'annual']", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - }, - { - "name": "structure", - "type": "Literal['hierarchical', 'flat']", - "description": "Structure of the returned data.", - "default": "flat", + "name": "source", + "type": "Literal['iex', 'bats', 'bats_delayed', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed', 'intrinio_mx', 'intrinio_mx_plus', 'delayed_sip']", + "description": "Source of the data.", + "default": "iex", "optional": true } - ] + ], + "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[RevenueBusinessLine]", + "type": "List[EquityQuote]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", "description": "Provider name." }, { @@ -19527,475 +18134,372 @@ "data": { "standard": [ { - "name": "period_ending", - "type": "date", - "description": "The end date of the reporting period.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "fiscal_period", + "name": "asset_type", "type": "str", - "description": "The fiscal period of the reporting period.", + "description": "Type of asset - i.e, stock, ETF, etc.", "default": null, "optional": true }, { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the reporting period.", + "name": "name", + "type": "str", + "description": "Name of the company or asset.", "default": null, "optional": true }, { - "name": "filing_date", - "type": "date", - "description": "The filing date of the report.", + "name": "exchange", + "type": "str", + "description": "The name or symbol of the venue where the data is from.", "default": null, "optional": true }, { - "name": "business_line", - "type": "int", - "description": "Dictionary containing the revenue of the business line.", - "default": "", - "optional": false - } - ], - "fmp": [ - { - "name": "period_ending", - "type": "date", - "description": "The end date of the reporting period.", - "default": "", - "optional": false + "name": "bid", + "type": "float", + "description": "Price of the top bid order.", + "default": null, + "optional": true }, { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the reporting period.", + "name": "bid_size", + "type": "int", + "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", "default": null, "optional": true }, { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the reporting period.", + "name": "bid_exchange", + "type": "str", + "description": "The specific trading venue where the purchase order was placed.", "default": null, "optional": true }, { - "name": "filing_date", - "type": "date", - "description": "The filing date of the report.", + "name": "ask", + "type": "float", + "description": "Price of the top ask order.", "default": null, "optional": true }, { - "name": "business_line", + "name": "ask_size", "type": "int", - "description": "Dictionary containing the revenue of the business line.", - "default": "", - "optional": false - } - ] - }, - "model": "RevenueBusinessLine" - }, - "/equity/fundamental/filings": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more. SEC\nfilings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114,\nForeign Investment Disclosures and others. The annual 10-K report is required to be\nfiled annually and includes the company's financial statements, management discussion and analysis,\nand audited financial statements.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.filings(provider='fmp')\nobb.equity.fundamental.filings(limit=100, provider='fmp')\n```\n\n", - "parameters": { - "standard": [ + "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", + "default": null, + "optional": true + }, { - "name": "symbol", + "name": "ask_exchange", "type": "str", - "description": "Symbol to get data for.", + "description": "The specific trading venue where the sale order was placed.", "default": null, "optional": true }, { - "name": "form_type", - "type": "str", - "description": "Filter by form type. Check the data provider for available types.", + "name": "quote_conditions", + "type": "Union[str, int, List[str], List[int]]", + "description": "Conditions or condition codes applicable to the quote.", "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 100, + "name": "quote_indicators", + "type": "Union[str, int, List[str], List[int]]", + "description": "Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'sec']", - "description": "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.", - "default": "fmp", + "name": "sales_conditions", + "type": "Union[str, int, List[str], List[int]]", + "description": "Conditions or condition codes applicable to the sale.", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "name": "sequence_number", + "type": "int", + "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11).", "default": null, "optional": true }, { - "name": "form_type", + "name": "market_center", "type": "str", - "description": "Filter by form type. Check the data provider for available types.", + "description": "The ID of the UTP participant that originated the message.", "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 100, + "name": "participant_timestamp", + "type": "datetime", + "description": "Timestamp for when the quote was generated by the exchange.", + "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "trf_timestamp", + "type": "datetime", + "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "sip_timestamp", + "type": "datetime", + "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange.", "default": null, "optional": true }, { - "name": "thea_enabled", - "type": "bool", - "description": "Return filings that have been read by Intrinio's Thea NLP.", + "name": "last_price", + "type": "float", + "description": "Price of the last trade.", "default": null, "optional": true - } - ], - "sec": [ + }, { - "name": "symbol", + "name": "last_tick", "type": "str", - "description": "Symbol to get data for.", + "description": "Whether the last sale was an up or down tick.", "default": null, "optional": true }, { - "name": "form_type", - "type": "Literal['1', '1-A', '1-A POS', '1-A-W', '1-E', '1-E AD', '1-K', '1-SA', '1-U', '1-Z', '1-Z-W', '10-12B', '10-12G', '10-D', '10-K', '10-KT', '10-Q', '10-QT', '11-K', '11-KT', '13F-HR', '13F-NT', '13FCONP', '144', '15-12B', '15-12G', '15-15D', '15F-12B', '15F-12G', '15F-15D', '18-12B', '18-K', '19B-4E', '2-A', '2-AF', '2-E', '20-F', '20FR12B', '20FR12G', '24F-2NT', '25', '25-NSE', '253G1', '253G2', '253G3', '253G4', '3', '305B2', '34-12H', '4', '40-17F1', '40-17F2', '40-17G', '40-17GCS', '40-202A', '40-203A', '40-206A', '40-24B2', '40-33', '40-6B', '40-8B25', '40-8F-2', '40-APP', '40-F', '40-OIP', '40FR12B', '40FR12G', '424A', '424B1', '424B2', '424B3', '424B4', '424B5', '424B7', '424B8', '424H', '425', '485APOS', '485BPOS', '485BXT', '486APOS', '486BPOS', '486BXT', '487', '497', '497AD', '497H2', '497J', '497K', '497VPI', '497VPU', '5', '6-K', '6B NTC', '6B ORDR', '8-A12B', '8-A12G', '8-K', '8-K12B', '8-K12G3', '8-K15D5', '8-M', '8F-2 NTC', '8F-2 ORDR', '9-M', 'ABS-15G', 'ABS-EE', 'ADN-MTL', 'ADV-E', 'ADV-H-C', 'ADV-H-T', 'ADV-NR', 'ANNLRPT', 'APP NTC', 'APP ORDR', 'APP WD', 'APP WDG', 'ARS', 'ATS-N', 'ATS-N-C', 'ATS-N/UA', 'AW', 'AW WD', 'C', 'C-AR', 'C-AR-W', 'C-TR', 'C-TR-W', 'C-U', 'C-U-W', 'C-W', 'CB', 'CERT', 'CERTARCA', 'CERTBATS', 'CERTCBO', 'CERTNAS', 'CERTNYS', 'CERTPAC', 'CFPORTAL', 'CFPORTAL-W', 'CORRESP', 'CT ORDER', 'D', 'DEF 14A', 'DEF 14C', 'DEFA14A', 'DEFA14C', 'DEFC14A', 'DEFC14C', 'DEFM14A', 'DEFM14C', 'DEFN14A', 'DEFR14A', 'DEFR14C', 'DEL AM', 'DFAN14A', 'DFRN14A', 'DOS', 'DOSLTR', 'DRS', 'DRSLTR', 'DSTRBRPT', 'EFFECT', 'F-1', 'F-10', 'F-10EF', 'F-10POS', 'F-1MEF', 'F-3', 'F-3ASR', 'F-3D', 'F-3DPOS', 'F-3MEF', 'F-4', 'F-4 POS', 'F-4MEF', 'F-6', 'F-6 POS', 'F-6EF', 'F-7', 'F-7 POS', 'F-8', 'F-8 POS', 'F-80', 'F-80POS', 'F-9', 'F-9 POS', 'F-N', 'F-X', 'FOCUSN', 'FWP', 'G-405', 'G-405N', 'G-FIN', 'G-FINW', 'IRANNOTICE', 'MA', 'MA-A', 'MA-I', 'MA-W', 'MSD', 'MSDCO', 'MSDW', 'N-1', 'N-14', 'N-14 8C', 'N-14MEF', 'N-18F1', 'N-1A', 'N-2', 'N-2 POSASR', 'N-23C-2', 'N-23C3A', 'N-23C3B', 'N-23C3C', 'N-2ASR', 'N-2MEF', 'N-30B-2', 'N-30D', 'N-4', 'N-5', 'N-54A', 'N-54C', 'N-6', 'N-6F', 'N-8A', 'N-8B-2', 'N-8F', 'N-8F NTC', 'N-8F ORDR', 'N-CEN', 'N-CR', 'N-CSR', 'N-CSRS', 'N-MFP', 'N-MFP1', 'N-MFP2', 'N-PX', 'N-Q', 'N-VP', 'N-VPFS', 'NO ACT', 'NPORT-EX', 'NPORT-NP', 'NPORT-P', 'NRSRO-CE', 'NRSRO-UPD', 'NSAR-A', 'NSAR-AT', 'NSAR-B', 'NSAR-BT', 'NSAR-U', 'NT 10-D', 'NT 10-K', 'NT 10-Q', 'NT 11-K', 'NT 20-F', 'NT N-CEN', 'NT N-MFP', 'NT N-MFP1', 'NT N-MFP2', 'NT NPORT-EX', 'NT NPORT-P', 'NT-NCEN', 'NT-NCSR', 'NT-NSAR', 'NTFNCEN', 'NTFNCSR', 'NTFNSAR', 'NTN 10D', 'NTN 10K', 'NTN 10Q', 'NTN 20F', 'OIP NTC', 'OIP ORDR', 'POS 8C', 'POS AM', 'POS AMI', 'POS EX', 'POS462B', 'POS462C', 'POSASR', 'PRE 14A', 'PRE 14C', 'PREC14A', 'PREC14C', 'PREM14A', 'PREM14C', 'PREN14A', 'PRER14A', 'PRER14C', 'PRRN14A', 'PX14A6G', 'PX14A6N', 'QRTLYRPT', 'QUALIF', 'REG-NR', 'REVOKED', 'RW', 'RW WD', 'S-1', 'S-11', 'S-11MEF', 'S-1MEF', 'S-20', 'S-3', 'S-3ASR', 'S-3D', 'S-3DPOS', 'S-3MEF', 'S-4', 'S-4 POS', 'S-4EF', 'S-4MEF', 'S-6', 'S-8', 'S-8 POS', 'S-B', 'S-BMEF', 'SBSE', 'SBSE-A', 'SBSE-BD', 'SBSE-C', 'SBSE-W', 'SC 13D', 'SC 13E1', 'SC 13E3', 'SC 13G', 'SC 14D9', 'SC 14F1', 'SC 14N', 'SC TO-C', 'SC TO-I', 'SC TO-T', 'SC13E4F', 'SC14D1F', 'SC14D9C', 'SC14D9F', 'SD', 'SDR', 'SE', 'SEC ACTION', 'SEC STAFF ACTION', 'SEC STAFF LETTER', 'SF-1', 'SF-3', 'SL', 'SP 15D2', 'STOP ORDER', 'SUPPL', 'T-3', 'TA-1', 'TA-2', 'TA-W', 'TACO', 'TH', 'TTW', 'UNDER', 'UPLOAD', 'WDL-REQ', 'X-17A-5']", - "description": "Type of the SEC filing form.", + "name": "last_size", + "type": "int", + "description": "Size of the last trade.", "default": null, "optional": true }, { - "name": "cik", - "type": "Union[int, str]", - "description": "Lookup filings by Central Index Key (CIK) instead of by symbol.", + "name": "last_timestamp", + "type": "datetime", + "description": "Date and Time when the last price was recorded.", "default": null, "optional": true }, { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache. If True, cache will store for one day.", - "default": true, + "name": "open", + "type": "float", + "description": "The open price.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[CompanyFilings]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'sec']]", - "description": "Provider name." + "name": "high", + "type": "float", + "description": "The high price.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "low", + "type": "float", + "description": "The low price.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "filing_date", - "type": "date", - "description": "The date of the filing.", - "default": "", - "optional": false + "name": "volume", + "type": "Union[int, float]", + "description": "The trading volume.", + "default": null, + "optional": true }, { - "name": "accepted_date", - "type": "datetime", - "description": "Accepted date of the filing.", + "name": "exchange_volume", + "type": "Union[int, float]", + "description": "Volume of shares exchanged during the trading day on the specific exchange.", "default": null, "optional": true }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "prev_close", + "type": "float", + "description": "The previous close price.", "default": null, "optional": true }, { - "name": "cik", - "type": "str", - "description": "Central Index Key (CIK) for the requested entity.", + "name": "change", + "type": "float", + "description": "Change in price from previous close.", "default": null, "optional": true }, { - "name": "report_type", - "type": "str", - "description": "Type of filing.", + "name": "change_percent", + "type": "float", + "description": "Change in price as a normalized percentage.", "default": null, "optional": true }, { - "name": "filing_url", - "type": "str", - "description": "URL to the filing page.", + "name": "year_high", + "type": "float", + "description": "The one year high (52W High).", "default": null, "optional": true }, { - "name": "report_url", - "type": "str", - "description": "URL to the actual report.", - "default": "", - "optional": false + "name": "year_low", + "type": "float", + "description": "The one year low (52W Low).", + "default": null, + "optional": true } ], "fmp": [ { - "name": "filing_date", - "type": "date", - "description": "The date of the filing.", - "default": "", - "optional": false - }, - { - "name": "accepted_date", - "type": "datetime", - "description": "Accepted date of the filing.", - "default": null, - "optional": true - }, - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": null, - "optional": true - }, - { - "name": "cik", - "type": "str", - "description": "Central Index Key (CIK) for the requested entity.", + "name": "price_avg50", + "type": "float", + "description": "50 day moving average price.", "default": null, "optional": true }, { - "name": "report_type", - "type": "str", - "description": "Type of filing.", + "name": "price_avg200", + "type": "float", + "description": "200 day moving average price.", "default": null, "optional": true }, { - "name": "filing_url", - "type": "str", - "description": "URL to the filing page.", + "name": "avg_volume", + "type": "int", + "description": "Average volume over the last 10 trading days.", "default": null, "optional": true }, { - "name": "report_url", - "type": "str", - "description": "URL to the actual report.", - "default": "", - "optional": false - } - ], - "intrinio": [ - { - "name": "id", - "type": "str", - "description": "Intrinio ID of the filing.", - "default": "", - "optional": false - }, - { - "name": "period_end_date", - "type": "date", - "description": "Ending date of the fiscal period for the filing.", + "name": "market_cap", + "type": "float", + "description": "Market cap of the company.", "default": null, "optional": true }, { - "name": "sec_unique_id", - "type": "str", - "description": "SEC unique ID of the filing.", - "default": "", - "optional": false - }, - { - "name": "instance_url", - "type": "str", - "description": "URL for the XBRL filing for the report.", + "name": "shares_outstanding", + "type": "int", + "description": "Number of shares outstanding.", "default": null, "optional": true }, { - "name": "industry_group", - "type": "str", - "description": "Industry group of the company.", - "default": "", - "optional": false - }, - { - "name": "industry_category", - "type": "str", - "description": "Industry category of the company.", - "default": "", - "optional": false - } - ], - "sec": [ - { - "name": "report_date", - "type": "date", - "description": "The date of the filing.", + "name": "eps", + "type": "float", + "description": "Earnings per share.", "default": null, "optional": true }, { - "name": "act", - "type": "Union[int, str]", - "description": "The SEC Act number.", + "name": "pe", + "type": "float", + "description": "Price earnings ratio.", "default": null, "optional": true }, { - "name": "items", - "type": "Union[str, float]", - "description": "The SEC Item numbers.", + "name": "earnings_announcement", + "type": "datetime", + "description": "Upcoming earnings announcement date.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "primary_doc_description", - "type": "str", - "description": "The description of the primary document.", + "name": "is_darkpool", + "type": "bool", + "description": "Whether or not the current trade is from a darkpool.", "default": null, "optional": true }, { - "name": "primary_doc", + "name": "source", "type": "str", - "description": "The filename of the primary document.", - "default": null, - "optional": true - }, - { - "name": "accession_number", - "type": "Union[int, str]", - "description": "The accession number.", + "description": "Source of the Intrinio data.", "default": null, "optional": true }, { - "name": "file_number", - "type": "Union[int, str]", - "description": "The file number.", - "default": null, - "optional": true + "name": "updated_on", + "type": "datetime", + "description": "Date and Time when the data was last updated.", + "default": "", + "optional": false }, { - "name": "film_number", - "type": "Union[int, str]", - "description": "The film number.", + "name": "security", + "type": "IntrinioSecurity", + "description": "Security details related to the quote.", "default": null, "optional": true - }, + } + ], + "yfinance": [ { - "name": "is_inline_xbrl", - "type": "Union[int, str]", - "description": "Whether the filing is an inline XBRL filing.", + "name": "ma_50d", + "type": "float", + "description": "50-day moving average price.", "default": null, "optional": true }, { - "name": "is_xbrl", - "type": "Union[int, str]", - "description": "Whether the filing is an XBRL filing.", + "name": "ma_200d", + "type": "float", + "description": "200-day moving average price.", "default": null, "optional": true }, { - "name": "size", - "type": "Union[int, str]", - "description": "The size of the filing.", + "name": "volume_average", + "type": "float", + "description": "Average daily trading volume.", "default": null, "optional": true }, { - "name": "complete_submission_url", - "type": "str", - "description": "The URL to the complete filing submission.", + "name": "volume_average_10d", + "type": "float", + "description": "Average daily trading volume in the last 10 days.", "default": null, "optional": true }, { - "name": "filing_detail_url", + "name": "currency", "type": "str", - "description": "The URL to the filing details.", + "description": "Currency of the price.", "default": null, "optional": true } ] }, - "model": "CompanyFilings" + "model": "EquityQuote" }, - "/equity/fundamental/historical_splits": { + "/equity/price/nbbo": { "deprecated": { "flag": null, "message": null }, - "description": "Get historical stock splits for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_splits(symbol='AAPL', provider='fmp')\n```\n\n", + "description": "Get the National Best Bid and Offer for a given stock.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.nbbo(symbol='AAPL', provider='polygon')\n```\n\n", "parameters": { "standard": [ { @@ -20007,19 +18511,54 @@ }, { "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", + "type": "Literal['polygon']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'polygon' if there is no default.", + "default": "polygon", "optional": true } ], - "fmp": [ + "polygon": [ { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false + "name": "limit", + "type": "int", + "description": "The number of data entries to return. Up to ten million records will be returned. Pagination occurs in groups of 50,000. Remaining limit values will always return 50,000 more records unless it is the last page. High volume tickers will require multiple max requests for a single day's NBBO records. Expect stocks, like SPY, to approach 1GB in size, per day, as a raw CSV. Splitting large requests into chunks is recommended for full-day requests of high-volume symbols.", + "default": 50000, + "optional": true + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for. Use bracketed the timestamp parameters to specify exact time ranges.", + "default": null, + "optional": true + }, + { + "name": "timestamp_lt", + "type": "Union[datetime, str]", + "description": "Query by datetime, less than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", + "default": null, + "optional": true + }, + { + "name": "timestamp_gt", + "type": "Union[datetime, str]", + "description": "Query by datetime, greater than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", + "default": null, + "optional": true + }, + { + "name": "timestamp_lte", + "type": "Union[datetime, str]", + "description": "Query by datetime, less than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", + "default": null, + "optional": true + }, + { + "name": "timestamp_gte", + "type": "Union[datetime, str]", + "description": "Query by datetime, greater than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", + "default": null, + "optional": true } ] }, @@ -20027,12 +18566,12 @@ "OBBject": [ { "name": "results", - "type": "List[HistoricalSplits]", + "type": "List[EquityNBBO]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['polygon']]", "description": "Provider name." }, { @@ -20055,266 +18594,287 @@ "data": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "ask_exchange", + "type": "str", + "description": "The exchange ID for the ask.", "default": "", "optional": false }, { - "name": "numerator", - "type": "float", - "description": "Numerator of the split.", - "default": null, - "optional": true - }, - { - "name": "denominator", + "name": "ask", "type": "float", - "description": "Denominator of the split.", - "default": null, - "optional": true + "description": "The last ask price.", + "default": "", + "optional": false }, { - "name": "split_ratio", - "type": "str", - "description": "Split ratio.", - "default": null, - "optional": true - } - ], - "fmp": [ + "name": "ask_size", + "type": "int", + "description": "The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price.", + "default": "", + "optional": false + }, { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "bid_size", + "type": "int", + "description": "The bid size in round lots.", "default": "", "optional": false }, { - "name": "numerator", + "name": "bid", "type": "float", - "description": "Numerator of the split.", + "description": "The last bid price.", + "default": "", + "optional": false + }, + { + "name": "bid_exchange", + "type": "str", + "description": "The exchange ID for the bid.", + "default": "", + "optional": false + } + ], + "polygon": [ + { + "name": "tape", + "type": "str", + "description": "The exchange tape.", "default": null, "optional": true }, { - "name": "denominator", - "type": "float", - "description": "Denominator of the split.", + "name": "conditions", + "type": "Union[str, List[int], List[str]]", + "description": "A list of condition codes.", "default": null, "optional": true }, { - "name": "split_ratio", - "type": "str", - "description": "Split ratio.", + "name": "indicators", + "type": "List[int]", + "description": "A list of indicator codes.", + "default": null, + "optional": true + }, + { + "name": "sequence_num", + "type": "int", + "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11)", + "default": null, + "optional": true + }, + { + "name": "participant_timestamp", + "type": "datetime", + "description": "The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.", + "default": null, + "optional": true + }, + { + "name": "sip_timestamp", + "type": "datetime", + "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it.", + "default": null, + "optional": true + }, + { + "name": "trf_timestamp", + "type": "datetime", + "description": "The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this quote.", "default": null, "optional": true } ] }, - "model": "HistoricalSplits" + "model": "EquityNBBO" }, - "/equity/fundamental/transcript": { + "/equity/price/historical": { "deprecated": { "flag": null, "message": null }, - "description": "Get earnings call transcripts for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.transcript(symbol='AAPL', year=2020, provider='fmp')\n```\n\n", + "description": "Get historical price data for a given stock. This includes open, high, low, close, and volume.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.historical(symbol='AAPL', provider='fmp')\nobb.equity.price.historical(symbol='AAPL', interval='1d', provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", "default": "", "optional": false }, { - "name": "year", - "type": "int", - "description": "Year of the earnings call transcript.", - "default": "", - "optional": false + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true }, { "name": "provider", - "type": "Literal['fmp']", + "type": "Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']", "description": "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.", "default": "fmp", "optional": true } ], "fmp": [ + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ], + "intrinio": [ { "name": "symbol", "type": "str", - "description": "Symbol to get data for.", + "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", "default": "", "optional": false }, { - "name": "year", - "type": "int", - "description": "Year of the earnings call transcript.", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EarningsCallTranscript]", - "description": "Serializable results." + "name": "interval", + "type": "Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "start_time", + "type": "datetime.time", + "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "end_time", + "type": "datetime.time", + "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "timezone", + "type": "str", + "description": "Timezone of the data, in the IANA format (Continent/City).", + "default": "America/New_York", + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "source", + "type": "Literal['realtime', 'delayed', 'nasdaq_basic']", + "description": "The source of the data.", + "default": "realtime", + "optional": true } - ] - }, - "data": { - "standard": [ + ], + "polygon": [ { - "name": "symbol", + "name": "interval", "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", + "default": "1d", + "optional": true }, { - "name": "quarter", - "type": "int", - "description": "Quarter of the earnings call transcript.", - "default": "", - "optional": false + "name": "adjustment", + "type": "Literal['splits_only', 'unadjusted']", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", + "optional": true }, { - "name": "year", - "type": "int", - "description": "Year of the earnings call transcript.", - "default": "", - "optional": false + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": false, + "optional": true }, { - "name": "date", - "type": "datetime", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", + "default": "asc", + "optional": true }, { - "name": "content", - "type": "str", - "description": "Content of the earnings call transcript.", - "default": "", - "optional": false + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 49999, + "optional": true } ], - "fmp": [ + "tiingo": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "interval", + "type": "Literal['1d', '1W', '1M', '1Y']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ], + "yfinance": [ + { + "name": "interval", + "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true }, { - "name": "quarter", - "type": "int", - "description": "Quarter of the earnings call transcript.", - "default": "", - "optional": false - }, - { - "name": "year", - "type": "int", - "description": "Year of the earnings call transcript.", - "default": "", - "optional": false - }, - { - "name": "date", - "type": "datetime", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": false, + "optional": true }, { - "name": "content", - "type": "str", - "description": "Content of the earnings call transcript.", - "default": "", - "optional": false - } - ] - }, - "model": "EarningsCallTranscript" - }, - "/equity/fundamental/trailing_dividend_yield": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the 1 year trailing dividend yield for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.trailing_dividend_yield(symbol='AAPL', provider='tiingo')\nobb.equity.fundamental.trailing_dividend_yield(symbol='AAPL', limit=252, provider='tiingo')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false + "name": "include_actions", + "type": "bool", + "description": "Include dividends and stock splits in results.", + "default": true, + "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. Default is 252, the number of trading days in a year.", - "default": 252, + "name": "adjustment", + "type": "Literal['splits_only', 'splits_and_dividends']", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", "optional": true }, { - "name": "provider", - "type": "Literal['tiingo']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tiingo' if there is no default.", - "default": "tiingo", + "name": "adjusted", + "type": "bool", + "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead.", + "default": false, "optional": true - } - ], - "tiingo": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. Default is 252, the number of trading days in a year.", - "default": 252, + "name": "prepost", + "type": "bool", + "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead.", + "default": false, "optional": true } ] @@ -20323,12 +18883,12 @@ "OBBject": [ { "name": "results", - "type": "List[TrailingDividendYield]", + "type": "List[EquityHistorical]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['tiingo']]", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']]", "description": "Provider name." }, { @@ -20352,699 +18912,746 @@ "standard": [ { "name": "date", - "type": "date", + "type": "Union[date, datetime]", "description": "The date of the data.", "default": "", "optional": false }, { - "name": "trailing_dividend_yield", + "name": "open", "type": "float", - "description": "Trailing dividend yield.", + "description": "The open price.", "default": "", "optional": false - } - ], - "tiingo": [ + }, { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "high", + "type": "float", + "description": "The high price.", "default": "", "optional": false }, { - "name": "trailing_dividend_yield", + "name": "low", "type": "float", - "description": "Trailing dividend yield.", + "description": "The low price.", "default": "", "optional": false - } - ] - }, - "model": "TrailingDividendYield" - }, - "/equity/ownership/major_holders": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get data about major holders for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.major_holders(symbol='AAPL', provider='fmp')\nobb.equity.ownership.major_holders(symbol='AAPL', page=0, provider='fmp')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "name": "close", + "type": "float", + "description": "The close price.", "default": "", "optional": false }, { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", + "name": "volume", + "type": "Union[int, float]", + "description": "The trading volume.", "default": null, "optional": true }, { - "name": "page", - "type": "int", - "description": "Page number of the data to fetch.", - "default": 0, - "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": null, "optional": true } ], "fmp": [ { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": null, + "optional": true }, { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", + "name": "unadjusted_volume", + "type": "float", + "description": "Unadjusted volume of the symbol.", "default": null, "optional": true }, { - "name": "page", - "type": "int", - "description": "Page number of the data to fetch.", - "default": 0, + "name": "change", + "type": "float", + "description": "Change in the price from the previous close.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in the price from the previous close, as a normalized percent.", + "default": null, "optional": true } - ] - }, - "returns": { - "OBBject": [ + ], + "intrinio": [ { - "name": "results", - "type": "List[EquityOwnership]", - "description": "Serializable results." + "name": "average", + "type": "float", + "description": "Average trade price of an individual equity during the interval.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "change", + "type": "float", + "description": "Change in the price of the symbol from the previous day.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "change_percent", + "type": "float", + "description": "Percent change in the price of the symbol from the previous day.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "adj_open", + "type": "float", + "description": "The adjusted open price.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "adj_high", + "type": "float", + "description": "The adjusted high price.", + "default": null, + "optional": true + }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "adj_low", + "type": "float", + "description": "The adjusted low price.", + "default": null, + "optional": true }, { - "name": "cik", - "type": "int", - "description": "Central Index Key (CIK) for the requested entity.", - "default": "", - "optional": false + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": null, + "optional": true }, { - "name": "filing_date", - "type": "date", - "description": "Filing date of the stock ownership.", - "default": "", - "optional": false + "name": "adj_volume", + "type": "float", + "description": "The adjusted volume.", + "default": null, + "optional": true }, { - "name": "investor_name", - "type": "str", - "description": "Investor name of the stock ownership.", - "default": "", - "optional": false + "name": "fifty_two_week_high", + "type": "float", + "description": "52 week high price for the symbol.", + "default": null, + "optional": true }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "fifty_two_week_low", + "type": "float", + "description": "52 week low price for the symbol.", + "default": null, + "optional": true }, { - "name": "security_name", - "type": "str", - "description": "Security name of the stock ownership.", - "default": "", - "optional": false + "name": "factor", + "type": "float", + "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices.", + "default": null, + "optional": true }, { - "name": "type_of_security", - "type": "str", - "description": "Type of security of the stock ownership.", - "default": "", - "optional": false + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", + "default": null, + "optional": true }, { - "name": "security_cusip", - "type": "str", - "description": "Security cusip of the stock ownership.", - "default": "", - "optional": false + "name": "dividend", + "type": "float", + "description": "Dividend amount, if a dividend was paid.", + "default": null, + "optional": true }, { - "name": "shares_type", - "type": "str", - "description": "Shares type of the stock ownership.", - "default": "", - "optional": false + "name": "close_time", + "type": "datetime", + "description": "The timestamp that represents the end of the interval span.", + "default": null, + "optional": true }, { - "name": "put_call_share", + "name": "interval", "type": "str", - "description": "Put call share of the stock ownership.", - "default": "", - "optional": false + "description": "The data time frequency.", + "default": null, + "optional": true }, { - "name": "investment_discretion", - "type": "str", - "description": "Investment discretion of the stock ownership.", - "default": "", - "optional": false - }, + "name": "intra_period", + "type": "bool", + "description": "If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period", + "default": null, + "optional": true + } + ], + "polygon": [ { - "name": "industry_title", - "type": "str", - "description": "Industry title of the stock ownership.", - "default": "", - "optional": false - }, + "name": "transactions", + "type": "Annotated[int, Gt(gt=0)]", + "description": "Number of transactions for the symbol in the time period.", + "default": null, + "optional": true + } + ], + "tiingo": [ { - "name": "weight", + "name": "adj_open", "type": "float", - "description": "Weight of the stock ownership.", - "default": "", - "optional": false + "description": "The adjusted open price.", + "default": null, + "optional": true }, { - "name": "last_weight", + "name": "adj_high", "type": "float", - "description": "Last weight of the stock ownership.", - "default": "", - "optional": false + "description": "The adjusted high price.", + "default": null, + "optional": true }, { - "name": "change_in_weight", + "name": "adj_low", "type": "float", - "description": "Change in weight of the stock ownership.", - "default": "", - "optional": false + "description": "The adjusted low price.", + "default": null, + "optional": true }, { - "name": "change_in_weight_percentage", + "name": "adj_close", "type": "float", - "description": "Change in weight percentage of the stock ownership.", - "default": "", - "optional": false + "description": "The adjusted close price.", + "default": null, + "optional": true }, { - "name": "market_value", - "type": "int", - "description": "Market value of the stock ownership.", - "default": "", - "optional": false + "name": "adj_volume", + "type": "float", + "description": "The adjusted volume.", + "default": null, + "optional": true }, { - "name": "last_market_value", - "type": "int", - "description": "Last market value of the stock ownership.", - "default": "", - "optional": false + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", + "default": null, + "optional": true }, { - "name": "change_in_market_value", - "type": "int", - "description": "Change in market value of the stock ownership.", - "default": "", - "optional": false - }, + "name": "dividend", + "type": "float", + "description": "Dividend amount, if a dividend was paid.", + "default": null, + "optional": true + } + ], + "yfinance": [ { - "name": "change_in_market_value_percentage", + "name": "split_ratio", "type": "float", - "description": "Change in market value percentage of the stock ownership.", - "default": "", - "optional": false + "description": "Ratio of the equity split, if a split occurred.", + "default": null, + "optional": true }, { - "name": "shares_number", - "type": "int", - "description": "Shares number of the stock ownership.", - "default": "", - "optional": false - }, + "name": "dividend", + "type": "float", + "description": "Dividend amount (split-adjusted), if a dividend was paid.", + "default": null, + "optional": true + } + ] + }, + "model": "EquityHistorical" + }, + "/equity/price/performance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get price performance data for a given stock. This includes price changes for different time periods.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.performance(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "last_shares_number", - "type": "int", - "description": "Last shares number of the stock ownership.", + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": "", "optional": false }, { - "name": "change_in_shares_number", - "type": "float", - "description": "Change in shares number of the stock ownership.", - "default": "", - "optional": false + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[PricePerformance]", + "description": "Serializable results." }, { - "name": "change_in_shares_number_percentage", - "type": "float", - "description": "Change in shares number percentage of the stock ownership.", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "quarter_end_price", - "type": "float", - "description": "Quarter end price of the stock ownership.", - "default": "", - "optional": false + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "avg_price_paid", - "type": "float", - "description": "Average price paid of the stock ownership.", - "default": "", - "optional": false + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "is_new", - "type": "bool", - "description": "Is the stock ownership new.", - "default": "", - "optional": false + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true }, { - "name": "is_sold_out", - "type": "bool", - "description": "Is the stock ownership sold out.", - "default": "", - "optional": false + "name": "one_day", + "type": "float", + "description": "One-day return.", + "default": null, + "optional": true }, { - "name": "ownership", + "name": "wtd", "type": "float", - "description": "How much is the ownership.", - "default": "", - "optional": false + "description": "Week to date return.", + "default": null, + "optional": true }, { - "name": "last_ownership", + "name": "one_week", "type": "float", - "description": "Last ownership amount.", - "default": "", - "optional": false + "description": "One-week return.", + "default": null, + "optional": true }, { - "name": "change_in_ownership", + "name": "mtd", "type": "float", - "description": "Change in ownership amount.", - "default": "", - "optional": false + "description": "Month to date return.", + "default": null, + "optional": true }, { - "name": "change_in_ownership_percentage", + "name": "one_month", "type": "float", - "description": "Change in ownership percentage.", - "default": "", - "optional": false + "description": "One-month return.", + "default": null, + "optional": true }, { - "name": "holding_period", - "type": "int", - "description": "Holding period of the stock ownership.", - "default": "", - "optional": false + "name": "qtd", + "type": "float", + "description": "Quarter to date return.", + "default": null, + "optional": true }, { - "name": "first_added", - "type": "date", - "description": "First added date of the stock ownership.", - "default": "", - "optional": false + "name": "three_month", + "type": "float", + "description": "Three-month return.", + "default": null, + "optional": true }, { - "name": "performance", + "name": "six_month", "type": "float", - "description": "Performance of the stock ownership.", - "default": "", - "optional": false + "description": "Six-month return.", + "default": null, + "optional": true }, { - "name": "performance_percentage", + "name": "ytd", "type": "float", - "description": "Performance percentage of the stock ownership.", - "default": "", - "optional": false + "description": "Year to date return.", + "default": null, + "optional": true }, { - "name": "last_performance", + "name": "one_year", "type": "float", - "description": "Last performance of the stock ownership.", - "default": "", - "optional": false + "description": "One-year return.", + "default": null, + "optional": true }, { - "name": "change_in_performance", + "name": "two_year", "type": "float", - "description": "Change in performance of the stock ownership.", - "default": "", - "optional": false + "description": "Two-year return.", + "default": null, + "optional": true }, { - "name": "is_counted_for_performance", - "type": "bool", - "description": "Is the stock ownership counted for performance.", - "default": "", - "optional": false - } - ], - "fmp": [ + "name": "three_year", + "type": "float", + "description": "Three-year return.", + "default": null, + "optional": true + }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "four_year", + "type": "float", + "description": "Four-year", + "default": null, + "optional": true }, { - "name": "cik", - "type": "int", - "description": "Central Index Key (CIK) for the requested entity.", - "default": "", - "optional": false + "name": "five_year", + "type": "float", + "description": "Five-year return.", + "default": null, + "optional": true }, { - "name": "filing_date", - "type": "date", - "description": "Filing date of the stock ownership.", - "default": "", - "optional": false + "name": "ten_year", + "type": "float", + "description": "Ten-year return.", + "default": null, + "optional": true }, { - "name": "investor_name", + "name": "max", + "type": "float", + "description": "Return from the beginning of the time series.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "symbol", "type": "str", - "description": "Investor name of the stock ownership.", + "description": "The ticker symbol.", "default": "", "optional": false - }, + } + ] + }, + "model": "PricePerformance" + }, + "/equity/shorts/fails_to_deliver": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get reported Fail-to-deliver (FTD) data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.shorts.fails_to_deliver(symbol='AAPL', provider='sec')\n```\n\n", + "parameters": { + "standard": [ { "name": "symbol", "type": "str", - "description": "Symbol representing the entity requested in the data.", + "description": "Symbol to get data for.", "default": "", "optional": false }, { - "name": "security_name", - "type": "str", - "description": "Security name of the stock ownership.", - "default": "", - "optional": false + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", + "optional": true + } + ], + "sec": [ + { + "name": "limit", + "type": "int", + "description": "Limit the number of reports to parse, from most recent. Approximately 24 reports per year, going back to 2009.", + "default": 24, + "optional": true }, { - "name": "type_of_security", - "type": "str", - "description": "Type of security of the stock ownership.", - "default": "", - "optional": false + "name": "skip_reports", + "type": "int", + "description": "Skip N number of reports from current. A value of 1 will skip the most recent report.", + "default": 0, + "optional": true }, { - "name": "security_cusip", - "type": "str", - "description": "Security cusip of the stock ownership.", - "default": "", - "optional": false + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache for the request, default is True. Each reporting period is a separate URL, new reports will be added to the cache.", + "default": true, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityFTD]", + "description": "Serializable results." }, { - "name": "shares_type", - "type": "str", - "description": "Shares type of the stock ownership.", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['sec']]", + "description": "Provider name." }, { - "name": "put_call_share", - "type": "str", - "description": "Put call share of the stock ownership.", - "default": "", - "optional": false + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "investment_discretion", - "type": "str", - "description": "Investment discretion of the stock ownership.", - "default": "", - "optional": false + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "industry_title", - "type": "str", - "description": "Industry title of the stock ownership.", - "default": "", - "optional": false + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "settlement_date", + "type": "date", + "description": "The settlement date of the fail.", + "default": null, + "optional": true }, { - "name": "weight", - "type": "float", - "description": "Weight of the stock ownership.", - "default": "", - "optional": false + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true }, { - "name": "last_weight", - "type": "float", - "description": "Last weight of the stock ownership.", - "default": "", - "optional": false + "name": "cusip", + "type": "str", + "description": "CUSIP of the Security.", + "default": null, + "optional": true }, { - "name": "change_in_weight", - "type": "float", - "description": "Change in weight of the stock ownership.", - "default": "", - "optional": false + "name": "quantity", + "type": "int", + "description": "The number of fails on that settlement date.", + "default": null, + "optional": true }, { - "name": "change_in_weight_percentage", + "name": "price", "type": "float", - "description": "Change in weight percentage of the stock ownership.", - "default": "", - "optional": false + "description": "The price at the previous closing price from the settlement date.", + "default": null, + "optional": true }, { - "name": "market_value", - "type": "int", - "description": "Market value of the stock ownership.", - "default": "", - "optional": false - }, + "name": "description", + "type": "str", + "description": "The description of the Security.", + "default": null, + "optional": true + } + ], + "sec": [] + }, + "model": "EquityFTD" + }, + "/equity/search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search for stock symbol, CIK, LEI, or company name.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.search(provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ { - "name": "last_market_value", - "type": "int", - "description": "Last market value of the stock ownership.", + "name": "query", + "type": "str", + "description": "Search query.", "default": "", - "optional": false + "optional": true }, { - "name": "change_in_market_value", - "type": "int", - "description": "Change in market value of the stock ownership.", - "default": "", - "optional": false + "name": "is_symbol", + "type": "bool", + "description": "Whether to search by ticker symbol.", + "default": false, + "optional": true }, { - "name": "change_in_market_value_percentage", - "type": "float", - "description": "Change in market value percentage of the stock ownership.", - "default": "", - "optional": false + "name": "use_cache", + "type": "bool", + "description": "Whether to use the cache or not.", + "default": true, + "optional": true }, { - "name": "shares_number", - "type": "int", - "description": "Shares number of the stock ownership.", - "default": "", - "optional": false + "name": "provider", + "type": "Literal['intrinio', 'sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", + "optional": true + } + ], + "intrinio": [ + { + "name": "active", + "type": "bool", + "description": "When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded.", + "default": true, + "optional": true }, { - "name": "last_shares_number", + "name": "limit", "type": "int", - "description": "Last shares number of the stock ownership.", - "default": "", - "optional": false - }, + "description": "The number of data entries to return.", + "default": 10000, + "optional": true + } + ], + "sec": [ { - "name": "change_in_shares_number", - "type": "float", - "description": "Change in shares number of the stock ownership.", - "default": "", - "optional": false - }, + "name": "is_fund", + "type": "bool", + "description": "Whether to direct the search to the list of mutual funds and ETFs.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ { - "name": "change_in_shares_number_percentage", - "type": "float", - "description": "Change in shares number percentage of the stock ownership.", - "default": "", - "optional": false + "name": "results", + "type": "List[EquitySearch]", + "description": "Serializable results." }, { - "name": "quarter_end_price", - "type": "float", - "description": "Quarter end price of the stock ownership.", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['intrinio', 'sec']]", + "description": "Provider name." }, { - "name": "avg_price_paid", - "type": "float", - "description": "Average price paid of the stock ownership.", - "default": "", - "optional": false + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "is_new", - "type": "bool", - "description": "Is the stock ownership new.", - "default": "", - "optional": false + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "is_sold_out", - "type": "bool", - "description": "Is the stock ownership sold out.", - "default": "", - "optional": false - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "ownership", - "type": "float", - "description": "How much is the ownership.", - "default": "", - "optional": false + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true }, { - "name": "last_ownership", - "type": "float", - "description": "Last ownership amount.", - "default": "", - "optional": false - }, + "name": "name", + "type": "str", + "description": "Name of the company.", + "default": null, + "optional": true + } + ], + "intrinio": [ { - "name": "change_in_ownership", - "type": "float", - "description": "Change in ownership amount.", + "name": "cik", + "type": "str", + "description": "", "default": "", "optional": false }, { - "name": "change_in_ownership_percentage", - "type": "float", - "description": "Change in ownership percentage.", + "name": "lei", + "type": "str", + "description": "The Legal Entity Identifier (LEI) of the company.", "default": "", "optional": false }, { - "name": "holding_period", - "type": "int", - "description": "Holding period of the stock ownership.", + "name": "intrinio_id", + "type": "str", + "description": "The Intrinio ID of the company.", "default": "", "optional": false - }, + } + ], + "sec": [ { - "name": "first_added", - "type": "date", - "description": "First added date of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "performance", - "type": "float", - "description": "Performance of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "performance_percentage", - "type": "float", - "description": "Performance percentage of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "last_performance", - "type": "float", - "description": "Last performance of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "change_in_performance", - "type": "float", - "description": "Change in performance of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "is_counted_for_performance", - "type": "bool", - "description": "Is the stock ownership counted for performance.", + "name": "cik", + "type": "str", + "description": "Central Index Key", "default": "", "optional": false } ] }, - "model": "EquityOwnership" + "model": "EquitySearch" }, - "/equity/ownership/institutional": { + "/equity/screener": { "deprecated": { "flag": null, "message": null }, - "description": "Get data about institutional ownership for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.institutional(symbol='AAPL', provider='fmp')\n```\n\n", + "description": "Screen for companies meeting various criteria.\n\nThese criteria include market cap, price, beta, volume, and dividend yield.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.screener(provider='fmp')\n```\n\n", "parameters": { "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, { "name": "provider", "type": "Literal['fmp']", @@ -21055,18 +19662,123 @@ ], "fmp": [ { - "name": "include_current_quarter", + "name": "mktcap_min", + "type": "int", + "description": "Filter by market cap greater than this value.", + "default": null, + "optional": true + }, + { + "name": "mktcap_max", + "type": "int", + "description": "Filter by market cap less than this value.", + "default": null, + "optional": true + }, + { + "name": "price_min", + "type": "float", + "description": "Filter by price greater than this value.", + "default": null, + "optional": true + }, + { + "name": "price_max", + "type": "float", + "description": "Filter by price less than this value.", + "default": null, + "optional": true + }, + { + "name": "beta_min", + "type": "float", + "description": "Filter by a beta greater than this value.", + "default": null, + "optional": true + }, + { + "name": "beta_max", + "type": "float", + "description": "Filter by a beta less than this value.", + "default": null, + "optional": true + }, + { + "name": "volume_min", + "type": "int", + "description": "Filter by volume greater than this value.", + "default": null, + "optional": true + }, + { + "name": "volume_max", + "type": "int", + "description": "Filter by volume less than this value.", + "default": null, + "optional": true + }, + { + "name": "dividend_min", + "type": "float", + "description": "Filter by dividend amount greater than this value.", + "default": null, + "optional": true + }, + { + "name": "dividend_max", + "type": "float", + "description": "Filter by dividend amount less than this value.", + "default": null, + "optional": true + }, + { + "name": "is_etf", "type": "bool", - "description": "Include current quarter data.", + "description": "If true, returns only ETFs.", "default": false, "optional": true }, { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", + "name": "is_active", + "type": "bool", + "description": "If false, returns only inactive tickers.", + "default": true, + "optional": true + }, + { + "name": "sector", + "type": "Literal['Consumer Cyclical', 'Energy', 'Technology', 'Industrials', 'Financial Services', 'Basic Materials', 'Communication Services', 'Consumer Defensive', 'Healthcare', 'Real Estate', 'Utilities', 'Industrial Goods', 'Financial', 'Services', 'Conglomerates']", + "description": "Filter by sector.", + "default": null, + "optional": true + }, + { + "name": "industry", + "type": "str", + "description": "Filter by industry.", "default": null, "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Filter by country, as a two-letter country code.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra']", + "description": "Filter by exchange.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "Limit the number of results to return.", + "default": 50000, + "optional": true } ] }, @@ -21074,7 +19786,7 @@ "OBBject": [ { "name": "results", - "type": "List[InstitutionalOwnership]", + "type": "List[EquityScreener]", "description": "Serializable results." }, { @@ -21109,337 +19821,140 @@ "optional": false }, { - "name": "cik", + "name": "name", "type": "str", - "description": "Central Index Key (CIK) for the requested entity.", - "default": null, - "optional": true - }, - { - "name": "date", - "type": "date", - "description": "The date of the data.", + "description": "Name of the company.", "default": "", "optional": false } ], "fmp": [ { - "name": "investors_holding", - "type": "int", - "description": "Number of investors holding the stock.", - "default": "", - "optional": false - }, - { - "name": "last_investors_holding", - "type": "int", - "description": "Number of investors holding the stock in the last quarter.", - "default": "", - "optional": false - }, - { - "name": "investors_holding_change", + "name": "market_cap", "type": "int", - "description": "Change in the number of investors holding the stock.", - "default": "", - "optional": false + "description": "The market cap of ticker.", + "default": null, + "optional": true }, { - "name": "number_of_13f_shares", - "type": "int", - "description": "Number of 13F shares.", + "name": "sector", + "type": "str", + "description": "The sector the ticker belongs to.", "default": null, "optional": true }, { - "name": "last_number_of_13f_shares", - "type": "int", - "description": "Number of 13F shares in the last quarter.", + "name": "industry", + "type": "str", + "description": "The industry ticker belongs to.", "default": null, "optional": true }, { - "name": "number_of_13f_shares_change", - "type": "int", - "description": "Change in the number of 13F shares.", + "name": "beta", + "type": "float", + "description": "The beta of the ETF.", "default": null, "optional": true }, { - "name": "total_invested", + "name": "price", "type": "float", - "description": "Total amount invested.", - "default": "", - "optional": false + "description": "The current price.", + "default": null, + "optional": true }, { - "name": "last_total_invested", + "name": "last_annual_dividend", "type": "float", - "description": "Total amount invested in the last quarter.", - "default": "", - "optional": false + "description": "The last annual amount dividend paid.", + "default": null, + "optional": true }, { - "name": "total_invested_change", - "type": "float", - "description": "Change in the total amount invested.", - "default": "", - "optional": false + "name": "volume", + "type": "int", + "description": "The current trading volume.", + "default": null, + "optional": true }, { - "name": "ownership_percent", - "type": "float", - "description": "Ownership percent.", - "default": "", - "optional": false + "name": "exchange", + "type": "str", + "description": "The exchange code the asset trades on.", + "default": null, + "optional": true }, { - "name": "last_ownership_percent", - "type": "float", - "description": "Ownership percent in the last quarter.", - "default": "", - "optional": false - }, - { - "name": "ownership_percent_change", - "type": "float", - "description": "Change in the ownership percent.", - "default": "", - "optional": false - }, - { - "name": "new_positions", - "type": "int", - "description": "Number of new positions.", - "default": "", - "optional": false - }, - { - "name": "last_new_positions", - "type": "int", - "description": "Number of new positions in the last quarter.", - "default": "", - "optional": false - }, - { - "name": "new_positions_change", - "type": "int", - "description": "Change in the number of new positions.", - "default": "", - "optional": false - }, - { - "name": "increased_positions", - "type": "int", - "description": "Number of increased positions.", - "default": "", - "optional": false - }, - { - "name": "last_increased_positions", - "type": "int", - "description": "Number of increased positions in the last quarter.", - "default": "", - "optional": false - }, - { - "name": "increased_positions_change", - "type": "int", - "description": "Change in the number of increased positions.", - "default": "", - "optional": false - }, - { - "name": "closed_positions", - "type": "int", - "description": "Number of closed positions.", - "default": "", - "optional": false - }, - { - "name": "last_closed_positions", - "type": "int", - "description": "Number of closed positions in the last quarter.", - "default": "", - "optional": false - }, - { - "name": "closed_positions_change", - "type": "int", - "description": "Change in the number of closed positions.", - "default": "", - "optional": false - }, - { - "name": "reduced_positions", - "type": "int", - "description": "Number of reduced positions.", - "default": "", - "optional": false - }, - { - "name": "last_reduced_positions", - "type": "int", - "description": "Number of reduced positions in the last quarter.", - "default": "", - "optional": false - }, - { - "name": "reduced_positions_change", - "type": "int", - "description": "Change in the number of reduced positions.", - "default": "", - "optional": false - }, - { - "name": "total_calls", - "type": "int", - "description": "Total number of call options contracts traded for Apple Inc. on the specified date.", - "default": "", - "optional": false - }, - { - "name": "last_total_calls", - "type": "int", - "description": "Total number of call options contracts traded for Apple Inc. on the previous reporting date.", - "default": "", - "optional": false - }, - { - "name": "total_calls_change", - "type": "int", - "description": "Change in the total number of call options contracts traded between the current and previous reporting dates.", - "default": "", - "optional": false - }, - { - "name": "total_puts", - "type": "int", - "description": "Total number of put options contracts traded for Apple Inc. on the specified date.", - "default": "", - "optional": false - }, - { - "name": "last_total_puts", - "type": "int", - "description": "Total number of put options contracts traded for Apple Inc. on the previous reporting date.", - "default": "", - "optional": false - }, - { - "name": "total_puts_change", - "type": "int", - "description": "Change in the total number of put options contracts traded between the current and previous reporting dates.", - "default": "", - "optional": false + "name": "exchange_name", + "type": "str", + "description": "The full name of the primary exchange.", + "default": null, + "optional": true }, { - "name": "put_call_ratio", - "type": "float", - "description": "Put-call ratio, which is the ratio of the total number of put options to call options traded on the specified date.", - "default": "", - "optional": false + "name": "country", + "type": "str", + "description": "The two-letter country abbreviation where the head office is located.", + "default": null, + "optional": true }, { - "name": "last_put_call_ratio", - "type": "float", - "description": "Put-call ratio on the previous reporting date.", - "default": "", - "optional": false + "name": "is_etf", + "type": "Literal[True, False]", + "description": "Whether the ticker is an ETF.", + "default": null, + "optional": true }, { - "name": "put_call_ratio_change", - "type": "float", - "description": "Change in the put-call ratio between the current and previous reporting dates.", - "default": "", - "optional": false + "name": "actively_trading", + "type": "Literal[True, False]", + "description": "Whether the ETF is actively trading.", + "default": null, + "optional": true } ] }, - "model": "InstitutionalOwnership" + "model": "EquityScreener" }, - "/equity/ownership/insider_trading": { + "/equity/profile": { "deprecated": { "flag": null, "message": null }, - "description": "Get data about trading by a company's management team and board of directors.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.insider_trading(symbol='AAPL', provider='fmp')\nobb.equity.ownership.insider_trading(symbol='AAPL', limit=500, provider='intrinio')\n```\n\n", + "description": "Get general information about a company. This includes company name, industry, sector and price data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.profile(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": "", "optional": false }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 500, - "optional": true - }, { "name": "provider", - "type": "Literal['fmp', 'intrinio']", + "type": "Literal['fmp', 'intrinio', 'yfinance']", "description": "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.", "default": "fmp", "optional": true } ], - "fmp": [ - { - "name": "transaction_type", - "type": "Literal[None, 'award', 'conversion', 'return', 'expire_short', 'in_kind', 'gift', 'expire_long', 'discretionary', 'other', 'small', 'exempt', 'otm', 'purchase', 'sale', 'tender', 'will', 'itm', 'trust']", - "description": "Type of the transaction.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": "", - "optional": false - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": "", - "optional": false - }, - { - "name": "ownership_type", - "type": "Literal['D', 'I']", - "description": "Type of ownership.", - "default": null, - "optional": true - }, - { - "name": "sort_by", - "type": "Literal['filing_date', 'updated_on']", - "description": "Field to sort by.", - "default": "updated_on", - "optional": true - } - ] + "fmp": [], + "intrinio": [], + "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[InsiderTrading]", + "type": "List[EquityInfo]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio']]", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", "description": "Provider name." }, { @@ -21465,553 +19980,500 @@ "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", - "default": null, - "optional": true + "default": "", + "optional": false }, { - "name": "company_cik", - "type": "Union[int, str]", - "description": "CIK number of the company.", + "name": "name", + "type": "str", + "description": "Common name of the company.", "default": null, "optional": true }, { - "name": "filing_date", - "type": "Union[date, datetime]", - "description": "Filing date of the trade.", + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", "default": null, "optional": true }, { - "name": "transaction_date", - "type": "date", - "description": "Date of the transaction.", + "name": "cusip", + "type": "str", + "description": "CUSIP identifier for the company.", "default": null, "optional": true }, { - "name": "owner_cik", - "type": "Union[int, str]", - "description": "Reporting individual's CIK.", + "name": "isin", + "type": "str", + "description": "International Securities Identification Number.", "default": null, "optional": true }, { - "name": "owner_name", + "name": "lei", "type": "str", - "description": "Name of the reporting individual.", + "description": "Legal Entity Identifier assigned to the company.", "default": null, "optional": true }, { - "name": "owner_title", + "name": "legal_name", "type": "str", - "description": "The title held by the reporting individual.", + "description": "Official legal name of the company.", "default": null, "optional": true }, { - "name": "transaction_type", + "name": "stock_exchange", "type": "str", - "description": "Type of transaction being reported.", + "description": "Stock exchange where the company is traded.", "default": null, "optional": true }, { - "name": "acquisition_or_disposition", + "name": "sic", + "type": "int", + "description": "Standard Industrial Classification code for the company.", + "default": null, + "optional": true + }, + { + "name": "short_description", "type": "str", - "description": "Acquisition or disposition of the shares.", + "description": "Short description of the company.", "default": null, "optional": true }, { - "name": "security_type", + "name": "long_description", "type": "str", - "description": "The type of security transacted.", + "description": "Long description of the company.", "default": null, "optional": true }, { - "name": "securities_owned", - "type": "float", - "description": "Number of securities owned by the reporting individual.", + "name": "ceo", + "type": "str", + "description": "Chief Executive Officer of the company.", "default": null, "optional": true }, { - "name": "securities_transacted", - "type": "float", - "description": "Number of securities transacted by the reporting individual.", + "name": "company_url", + "type": "str", + "description": "URL of the company's website.", "default": null, "optional": true }, { - "name": "transaction_price", - "type": "float", - "description": "The price of the transaction.", + "name": "business_address", + "type": "str", + "description": "Address of the company's headquarters.", "default": null, "optional": true }, { - "name": "filing_url", + "name": "mailing_address", "type": "str", - "description": "Link to the filing.", + "description": "Mailing address of the company.", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "form_type", + "name": "business_phone_no", "type": "str", - "description": "Form type of the insider trading.", - "default": "", - "optional": false - } - ], - "intrinio": [ + "description": "Phone number of the company's headquarters.", + "default": null, + "optional": true + }, { - "name": "filing_url", + "name": "hq_address1", "type": "str", - "description": "URL of the filing.", + "description": "Address of the company's headquarters.", "default": null, "optional": true }, { - "name": "company_name", + "name": "hq_address2", "type": "str", - "description": "Name of the company.", - "default": "", - "optional": false + "description": "Address of the company's headquarters.", + "default": null, + "optional": true }, { - "name": "conversion_exercise_price", - "type": "float", - "description": "Conversion/Exercise price of the shares.", + "name": "hq_address_city", + "type": "str", + "description": "City of the company's headquarters.", "default": null, "optional": true }, { - "name": "deemed_execution_date", - "type": "date", - "description": "Deemed execution date of the trade.", + "name": "hq_address_postal_code", + "type": "str", + "description": "Zip code of the company's headquarters.", "default": null, "optional": true }, { - "name": "exercise_date", - "type": "date", - "description": "Exercise date of the trade.", + "name": "hq_state", + "type": "str", + "description": "State of the company's headquarters.", "default": null, "optional": true }, { - "name": "expiration_date", - "type": "date", - "description": "Expiration date of the derivative.", + "name": "hq_country", + "type": "str", + "description": "Country of the company's headquarters.", "default": null, "optional": true }, { - "name": "underlying_security_title", + "name": "inc_state", "type": "str", - "description": "Name of the underlying non-derivative security related to this derivative transaction.", + "description": "State in which the company is incorporated.", "default": null, "optional": true }, { - "name": "underlying_shares", - "type": "Union[int, float]", - "description": "Number of underlying shares related to this derivative transaction.", + "name": "inc_country", + "type": "str", + "description": "Country in which the company is incorporated.", "default": null, "optional": true }, { - "name": "nature_of_ownership", + "name": "employees", + "type": "int", + "description": "Number of employees working for the company.", + "default": null, + "optional": true + }, + { + "name": "entity_legal_form", "type": "str", - "description": "Nature of ownership of the insider trading.", + "description": "Legal form of the company.", "default": null, "optional": true }, { - "name": "director", - "type": "bool", - "description": "Whether the owner is a director.", + "name": "entity_status", + "type": "str", + "description": "Status of the company.", "default": null, "optional": true }, { - "name": "officer", - "type": "bool", - "description": "Whether the owner is an officer.", + "name": "latest_filing_date", + "type": "date", + "description": "Date of the company's latest filing.", "default": null, "optional": true }, { - "name": "ten_percent_owner", - "type": "bool", - "description": "Whether the owner is a 10% owner.", + "name": "irs_number", + "type": "str", + "description": "IRS number assigned to the company.", "default": null, "optional": true }, { - "name": "other_relation", - "type": "bool", - "description": "Whether the owner is having another relation.", + "name": "sector", + "type": "str", + "description": "Sector in which the company operates.", "default": null, "optional": true }, { - "name": "derivative_transaction", + "name": "industry_category", + "type": "str", + "description": "Category of industry in which the company operates.", + "default": null, + "optional": true + }, + { + "name": "industry_group", + "type": "str", + "description": "Group of industry in which the company operates.", + "default": null, + "optional": true + }, + { + "name": "template", + "type": "str", + "description": "Template used to standardize the company's financial statements.", + "default": null, + "optional": true + }, + { + "name": "standardized_active", "type": "bool", - "description": "Whether the owner is having a derivative transaction.", + "description": "Whether the company is active or not.", "default": null, "optional": true }, { - "name": "report_line_number", - "type": "int", - "description": "Report line number of the insider trading.", + "name": "first_fundamental_date", + "type": "date", + "description": "Date of the company's first fundamental.", "default": null, "optional": true - } - ] - }, - "model": "InsiderTrading" - }, - "/equity/ownership/share_statistics": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get data about share float for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.share_statistics(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", - "default": "", - "optional": false + "name": "last_fundamental_date", + "type": "date", + "description": "Date of the company's last fundamental.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'yfinance']", - "description": "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.", - "default": "fmp", + "name": "first_stock_price_date", + "type": "date", + "description": "Date of the company's first stock price.", + "default": null, + "optional": true + }, + { + "name": "last_stock_price_date", + "type": "date", + "description": "Date of the company's last stock price.", + "default": null, "optional": true } ], "fmp": [ { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "name": "is_etf", + "type": "bool", + "description": "If the symbol is an ETF.", "default": "", "optional": false - } - ], - "intrinio": [ + }, { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "name": "is_actively_trading", + "type": "bool", + "description": "If the company is actively trading.", "default": "", "optional": false - } - ], - "yfinance": [ + }, { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "name": "is_adr", + "type": "bool", + "description": "If the stock is an ADR.", "default": "", "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[ShareStatistics]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "is_fund", + "type": "bool", + "description": "If the company is a fund.", "default": "", "optional": false }, { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "image", + "type": "str", + "description": "Image of the company.", "default": null, "optional": true }, { - "name": "free_float", - "type": "float", - "description": "Percentage of unrestricted shares of a publicly-traded company.", + "name": "currency", + "type": "str", + "description": "Currency in which the stock is traded.", "default": null, "optional": true }, { - "name": "float_shares", - "type": "float", - "description": "Number of shares available for trading by the general public.", + "name": "market_cap", + "type": "int", + "description": "Market capitalization of the company.", "default": null, "optional": true }, { - "name": "outstanding_shares", + "name": "last_price", "type": "float", - "description": "Total number of shares of a publicly-traded company.", - "default": null, - "optional": true - }, - { - "name": "source", - "type": "str", - "description": "Source of the received data.", + "description": "The last traded price.", "default": null, "optional": true - } - ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false }, { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "year_high", + "type": "float", + "description": "The one-year high of the price.", "default": null, "optional": true }, { - "name": "free_float", + "name": "year_low", "type": "float", - "description": "Percentage of unrestricted shares of a publicly-traded company.", + "description": "The one-year low of the price.", "default": null, "optional": true }, { - "name": "float_shares", - "type": "float", - "description": "Number of shares available for trading by the general public.", + "name": "volume_avg", + "type": "int", + "description": "Average daily trading volume.", "default": null, "optional": true }, { - "name": "outstanding_shares", + "name": "annualized_dividend_amount", "type": "float", - "description": "Total number of shares of a publicly-traded company.", + "description": "The annualized dividend payment based on the most recent regular dividend payment.", "default": null, "optional": true }, { - "name": "source", - "type": "str", - "description": "Source of the received data.", + "name": "beta", + "type": "float", + "description": "Beta of the stock relative to the market.", "default": null, "optional": true } ], "intrinio": [ { - "name": "adjusted_outstanding_shares", - "type": "float", - "description": "Total number of shares of a publicly-traded company, adjusted for splits.", + "name": "id", + "type": "str", + "description": "Intrinio ID for the company.", "default": null, "optional": true }, { - "name": "public_float", - "type": "float", - "description": "Aggregate market value of the shares of a publicly-traded company.", + "name": "thea_enabled", + "type": "bool", + "description": "Whether the company has been enabled for Thea.", "default": null, "optional": true } ], "yfinance": [ { - "name": "implied_shares_outstanding", - "type": "int", - "description": "Implied Shares Outstanding of common equity, assuming the conversion of all convertible subsidiary equity into common.", + "name": "exchange_timezone", + "type": "str", + "description": "The timezone of the exchange.", "default": null, "optional": true }, { - "name": "short_interest", - "type": "int", - "description": "Number of shares that are reported short.", + "name": "issue_type", + "type": "str", + "description": "The issuance type of the asset.", "default": null, "optional": true }, { - "name": "short_percent_of_float", - "type": "float", - "description": "Percentage of shares that are reported short, as a normalized percent.", + "name": "currency", + "type": "str", + "description": "The currency in which the asset is traded.", "default": null, "optional": true }, { - "name": "days_to_cover", - "type": "float", - "description": "Number of days to repurchase the shares as a ratio of average daily volume", + "name": "market_cap", + "type": "int", + "description": "The market capitalization of the asset.", "default": null, "optional": true }, { - "name": "short_interest_prev_month", + "name": "shares_outstanding", "type": "int", - "description": "Number of shares that were reported short in the previous month.", + "description": "The number of listed shares outstanding.", "default": null, "optional": true }, { - "name": "short_interest_prev_date", - "type": "date", - "description": "Date of the previous month's report.", + "name": "shares_float", + "type": "int", + "description": "The number of shares in the public float.", "default": null, "optional": true }, { - "name": "insider_ownership", - "type": "float", - "description": "Percentage of shares held by insiders, as a normalized percent.", + "name": "shares_implied_outstanding", + "type": "int", + "description": "Implied shares outstanding of common equityassuming the conversion of all convertible subsidiary equity into common.", "default": null, "optional": true }, { - "name": "institution_ownership", - "type": "float", - "description": "Percentage of shares held by institutions, as a normalized percent.", + "name": "shares_short", + "type": "int", + "description": "The reported number of shares short.", "default": null, "optional": true }, { - "name": "institution_float_ownership", + "name": "dividend_yield", "type": "float", - "description": "Percentage of float held by institutions, as a normalized percent.", + "description": "The dividend yield of the asset, as a normalized percent.", "default": null, "optional": true }, { - "name": "institutions_count", - "type": "int", - "description": "Number of institutions holding shares.", + "name": "beta", + "type": "float", + "description": "The beta of the asset relative to the broad market.", "default": null, "optional": true } ] }, - "model": "ShareStatistics" + "model": "EquityInfo" }, - "/equity/ownership/form_13f": { + "/equity/market_snapshots": { "deprecated": { "flag": null, "message": null }, - "description": "Get the form 13F.\n\nThe Securities and Exchange Commission's (SEC) Form 13F is a quarterly report\nthat is required to be filed by all institutional investment managers with at least\n$100 million in assets under management.\nManagers are required to file Form 13F within 45 days after the last day of the calendar quarter.\nMost funds wait until the end of this period in order to conceal\ntheir investment strategy from competitors and the public.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.form_13f(symbol='NVDA', provider='sec')\n# Enter a date (calendar quarter ending) for a specific report.\nobb.equity.ownership.form_13f(symbol='BRK-A', date='2016-09-30', provider='sec')\n# Example finding Michael Burry's filings.\ncik = obb.regulators.sec.institutions_search(\"Scion Asset Management\").results[0].cik\n# Use the `limit` parameter to return N number of reports from the most recent.\nobb.equity.ownership.form_13f(cik, limit=2).to_df()\n```\n\n", + "description": "Get an updated equity market snapshot. This includes price data for thousands of stocks.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.market_snapshots(provider='fmp')\n```\n\n", "parameters": { "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for. A CIK or Symbol can be used.", - "default": "", - "optional": false - }, - { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported.", - "default": null, - "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter.", - "default": 1, - "optional": true - }, { "name": "provider", - "type": "Literal['sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", - "default": "sec", + "type": "Literal['fmp', 'intrinio', 'polygon']", + "description": "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.", + "default": "fmp", "optional": true } ], - "sec": [ + "fmp": [ { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for. A CIK or Symbol can be used.", - "default": "", - "optional": false - }, + "name": "market", + "type": "Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra']", + "description": "The market to fetch data for.", + "default": "nasdaq", + "optional": true + } + ], + "intrinio": [ { "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported.", + "type": "Union[Union[date, datetime, str], str]", + "description": "The date of the data. Can be a datetime or an ISO datetime string. Historical data appears to go back to mid-June 2022. Example: '2024-03-08T12:15:00+0400'", "default": null, "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter.", - "default": 1, - "optional": true } - ] + ], + "polygon": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[Form13FHR]", + "type": "List[MarketSnapshots]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['sec']]", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon']]", "description": "Provider name." }, { @@ -22034,749 +20496,594 @@ "data": { "standard": [ { - "name": "period_ending", - "type": "date", - "description": "The end-of-quarter date of the filing.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "issuer", - "type": "str", - "description": "The name of the issuer.", - "default": "", - "optional": false + "name": "open", + "type": "float", + "description": "The open price.", + "default": null, + "optional": true }, { - "name": "cusip", - "type": "str", - "description": "The CUSIP of the security.", - "default": "", - "optional": false - }, - { - "name": "asset_class", - "type": "str", - "description": "The title of the asset class for the security.", - "default": "", - "optional": false - }, - { - "name": "security_type", - "type": "Literal['SH', 'PRN']", - "description": "The total number of shares of the class of security or the principal amount of such class. 'SH' for shares. 'PRN' for principal amount. Convertible debt securities are reported as 'PRN'.", + "name": "high", + "type": "float", + "description": "The high price.", "default": null, "optional": true }, { - "name": "option_type", - "type": "Literal['call', 'put']", - "description": "Defined when the holdings being reported are put or call options. Only long positions are reported.", + "name": "low", + "type": "float", + "description": "The low price.", "default": null, "optional": true }, { - "name": "voting_authority_sole", - "type": "int", - "description": "The number of shares for which the Manager exercises sole voting authority (none).", + "name": "close", + "type": "float", + "description": "The close price.", "default": null, "optional": true }, { - "name": "voting_authority_shared", + "name": "volume", "type": "int", - "description": "The number of shares for which the Manager exercises a defined shared voting authority (none).", + "description": "The trading volume.", "default": null, "optional": true }, { - "name": "voting_authority_other", - "type": "int", - "description": "The number of shares for which the Manager exercises other shared voting authority (none).", + "name": "prev_close", + "type": "float", + "description": "The previous close price.", "default": null, "optional": true }, { - "name": "principal_amount", - "type": "int", - "description": "The total number of shares of the class of security or the principal amount of such class. Only long positions are reported", - "default": "", - "optional": false - }, - { - "name": "value", - "type": "int", - "description": "The fair market value of the holding of the particular class of security. The value reported for options is the fair market value of the underlying security with respect to the number of shares controlled. Values are rounded to the nearest US dollar and use the closing price of the last trading day of the calendar year or quarter.", - "default": "", - "optional": false - } - ], - "sec": [ - { - "name": "weight", + "name": "change", "type": "float", - "description": "The weight of the security relative to the market value of all securities in the filing , as a normalized percent.", - "default": "", - "optional": false - } - ] - }, - "model": "Form13FHR" - }, - "/equity/price/quote": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the latest quote for a given stock. Quote includes price, volume, and other data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.quote(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", - "default": "", - "optional": false + "description": "The change in price from the previous close.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'yfinance']", - "description": "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.", - "default": "fmp", + "name": "change_percent", + "type": "float", + "description": "The change in price from the previous close, as a normalized percent.", + "default": null, "optional": true } ], "fmp": [ { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - } - ], - "intrinio": [ - { - "name": "symbol", - "type": "str", - "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", - "default": "", - "optional": false - }, - { - "name": "source", - "type": "Literal['iex', 'bats', 'bats_delayed', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed', 'intrinio_mx', 'intrinio_mx_plus', 'delayed_sip']", - "description": "Source of the data.", - "default": "iex", + "name": "last_price", + "type": "float", + "description": "The last price of the stock.", + "default": null, "optional": true - } - ], - "yfinance": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EquityQuote]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "last_price_timestamp", + "type": "Union[date, datetime]", + "description": "The timestamp of the last price.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "ma50", + "type": "float", + "description": "The 50-day moving average.", + "default": null, + "optional": true }, { - "name": "asset_type", - "type": "str", - "description": "Type of asset - i.e, stock, ETF, etc.", + "name": "ma200", + "type": "float", + "description": "The 200-day moving average.", "default": null, "optional": true }, { - "name": "name", - "type": "str", - "description": "Name of the company or asset.", + "name": "year_high", + "type": "float", + "description": "The 52-week high.", "default": null, "optional": true }, { - "name": "exchange", - "type": "str", - "description": "The name or symbol of the venue where the data is from.", + "name": "year_low", + "type": "float", + "description": "The 52-week low.", "default": null, "optional": true }, { - "name": "bid", - "type": "float", - "description": "Price of the top bid order.", + "name": "volume_avg", + "type": "int", + "description": "Average daily trading volume.", "default": null, "optional": true }, { - "name": "bid_size", + "name": "market_cap", "type": "int", - "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", + "description": "Market cap of the stock.", "default": null, "optional": true }, { - "name": "bid_exchange", - "type": "str", - "description": "The specific trading venue where the purchase order was placed.", + "name": "eps", + "type": "float", + "description": "Earnings per share.", "default": null, "optional": true }, { - "name": "ask", + "name": "pe", "type": "float", - "description": "Price of the top ask order.", + "description": "Price to earnings ratio.", "default": null, "optional": true }, { - "name": "ask_size", + "name": "shares_outstanding", "type": "int", - "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", + "description": "Number of shares outstanding.", "default": null, "optional": true }, { - "name": "ask_exchange", + "name": "name", "type": "str", - "description": "The specific trading venue where the sale order was placed.", + "description": "The company name associated with the symbol.", "default": null, "optional": true }, { - "name": "quote_conditions", - "type": "Union[str, int, List[str], List[int]]", - "description": "Conditions or condition codes applicable to the quote.", + "name": "exchange", + "type": "str", + "description": "The exchange of the stock.", "default": null, "optional": true }, { - "name": "quote_indicators", - "type": "Union[str, int, List[str], List[int]]", - "description": "Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO.", + "name": "earnings_date", + "type": "Union[date, datetime]", + "description": "The upcoming earnings announcement date.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "sales_conditions", - "type": "Union[str, int, List[str], List[int]]", - "description": "Conditions or condition codes applicable to the sale.", + "name": "last_price", + "type": "float", + "description": "The last trade price.", "default": null, "optional": true }, { - "name": "sequence_number", + "name": "last_size", "type": "int", - "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11).", + "description": "The last trade size.", "default": null, "optional": true }, { - "name": "market_center", - "type": "str", - "description": "The ID of the UTP participant that originated the message.", + "name": "last_volume", + "type": "int", + "description": "The last trade volume.", "default": null, "optional": true }, { - "name": "participant_timestamp", + "name": "last_trade_timestamp", "type": "datetime", - "description": "Timestamp for when the quote was generated by the exchange.", + "description": "The timestamp of the last trade.", "default": null, "optional": true }, { - "name": "trf_timestamp", - "type": "datetime", - "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message.", - "default": null, - "optional": true - }, - { - "name": "sip_timestamp", - "type": "datetime", - "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange.", + "name": "bid_size", + "type": "int", + "description": "The size of the last bid price. Bid price and size is not always available.", "default": null, "optional": true }, { - "name": "last_price", + "name": "bid_price", "type": "float", - "description": "Price of the last trade.", + "description": "The last bid price. Bid price and size is not always available.", "default": null, "optional": true }, { - "name": "last_tick", - "type": "str", - "description": "Whether the last sale was an up or down tick.", + "name": "ask_price", + "type": "float", + "description": "The last ask price. Ask price and size is not always available.", "default": null, "optional": true }, { - "name": "last_size", + "name": "ask_size", "type": "int", - "description": "Size of the last trade.", + "description": "The size of the last ask price. Ask price and size is not always available.", "default": null, "optional": true }, { - "name": "last_timestamp", + "name": "last_bid_timestamp", "type": "datetime", - "description": "Date and Time when the last price was recorded.", + "description": "The timestamp of the last bid price. Bid price and size is not always available.", "default": null, "optional": true }, { - "name": "open", - "type": "float", - "description": "The open price.", + "name": "last_ask_timestamp", + "type": "datetime", + "description": "The timestamp of the last ask price. Ask price and size is not always available.", "default": null, "optional": true - }, + } + ], + "polygon": [ { - "name": "high", + "name": "vwap", "type": "float", - "description": "The high price.", + "description": "The volume weighted average price of the stock on the current trading day.", "default": null, "optional": true }, { - "name": "low", + "name": "prev_open", "type": "float", - "description": "The low price.", + "description": "The previous trading session opening price.", "default": null, "optional": true }, { - "name": "close", + "name": "prev_high", "type": "float", - "description": "The close price.", + "description": "The previous trading session high price.", "default": null, "optional": true }, { - "name": "volume", - "type": "Union[int, float]", - "description": "The trading volume.", + "name": "prev_low", + "type": "float", + "description": "The previous trading session low price.", "default": null, "optional": true }, { - "name": "exchange_volume", - "type": "Union[int, float]", - "description": "Volume of shares exchanged during the trading day on the specific exchange.", + "name": "prev_volume", + "type": "float", + "description": "The previous trading session volume.", "default": null, "optional": true }, { - "name": "prev_close", + "name": "prev_vwap", "type": "float", - "description": "The previous close price.", + "description": "The previous trading session VWAP.", "default": null, "optional": true }, { - "name": "change", + "name": "last_updated", + "type": "datetime", + "description": "The last time the data was updated.", + "default": "", + "optional": false + }, + { + "name": "bid", "type": "float", - "description": "Change in price from previous close.", + "description": "The current bid price.", "default": null, "optional": true }, { - "name": "change_percent", - "type": "float", - "description": "Change in price as a normalized percentage.", + "name": "bid_size", + "type": "int", + "description": "The current bid size.", "default": null, "optional": true }, { - "name": "year_high", - "type": "float", - "description": "The one year high (52W High).", + "name": "ask_size", + "type": "int", + "description": "The current ask size.", "default": null, "optional": true }, { - "name": "year_low", + "name": "ask", "type": "float", - "description": "The one year low (52W Low).", + "description": "The current ask price.", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "price_avg50", - "type": "float", - "description": "50 day moving average price.", + "name": "quote_timestamp", + "type": "datetime", + "description": "The timestamp of the last quote.", "default": null, "optional": true }, { - "name": "price_avg200", + "name": "last_trade_price", "type": "float", - "description": "200 day moving average price.", + "description": "The last trade price.", "default": null, "optional": true }, { - "name": "avg_volume", + "name": "last_trade_size", "type": "int", - "description": "Average volume over the last 10 trading days.", + "description": "The last trade size.", "default": null, "optional": true }, { - "name": "market_cap", - "type": "float", - "description": "Market cap of the company.", + "name": "last_trade_conditions", + "type": "List[int]", + "description": "The last trade condition codes.", "default": null, "optional": true }, { - "name": "shares_outstanding", + "name": "last_trade_exchange", "type": "int", - "description": "Number of shares outstanding.", + "description": "The last trade exchange ID code.", "default": null, "optional": true }, { - "name": "eps", - "type": "float", - "description": "Earnings per share.", + "name": "last_trade_timestamp", + "type": "datetime", + "description": "The last trade timestamp.", "default": null, "optional": true + } + ] + }, + "model": "MarketSnapshots" + }, + "/etf/search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search for ETFs.\n\nAn empty query returns the full list of ETFs from the provider.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# An empty query returns the full list of ETFs from the provider.\nobb.etf.search(provider='fmp')\n# The query will return results from text-based fields containing the term.\nobb.etf.search(query='commercial real estate', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", + "optional": true }, { - "name": "pe", - "type": "float", - "description": "Price earnings ratio.", + "name": "provider", + "type": "Literal['fmp', 'intrinio']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "exchange", + "type": "Literal['AMEX', 'NYSE', 'NASDAQ', 'ETF', 'TSX', 'EURONEXT']", + "description": "The exchange code the ETF trades on.", "default": null, "optional": true }, { - "name": "earnings_announcement", - "type": "datetime", - "description": "Upcoming earnings announcement date.", + "name": "is_active", + "type": "Literal[True, False]", + "description": "Whether the ETF is actively trading.", "default": null, "optional": true } ], "intrinio": [ { - "name": "is_darkpool", - "type": "bool", - "description": "Whether or not the current trade is from a darkpool.", + "name": "exchange", + "type": "Literal['xnas', 'arcx', 'bats', 'xnys', 'bvmf', 'xshg', 'xshe', 'xhkg', 'xbom', 'xnse', 'xidx', 'tase', 'xkrx', 'xkls', 'xmex', 'xses', 'roco', 'xtai', 'xbkk', 'xist']", + "description": "Target a specific exchange by providing the MIC code.", "default": null, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfSearch]", + "description": "Serializable results." }, { - "name": "source", - "type": "str", - "description": "Source of the Intrinio data.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio']]", + "description": "Provider name." }, { - "name": "updated_on", - "type": "datetime", - "description": "Date and Time when the data was last updated.", + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.(ETF)", "default": "", "optional": false }, { - "name": "security", - "type": "IntrinioSecurity", - "description": "Security details related to the quote.", + "name": "name", + "type": "str", + "description": "Name of the ETF.", "default": null, "optional": true } ], - "yfinance": [ + "fmp": [ { - "name": "ma_50d", + "name": "market_cap", "type": "float", - "description": "50-day moving average price.", + "description": "The market cap of the ETF.", "default": null, "optional": true }, { - "name": "ma_200d", - "type": "float", - "description": "200-day moving average price.", + "name": "sector", + "type": "str", + "description": "The sector of the ETF.", "default": null, "optional": true }, { - "name": "volume_average", + "name": "industry", + "type": "str", + "description": "The industry of the ETF.", + "default": null, + "optional": true + }, + { + "name": "beta", "type": "float", - "description": "Average daily trading volume.", + "description": "The beta of the ETF.", "default": null, "optional": true }, { - "name": "volume_average_10d", + "name": "price", "type": "float", - "description": "Average daily trading volume in the last 10 days.", + "description": "The current price of the ETF.", "default": null, "optional": true }, { - "name": "currency", - "type": "str", - "description": "Currency of the price.", + "name": "last_annual_dividend", + "type": "float", + "description": "The last annual dividend paid.", "default": null, "optional": true - } - ] - }, - "model": "EquityQuote" - }, - "/equity/price/nbbo": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the National Best Bid and Offer for a given stock.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.nbbo(symbol='AAPL', provider='polygon')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['polygon']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'polygon' if there is no default.", - "default": "polygon", - "optional": true - } - ], - "polygon": [ - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. Up to ten million records will be returned. Pagination occurs in groups of 50,000. Remaining limit values will always return 50,000 more records unless it is the last page. High volume tickers will require multiple max requests for a single day's NBBO records. Expect stocks, like SPY, to approach 1GB in size, per day, as a raw CSV. Splitting large requests into chunks is recommended for full-day requests of high-volume symbols.", - "default": 50000, - "optional": true }, { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for. Use bracketed the timestamp parameters to specify exact time ranges.", + "name": "volume", + "type": "float", + "description": "The current trading volume of the ETF.", "default": null, "optional": true }, { - "name": "timestamp_lt", - "type": "Union[datetime, str]", - "description": "Query by datetime, less than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", + "name": "exchange", + "type": "str", + "description": "The exchange code the ETF trades on.", "default": null, "optional": true }, { - "name": "timestamp_gt", - "type": "Union[datetime, str]", - "description": "Query by datetime, greater than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", + "name": "exchange_name", + "type": "str", + "description": "The full name of the exchange the ETF trades on.", "default": null, "optional": true }, { - "name": "timestamp_lte", - "type": "Union[datetime, str]", - "description": "Query by datetime, less than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", + "name": "country", + "type": "str", + "description": "The country the ETF is registered in.", "default": null, "optional": true }, { - "name": "timestamp_gte", - "type": "Union[datetime, str]", - "description": "Query by datetime, greater than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", + "name": "actively_trading", + "type": "Literal[True, False]", + "description": "Whether the ETF is actively trading.", "default": null, "optional": true } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EquityNBBO]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['polygon']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "ask_exchange", - "type": "str", - "description": "The exchange ID for the ask.", - "default": "", - "optional": false - }, - { - "name": "ask", - "type": "float", - "description": "The last ask price.", - "default": "", - "optional": false - }, - { - "name": "ask_size", - "type": "int", - "description": "The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price.", - "default": "", - "optional": false - }, - { - "name": "bid_size", - "type": "int", - "description": "The bid size in round lots.", - "default": "", - "optional": false - }, - { - "name": "bid", - "type": "float", - "description": "The last bid price.", - "default": "", - "optional": false - }, - { - "name": "bid_exchange", - "type": "str", - "description": "The exchange ID for the bid.", - "default": "", - "optional": false - } ], - "polygon": [ + "intrinio": [ { - "name": "tape", + "name": "exchange", "type": "str", - "description": "The exchange tape.", - "default": null, - "optional": true - }, - { - "name": "conditions", - "type": "Union[str, List[int], List[str]]", - "description": "A list of condition codes.", + "description": "The exchange MIC code.", "default": null, "optional": true }, { - "name": "indicators", - "type": "List[int]", - "description": "A list of indicator codes.", + "name": "figi_ticker", + "type": "str", + "description": "The OpenFIGI ticker.", "default": null, "optional": true }, { - "name": "sequence_num", - "type": "int", - "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11)", + "name": "ric", + "type": "str", + "description": "The Reuters Instrument Code.", "default": null, "optional": true }, { - "name": "participant_timestamp", - "type": "datetime", - "description": "The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.", + "name": "isin", + "type": "str", + "description": "The International Securities Identification Number.", "default": null, "optional": true }, { - "name": "sip_timestamp", - "type": "datetime", - "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it.", + "name": "sedol", + "type": "str", + "description": "The Stock Exchange Daily Official List.", "default": null, "optional": true }, { - "name": "trf_timestamp", - "type": "datetime", - "description": "The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this quote.", + "name": "intrinio_id", + "type": "str", + "description": "The unique Intrinio ID for the security.", "default": null, "optional": true } ] }, - "model": "EquityNBBO" + "model": "EtfSearch" }, - "/equity/price/historical": { + "/etf/historical": { "deprecated": { "flag": null, "message": null }, - "description": "Get historical price data for a given stock. This includes open, high, low, close, and volume.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.historical(symbol='AAPL', provider='fmp')\nobb.equity.price.historical(symbol='AAPL', interval='1d', provider='intrinio')\n```\n\n", + "description": "ETF Historical Market Price.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.historical(symbol='SPY', provider='fmp')\nobb.etf.historical(symbol='SPY', provider='yfinance')\n# This function accepts multiple tickers.\nobb.etf.historical(symbol='SPY,IWM,QQQ,DJIA', provider='yfinance')\n```\n\n", "parameters": { "standard": [ { @@ -22963,7 +21270,7 @@ "OBBject": [ { "name": "results", - "type": "List[EquityHistorical]", + "type": "List[EtfHistorical]", "description": "Serializable results." }, { @@ -23261,52 +21568,46 @@ } ] }, - "model": "EquityHistorical" + "model": "EtfHistorical" }, - "/equity/price/performance": { + "/etf/info": { "deprecated": { "flag": null, "message": null }, - "description": "Get price performance data for a given stock. This includes price changes for different time periods.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.performance(symbol='AAPL', provider='fmp')\n```\n\n", + "description": "ETF Information Overview.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.info(symbol='SPY', provider='fmp')\n# This function accepts multiple tickers.\nobb.etf.info(symbol='SPY,IWM,QQQ,DJIA', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": "", "optional": false }, { "name": "provider", - "type": "Literal['fmp']", + "type": "Literal['fmp', 'intrinio', 'yfinance']", "description": "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.", "default": "fmp", "optional": true } ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - } - ] + "fmp": [], + "intrinio": [], + "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[PricePerformance]", + "type": "List[EtfInfo]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", "description": "Provider name." }, { @@ -23331,4186 +21632,1323 @@ { "name": "symbol", "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": null, - "optional": true + "description": "Symbol representing the entity requested in the data. (ETF)", + "default": "", + "optional": false }, { - "name": "one_day", - "type": "float", - "description": "One-day return.", + "name": "name", + "type": "str", + "description": "Name of the ETF.", + "default": "", + "optional": false + }, + { + "name": "description", + "type": "str", + "description": "Description of the fund.", "default": null, "optional": true }, { - "name": "wtd", - "type": "float", - "description": "Week to date return.", + "name": "inception_date", + "type": "str", + "description": "Inception date of the ETF.", + "default": "", + "optional": false + } + ], + "fmp": [ + { + "name": "issuer", + "type": "str", + "description": "Company of the ETF.", "default": null, "optional": true }, { - "name": "one_week", - "type": "float", - "description": "One-week return.", + "name": "cusip", + "type": "str", + "description": "CUSIP of the ETF.", "default": null, "optional": true }, { - "name": "mtd", - "type": "float", - "description": "Month to date return.", + "name": "isin", + "type": "str", + "description": "ISIN of the ETF.", "default": null, "optional": true }, { - "name": "one_month", - "type": "float", - "description": "One-month return.", + "name": "domicile", + "type": "str", + "description": "Domicile of the ETF.", "default": null, "optional": true }, { - "name": "qtd", - "type": "float", - "description": "Quarter to date return.", + "name": "asset_class", + "type": "str", + "description": "Asset class of the ETF.", "default": null, "optional": true }, { - "name": "three_month", + "name": "aum", "type": "float", - "description": "Three-month return.", + "description": "Assets under management.", "default": null, "optional": true }, { - "name": "six_month", + "name": "nav", "type": "float", - "description": "Six-month return.", + "description": "Net asset value of the ETF.", "default": null, "optional": true }, { - "name": "ytd", - "type": "float", - "description": "Year to date return.", + "name": "nav_currency", + "type": "str", + "description": "Currency of the ETF's net asset value.", "default": null, "optional": true }, { - "name": "one_year", + "name": "expense_ratio", "type": "float", - "description": "One-year return.", + "description": "The expense ratio, as a normalized percent.", "default": null, "optional": true }, { - "name": "two_year", - "type": "float", - "description": "Two-year return.", + "name": "holdings_count", + "type": "int", + "description": "Number of holdings.", "default": null, "optional": true }, { - "name": "three_year", + "name": "avg_volume", "type": "float", - "description": "Three-year return.", + "description": "Average daily trading volume.", "default": null, "optional": true }, { - "name": "four_year", - "type": "float", - "description": "Four-year", + "name": "website", + "type": "str", + "description": "Website of the issuer.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "five_year", - "type": "float", - "description": "Five-year return.", + "name": "fund_listing_date", + "type": "date", + "description": "The date on which the Exchange Traded Product (ETP) or share class of the ETP is listed on a specific exchange.", "default": null, "optional": true }, { - "name": "ten_year", - "type": "float", - "description": "Ten-year return.", + "name": "data_change_date", + "type": "date", + "description": "The last date on which there was a change in a classifications data field for this ETF.", "default": null, "optional": true }, { - "name": "max", - "type": "float", - "description": "Return from the beginning of the time series.", + "name": "etn_maturity_date", + "type": "date", + "description": "If the product is an ETN, this field identifies the maturity date for the ETN.", "default": null, "optional": true - } - ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "The ticker symbol.", - "default": "", - "optional": false - } - ] - }, - "model": "PricePerformance" - }, - "/equity/shorts/fails_to_deliver": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get reported Fail-to-deliver (FTD) data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.shorts.fails_to_deliver(symbol='AAPL', provider='sec')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "provider", - "type": "Literal['sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", - "default": "sec", + "name": "is_listed", + "type": "bool", + "description": "If true, the ETF is still listed on an exchange.", + "default": null, "optional": true - } - ], - "sec": [ + }, { - "name": "limit", - "type": "int", - "description": "Limit the number of reports to parse, from most recent. Approximately 24 reports per year, going back to 2009.", - "default": 24, + "name": "close_date", + "type": "date", + "description": "The date on which the ETF was de-listed if it is no longer listed.", + "default": null, "optional": true }, { - "name": "skip_reports", - "type": "int", - "description": "Skip N number of reports from current. A value of 1 will skip the most recent report.", - "default": 0, + "name": "exchange", + "type": "str", + "description": "The exchange Market Identifier Code (MIC).", + "default": null, "optional": true }, { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache for the request, default is True. Each reporting period is a separate URL, new reports will be added to the cache.", - "default": true, + "name": "isin", + "type": "str", + "description": "International Securities Identification Number (ISIN).", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EquityFTD]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['sec']]", - "description": "Provider name." + "name": "ric", + "type": "str", + "description": "Reuters Instrument Code (RIC).", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "sedol", + "type": "str", + "description": "Stock Exchange Daily Official List (SEDOL).", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "figi_symbol", + "type": "str", + "description": "Financial Instrument Global Identifier (FIGI) symbol.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "share_class_figi", + "type": "str", + "description": "Financial Instrument Global Identifier (FIGI).", + "default": null, + "optional": true + }, { - "name": "settlement_date", - "type": "date", - "description": "The settlement date of the fail.", + "name": "firstbridge_id", + "type": "str", + "description": "The FirstBridge unique identifier for the Exchange Traded Fund (ETF).", "default": null, "optional": true }, { - "name": "symbol", + "name": "firstbridge_parent_id", "type": "str", - "description": "Symbol representing the entity requested in the data.", + "description": "The FirstBridge unique identifier for the parent Exchange Traded Fund (ETF), if applicable.", "default": null, "optional": true }, { - "name": "cusip", + "name": "intrinio_id", "type": "str", - "description": "CUSIP of the Security.", + "description": "Intrinio unique identifier for the security.", "default": null, "optional": true }, { - "name": "quantity", - "type": "int", - "description": "The number of fails on that settlement date.", + "name": "intraday_nav_symbol", + "type": "str", + "description": "Intraday Net Asset Value (NAV) symbol.", "default": null, "optional": true }, { - "name": "price", - "type": "float", - "description": "The price at the previous closing price from the settlement date.", + "name": "primary_symbol", + "type": "str", + "description": "The primary ticker field is used for Exchange Traded Products (ETPs) that have multiple listings and share classes. If an ETP has multiple listings or share classes, the same primary ticker is assigned to all the listings and share classes.", "default": null, "optional": true }, { - "name": "description", + "name": "etp_structure_type", "type": "str", - "description": "The description of the Security.", + "description": "Classifies Exchange Traded Products (ETPs) into very broad categories based on its legal structure.", "default": null, "optional": true - } - ], - "sec": [ + }, { - "name": "settlement_date", - "type": "date", - "description": "The settlement date of the fail.", + "name": "legal_structure", + "type": "str", + "description": "Legal structure of the fund.", "default": null, "optional": true }, { - "name": "symbol", + "name": "issuer", "type": "str", - "description": "Symbol representing the entity requested in the data.", + "description": "Issuer of the ETF.", "default": null, "optional": true }, { - "name": "cusip", + "name": "etn_issuing_bank", "type": "str", - "description": "CUSIP of the Security.", + "description": "If the product is an Exchange Traded Note (ETN), this field identifies the issuing bank.", "default": null, "optional": true }, { - "name": "quantity", - "type": "int", - "description": "The number of fails on that settlement date.", + "name": "fund_family", + "type": "str", + "description": "This field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor.", "default": null, "optional": true }, { - "name": "price", - "type": "float", - "description": "The price at the previous closing price from the settlement date.", + "name": "investment_style", + "type": "str", + "description": "Investment style of the ETF.", "default": null, "optional": true }, { - "name": "description", + "name": "derivatives_based", "type": "str", - "description": "The description of the Security.", + "description": "This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio.", "default": null, "optional": true - } - ] - }, - "model": "EquityFTD" - }, - "/equity/search": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Search for stock symbol, CIK, LEI, or company name.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.search(provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "query", + "name": "income_category", "type": "str", - "description": "Search query.", - "default": "", + "description": "Identifies if an Exchange Traded Fund (ETF) falls into a category that is specifically designed to provide a high yield or income", + "default": null, "optional": true }, { - "name": "is_symbol", - "type": "bool", - "description": "Whether to search by ticker symbol.", - "default": false, + "name": "asset_class", + "type": "str", + "description": "Captures the underlying nature of the securities in the Exchanged Traded Product (ETP).", + "default": null, "optional": true }, { - "name": "use_cache", - "type": "bool", - "description": "Whether to use the cache or not.", - "default": true, + "name": "other_asset_types", + "type": "str", + "description": "If 'asset_class' field is classified as 'Other Asset Types' this field captures the specific category of the underlying assets.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['intrinio', 'sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", - "optional": true - } - ], - "intrinio": [ - { - "name": "active", - "type": "bool", - "description": "When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded.", - "default": true, + "name": "single_category_designation", + "type": "str", + "description": "This categorization is created for those users who want every ETF to be 'forced' into a single bucket, so that the assets for all categories will always sum to the total market.", + "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 10000, - "optional": true - } - ], - "sec": [ - { - "name": "is_fund", - "type": "bool", - "description": "Whether to direct the search to the list of mutual funds and ETFs.", - "default": false, + "name": "beta_type", + "type": "str", + "description": "This field identifies whether an ETF provides 'Traditional' beta exposure or 'Smart' beta exposure. ETFs that are active (i.e. non-indexed), leveraged / inverse or have a proprietary quant model (i.e. that don't provide indexed exposure to a targeted factor) are classified separately.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EquitySearch]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['intrinio', 'sec']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", + "name": "beta_details", "type": "str", - "description": "Symbol representing the entity requested in the data.", + "description": "This field provides further detail within the traditional and smart beta categories.", "default": null, "optional": true }, { - "name": "name", + "name": "market_cap_range", "type": "str", - "description": "Name of the company.", + "description": "Equity ETFs are classified as falling into categories based on the description of their investment strategy in the prospectus. Examples ('Mega Cap', 'Large Cap', 'Mid Cap', etc.)", "default": null, "optional": true - } - ], - "intrinio": [ - { - "name": "cik", - "type": "str", - "description": "", - "default": "", - "optional": false }, { - "name": "lei", + "name": "market_cap_weighting_type", "type": "str", - "description": "The Legal Entity Identifier (LEI) of the company.", - "default": "", - "optional": false + "description": "For ETFs that take the value 'Market Cap Weighted' in the 'index_weighting_scheme' field, this field provides detail on the market cap weighting type.", + "default": null, + "optional": true }, { - "name": "intrinio_id", - "type": "str", - "description": "The Intrinio ID of the company.", - "default": "", - "optional": false - } - ], - "sec": [ - { - "name": "cik", + "name": "index_weighting_scheme", "type": "str", - "description": "Central Index Key", - "default": "", - "optional": false - } - ] - }, - "model": "EquitySearch" - }, - "/equity/screener": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Screen for companies meeting various criteria.\n\nThese criteria include market cap, price, beta, volume, and dividend yield.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.screener(provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", + "description": "For ETFs that track an underlying index, this field provides detail on the index weighting type.", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "mktcap_min", - "type": "int", - "description": "Filter by market cap greater than this value.", + "name": "index_linked", + "type": "str", + "description": "This field identifies whether an ETF is index linked or active.", "default": null, "optional": true }, { - "name": "mktcap_max", - "type": "int", - "description": "Filter by market cap less than this value.", + "name": "index_name", + "type": "str", + "description": "This field identifies the name of the underlying index tracked by the ETF, if applicable.", "default": null, "optional": true }, { - "name": "price_min", - "type": "float", - "description": "Filter by price greater than this value.", + "name": "index_symbol", + "type": "str", + "description": "This field identifies the OpenFIGI ticker for the Index underlying the ETF.", "default": null, "optional": true }, { - "name": "price_max", - "type": "float", - "description": "Filter by price less than this value.", + "name": "parent_index", + "type": "str", + "description": "This field identifies the name of the parent index, which represents the broader universe from which the index underlying the ETF is created, if applicable.", "default": null, "optional": true }, { - "name": "beta_min", - "type": "float", - "description": "Filter by a beta greater than this value.", + "name": "index_family", + "type": "str", + "description": "This field identifies the index family to which the index underlying the ETF belongs. The index family is represented as categorized by the index provider.", "default": null, "optional": true }, { - "name": "beta_max", - "type": "float", - "description": "Filter by a beta less than this value.", + "name": "broader_index_family", + "type": "str", + "description": "This field identifies the broader index family to which the index underlying the ETF belongs. The broader index family is represented as categorized by the index provider.", "default": null, "optional": true }, { - "name": "volume_min", - "type": "int", - "description": "Filter by volume greater than this value.", + "name": "index_provider", + "type": "str", + "description": "This field identifies the Index provider for the index underlying the ETF, if applicable.", "default": null, "optional": true }, { - "name": "volume_max", - "type": "int", - "description": "Filter by volume less than this value.", + "name": "index_provider_code", + "type": "str", + "description": "This field provides the First Bridge code for each Index provider, corresponding to the index underlying the ETF if applicable.", "default": null, "optional": true }, { - "name": "dividend_min", - "type": "float", - "description": "Filter by dividend amount greater than this value.", + "name": "replication_structure", + "type": "str", + "description": "The replication structure of the Exchange Traded Product (ETP).", "default": null, "optional": true }, { - "name": "dividend_max", - "type": "float", - "description": "Filter by dividend amount less than this value.", + "name": "growth_value_tilt", + "type": "str", + "description": "Classifies equity ETFs as either 'Growth' or Value' based on the stated style tilt in the ETF prospectus. Equity ETFs that do not have a stated style tilt are classified as 'Core / Blend'.", "default": null, "optional": true }, { - "name": "is_etf", - "type": "bool", - "description": "If true, returns only ETFs.", - "default": false, + "name": "growth_type", + "type": "str", + "description": "For ETFs that are classified as 'Growth' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their growth (style factor) scores.", + "default": null, "optional": true }, { - "name": "is_active", - "type": "bool", - "description": "If false, returns only inactive tickers.", - "default": true, + "name": "value_type", + "type": "str", + "description": "For ETFs that are classified as 'Value' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their value (style factor) scores.", + "default": null, "optional": true }, { "name": "sector", - "type": "Literal['Consumer Cyclical', 'Energy', 'Technology', 'Industrials', 'Financial Services', 'Basic Materials', 'Communication Services', 'Consumer Defensive', 'Healthcare', 'Real Estate', 'Utilities', 'Industrial Goods', 'Financial', 'Services', 'Conglomerates']", - "description": "Filter by sector.", + "type": "str", + "description": "For equity ETFs that aim to provide targeted exposure to a sector or industry, this field identifies the Sector that it provides the exposure to.", "default": null, "optional": true }, { "name": "industry", "type": "str", - "description": "Filter by industry.", + "description": "For equity ETFs that aim to provide targeted exposure to an industry, this field identifies the Industry that it provides the exposure to.", "default": null, "optional": true }, { - "name": "country", + "name": "industry_group", "type": "str", - "description": "Filter by country, as a two-letter country code.", + "description": "For equity ETFs that aim to provide targeted exposure to a sub-industry, this field identifies the sub-Industry that it provides the exposure to.", "default": null, "optional": true }, { - "name": "exchange", - "type": "Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra']", - "description": "Filter by exchange.", - "default": null, - "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "Limit the number of results to return.", - "default": 50000, + "name": "cross_sector_theme", + "type": "str", + "description": "For equity ETFs that aim to provide targeted exposure to a specific investment theme that cuts across GICS sectors, this field identifies the specific cross-sector theme. Examples ('Agri-business', 'Natural Resources', 'Green Investing', etc.)", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EquityScreener]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", + "name": "natural_resources_type", "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "description": "For ETFs that are classified as 'Natural Resources' in the 'cross_sector_theme' field, this field provides further detail on the type of Natural Resources exposure.", + "default": null, + "optional": true }, { - "name": "name", + "name": "us_or_excludes_us", "type": "str", - "description": "Name of the company.", - "default": "", - "optional": false - } - ], - "fmp": [ - { - "name": "market_cap", - "type": "int", - "description": "The market cap of ticker.", + "description": "Takes the value of 'Domestic' for US exposure, 'International' for non-US exposure and 'Global' for exposure that includes all regions including the US.", "default": null, "optional": true }, { - "name": "sector", + "name": "developed_emerging", "type": "str", - "description": "The sector the ticker belongs to.", + "description": "This field identifies the stage of development of the markets that the ETF provides exposure to.", "default": null, "optional": true }, { - "name": "industry", + "name": "specialized_region", "type": "str", - "description": "The industry ticker belongs to.", + "description": "This field is populated if the ETF provides targeted exposure to a specific type of geography-based grouping that does not fall into a specific country or continent grouping. Examples ('BRIC', 'Chindia', etc.)", "default": null, "optional": true }, { - "name": "beta", - "type": "float", - "description": "The beta of the ETF.", + "name": "continent", + "type": "str", + "description": "This field is populated if the ETF provides targeted exposure to a specific continent or country within that Continent.", "default": null, "optional": true }, { - "name": "price", - "type": "float", - "description": "The current price.", + "name": "latin_america_sub_group", + "type": "str", + "description": "For ETFs that are classified as 'Latin America' in the 'continent' field, this field provides further detail on the type of regional exposure.", "default": null, "optional": true }, { - "name": "last_annual_dividend", - "type": "float", - "description": "The last annual amount dividend paid.", + "name": "europe_sub_group", + "type": "str", + "description": "For ETFs that are classified as 'Europe' in the 'continent' field, this field provides further detail on the type of regional exposure.", "default": null, "optional": true }, { - "name": "volume", - "type": "int", - "description": "The current trading volume.", + "name": "asia_sub_group", + "type": "str", + "description": "For ETFs that are classified as 'Asia' in the 'continent' field, this field provides further detail on the type of regional exposure.", "default": null, "optional": true }, { - "name": "exchange", + "name": "specific_country", "type": "str", - "description": "The exchange code the asset trades on.", + "description": "This field is populated if the ETF provides targeted exposure to a specific country.", "default": null, "optional": true }, { - "name": "exchange_name", + "name": "china_listing_location", "type": "str", - "description": "The full name of the primary exchange.", + "description": "For ETFs that are classified as 'China' in the 'country' field, this field provides further detail on the type of exposure in the underlying securities.", "default": null, "optional": true }, { - "name": "country", + "name": "us_state", "type": "str", - "description": "The two-letter country abbreviation where the head office is located.", + "description": "Takes the value of a US state if the ETF provides targeted exposure to the municipal bonds or equities of companies.", "default": null, "optional": true }, { - "name": "is_etf", - "type": "Literal[True, False]", - "description": "Whether the ticker is an ETF.", + "name": "real_estate", + "type": "str", + "description": "For ETFs that provide targeted real estate exposure, this field is populated if the ETF provides targeted exposure to a specific segment of the real estate market.", "default": null, "optional": true }, { - "name": "actively_trading", - "type": "Literal[True, False]", - "description": "Whether the ETF is actively trading.", + "name": "fundamental_weighting_type", + "type": "str", + "description": "For ETFs that take the value 'Fundamental Weighted' in the 'index_weighting_scheme' field, this field provides detail on the fundamental weighting methodology.", "default": null, "optional": true - } - ] - }, - "model": "EquityScreener" - }, - "/equity/profile": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get general information about a company. This includes company name, industry, sector and price data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.profile(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", - "default": "", - "optional": false }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'yfinance']", - "description": "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.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - } - ], - "intrinio": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - } - ], - "yfinance": [ - { - "name": "symbol", + "name": "dividend_weighting_type", "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EquityInfo]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "description": "For ETFs that take the value 'Dividend Weighted' in the 'index_weighting_scheme' field, this field provides detail on the dividend weighting methodology.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", + "name": "bond_type", "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "description": "For ETFs where 'asset_class_type' is 'Bonds', this field provides detail on the type of bonds held in the ETF.", + "default": null, + "optional": true }, { - "name": "name", + "name": "government_bond_types", "type": "str", - "description": "Common name of the company.", + "description": "For bond ETFs that take the value 'Treasury & Government' in 'bond_type', this field provides detail on the exposure.", "default": null, "optional": true }, { - "name": "cik", + "name": "municipal_bond_region", "type": "str", - "description": "Central Index Key (CIK) for the requested entity.", + "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field provides additional detail on the geographic exposure.", "default": null, "optional": true }, { - "name": "cusip", - "type": "str", - "description": "CUSIP identifier for the company.", + "name": "municipal_vrdo", + "type": "bool", + "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field identifies those ETFs that specifically provide exposure to Variable Rate Demand Obligations.", "default": null, "optional": true }, { - "name": "isin", + "name": "mortgage_bond_types", "type": "str", - "description": "International Securities Identification Number.", + "description": "For bond ETFs that take the value 'Mortgage' in 'bond_type', this field provides additional detail on the type of underlying securities.", "default": null, "optional": true }, { - "name": "lei", + "name": "bond_tax_status", "type": "str", - "description": "Legal Entity Identifier assigned to the company.", + "description": "For all US bond ETFs, this field provides additional detail on the tax treatment of the underlying securities.", "default": null, "optional": true }, { - "name": "legal_name", + "name": "credit_quality", "type": "str", - "description": "Official legal name of the company.", + "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific credit quality range.", "default": null, "optional": true }, { - "name": "stock_exchange", + "name": "average_maturity", "type": "str", - "description": "Stock exchange where the company is traded.", + "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific maturity range.", "default": null, "optional": true }, { - "name": "sic", + "name": "specific_maturity_year", "type": "int", - "description": "Standard Industrial Classification code for the company.", + "description": "For all bond ETFs that take the value 'Specific Maturity Year' in the 'average_maturity' field, this field specifies the calendar year.", "default": null, "optional": true }, { - "name": "short_description", + "name": "commodity_types", "type": "str", - "description": "Short description of the company.", + "description": "For ETFs where 'asset_class_type' is 'Commodities', this field provides detail on the type of commodities held in the ETF.", "default": null, "optional": true }, { - "name": "long_description", + "name": "energy_type", "type": "str", - "description": "Long description of the company.", + "description": "For ETFs where 'commodity_type' is 'Energy', this field provides detail on the type of energy exposure provided by the ETF.", "default": null, "optional": true }, { - "name": "ceo", + "name": "agricultural_type", "type": "str", - "description": "Chief Executive Officer of the company.", + "description": "For ETFs where 'commodity_type' is 'Agricultural', this field provides detail on the type of agricultural exposure provided by the ETF.", "default": null, "optional": true }, { - "name": "company_url", + "name": "livestock_type", "type": "str", - "description": "URL of the company's website.", + "description": "For ETFs where 'commodity_type' is 'Livestock', this field provides detail on the type of livestock exposure provided by the ETF.", "default": null, "optional": true }, { - "name": "business_address", + "name": "metal_type", "type": "str", - "description": "Address of the company's headquarters.", + "description": "For ETFs where 'commodity_type' is 'Gold & Metals', this field provides detail on the type of exposure provided by the ETF.", "default": null, "optional": true }, { - "name": "mailing_address", + "name": "inverse_leveraged", "type": "str", - "description": "Mailing address of the company.", + "description": "This field is populated if the ETF provides inverse or leveraged exposure.", "default": null, "optional": true }, { - "name": "business_phone_no", + "name": "target_date_multi_asset_type", "type": "str", - "description": "Phone number of the company's headquarters.", + "description": "For ETFs where 'asset_class_type' is 'Target Date / MultiAsset', this field provides detail on the type of commodities held in the ETF.", "default": null, "optional": true }, { - "name": "hq_address1", + "name": "currency_pair", "type": "str", - "description": "Address of the company's headquarters.", + "description": "This field is populated if the ETF's strategy involves providing exposure to the movements of a currency or involves hedging currency exposure.", "default": null, "optional": true }, { - "name": "hq_address2", + "name": "social_environmental_type", "type": "str", - "description": "Address of the company's headquarters.", + "description": "This field is populated if the ETF's strategy involves providing exposure to a specific social or environmental theme.", "default": null, "optional": true }, { - "name": "hq_address_city", + "name": "clean_energy_type", "type": "str", - "description": "City of the company's headquarters.", + "description": "This field is populated if the ETF has a value of 'Clean Energy' in the 'social_environmental_type' field.", "default": null, "optional": true }, { - "name": "hq_address_postal_code", + "name": "dividend_type", "type": "str", - "description": "Zip code of the company's headquarters.", + "description": "This field is populated if the ETF has an intended investment objective of holding dividend-oriented stocks as stated in the prospectus.", "default": null, "optional": true }, { - "name": "hq_state", + "name": "regular_dividend_payor_type", "type": "str", - "description": "State of the company's headquarters.", + "description": "This field is populated if the ETF has a value of'Dividend - Regular Payors' in the 'dividend_type' field.", "default": null, "optional": true }, { - "name": "hq_country", + "name": "quant_strategies_type", "type": "str", - "description": "Country of the company's headquarters.", + "description": "This field is populated if the ETF has either an index-linked or active strategy that is based on a proprietary quantitative strategy.", "default": null, "optional": true }, { - "name": "inc_state", + "name": "other_quant_models", "type": "str", - "description": "State in which the company is incorporated.", + "description": "For ETFs where 'quant_strategies_type' is 'Other Quant Model', this field provides the name of the specific proprietary quant model used as the underlying strategy for the ETF.", "default": null, "optional": true }, { - "name": "inc_country", + "name": "hedge_fund_type", "type": "str", - "description": "Country in which the company is incorporated.", + "description": "For ETFs where 'other_asset_types' is 'Hedge Fund Replication', this field provides detail on the type of hedge fund replication strategy.", "default": null, "optional": true }, { - "name": "employees", - "type": "int", - "description": "Number of employees working for the company.", + "name": "excludes_financials", + "type": "bool", + "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold financials stocks, based on the funds intended objective.", "default": null, "optional": true }, { - "name": "entity_legal_form", - "type": "str", - "description": "Legal form of the company.", + "name": "excludes_technology", + "type": "bool", + "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold technology stocks, based on the funds intended objective.", "default": null, "optional": true }, { - "name": "entity_status", - "type": "str", - "description": "Status of the company.", + "name": "holds_only_nyse_stocks", + "type": "bool", + "description": "If true, the ETF is an equity ETF and holds only stocks listed on NYSE.", "default": null, "optional": true }, { - "name": "latest_filing_date", - "type": "date", - "description": "Date of the company's latest filing.", + "name": "holds_only_nasdaq_stocks", + "type": "bool", + "description": "If true, the ETF is an equity ETF and holds only stocks listed on Nasdaq.", "default": null, "optional": true }, { - "name": "irs_number", - "type": "str", - "description": "IRS number assigned to the company.", + "name": "holds_mlp", + "type": "bool", + "description": "If true, the ETF's investment objective explicitly specifies that it holds MLPs as an intended part of its investment strategy.", "default": null, "optional": true }, { - "name": "sector", - "type": "str", - "description": "Sector in which the company operates.", + "name": "holds_preferred_stock", + "type": "bool", + "description": "If true, the ETF's investment objective explicitly specifies that it holds preferred stock as an intended part of its investment strategy.", "default": null, "optional": true }, { - "name": "industry_category", - "type": "str", - "description": "Category of industry in which the company operates.", + "name": "holds_closed_end_funds", + "type": "bool", + "description": "If true, the ETF's investment objective explicitly specifies that it holds closed end funds as an intended part of its investment strategy.", "default": null, "optional": true }, { - "name": "industry_group", - "type": "str", - "description": "Group of industry in which the company operates.", + "name": "holds_adr", + "type": "bool", + "description": "If true, he ETF's investment objective explicitly specifies that it holds American Depositary Receipts (ADRs) as an intended part of its investment strategy.", "default": null, "optional": true }, { - "name": "template", - "type": "str", - "description": "Template used to standardize the company's financial statements.", + "name": "laddered", + "type": "bool", + "description": "For bond ETFs, this field identifies those ETFs that specifically hold bonds in a laddered structure, where the bonds are scheduled to mature in an annual, sequential structure.", "default": null, "optional": true }, { - "name": "standardized_active", + "name": "zero_coupon", "type": "bool", - "description": "Whether the company is active or not.", + "description": "For bond ETFs, this field identifies those ETFs that specifically hold zero coupon Treasury Bills.", "default": null, "optional": true }, { - "name": "first_fundamental_date", - "type": "date", - "description": "Date of the company's first fundamental.", + "name": "floating_rate", + "type": "bool", + "description": "For bond ETFs, this field identifies those ETFs that specifically hold floating rate bonds.", "default": null, "optional": true }, { - "name": "last_fundamental_date", - "type": "date", - "description": "Date of the company's last fundamental.", + "name": "build_america_bonds", + "type": "bool", + "description": "For municipal bond ETFs, this field identifies those ETFs that specifically hold Build America Bonds.", "default": null, "optional": true }, { - "name": "first_stock_price_date", - "type": "date", - "description": "Date of the company's first stock price.", + "name": "dynamic_futures_roll", + "type": "bool", + "description": "If the product holds futures contracts, this field identifies those products where the roll strategy is dynamic (rather than entirely rules based), so as to minimize roll costs.", "default": null, "optional": true }, { - "name": "last_stock_price_date", - "type": "date", - "description": "Date of the company's last stock price.", + "name": "currency_hedged", + "type": "bool", + "description": "This field is populated if the ETF's strategy involves hedging currency exposure.", "default": null, "optional": true - } - ], - "fmp": [ - { - "name": "is_etf", - "type": "bool", - "description": "If the symbol is an ETF.", - "default": "", - "optional": false }, { - "name": "is_actively_trading", + "name": "includes_short_exposure", "type": "bool", - "description": "If the company is actively trading.", - "default": "", - "optional": false + "description": "This field is populated if the ETF has short exposure in any of its holdings e.g. in a long/short or inverse ETF.", + "default": null, + "optional": true }, { - "name": "is_adr", + "name": "ucits", "type": "bool", - "description": "If the stock is an ADR.", - "default": "", - "optional": false + "description": "If true, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant", + "default": null, + "optional": true }, { - "name": "is_fund", - "type": "bool", - "description": "If the company is a fund.", - "default": "", - "optional": false + "name": "registered_countries", + "type": "str", + "description": "The list of countries where the ETF is legally registered for sale. This may differ from where the ETF is domiciled or traded, particularly in Europe.", + "default": null, + "optional": true }, { - "name": "image", + "name": "issuer_country", "type": "str", - "description": "Image of the company.", + "description": "2 letter ISO country code for the country where the issuer is located.", "default": null, "optional": true }, { - "name": "currency", + "name": "domicile", "type": "str", - "description": "Currency in which the stock is traded.", + "description": "2 letter ISO country code for the country where the ETP is domiciled.", "default": null, "optional": true }, { - "name": "market_cap", - "type": "int", - "description": "Market capitalization of the company.", + "name": "listing_country", + "type": "str", + "description": "2 letter ISO country code for the country of the primary listing.", "default": null, "optional": true }, { - "name": "last_price", - "type": "float", - "description": "The last traded price.", + "name": "listing_region", + "type": "str", + "description": "Geographic region in the country of the primary listing falls.", "default": null, "optional": true }, { - "name": "year_high", - "type": "float", - "description": "The one-year high of the price.", + "name": "bond_currency_denomination", + "type": "str", + "description": "For all bond ETFs, this field provides additional detail on the currency denomination of the underlying securities.", "default": null, "optional": true }, { - "name": "year_low", - "type": "float", - "description": "The one-year low of the price.", + "name": "base_currency", + "type": "str", + "description": "Base currency in which NAV is reported.", "default": null, "optional": true }, { - "name": "volume_avg", - "type": "int", - "description": "Average daily trading volume.", + "name": "listing_currency", + "type": "str", + "description": "Listing currency of the Exchange Traded Product (ETP) in which it is traded. Reported using the 3-digit ISO currency code.", "default": null, "optional": true }, { - "name": "annualized_dividend_amount", - "type": "float", - "description": "The annualized dividend payment based on the most recent regular dividend payment.", + "name": "number_of_holdings", + "type": "int", + "description": "The number of holdings in the ETF.", "default": null, "optional": true }, { - "name": "beta", + "name": "month_end_assets", "type": "float", - "description": "Beta of the stock relative to the market.", + "description": "Net assets in millions of dollars as of the most recent month end.", "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "id", - "type": "str", - "description": "Intrinio ID for the company.", + "name": "net_expense_ratio", + "type": "float", + "description": "Gross expense net of Fee Waivers, as a percentage of net assets as published by the ETF issuer.", "default": null, "optional": true }, { - "name": "thea_enabled", - "type": "bool", - "description": "Whether the company has been enabled for Thea.", + "name": "etf_portfolio_turnover", + "type": "float", + "description": "The percentage of positions turned over in the last 12 months.", "default": null, "optional": true } ], "yfinance": [ { - "name": "exchange_timezone", + "name": "fund_type", "type": "str", - "description": "The timezone of the exchange.", + "description": "The legal type of fund.", "default": null, "optional": true }, { - "name": "issue_type", + "name": "fund_family", "type": "str", - "description": "The issuance type of the asset.", + "description": "The fund family.", "default": null, "optional": true }, { - "name": "currency", + "name": "category", "type": "str", - "description": "The currency in which the asset is traded.", + "description": "The fund category.", "default": null, "optional": true }, { - "name": "market_cap", - "type": "int", - "description": "The market capitalization of the asset.", + "name": "exchange", + "type": "str", + "description": "The exchange the fund is listed on.", "default": null, "optional": true }, { - "name": "shares_outstanding", - "type": "int", - "description": "The number of listed shares outstanding.", - "default": null, - "optional": true - }, - { - "name": "shares_float", - "type": "int", - "description": "The number of shares in the public float.", - "default": null, - "optional": true - }, - { - "name": "shares_implied_outstanding", - "type": "int", - "description": "Implied shares outstanding of common equityassuming the conversion of all convertible subsidiary equity into common.", - "default": null, - "optional": true - }, - { - "name": "shares_short", - "type": "int", - "description": "The reported number of shares short.", - "default": null, - "optional": true - }, - { - "name": "dividend_yield", - "type": "float", - "description": "The dividend yield of the asset, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "beta", - "type": "float", - "description": "The beta of the asset relative to the broad market.", - "default": null, - "optional": true - } - ] - }, - "model": "EquityInfo" - }, - "/equity/market_snapshots": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get an updated equity market snapshot. This includes price data for thousands of stocks.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.market_snapshots(provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'polygon']", - "description": "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.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "market", - "type": "Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra']", - "description": "The market to fetch data for.", - "default": "nasdaq", - "optional": true - } - ], - "intrinio": [ - { - "name": "date", - "type": "Union[Union[date, datetime, str], str]", - "description": "The date of the data. Can be a datetime or an ISO datetime string. Historical data appears to go back to mid-June 2022. Example: '2024-03-08T12:15:00+0400'", - "default": null, - "optional": true - } - ], - "polygon": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[MarketSnapshots]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "open", - "type": "float", - "description": "The open price.", - "default": null, - "optional": true - }, - { - "name": "high", - "type": "float", - "description": "The high price.", - "default": null, - "optional": true - }, - { - "name": "low", - "type": "float", - "description": "The low price.", - "default": null, - "optional": true - }, - { - "name": "close", - "type": "float", - "description": "The close price.", - "default": null, - "optional": true - }, - { - "name": "volume", - "type": "int", - "description": "The trading volume.", - "default": null, - "optional": true - }, - { - "name": "prev_close", - "type": "float", - "description": "The previous close price.", - "default": null, - "optional": true - }, - { - "name": "change", - "type": "float", - "description": "The change in price from the previous close.", - "default": null, - "optional": true - }, - { - "name": "change_percent", - "type": "float", - "description": "The change in price from the previous close, as a normalized percent.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "last_price", - "type": "float", - "description": "The last price of the stock.", - "default": null, - "optional": true - }, - { - "name": "last_price_timestamp", - "type": "Union[date, datetime]", - "description": "The timestamp of the last price.", - "default": null, - "optional": true - }, - { - "name": "ma50", - "type": "float", - "description": "The 50-day moving average.", - "default": null, - "optional": true - }, - { - "name": "ma200", - "type": "float", - "description": "The 200-day moving average.", - "default": null, - "optional": true - }, - { - "name": "year_high", - "type": "float", - "description": "The 52-week high.", - "default": null, - "optional": true - }, - { - "name": "year_low", - "type": "float", - "description": "The 52-week low.", - "default": null, - "optional": true - }, - { - "name": "volume_avg", - "type": "int", - "description": "Average daily trading volume.", - "default": null, - "optional": true - }, - { - "name": "market_cap", - "type": "int", - "description": "Market cap of the stock.", - "default": null, - "optional": true - }, - { - "name": "eps", - "type": "float", - "description": "Earnings per share.", - "default": null, - "optional": true - }, - { - "name": "pe", - "type": "float", - "description": "Price to earnings ratio.", - "default": null, - "optional": true - }, - { - "name": "shares_outstanding", - "type": "int", - "description": "Number of shares outstanding.", - "default": null, - "optional": true - }, - { - "name": "name", - "type": "str", - "description": "The company name associated with the symbol.", - "default": null, - "optional": true - }, - { - "name": "exchange", - "type": "str", - "description": "The exchange of the stock.", - "default": null, - "optional": true - }, - { - "name": "earnings_date", - "type": "Union[date, datetime]", - "description": "The upcoming earnings announcement date.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "last_price", - "type": "float", - "description": "The last trade price.", - "default": null, - "optional": true - }, - { - "name": "last_size", - "type": "int", - "description": "The last trade size.", - "default": null, - "optional": true - }, - { - "name": "last_volume", - "type": "int", - "description": "The last trade volume.", - "default": null, - "optional": true - }, - { - "name": "last_trade_timestamp", - "type": "datetime", - "description": "The timestamp of the last trade.", - "default": null, - "optional": true - }, - { - "name": "bid_size", - "type": "int", - "description": "The size of the last bid price. Bid price and size is not always available.", - "default": null, - "optional": true - }, - { - "name": "bid_price", - "type": "float", - "description": "The last bid price. Bid price and size is not always available.", - "default": null, - "optional": true - }, - { - "name": "ask_price", - "type": "float", - "description": "The last ask price. Ask price and size is not always available.", - "default": null, - "optional": true - }, - { - "name": "ask_size", - "type": "int", - "description": "The size of the last ask price. Ask price and size is not always available.", - "default": null, - "optional": true - }, - { - "name": "last_bid_timestamp", - "type": "datetime", - "description": "The timestamp of the last bid price. Bid price and size is not always available.", - "default": null, - "optional": true - }, - { - "name": "last_ask_timestamp", - "type": "datetime", - "description": "The timestamp of the last ask price. Ask price and size is not always available.", - "default": null, - "optional": true - } - ], - "polygon": [ - { - "name": "vwap", - "type": "float", - "description": "The volume weighted average price of the stock on the current trading day.", - "default": null, - "optional": true - }, - { - "name": "prev_open", - "type": "float", - "description": "The previous trading session opening price.", - "default": null, - "optional": true - }, - { - "name": "prev_high", - "type": "float", - "description": "The previous trading session high price.", - "default": null, - "optional": true - }, - { - "name": "prev_low", - "type": "float", - "description": "The previous trading session low price.", - "default": null, - "optional": true - }, - { - "name": "prev_volume", - "type": "float", - "description": "The previous trading session volume.", - "default": null, - "optional": true - }, - { - "name": "prev_vwap", - "type": "float", - "description": "The previous trading session VWAP.", - "default": null, - "optional": true - }, - { - "name": "last_updated", - "type": "datetime", - "description": "The last time the data was updated.", - "default": "", - "optional": false - }, - { - "name": "bid", - "type": "float", - "description": "The current bid price.", - "default": null, - "optional": true - }, - { - "name": "bid_size", - "type": "int", - "description": "The current bid size.", - "default": null, - "optional": true - }, - { - "name": "ask_size", - "type": "int", - "description": "The current ask size.", - "default": null, - "optional": true - }, - { - "name": "ask", - "type": "float", - "description": "The current ask price.", - "default": null, - "optional": true - }, - { - "name": "quote_timestamp", - "type": "datetime", - "description": "The timestamp of the last quote.", - "default": null, - "optional": true - }, - { - "name": "last_trade_price", - "type": "float", - "description": "The last trade price.", - "default": null, - "optional": true - }, - { - "name": "last_trade_size", - "type": "int", - "description": "The last trade size.", - "default": null, - "optional": true - }, - { - "name": "last_trade_conditions", - "type": "List[int]", - "description": "The last trade condition codes.", - "default": null, - "optional": true - }, - { - "name": "last_trade_exchange", - "type": "int", - "description": "The last trade exchange ID code.", - "default": null, - "optional": true - }, - { - "name": "last_trade_timestamp", - "type": "datetime", - "description": "The last trade timestamp.", - "default": null, - "optional": true - } - ] - }, - "model": "MarketSnapshots" - }, - "/etf/search": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Search for ETFs.\n\nAn empty query returns the full list of ETFs from the provider.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# An empty query returns the full list of ETFs from the provider.\nobb.etf.search(provider='fmp')\n# The query will return results from text-based fields containing the term.\nobb.etf.search(query='commercial real estate', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "query", - "type": "str", - "description": "Search query.", - "default": "", - "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp', 'intrinio']", - "description": "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.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "exchange", - "type": "Literal['AMEX', 'NYSE', 'NASDAQ', 'ETF', 'TSX', 'EURONEXT']", - "description": "The exchange code the ETF trades on.", - "default": null, - "optional": true - }, - { - "name": "is_active", - "type": "Literal[True, False]", - "description": "Whether the ETF is actively trading.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "exchange", - "type": "Literal['xnas', 'arcx', 'bats', 'xnys', 'bvmf', 'xshg', 'xshe', 'xhkg', 'xbom', 'xnse', 'xidx', 'tase', 'xkrx', 'xkls', 'xmex', 'xses', 'roco', 'xtai', 'xbkk', 'xist']", - "description": "Target a specific exchange by providing the MIC code.", - "default": null, - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EtfSearch]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.(ETF)", - "default": "", - "optional": false - }, - { - "name": "name", - "type": "str", - "description": "Name of the ETF.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "market_cap", - "type": "float", - "description": "The market cap of the ETF.", - "default": null, - "optional": true - }, - { - "name": "sector", - "type": "str", - "description": "The sector of the ETF.", - "default": null, - "optional": true - }, - { - "name": "industry", - "type": "str", - "description": "The industry of the ETF.", - "default": null, - "optional": true - }, - { - "name": "beta", - "type": "float", - "description": "The beta of the ETF.", - "default": null, - "optional": true - }, - { - "name": "price", - "type": "float", - "description": "The current price of the ETF.", - "default": null, - "optional": true - }, - { - "name": "last_annual_dividend", - "type": "float", - "description": "The last annual dividend paid.", - "default": null, - "optional": true - }, - { - "name": "volume", - "type": "float", - "description": "The current trading volume of the ETF.", - "default": null, - "optional": true - }, - { - "name": "exchange", - "type": "str", - "description": "The exchange code the ETF trades on.", - "default": null, - "optional": true - }, - { - "name": "exchange_name", - "type": "str", - "description": "The full name of the exchange the ETF trades on.", - "default": null, - "optional": true - }, - { - "name": "country", - "type": "str", - "description": "The country the ETF is registered in.", - "default": null, - "optional": true - }, - { - "name": "actively_trading", - "type": "Literal[True, False]", - "description": "Whether the ETF is actively trading.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "exchange", - "type": "str", - "description": "The exchange MIC code.", - "default": null, - "optional": true - }, - { - "name": "figi_ticker", - "type": "str", - "description": "The OpenFIGI ticker.", - "default": null, - "optional": true - }, - { - "name": "ric", - "type": "str", - "description": "The Reuters Instrument Code.", - "default": null, - "optional": true - }, - { - "name": "isin", - "type": "str", - "description": "The International Securities Identification Number.", - "default": null, - "optional": true - }, - { - "name": "sedol", - "type": "str", - "description": "The Stock Exchange Daily Official List.", - "default": null, - "optional": true - }, - { - "name": "intrinio_id", - "type": "str", - "description": "The unique Intrinio ID for the security.", - "default": null, - "optional": true - } - ] - }, - "model": "EtfSearch" - }, - "/etf/historical": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "ETF Historical Market Price.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.historical(symbol='SPY', provider='fmp')\nobb.etf.historical(symbol='SPY', provider='yfinance')\n# This function accepts multiple tickers.\nobb.etf.historical(symbol='SPY,IWM,QQQ,DJIA', provider='yfinance')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", - "default": "", - "optional": false - }, - { - "name": "interval", - "type": "str", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - }, - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']", - "description": "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.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "interval", - "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - } - ], - "intrinio": [ - { - "name": "symbol", - "type": "str", - "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", - "default": "", - "optional": false - }, - { - "name": "interval", - "type": "Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y']", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - }, - { - "name": "start_time", - "type": "datetime.time", - "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'.", - "default": null, - "optional": true - }, - { - "name": "end_time", - "type": "datetime.time", - "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'.", - "default": null, - "optional": true - }, - { - "name": "timezone", - "type": "str", - "description": "Timezone of the data, in the IANA format (Continent/City).", - "default": "America/New_York", - "optional": true - }, - { - "name": "source", - "type": "Literal['realtime', 'delayed', 'nasdaq_basic']", - "description": "The source of the data.", - "default": "realtime", - "optional": true - } - ], - "polygon": [ - { - "name": "interval", - "type": "str", - "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", - "default": "1d", - "optional": true - }, - { - "name": "adjustment", - "type": "Literal['splits_only', 'unadjusted']", - "description": "The adjustment factor to apply. Default is splits only.", - "default": "splits_only", - "optional": true - }, - { - "name": "extended_hours", - "type": "bool", - "description": "Include Pre and Post market data.", - "default": false, - "optional": true - }, - { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", - "default": "asc", - "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 49999, - "optional": true - } - ], - "tiingo": [ - { - "name": "interval", - "type": "Literal['1d', '1W', '1M', '1Y']", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - } - ], - "yfinance": [ - { - "name": "interval", - "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - }, - { - "name": "extended_hours", - "type": "bool", - "description": "Include Pre and Post market data.", - "default": false, - "optional": true - }, - { - "name": "include_actions", - "type": "bool", - "description": "Include dividends and stock splits in results.", - "default": true, - "optional": true - }, - { - "name": "adjustment", - "type": "Literal['splits_only', 'splits_and_dividends']", - "description": "The adjustment factor to apply. Default is splits only.", - "default": "splits_only", - "optional": true - }, - { - "name": "adjusted", - "type": "bool", - "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead.", - "default": false, - "optional": true - }, - { - "name": "prepost", - "type": "bool", - "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead.", - "default": false, - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EtfHistorical]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "Union[date, datetime]", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "open", - "type": "float", - "description": "The open price.", - "default": "", - "optional": false - }, - { - "name": "high", - "type": "float", - "description": "The high price.", - "default": "", - "optional": false - }, - { - "name": "low", - "type": "float", - "description": "The low price.", - "default": "", - "optional": false - }, - { - "name": "close", - "type": "float", - "description": "The close price.", - "default": "", - "optional": false - }, - { - "name": "volume", - "type": "Union[int, float]", - "description": "The trading volume.", - "default": null, - "optional": true - }, - { - "name": "vwap", - "type": "float", - "description": "Volume Weighted Average Price over the period.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "adj_close", - "type": "float", - "description": "The adjusted close price.", - "default": null, - "optional": true - }, - { - "name": "unadjusted_volume", - "type": "float", - "description": "Unadjusted volume of the symbol.", - "default": null, - "optional": true - }, - { - "name": "change", - "type": "float", - "description": "Change in the price from the previous close.", - "default": null, - "optional": true - }, - { - "name": "change_percent", - "type": "float", - "description": "Change in the price from the previous close, as a normalized percent.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "average", - "type": "float", - "description": "Average trade price of an individual equity during the interval.", - "default": null, - "optional": true - }, - { - "name": "change", - "type": "float", - "description": "Change in the price of the symbol from the previous day.", - "default": null, - "optional": true - }, - { - "name": "change_percent", - "type": "float", - "description": "Percent change in the price of the symbol from the previous day.", - "default": null, - "optional": true - }, - { - "name": "adj_open", - "type": "float", - "description": "The adjusted open price.", - "default": null, - "optional": true - }, - { - "name": "adj_high", - "type": "float", - "description": "The adjusted high price.", - "default": null, - "optional": true - }, - { - "name": "adj_low", - "type": "float", - "description": "The adjusted low price.", - "default": null, - "optional": true - }, - { - "name": "adj_close", - "type": "float", - "description": "The adjusted close price.", - "default": null, - "optional": true - }, - { - "name": "adj_volume", - "type": "float", - "description": "The adjusted volume.", - "default": null, - "optional": true - }, - { - "name": "fifty_two_week_high", - "type": "float", - "description": "52 week high price for the symbol.", - "default": null, - "optional": true - }, - { - "name": "fifty_two_week_low", - "type": "float", - "description": "52 week low price for the symbol.", - "default": null, - "optional": true - }, - { - "name": "factor", - "type": "float", - "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices.", - "default": null, - "optional": true - }, - { - "name": "split_ratio", - "type": "float", - "description": "Ratio of the equity split, if a split occurred.", - "default": null, - "optional": true - }, - { - "name": "dividend", - "type": "float", - "description": "Dividend amount, if a dividend was paid.", - "default": null, - "optional": true - }, - { - "name": "close_time", - "type": "datetime", - "description": "The timestamp that represents the end of the interval span.", - "default": null, - "optional": true - }, - { - "name": "interval", - "type": "str", - "description": "The data time frequency.", - "default": null, - "optional": true - }, - { - "name": "intra_period", - "type": "bool", - "description": "If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period", - "default": null, - "optional": true - } - ], - "polygon": [ - { - "name": "transactions", - "type": "Annotated[int, Gt(gt=0)]", - "description": "Number of transactions for the symbol in the time period.", - "default": null, - "optional": true - } - ], - "tiingo": [ - { - "name": "adj_open", - "type": "float", - "description": "The adjusted open price.", - "default": null, - "optional": true - }, - { - "name": "adj_high", - "type": "float", - "description": "The adjusted high price.", - "default": null, - "optional": true - }, - { - "name": "adj_low", - "type": "float", - "description": "The adjusted low price.", - "default": null, - "optional": true - }, - { - "name": "adj_close", - "type": "float", - "description": "The adjusted close price.", - "default": null, - "optional": true - }, - { - "name": "adj_volume", - "type": "float", - "description": "The adjusted volume.", - "default": null, - "optional": true - }, - { - "name": "split_ratio", - "type": "float", - "description": "Ratio of the equity split, if a split occurred.", - "default": null, - "optional": true - }, - { - "name": "dividend", - "type": "float", - "description": "Dividend amount, if a dividend was paid.", - "default": null, - "optional": true - } - ], - "yfinance": [ - { - "name": "split_ratio", - "type": "float", - "description": "Ratio of the equity split, if a split occurred.", - "default": null, - "optional": true - }, - { - "name": "dividend", - "type": "float", - "description": "Dividend amount (split-adjusted), if a dividend was paid.", - "default": null, - "optional": true - } - ] - }, - "model": "EtfHistorical" - }, - "/etf/info": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "ETF Information Overview.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.info(symbol='SPY', provider='fmp')\n# This function accepts multiple tickers.\nobb.etf.info(symbol='SPY,IWM,QQQ,DJIA', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, intrinio, yfinance.", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'yfinance']", - "description": "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.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for. (ETF)", - "default": "", - "optional": false - } - ], - "intrinio": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for. (ETF)", - "default": "", - "optional": false - } - ], - "yfinance": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for. (ETF)", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EtfInfo]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data. (ETF)", - "default": "", - "optional": false - }, - { - "name": "name", - "type": "str", - "description": "Name of the ETF.", - "default": "", - "optional": false - }, - { - "name": "description", - "type": "str", - "description": "Description of the fund.", - "default": null, - "optional": true - }, - { - "name": "inception_date", - "type": "str", - "description": "Inception date of the ETF.", - "default": "", - "optional": false - } - ], - "fmp": [ - { - "name": "issuer", - "type": "str", - "description": "Company of the ETF.", - "default": null, - "optional": true - }, - { - "name": "cusip", - "type": "str", - "description": "CUSIP of the ETF.", - "default": null, - "optional": true - }, - { - "name": "isin", - "type": "str", - "description": "ISIN of the ETF.", - "default": null, - "optional": true - }, - { - "name": "domicile", - "type": "str", - "description": "Domicile of the ETF.", - "default": null, - "optional": true - }, - { - "name": "asset_class", - "type": "str", - "description": "Asset class of the ETF.", - "default": null, - "optional": true - }, - { - "name": "aum", - "type": "float", - "description": "Assets under management.", - "default": null, - "optional": true - }, - { - "name": "nav", - "type": "float", - "description": "Net asset value of the ETF.", - "default": null, - "optional": true - }, - { - "name": "nav_currency", - "type": "str", - "description": "Currency of the ETF's net asset value.", - "default": null, - "optional": true - }, - { - "name": "expense_ratio", - "type": "float", - "description": "The expense ratio, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "holdings_count", - "type": "int", - "description": "Number of holdings.", - "default": null, - "optional": true - }, - { - "name": "avg_volume", - "type": "float", - "description": "Average daily trading volume.", - "default": null, - "optional": true - }, - { - "name": "website", - "type": "str", - "description": "Website of the issuer.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "fund_listing_date", - "type": "date", - "description": "The date on which the Exchange Traded Product (ETP) or share class of the ETP is listed on a specific exchange.", - "default": null, - "optional": true - }, - { - "name": "data_change_date", - "type": "date", - "description": "The last date on which there was a change in a classifications data field for this ETF.", - "default": null, - "optional": true - }, - { - "name": "etn_maturity_date", - "type": "date", - "description": "If the product is an ETN, this field identifies the maturity date for the ETN.", - "default": null, - "optional": true - }, - { - "name": "is_listed", - "type": "bool", - "description": "If true, the ETF is still listed on an exchange.", - "default": null, - "optional": true - }, - { - "name": "close_date", - "type": "date", - "description": "The date on which the ETF was de-listed if it is no longer listed.", - "default": null, - "optional": true - }, - { - "name": "exchange", - "type": "str", - "description": "The exchange Market Identifier Code (MIC).", - "default": null, - "optional": true - }, - { - "name": "isin", - "type": "str", - "description": "International Securities Identification Number (ISIN).", - "default": null, - "optional": true - }, - { - "name": "ric", - "type": "str", - "description": "Reuters Instrument Code (RIC).", - "default": null, - "optional": true - }, - { - "name": "sedol", - "type": "str", - "description": "Stock Exchange Daily Official List (SEDOL).", - "default": null, - "optional": true - }, - { - "name": "figi_symbol", - "type": "str", - "description": "Financial Instrument Global Identifier (FIGI) symbol.", - "default": null, - "optional": true - }, - { - "name": "share_class_figi", - "type": "str", - "description": "Financial Instrument Global Identifier (FIGI).", - "default": null, - "optional": true - }, - { - "name": "firstbridge_id", - "type": "str", - "description": "The FirstBridge unique identifier for the Exchange Traded Fund (ETF).", - "default": null, - "optional": true - }, - { - "name": "firstbridge_parent_id", - "type": "str", - "description": "The FirstBridge unique identifier for the parent Exchange Traded Fund (ETF), if applicable.", - "default": null, - "optional": true - }, - { - "name": "intrinio_id", - "type": "str", - "description": "Intrinio unique identifier for the security.", - "default": null, - "optional": true - }, - { - "name": "intraday_nav_symbol", - "type": "str", - "description": "Intraday Net Asset Value (NAV) symbol.", - "default": null, - "optional": true - }, - { - "name": "primary_symbol", - "type": "str", - "description": "The primary ticker field is used for Exchange Traded Products (ETPs) that have multiple listings and share classes. If an ETP has multiple listings or share classes, the same primary ticker is assigned to all the listings and share classes.", - "default": null, - "optional": true - }, - { - "name": "etp_structure_type", - "type": "str", - "description": "Classifies Exchange Traded Products (ETPs) into very broad categories based on its legal structure.", - "default": null, - "optional": true - }, - { - "name": "legal_structure", - "type": "str", - "description": "Legal structure of the fund.", - "default": null, - "optional": true - }, - { - "name": "issuer", - "type": "str", - "description": "Issuer of the ETF.", - "default": null, - "optional": true - }, - { - "name": "etn_issuing_bank", - "type": "str", - "description": "If the product is an Exchange Traded Note (ETN), this field identifies the issuing bank.", - "default": null, - "optional": true - }, - { - "name": "fund_family", - "type": "str", - "description": "This field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor.", - "default": null, - "optional": true - }, - { - "name": "investment_style", - "type": "str", - "description": "Investment style of the ETF.", - "default": null, - "optional": true - }, - { - "name": "derivatives_based", - "type": "str", - "description": "This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio.", - "default": null, - "optional": true - }, - { - "name": "income_category", - "type": "str", - "description": "Identifies if an Exchange Traded Fund (ETF) falls into a category that is specifically designed to provide a high yield or income", - "default": null, - "optional": true - }, - { - "name": "asset_class", - "type": "str", - "description": "Captures the underlying nature of the securities in the Exchanged Traded Product (ETP).", - "default": null, - "optional": true - }, - { - "name": "other_asset_types", - "type": "str", - "description": "If 'asset_class' field is classified as 'Other Asset Types' this field captures the specific category of the underlying assets.", - "default": null, - "optional": true - }, - { - "name": "single_category_designation", - "type": "str", - "description": "This categorization is created for those users who want every ETF to be 'forced' into a single bucket, so that the assets for all categories will always sum to the total market.", - "default": null, - "optional": true - }, - { - "name": "beta_type", - "type": "str", - "description": "This field identifies whether an ETF provides 'Traditional' beta exposure or 'Smart' beta exposure. ETFs that are active (i.e. non-indexed), leveraged / inverse or have a proprietary quant model (i.e. that don't provide indexed exposure to a targeted factor) are classified separately.", - "default": null, - "optional": true - }, - { - "name": "beta_details", - "type": "str", - "description": "This field provides further detail within the traditional and smart beta categories.", - "default": null, - "optional": true - }, - { - "name": "market_cap_range", - "type": "str", - "description": "Equity ETFs are classified as falling into categories based on the description of their investment strategy in the prospectus. Examples ('Mega Cap', 'Large Cap', 'Mid Cap', etc.)", - "default": null, - "optional": true - }, - { - "name": "market_cap_weighting_type", - "type": "str", - "description": "For ETFs that take the value 'Market Cap Weighted' in the 'index_weighting_scheme' field, this field provides detail on the market cap weighting type.", - "default": null, - "optional": true - }, - { - "name": "index_weighting_scheme", - "type": "str", - "description": "For ETFs that track an underlying index, this field provides detail on the index weighting type.", - "default": null, - "optional": true - }, - { - "name": "index_linked", - "type": "str", - "description": "This field identifies whether an ETF is index linked or active.", - "default": null, - "optional": true - }, - { - "name": "index_name", - "type": "str", - "description": "This field identifies the name of the underlying index tracked by the ETF, if applicable.", - "default": null, - "optional": true - }, - { - "name": "index_symbol", - "type": "str", - "description": "This field identifies the OpenFIGI ticker for the Index underlying the ETF.", - "default": null, - "optional": true - }, - { - "name": "parent_index", - "type": "str", - "description": "This field identifies the name of the parent index, which represents the broader universe from which the index underlying the ETF is created, if applicable.", - "default": null, - "optional": true - }, - { - "name": "index_family", - "type": "str", - "description": "This field identifies the index family to which the index underlying the ETF belongs. The index family is represented as categorized by the index provider.", - "default": null, - "optional": true - }, - { - "name": "broader_index_family", - "type": "str", - "description": "This field identifies the broader index family to which the index underlying the ETF belongs. The broader index family is represented as categorized by the index provider.", - "default": null, - "optional": true - }, - { - "name": "index_provider", - "type": "str", - "description": "This field identifies the Index provider for the index underlying the ETF, if applicable.", - "default": null, - "optional": true - }, - { - "name": "index_provider_code", - "type": "str", - "description": "This field provides the First Bridge code for each Index provider, corresponding to the index underlying the ETF if applicable.", - "default": null, - "optional": true - }, - { - "name": "replication_structure", - "type": "str", - "description": "The replication structure of the Exchange Traded Product (ETP).", - "default": null, - "optional": true - }, - { - "name": "growth_value_tilt", - "type": "str", - "description": "Classifies equity ETFs as either 'Growth' or Value' based on the stated style tilt in the ETF prospectus. Equity ETFs that do not have a stated style tilt are classified as 'Core / Blend'.", - "default": null, - "optional": true - }, - { - "name": "growth_type", - "type": "str", - "description": "For ETFs that are classified as 'Growth' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their growth (style factor) scores.", - "default": null, - "optional": true - }, - { - "name": "value_type", - "type": "str", - "description": "For ETFs that are classified as 'Value' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their value (style factor) scores.", - "default": null, - "optional": true - }, - { - "name": "sector", - "type": "str", - "description": "For equity ETFs that aim to provide targeted exposure to a sector or industry, this field identifies the Sector that it provides the exposure to.", - "default": null, - "optional": true - }, - { - "name": "industry", - "type": "str", - "description": "For equity ETFs that aim to provide targeted exposure to an industry, this field identifies the Industry that it provides the exposure to.", - "default": null, - "optional": true - }, - { - "name": "industry_group", - "type": "str", - "description": "For equity ETFs that aim to provide targeted exposure to a sub-industry, this field identifies the sub-Industry that it provides the exposure to.", - "default": null, - "optional": true - }, - { - "name": "cross_sector_theme", - "type": "str", - "description": "For equity ETFs that aim to provide targeted exposure to a specific investment theme that cuts across GICS sectors, this field identifies the specific cross-sector theme. Examples ('Agri-business', 'Natural Resources', 'Green Investing', etc.)", - "default": null, - "optional": true - }, - { - "name": "natural_resources_type", - "type": "str", - "description": "For ETFs that are classified as 'Natural Resources' in the 'cross_sector_theme' field, this field provides further detail on the type of Natural Resources exposure.", - "default": null, - "optional": true - }, - { - "name": "us_or_excludes_us", - "type": "str", - "description": "Takes the value of 'Domestic' for US exposure, 'International' for non-US exposure and 'Global' for exposure that includes all regions including the US.", - "default": null, - "optional": true - }, - { - "name": "developed_emerging", - "type": "str", - "description": "This field identifies the stage of development of the markets that the ETF provides exposure to.", - "default": null, - "optional": true - }, - { - "name": "specialized_region", - "type": "str", - "description": "This field is populated if the ETF provides targeted exposure to a specific type of geography-based grouping that does not fall into a specific country or continent grouping. Examples ('BRIC', 'Chindia', etc.)", - "default": null, - "optional": true - }, - { - "name": "continent", - "type": "str", - "description": "This field is populated if the ETF provides targeted exposure to a specific continent or country within that Continent.", - "default": null, - "optional": true - }, - { - "name": "latin_america_sub_group", - "type": "str", - "description": "For ETFs that are classified as 'Latin America' in the 'continent' field, this field provides further detail on the type of regional exposure.", - "default": null, - "optional": true - }, - { - "name": "europe_sub_group", - "type": "str", - "description": "For ETFs that are classified as 'Europe' in the 'continent' field, this field provides further detail on the type of regional exposure.", - "default": null, - "optional": true - }, - { - "name": "asia_sub_group", - "type": "str", - "description": "For ETFs that are classified as 'Asia' in the 'continent' field, this field provides further detail on the type of regional exposure.", - "default": null, - "optional": true - }, - { - "name": "specific_country", - "type": "str", - "description": "This field is populated if the ETF provides targeted exposure to a specific country.", - "default": null, - "optional": true - }, - { - "name": "china_listing_location", - "type": "str", - "description": "For ETFs that are classified as 'China' in the 'country' field, this field provides further detail on the type of exposure in the underlying securities.", - "default": null, - "optional": true - }, - { - "name": "us_state", - "type": "str", - "description": "Takes the value of a US state if the ETF provides targeted exposure to the municipal bonds or equities of companies.", - "default": null, - "optional": true - }, - { - "name": "real_estate", - "type": "str", - "description": "For ETFs that provide targeted real estate exposure, this field is populated if the ETF provides targeted exposure to a specific segment of the real estate market.", - "default": null, - "optional": true - }, - { - "name": "fundamental_weighting_type", - "type": "str", - "description": "For ETFs that take the value 'Fundamental Weighted' in the 'index_weighting_scheme' field, this field provides detail on the fundamental weighting methodology.", - "default": null, - "optional": true - }, - { - "name": "dividend_weighting_type", - "type": "str", - "description": "For ETFs that take the value 'Dividend Weighted' in the 'index_weighting_scheme' field, this field provides detail on the dividend weighting methodology.", - "default": null, - "optional": true - }, - { - "name": "bond_type", - "type": "str", - "description": "For ETFs where 'asset_class_type' is 'Bonds', this field provides detail on the type of bonds held in the ETF.", - "default": null, - "optional": true - }, - { - "name": "government_bond_types", - "type": "str", - "description": "For bond ETFs that take the value 'Treasury & Government' in 'bond_type', this field provides detail on the exposure.", - "default": null, - "optional": true - }, - { - "name": "municipal_bond_region", - "type": "str", - "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field provides additional detail on the geographic exposure.", - "default": null, - "optional": true - }, - { - "name": "municipal_vrdo", - "type": "bool", - "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field identifies those ETFs that specifically provide exposure to Variable Rate Demand Obligations.", - "default": null, - "optional": true - }, - { - "name": "mortgage_bond_types", - "type": "str", - "description": "For bond ETFs that take the value 'Mortgage' in 'bond_type', this field provides additional detail on the type of underlying securities.", - "default": null, - "optional": true - }, - { - "name": "bond_tax_status", - "type": "str", - "description": "For all US bond ETFs, this field provides additional detail on the tax treatment of the underlying securities.", - "default": null, - "optional": true - }, - { - "name": "credit_quality", - "type": "str", - "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific credit quality range.", - "default": null, - "optional": true - }, - { - "name": "average_maturity", - "type": "str", - "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific maturity range.", - "default": null, - "optional": true - }, - { - "name": "specific_maturity_year", - "type": "int", - "description": "For all bond ETFs that take the value 'Specific Maturity Year' in the 'average_maturity' field, this field specifies the calendar year.", - "default": null, - "optional": true - }, - { - "name": "commodity_types", - "type": "str", - "description": "For ETFs where 'asset_class_type' is 'Commodities', this field provides detail on the type of commodities held in the ETF.", - "default": null, - "optional": true - }, - { - "name": "energy_type", - "type": "str", - "description": "For ETFs where 'commodity_type' is 'Energy', this field provides detail on the type of energy exposure provided by the ETF.", - "default": null, - "optional": true - }, - { - "name": "agricultural_type", - "type": "str", - "description": "For ETFs where 'commodity_type' is 'Agricultural', this field provides detail on the type of agricultural exposure provided by the ETF.", - "default": null, - "optional": true - }, - { - "name": "livestock_type", - "type": "str", - "description": "For ETFs where 'commodity_type' is 'Livestock', this field provides detail on the type of livestock exposure provided by the ETF.", - "default": null, - "optional": true - }, - { - "name": "metal_type", - "type": "str", - "description": "For ETFs where 'commodity_type' is 'Gold & Metals', this field provides detail on the type of exposure provided by the ETF.", - "default": null, - "optional": true - }, - { - "name": "inverse_leveraged", - "type": "str", - "description": "This field is populated if the ETF provides inverse or leveraged exposure.", - "default": null, - "optional": true - }, - { - "name": "target_date_multi_asset_type", - "type": "str", - "description": "For ETFs where 'asset_class_type' is 'Target Date / MultiAsset', this field provides detail on the type of commodities held in the ETF.", - "default": null, - "optional": true - }, - { - "name": "currency_pair", - "type": "str", - "description": "This field is populated if the ETF's strategy involves providing exposure to the movements of a currency or involves hedging currency exposure.", - "default": null, - "optional": true - }, - { - "name": "social_environmental_type", - "type": "str", - "description": "This field is populated if the ETF's strategy involves providing exposure to a specific social or environmental theme.", - "default": null, - "optional": true - }, - { - "name": "clean_energy_type", - "type": "str", - "description": "This field is populated if the ETF has a value of 'Clean Energy' in the 'social_environmental_type' field.", - "default": null, - "optional": true - }, - { - "name": "dividend_type", - "type": "str", - "description": "This field is populated if the ETF has an intended investment objective of holding dividend-oriented stocks as stated in the prospectus.", - "default": null, - "optional": true - }, - { - "name": "regular_dividend_payor_type", - "type": "str", - "description": "This field is populated if the ETF has a value of'Dividend - Regular Payors' in the 'dividend_type' field.", - "default": null, - "optional": true - }, - { - "name": "quant_strategies_type", - "type": "str", - "description": "This field is populated if the ETF has either an index-linked or active strategy that is based on a proprietary quantitative strategy.", - "default": null, - "optional": true - }, - { - "name": "other_quant_models", - "type": "str", - "description": "For ETFs where 'quant_strategies_type' is 'Other Quant Model', this field provides the name of the specific proprietary quant model used as the underlying strategy for the ETF.", - "default": null, - "optional": true - }, - { - "name": "hedge_fund_type", - "type": "str", - "description": "For ETFs where 'other_asset_types' is 'Hedge Fund Replication', this field provides detail on the type of hedge fund replication strategy.", - "default": null, - "optional": true - }, - { - "name": "excludes_financials", - "type": "bool", - "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold financials stocks, based on the funds intended objective.", - "default": null, - "optional": true - }, - { - "name": "excludes_technology", - "type": "bool", - "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold technology stocks, based on the funds intended objective.", - "default": null, - "optional": true - }, - { - "name": "holds_only_nyse_stocks", - "type": "bool", - "description": "If true, the ETF is an equity ETF and holds only stocks listed on NYSE.", - "default": null, - "optional": true - }, - { - "name": "holds_only_nasdaq_stocks", - "type": "bool", - "description": "If true, the ETF is an equity ETF and holds only stocks listed on Nasdaq.", - "default": null, - "optional": true - }, - { - "name": "holds_mlp", - "type": "bool", - "description": "If true, the ETF's investment objective explicitly specifies that it holds MLPs as an intended part of its investment strategy.", - "default": null, - "optional": true - }, - { - "name": "holds_preferred_stock", - "type": "bool", - "description": "If true, the ETF's investment objective explicitly specifies that it holds preferred stock as an intended part of its investment strategy.", - "default": null, - "optional": true - }, - { - "name": "holds_closed_end_funds", - "type": "bool", - "description": "If true, the ETF's investment objective explicitly specifies that it holds closed end funds as an intended part of its investment strategy.", - "default": null, - "optional": true - }, - { - "name": "holds_adr", - "type": "bool", - "description": "If true, he ETF's investment objective explicitly specifies that it holds American Depositary Receipts (ADRs) as an intended part of its investment strategy.", - "default": null, - "optional": true - }, - { - "name": "laddered", - "type": "bool", - "description": "For bond ETFs, this field identifies those ETFs that specifically hold bonds in a laddered structure, where the bonds are scheduled to mature in an annual, sequential structure.", - "default": null, - "optional": true - }, - { - "name": "zero_coupon", - "type": "bool", - "description": "For bond ETFs, this field identifies those ETFs that specifically hold zero coupon Treasury Bills.", - "default": null, - "optional": true - }, - { - "name": "floating_rate", - "type": "bool", - "description": "For bond ETFs, this field identifies those ETFs that specifically hold floating rate bonds.", - "default": null, - "optional": true - }, - { - "name": "build_america_bonds", - "type": "bool", - "description": "For municipal bond ETFs, this field identifies those ETFs that specifically hold Build America Bonds.", - "default": null, - "optional": true - }, - { - "name": "dynamic_futures_roll", - "type": "bool", - "description": "If the product holds futures contracts, this field identifies those products where the roll strategy is dynamic (rather than entirely rules based), so as to minimize roll costs.", - "default": null, - "optional": true - }, - { - "name": "currency_hedged", - "type": "bool", - "description": "This field is populated if the ETF's strategy involves hedging currency exposure.", - "default": null, - "optional": true - }, - { - "name": "includes_short_exposure", - "type": "bool", - "description": "This field is populated if the ETF has short exposure in any of its holdings e.g. in a long/short or inverse ETF.", - "default": null, - "optional": true - }, - { - "name": "ucits", - "type": "bool", - "description": "If true, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant", - "default": null, - "optional": true - }, - { - "name": "registered_countries", - "type": "str", - "description": "The list of countries where the ETF is legally registered for sale. This may differ from where the ETF is domiciled or traded, particularly in Europe.", - "default": null, - "optional": true - }, - { - "name": "issuer_country", - "type": "str", - "description": "2 letter ISO country code for the country where the issuer is located.", - "default": null, - "optional": true - }, - { - "name": "domicile", - "type": "str", - "description": "2 letter ISO country code for the country where the ETP is domiciled.", - "default": null, - "optional": true - }, - { - "name": "listing_country", - "type": "str", - "description": "2 letter ISO country code for the country of the primary listing.", - "default": null, - "optional": true - }, - { - "name": "listing_region", - "type": "str", - "description": "Geographic region in the country of the primary listing falls.", - "default": null, - "optional": true - }, - { - "name": "bond_currency_denomination", - "type": "str", - "description": "For all bond ETFs, this field provides additional detail on the currency denomination of the underlying securities.", - "default": null, - "optional": true - }, - { - "name": "base_currency", - "type": "str", - "description": "Base currency in which NAV is reported.", - "default": null, - "optional": true - }, - { - "name": "listing_currency", - "type": "str", - "description": "Listing currency of the Exchange Traded Product (ETP) in which it is traded. Reported using the 3-digit ISO currency code.", - "default": null, - "optional": true - }, - { - "name": "number_of_holdings", - "type": "int", - "description": "The number of holdings in the ETF.", - "default": null, - "optional": true - }, - { - "name": "month_end_assets", - "type": "float", - "description": "Net assets in millions of dollars as of the most recent month end.", - "default": null, - "optional": true - }, - { - "name": "net_expense_ratio", - "type": "float", - "description": "Gross expense net of Fee Waivers, as a percentage of net assets as published by the ETF issuer.", - "default": null, - "optional": true - }, - { - "name": "etf_portfolio_turnover", - "type": "float", - "description": "The percentage of positions turned over in the last 12 months.", - "default": null, - "optional": true - } - ], - "yfinance": [ - { - "name": "fund_type", - "type": "str", - "description": "The legal type of fund.", - "default": null, - "optional": true - }, - { - "name": "fund_family", - "type": "str", - "description": "The fund family.", - "default": null, - "optional": true - }, - { - "name": "category", - "type": "str", - "description": "The fund category.", - "default": null, - "optional": true - }, - { - "name": "exchange", - "type": "str", - "description": "The exchange the fund is listed on.", - "default": null, - "optional": true - }, - { - "name": "exchange_timezone", - "type": "str", - "description": "The timezone of the exchange.", - "default": null, - "optional": true - }, - { - "name": "currency", - "type": "str", - "description": "The currency in which the fund is listed.", - "default": null, - "optional": true - }, - { - "name": "nav_price", - "type": "float", - "description": "The net asset value per unit of the fund.", - "default": null, - "optional": true - }, - { - "name": "total_assets", - "type": "int", - "description": "The total value of assets held by the fund.", - "default": null, - "optional": true - }, - { - "name": "trailing_pe", - "type": "float", - "description": "The trailing twelve month P/E ratio of the fund's assets.", - "default": null, - "optional": true - }, - { - "name": "dividend_yield", - "type": "float", - "description": "The dividend yield of the fund, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "dividend_rate_ttm", - "type": "float", - "description": "The trailing twelve month annual dividend rate of the fund, in currency units.", - "default": null, - "optional": true - }, - { - "name": "dividend_yield_ttm", - "type": "float", - "description": "The trailing twelve month annual dividend yield of the fund, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "year_high", - "type": "float", - "description": "The fifty-two week high price.", - "default": null, - "optional": true - }, - { - "name": "year_low", - "type": "float", - "description": "The fifty-two week low price.", - "default": null, - "optional": true - }, - { - "name": "ma_50d", - "type": "float", - "description": "50-day moving average price.", - "default": null, - "optional": true - }, - { - "name": "ma_200d", - "type": "float", - "description": "200-day moving average price.", - "default": null, - "optional": true - }, - { - "name": "return_ytd", - "type": "float", - "description": "The year-to-date return of the fund, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "return_3y_avg", - "type": "float", - "description": "The three year average return of the fund, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "return_5y_avg", - "type": "float", - "description": "The five year average return of the fund, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "beta_3y_avg", - "type": "float", - "description": "The three year average beta of the fund.", - "default": null, - "optional": true - }, - { - "name": "volume_avg", - "type": "float", - "description": "The average daily trading volume of the fund.", - "default": null, - "optional": true - }, - { - "name": "volume_avg_10d", - "type": "float", - "description": "The average daily trading volume of the fund over the past ten days.", - "default": null, - "optional": true - }, - { - "name": "bid", - "type": "float", - "description": "The current bid price.", - "default": null, - "optional": true - }, - { - "name": "bid_size", - "type": "float", - "description": "The current bid size.", - "default": null, - "optional": true - }, - { - "name": "ask", - "type": "float", - "description": "The current ask price.", - "default": null, - "optional": true - }, - { - "name": "ask_size", - "type": "float", - "description": "The current ask size.", - "default": null, - "optional": true - }, - { - "name": "open", - "type": "float", - "description": "The open price of the most recent trading session.", - "default": null, - "optional": true - }, - { - "name": "high", - "type": "float", - "description": "The highest price of the most recent trading session.", - "default": null, - "optional": true - }, - { - "name": "low", - "type": "float", - "description": "The lowest price of the most recent trading session.", - "default": null, - "optional": true - }, - { - "name": "volume", - "type": "int", - "description": "The trading volume of the most recent trading session.", - "default": null, - "optional": true - }, - { - "name": "prev_close", - "type": "float", - "description": "The previous closing price.", - "default": null, - "optional": true - } - ] - }, - "model": "EtfInfo" - }, - "/etf/sectors": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "ETF Sector weighting.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.sectors(symbol='SPY', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for. (ETF)", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for. (ETF)", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EtfSectors]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "sector", - "type": "str", - "description": "Sector of exposure.", - "default": "", - "optional": false - }, - { - "name": "weight", - "type": "float", - "description": "Exposure of the ETF to the sector in normalized percentage points.", - "default": "", - "optional": false - } - ], - "fmp": [ - { - "name": "sector", - "type": "str", - "description": "Sector of exposure.", - "default": "", - "optional": false - }, - { - "name": "weight", - "type": "float", - "description": "Exposure of the ETF to the sector in normalized percentage points.", - "default": "", - "optional": false - } - ] - }, - "model": "EtfSectors" - }, - "/etf/countries": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "ETF Country weighting.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.countries(symbol='VT', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp.", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for. (ETF)", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EtfCountries]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "country", - "type": "str", - "description": "The country of the exposure. Corresponding values are normalized percentage points.", - "default": "", - "optional": false - } - ], - "fmp": [ - { - "name": "country", - "type": "str", - "description": "The country of the exposure. Corresponding values are normalized percentage points.", - "default": "", - "optional": false - } - ] - }, - "model": "EtfCountries" - }, - "/etf/price_performance": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Price performance as a return, over different periods.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.price_performance(symbol='QQQ', provider='fmp')\nobb.etf.price_performance(symbol='SPY,QQQ,IWM,DJIA', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['fmp', 'intrinio']", - "description": "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.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - } - ], - "intrinio": [ - { - "name": "return_type", - "type": "Literal['trailing', 'calendar']", - "description": "The type of returns to return, a trailing or calendar window.", - "default": "trailing", - "optional": true - }, - { - "name": "adjustment", - "type": "Literal['splits_only', 'splits_and_dividends']", - "description": "The adjustment factor, 'splits_only' will return pure price performance.", - "default": "splits_and_dividends", - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EtfPricePerformance]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", + "name": "exchange_timezone", "type": "str", - "description": "Symbol representing the entity requested in the data.", + "description": "The timezone of the exchange.", "default": null, "optional": true }, { - "name": "one_day", - "type": "float", - "description": "One-day return.", + "name": "currency", + "type": "str", + "description": "The currency in which the fund is listed.", "default": null, "optional": true }, { - "name": "wtd", + "name": "nav_price", "type": "float", - "description": "Week to date return.", + "description": "The net asset value per unit of the fund.", "default": null, "optional": true }, { - "name": "one_week", - "type": "float", - "description": "One-week return.", + "name": "total_assets", + "type": "int", + "description": "The total value of assets held by the fund.", "default": null, "optional": true }, { - "name": "mtd", + "name": "trailing_pe", "type": "float", - "description": "Month to date return.", + "description": "The trailing twelve month P/E ratio of the fund's assets.", "default": null, "optional": true }, { - "name": "one_month", + "name": "dividend_yield", "type": "float", - "description": "One-month return.", + "description": "The dividend yield of the fund, as a normalized percent.", "default": null, "optional": true }, { - "name": "qtd", + "name": "dividend_rate_ttm", "type": "float", - "description": "Quarter to date return.", + "description": "The trailing twelve month annual dividend rate of the fund, in currency units.", "default": null, "optional": true }, { - "name": "three_month", + "name": "dividend_yield_ttm", "type": "float", - "description": "Three-month return.", + "description": "The trailing twelve month annual dividend yield of the fund, as a normalized percent.", "default": null, "optional": true }, { - "name": "six_month", + "name": "year_high", "type": "float", - "description": "Six-month return.", + "description": "The fifty-two week high price.", "default": null, "optional": true }, { - "name": "ytd", + "name": "year_low", "type": "float", - "description": "Year to date return.", + "description": "The fifty-two week low price.", "default": null, "optional": true }, { - "name": "one_year", + "name": "ma_50d", "type": "float", - "description": "One-year return.", + "description": "50-day moving average price.", "default": null, "optional": true }, { - "name": "two_year", + "name": "ma_200d", "type": "float", - "description": "Two-year return.", + "description": "200-day moving average price.", "default": null, "optional": true }, { - "name": "three_year", + "name": "return_ytd", "type": "float", - "description": "Three-year return.", + "description": "The year-to-date return of the fund, as a normalized percent.", "default": null, "optional": true }, { - "name": "four_year", + "name": "return_3y_avg", "type": "float", - "description": "Four-year", + "description": "The three year average return of the fund, as a normalized percent.", "default": null, "optional": true }, { - "name": "five_year", + "name": "return_5y_avg", "type": "float", - "description": "Five-year return.", + "description": "The five year average return of the fund, as a normalized percent.", "default": null, "optional": true }, { - "name": "ten_year", + "name": "beta_3y_avg", "type": "float", - "description": "Ten-year return.", + "description": "The three year average beta of the fund.", "default": null, "optional": true }, { - "name": "max", + "name": "volume_avg", "type": "float", - "description": "Return from the beginning of the time series.", + "description": "The average daily trading volume of the fund.", "default": null, "optional": true - } - ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "The ticker symbol.", - "default": "", - "optional": false - } - ], - "intrinio": [ + }, { - "name": "max_annualized", + "name": "volume_avg_10d", "type": "float", - "description": "Annualized rate of return from inception.", + "description": "The average daily trading volume of the fund over the past ten days.", "default": null, "optional": true }, { - "name": "volatility_one_year", + "name": "bid", "type": "float", - "description": "Trailing one-year annualized volatility.", + "description": "The current bid price.", "default": null, "optional": true }, { - "name": "volatility_three_year", + "name": "bid_size", "type": "float", - "description": "Trailing three-year annualized volatility.", + "description": "The current bid size.", "default": null, "optional": true }, { - "name": "volatility_five_year", + "name": "ask", "type": "float", - "description": "Trailing five-year annualized volatility.", + "description": "The current ask price.", "default": null, "optional": true }, { - "name": "volume", - "type": "int", - "description": "The trading volume.", + "name": "ask_size", + "type": "float", + "description": "The current ask size.", "default": null, "optional": true }, { - "name": "volume_avg_30", + "name": "open", "type": "float", - "description": "The one-month average daily volume.", + "description": "The open price of the most recent trading session.", "default": null, "optional": true }, { - "name": "volume_avg_90", + "name": "high", "type": "float", - "description": "The three-month average daily volume.", + "description": "The highest price of the most recent trading session.", "default": null, "optional": true }, { - "name": "volume_avg_180", + "name": "low", "type": "float", - "description": "The six-month average daily volume.", + "description": "The lowest price of the most recent trading session.", "default": null, "optional": true }, { - "name": "beta", - "type": "float", - "description": "Beta compared to the S&P 500.", + "name": "volume", + "type": "int", + "description": "The trading volume of the most recent trading session.", "default": null, "optional": true }, { - "name": "nav", + "name": "prev_close", "type": "float", - "description": "Net asset value per share.", + "description": "The previous closing price.", "default": null, "optional": true + } + ] + }, + "model": "EtfInfo" + }, + "/etf/sectors": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "ETF Sector weighting.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.sectors(symbol='SPY', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false }, { - "name": "year_high", - "type": "float", - "description": "The 52-week high price.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfSectors]", + "description": "Serializable results." }, { - "name": "year_low", - "type": "float", - "description": "The 52-week low price.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "market_cap", + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "sector", + "type": "str", + "description": "Sector of exposure.", + "default": "", + "optional": false + }, + { + "name": "weight", "type": "float", - "description": "The market capitalization.", - "default": null, - "optional": true + "description": "Exposure of the ETF to the sector in normalized percentage points.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "EtfSectors" + }, + "/etf/countries": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "ETF Country weighting.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.countries(symbol='VT', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false }, { - "name": "shares_outstanding", - "type": "int", - "description": "The number of shares outstanding.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfCountries]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "updated", - "type": "date", - "description": "The date of the data.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } ] }, - "model": "EtfPricePerformance" + "data": { + "standard": [ + { + "name": "country", + "type": "str", + "description": "The country of the exposure. Corresponding values are normalized percentage points.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "EtfCountries" }, - "/etf/holdings": { + "/etf/price_performance": { "deprecated": { "flag": null, "message": null }, - "description": "Get the holdings for an individual ETF.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings(symbol='XLK', provider='fmp')\n# Including a date (FMP, SEC) will return the holdings as per NPORT-P filings.\nobb.etf.holdings(symbol='XLK', date=2022-03-31, provider='fmp')\n# The same data can be returned from the SEC directly.\nobb.etf.holdings(symbol='XLK', date=2022-03-31, provider='sec')\n```\n\n", + "description": "Price performance as a return, over different periods.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.price_performance(symbol='QQQ', provider='fmp')\nobb.etf.price_performance(symbol='SPY,QQQ,IWM,DJIA', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for. (ETF)", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", "default": "", "optional": false }, { "name": "provider", - "type": "Literal['fmp', 'intrinio', 'sec']", + "type": "Literal['fmp', 'intrinio']", "description": "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.", "default": "fmp", "optional": true } ], - "fmp": [ - { - "name": "date", - "type": "Union[Union[str, date], str]", - "description": "A specific date to get data for. Entering a date will attempt to return the NPORT-P filing for the entered date. This needs to be _exactly_ the date of the filing. Use the holdings_date command/endpoint to find available filing dates for the ETF.", - "default": null, - "optional": true - }, - { - "name": "cik", - "type": "str", - "description": "The CIK of the filing entity. Overrides symbol.", - "default": null, - "optional": true - } - ], + "fmp": [], "intrinio": [ { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", - "default": null, - "optional": true - } - ], - "sec": [ - { - "name": "date", - "type": "Union[Union[str, date], str]", - "description": "A specific date to get data for. The date represents the period ending. The date entered will return the closest filing.", - "default": null, + "name": "return_type", + "type": "Literal['trailing', 'calendar']", + "description": "The type of returns to return, a trailing or calendar window.", + "default": "trailing", "optional": true }, { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache for the request.", - "default": true, + "name": "adjustment", + "type": "Literal['splits_only', 'splits_and_dividends']", + "description": "The adjustment factor, 'splits_only' will return pure price performance.", + "default": "splits_and_dividends", "optional": true } ] @@ -27519,12 +22957,12 @@ "OBBject": [ { "name": "results", - "type": "List[EtfHoldings]", + "type": "List[EtfPricePerformance]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'sec']]", + "type": "Optional[Literal['fmp', 'intrinio']]", "description": "Provider name." }, { @@ -27549,296 +22987,355 @@ { "name": "symbol", "type": "str", - "description": "Symbol representing the entity requested in the data. (ETF)", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "name", - "type": "str", - "description": "Name of the ETF holding.", + "name": "one_day", + "type": "float", + "description": "One-day return.", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "lei", - "type": "str", - "description": "The LEI of the holding.", + "name": "wtd", + "type": "float", + "description": "Week to date return.", "default": null, "optional": true }, { - "name": "title", - "type": "str", - "description": "The title of the holding.", + "name": "one_week", + "type": "float", + "description": "One-week return.", "default": null, "optional": true }, { - "name": "cusip", - "type": "str", - "description": "The CUSIP of the holding.", + "name": "mtd", + "type": "float", + "description": "Month to date return.", "default": null, "optional": true }, { - "name": "isin", - "type": "str", - "description": "The ISIN of the holding.", + "name": "one_month", + "type": "float", + "description": "One-month return.", "default": null, "optional": true }, { - "name": "balance", - "type": "int", - "description": "The balance of the holding, in shares or units.", + "name": "qtd", + "type": "float", + "description": "Quarter to date return.", "default": null, "optional": true }, { - "name": "units", - "type": "Union[str, float]", - "description": "The type of units.", + "name": "three_month", + "type": "float", + "description": "Three-month return.", "default": null, "optional": true }, { - "name": "currency", - "type": "str", - "description": "The currency of the holding.", + "name": "six_month", + "type": "float", + "description": "Six-month return.", "default": null, "optional": true }, { - "name": "value", + "name": "ytd", "type": "float", - "description": "The value of the holding, in dollars.", + "description": "Year to date return.", "default": null, "optional": true }, { - "name": "weight", + "name": "one_year", "type": "float", - "description": "The weight of the holding, as a normalized percent.", + "description": "One-year return.", "default": null, "optional": true }, { - "name": "payoff_profile", - "type": "str", - "description": "The payoff profile of the holding.", + "name": "two_year", + "type": "float", + "description": "Two-year return.", "default": null, "optional": true }, { - "name": "asset_category", - "type": "str", - "description": "The asset category of the holding.", + "name": "three_year", + "type": "float", + "description": "Three-year return.", "default": null, "optional": true }, { - "name": "issuer_category", - "type": "str", - "description": "The issuer category of the holding.", + "name": "four_year", + "type": "float", + "description": "Four-year", "default": null, "optional": true }, { - "name": "country", - "type": "str", - "description": "The country of the holding.", + "name": "five_year", + "type": "float", + "description": "Five-year return.", "default": null, "optional": true }, { - "name": "is_restricted", - "type": "str", - "description": "Whether the holding is restricted.", + "name": "ten_year", + "type": "float", + "description": "Ten-year return.", "default": null, "optional": true }, { - "name": "fair_value_level", - "type": "int", - "description": "The fair value level of the holding.", + "name": "max", + "type": "float", + "description": "Return from the beginning of the time series.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "is_cash_collateral", + "name": "symbol", "type": "str", - "description": "Whether the holding is cash collateral.", + "description": "The ticker symbol.", + "default": "", + "optional": false + } + ], + "intrinio": [ + { + "name": "max_annualized", + "type": "float", + "description": "Annualized rate of return from inception.", "default": null, "optional": true }, { - "name": "is_non_cash_collateral", - "type": "str", - "description": "Whether the holding is non-cash collateral.", + "name": "volatility_one_year", + "type": "float", + "description": "Trailing one-year annualized volatility.", "default": null, "optional": true }, { - "name": "is_loan_by_fund", - "type": "str", - "description": "Whether the holding is loan by fund.", + "name": "volatility_three_year", + "type": "float", + "description": "Trailing three-year annualized volatility.", "default": null, "optional": true }, { - "name": "cik", - "type": "str", - "description": "The CIK of the filing.", + "name": "volatility_five_year", + "type": "float", + "description": "Trailing five-year annualized volatility.", "default": null, "optional": true }, { - "name": "acceptance_datetime", - "type": "str", - "description": "The acceptance datetime of the filing.", + "name": "volume", + "type": "int", + "description": "The trading volume.", "default": null, "optional": true }, { - "name": "updated", - "type": "Union[date, datetime]", - "description": "The date the data was updated.", + "name": "volume_avg_30", + "type": "float", + "description": "The one-month average daily volume.", "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "name", - "type": "str", - "description": "The common name for the holding.", + "name": "volume_avg_90", + "type": "float", + "description": "The three-month average daily volume.", "default": null, "optional": true }, { - "name": "security_type", - "type": "str", - "description": "The type of instrument for this holding. Examples(Bond='BOND', Equity='EQUI')", + "name": "volume_avg_180", + "type": "float", + "description": "The six-month average daily volume.", "default": null, "optional": true }, { - "name": "isin", - "type": "str", - "description": "The International Securities Identification Number.", + "name": "beta", + "type": "float", + "description": "Beta compared to the S&P 500.", "default": null, "optional": true }, { - "name": "ric", - "type": "str", - "description": "The Reuters Instrument Code.", + "name": "nav", + "type": "float", + "description": "Net asset value per share.", "default": null, "optional": true }, { - "name": "sedol", - "type": "str", - "description": "The Stock Exchange Daily Official List.", + "name": "year_high", + "type": "float", + "description": "The 52-week high price.", "default": null, "optional": true }, { - "name": "share_class_figi", - "type": "str", - "description": "The OpenFIGI symbol for the holding.", + "name": "year_low", + "type": "float", + "description": "The 52-week low price.", "default": null, "optional": true }, { - "name": "country", - "type": "str", - "description": "The country or region of the holding.", + "name": "market_cap", + "type": "float", + "description": "The market capitalization.", "default": null, "optional": true }, { - "name": "maturity_date", - "type": "date", - "description": "The maturity date for the debt security, if available.", + "name": "shares_outstanding", + "type": "int", + "description": "The number of shares outstanding.", "default": null, "optional": true }, { - "name": "contract_expiry_date", + "name": "updated", "type": "date", - "description": "Expiry date for the futures contract held, if available.", + "description": "The date of the data.", "default": null, "optional": true + } + ] + }, + "model": "EtfPricePerformance" + }, + "/etf/holdings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the holdings for an individual ETF.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings(symbol='XLK', provider='fmp')\n# Including a date (FMP, SEC) will return the holdings as per NPORT-P filings.\nobb.etf.holdings(symbol='XLK', date=2022-03-31, provider='fmp')\n# The same data can be returned from the SEC directly.\nobb.etf.holdings(symbol='XLK', date=2022-03-31, provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false }, { - "name": "coupon", - "type": "float", - "description": "The coupon rate of the debt security, if available.", - "default": null, + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'sec']", + "description": "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.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "balance", - "type": "Union[int, float]", - "description": "The number of units of the security held, if available.", + "name": "date", + "type": "Union[Union[str, date], str]", + "description": "A specific date to get data for. Entering a date will attempt to return the NPORT-P filing for the entered date. This needs to be _exactly_ the date of the filing. Use the holdings_date command/endpoint to find available filing dates for the ETF.", "default": null, "optional": true }, { - "name": "unit", + "name": "cik", "type": "str", - "description": "The units of the 'balance' field.", + "description": "The CIK of the filing entity. Overrides symbol.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "units_per_share", - "type": "float", - "description": "Number of units of the security held per share outstanding of the ETF, if available.", + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", "default": null, "optional": true - }, + } + ], + "sec": [ { - "name": "face_value", - "type": "float", - "description": "The face value of the debt security, if available.", + "name": "date", + "type": "Union[Union[str, date], str]", + "description": "A specific date to get data for. The date represents the period ending. The date entered will return the closest filing.", "default": null, "optional": true }, { - "name": "derivatives_value", - "type": "float", - "description": "The notional value of derivatives contracts held.", - "default": null, + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache for the request.", + "default": true, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfHoldings]", + "description": "Serializable results." }, { - "name": "value", - "type": "float", - "description": "The market value of the holding, on the 'as_of' date.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'sec']]", + "description": "Provider name." }, { - "name": "weight", - "type": "float", - "description": "The weight of the holding, as a normalized percent.", + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. (ETF)", "default": null, "optional": true }, { - "name": "updated", - "type": "date", - "description": "The 'as_of' date for the holding.", + "name": "name", + "type": "str", + "description": "Name of the ETF holding.", "default": null, "optional": true } ], - "sec": [ + "fmp": [ { "name": "lei", "type": "str", @@ -27847,65 +23344,65 @@ "optional": true }, { - "name": "cusip", + "name": "title", "type": "str", - "description": "The CUSIP of the holding.", + "description": "The title of the holding.", "default": null, "optional": true }, { - "name": "isin", + "name": "cusip", "type": "str", - "description": "The ISIN of the holding.", + "description": "The CUSIP of the holding.", "default": null, "optional": true }, { - "name": "other_id", + "name": "isin", "type": "str", - "description": "Internal identifier for the holding.", + "description": "The ISIN of the holding.", "default": null, "optional": true }, { "name": "balance", - "type": "float", - "description": "The balance of the holding.", + "type": "int", + "description": "The balance of the holding, in shares or units.", "default": null, "optional": true }, { - "name": "weight", - "type": "float", - "description": "The weight of the holding in ETF in %.", + "name": "units", + "type": "Union[str, float]", + "description": "The type of units.", "default": null, "optional": true }, { - "name": "value", - "type": "float", - "description": "The value of the holding in USD.", + "name": "currency", + "type": "str", + "description": "The currency of the holding.", "default": null, "optional": true }, { - "name": "payoff_profile", - "type": "str", - "description": "The payoff profile of the holding.", + "name": "value", + "type": "float", + "description": "The value of the holding, in dollars.", "default": null, "optional": true }, { - "name": "units", - "type": "Union[str, float]", - "description": "The units of the holding.", + "name": "weight", + "type": "float", + "description": "The weight of the holding, as a normalized percent.", "default": null, "optional": true }, { - "name": "currency", + "name": "payoff_profile", "type": "str", - "description": "The currency of the holding.", + "description": "The payoff profile of the holding.", "default": null, "optional": true }, @@ -27966,854 +23463,701 @@ "optional": true }, { - "name": "loan_value", - "type": "float", - "description": "The loan value of the holding.", - "default": null, - "optional": true - }, - { - "name": "issuer_conditional", - "type": "str", - "description": "The issuer conditions of the holding.", - "default": null, - "optional": true - }, - { - "name": "asset_conditional", - "type": "str", - "description": "The asset conditions of the holding.", - "default": null, - "optional": true - }, - { - "name": "maturity_date", - "type": "date", - "description": "The maturity date of the debt security.", - "default": null, - "optional": true - }, - { - "name": "coupon_kind", - "type": "str", - "description": "The type of coupon for the debt security.", - "default": null, - "optional": true - }, - { - "name": "rate_type", + "name": "cik", "type": "str", - "description": "The type of rate for the debt security, floating or fixed.", - "default": null, - "optional": true - }, - { - "name": "annualized_return", - "type": "float", - "description": "The annualized return on the debt security.", + "description": "The CIK of the filing.", "default": null, "optional": true }, { - "name": "is_default", + "name": "acceptance_datetime", "type": "str", - "description": "If the debt security is defaulted.", + "description": "The acceptance datetime of the filing.", "default": null, "optional": true }, { - "name": "in_arrears", - "type": "str", - "description": "If the debt security is in arrears.", + "name": "updated", + "type": "Union[date, datetime]", + "description": "The date the data was updated.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "is_paid_kind", + "name": "name", "type": "str", - "description": "If the debt security payments are paid in kind.", + "description": "The common name for the holding.", "default": null, "optional": true }, { - "name": "derivative_category", + "name": "security_type", "type": "str", - "description": "The derivative category of the holding.", + "description": "The type of instrument for this holding. Examples(Bond='BOND', Equity='EQUI')", "default": null, "optional": true }, { - "name": "counterparty", + "name": "isin", "type": "str", - "description": "The counterparty of the derivative.", + "description": "The International Securities Identification Number.", "default": null, "optional": true }, { - "name": "underlying_name", + "name": "ric", "type": "str", - "description": "The name of the underlying asset associated with the derivative.", + "description": "The Reuters Instrument Code.", "default": null, "optional": true }, { - "name": "option_type", + "name": "sedol", "type": "str", - "description": "The type of option.", + "description": "The Stock Exchange Daily Official List.", "default": null, "optional": true }, { - "name": "derivative_payoff", + "name": "share_class_figi", "type": "str", - "description": "The payoff profile of the derivative.", + "description": "The OpenFIGI symbol for the holding.", "default": null, "optional": true }, { - "name": "expiry_date", - "type": "date", - "description": "The expiry or termination date of the derivative.", + "name": "country", + "type": "str", + "description": "The country or region of the holding.", "default": null, "optional": true }, { - "name": "exercise_price", - "type": "float", - "description": "The exercise price of the option.", + "name": "maturity_date", + "type": "date", + "description": "The maturity date for the debt security, if available.", "default": null, "optional": true }, { - "name": "exercise_currency", - "type": "str", - "description": "The currency of the option exercise price.", + "name": "contract_expiry_date", + "type": "date", + "description": "Expiry date for the futures contract held, if available.", "default": null, "optional": true }, { - "name": "shares_per_contract", + "name": "coupon", "type": "float", - "description": "The number of shares per contract.", + "description": "The coupon rate of the debt security, if available.", "default": null, "optional": true }, { - "name": "delta", - "type": "Union[str, float]", - "description": "The delta of the option.", + "name": "balance", + "type": "Union[int, float]", + "description": "The number of units of the security held, if available.", "default": null, "optional": true }, { - "name": "rate_type_rec", + "name": "unit", "type": "str", - "description": "The type of rate for receivable portion of the swap.", + "description": "The units of the 'balance' field.", "default": null, "optional": true }, { - "name": "receive_currency", - "type": "str", - "description": "The receive currency of the swap.", + "name": "units_per_share", + "type": "float", + "description": "Number of units of the security held per share outstanding of the ETF, if available.", "default": null, "optional": true }, { - "name": "upfront_receive", + "name": "face_value", "type": "float", - "description": "The upfront amount received of the swap.", + "description": "The face value of the debt security, if available.", "default": null, "optional": true }, { - "name": "floating_rate_index_rec", - "type": "str", - "description": "The floating rate index for receivable portion of the swap.", + "name": "derivatives_value", + "type": "float", + "description": "The notional value of derivatives contracts held.", "default": null, "optional": true }, { - "name": "floating_rate_spread_rec", + "name": "value", "type": "float", - "description": "The floating rate spread for reveivable portion of the swap.", + "description": "The market value of the holding, on the 'as_of' date.", "default": null, "optional": true }, { - "name": "rate_tenor_rec", - "type": "str", - "description": "The rate tenor for receivable portion of the swap.", + "name": "weight", + "type": "float", + "description": "The weight of the holding, as a normalized percent.", "default": null, "optional": true }, { - "name": "rate_tenor_unit_rec", - "type": "Union[int, str]", - "description": "The rate tenor unit for receivable portion of the swap.", + "name": "updated", + "type": "date", + "description": "The 'as_of' date for the holding.", "default": null, "optional": true - }, + } + ], + "sec": [ { - "name": "reset_date_rec", + "name": "lei", "type": "str", - "description": "The reset date for receivable portion of the swap.", + "description": "The LEI of the holding.", "default": null, "optional": true }, { - "name": "reset_date_unit_rec", - "type": "Union[int, str]", - "description": "The reset date unit for receivable portion of the swap.", + "name": "cusip", + "type": "str", + "description": "The CUSIP of the holding.", "default": null, "optional": true }, { - "name": "rate_type_pmnt", + "name": "isin", "type": "str", - "description": "The type of rate for payment portion of the swap.", + "description": "The ISIN of the holding.", "default": null, "optional": true }, { - "name": "payment_currency", + "name": "other_id", "type": "str", - "description": "The payment currency of the swap.", + "description": "Internal identifier for the holding.", "default": null, "optional": true }, { - "name": "upfront_payment", + "name": "balance", "type": "float", - "description": "The upfront amount received of the swap.", + "description": "The balance of the holding.", "default": null, "optional": true }, { - "name": "floating_rate_index_pmnt", - "type": "str", - "description": "The floating rate index for payment portion of the swap.", + "name": "weight", + "type": "float", + "description": "The weight of the holding in ETF in %.", "default": null, "optional": true }, { - "name": "floating_rate_spread_pmnt", + "name": "value", "type": "float", - "description": "The floating rate spread for payment portion of the swap.", + "description": "The value of the holding in USD.", "default": null, "optional": true }, { - "name": "rate_tenor_pmnt", + "name": "payoff_profile", "type": "str", - "description": "The rate tenor for payment portion of the swap.", + "description": "The payoff profile of the holding.", "default": null, "optional": true }, { - "name": "rate_tenor_unit_pmnt", - "type": "Union[int, str]", - "description": "The rate tenor unit for payment portion of the swap.", + "name": "units", + "type": "Union[str, float]", + "description": "The units of the holding.", "default": null, "optional": true }, { - "name": "reset_date_pmnt", + "name": "currency", "type": "str", - "description": "The reset date for payment portion of the swap.", + "description": "The currency of the holding.", "default": null, "optional": true }, { - "name": "reset_date_unit_pmnt", - "type": "Union[int, str]", - "description": "The reset date unit for payment portion of the swap.", + "name": "asset_category", + "type": "str", + "description": "The asset category of the holding.", "default": null, "optional": true }, { - "name": "repo_type", + "name": "issuer_category", "type": "str", - "description": "The type of repo.", + "description": "The issuer category of the holding.", "default": null, "optional": true }, { - "name": "is_cleared", + "name": "country", "type": "str", - "description": "If the repo is cleared.", + "description": "The country of the holding.", "default": null, "optional": true }, { - "name": "is_tri_party", + "name": "is_restricted", "type": "str", - "description": "If the repo is tri party.", + "description": "Whether the holding is restricted.", "default": null, "optional": true }, { - "name": "principal_amount", - "type": "float", - "description": "The principal amount of the repo.", + "name": "fair_value_level", + "type": "int", + "description": "The fair value level of the holding.", "default": null, "optional": true }, { - "name": "principal_currency", + "name": "is_cash_collateral", "type": "str", - "description": "The currency of the principal amount.", + "description": "Whether the holding is cash collateral.", "default": null, "optional": true }, { - "name": "collateral_type", + "name": "is_non_cash_collateral", "type": "str", - "description": "The collateral type of the repo.", + "description": "Whether the holding is non-cash collateral.", "default": null, "optional": true }, { - "name": "collateral_amount", + "name": "is_loan_by_fund", + "type": "str", + "description": "Whether the holding is loan by fund.", + "default": null, + "optional": true + }, + { + "name": "loan_value", "type": "float", - "description": "The collateral amount of the repo.", + "description": "The loan value of the holding.", "default": null, "optional": true }, { - "name": "collateral_currency", + "name": "issuer_conditional", "type": "str", - "description": "The currency of the collateral amount.", + "description": "The issuer conditions of the holding.", "default": null, "optional": true }, { - "name": "exchange_currency", + "name": "asset_conditional", "type": "str", - "description": "The currency of the exchange rate.", + "description": "The asset conditions of the holding.", "default": null, "optional": true }, { - "name": "exchange_rate", - "type": "float", - "description": "The exchange rate.", + "name": "maturity_date", + "type": "date", + "description": "The maturity date of the debt security.", "default": null, "optional": true }, { - "name": "currency_sold", + "name": "coupon_kind", "type": "str", - "description": "The currency sold in a Forward Derivative.", + "description": "The type of coupon for the debt security.", "default": null, "optional": true }, { - "name": "currency_amount_sold", + "name": "rate_type", + "type": "str", + "description": "The type of rate for the debt security, floating or fixed.", + "default": null, + "optional": true + }, + { + "name": "annualized_return", "type": "float", - "description": "The amount of currency sold in a Forward Derivative.", + "description": "The annualized return on the debt security.", "default": null, "optional": true }, { - "name": "currency_bought", + "name": "is_default", "type": "str", - "description": "The currency bought in a Forward Derivative.", + "description": "If the debt security is defaulted.", "default": null, "optional": true }, { - "name": "currency_amount_bought", - "type": "float", - "description": "The amount of currency bought in a Forward Derivative.", + "name": "in_arrears", + "type": "str", + "description": "If the debt security is in arrears.", "default": null, "optional": true }, { - "name": "notional_amount", - "type": "float", - "description": "The notional amount of the derivative.", + "name": "is_paid_kind", + "type": "str", + "description": "If the debt security payments are paid in kind.", "default": null, "optional": true }, { - "name": "notional_currency", + "name": "derivative_category", "type": "str", - "description": "The currency of the derivative's notional amount.", + "description": "The derivative category of the holding.", "default": null, "optional": true }, { - "name": "unrealized_gain", - "type": "float", - "description": "The unrealized gain or loss on the derivative.", + "name": "counterparty", + "type": "str", + "description": "The counterparty of the derivative.", "default": null, "optional": true - } - ] - }, - "model": "EtfHoldings" - }, - "/etf/holdings_date": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Use this function to get the holdings dates, if available.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings_date(symbol='XLK', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "symbol", + "name": "underlying_name", "type": "str", - "description": "Symbol to get data for. (ETF)", - "default": "", - "optional": false + "description": "The name of the underlying asset associated with the derivative.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", + "name": "option_type", + "type": "str", + "description": "The type of option.", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "cik", + "name": "derivative_payoff", "type": "str", - "description": "The CIK of the filing entity. Overrides symbol.", + "description": "The payoff profile of the derivative.", "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EtfHoldingsDate]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "expiry_date", + "type": "date", + "description": "The expiry or termination date of the derivative.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "exercise_price", + "type": "float", + "description": "The exercise price of the option.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "exercise_currency", + "type": "str", + "description": "The currency of the option exercise price.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - } - ], - "fmp": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - } - ] - }, - "model": "EtfHoldingsDate" - }, - "/etf/holdings_performance": { - "deprecated": { - "flag": true, - "message": "This endpoint is deprecated; pass a list of holdings symbols directly to `/equity/price/performance` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.2." - }, - "description": "Get the recent price performance of each ticker held in the ETF.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings_performance(symbol='XLK', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", - "default": "", - "optional": false + "name": "shares_per_contract", + "type": "float", + "description": "The number of shares per contract.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", + "name": "delta", + "type": "Union[str, float]", + "description": "The delta of the option.", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "symbol", + "name": "rate_type_rec", "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EtfHoldingsPerformance]", - "description": "Serializable results." + "description": "The type of rate for receivable portion of the swap.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "receive_currency", + "type": "str", + "description": "The receive currency of the swap.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "upfront_receive", + "type": "float", + "description": "The upfront amount received of the swap.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "floating_rate_index_rec", + "type": "str", + "description": "The floating rate index for receivable portion of the swap.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "floating_rate_spread_rec", + "type": "float", + "description": "The floating rate spread for reveivable portion of the swap.", + "default": null, + "optional": true + }, { - "name": "symbol", + "name": "rate_tenor_rec", "type": "str", - "description": "Symbol representing the entity requested in the data.", + "description": "The rate tenor for receivable portion of the swap.", "default": null, "optional": true }, { - "name": "one_day", - "type": "float", - "description": "One-day return.", + "name": "rate_tenor_unit_rec", + "type": "Union[int, str]", + "description": "The rate tenor unit for receivable portion of the swap.", "default": null, "optional": true }, { - "name": "wtd", - "type": "float", - "description": "Week to date return.", + "name": "reset_date_rec", + "type": "str", + "description": "The reset date for receivable portion of the swap.", "default": null, "optional": true }, { - "name": "one_week", - "type": "float", - "description": "One-week return.", + "name": "reset_date_unit_rec", + "type": "Union[int, str]", + "description": "The reset date unit for receivable portion of the swap.", "default": null, "optional": true }, { - "name": "mtd", - "type": "float", - "description": "Month to date return.", + "name": "rate_type_pmnt", + "type": "str", + "description": "The type of rate for payment portion of the swap.", "default": null, "optional": true }, { - "name": "one_month", - "type": "float", - "description": "One-month return.", + "name": "payment_currency", + "type": "str", + "description": "The payment currency of the swap.", "default": null, "optional": true }, { - "name": "qtd", + "name": "upfront_payment", "type": "float", - "description": "Quarter to date return.", + "description": "The upfront amount received of the swap.", "default": null, "optional": true }, { - "name": "three_month", - "type": "float", - "description": "Three-month return.", + "name": "floating_rate_index_pmnt", + "type": "str", + "description": "The floating rate index for payment portion of the swap.", "default": null, "optional": true }, { - "name": "six_month", + "name": "floating_rate_spread_pmnt", "type": "float", - "description": "Six-month return.", + "description": "The floating rate spread for payment portion of the swap.", "default": null, "optional": true }, { - "name": "ytd", - "type": "float", - "description": "Year to date return.", + "name": "rate_tenor_pmnt", + "type": "str", + "description": "The rate tenor for payment portion of the swap.", "default": null, "optional": true }, { - "name": "one_year", - "type": "float", - "description": "One-year return.", + "name": "rate_tenor_unit_pmnt", + "type": "Union[int, str]", + "description": "The rate tenor unit for payment portion of the swap.", "default": null, "optional": true }, { - "name": "two_year", - "type": "float", - "description": "Two-year return.", + "name": "reset_date_pmnt", + "type": "str", + "description": "The reset date for payment portion of the swap.", "default": null, "optional": true }, { - "name": "three_year", - "type": "float", - "description": "Three-year return.", + "name": "reset_date_unit_pmnt", + "type": "Union[int, str]", + "description": "The reset date unit for payment portion of the swap.", "default": null, "optional": true }, { - "name": "four_year", - "type": "float", - "description": "Four-year", + "name": "repo_type", + "type": "str", + "description": "The type of repo.", "default": null, "optional": true }, { - "name": "five_year", - "type": "float", - "description": "Five-year return.", + "name": "is_cleared", + "type": "str", + "description": "If the repo is cleared.", + "default": null, + "optional": true + }, + { + "name": "is_tri_party", + "type": "str", + "description": "If the repo is tri party.", "default": null, "optional": true }, { - "name": "ten_year", + "name": "principal_amount", "type": "float", - "description": "Ten-year return.", + "description": "The principal amount of the repo.", "default": null, "optional": true }, { - "name": "max", - "type": "float", - "description": "Return from the beginning of the time series.", + "name": "principal_currency", + "type": "str", + "description": "The currency of the principal amount.", "default": null, "optional": true - } - ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "The ticker symbol.", - "default": "", - "optional": false - } - ] - }, - "model": "EtfHoldingsPerformance" - }, - "/etf/equity_exposure": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the exposure to ETFs for a specific stock.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.equity_exposure(symbol='MSFT', provider='fmp')\n# This function accepts multiple tickers.\nobb.etf.equity_exposure(symbol='MSFT,AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp.", - "default": "", - "optional": false }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "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.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "symbol", + "name": "collateral_type", "type": "str", - "description": "Symbol to get data for. (Stock)", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EtfEquityExposure]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "description": "The collateral type of the repo.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "collateral_amount", + "type": "float", + "description": "The collateral amount of the repo.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "equity_symbol", + "name": "collateral_currency", "type": "str", - "description": "The symbol of the equity requested.", - "default": "", - "optional": false + "description": "The currency of the collateral amount.", + "default": null, + "optional": true }, { - "name": "etf_symbol", + "name": "exchange_currency", "type": "str", - "description": "The symbol of the ETF with exposure to the requested equity.", - "default": "", - "optional": false + "description": "The currency of the exchange rate.", + "default": null, + "optional": true }, { - "name": "shares", + "name": "exchange_rate", "type": "float", - "description": "The number of shares held in the ETF.", + "description": "The exchange rate.", "default": null, "optional": true }, { - "name": "weight", - "type": "float", - "description": "The weight of the equity in the ETF, as a normalized percent.", + "name": "currency_sold", + "type": "str", + "description": "The currency sold in a Forward Derivative.", "default": null, "optional": true }, { - "name": "market_value", - "type": "Union[int, float]", - "description": "The market value of the equity position in the ETF.", + "name": "currency_amount_sold", + "type": "float", + "description": "The amount of currency sold in a Forward Derivative.", "default": null, "optional": true - } - ], - "fmp": [ - { - "name": "equity_symbol", - "type": "str", - "description": "The symbol of the equity requested.", - "default": "", - "optional": false }, { - "name": "etf_symbol", + "name": "currency_bought", "type": "str", - "description": "The symbol of the ETF with exposure to the requested equity.", - "default": "", - "optional": false + "description": "The currency bought in a Forward Derivative.", + "default": null, + "optional": true }, { - "name": "shares", + "name": "currency_amount_bought", "type": "float", - "description": "The number of shares held in the ETF.", + "description": "The amount of currency bought in a Forward Derivative.", "default": null, "optional": true }, { - "name": "weight", + "name": "notional_amount", "type": "float", - "description": "The weight of the equity in the ETF, as a normalized percent.", + "description": "The notional amount of the derivative.", "default": null, "optional": true }, { - "name": "market_value", - "type": "Union[int, float]", - "description": "The market value of the equity position in the ETF.", + "name": "notional_currency", + "type": "str", + "description": "The currency of the derivative's notional amount.", + "default": null, + "optional": true + }, + { + "name": "unrealized_gain", + "type": "float", + "description": "The unrealized gain or loss on the derivative.", "default": null, "optional": true } ] }, - "model": "EtfEquityExposure" + "model": "EtfHoldings" }, - "/fixedincome/rate/ameribor": { + "/etf/holdings_date": { "deprecated": { "flag": null, "message": null }, - "description": "Ameribor.\n\nAmeribor (short for the American interbank offered rate) is a benchmark interest rate that reflects the true cost of\nshort-term interbank borrowing. This rate is based on transactions in overnight unsecured loans conducted on the\nAmerican Financial Exchange (AFX).", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.ameribor(provider='fred')\nobb.fixedincome.rate.ameribor(parameter=30_day_ma, provider='fred')\n```\n\n", + "description": "Use this function to get the holdings dates, if available.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings_date(symbol='XLK', provider='fmp')\n```\n\n", "parameters": { "standard": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false }, { "name": "provider", - "type": "Literal['fred']", - "description": "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.", - "default": "fred", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true } ], - "fred": [ + "fmp": [ { - "name": "parameter", - "type": "Literal['overnight', 'term_30', 'term_90', '1_week_term_structure', '1_month_term_structure', '3_month_term_structure', '6_month_term_structure', '1_year_term_structure', '2_year_term_structure', '30_day_ma', '90_day_ma']", - "description": "Period of AMERIBOR rate.", - "default": "overnight", + "name": "cik", + "type": "str", + "description": "The CIK of the filing entity. Overrides symbol.", + "default": null, "optional": true } ] @@ -28822,12 +24166,12 @@ "OBBject": [ { "name": "results", - "type": "List[AMERIBOR]", + "type": "List[EtfHoldingsDate]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fred']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -28855,85 +24199,48 @@ "description": "The date of the data.", "default": "", "optional": false - }, - { - "name": "rate", - "type": "float", - "description": "AMERIBOR rate.", - "default": "", - "optional": false } ], - "fred": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "rate", - "type": "float", - "description": "AMERIBOR rate.", - "default": "", - "optional": false - } - ] + "fmp": [] }, - "model": "AMERIBOR" + "model": "EtfHoldingsDate" }, - "/fixedincome/rate/sonia": { + "/etf/holdings_performance": { "deprecated": { - "flag": null, - "message": null + "flag": true, + "message": "This endpoint is deprecated; pass a list of holdings symbols directly to `/equity/price/performance` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.2." }, - "description": "Sterling Overnight Index Average.\n\nSONIA (Sterling Overnight Index Average) is an important interest rate benchmark. SONIA is based on actual\ntransactions and reflects the average of the interest rates that banks pay to borrow sterling overnight from other\nfinancial institutions and other institutional investors.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.sonia(provider='fred')\nobb.fixedincome.rate.sonia(parameter=total_nominal_value, provider='fred')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true + "description": "Get the recent price performance of each ticker held in the ETF.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings_performance(symbol='XLK', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false }, { "name": "provider", - "type": "Literal['fred']", - "description": "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.", - "default": "fred", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", "optional": true } ], - "fred": [ - { - "name": "parameter", - "type": "Literal['rate', 'index', '10th_percentile', '25th_percentile', '75th_percentile', '90th_percentile', 'total_nominal_value']", - "description": "Period of SONIA rate.", - "default": "rate", - "optional": true - } - ] + "fmp": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[SONIA]", + "type": "List[EtfHoldingsPerformance]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fred']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -28956,97 +24263,173 @@ "data": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true }, { - "name": "rate", + "name": "one_day", "type": "float", - "description": "SONIA rate.", - "default": "", - "optional": false - } - ], - "fred": [ + "description": "One-day return.", + "default": null, + "optional": true + }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "wtd", + "type": "float", + "description": "Week to date return.", + "default": null, + "optional": true }, { - "name": "rate", + "name": "one_week", "type": "float", - "description": "SONIA rate.", - "default": "", - "optional": false - } - ] - }, - "model": "SONIA" - }, - "/fixedincome/rate/iorb": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Interest on Reserve Balances.\n\nGet Interest Rate on Reserve Balances data A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.iorb(provider='fred')\n```\n\n", - "parameters": { - "standard": [ + "description": "One-week return.", + "default": null, + "optional": true + }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "mtd", + "type": "float", + "description": "Month to date return.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "one_month", + "type": "float", + "description": "One-month return.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fred']", - "description": "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.", - "default": "fred", + "name": "qtd", + "type": "float", + "description": "Quarter to date return.", + "default": null, "optional": true - } - ], - "fred": [ + }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "three_month", + "type": "float", + "description": "Three-month return.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "six_month", + "type": "float", + "description": "Six-month return.", + "default": null, + "optional": true + }, + { + "name": "ytd", + "type": "float", + "description": "Year to date return.", + "default": null, + "optional": true + }, + { + "name": "one_year", + "type": "float", + "description": "One-year return.", + "default": null, + "optional": true + }, + { + "name": "two_year", + "type": "float", + "description": "Two-year return.", + "default": null, + "optional": true + }, + { + "name": "three_year", + "type": "float", + "description": "Three-year return.", + "default": null, + "optional": true + }, + { + "name": "four_year", + "type": "float", + "description": "Four-year", + "default": null, + "optional": true + }, + { + "name": "five_year", + "type": "float", + "description": "Five-year return.", + "default": null, + "optional": true + }, + { + "name": "ten_year", + "type": "float", + "description": "Ten-year return.", + "default": null, + "optional": true + }, + { + "name": "max", + "type": "float", + "description": "Return from the beginning of the time series.", "default": null, "optional": true } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": "", + "optional": false + } ] }, + "model": "EtfHoldingsPerformance" + }, + "/etf/equity_exposure": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the exposure to ETFs for a specific stock.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.equity_exposure(symbol='MSFT', provider='fmp')\n# This function accepts multiple tickers.\nobb.etf.equity_exposure(symbol='MSFT,AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, "returns": { "OBBject": [ { "name": "results", - "type": "List[IORB]", + "type": "List[EtfEquityExposure]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fred']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -29069,46 +24452,52 @@ "data": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "equity_symbol", + "type": "str", + "description": "The symbol of the equity requested.", "default": "", "optional": false }, { - "name": "rate", - "type": "float", - "description": "IORB rate.", + "name": "etf_symbol", + "type": "str", + "description": "The symbol of the ETF with exposure to the requested equity.", "default": "", "optional": false - } - ], - "fred": [ + }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "shares", + "type": "float", + "description": "The number of shares held in the ETF.", + "default": null, + "optional": true }, { - "name": "rate", + "name": "weight", "type": "float", - "description": "IORB rate.", - "default": "", - "optional": false + "description": "The weight of the equity in the ETF, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "market_value", + "type": "Union[int, float]", + "description": "The market value of the equity position in the ETF.", + "default": null, + "optional": true } - ] + ], + "fmp": [] }, - "model": "IORB" + "model": "EtfEquityExposure" }, - "/fixedincome/rate/effr": { + "/fixedincome/rate/ameribor": { "deprecated": { "flag": null, "message": null }, - "description": "Fed Funds Rate.\n\nGet Effective Federal Funds Rate data. A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.effr(provider='fred')\nobb.fixedincome.rate.effr(parameter=daily, provider='fred')\n```\n\n", + "description": "Ameribor.\n\nAmeribor (short for the American interbank offered rate) is a benchmark interest rate that reflects the true cost of\nshort-term interbank borrowing. This rate is based on transactions in overnight unsecured loans conducted on the\nAmerican Financial Exchange (AFX).", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.ameribor(provider='fred')\nobb.fixedincome.rate.ameribor(parameter=30_day_ma, provider='fred')\n```\n\n", "parameters": { "standard": [ { @@ -29127,34 +24516,18 @@ }, { "name": "provider", - "type": "Literal['federal_reserve', 'fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default.", - "default": "federal_reserve", - "optional": true - } - ], - "federal_reserve": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, + "type": "Literal['fred']", + "description": "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.", + "default": "fred", "optional": true } ], "fred": [ { "name": "parameter", - "type": "Literal['monthly', 'daily', 'weekly', 'daily_excl_weekend', 'annual', 'biweekly', 'volume']", - "description": "Period of FED rate.", - "default": "weekly", + "type": "Literal['overnight', 'term_30', 'term_90', '1_week_term_structure', '1_month_term_structure', '3_month_term_structure', '6_month_term_structure', '1_year_term_structure', '2_year_term_structure', '30_day_ma', '90_day_ma']", + "description": "Period of AMERIBOR rate.", + "default": "overnight", "optional": true } ] @@ -29163,12 +24536,12 @@ "OBBject": [ { "name": "results", - "type": "List[FEDFUNDS]", + "type": "List[AMERIBOR]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['federal_reserve', 'fred']]", + "type": "Optional[Literal['fred']]", "description": "Provider name." }, { @@ -29200,55 +24573,38 @@ { "name": "rate", "type": "float", - "description": "FED rate.", - "default": "", - "optional": false - } - ], - "federal_reserve": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "rate", - "type": "float", - "description": "FED rate.", + "description": "AMERIBOR rate.", "default": "", "optional": false } ], - "fred": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "rate", - "type": "float", - "description": "FED rate.", - "default": "", - "optional": false - } - ] + "fred": [] }, - "model": "FEDFUNDS" + "model": "AMERIBOR" }, - "/fixedincome/rate/effr_forecast": { + "/fixedincome/rate/sonia": { "deprecated": { "flag": null, "message": null }, - "description": "Fed Funds Rate Projections.\n\nThe projections for the federal funds rate are the value of the midpoint of the\nprojected appropriate target range for the federal funds rate or the projected\nappropriate target level for the federal funds rate at the end of the specified\ncalendar year or over the longer run.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.effr_forecast(provider='fred')\nobb.fixedincome.rate.effr_forecast(long_run=True, provider='fred')\n```\n\n", + "description": "Sterling Overnight Index Average.\n\nSONIA (Sterling Overnight Index Average) is an important interest rate benchmark. SONIA is based on actual\ntransactions and reflects the average of the interest rates that banks pay to borrow sterling overnight from other\nfinancial institutions and other institutional investors.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.sonia(provider='fred')\nobb.fixedincome.rate.sonia(parameter=total_nominal_value, provider='fred')\n```\n\n", "parameters": { "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, { "name": "provider", "type": "Literal['fred']", @@ -29259,10 +24615,10 @@ ], "fred": [ { - "name": "long_run", - "type": "bool", - "description": "Flag to show long run projections", - "default": false, + "name": "parameter", + "type": "Literal['rate', 'index', '10th_percentile', '25th_percentile', '75th_percentile', '90th_percentile', 'total_nominal_value']", + "description": "Period of SONIA rate.", + "default": "rate", "optional": true } ] @@ -29271,7 +24627,7 @@ "OBBject": [ { "name": "results", - "type": "List[PROJECTIONS]", + "type": "List[SONIA]", "description": "Serializable results." }, { @@ -29306,123 +24662,24 @@ "optional": false }, { - "name": "range_high", - "type": "float", - "description": "High projection of rates.", - "default": "", - "optional": false - }, - { - "name": "central_tendency_high", - "type": "float", - "description": "Central tendency of high projection of rates.", - "default": "", - "optional": false - }, - { - "name": "median", - "type": "float", - "description": "Median projection of rates.", - "default": "", - "optional": false - }, - { - "name": "range_midpoint", - "type": "float", - "description": "Midpoint projection of rates.", - "default": "", - "optional": false - }, - { - "name": "central_tendency_midpoint", - "type": "float", - "description": "Central tendency of midpoint projection of rates.", - "default": "", - "optional": false - }, - { - "name": "range_low", - "type": "float", - "description": "Low projection of rates.", - "default": "", - "optional": false - }, - { - "name": "central_tendency_low", + "name": "rate", "type": "float", - "description": "Central tendency of low projection of rates.", + "description": "SONIA rate.", "default": "", "optional": false } ], - "fred": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "range_high", - "type": "float", - "description": "High projection of rates.", - "default": "", - "optional": false - }, - { - "name": "central_tendency_high", - "type": "float", - "description": "Central tendency of high projection of rates.", - "default": "", - "optional": false - }, - { - "name": "median", - "type": "float", - "description": "Median projection of rates.", - "default": "", - "optional": false - }, - { - "name": "range_midpoint", - "type": "float", - "description": "Midpoint projection of rates.", - "default": "", - "optional": false - }, - { - "name": "central_tendency_midpoint", - "type": "float", - "description": "Central tendency of midpoint projection of rates.", - "default": "", - "optional": false - }, - { - "name": "range_low", - "type": "float", - "description": "Low projection of rates.", - "default": "", - "optional": false - }, - { - "name": "central_tendency_low", - "type": "float", - "description": "Central tendency of low projection of rates.", - "default": "", - "optional": false - } - ] + "fred": [] }, - "model": "PROJECTIONS" + "model": "SONIA" }, - "/fixedincome/rate/estr": { + "/fixedincome/rate/iorb": { "deprecated": { "flag": null, "message": null }, - "description": "Euro Short-Term Rate.\n\nThe euro short-term rate (\u20acSTR) reflects the wholesale euro unsecured overnight borrowing costs of banks located in\nthe euro area. The \u20acSTR is published on each TARGET2 business day based on transactions conducted and settled on\nthe previous TARGET2 business day (the reporting date \u201cT\u201d) with a maturity date of T+1 which are deemed to have been\nexecuted at arm\u2019s length and thus reflect market rates in an unbiased way.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.estr(provider='fred')\nobb.fixedincome.rate.estr(parameter=number_of_active_banks, provider='fred')\n```\n\n", + "description": "Interest on Reserve Balances.\n\nGet Interest Rate on Reserve Balances data A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.iorb(provider='fred')\n```\n\n", "parameters": { "standard": [ { @@ -29447,21 +24704,13 @@ "optional": true } ], - "fred": [ - { - "name": "parameter", - "type": "Literal['volume_weighted_trimmed_mean_rate', 'number_of_transactions', 'number_of_active_banks', 'total_volume', 'share_of_volume_of_the_5_largest_active_banks', 'rate_at_75th_percentile_of_volume', 'rate_at_25th_percentile_of_volume']", - "description": "Period of ESTR rate.", - "default": "volume_weighted_trimmed_mean_rate", - "optional": true - } - ] + "fred": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[ESTR]", + "type": "List[IORB]", "description": "Serializable results." }, { @@ -29498,37 +24747,22 @@ { "name": "rate", "type": "float", - "description": "ESTR rate.", + "description": "IORB rate.", "default": "", "optional": false } ], - "fred": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "rate", - "type": "float", - "description": "ESTR rate.", - "default": "", - "optional": false - } - ] + "fred": [] }, - "model": "ESTR" + "model": "IORB" }, - "/fixedincome/rate/ecb": { + "/fixedincome/rate/effr": { "deprecated": { "flag": null, "message": null }, - "description": "European Central Bank Interest Rates.\n\nThe Governing Council of the ECB sets the key interest rates for the euro area:\n\n- The interest rate on the main refinancing operations (MRO), which provide\nthe bulk of liquidity to the banking system.\n- The rate on the deposit facility, which banks may use to make overnight deposits with the Eurosystem.\n- The rate on the marginal lending facility, which offers overnight credit to banks from the Eurosystem.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.ecb(provider='fred')\nobb.fixedincome.rate.ecb(interest_rate_type='refinancing', provider='fred')\n```\n\n", + "description": "Fed Funds Rate.\n\nGet Effective Federal Funds Rate data. A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.effr(provider='fred')\nobb.fixedincome.rate.effr(parameter=daily, provider='fred')\n```\n\n", "parameters": { "standard": [ { @@ -29545,41 +24779,21 @@ "default": null, "optional": true }, - { - "name": "interest_rate_type", - "type": "Literal['deposit', 'lending', 'refinancing']", - "description": "The type of interest rate.", - "default": "lending", - "optional": true - }, { "name": "provider", - "type": "Literal['fred']", - "description": "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.", - "default": "fred", + "type": "Literal['federal_reserve', 'fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default.", + "default": "federal_reserve", "optional": true } ], + "federal_reserve": [], "fred": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "interest_rate_type", - "type": "Literal['deposit', 'lending', 'refinancing']", - "description": "The type of interest rate.", - "default": "lending", + "name": "parameter", + "type": "Literal['monthly', 'daily', 'weekly', 'daily_excl_weekend', 'annual', 'biweekly', 'volume']", + "description": "Period of FED rate.", + "default": "weekly", "optional": true } ] @@ -29588,12 +24802,12 @@ "OBBject": [ { "name": "results", - "type": "List[EuropeanCentralBankInterestRates]", + "type": "List[FEDFUNDS]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fred']]", + "type": "Optional[Literal['federal_reserve', 'fred']]", "description": "Provider name." }, { @@ -29625,53 +24839,25 @@ { "name": "rate", "type": "float", - "description": "European Central Bank Interest Rate.", + "description": "FED rate.", "default": "", "optional": false } ], - "fred": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "rate", - "type": "float", - "description": "European Central Bank Interest Rate.", - "default": "", - "optional": false - } - ] + "federal_reserve": [], + "fred": [] }, - "model": "EuropeanCentralBankInterestRates" + "model": "FEDFUNDS" }, - "/fixedincome/rate/dpcredit": { + "/fixedincome/rate/effr_forecast": { "deprecated": { "flag": null, "message": null }, - "description": "Discount Window Primary Credit Rate.\n\nA bank rate is the interest rate a nation's central bank charges to its domestic banks to borrow money.\nThe rates central banks charge are set to stabilize the economy.\nIn the United States, the Federal Reserve System's Board of Governors set the bank rate,\nalso known as the discount rate.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.dpcredit(provider='fred')\nobb.fixedincome.rate.dpcredit(start_date='2023-02-01', end_date='2023-05-01', provider='fred')\n```\n\n", + "description": "Fed Funds Rate Projections.\n\nThe projections for the federal funds rate are the value of the midpoint of the\nprojected appropriate target range for the federal funds rate or the projected\nappropriate target level for the federal funds rate at the end of the specified\ncalendar year or over the longer run.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.effr_forecast(provider='fred')\nobb.fixedincome.rate.effr_forecast(long_run=True, provider='fred')\n```\n\n", "parameters": { "standard": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, { "name": "provider", "type": "Literal['fred']", @@ -29682,10 +24868,10 @@ ], "fred": [ { - "name": "parameter", - "type": "Literal['daily_excl_weekend', 'monthly', 'weekly', 'daily', 'annual']", - "description": "FRED series ID of DWPCR data.", - "default": "daily_excl_weekend", + "name": "long_run", + "type": "bool", + "description": "Flag to show long run projections", + "default": false, "optional": true } ] @@ -29694,7 +24880,7 @@ "OBBject": [ { "name": "results", - "type": "List[DiscountWindowPrimaryCreditRate]", + "type": "List[PROJECTIONS]", "description": "Serializable results." }, { @@ -29729,39 +24915,66 @@ "optional": false }, { - "name": "rate", + "name": "range_high", "type": "float", - "description": "Discount Window Primary Credit Rate.", + "description": "High projection of rates.", "default": "", "optional": false - } - ], - "fred": [ + }, { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "central_tendency_high", + "type": "float", + "description": "Central tendency of high projection of rates.", "default": "", "optional": false }, { - "name": "rate", + "name": "median", "type": "float", - "description": "Discount Window Primary Credit Rate.", + "description": "Median projection of rates.", + "default": "", + "optional": false + }, + { + "name": "range_midpoint", + "type": "float", + "description": "Midpoint projection of rates.", + "default": "", + "optional": false + }, + { + "name": "central_tendency_midpoint", + "type": "float", + "description": "Central tendency of midpoint projection of rates.", + "default": "", + "optional": false + }, + { + "name": "range_low", + "type": "float", + "description": "Low projection of rates.", + "default": "", + "optional": false + }, + { + "name": "central_tendency_low", + "type": "float", + "description": "Central tendency of low projection of rates.", "default": "", "optional": false } - ] + ], + "fred": [] }, - "model": "DiscountWindowPrimaryCreditRate" + "model": "PROJECTIONS" }, - "/fixedincome/spreads/tcm": { + "/fixedincome/rate/estr": { "deprecated": { "flag": null, "message": null }, - "description": "Treasury Constant Maturity.\n\nGet data for 10-Year Treasury Constant Maturity Minus Selected Treasury Constant Maturity.\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S.\nTreasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.tcm(provider='fred')\nobb.fixedincome.spreads.tcm(maturity='2y', provider='fred')\n```\n\n", + "description": "Euro Short-Term Rate.\n\nThe euro short-term rate (\u20acSTR) reflects the wholesale euro unsecured overnight borrowing costs of banks located in\nthe euro area. The \u20acSTR is published on each TARGET2 business day based on transactions conducted and settled on\nthe previous TARGET2 business day (the reporting date \u201cT\u201d) with a maturity date of T+1 which are deemed to have been\nexecuted at arm\u2019s length and thus reflect market rates in an unbiased way.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.estr(provider='fred')\nobb.fixedincome.rate.estr(parameter=number_of_active_banks, provider='fred')\n```\n\n", "parameters": { "standard": [ { @@ -29778,13 +24991,6 @@ "default": null, "optional": true }, - { - "name": "maturity", - "type": "Literal['3m', '2y']", - "description": "The maturity", - "default": "3m", - "optional": true - }, { "name": "provider", "type": "Literal['fred']", @@ -29795,24 +25001,10 @@ ], "fred": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "maturity", - "type": "Literal['3m', '2y']", - "description": "The maturity", - "default": "3m", + "name": "parameter", + "type": "Literal['volume_weighted_trimmed_mean_rate', 'number_of_transactions', 'number_of_active_banks', 'total_volume', 'share_of_volume_of_the_5_largest_active_banks', 'rate_at_75th_percentile_of_volume', 'rate_at_25th_percentile_of_volume']", + "description": "Period of ESTR rate.", + "default": "volume_weighted_trimmed_mean_rate", "optional": true } ] @@ -29821,7 +25013,7 @@ "OBBject": [ { "name": "results", - "type": "List[TreasuryConstantMaturity]", + "type": "List[ESTR]", "description": "Serializable results." }, { @@ -29858,37 +25050,22 @@ { "name": "rate", "type": "float", - "description": "TreasuryConstantMaturity Rate.", + "description": "ESTR rate.", "default": "", "optional": false } ], - "fred": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "rate", - "type": "float", - "description": "TreasuryConstantMaturity Rate.", - "default": "", - "optional": false - } - ] + "fred": [] }, - "model": "TreasuryConstantMaturity" + "model": "ESTR" }, - "/fixedincome/spreads/tcm_effr": { + "/fixedincome/rate/ecb": { "deprecated": { "flag": null, "message": null }, - "description": "Select Treasury Constant Maturity.\n\nGet data for Selected Treasury Constant Maturity Minus Federal Funds Rate\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S.\nTreasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.tcm_effr(provider='fred')\nobb.fixedincome.spreads.tcm_effr(maturity='10y', provider='fred')\n```\n\n", + "description": "European Central Bank Interest Rates.\n\nThe Governing Council of the ECB sets the key interest rates for the euro area:\n\n- The interest rate on the main refinancing operations (MRO), which provide\nthe bulk of liquidity to the banking system.\n- The rate on the deposit facility, which banks may use to make overnight deposits with the Eurosystem.\n- The rate on the marginal lending facility, which offers overnight credit to banks from the Eurosystem.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.ecb(provider='fred')\nobb.fixedincome.rate.ecb(interest_rate_type='refinancing', provider='fred')\n```\n\n", "parameters": { "standard": [ { @@ -29906,10 +25083,10 @@ "optional": true }, { - "name": "maturity", - "type": "Literal['10y', '5y', '1y', '6m', '3m']", - "description": "The maturity", - "default": "10y", + "name": "interest_rate_type", + "type": "Literal['deposit', 'lending', 'refinancing']", + "description": "The type of interest rate.", + "default": "lending", "optional": true }, { @@ -29920,35 +25097,13 @@ "optional": true } ], - "fred": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "maturity", - "type": "Literal['10y', '5y', '1y', '6m', '3m']", - "description": "The maturity", - "default": "10y", - "optional": true - } - ] + "fred": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[SelectedTreasuryConstantMaturity]", + "type": "List[EuropeanCentralBankInterestRates]", "description": "Serializable results." }, { @@ -29985,37 +25140,22 @@ { "name": "rate", "type": "float", - "description": "Selected Treasury Constant Maturity Rate.", + "description": "European Central Bank Interest Rate.", "default": "", "optional": false } ], - "fred": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "rate", - "type": "float", - "description": "Selected Treasury Constant Maturity Rate.", - "default": "", - "optional": false - } - ] + "fred": [] }, - "model": "SelectedTreasuryConstantMaturity" + "model": "EuropeanCentralBankInterestRates" }, - "/fixedincome/spreads/treasury_effr": { + "/fixedincome/rate/dpcredit": { "deprecated": { "flag": null, "message": null }, - "description": "Select Treasury Bill.\n\nGet Selected Treasury Bill Minus Federal Funds Rate.\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of\nauctioned U.S. Treasuries.\nThe value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.treasury_effr(provider='fred')\nobb.fixedincome.spreads.treasury_effr(maturity='6m', provider='fred')\n```\n\n", + "description": "Discount Window Primary Credit Rate.\n\nA bank rate is the interest rate a nation's central bank charges to its domestic banks to borrow money.\nThe rates central banks charge are set to stabilize the economy.\nIn the United States, the Federal Reserve System's Board of Governors set the bank rate,\nalso known as the discount rate.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.dpcredit(provider='fred')\nobb.fixedincome.rate.dpcredit(start_date='2023-02-01', end_date='2023-05-01', provider='fred')\n```\n\n", "parameters": { "standard": [ { @@ -30032,13 +25172,6 @@ "default": null, "optional": true }, - { - "name": "maturity", - "type": "Literal['3m', '6m']", - "description": "The maturity", - "default": "3m", - "optional": true - }, { "name": "provider", "type": "Literal['fred']", @@ -30049,24 +25182,10 @@ ], "fred": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "maturity", - "type": "Literal['3m', '6m']", - "description": "The maturity", - "default": "3m", + "name": "parameter", + "type": "Literal['daily_excl_weekend', 'monthly', 'weekly', 'daily', 'annual']", + "description": "FRED series ID of DWPCR data.", + "default": "daily_excl_weekend", "optional": true } ] @@ -30075,7 +25194,7 @@ "OBBject": [ { "name": "results", - "type": "List[SelectedTreasuryBill]", + "type": "List[DiscountWindowPrimaryCreditRate]", "description": "Serializable results." }, { @@ -30112,51 +25231,43 @@ { "name": "rate", "type": "float", - "description": "SelectedTreasuryBill Rate.", + "description": "Discount Window Primary Credit Rate.", "default": "", "optional": false } ], - "fred": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "rate", - "type": "float", - "description": "SelectedTreasuryBill Rate.", - "default": "", - "optional": false - } - ] + "fred": [] }, - "model": "SelectedTreasuryBill" + "model": "DiscountWindowPrimaryCreditRate" }, - "/fixedincome/government/us_yield_curve": { + "/fixedincome/spreads/tcm": { "deprecated": { "flag": null, "message": null }, - "description": "US Yield Curve. Get United States yield curve.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.us_yield_curve(provider='fred')\nobb.fixedincome.government.us_yield_curve(inflation_adjusted=True, provider='fred')\n```\n\n", + "description": "Treasury Constant Maturity.\n\nGet data for 10-Year Treasury Constant Maturity Minus Selected Treasury Constant Maturity.\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S.\nTreasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.tcm(provider='fred')\nobb.fixedincome.spreads.tcm(maturity='2y', provider='fred')\n```\n\n", "parameters": { "standard": [ { - "name": "date", + "name": "start_date", "type": "Union[date, str]", - "description": "A specific date to get data for. Defaults to the most recent FRED entry.", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "inflation_adjusted", - "type": "bool", - "description": "Get inflation adjusted rates.", - "default": false, + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "maturity", + "type": "Literal['3m', '2y']", + "description": "The maturity", + "default": "3m", "optional": true }, { @@ -30167,28 +25278,13 @@ "optional": true } ], - "fred": [ - { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for. Defaults to the most recent FRED entry.", - "default": null, - "optional": true - }, - { - "name": "inflation_adjusted", - "type": "bool", - "description": "Get inflation adjusted rates.", - "default": false, - "optional": true - } - ] + "fred": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[USYieldCurve]", + "type": "List[TreasuryConstantMaturity]", "description": "Serializable results." }, { @@ -30216,46 +25312,31 @@ "data": { "standard": [ { - "name": "maturity", - "type": "float", - "description": "Maturity of the treasury rate in years.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { "name": "rate", "type": "float", - "description": "Associated rate given in decimal form (0.05 is 5%)", + "description": "TreasuryConstantMaturity Rate.", "default": "", "optional": false } ], - "fred": [ - { - "name": "maturity", - "type": "float", - "description": "Maturity of the treasury rate in years.", - "default": "", - "optional": false - }, - { - "name": "rate", - "type": "float", - "description": "Associated rate given in decimal form (0.05 is 5%)", - "default": "", - "optional": false - } - ] + "fred": [] }, - "model": "USYieldCurve" + "model": "TreasuryConstantMaturity" }, - "/fixedincome/government/treasury_rates": { + "/fixedincome/spreads/tcm_effr": { "deprecated": { "flag": null, "message": null }, - "description": "Government Treasury Rates.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.treasury_rates(provider='fmp')\n```\n\n", + "description": "Select Treasury Constant Maturity.\n\nGet data for Selected Treasury Constant Maturity Minus Federal Funds Rate\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S.\nTreasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.tcm_effr(provider='fred')\nobb.fixedincome.spreads.tcm_effr(maturity='10y', provider='fred')\n```\n\n", "parameters": { "standard": [ { @@ -30273,56 +25354,32 @@ "optional": true }, { - "name": "provider", - "type": "Literal['federal_reserve', 'fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default.", - "default": "federal_reserve", - "optional": true - } - ], - "federal_reserve": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, + "name": "maturity", + "type": "Literal['10y', '5y', '1y', '6m', '3m']", + "description": "The maturity", + "default": "10y", "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", "optional": true } ], - "fmp": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - } - ] + "fred": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[TreasuryRates]", + "type": "List[SelectedTreasuryConstantMaturity]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['federal_reserve', 'fmp']]", + "type": "Optional[Literal['fred']]", "description": "Provider name." }, { @@ -30352,98 +25409,88 @@ "optional": false }, { - "name": "week_4", - "type": "float", - "description": "4 week Treasury bills rate (secondary market).", - "default": null, - "optional": true - }, - { - "name": "month_1", - "type": "float", - "description": "1 month Treasury rate.", - "default": null, - "optional": true - }, - { - "name": "month_2", - "type": "float", - "description": "2 month Treasury rate.", - "default": null, - "optional": true - }, - { - "name": "month_3", - "type": "float", - "description": "3 month Treasury rate.", - "default": null, - "optional": true - }, - { - "name": "month_6", + "name": "rate", "type": "float", - "description": "6 month Treasury rate.", - "default": null, - "optional": true - }, + "description": "Selected Treasury Constant Maturity Rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "SelectedTreasuryConstantMaturity" + }, + "/fixedincome/spreads/treasury_effr": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Select Treasury Bill.\n\nGet Selected Treasury Bill Minus Federal Funds Rate.\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of\nauctioned U.S. Treasuries.\nThe value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.treasury_effr(provider='fred')\nobb.fixedincome.spreads.treasury_effr(maturity='6m', provider='fred')\n```\n\n", + "parameters": { + "standard": [ { - "name": "year_1", - "type": "float", - "description": "1 year Treasury rate.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "year_2", - "type": "float", - "description": "2 year Treasury rate.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "year_3", - "type": "float", - "description": "3 year Treasury rate.", - "default": null, + "name": "maturity", + "type": "Literal['3m', '6m']", + "description": "The maturity", + "default": "3m", "optional": true }, { - "name": "year_5", - "type": "float", - "description": "5 year Treasury rate.", - "default": null, + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", "optional": true + } + ], + "fred": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[SelectedTreasuryBill]", + "description": "Serializable results." }, { - "name": "year_7", - "type": "float", - "description": "7 year Treasury rate.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "year_10", - "type": "float", - "description": "10 year Treasury rate.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "year_20", - "type": "float", - "description": "20 year Treasury rate.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "year_30", - "type": "float", - "description": "30 year Treasury rate.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } - ], - "federal_reserve": [ + ] + }, + "data": { + "standard": [ { "name": "date", "type": "date", @@ -30452,98 +25499,165 @@ "optional": false }, { - "name": "week_4", + "name": "rate", "type": "float", - "description": "4 week Treasury bills rate (secondary market).", + "description": "SelectedTreasuryBill Rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "SelectedTreasuryBill" + }, + "/fixedincome/government/us_yield_curve": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "US Yield Curve. Get United States yield curve.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.us_yield_curve(provider='fred')\nobb.fixedincome.government.us_yield_curve(inflation_adjusted=True, provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for. Defaults to the most recent FRED entry.", "default": null, "optional": true }, { - "name": "month_1", - "type": "float", - "description": "1 month Treasury rate.", - "default": null, + "name": "inflation_adjusted", + "type": "bool", + "description": "Get inflation adjusted rates.", + "default": false, "optional": true }, { - "name": "month_2", - "type": "float", - "description": "2 month Treasury rate.", - "default": null, + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", "optional": true + } + ], + "fred": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[USYieldCurve]", + "description": "Serializable results." }, { - "name": "month_3", - "type": "float", - "description": "3 month Treasury rate.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "month_6", - "type": "float", - "description": "6 month Treasury rate.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "year_1", - "type": "float", - "description": "1 year Treasury rate.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "year_2", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "maturity", "type": "float", - "description": "2 year Treasury rate.", - "default": null, - "optional": true + "description": "Maturity of the treasury rate in years.", + "default": "", + "optional": false }, { - "name": "year_3", + "name": "rate", "type": "float", - "description": "3 year Treasury rate.", + "description": "Associated rate given in decimal form (0.05 is 5%)", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "USYieldCurve" + }, + "/fixedincome/government/treasury_rates": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Government Treasury Rates.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.treasury_rates(provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "year_5", - "type": "float", - "description": "5 year Treasury rate.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "year_7", - "type": "float", - "description": "7 year Treasury rate.", - "default": null, + "name": "provider", + "type": "Literal['federal_reserve', 'fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default.", + "default": "federal_reserve", "optional": true + } + ], + "federal_reserve": [], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[TreasuryRates]", + "description": "Serializable results." }, { - "name": "year_10", - "type": "float", - "description": "10 year Treasury rate.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['federal_reserve', 'fmp']]", + "description": "Provider name." }, { - "name": "year_20", - "type": "float", - "description": "20 year Treasury rate.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "year_30", - "type": "float", - "description": "30 year Treasury rate.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } - ], - "fmp": [ + ] + }, + "data": { + "standard": [ { "name": "date", "type": "date", @@ -30642,7 +25756,9 @@ "default": null, "optional": true } - ] + ], + "federal_reserve": [], + "fmp": [] }, "model": "TreasuryRates" }, @@ -30761,22 +25877,7 @@ "optional": false } ], - "fred": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "rate", - "type": "float", - "description": "ICE BofA US Corporate Bond Indices Rate.", - "default": "", - "optional": false - } - ] + "fred": [] }, "model": "ICEBofA" }, @@ -30855,26 +25956,10 @@ "type": "Dict[str, Any]", "description": "Extra info." } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "rate", - "type": "float", - "description": "Moody Corporate Bond Index Rate.", - "default": "", - "optional": false - } - ], - "fred": [ + ] + }, + "data": { + "standard": [ { "name": "date", "type": "date", @@ -30889,7 +25974,8 @@ "default": "", "optional": false } - ] + ], + "fred": [] }, "model": "MoodyCorporateBondIndex" }, @@ -30924,22 +26010,7 @@ "optional": true } ], - "fred": [ - { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", - "default": null, - "optional": true - }, - { - "name": "yield_curve", - "type": "Literal['spot', 'par']", - "description": "The yield curve type.", - "default": "spot", - "optional": true - } - ] + "fred": [] }, "returns": { "OBBject": [ @@ -31058,36 +26129,7 @@ "optional": true } ], - "fred": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "maturity", - "type": "Union[float, str]", - "description": "Maturities in years.", - "default": 10.0, - "optional": true - }, - { - "name": "category", - "type": "str", - "description": "Rate category. Options: spot_rate, par_yield.", - "default": "spot_rate", - "optional": true - } - ] + "fred": [] }, "returns": { "OBBject": [ @@ -31135,22 +26177,7 @@ "optional": false } ], - "fred": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "rate", - "type": "float", - "description": "Spot Rate.", - "default": "", - "optional": false - } - ] + "fred": [] }, "model": "SpotRate" }, @@ -31206,43 +26233,7 @@ "optional": true } ], - "fred": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "maturity", - "type": "Literal['overnight', '7d', '15d', '30d', '60d', '90d']", - "description": "The maturity.", - "default": "30d", - "optional": true - }, - { - "name": "category", - "type": "Literal['asset_backed', 'financial', 'nonfinancial']", - "description": "The category.", - "default": "financial", - "optional": true - }, - { - "name": "grade", - "type": "Literal['aa', 'a2_p2']", - "description": "The grade.", - "default": "aa", - "optional": true - } - ] + "fred": [] }, "returns": { "OBBject": [ @@ -31290,22 +26281,7 @@ "optional": false } ], - "fred": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "rate", - "type": "float", - "description": "Commercial Paper Rate.", - "default": "", - "optional": false - } - ] + "fred": [] }, "model": "CommercialPaper" }, @@ -31396,22 +26372,7 @@ "optional": false } ], - "fred": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "rate", - "type": "float", - "description": "SOFR rate.", - "default": "", - "optional": false - } - ] + "fred": [] }, "model": "SOFR" }, @@ -31534,134 +26495,14 @@ "description": "Chart object." }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "Union[date, datetime]", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "open", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The open price.", - "default": null, - "optional": true - }, - { - "name": "high", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The high price.", - "default": null, - "optional": true - }, - { - "name": "low", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The low price.", - "default": null, - "optional": true - }, - { - "name": "close", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The close price.", - "default": null, - "optional": true - }, - { - "name": "volume", - "type": "int", - "description": "The trading volume.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "vwap", - "type": "float", - "description": "Volume Weighted Average Price over the period.", - "default": null, - "optional": true - }, - { - "name": "change", - "type": "float", - "description": "Change in the price from the previous close.", - "default": null, - "optional": true - }, - { - "name": "change_percent", - "type": "float", - "description": "Change in the price from the previous close, as a normalized percent.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "date", - "type": "Union[date, datetime]", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "open", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The open price.", - "default": null, - "optional": true - }, - { - "name": "high", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The high price.", - "default": null, - "optional": true - }, - { - "name": "low", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The low price.", - "default": null, - "optional": true - }, - { - "name": "close", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The close price.", - "default": null, - "optional": true - }, - { - "name": "volume", - "type": "int", - "description": "The trading volume.", - "default": null, - "optional": true - } - ], - "polygon": [ - { - "name": "transactions", - "type": "Annotated[int, Gt(gt=0)]", - "description": "Number of transactions for the symbol in the time period.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } - ], - "yfinance": [ + ] + }, + "data": { + "standard": [ { "name": "date", "type": "Union[date, datetime]", @@ -31704,7 +26545,41 @@ "default": null, "optional": true } - ] + ], + "fmp": [ + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "Change in the price from the previous close.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in the price from the previous close, as a normalized percent.", + "default": null, + "optional": true + } + ], + "intrinio": [], + "polygon": [ + { + "name": "transactions", + "type": "Annotated[int, Gt(gt=0)]", + "description": "Number of transactions for the symbol in the time period.", + "default": null, + "optional": true + } + ], + "yfinance": [] }, "model": "IndexHistorical" }, @@ -31901,50 +26776,7 @@ "optional": true } ], - "intrinio": [ - { - "name": "date", - "type": "Union[date, datetime]", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "open", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The open price.", - "default": null, - "optional": true - }, - { - "name": "high", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The high price.", - "default": null, - "optional": true - }, - { - "name": "low", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The low price.", - "default": null, - "optional": true - }, - { - "name": "close", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The close price.", - "default": null, - "optional": true - }, - { - "name": "volume", - "type": "int", - "description": "The trading volume.", - "default": null, - "optional": true - } - ], + "intrinio": [], "polygon": [ { "name": "transactions", @@ -31954,50 +26786,7 @@ "optional": true } ], - "yfinance": [ - { - "name": "date", - "type": "Union[date, datetime]", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "open", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The open price.", - "default": null, - "optional": true - }, - { - "name": "high", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The high price.", - "default": null, - "optional": true - }, - { - "name": "low", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The low price.", - "default": null, - "optional": true - }, - { - "name": "close", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The close price.", - "default": null, - "optional": true - }, - { - "name": "volume", - "type": "int", - "description": "The trading volume.", - "default": null, - "optional": true - } - ] + "yfinance": [] }, "model": "MarketIndices" }, @@ -32353,29 +27142,7 @@ "optional": true } ], - "fmp": [ - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. The number of articles to return.", - "default": 2500, - "optional": true - }, - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - } - ], + "fmp": [], "intrinio": [ { "name": "source", @@ -32948,36 +27715,7 @@ "optional": true } ], - "yfinance": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": null, - "optional": true - }, - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "limit", - "type": "Annotated[int, Ge(ge=0)]", - "description": "The number of data entries to return.", - "default": 2500, - "optional": true - } - ] + "yfinance": [] }, "returns": { "OBBject": [ @@ -33358,15 +28096,7 @@ "optional": true } ], - "sec": [ - { - "name": "cik", - "type": "Union[int, str]", - "description": "Central Index Key (CIK) for the requested entity.", - "default": null, - "optional": true - } - ] + "sec": [] }, "model": "CikMap" }, @@ -33401,22 +28131,7 @@ "optional": true } ], - "sec": [ - { - "name": "query", - "type": "str", - "description": "Search query.", - "default": "", - "optional": true - }, - { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache.", - "default": true, - "optional": true - } - ] + "sec": [] }, "returns": { "OBBject": [ @@ -33583,22 +28298,7 @@ "optional": true } ], - "sec": [ - { - "name": "query", - "type": "str", - "description": "Search query.", - "default": "", - "optional": false - }, - { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache. If True, cache will store for seven days.", - "default": true, - "optional": true - } - ] + "sec": [] }, "returns": { "OBBject": [ @@ -33764,22 +28464,7 @@ "optional": true } ], - "sec": [ - { - "name": "query", - "type": "str", - "description": "Search query.", - "default": "", - "optional": true - }, - { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache.", - "default": true, - "optional": true - } - ] + "sec": [] }, "returns": { "OBBject": [ From eb90cf2a4ce02bd13da1ed3640c34a18a55f4121 Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Wed, 8 May 2024 16:54:01 +0100 Subject: [PATCH 14/24] comment --- openbb_platform/core/openbb_core/provider/registry_map.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openbb_platform/core/openbb_core/provider/registry_map.py b/openbb_platform/core/openbb_core/provider/registry_map.py index 12ea7ba13dab..b2b82ce87145 100644 --- a/openbb_platform/core/openbb_core/provider/registry_map.py +++ b/openbb_platform/core/openbb_core/provider/registry_map.py @@ -164,7 +164,7 @@ def _extract_info( # This ensures fields inherited by c are discarded. # We need to compare child and parent __annotations__ # because this attribute is redirected to the parent class - # when the model simply inherits the parent and does not + # when the child simply inherits the parent and does not # define any attributes. # TLDR: Only fields defined in c are included if name in c.__annotations__ From 096b1e61972cd9870fb39baef13e44c358a3ee2e Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Wed, 8 May 2024 17:00:42 +0100 Subject: [PATCH 15/24] better --- openbb_platform/core/openbb_core/provider/registry_map.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/openbb_platform/core/openbb_core/provider/registry_map.py b/openbb_platform/core/openbb_core/provider/registry_map.py index b2b82ce87145..849e31489a77 100644 --- a/openbb_platform/core/openbb_core/provider/registry_map.py +++ b/openbb_platform/core/openbb_core/provider/registry_map.py @@ -152,11 +152,12 @@ def _extract_info( extra_info: Dict[str, Any] = {"fields": {}, "docstring": model.__doc__} found_first_standard = False - for c in RegistryMap._class_hierarchy(model): + hierarchy = RegistryMap._class_hierarchy(model) + for i, c in enumerate(hierarchy): if c.__name__ in SKIP: continue - parent = c.__mro__[1] if c.__mro__[1] not in SKIP else BaseModel + parent = hierarchy[i + 1] if hierarchy[i + 1] not in SKIP else BaseModel fields = { name: field From 4de2de746bf575c0062a36550bfd7a148590d9b9 Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Wed, 8 May 2024 17:03:48 +0100 Subject: [PATCH 16/24] better --- .../core/openbb_core/provider/registry_map.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/openbb_platform/core/openbb_core/provider/registry_map.py b/openbb_platform/core/openbb_core/provider/registry_map.py index 849e31489a77..5511e8aa11a6 100644 --- a/openbb_platform/core/openbb_core/provider/registry_map.py +++ b/openbb_platform/core/openbb_core/provider/registry_map.py @@ -153,29 +153,29 @@ def _extract_info( found_first_standard = False hierarchy = RegistryMap._class_hierarchy(model) - for i, c in enumerate(hierarchy): - if c.__name__ in SKIP: + for i, child in enumerate(hierarchy): + if child.__name__ in SKIP: continue parent = hierarchy[i + 1] if hierarchy[i + 1] not in SKIP else BaseModel fields = { name: field - for name, field in c.model_fields.items() + for name, field in child.model_fields.items() # This ensures fields inherited by c are discarded. # We need to compare child and parent __annotations__ # because this attribute is redirected to the parent class # when the child simply inherits the parent and does not # define any attributes. # TLDR: Only fields defined in c are included - if name in c.__annotations__ - and c.__annotations__ is not parent.__annotations__ + if name in child.__annotations__ + and child.__annotations__ is not parent.__annotations__ } - if Path(getfile(c)).parent == STANDARD_MODELS_FOLDER: + if Path(getfile(child)).parent == STANDARD_MODELS_FOLDER: if not found_first_standard: # If standard uses inheritance we just use the first docstring - standard_info["docstring"] = c.__doc__ + standard_info["docstring"] = child.__doc__ found_first_standard = True standard_info["fields"].update(fields) else: From ed2a6391ce3c3bc5f7f1f8b4f2c8da616eed4ccb Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Wed, 8 May 2024 17:04:50 +0100 Subject: [PATCH 17/24] better --- openbb_platform/core/openbb_core/provider/registry_map.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/openbb_platform/core/openbb_core/provider/registry_map.py b/openbb_platform/core/openbb_core/provider/registry_map.py index 5511e8aa11a6..10a2622f7e3c 100644 --- a/openbb_platform/core/openbb_core/provider/registry_map.py +++ b/openbb_platform/core/openbb_core/provider/registry_map.py @@ -152,12 +152,12 @@ def _extract_info( extra_info: Dict[str, Any] = {"fields": {}, "docstring": model.__doc__} found_first_standard = False - hierarchy = RegistryMap._class_hierarchy(model) - for i, child in enumerate(hierarchy): + family = RegistryMap._class_hierarchy(model) + for i, child in enumerate(family): if child.__name__ in SKIP: continue - parent = hierarchy[i + 1] if hierarchy[i + 1] not in SKIP else BaseModel + parent = family[i + 1] if family[i + 1] not in SKIP else BaseModel fields = { name: field From ef83b8d48b9e1f55d242af85ec3562b71f4129ff Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Wed, 8 May 2024 17:05:19 +0100 Subject: [PATCH 18/24] better --- openbb_platform/core/openbb_core/provider/registry_map.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/openbb_platform/core/openbb_core/provider/registry_map.py b/openbb_platform/core/openbb_core/provider/registry_map.py index 10a2622f7e3c..469785894da2 100644 --- a/openbb_platform/core/openbb_core/provider/registry_map.py +++ b/openbb_platform/core/openbb_core/provider/registry_map.py @@ -152,7 +152,7 @@ def _extract_info( extra_info: Dict[str, Any] = {"fields": {}, "docstring": model.__doc__} found_first_standard = False - family = RegistryMap._class_hierarchy(model) + family = RegistryMap._get_class_hierarchy(model) for i, child in enumerate(family): if child.__name__ in SKIP: continue @@ -205,6 +205,6 @@ def _validate(model: Any, type_: Literal["query_params", "data"]) -> None: ) @staticmethod - def _class_hierarchy(class_) -> tuple: + def _get_class_hierarchy(class_) -> tuple: """Return the class hierarchy starting with the class itself until `object`.""" return getattr(class_, "__mro__", ()) From c27fb54c668b756b7284facc8992b5053a71c32a Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Wed, 8 May 2024 17:06:08 +0100 Subject: [PATCH 19/24] better --- openbb_platform/core/openbb_core/provider/registry_map.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/openbb_platform/core/openbb_core/provider/registry_map.py b/openbb_platform/core/openbb_core/provider/registry_map.py index 469785894da2..a3a7fcc32d43 100644 --- a/openbb_platform/core/openbb_core/provider/registry_map.py +++ b/openbb_platform/core/openbb_core/provider/registry_map.py @@ -152,7 +152,7 @@ def _extract_info( extra_info: Dict[str, Any] = {"fields": {}, "docstring": model.__doc__} found_first_standard = False - family = RegistryMap._get_class_hierarchy(model) + family = RegistryMap._get_class_family(model) for i, child in enumerate(family): if child.__name__ in SKIP: continue @@ -205,6 +205,6 @@ def _validate(model: Any, type_: Literal["query_params", "data"]) -> None: ) @staticmethod - def _get_class_hierarchy(class_) -> tuple: - """Return the class hierarchy starting with the class itself until `object`.""" + def _get_class_family(class_) -> tuple: + """Return the class family starting with the class itself until `object`.""" return getattr(class_, "__mro__", ()) From 2fce4cfc230e0a8db35dbdb5f4f8926f2ef0196a Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Wed, 8 May 2024 17:58:41 +0100 Subject: [PATCH 20/24] mypy fixes --- .../benzinga/openbb_benzinga/models/company_news.py | 7 ++++--- .../cboe/openbb_cboe/models/equity_historical.py | 2 +- .../providers/cboe/openbb_cboe/models/index_historical.py | 6 +++--- .../providers/finviz/openbb_finviz/models/price_target.py | 6 +++--- .../providers/fmp/openbb_fmp/models/analyst_estimates.py | 2 +- .../fmp/openbb_fmp/models/etf_equity_exposure.py | 2 +- .../fmp/openbb_fmp/models/executive_compensation.py | 2 +- .../providers/fmp/openbb_fmp/models/price_target.py | 2 +- openbb_platform/providers/fred/openbb_fred/models/cpi.py | 5 ++--- .../intrinio/openbb_intrinio/models/company_news.py | 6 ++++-- .../polygon/openbb_polygon/models/currency_snapshots.py | 8 ++++---- .../tiingo/openbb_tiingo/models/crypto_historical.py | 2 +- .../tiingo/openbb_tiingo/models/currency_historical.py | 2 +- .../tiingo/openbb_tiingo/models/equity_historical.py | 2 +- .../yfinance/openbb_yfinance/models/market_indices.py | 4 ++-- 15 files changed, 30 insertions(+), 28 deletions(-) diff --git a/openbb_platform/providers/benzinga/openbb_benzinga/models/company_news.py b/openbb_platform/providers/benzinga/openbb_benzinga/models/company_news.py index 2e8190ccaaa6..ddeda7696571 100644 --- a/openbb_platform/providers/benzinga/openbb_benzinga/models/company_news.py +++ b/openbb_platform/providers/benzinga/openbb_benzinga/models/company_news.py @@ -152,10 +152,11 @@ async def aextract_data( base_url = "https://api.benzinga.com/api/v2/news" - query.sort = f"{query.sort}:{query.order}" if query.sort and query.order else "" - querystring = get_querystring( - query.model_dump(by_alias=True), ["order", "pageSize"] + model = query.model_dump(by_alias=True) + model["sort"] = ( + f"{query.sort}:{query.order}" if query.sort and query.order else "" ) + querystring = get_querystring(model, ["order", "pageSize"]) pages = math.ceil(query.limit / 100) if query.limit else 1 page_size = 100 if query.limit and query.limit > 100 else query.limit diff --git a/openbb_platform/providers/cboe/openbb_cboe/models/equity_historical.py b/openbb_platform/providers/cboe/openbb_cboe/models/equity_historical.py index dd74cdba493a..936d31abc093 100644 --- a/openbb_platform/providers/cboe/openbb_cboe/models/equity_historical.py +++ b/openbb_platform/providers/cboe/openbb_cboe/models/equity_historical.py @@ -141,7 +141,7 @@ def _generate_historical_prices_url( return url urls = [ - _generate_historical_prices_url(symbol, INTERVAL_DICT[query.interval]) + _generate_historical_prices_url(symbol, INTERVAL_DICT[query.interval]) # type: ignore[arg-type] for symbol in symbols ] return await amake_requests(urls, **kwargs) diff --git a/openbb_platform/providers/cboe/openbb_cboe/models/index_historical.py b/openbb_platform/providers/cboe/openbb_cboe/models/index_historical.py index 38c579dd9e33..01340b4076eb 100644 --- a/openbb_platform/providers/cboe/openbb_cboe/models/index_historical.py +++ b/openbb_platform/providers/cboe/openbb_cboe/models/index_historical.py @@ -139,7 +139,7 @@ def _generate_historical_prices_url( ) url += f"{symbol.replace('^', '')}.json" else: - base_url: str = ( + base_url: str = ( # type: ignore[no-redef] f"https://cdn.cboe.com/api/global/delayed_quotes/charts/{interval_type}" ) url = ( @@ -152,7 +152,7 @@ def _generate_historical_prices_url( return url urls = [ - _generate_historical_prices_url(symbol, INTERVAL_DICT[query.interval]) + _generate_historical_prices_url(symbol, INTERVAL_DICT[query.interval]) # type: ignore[arg-type] for symbol in symbols ] @@ -205,7 +205,7 @@ def transform_data( (to_datetime(output["date"]) >= to_datetime(query.start_date)) & ( to_datetime(output["date"]) - <= to_datetime(query.end_date + timedelta(days=1)) + <= to_datetime(query.end_date + timedelta(days=1)) # type: ignore[operator] ) ] return [ diff --git a/openbb_platform/providers/finviz/openbb_finviz/models/price_target.py b/openbb_platform/providers/finviz/openbb_finviz/models/price_target.py index b3633510518d..74792b039511 100644 --- a/openbb_platform/providers/finviz/openbb_finviz/models/price_target.py +++ b/openbb_platform/providers/finviz/openbb_finviz/models/price_target.py @@ -67,12 +67,12 @@ def extract_data( ) -> List[Dict]: """Return the raw data from the Finviz endpoint.""" - results = [] + results: List[dict] = [] def get_one(symbol) -> List[Dict]: """Get the data for one symbol.""" price_targets = DataFrame() - result = [] + result: List[dict] = [] try: data = finvizfinance(symbol) price_targets = data.ticker_outer_ratings() @@ -100,7 +100,7 @@ def get_one(symbol) -> List[Dict]: result = price_targets.to_dict(orient="records") return result - symbols = query.symbol.split(",") + symbols = query.symbol.split(",") if query.symbol else [] for symbol in symbols: result = get_one(symbol) if result is not None and result != []: diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/analyst_estimates.py b/openbb_platform/providers/fmp/openbb_fmp/models/analyst_estimates.py index 72d0b49d03de..391a4080e566 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/analyst_estimates.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/analyst_estimates.py @@ -60,7 +60,7 @@ async def aextract_data( symbols = query.symbol.split(",") # type: ignore - results = [] + results: List[dict] = [] async def get_one(symbol): """Get data for one symbol.""" diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/etf_equity_exposure.py b/openbb_platform/providers/fmp/openbb_fmp/models/etf_equity_exposure.py index 393702d87085..65109aef1575 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/etf_equity_exposure.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/etf_equity_exposure.py @@ -64,7 +64,7 @@ async def aextract_data( """Return the raw data from the FMP endpoint.""" api_key = credentials.get("fmp_api_key") if credentials else "" symbols = query.symbol.split(",") - results = [] + results: List[dict] = [] async def get_one(symbol): """Get one symbol.""" diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/executive_compensation.py b/openbb_platform/providers/fmp/openbb_fmp/models/executive_compensation.py index 358cab94c635..d95e305e8299 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/executive_compensation.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/executive_compensation.py @@ -86,7 +86,7 @@ async def aextract_data( symbols = query.symbol.split(",") - results = [] + results: List[dict] = [] async def get_one(symbol): """Get data for one symbol.""" diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/price_target.py b/openbb_platform/providers/fmp/openbb_fmp/models/price_target.py index 6c0ecede2070..3b6e8481c4d3 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/price_target.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/price_target.py @@ -89,7 +89,7 @@ async def aextract_data( symbols = query.symbol.split(",") # type: ignore - results = [] + results: List[dict] = [] async def get_one(symbol): """Get data for one symbol.""" diff --git a/openbb_platform/providers/fred/openbb_fred/models/cpi.py b/openbb_platform/providers/fred/openbb_fred/models/cpi.py index c5878c8f9424..a7c55bb9b787 100644 --- a/openbb_platform/providers/fred/openbb_fred/models/cpi.py +++ b/openbb_platform/providers/fred/openbb_fred/models/cpi.py @@ -75,8 +75,7 @@ def transform_data( transformed_data[item["date"]].update({country: item["value"]}) # Convert the dictionary to a list of dictionaries - transformed_data = list(transformed_data.values()) - return [ - FREDConsumerPriceIndexData.model_validate(item) for item in transformed_data + FREDConsumerPriceIndexData.model_validate(item) + for item in list(transformed_data.values()) ] diff --git a/openbb_platform/providers/intrinio/openbb_intrinio/models/company_news.py b/openbb_platform/providers/intrinio/openbb_intrinio/models/company_news.py index daee4f3c6c96..d70a7734f75d 100644 --- a/openbb_platform/providers/intrinio/openbb_intrinio/models/company_news.py +++ b/openbb_platform/providers/intrinio/openbb_intrinio/models/company_news.py @@ -182,7 +182,7 @@ async def aextract_data( else ["symbol", "page_size"] ) query_str = get_querystring(query.model_dump(by_alias=True), ignore) - symbols = query.symbol.split(",") + symbols = query.symbol.split(",") if query.symbol else [] news: List = [] async def callback(response, session): @@ -196,7 +196,9 @@ async def callback(response, session): data.extend([{"symbol": symbol, **d} for d in _data]) articles = len(data) next_page = result.get("next_page") - while next_page and query.limit > articles: + # query.limit can be None... + limit = query.limit or 2500 + while next_page and limit > articles: url = f"{base_url}/{symbol}/news?{query_str}&api_key={api_key}&next_page={next_page}" result = await get_data(url, session=session, **kwargs) _data = result.get("news", []) diff --git a/openbb_platform/providers/polygon/openbb_polygon/models/currency_snapshots.py b/openbb_platform/providers/polygon/openbb_polygon/models/currency_snapshots.py index b476c6e9074e..0815d097ccc8 100644 --- a/openbb_platform/providers/polygon/openbb_polygon/models/currency_snapshots.py +++ b/openbb_platform/providers/polygon/openbb_polygon/models/currency_snapshots.py @@ -115,9 +115,9 @@ async def aextract_data( api_key = credentials.get("polygon_api_key") if credentials else "" url = f"https://api.polygon.io/v2/snapshot/locale/global/markets/forex/tickers?apiKey={api_key}" results = await amake_request(url, **kwargs) - if results.get("status") != "OK": - raise RuntimeError(f"Error: {results.get('status')}") - return results.get("tickers", []) + if results.get("status") != "OK": # type: ignore[union-attr] + raise RuntimeError(f"Error: {results.get('status')}") # type: ignore[union-attr] + return results.get("tickers", []) # type: ignore[union-attr] @staticmethod def transform_data( # pylint: disable=too-many-locals, too-many-statements @@ -129,7 +129,7 @@ def transform_data( # pylint: disable=too-many-locals, too-many-statements if not data: raise EmptyDataError("No data returned.") counter_currencies = ( - query.counter_currencies.upper().split(",") + query.counter_currencies.upper().split(",") # type: ignore[union-attr] if query.counter_currencies else [] ) diff --git a/openbb_platform/providers/tiingo/openbb_tiingo/models/crypto_historical.py b/openbb_platform/providers/tiingo/openbb_tiingo/models/crypto_historical.py index ac1ea2375b21..0df0e092c2f3 100644 --- a/openbb_platform/providers/tiingo/openbb_tiingo/models/crypto_historical.py +++ b/openbb_platform/providers/tiingo/openbb_tiingo/models/crypto_historical.py @@ -125,7 +125,7 @@ async def aextract_data( query_str = get_querystring( query.model_dump(by_alias=False), ["tickers", "resampleFreq"] ) - results = [] + results: List[dict] = [] async def callback(response: ClientResponse, _: Any) -> List[Dict]: result = await response.json() diff --git a/openbb_platform/providers/tiingo/openbb_tiingo/models/currency_historical.py b/openbb_platform/providers/tiingo/openbb_tiingo/models/currency_historical.py index d64070a1d6dc..537db364cd4f 100644 --- a/openbb_platform/providers/tiingo/openbb_tiingo/models/currency_historical.py +++ b/openbb_platform/providers/tiingo/openbb_tiingo/models/currency_historical.py @@ -106,7 +106,7 @@ async def aextract_data( query_str = get_querystring( query.model_dump(by_alias=False), ["tickers", "resampleFreq"] ) - results = [] + results: List[dict] = [] async def callback(response: ClientResponse, _: Any) -> List[Dict]: result = await response.json() diff --git a/openbb_platform/providers/tiingo/openbb_tiingo/models/equity_historical.py b/openbb_platform/providers/tiingo/openbb_tiingo/models/equity_historical.py index 56d538c89826..0af3a97606df 100644 --- a/openbb_platform/providers/tiingo/openbb_tiingo/models/equity_historical.py +++ b/openbb_platform/providers/tiingo/openbb_tiingo/models/equity_historical.py @@ -142,7 +142,7 @@ async def aextract_data( async def callback(response: ClientResponse, _: Any) -> List[Dict]: data = await response.json() symbol = response.url.parts[-2] - results = [] + results: List[dict] = [] if not data: _warn(f"No data found the the symbol: {symbol}") return results diff --git a/openbb_platform/providers/yfinance/openbb_yfinance/models/market_indices.py b/openbb_platform/providers/yfinance/openbb_yfinance/models/market_indices.py index 5b069b94a30e..461977499827 100644 --- a/openbb_platform/providers/yfinance/openbb_yfinance/models/market_indices.py +++ b/openbb_platform/providers/yfinance/openbb_yfinance/models/market_indices.py @@ -61,7 +61,7 @@ def transform_query(params: Dict[str, Any]) -> YFinanceMarketIndicesQueryParams: if params.get("end_date") is None: transformed_params["end_date"] = now - tickers = params.get("symbol").lower().split(",") + tickers = params.get("symbol", "").lower().split(",") new_tickers = [] for ticker in tickers: @@ -123,7 +123,7 @@ def extract_data( data = data[ (data.index >= to_datetime(query.start_date)) - & (data.index <= to_datetime(query.end_date + timedelta(days=days))) + & (data.index <= to_datetime(query.end_date + timedelta(days=days))) # type: ignore[operator] ] data.reset_index(inplace=True) From 4b17252bcb4a2863933c5831f149af119a964f55 Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Wed, 8 May 2024 18:00:40 +0100 Subject: [PATCH 21/24] mypy fixes --- .../providers/cboe/openbb_cboe/models/equity_historical.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openbb_platform/providers/cboe/openbb_cboe/models/equity_historical.py b/openbb_platform/providers/cboe/openbb_cboe/models/equity_historical.py index 936d31abc093..67a7423211ef 100644 --- a/openbb_platform/providers/cboe/openbb_cboe/models/equity_historical.py +++ b/openbb_platform/providers/cboe/openbb_cboe/models/equity_historical.py @@ -199,7 +199,7 @@ def transform_data( (to_datetime(output["date"]) >= to_datetime(query.start_date)) & ( to_datetime(output["date"]) - <= to_datetime(query.end_date + timedelta(days=1)) + <= to_datetime(query.end_date + timedelta(days=1)) # type: ignore[operator] ) ] return [ From 5ba707f38cdb5f3ed2b806774325f84bbc4eadca Mon Sep 17 00:00:00 2001 From: hjoaquim Date: Thu, 9 May 2024 13:53:09 +0100 Subject: [PATCH 22/24] reference --- openbb_platform/openbb/assets/reference.json | 28509 +++++++++++++++++ 1 file changed, 28509 insertions(+) diff --git a/openbb_platform/openbb/assets/reference.json b/openbb_platform/openbb/assets/reference.json index e69de29bb2d1..5ff26093f056 100644 --- a/openbb_platform/openbb/assets/reference.json +++ b/openbb_platform/openbb/assets/reference.json @@ -0,0 +1,28509 @@ +{ + "openbb": "4.1.7", + "info": { + "title": "OpenBB Platform (Python)", + "description": "This is the OpenBB Platform (Python).", + "core": "1.1.6", + "extensions": { + "openbb_core_extension": [ + "commodity@1.0.4", + "crypto@1.1.5", + "currency@1.1.5", + "derivatives@1.1.5", + "economy@1.1.5", + "equity@1.1.5", + "etf@1.1.5", + "fixedincome@1.1.5", + "index@1.1.5", + "news@1.1.5", + "regulators@1.1.5" + ], + "openbb_provider_extension": [ + "benzinga@1.1.5", + "econdb@1.0.0", + "federal_reserve@1.1.5", + "fmp@1.1.5", + "fred@1.1.5", + "intrinio@1.1.5", + "oecd@1.1.5", + "polygon@1.1.5", + "sec@1.1.5", + "tiingo@1.1.5", + "tradingeconomics@1.1.5", + "yfinance@1.1.5" + ], + "openbb_obbject_extension": [] + } + }, + "paths": { + "/crypto/price/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical price data for cryptocurrency pair(s) within a provider.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.crypto.price.historical(symbol='BTCUSD', provider='fmp')\nobb.crypto.price.historical(symbol='BTCUSD', start_date='2024-01-01', end_date='2024-01-31', provider='fmp')\nobb.crypto.price.historical(symbol='BTCUSD,ETHUSD', start_date='2024-01-01', end_date='2024-01-31', provider='polygon')\n# Get monthly historical prices from Yahoo Finance for Ethereum.\nobb.crypto.price.historical(symbol='ETH-USD', interval=1m, start_date='2024-01-01', end_date='2024-12-31', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", + "default": "", + "optional": false + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'polygon', 'tiingo', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ], + "polygon": [ + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", + "default": "1d", + "optional": true + }, + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", + "default": "asc", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 49999, + "optional": true + } + ], + "tiingo": [ + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "exchanges", + "type": "List[str]", + "description": "To limit the query to a subset of exchanges e.g. ['POLONIEX', 'GDAX']", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "interval", + "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CryptoHistorical]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'polygon', 'tiingo', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false + }, + { + "name": "vwap", + "type": "Annotated[float, Gt(gt=0)]", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "Change in the price from the previous close.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in the price from the previous close, as a normalized percent.", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "transactions", + "type": "Annotated[int, Gt(gt=0)]", + "description": "Number of transactions for the symbol in the time period.", + "default": null, + "optional": true + } + ], + "tiingo": [ + { + "name": "transactions", + "type": "int", + "description": "Number of transactions for the symbol in the time period.", + "default": null, + "optional": true + }, + { + "name": "volume_notional", + "type": "float", + "description": "The last size done for the asset on the specific date in the quote currency. The volume of the asset on the specific date in the quote currency.", + "default": null, + "optional": true + } + ], + "yfinance": [] + }, + "model": "CryptoHistorical" + }, + "/crypto/search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search available cryptocurrency pairs within a provider.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.crypto.search(provider='fmp')\nobb.crypto.search(query='BTCUSD', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CryptoSearch]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. (Crypto)", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the crypto.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "currency", + "type": "str", + "description": "The currency the crypto trades for.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "The exchange code the crypto trades on.", + "default": null, + "optional": true + }, + { + "name": "exchange_name", + "type": "str", + "description": "The short name of the exchange the crypto trades on.", + "default": null, + "optional": true + } + ] + }, + "model": "CryptoSearch" + }, + "/currency/price/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Currency Historical Price. Currency historical data.\n\nCurrency historical prices refer to the past exchange rates of one currency against\nanother over a specific period.\nThis data provides insight into the fluctuations and trends in the foreign exchange market,\nhelping analysts, traders, and economists understand currency performance,\nevaluate economic health, and make predictions about future movements.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.currency.price.historical(symbol='EURUSD', provider='fmp')\n# Filter historical data with specific start and end date.\nobb.currency.price.historical(symbol='EURUSD', start_date='2023-01-01', end_date='2023-12-31', provider='fmp')\n# Get data with different granularity.\nobb.currency.price.historical(symbol='EURUSD', provider='polygon', interval=15m)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", + "default": "", + "optional": false + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'polygon', 'tiingo', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ], + "polygon": [ + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", + "default": "1d", + "optional": true + }, + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", + "default": "asc", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 49999, + "optional": true + } + ], + "tiingo": [ + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ], + "yfinance": [ + { + "name": "interval", + "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CurrencyHistorical]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'polygon', 'tiingo', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": null, + "optional": true + }, + { + "name": "vwap", + "type": "Annotated[float, Gt(gt=0)]", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "Change in the price from the previous close.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in the price from the previous close, as a normalized percent.", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "transactions", + "type": "Annotated[int, Gt(gt=0)]", + "description": "Number of transactions for the symbol in the time period.", + "default": null, + "optional": true + } + ], + "tiingo": [], + "yfinance": [] + }, + "model": "CurrencyHistorical" + }, + "/currency/search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Currency Search.\n\nSearch available currency pairs.\nCurrency pairs are the national currencies from two countries coupled for trading on\nthe foreign exchange (FX) marketplace.\nBoth currencies will have exchange rates on which the trade will have its position basis.\nAll trading within the forex market, whether selling, buying, or trading, will take place through currency pairs.\n(ref: Investopedia)\nMajor currency pairs include pairs such as EUR/USD, USD/JPY, GBP/USD, etc.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.currency.search(provider='fmp')\n# Search for 'EUR' currency pair using 'intrinio' as provider.\nobb.currency.search(provider='intrinio', query='EUR')\n# Search for terms using 'polygon' as provider.\nobb.currency.search(provider='polygon', query='Euro zone')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str", + "description": "Query to search for currency pairs.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [], + "intrinio": [], + "polygon": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CurrencyPairs]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the currency pair.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol of the currency pair.", + "default": "", + "optional": false + }, + { + "name": "currency", + "type": "str", + "description": "Base currency of the currency pair.", + "default": "", + "optional": false + }, + { + "name": "stock_exchange", + "type": "str", + "description": "Stock exchange of the currency pair.", + "default": null, + "optional": true + }, + { + "name": "exchange_short_name", + "type": "str", + "description": "Short name of the stock exchange of the currency pair.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "base_currency", + "type": "str", + "description": "ISO 4217 currency code of the base currency.", + "default": "", + "optional": false + }, + { + "name": "quote_currency", + "type": "str", + "description": "ISO 4217 currency code of the quote currency.", + "default": "", + "optional": false + } + ], + "polygon": [ + { + "name": "currency_symbol", + "type": "str", + "description": "The symbol of the quote currency.", + "default": null, + "optional": true + }, + { + "name": "base_currency_symbol", + "type": "str", + "description": "The symbol of the base currency.", + "default": null, + "optional": true + }, + { + "name": "base_currency_name", + "type": "str", + "description": "Name of the base currency.", + "default": null, + "optional": true + }, + { + "name": "market", + "type": "str", + "description": "Name of the trading market. Always 'fx'.", + "default": "", + "optional": false + }, + { + "name": "locale", + "type": "str", + "description": "Locale of the currency pair.", + "default": "", + "optional": false + }, + { + "name": "last_updated", + "type": "date", + "description": "The date the reference data was last updated.", + "default": null, + "optional": true + }, + { + "name": "delisted", + "type": "date", + "description": "The date the item was delisted.", + "default": null, + "optional": true + } + ] + }, + "model": "CurrencyPairs" + }, + "/currency/snapshots": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Snapshots of currency exchange rates from an indirect or direct perspective of a base currency.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.currency.snapshots(provider='fmp')\n# Get exchange rates from USD and XAU to EUR, JPY, and GBP using 'fmp' as provider.\nobb.currency.snapshots(provider='fmp', base='USD,XAU', counter_currencies='EUR,JPY,GBP', quote_type='indirect')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "base", + "type": "Union[str, List[str]]", + "description": "The base currency symbol. Multiple items allowed for provider(s): fmp, polygon.", + "default": "usd", + "optional": true + }, + { + "name": "quote_type", + "type": "Literal['direct', 'indirect']", + "description": "Whether the quote is direct or indirect. Selecting 'direct' will return the exchange rate as the amount of domestic currency required to buy one unit of the foreign currency. Selecting 'indirect' (default) will return the exchange rate as the amount of foreign currency required to buy one unit of the domestic currency.", + "default": "indirect", + "optional": true + }, + { + "name": "counter_currencies", + "type": "Union[List[str], str]", + "description": "An optional list of counter currency symbols to filter for. None returns all.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'polygon']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [], + "polygon": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CurrencySnapshots]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'polygon']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "base_currency", + "type": "str", + "description": "The base, or domestic, currency.", + "default": "", + "optional": false + }, + { + "name": "counter_currency", + "type": "str", + "description": "The counter, or foreign, currency.", + "default": "", + "optional": false + }, + { + "name": "last_rate", + "type": "float", + "description": "The exchange rate, relative to the base currency. Rates are expressed as the amount of foreign currency received from selling one unit of the base currency, or the quantity of foreign currency required to purchase one unit of the domestic currency. To inverse the perspective, set the 'quote_type' parameter as 'direct'.", + "default": "", + "optional": false + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": null, + "optional": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": null, + "optional": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": null, + "optional": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": null, + "optional": true + }, + { + "name": "prev_close", + "type": "float", + "description": "The previous close price.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "change", + "type": "float", + "description": "The change in the price from the previous close.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "The change in the price from the previous close, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "ma50", + "type": "float", + "description": "The 50-day moving average.", + "default": null, + "optional": true + }, + { + "name": "ma200", + "type": "float", + "description": "The 200-day moving average.", + "default": null, + "optional": true + }, + { + "name": "year_high", + "type": "float", + "description": "The 52-week high.", + "default": null, + "optional": true + }, + { + "name": "year_low", + "type": "float", + "description": "The 52-week low.", + "default": null, + "optional": true + }, + { + "name": "last_rate_timestamp", + "type": "datetime", + "description": "The timestamp of the last rate.", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "vwap", + "type": "float", + "description": "The volume-weighted average price.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "The change in price from the previous day.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "The percentage change in price from the previous day.", + "default": null, + "optional": true + }, + { + "name": "prev_open", + "type": "float", + "description": "The previous day's opening price.", + "default": null, + "optional": true + }, + { + "name": "prev_high", + "type": "float", + "description": "The previous day's high price.", + "default": null, + "optional": true + }, + { + "name": "prev_low", + "type": "float", + "description": "The previous day's low price.", + "default": null, + "optional": true + }, + { + "name": "prev_volume", + "type": "float", + "description": "The previous day's volume.", + "default": null, + "optional": true + }, + { + "name": "prev_vwap", + "type": "float", + "description": "The previous day's VWAP.", + "default": null, + "optional": true + }, + { + "name": "bid", + "type": "float", + "description": "The current bid price.", + "default": null, + "optional": true + }, + { + "name": "ask", + "type": "float", + "description": "The current ask price.", + "default": null, + "optional": true + }, + { + "name": "minute_open", + "type": "float", + "description": "The open price from the most recent minute bar.", + "default": null, + "optional": true + }, + { + "name": "minute_high", + "type": "float", + "description": "The high price from the most recent minute bar.", + "default": null, + "optional": true + }, + { + "name": "minute_low", + "type": "float", + "description": "The low price from the most recent minute bar.", + "default": null, + "optional": true + }, + { + "name": "minute_close", + "type": "float", + "description": "The close price from the most recent minute bar.", + "default": null, + "optional": true + }, + { + "name": "minute_volume", + "type": "float", + "description": "The volume from the most recent minute bar.", + "default": null, + "optional": true + }, + { + "name": "minute_vwap", + "type": "float", + "description": "The VWAP from the most recent minute bar.", + "default": null, + "optional": true + }, + { + "name": "minute_transactions", + "type": "float", + "description": "The number of transactions in the most recent minute bar.", + "default": null, + "optional": true + }, + { + "name": "quote_timestamp", + "type": "datetime", + "description": "The timestamp of the last quote.", + "default": null, + "optional": true + }, + { + "name": "minute_timestamp", + "type": "datetime", + "description": "The timestamp for the start of the most recent minute bar.", + "default": null, + "optional": true + }, + { + "name": "last_updated", + "type": "datetime", + "description": "The last time the data was updated.", + "default": "", + "optional": false + } + ] + }, + "model": "CurrencySnapshots" + }, + "/derivatives/options/chains": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the complete options chain for a ticker.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.derivatives.options.chains(symbol='AAPL', provider='intrinio')\n# Use the \"date\" parameter to get the end-of-day-data for a specific date, where supported.\nobb.derivatives.options.chains(symbol='AAPL', date=2023-01-25, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", + "optional": true + } + ], + "intrinio": [ + { + "name": "date", + "type": "Union[date, str]", + "description": "The end-of-day date for options chains data.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[OptionsChains]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['intrinio']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. Here, it is the underlying symbol for the option.", + "default": null, + "optional": true + }, + { + "name": "contract_symbol", + "type": "str", + "description": "Contract symbol for the option.", + "default": "", + "optional": false + }, + { + "name": "eod_date", + "type": "date", + "description": "Date for which the options chains are returned.", + "default": null, + "optional": true + }, + { + "name": "expiration", + "type": "date", + "description": "Expiration date of the contract.", + "default": "", + "optional": false + }, + { + "name": "strike", + "type": "float", + "description": "Strike price of the contract.", + "default": "", + "optional": false + }, + { + "name": "option_type", + "type": "str", + "description": "Call or Put.", + "default": "", + "optional": false + }, + { + "name": "open_interest", + "type": "int", + "description": "Open interest on the contract.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": null, + "optional": true + }, + { + "name": "theoretical_price", + "type": "float", + "description": "Theoretical value of the option.", + "default": null, + "optional": true + }, + { + "name": "last_trade_price", + "type": "float", + "description": "Last trade price of the option.", + "default": null, + "optional": true + }, + { + "name": "tick", + "type": "str", + "description": "Whether the last tick was up or down in price.", + "default": null, + "optional": true + }, + { + "name": "bid", + "type": "float", + "description": "Current bid price for the option.", + "default": null, + "optional": true + }, + { + "name": "bid_size", + "type": "int", + "description": "Bid size for the option.", + "default": null, + "optional": true + }, + { + "name": "ask", + "type": "float", + "description": "Current ask price for the option.", + "default": null, + "optional": true + }, + { + "name": "ask_size", + "type": "int", + "description": "Ask size for the option.", + "default": null, + "optional": true + }, + { + "name": "mark", + "type": "float", + "description": "The mid-price between the latest bid and ask.", + "default": null, + "optional": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": null, + "optional": true + }, + { + "name": "open_bid", + "type": "float", + "description": "The opening bid price for the option that day.", + "default": null, + "optional": true + }, + { + "name": "open_ask", + "type": "float", + "description": "The opening ask price for the option that day.", + "default": null, + "optional": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": null, + "optional": true + }, + { + "name": "bid_high", + "type": "float", + "description": "The highest bid price for the option that day.", + "default": null, + "optional": true + }, + { + "name": "ask_high", + "type": "float", + "description": "The highest ask price for the option that day.", + "default": null, + "optional": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": null, + "optional": true + }, + { + "name": "bid_low", + "type": "float", + "description": "The lowest bid price for the option that day.", + "default": null, + "optional": true + }, + { + "name": "ask_low", + "type": "float", + "description": "The lowest ask price for the option that day.", + "default": null, + "optional": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": true + }, + { + "name": "close_size", + "type": "int", + "description": "The closing trade size for the option that day.", + "default": null, + "optional": true + }, + { + "name": "close_time", + "type": "datetime", + "description": "The time of the closing price for the option that day.", + "default": null, + "optional": true + }, + { + "name": "close_bid", + "type": "float", + "description": "The closing bid price for the option that day.", + "default": null, + "optional": true + }, + { + "name": "close_bid_size", + "type": "int", + "description": "The closing bid size for the option that day.", + "default": null, + "optional": true + }, + { + "name": "close_bid_time", + "type": "datetime", + "description": "The time of the bid closing price for the option that day.", + "default": null, + "optional": true + }, + { + "name": "close_ask", + "type": "float", + "description": "The closing ask price for the option that day.", + "default": null, + "optional": true + }, + { + "name": "close_ask_size", + "type": "int", + "description": "The closing ask size for the option that day.", + "default": null, + "optional": true + }, + { + "name": "close_ask_time", + "type": "datetime", + "description": "The time of the ask closing price for the option that day.", + "default": null, + "optional": true + }, + { + "name": "prev_close", + "type": "float", + "description": "The previous close price.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "The change in the price of the option.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Change, in normalizezd percentage points, of the option.", + "default": null, + "optional": true + }, + { + "name": "implied_volatility", + "type": "float", + "description": "Implied volatility of the option.", + "default": null, + "optional": true + }, + { + "name": "delta", + "type": "float", + "description": "Delta of the option.", + "default": null, + "optional": true + }, + { + "name": "gamma", + "type": "float", + "description": "Gamma of the option.", + "default": null, + "optional": true + }, + { + "name": "theta", + "type": "float", + "description": "Theta of the option.", + "default": null, + "optional": true + }, + { + "name": "vega", + "type": "float", + "description": "Vega of the option.", + "default": null, + "optional": true + }, + { + "name": "rho", + "type": "float", + "description": "Rho of the option.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "exercise_style", + "type": "str", + "description": "The exercise style of the option, American or European.", + "default": null, + "optional": true + } + ] + }, + "model": "OptionsChains" + }, + "/derivatives/options/unusual": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the complete options chain for a ticker.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.derivatives.options.unusual(provider='intrinio')\n# Use the 'symbol' parameter to get the most recent activity for a specific symbol.\nobb.derivatives.options.unusual(symbol='TSLA', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (the underlying symbol)", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", + "optional": true + } + ], + "intrinio": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format. If no symbol is supplied, requests are only allowed for a single date. Use the start_date for the target date. Intrinio appears to have data beginning Feb/2022, but is unclear when it actually began.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format. If a symbol is not supplied, do not include an end date.", + "default": null, + "optional": true + }, + { + "name": "trade_type", + "type": "Literal['block', 'sweep', 'large']", + "description": "The type of unusual activity to query for.", + "default": null, + "optional": true + }, + { + "name": "sentiment", + "type": "Literal['bullish', 'bearish', 'neutral']", + "description": "The sentiment type to query for.", + "default": null, + "optional": true + }, + { + "name": "min_value", + "type": "Union[int, float]", + "description": "The inclusive minimum total value for the unusual activity.", + "default": null, + "optional": true + }, + { + "name": "max_value", + "type": "Union[int, float]", + "description": "The inclusive maximum total value for the unusual activity.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return. A typical day for all symbols will yield 50-80K records. The API will paginate at 1000 records. The high default limit (100K) is to be able to reliably capture the most days. The high absolute limit (1.25M) is to allow for outlier days. Queries at the absolute limit will take a long time, and might be unreliable. Apply filters to improve performance.", + "default": 100000, + "optional": true + }, + { + "name": "source", + "type": "Literal['delayed', 'realtime']", + "description": "The source of the data. Either realtime or delayed.", + "default": "delayed", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[OptionsUnusual]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['intrinio']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "underlying_symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. (the underlying symbol)", + "default": null, + "optional": true + }, + { + "name": "contract_symbol", + "type": "str", + "description": "Contract symbol for the option.", + "default": "", + "optional": false + } + ], + "intrinio": [ + { + "name": "trade_timestamp", + "type": "datetime", + "description": "The datetime of order placement.", + "default": "", + "optional": false + }, + { + "name": "trade_type", + "type": "Literal['block', 'sweep', 'large']", + "description": "The type of unusual trade.", + "default": "", + "optional": false + }, + { + "name": "sentiment", + "type": "Literal['bullish', 'bearish', 'neutral']", + "description": "Bullish, Bearish, or Neutral Sentiment is estimated based on whether the trade was executed at the bid, ask, or mark price.", + "default": "", + "optional": false + }, + { + "name": "bid_at_execution", + "type": "float", + "description": "Bid price at execution.", + "default": "", + "optional": false + }, + { + "name": "ask_at_execution", + "type": "float", + "description": "Ask price at execution.", + "default": "", + "optional": false + }, + { + "name": "average_price", + "type": "float", + "description": "The average premium paid per option contract.", + "default": "", + "optional": false + }, + { + "name": "underlying_price_at_execution", + "type": "float", + "description": "Price of the underlying security at execution of trade.", + "default": null, + "optional": true + }, + { + "name": "total_size", + "type": "int", + "description": "The total number of contracts involved in a single transaction.", + "default": "", + "optional": false + }, + { + "name": "total_value", + "type": "Union[int, float]", + "description": "The aggregated value of all option contract premiums included in the trade.", + "default": "", + "optional": false + } + ] + }, + "model": "OptionsUnusual" + }, + "/derivatives/futures/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Historical futures prices.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.derivatives.futures.historical(symbol='ES', provider='yfinance')\n# Enter multiple symbols.\nobb.derivatives.futures.historical(symbol='ES,NQ', provider='yfinance')\n# Enter expiration dates as \"YYYY-MM\".\nobb.derivatives.futures.historical(symbol='ES', provider='yfinance', expiration='2025-12')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": "", + "optional": false + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "expiration", + "type": "str", + "description": "Future expiry date with format YYYY-MM", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['yfinance']", + "description": "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.", + "default": "yfinance", + "optional": true + } + ], + "yfinance": [ + { + "name": "interval", + "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[FuturesHistorical]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "datetime", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false + } + ], + "yfinance": [] + }, + "model": "FuturesHistorical" + }, + "/derivatives/futures/curve": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Futures Term Structure, current or historical.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Enter a date to get the term structure from a historical date.\nobb.derivatives.futures.curve(symbol='NG', provider='yfinance', date='2023-01-01')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['yfinance']", + "description": "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.", + "default": "yfinance", + "optional": true + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[FuturesCurve]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "expiration", + "type": "str", + "description": "Futures expiration month.", + "default": "", + "optional": false + }, + { + "name": "price", + "type": "float", + "description": "The close price.", + "default": null, + "optional": true + } + ], + "yfinance": [] + }, + "model": "FuturesCurve" + }, + "/economy/gdp/forecast": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Forecasted GDP Data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.gdp.forecast(provider='oecd')\nobb.economy.gdp.forecast(period='annual', type='real', provider='oecd')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return. Units for nominal GDP period. Either quarter or annual.", + "default": "annual", + "optional": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "type", + "type": "Literal['nominal', 'real']", + "description": "Type of GDP to get forecast of. Either nominal or real.", + "default": "real", + "optional": true + }, + { + "name": "provider", + "type": "Literal['oecd']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default.", + "default": "oecd", + "optional": true + } + ], + "oecd": [ + { + "name": "country", + "type": "Literal['argentina', 'asia', 'australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'colombia', 'costa_rica', 'croatia', 'czech_republic', 'denmark', 'estonia', 'euro_area_17', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'india', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'non-oecd', 'norway', 'oecd_total', 'peru', 'poland', 'portugal', 'romania', 'russia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'world']", + "description": "Country to get GDP for.", + "default": "united_states", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[GdpForecast]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['oecd']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": null, + "optional": true + }, + { + "name": "value", + "type": "float", + "description": "Nominal GDP value on the date.", + "default": null, + "optional": true + } + ], + "oecd": [] + }, + "model": "GdpForecast" + }, + "/economy/gdp/nominal": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Nominal GDP Data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.gdp.nominal(provider='oecd')\nobb.economy.gdp.nominal(units='usd', provider='oecd')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "units", + "type": "Literal['usd', 'usd_cap']", + "description": "The unit of measurement for the data. Units to get nominal GDP in. Either usd or usd_cap indicating per capita.", + "default": "usd", + "optional": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['oecd']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default.", + "default": "oecd", + "optional": true + } + ], + "oecd": [ + { + "name": "country", + "type": "Literal['australia', 'austria', 'belgium', 'brazil', 'canada', 'chile', 'colombia', 'costa_rica', 'czech_republic', 'denmark', 'estonia', 'euro_area', 'european_union', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'norway', 'poland', 'portugal', 'russia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'all']", + "description": "Country to get GDP for.", + "default": "united_states", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[GdpNominal]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['oecd']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": null, + "optional": true + }, + { + "name": "value", + "type": "float", + "description": "Nominal GDP value on the date.", + "default": null, + "optional": true + } + ], + "oecd": [] + }, + "model": "GdpNominal" + }, + "/economy/gdp/real": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Real GDP Data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.gdp.real(provider='oecd')\nobb.economy.gdp.real(units='yoy', provider='oecd')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "units", + "type": "Literal['idx', 'qoq', 'yoy']", + "description": "The unit of measurement for the data. Either idx (indicating 2015=100), qoq (previous period) or yoy (same period, previous year).)", + "default": "yoy", + "optional": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['oecd']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default.", + "default": "oecd", + "optional": true + } + ], + "oecd": [ + { + "name": "country", + "type": "Literal['G20', 'G7', 'argentina', 'australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'colombia', 'costa_rica', 'croatia', 'czech_republic', 'denmark', 'estonia', 'euro_area_19', 'europe', 'european_union_27', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'india', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'norway', 'oecd_total', 'poland', 'portugal', 'romania', 'russia', 'saudi_arabia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'all']", + "description": "Country to get GDP for.", + "default": "united_states", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[GdpReal]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['oecd']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": null, + "optional": true + }, + { + "name": "value", + "type": "float", + "description": "Nominal GDP value on the date.", + "default": null, + "optional": true + } + ], + "oecd": [] + }, + "model": "GdpReal" + }, + "/economy/calendar": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the upcoming, or historical, economic calendar of global events.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# By default, the calendar will be forward-looking.\nobb.economy.calendar(provider='fmp')\nobb.economy.calendar(provider='fmp', start_date='2020-03-01', end_date='2020-03-31')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'tradingeconomics']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [], + "tradingeconomics": [ + { + "name": "country", + "type": "Union[str, List[str]]", + "description": "Country of the event. Multiple items allowed for provider(s): tradingeconomics.", + "default": null, + "optional": true + }, + { + "name": "importance", + "type": "Literal['Low', 'Medium', 'High']", + "description": "Importance of the event.", + "default": null, + "optional": true + }, + { + "name": "group", + "type": "Literal['interest rate', 'inflation', 'bonds', 'consumer', 'gdp', 'government', 'housing', 'labour', 'markets', 'money', 'prices', 'trade', 'business']", + "description": "Grouping of events", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EconomicCalendar]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'tradingeconomics']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "datetime", + "description": "The date of the data.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Country of event.", + "default": null, + "optional": true + }, + { + "name": "event", + "type": "str", + "description": "Event name.", + "default": null, + "optional": true + }, + { + "name": "reference", + "type": "str", + "description": "Abbreviated period for which released data refers to.", + "default": null, + "optional": true + }, + { + "name": "source", + "type": "str", + "description": "Source of the data.", + "default": null, + "optional": true + }, + { + "name": "sourceurl", + "type": "str", + "description": "Source URL.", + "default": null, + "optional": true + }, + { + "name": "actual", + "type": "Union[str, float]", + "description": "Latest released value.", + "default": null, + "optional": true + }, + { + "name": "previous", + "type": "Union[str, float]", + "description": "Value for the previous period after the revision (if revision is applicable).", + "default": null, + "optional": true + }, + { + "name": "consensus", + "type": "Union[str, float]", + "description": "Average forecast among a representative group of economists.", + "default": null, + "optional": true + }, + { + "name": "forecast", + "type": "Union[str, float]", + "description": "Trading Economics projections", + "default": null, + "optional": true + }, + { + "name": "url", + "type": "str", + "description": "Trading Economics URL", + "default": null, + "optional": true + }, + { + "name": "importance", + "type": "Union[Literal[0, 1, 2, 3], str]", + "description": "Importance of the event. 1-Low, 2-Medium, 3-High", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency of the data.", + "default": null, + "optional": true + }, + { + "name": "unit", + "type": "str", + "description": "Unit of the data.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "change", + "type": "float", + "description": "Value change since previous.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Percentage change since previous.", + "default": null, + "optional": true + }, + { + "name": "updated_at", + "type": "datetime", + "description": "Last updated timestamp.", + "default": null, + "optional": true + }, + { + "name": "created_at", + "type": "datetime", + "description": "Created at timestamp.", + "default": null, + "optional": true + } + ], + "tradingeconomics": [] + }, + "model": "EconomicCalendar" + }, + "/economy/cpi": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Consumer Price Index (CPI).\n\nReturns either the rescaled index value, or a rate of change (inflation).", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.cpi(country='japan,china,turkey', provider='fred')\n# Use the `units` parameter to define the reference period for the change in values.\nobb.economy.cpi(country='united_states,united_kingdom', units='growth_previous', provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "country", + "type": "Union[str, List[str]]", + "description": "The country to get data. Multiple items allowed for provider(s): fred.", + "default": "", + "optional": false + }, + { + "name": "units", + "type": "Literal['growth_previous', 'growth_same', 'index_2015']", + "description": "The unit of measurement for the data. Options: - `growth_previous`: Percent growth from the previous period. If monthly data, this is month-over-month, etc - `growth_same`: Percent growth from the same period in the previous year. If looking at monthly data, this would be year-over-year, etc. - `index_2015`: Rescaled index value, such that the value in 2015 is 100.", + "default": "growth_same", + "optional": true + }, + { + "name": "frequency", + "type": "Literal['monthly', 'quarter', 'annual']", + "description": "The frequency of the data. Options: `monthly`, `quarter`, and `annual`.", + "default": "monthly", + "optional": true + }, + { + "name": "harmonized", + "type": "bool", + "description": "Whether you wish to obtain harmonized data.", + "default": false, + "optional": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[ConsumerPriceIndex]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "ConsumerPriceIndex" + }, + "/economy/risk_premium": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Market Risk Premium by country.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.risk_premium(provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[RiskPremium]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "country", + "type": "str", + "description": "Market country.", + "default": "", + "optional": false + }, + { + "name": "continent", + "type": "str", + "description": "Continent of the country.", + "default": null, + "optional": true + }, + { + "name": "total_equity_risk_premium", + "type": "Annotated[float, Gt(gt=0)]", + "description": "Total equity risk premium for the country.", + "default": null, + "optional": true + }, + { + "name": "country_risk_premium", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Country-specific risk premium.", + "default": null, + "optional": true + } + ], + "fmp": [] + }, + "model": "RiskPremium" + }, + "/economy/fred_search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search for FRED series or economic releases by ID or string.\n\nThis does not return the observation values, only the metadata.\nUse this function to find series IDs for `fred_series()`.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.fred_search(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str", + "description": "The search word(s).", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [ + { + "name": "is_release", + "type": "bool", + "description": "Is release? If True, other search filter variables are ignored. If no query text or release_id is supplied, this defaults to True.", + "default": false, + "optional": true + }, + { + "name": "release_id", + "type": "Union[int, str]", + "description": "A specific release ID to target.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return. (1-1000)", + "default": null, + "optional": true + }, + { + "name": "offset", + "type": "Annotated[int, Ge(ge=0)]", + "description": "Offset the results in conjunction with limit.", + "default": 0, + "optional": true + }, + { + "name": "filter_variable", + "type": "Literal['frequency', 'units', 'seasonal_adjustment']", + "description": "Filter by an attribute.", + "default": null, + "optional": true + }, + { + "name": "filter_value", + "type": "str", + "description": "String value to filter the variable by. Used in conjunction with filter_variable.", + "default": null, + "optional": true + }, + { + "name": "tag_names", + "type": "str", + "description": "A semicolon delimited list of tag names that series match all of. Example: 'japan;imports'", + "default": null, + "optional": true + }, + { + "name": "exclude_tag_names", + "type": "str", + "description": "A semicolon delimited list of tag names that series match none of. Example: 'imports;services'. Requires that variable tag_names also be set to limit the number of matching series.", + "default": null, + "optional": true + }, + { + "name": "series_id", + "type": "str", + "description": "A FRED Series ID to return series group information for. This returns the required information to query for regional data. Not all series that are in FRED have geographical data. Entering a value for series_id will override all other parameters. Multiple series_ids can be separated by commas.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[FredSearch]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "release_id", + "type": "Union[int, str]", + "description": "The release ID for queries.", + "default": null, + "optional": true + }, + { + "name": "series_id", + "type": "str", + "description": "The series ID for the item in the release.", + "default": null, + "optional": true + }, + { + "name": "name", + "type": "str", + "description": "The name of the release.", + "default": null, + "optional": true + }, + { + "name": "title", + "type": "str", + "description": "The title of the series.", + "default": null, + "optional": true + }, + { + "name": "observation_start", + "type": "date", + "description": "The date of the first observation in the series.", + "default": null, + "optional": true + }, + { + "name": "observation_end", + "type": "date", + "description": "The date of the last observation in the series.", + "default": null, + "optional": true + }, + { + "name": "frequency", + "type": "str", + "description": "The frequency of the data.", + "default": null, + "optional": true + }, + { + "name": "frequency_short", + "type": "str", + "description": "Short form of the data frequency.", + "default": null, + "optional": true + }, + { + "name": "units", + "type": "str", + "description": "The units of the data.", + "default": null, + "optional": true + }, + { + "name": "units_short", + "type": "str", + "description": "Short form of the data units.", + "default": null, + "optional": true + }, + { + "name": "seasonal_adjustment", + "type": "str", + "description": "The seasonal adjustment of the data.", + "default": null, + "optional": true + }, + { + "name": "seasonal_adjustment_short", + "type": "str", + "description": "Short form of the data seasonal adjustment.", + "default": null, + "optional": true + }, + { + "name": "last_updated", + "type": "datetime", + "description": "The datetime of the last update to the data.", + "default": null, + "optional": true + }, + { + "name": "notes", + "type": "str", + "description": "Description of the release.", + "default": null, + "optional": true + }, + { + "name": "press_release", + "type": "bool", + "description": "If the release is a press release.", + "default": null, + "optional": true + }, + { + "name": "url", + "type": "str", + "description": "URL to the release.", + "default": null, + "optional": true + } + ], + "fred": [ + { + "name": "popularity", + "type": "int", + "description": "Popularity of the series", + "default": null, + "optional": true + }, + { + "name": "group_popularity", + "type": "int", + "description": "Group popularity of the release", + "default": null, + "optional": true + }, + { + "name": "region_type", + "type": "str", + "description": "The region type of the series.", + "default": null, + "optional": true + }, + { + "name": "series_group", + "type": "Union[int, str]", + "description": "The series group ID of the series. This value is used to query for regional data.", + "default": null, + "optional": true + } + ] + }, + "model": "FredSearch" + }, + "/economy/fred_series": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get data by series ID from FRED.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.fred_series(symbol='NFCI', provider='fred')\n# Multiple series can be passed in as a list.\nobb.economy.fred_series(symbol='NFCI,STLFSI4', provider='fred')\n# Use the `transform` parameter to transform the data as change, log, or percent change.\nobb.economy.fred_series(symbol='CBBTCUSD', transform=pc1, provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fred.", + "default": "", + "optional": false + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100000, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred', 'intrinio']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [ + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100000, + "optional": true + }, + { + "name": "frequency", + "type": "Literal['a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", + "description": "Frequency aggregation to convert high frequency data to lower frequency. None = No change a = Annual q = Quarterly m = Monthly w = Weekly d = Daily wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday", + "default": null, + "optional": true + }, + { + "name": "aggregation_method", + "type": "Literal['avg', 'sum', 'eop']", + "description": "A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. avg = Average sum = Sum eop = End of Period", + "default": "eop", + "optional": true + }, + { + "name": "transform", + "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", + "description": "Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "all_pages", + "type": "bool", + "description": "Returns all pages of data from the API call at once.", + "default": false, + "optional": true + }, + { + "name": "sleep", + "type": "float", + "description": "Time to sleep between requests to avoid rate limiting.", + "default": 1.0, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[FredSeries]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred', 'intrinio']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + } + ], + "fred": [], + "intrinio": [ + { + "name": "value", + "type": "float", + "description": "Value of the index.", + "default": null, + "optional": true + } + ] + }, + "model": "FredSeries" + }, + "/economy/money_measures": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Money Measures (M1/M2 and components).\n\nThe Federal Reserve publishes as part of the H.6 Release.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.money_measures(provider='federal_reserve')\nobb.economy.money_measures(adjusted=False, provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "adjusted", + "type": "bool", + "description": "Whether to return seasonally adjusted data.", + "default": true, + "optional": true + }, + { + "name": "provider", + "type": "Literal['federal_reserve']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default.", + "default": "federal_reserve", + "optional": true + } + ], + "federal_reserve": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[MoneyMeasures]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['federal_reserve']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "month", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "M1", + "type": "float", + "description": "Value of the M1 money supply in billions.", + "default": "", + "optional": false + }, + { + "name": "M2", + "type": "float", + "description": "Value of the M2 money supply in billions.", + "default": "", + "optional": false + }, + { + "name": "currency", + "type": "float", + "description": "Value of currency in circulation in billions.", + "default": null, + "optional": true + }, + { + "name": "demand_deposits", + "type": "float", + "description": "Value of demand deposits in billions.", + "default": null, + "optional": true + }, + { + "name": "retail_money_market_funds", + "type": "float", + "description": "Value of retail money market funds in billions.", + "default": null, + "optional": true + }, + { + "name": "other_liquid_deposits", + "type": "float", + "description": "Value of other liquid deposits in billions.", + "default": null, + "optional": true + }, + { + "name": "small_denomination_time_deposits", + "type": "float", + "description": "Value of small denomination time deposits in billions.", + "default": null, + "optional": true + } + ], + "federal_reserve": [] + }, + "model": "MoneyMeasures" + }, + "/economy/unemployment": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get global unemployment data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.unemployment(provider='oecd')\nobb.economy.unemployment(country=all, frequency=quarterly, provider='oecd')\n# Demographics for the statistics are selected with the `age` parameter.\nobb.economy.unemployment(country=all, frequency=quarterly, age=25-54, provider='oecd')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['oecd']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default.", + "default": "oecd", + "optional": true + } + ], + "oecd": [ + { + "name": "country", + "type": "Literal['colombia', 'new_zealand', 'united_kingdom', 'italy', 'luxembourg', 'euro_area19', 'sweden', 'oecd', 'south_africa', 'denmark', 'canada', 'switzerland', 'slovakia', 'hungary', 'portugal', 'spain', 'france', 'czech_republic', 'costa_rica', 'japan', 'slovenia', 'russia', 'austria', 'latvia', 'netherlands', 'israel', 'iceland', 'united_states', 'ireland', 'mexico', 'germany', 'greece', 'turkey', 'australia', 'poland', 'south_korea', 'chile', 'finland', 'european_union27_2020', 'norway', 'lithuania', 'euro_area20', 'estonia', 'belgium', 'brazil', 'indonesia', 'all']", + "description": "Country to get GDP for.", + "default": "united_states", + "optional": true + }, + { + "name": "sex", + "type": "Literal['total', 'male', 'female']", + "description": "Sex to get unemployment for.", + "default": "total", + "optional": true + }, + { + "name": "frequency", + "type": "Literal['monthly', 'quarterly', 'annual']", + "description": "Frequency to get unemployment for.", + "default": "monthly", + "optional": true + }, + { + "name": "age", + "type": "Literal['total', '15-24', '15-64', '25-54', '55-64']", + "description": "Age group to get unemployment for. Total indicates 15 years or over", + "default": "total", + "optional": true + }, + { + "name": "seasonal_adjustment", + "type": "bool", + "description": "Whether to get seasonally adjusted unemployment. Defaults to False.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[Unemployment]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['oecd']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": null, + "optional": true + }, + { + "name": "value", + "type": "float", + "description": "Unemployment rate (given as a whole number, i.e 10=10%)", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Country for which unemployment rate is given", + "default": null, + "optional": true + } + ], + "oecd": [] + }, + "model": "Unemployment" + }, + "/economy/composite_leading_indicator": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Use the composite leading indicator (CLI).\n\nIt is designed to provide early signals of turning points\nin business cycles showing fluctuation of the economic activity around its long term potential level.\n\nCLIs show short-term economic movements in qualitative rather than quantitative terms.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.composite_leading_indicator(provider='oecd')\nobb.economy.composite_leading_indicator(country=all, provider='oecd')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['oecd']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default.", + "default": "oecd", + "optional": true + } + ], + "oecd": [ + { + "name": "country", + "type": "Literal['united_states', 'united_kingdom', 'japan', 'mexico', 'indonesia', 'australia', 'brazil', 'canada', 'italy', 'germany', 'turkey', 'france', 'south_africa', 'south_korea', 'spain', 'india', 'china', 'g7', 'g20', 'all']", + "description": "Country to get GDP for.", + "default": "united_states", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CLI]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['oecd']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": null, + "optional": true + }, + { + "name": "value", + "type": "float", + "description": "CLI value", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Country for which CLI is given", + "default": null, + "optional": true + } + ], + "oecd": [] + }, + "model": "CLI" + }, + "/economy/short_term_interest_rate": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Short-term interest rates.\n\nThey are the rates at which short-term borrowings are effected between\nfinancial institutions or the rate at which short-term government paper is issued or traded in the market.\n\nShort-term interest rates are generally averages of daily rates, measured as a percentage.\nShort-term interest rates are based on three-month money market rates where available.\nTypical standardised names are \"money market rate\" and \"treasury bill rate\".", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.short_term_interest_rate(provider='oecd')\nobb.economy.short_term_interest_rate(country=all, frequency=quarterly, provider='oecd')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['oecd']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default.", + "default": "oecd", + "optional": true + } + ], + "oecd": [ + { + "name": "country", + "type": "Literal['belgium', 'ireland', 'mexico', 'indonesia', 'new_zealand', 'japan', 'united_kingdom', 'france', 'chile', 'canada', 'netherlands', 'united_states', 'south_korea', 'norway', 'austria', 'south_africa', 'denmark', 'switzerland', 'hungary', 'luxembourg', 'australia', 'germany', 'sweden', 'iceland', 'turkey', 'greece', 'israel', 'czech_republic', 'latvia', 'slovenia', 'poland', 'estonia', 'lithuania', 'portugal', 'costa_rica', 'slovakia', 'finland', 'spain', 'russia', 'euro_area19', 'colombia', 'italy', 'india', 'china', 'croatia', 'all']", + "description": "Country to get GDP for.", + "default": "united_states", + "optional": true + }, + { + "name": "frequency", + "type": "Literal['monthly', 'quarterly', 'annual']", + "description": "Frequency to get interest rate for for.", + "default": "monthly", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[STIR]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['oecd']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": null, + "optional": true + }, + { + "name": "value", + "type": "float", + "description": "Interest rate (given as a whole number, i.e 10=10%)", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Country for which interest rate is given", + "default": null, + "optional": true + } + ], + "oecd": [] + }, + "model": "STIR" + }, + "/economy/long_term_interest_rate": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Long-term interest rates that refer to government bonds maturing in ten years.\n\nRates are mainly determined by the price charged by the lender, the risk from the borrower and the\nfall in the capital value. Long-term interest rates are generally averages of daily rates,\nmeasured as a percentage. These interest rates are implied by the prices at which the government bonds are\ntraded on financial markets, not the interest rates at which the loans were issued.\nIn all cases, they refer to bonds whose capital repayment is guaranteed by governments.\nLong-term interest rates are one of the determinants of business investment.\nLow long-term interest rates encourage investment in new equipment and high interest rates discourage it.\nInvestment is, in turn, a major source of economic growth.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.long_term_interest_rate(provider='oecd')\nobb.economy.long_term_interest_rate(country=all, frequency=quarterly, provider='oecd')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['oecd']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default.", + "default": "oecd", + "optional": true + } + ], + "oecd": [ + { + "name": "country", + "type": "Literal['belgium', 'ireland', 'mexico', 'indonesia', 'new_zealand', 'japan', 'united_kingdom', 'france', 'chile', 'canada', 'netherlands', 'united_states', 'south_korea', 'norway', 'austria', 'south_africa', 'denmark', 'switzerland', 'hungary', 'luxembourg', 'australia', 'germany', 'sweden', 'iceland', 'turkey', 'greece', 'israel', 'czech_republic', 'latvia', 'slovenia', 'poland', 'estonia', 'lithuania', 'portugal', 'costa_rica', 'slovakia', 'finland', 'spain', 'russia', 'euro_area19', 'colombia', 'italy', 'india', 'china', 'croatia', 'all']", + "description": "Country to get GDP for.", + "default": "united_states", + "optional": true + }, + { + "name": "frequency", + "type": "Literal['monthly', 'quarterly', 'annual']", + "description": "Frequency to get interest rate for for.", + "default": "monthly", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[LTIR]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['oecd']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": null, + "optional": true + }, + { + "name": "value", + "type": "float", + "description": "Interest rate (given as a whole number, i.e 10=10%)", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Country for which interest rate is given", + "default": null, + "optional": true + } + ], + "oecd": [] + }, + "model": "LTIR" + }, + "/economy/fred_regional": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Query the Geo Fred API for regional economic data by series group.\n\nThe series group ID is found by using `fred_search` and the `series_id` parameter.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.fred_regional(symbol='NYICLAIMS', provider='fred')\n# With a date, time series data is returned.\nobb.economy.fred_regional(symbol='NYICLAIMS', start_date='2021-01-01', end_date='2021-12-31', limit=10, provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100000, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [ + { + "name": "symbol", + "type": "str", + "description": "For this function, it is the series_group ID or series ID. If the symbol provided is for a series_group, set the `is_series_group` parameter to True. Not all series that are in FRED have geographical data.", + "default": "", + "optional": false + }, + { + "name": "is_series_group", + "type": "bool", + "description": "When True, the symbol provided is for a series_group, else it is for a series ID.", + "default": false, + "optional": true + }, + { + "name": "region_type", + "type": "Literal['bea', 'msa', 'frb', 'necta', 'state', 'country', 'county', 'censusregion']", + "description": "The type of regional data. Parameter is only valid when `is_series_group` is True.", + "default": null, + "optional": true + }, + { + "name": "season", + "type": "Literal['SA', 'NSA', 'SSA']", + "description": "The seasonal adjustments to the data. Parameter is only valid when `is_series_group` is True.", + "default": "NSA", + "optional": true + }, + { + "name": "units", + "type": "str", + "description": "The units of the data. This should match the units returned from searching by series ID. An incorrect field will not necessarily return an error. Parameter is only valid when `is_series_group` is True.", + "default": null, + "optional": true + }, + { + "name": "frequency", + "type": "Literal['d', 'w', 'bw', 'm', 'q', 'sa', 'a', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", + "description": "Frequency aggregation to convert high frequency data to lower frequency. Parameter is only valid when `is_series_group` is True. a = Annual sa= Semiannual q = Quarterly m = Monthly w = Weekly d = Daily wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday", + "default": null, + "optional": true + }, + { + "name": "aggregation_method", + "type": "Literal['avg', 'sum', 'eop']", + "description": "A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. Only valid when `is_series_group` is True. avg = Average sum = Sum eop = End of Period", + "default": "avg", + "optional": true + }, + { + "name": "transform", + "type": "Literal['lin', 'chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", + "description": "Transformation type. Only valid when `is_series_group` is True. lin = Levels (No transformation) chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log", + "default": "lin", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[FredRegional]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + } + ], + "fred": [ + { + "name": "region", + "type": "str", + "description": "The name of the region.", + "default": "", + "optional": false + }, + { + "name": "code", + "type": "Union[str, int]", + "description": "The code of the region.", + "default": "", + "optional": false + }, + { + "name": "value", + "type": "Union[int, float]", + "description": "The obersvation value. The units are defined in the search results by series ID.", + "default": null, + "optional": true + }, + { + "name": "series_id", + "type": "str", + "description": "The individual series ID for the region.", + "default": "", + "optional": false + } + ] + }, + "model": "FredRegional" + }, + "/economy/country_profile": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get a profile of country statistics and economic indicators.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.country_profile(provider='econdb', country='united_kingdom')\n# Enter the country as the full name, or iso code. If `latest` is False, the complete history for each series is returned.\nobb.economy.country_profile(country='united_states,jp', latest=False, provider='econdb')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "country", + "type": "Union[str, List[str]]", + "description": "The country to get data. Multiple items allowed for provider(s): econdb.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['econdb']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'econdb' if there is no default.", + "default": "econdb", + "optional": true + } + ], + "econdb": [ + { + "name": "latest", + "type": "bool", + "description": "If True, return only the latest data. If False, return all available data for each indicator.", + "default": true, + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "If True, the request will be cached for one day.Using cache is recommended to avoid needlessly requesting the same data.", + "default": true, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CountryProfile]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['econdb']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "country", + "type": "str", + "description": "", + "default": "", + "optional": false + }, + { + "name": "population", + "type": "int", + "description": "Population.", + "default": null, + "optional": true + }, + { + "name": "gdp_usd", + "type": "float", + "description": "Gross Domestic Product, in billions of USD.", + "default": null, + "optional": true + }, + { + "name": "gdp_qoq", + "type": "float", + "description": "GDP growth quarter-over-quarter change, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "gdp_yoy", + "type": "float", + "description": "GDP growth year-over-year change, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "cpi_yoy", + "type": "float", + "description": "Consumer Price Index year-over-year change, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "core_yoy", + "type": "float", + "description": "Core Consumer Price Index year-over-year change, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "retail_sales_yoy", + "type": "float", + "description": "Retail Sales year-over-year change, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "industrial_production_yoy", + "type": "float", + "description": "Industrial Production year-over-year change, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "policy_rate", + "type": "float", + "description": "Short term policy rate, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "yield_10y", + "type": "float", + "description": "10-year government bond yield, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "govt_debt_gdp", + "type": "float", + "description": "Government debt as a percent (normalized) of GDP.", + "default": null, + "optional": true + }, + { + "name": "current_account_gdp", + "type": "float", + "description": "Current account balance as a percent (normalized) of GDP.", + "default": null, + "optional": true + }, + { + "name": "jobless_rate", + "type": "float", + "description": "Unemployment rate, as a normalized percent.", + "default": null, + "optional": true + } + ], + "econdb": [] + }, + "model": "CountryProfile" + }, + "/economy/available_indicators": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the available economic indicators for a provider.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.available_indicators(provider='econdb')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "provider", + "type": "Literal['econdb']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'econdb' if there is no default.", + "default": "econdb", + "optional": true + } + ], + "econdb": [ + { + "name": "use_cache", + "type": "bool", + "description": "Whether to use cache or not, by default is True The cache of indicator symbols will persist for one week.", + "default": true, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[AvailableIndicators]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['econdb']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol_root", + "type": "str", + "description": "The root symbol representing the indicator.", + "default": null, + "optional": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. The root symbol with additional codes.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "The name of the country, region, or entity represented by the symbol.", + "default": null, + "optional": true + }, + { + "name": "iso", + "type": "str", + "description": "The ISO code of the country, region, or entity represented by the symbol.", + "default": null, + "optional": true + }, + { + "name": "description", + "type": "str", + "description": "The description of the indicator.", + "default": null, + "optional": true + }, + { + "name": "frequency", + "type": "str", + "description": "The frequency of the indicator data.", + "default": null, + "optional": true + } + ], + "econdb": [ + { + "name": "currency", + "type": "str", + "description": "The currency, or unit, the data is based in.", + "default": null, + "optional": true + }, + { + "name": "scale", + "type": "str", + "description": "The scale of the data.", + "default": null, + "optional": true + }, + { + "name": "multiplier", + "type": "int", + "description": "The multiplier of the data to arrive at whole units.", + "default": "", + "optional": false + }, + { + "name": "transformation", + "type": "str", + "description": "Transformation type.", + "default": "", + "optional": false + }, + { + "name": "source", + "type": "str", + "description": "The original source of the data.", + "default": null, + "optional": true + }, + { + "name": "first_date", + "type": "date", + "description": "The first date of the data.", + "default": null, + "optional": true + }, + { + "name": "last_date", + "type": "date", + "description": "The last date of the data.", + "default": null, + "optional": true + }, + { + "name": "last_insert_timestamp", + "type": "datetime", + "description": "The time of the last update. Data is typically reported with a lag.", + "default": null, + "optional": true + } + ] + }, + "model": "AvailableIndicators" + }, + "/economy/indicators": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get economic indicators by country and indicator.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.indicators(provider='econdb', symbol='PCOCO')\n# Enter the country as the full name, or iso code. Use `available_indicators()` to get a list of supported indicators from EconDB.\nobb.economy.indicators(symbol='CPI', country='united_states,jp', provider='econdb')\n# Use the `main` symbol to get the group of main indicators for a country.\nobb.economy.indicators(provider='econdb', symbol='main', country='eu')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Multiple items allowed for provider(s): econdb.", + "default": "", + "optional": false + }, + { + "name": "country", + "type": "Union[str, List[str]]", + "description": "The country to get data. The country represented by the indicator, if available. Multiple items allowed for provider(s): econdb.", + "default": null, + "optional": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['econdb']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'econdb' if there is no default.", + "default": "econdb", + "optional": true + } + ], + "econdb": [ + { + "name": "transform", + "type": "Literal['toya', 'tpop', 'tusd', 'tpgp']", + "description": "The transformation to apply to the data, default is None. tpop: Change from previous period toya: Change from one year ago tusd: Values as US dollars tpgp: Values as a percent of GDP Only 'tpop' and 'toya' are applicable to all indicators. Applying transformations across multiple indicators/countries may produce unexpected results. This is because not all indicators are compatible with all transformations, and the original units and scale differ between entities. `tusd` should only be used where values are currencies.", + "default": null, + "optional": true + }, + { + "name": "frequency", + "type": "Literal['annual', 'quarter', 'month']", + "description": "The frequency of the data, default is 'quarter'. Only valid when 'symbol' is 'main'.", + "default": "quarter", + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "If True, the request will be cached for one day. Using cache is recommended to avoid needlessly requesting the same data.", + "default": true, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EconomicIndicators]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['econdb']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "symbol_root", + "type": "str", + "description": "The root symbol for the indicator (e.g. GDP).", + "default": null, + "optional": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "The country represented by the data.", + "default": null, + "optional": true + }, + { + "name": "value", + "type": "Union[int, float]", + "description": "", + "default": null, + "optional": true + } + ], + "econdb": [] + }, + "model": "EconomicIndicators" + }, + "/equity/calendar/ipo": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical and upcoming initial public offerings (IPOs).", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.calendar.ipo(provider='intrinio')\n# Get all IPOs available.\nobb.equity.calendar.ipo(provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100, + "optional": true + }, + { + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", + "optional": true + } + ], + "intrinio": [ + { + "name": "status", + "type": "Literal['upcoming', 'priced', 'withdrawn']", + "description": "Status of the IPO. [upcoming, priced, or withdrawn]", + "default": null, + "optional": true + }, + { + "name": "min_value", + "type": "int", + "description": "Return IPOs with an offer dollar amount greater than the given amount.", + "default": null, + "optional": true + }, + { + "name": "max_value", + "type": "int", + "description": "Return IPOs with an offer dollar amount less than the given amount.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CalendarIpo]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['intrinio']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "ipo_date", + "type": "date", + "description": "The date of the IPO, when the stock first trades on a major exchange.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "status", + "type": "Literal['upcoming', 'priced', 'withdrawn']", + "description": "The status of the IPO. Upcoming IPOs have not taken place yet but are expected to. Priced IPOs have taken place. Withdrawn IPOs were expected to take place, but were subsequently withdrawn.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "The acronym of the stock exchange that the company is going to trade publicly on. Typically NYSE or NASDAQ.", + "default": null, + "optional": true + }, + { + "name": "offer_amount", + "type": "float", + "description": "The total dollar amount of shares offered in the IPO. Typically this is share price * share count", + "default": null, + "optional": true + }, + { + "name": "share_price", + "type": "float", + "description": "The price per share at which the IPO was offered.", + "default": null, + "optional": true + }, + { + "name": "share_price_lowest", + "type": "float", + "description": "The expected lowest price per share at which the IPO will be offered. Before an IPO is priced, companies typically provide a range of prices per share at which they expect to offer the IPO (typically available for upcoming IPOs).", + "default": null, + "optional": true + }, + { + "name": "share_price_highest", + "type": "float", + "description": "The expected highest price per share at which the IPO will be offered. Before an IPO is priced, companies typically provide a range of prices per share at which they expect to offer the IPO (typically available for upcoming IPOs).", + "default": null, + "optional": true + }, + { + "name": "share_count", + "type": "int", + "description": "The number of shares offered in the IPO.", + "default": null, + "optional": true + }, + { + "name": "share_count_lowest", + "type": "int", + "description": "The expected lowest number of shares that will be offered in the IPO. Before an IPO is priced, companies typically provide a range of shares that they expect to offer in the IPO (typically available for upcoming IPOs).", + "default": null, + "optional": true + }, + { + "name": "share_count_highest", + "type": "int", + "description": "The expected highest number of shares that will be offered in the IPO. Before an IPO is priced, companies typically provide a range of shares that they expect to offer in the IPO (typically available for upcoming IPOs).", + "default": null, + "optional": true + }, + { + "name": "announcement_url", + "type": "str", + "description": "The URL to the company's announcement of the IPO", + "default": null, + "optional": true + }, + { + "name": "sec_report_url", + "type": "str", + "description": "The URL to the company's S-1, S-1/A, F-1, or F-1/A SEC filing, which is required to be filed before an IPO takes place.", + "default": null, + "optional": true + }, + { + "name": "open_price", + "type": "float", + "description": "The opening price at the beginning of the first trading day (only available for priced IPOs).", + "default": null, + "optional": true + }, + { + "name": "close_price", + "type": "float", + "description": "The closing price at the end of the first trading day (only available for priced IPOs).", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "int", + "description": "The volume at the end of the first trading day (only available for priced IPOs).", + "default": null, + "optional": true + }, + { + "name": "day_change", + "type": "float", + "description": "The percentage change between the open price and the close price on the first trading day (only available for priced IPOs).", + "default": null, + "optional": true + }, + { + "name": "week_change", + "type": "float", + "description": "The percentage change between the open price on the first trading day and the close price approximately a week after the first trading day (only available for priced IPOs).", + "default": null, + "optional": true + }, + { + "name": "month_change", + "type": "float", + "description": "The percentage change between the open price on the first trading day and the close price approximately a month after the first trading day (only available for priced IPOs).", + "default": null, + "optional": true + }, + { + "name": "id", + "type": "str", + "description": "The Intrinio ID of the IPO.", + "default": null, + "optional": true + }, + { + "name": "company", + "type": "IntrinioCompany", + "description": "The company that is going public via the IPO.", + "default": null, + "optional": true + }, + { + "name": "security", + "type": "IntrinioSecurity", + "description": "The primary Security for the Company that is going public via the IPO", + "default": null, + "optional": true + } + ] + }, + "model": "CalendarIpo" + }, + "/equity/calendar/dividend": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical and upcoming dividend payments. Includes dividend amount, ex-dividend and payment dates.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.calendar.dividend(provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CalendarDividend]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "ex_dividend_date", + "type": "date", + "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", + "default": "", + "optional": false + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "amount", + "type": "float", + "description": "The dividend amount per share.", + "default": null, + "optional": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": null, + "optional": true + }, + { + "name": "record_date", + "type": "date", + "description": "The record date of ownership for eligibility.", + "default": null, + "optional": true + }, + { + "name": "payment_date", + "type": "date", + "description": "The payment date of the dividend.", + "default": null, + "optional": true + }, + { + "name": "declaration_date", + "type": "date", + "description": "Declaration date of the dividend.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "adjusted_amount", + "type": "float", + "description": "The adjusted-dividend amount.", + "default": null, + "optional": true + }, + { + "name": "label", + "type": "str", + "description": "Ex-dividend date formatted for display.", + "default": null, + "optional": true + } + ] + }, + "model": "CalendarDividend" + }, + "/equity/calendar/splits": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical and upcoming stock split operations.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.calendar.splits(provider='fmp')\n# Get stock splits calendar for specific dates.\nobb.equity.calendar.splits(start_date='2024-02-01', end_date='2024-02-07', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CalendarSplits]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "label", + "type": "str", + "description": "Label of the stock splits.", + "default": "", + "optional": false + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "numerator", + "type": "float", + "description": "Numerator of the stock splits.", + "default": "", + "optional": false + }, + { + "name": "denominator", + "type": "float", + "description": "Denominator of the stock splits.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "CalendarSplits" + }, + "/equity/calendar/earnings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical and upcoming company earnings releases. Includes earnings per share (EPS) and revenue data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.calendar.earnings(provider='fmp')\n# Get earnings calendar for specific dates.\nobb.equity.calendar.earnings(start_date='2024-02-01', end_date='2024-02-07', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CalendarEarnings]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "report_date", + "type": "date", + "description": "The date of the earnings report.", + "default": "", + "optional": false + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": null, + "optional": true + }, + { + "name": "eps_previous", + "type": "float", + "description": "The earnings-per-share from the same previously reported period.", + "default": null, + "optional": true + }, + { + "name": "eps_consensus", + "type": "float", + "description": "The analyst conesus earnings-per-share estimate.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "eps_actual", + "type": "float", + "description": "The actual earnings per share announced.", + "default": null, + "optional": true + }, + { + "name": "revenue_actual", + "type": "float", + "description": "The actual reported revenue.", + "default": null, + "optional": true + }, + { + "name": "revenue_consensus", + "type": "float", + "description": "The revenue forecast consensus.", + "default": null, + "optional": true + }, + { + "name": "period_ending", + "type": "date", + "description": "The fiscal period end date.", + "default": null, + "optional": true + }, + { + "name": "reporting_time", + "type": "str", + "description": "The reporting time - e.g. after market close.", + "default": null, + "optional": true + }, + { + "name": "updated_date", + "type": "date", + "description": "The date the data was updated last.", + "default": null, + "optional": true + } + ] + }, + "model": "CalendarEarnings" + }, + "/equity/compare/peers": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the closest peers for a given company.\n\nPeers consist of companies trading on the same exchange, operating within the same sector\nand with comparable market capitalizations.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.compare.peers(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityPeers]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "peers_list", + "type": "List[str]", + "description": "A list of equity peers based on sector, exchange and market cap.", + "default": "", + "optional": true + } + ], + "fmp": [] + }, + "model": "EquityPeers" + }, + "/equity/estimates/price_target": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get analyst price targets by company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.price_target(provider='benzinga')\n# Get price targets for Microsoft using 'benzinga' as provider.\nobb.equity.estimates.price_target(start_date=2020-01-01, end_date=2024-02-16, limit=10, symbol='msft', provider='benzinga', action=downgrades)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 200, + "optional": true + }, + { + "name": "provider", + "type": "Literal['benzinga', 'fmp']", + "description": "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.", + "default": "benzinga", + "optional": true + } + ], + "benzinga": [ + { + "name": "page", + "type": "int", + "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. Used in conjunction with the limit and date parameters.", + "default": 0, + "optional": true + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "Date for calendar data, shorthand for date_from and date_to.", + "default": null, + "optional": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "updated", + "type": "Union[date, int]", + "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. The date can be a date string or a Unix timestamp. The date string must be in the format of YYYY-MM-DD.", + "default": null, + "optional": true + }, + { + "name": "importance", + "type": "int", + "description": "Importance level to filter by. Uses Greater Than or Equal To the importance indicated", + "default": null, + "optional": true + }, + { + "name": "action", + "type": "Literal['downgrades', 'maintains', 'reinstates', 'reiterates', 'upgrades', 'assumes', 'initiates', 'terminates', 'removes', 'suspends', 'firm_dissolved']", + "description": "Filter by a specific action_company.", + "default": null, + "optional": true + }, + { + "name": "analyst_ids", + "type": "Union[List[str], str]", + "description": "Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts.", + "default": null, + "optional": true + }, + { + "name": "firm_ids", + "type": "Union[List[str], str]", + "description": "Comma-separated list of firm IDs.", + "default": null, + "optional": true + }, + { + "name": "fields", + "type": "Union[List[str], str]", + "description": "Comma-separated list of fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "with_grade", + "type": "bool", + "description": "Include upgrades and downgrades in the response.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[PriceTarget]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['benzinga', 'fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "published_date", + "type": "Union[date, datetime]", + "description": "Published date of the price target.", + "default": "", + "optional": false + }, + { + "name": "published_time", + "type": "datetime.time", + "description": "Time of the original rating, UTC.", + "default": null, + "optional": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "exchange", + "type": "str", + "description": "Exchange where the company is traded.", + "default": null, + "optional": true + }, + { + "name": "company_name", + "type": "str", + "description": "Name of company that is the subject of rating.", + "default": null, + "optional": true + }, + { + "name": "analyst_name", + "type": "str", + "description": "Analyst name.", + "default": null, + "optional": true + }, + { + "name": "analyst_firm", + "type": "str", + "description": "Name of the analyst firm that published the price target.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency the data is denominated in.", + "default": null, + "optional": true + }, + { + "name": "price_target", + "type": "float", + "description": "The current price target.", + "default": null, + "optional": true + }, + { + "name": "adj_price_target", + "type": "float", + "description": "Adjusted price target for splits and stock dividends.", + "default": null, + "optional": true + }, + { + "name": "price_target_previous", + "type": "float", + "description": "Previous price target.", + "default": null, + "optional": true + }, + { + "name": "previous_adj_price_target", + "type": "float", + "description": "Previous adjusted price target.", + "default": null, + "optional": true + }, + { + "name": "price_when_posted", + "type": "float", + "description": "Price when posted.", + "default": null, + "optional": true + }, + { + "name": "rating_current", + "type": "str", + "description": "The analyst's rating for the company.", + "default": null, + "optional": true + }, + { + "name": "rating_previous", + "type": "str", + "description": "Previous analyst rating for the company.", + "default": null, + "optional": true + }, + { + "name": "action", + "type": "str", + "description": "Description of the change in rating from firm's last rating.", + "default": null, + "optional": true + } + ], + "benzinga": [ + { + "name": "action", + "type": "Literal['Downgrades', 'Maintains', 'Reinstates', 'Reiterates', 'Upgrades', 'Assumes', 'Initiates Coverage On', 'Terminates Coverage On', 'Removes', 'Suspends', 'Firm Dissolved']", + "description": "Description of the change in rating from firm's last rating.Note that all of these terms are precisely defined.", + "default": null, + "optional": true + }, + { + "name": "action_change", + "type": "Literal['Announces', 'Maintains', 'Lowers', 'Raises', 'Removes', 'Adjusts']", + "description": "Description of the change in price target from firm's last price target.", + "default": null, + "optional": true + }, + { + "name": "importance", + "type": "Literal[0, 1, 2, 3, 4, 5]", + "description": "Subjective Basis of How Important Event is to Market. 5 = High", + "default": null, + "optional": true + }, + { + "name": "notes", + "type": "str", + "description": "Notes of the price target.", + "default": null, + "optional": true + }, + { + "name": "analyst_id", + "type": "str", + "description": "Id of the analyst.", + "default": null, + "optional": true + }, + { + "name": "url_news", + "type": "str", + "description": "URL for analyst ratings news articles for this ticker on Benzinga.com.", + "default": null, + "optional": true + }, + { + "name": "url_analyst", + "type": "str", + "description": "URL for analyst ratings page for this ticker on Benzinga.com.", + "default": null, + "optional": true + }, + { + "name": "id", + "type": "str", + "description": "Unique ID of this entry.", + "default": null, + "optional": true + }, + { + "name": "last_updated", + "type": "datetime", + "description": "Last updated timestamp, UTC.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "news_url", + "type": "str", + "description": "News URL of the price target.", + "default": null, + "optional": true + }, + { + "name": "news_title", + "type": "str", + "description": "News title of the price target.", + "default": null, + "optional": true + }, + { + "name": "news_publisher", + "type": "str", + "description": "News publisher of the price target.", + "default": null, + "optional": true + }, + { + "name": "news_base_url", + "type": "str", + "description": "News base URL of the price target.", + "default": null, + "optional": true + } + ] + }, + "model": "PriceTarget" + }, + "/equity/estimates/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical analyst estimates for earnings and revenue.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.historical(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[AnalystEstimates]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "estimated_revenue_low", + "type": "int", + "description": "Estimated revenue low.", + "default": null, + "optional": true + }, + { + "name": "estimated_revenue_high", + "type": "int", + "description": "Estimated revenue high.", + "default": null, + "optional": true + }, + { + "name": "estimated_revenue_avg", + "type": "int", + "description": "Estimated revenue average.", + "default": null, + "optional": true + }, + { + "name": "estimated_sga_expense_low", + "type": "int", + "description": "Estimated SGA expense low.", + "default": null, + "optional": true + }, + { + "name": "estimated_sga_expense_high", + "type": "int", + "description": "Estimated SGA expense high.", + "default": null, + "optional": true + }, + { + "name": "estimated_sga_expense_avg", + "type": "int", + "description": "Estimated SGA expense average.", + "default": null, + "optional": true + }, + { + "name": "estimated_ebitda_low", + "type": "int", + "description": "Estimated EBITDA low.", + "default": null, + "optional": true + }, + { + "name": "estimated_ebitda_high", + "type": "int", + "description": "Estimated EBITDA high.", + "default": null, + "optional": true + }, + { + "name": "estimated_ebitda_avg", + "type": "int", + "description": "Estimated EBITDA average.", + "default": null, + "optional": true + }, + { + "name": "estimated_ebit_low", + "type": "int", + "description": "Estimated EBIT low.", + "default": null, + "optional": true + }, + { + "name": "estimated_ebit_high", + "type": "int", + "description": "Estimated EBIT high.", + "default": null, + "optional": true + }, + { + "name": "estimated_ebit_avg", + "type": "int", + "description": "Estimated EBIT average.", + "default": null, + "optional": true + }, + { + "name": "estimated_net_income_low", + "type": "int", + "description": "Estimated net income low.", + "default": null, + "optional": true + }, + { + "name": "estimated_net_income_high", + "type": "int", + "description": "Estimated net income high.", + "default": null, + "optional": true + }, + { + "name": "estimated_net_income_avg", + "type": "int", + "description": "Estimated net income average.", + "default": null, + "optional": true + }, + { + "name": "estimated_eps_avg", + "type": "float", + "description": "Estimated EPS average.", + "default": null, + "optional": true + }, + { + "name": "estimated_eps_high", + "type": "float", + "description": "Estimated EPS high.", + "default": null, + "optional": true + }, + { + "name": "estimated_eps_low", + "type": "float", + "description": "Estimated EPS low.", + "default": null, + "optional": true + }, + { + "name": "number_analyst_estimated_revenue", + "type": "int", + "description": "Number of analysts who estimated revenue.", + "default": null, + "optional": true + }, + { + "name": "number_analysts_estimated_eps", + "type": "int", + "description": "Number of analysts who estimated EPS.", + "default": null, + "optional": true + } + ], + "fmp": [] + }, + "model": "AnalystEstimates" + }, + "/equity/estimates/consensus": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get consensus price target and recommendation.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.consensus(symbol='AAPL', provider='fmp')\nobb.equity.estimates.consensus(symbol='AAPL,MSFT', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [], + "intrinio": [ + { + "name": "industry_group_number", + "type": "int", + "description": "The Zacks industry group number.", + "default": null, + "optional": true + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[PriceTargetConsensus]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "The company name", + "default": null, + "optional": true + }, + { + "name": "target_high", + "type": "float", + "description": "High target of the price target consensus.", + "default": null, + "optional": true + }, + { + "name": "target_low", + "type": "float", + "description": "Low target of the price target consensus.", + "default": null, + "optional": true + }, + { + "name": "target_consensus", + "type": "float", + "description": "Consensus target of the price target consensus.", + "default": null, + "optional": true + }, + { + "name": "target_median", + "type": "float", + "description": "Median target of the price target consensus.", + "default": null, + "optional": true + } + ], + "fmp": [], + "intrinio": [ + { + "name": "standard_deviation", + "type": "float", + "description": "The standard deviation of target price estimates.", + "default": null, + "optional": true + }, + { + "name": "total_anaylsts", + "type": "int", + "description": "The total number of target price estimates in consensus.", + "default": null, + "optional": true + }, + { + "name": "raised", + "type": "int", + "description": "The number of analysts that have raised their target price estimates.", + "default": null, + "optional": true + }, + { + "name": "lowered", + "type": "int", + "description": "The number of analysts that have lowered their target price estimates.", + "default": null, + "optional": true + }, + { + "name": "most_recent_date", + "type": "date", + "description": "The date of the most recent estimate.", + "default": null, + "optional": true + }, + { + "name": "industry_group_number", + "type": "int", + "description": "The Zacks industry group number.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "recommendation", + "type": "str", + "description": "Recommendation - buy, sell, etc.", + "default": null, + "optional": true + }, + { + "name": "recommendation_mean", + "type": "float", + "description": "Mean recommendation score where 1 is strong buy and 5 is strong sell.", + "default": null, + "optional": true + }, + { + "name": "number_of_analysts", + "type": "int", + "description": "Number of analysts providing opinions.", + "default": null, + "optional": true + }, + { + "name": "current_price", + "type": "float", + "description": "Current price of the stock.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency the stock is priced in.", + "default": null, + "optional": true + } + ] + }, + "model": "PriceTargetConsensus" + }, + "/equity/estimates/analyst_search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search for specific analysts and get their forecast track record.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.analyst_search(provider='benzinga')\nobb.equity.estimates.analyst_search(firm_name='Wedbush', provider='benzinga')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "analyst_name", + "type": "Union[str, List[str]]", + "description": "Analyst names to return. Omitting will return all available analysts. Multiple items allowed for provider(s): benzinga.", + "default": null, + "optional": true + }, + { + "name": "firm_name", + "type": "Union[str, List[str]]", + "description": "Firm names to return. Omitting will return all available firms. Multiple items allowed for provider(s): benzinga.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['benzinga']", + "description": "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.", + "default": "benzinga", + "optional": true + } + ], + "benzinga": [ + { + "name": "analyst_ids", + "type": "Union[str, List[str]]", + "description": "List of analyst IDs to return. Multiple items allowed for provider(s): benzinga.", + "default": null, + "optional": true + }, + { + "name": "firm_ids", + "type": "Union[str, List[str]]", + "description": "Firm IDs to return. Multiple items allowed for provider(s): benzinga.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "Number of results returned. Limit 1000.", + "default": 100, + "optional": true + }, + { + "name": "page", + "type": "int", + "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date.", + "default": 0, + "optional": true + }, + { + "name": "fields", + "type": "Union[str, List[str]]", + "description": "Fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple items allowed for provider(s): benzinga.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[AnalystSearch]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['benzinga']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "last_updated", + "type": "datetime", + "description": "Date of the last update.", + "default": null, + "optional": true + }, + { + "name": "firm_name", + "type": "str", + "description": "Firm name of the analyst.", + "default": null, + "optional": true + }, + { + "name": "name_first", + "type": "str", + "description": "Analyst first name.", + "default": null, + "optional": true + }, + { + "name": "name_last", + "type": "str", + "description": "Analyst last name.", + "default": null, + "optional": true + }, + { + "name": "name_full", + "type": "str", + "description": "Analyst full name.", + "default": "", + "optional": false + } + ], + "benzinga": [ + { + "name": "analyst_id", + "type": "str", + "description": "ID of the analyst.", + "default": null, + "optional": true + }, + { + "name": "firm_id", + "type": "str", + "description": "ID of the analyst firm.", + "default": null, + "optional": true + }, + { + "name": "smart_score", + "type": "float", + "description": "A weighted average of the total_ratings_percentile, overall_avg_return_percentile, and overall_success_rate", + "default": null, + "optional": true + }, + { + "name": "overall_success_rate", + "type": "float", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain overall.", + "default": null, + "optional": true + }, + { + "name": "overall_avg_return_percentile", + "type": "float", + "description": "The percentile (normalized) of this analyst's overall average return per rating in comparison to other analysts' overall average returns per rating.", + "default": null, + "optional": true + }, + { + "name": "total_ratings_percentile", + "type": "float", + "description": "The percentile (normalized) of this analyst's total number of ratings in comparison to the total number of ratings published by all other analysts", + "default": null, + "optional": true + }, + { + "name": "total_ratings", + "type": "int", + "description": "Number of recommendations made by this analyst.", + "default": null, + "optional": true + }, + { + "name": "overall_gain_count", + "type": "int", + "description": "The number of ratings that have gained value since the date of recommendation", + "default": null, + "optional": true + }, + { + "name": "overall_loss_count", + "type": "int", + "description": "The number of ratings that have lost value since the date of recommendation", + "default": null, + "optional": true + }, + { + "name": "overall_average_return", + "type": "float", + "description": "The average percent (normalized) price difference per rating since the date of recommendation", + "default": null, + "optional": true + }, + { + "name": "overall_std_dev", + "type": "float", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings since the date of recommendation", + "default": null, + "optional": true + }, + { + "name": "gain_count_1m", + "type": "int", + "description": "The number of ratings that have gained value over the last month", + "default": null, + "optional": true + }, + { + "name": "loss_count_1m", + "type": "int", + "description": "The number of ratings that have lost value over the last month", + "default": null, + "optional": true + }, + { + "name": "average_return_1m", + "type": "float", + "description": "The average percent (normalized) price difference per rating over the last month", + "default": null, + "optional": true + }, + { + "name": "std_dev_1m", + "type": "float", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last month", + "default": null, + "optional": true + }, + { + "name": "smart_score_1m", + "type": "float", + "description": "A weighted average smart score over the last month.", + "default": null, + "optional": true + }, + { + "name": "success_rate_1m", + "type": "float", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last month", + "default": null, + "optional": true + }, + { + "name": "gain_count_3m", + "type": "int", + "description": "The number of ratings that have gained value over the last 3 months", + "default": null, + "optional": true + }, + { + "name": "loss_count_3m", + "type": "int", + "description": "The number of ratings that have lost value over the last 3 months", + "default": null, + "optional": true + }, + { + "name": "average_return_3m", + "type": "float", + "description": "The average percent (normalized) price difference per rating over the last 3 months", + "default": null, + "optional": true + }, + { + "name": "std_dev_3m", + "type": "float", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 months", + "default": null, + "optional": true + }, + { + "name": "smart_score_3m", + "type": "float", + "description": "A weighted average smart score over the last 3 months.", + "default": null, + "optional": true + }, + { + "name": "success_rate_3m", + "type": "float", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 months", + "default": null, + "optional": true + }, + { + "name": "gain_count_6m", + "type": "int", + "description": "The number of ratings that have gained value over the last 6 months", + "default": null, + "optional": true + }, + { + "name": "loss_count_6m", + "type": "int", + "description": "The number of ratings that have lost value over the last 6 months", + "default": null, + "optional": true + }, + { + "name": "average_return_6m", + "type": "float", + "description": "The average percent (normalized) price difference per rating over the last 6 months", + "default": null, + "optional": true + }, + { + "name": "std_dev_6m", + "type": "float", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 6 months", + "default": null, + "optional": true + }, + { + "name": "gain_count_9m", + "type": "int", + "description": "The number of ratings that have gained value over the last 9 months", + "default": null, + "optional": true + }, + { + "name": "loss_count_9m", + "type": "int", + "description": "The number of ratings that have lost value over the last 9 months", + "default": null, + "optional": true + }, + { + "name": "average_return_9m", + "type": "float", + "description": "The average percent (normalized) price difference per rating over the last 9 months", + "default": null, + "optional": true + }, + { + "name": "std_dev_9m", + "type": "float", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 9 months", + "default": null, + "optional": true + }, + { + "name": "smart_score_9m", + "type": "float", + "description": "A weighted average smart score over the last 9 months.", + "default": null, + "optional": true + }, + { + "name": "success_rate_9m", + "type": "float", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 9 months", + "default": null, + "optional": true + }, + { + "name": "gain_count_1y", + "type": "int", + "description": "The number of ratings that have gained value over the last 1 year", + "default": null, + "optional": true + }, + { + "name": "loss_count_1y", + "type": "int", + "description": "The number of ratings that have lost value over the last 1 year", + "default": null, + "optional": true + }, + { + "name": "average_return_1y", + "type": "float", + "description": "The average percent (normalized) price difference per rating over the last 1 year", + "default": null, + "optional": true + }, + { + "name": "std_dev_1y", + "type": "float", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 1 year", + "default": null, + "optional": true + }, + { + "name": "smart_score_1y", + "type": "float", + "description": "A weighted average smart score over the last 1 year.", + "default": null, + "optional": true + }, + { + "name": "success_rate_1y", + "type": "float", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 1 year", + "default": null, + "optional": true + }, + { + "name": "gain_count_2y", + "type": "int", + "description": "The number of ratings that have gained value over the last 2 years", + "default": null, + "optional": true + }, + { + "name": "loss_count_2y", + "type": "int", + "description": "The number of ratings that have lost value over the last 2 years", + "default": null, + "optional": true + }, + { + "name": "average_return_2y", + "type": "float", + "description": "The average percent (normalized) price difference per rating over the last 2 years", + "default": null, + "optional": true + }, + { + "name": "std_dev_2y", + "type": "float", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 2 years", + "default": null, + "optional": true + }, + { + "name": "smart_score_2y", + "type": "float", + "description": "A weighted average smart score over the last 3 years.", + "default": null, + "optional": true + }, + { + "name": "success_rate_2y", + "type": "float", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 2 years", + "default": null, + "optional": true + }, + { + "name": "gain_count_3y", + "type": "int", + "description": "The number of ratings that have gained value over the last 3 years", + "default": null, + "optional": true + }, + { + "name": "loss_count_3y", + "type": "int", + "description": "The number of ratings that have lost value over the last 3 years", + "default": null, + "optional": true + }, + { + "name": "average_return_3y", + "type": "float", + "description": "The average percent (normalized) price difference per rating over the last 3 years", + "default": null, + "optional": true + }, + { + "name": "std_dev_3y", + "type": "float", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 years", + "default": null, + "optional": true + }, + { + "name": "smart_score_3y", + "type": "float", + "description": "A weighted average smart score over the last 3 years.", + "default": null, + "optional": true + }, + { + "name": "success_rate_3y", + "type": "float", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 years", + "default": null, + "optional": true + } + ] + }, + "model": "AnalystSearch" + }, + "/equity/estimates/forward_sales": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get forward sales estimates.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.forward_sales(symbol='AAPL', provider='intrinio')\nobb.equity.estimates.forward_sales(fiscal_year=2025, fiscal_period=fy, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", + "optional": true + } + ], + "intrinio": [ + { + "name": "fiscal_year", + "type": "int", + "description": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", + "default": null, + "optional": true + }, + { + "name": "fiscal_period", + "type": "Literal['fy', 'q1', 'q2', 'q3', 'q4']", + "description": "The future fiscal period to retrieve estimates for.", + "default": null, + "optional": true + }, + { + "name": "calendar_year", + "type": "int", + "description": "The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", + "default": null, + "optional": true + }, + { + "name": "calendar_period", + "type": "Literal['q1', 'q2', 'q3', 'q4']", + "description": "The future calendar period to retrieve estimates for.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[ForwardSalesEstimates]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['intrinio']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": null, + "optional": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "fiscal_year", + "type": "int", + "description": "Fiscal year for the estimate.", + "default": null, + "optional": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "Fiscal quarter for the estimate.", + "default": null, + "optional": true + }, + { + "name": "calendar_year", + "type": "int", + "description": "Calendar year for the estimate.", + "default": null, + "optional": true + }, + { + "name": "calendar_period", + "type": "str", + "description": "Calendar quarter for the estimate.", + "default": null, + "optional": true + }, + { + "name": "low_estimate", + "type": "int", + "description": "The sales estimate low for the period.", + "default": null, + "optional": true + }, + { + "name": "high_estimate", + "type": "int", + "description": "The sales estimate high for the period.", + "default": null, + "optional": true + }, + { + "name": "mean", + "type": "int", + "description": "The sales estimate mean for the period.", + "default": null, + "optional": true + }, + { + "name": "median", + "type": "int", + "description": "The sales estimate median for the period.", + "default": null, + "optional": true + }, + { + "name": "standard_deviation", + "type": "int", + "description": "The sales estimate standard deviation for the period.", + "default": null, + "optional": true + }, + { + "name": "number_of_analysts", + "type": "int", + "description": "Number of analysts providing estimates for the period.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "revisions_1w_up", + "type": "int", + "description": "Number of revisions up in the last week.", + "default": null, + "optional": true + }, + { + "name": "revisions_1w_down", + "type": "int", + "description": "Number of revisions down in the last week.", + "default": null, + "optional": true + }, + { + "name": "revisions_1w_change_percent", + "type": "float", + "description": "The analyst revisions percent change in estimate for the period of 1 week.", + "default": null, + "optional": true + }, + { + "name": "revisions_1m_up", + "type": "int", + "description": "Number of revisions up in the last month.", + "default": null, + "optional": true + }, + { + "name": "revisions_1m_down", + "type": "int", + "description": "Number of revisions down in the last month.", + "default": null, + "optional": true + }, + { + "name": "revisions_1m_change_percent", + "type": "float", + "description": "The analyst revisions percent change in estimate for the period of 1 month.", + "default": null, + "optional": true + }, + { + "name": "revisions_3m_up", + "type": "int", + "description": "Number of revisions up in the last 3 months.", + "default": null, + "optional": true + }, + { + "name": "revisions_3m_down", + "type": "int", + "description": "Number of revisions down in the last 3 months.", + "default": null, + "optional": true + }, + { + "name": "revisions_3m_change_percent", + "type": "float", + "description": "The analyst revisions percent change in estimate for the period of 3 months.", + "default": null, + "optional": true + } + ] + }, + "model": "ForwardSalesEstimates" + }, + "/equity/estimates/forward_eps": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get forward EPS estimates.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.forward_eps(symbol='AAPL', provider='intrinio')\nobb.equity.estimates.forward_eps(fiscal_year=2025, fiscal_period=fy, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "fiscal_period", + "type": "Literal['annual', 'quarter']", + "description": "The future fiscal period to retrieve estimates for.", + "default": "annual", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": null, + "optional": true + }, + { + "name": "include_historical", + "type": "bool", + "description": "If True, the data will include all past data and the limit will be ignored.", + "default": false, + "optional": true + } + ], + "intrinio": [ + { + "name": "fiscal_year", + "type": "int", + "description": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", + "default": null, + "optional": true + }, + { + "name": "fiscal_period", + "type": "Literal['fy', 'q1', 'q2', 'q3', 'q4']", + "description": "The future fiscal period to retrieve estimates for.", + "default": null, + "optional": true + }, + { + "name": "calendar_year", + "type": "int", + "description": "The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", + "default": null, + "optional": true + }, + { + "name": "calendar_period", + "type": "Literal['q1', 'q2', 'q3', 'q4']", + "description": "The future calendar period to retrieve estimates for.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[ForwardEpsEstimates]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": null, + "optional": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "fiscal_year", + "type": "int", + "description": "Fiscal year for the estimate.", + "default": null, + "optional": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "Fiscal quarter for the estimate.", + "default": null, + "optional": true + }, + { + "name": "calendar_year", + "type": "int", + "description": "Calendar year for the estimate.", + "default": null, + "optional": true + }, + { + "name": "calendar_period", + "type": "str", + "description": "Calendar quarter for the estimate.", + "default": null, + "optional": true + }, + { + "name": "low_estimate", + "type": "float", + "description": "Estimated EPS low for the period.", + "default": null, + "optional": true + }, + { + "name": "high_estimate", + "type": "float", + "description": "Estimated EPS high for the period.", + "default": null, + "optional": true + }, + { + "name": "mean", + "type": "float", + "description": "Estimated EPS mean for the period.", + "default": null, + "optional": true + }, + { + "name": "median", + "type": "float", + "description": "Estimated EPS median for the period.", + "default": null, + "optional": true + }, + { + "name": "standard_deviation", + "type": "float", + "description": "Estimated EPS standard deviation for the period.", + "default": null, + "optional": true + }, + { + "name": "number_of_analysts", + "type": "int", + "description": "Number of analysts providing estimates for the period.", + "default": null, + "optional": true + } + ], + "fmp": [], + "intrinio": [ + { + "name": "revisions_change_percent", + "type": "float", + "description": "The earnings per share (EPS) percent change in estimate for the period.", + "default": null, + "optional": true + }, + { + "name": "mean_1w", + "type": "float", + "description": "The mean estimate for the period one week ago.", + "default": null, + "optional": true + }, + { + "name": "mean_1m", + "type": "float", + "description": "The mean estimate for the period one month ago.", + "default": null, + "optional": true + }, + { + "name": "mean_2m", + "type": "float", + "description": "The mean estimate for the period two months ago.", + "default": null, + "optional": true + }, + { + "name": "mean_3m", + "type": "float", + "description": "The mean estimate for the period three months ago.", + "default": null, + "optional": true + } + ] + }, + "model": "ForwardEpsEstimates" + }, + "/equity/discovery/gainers": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the top price gainers in the stock market.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.gainers(provider='yfinance')\nobb.equity.discovery.gainers(sort='desc', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true + }, + { + "name": "provider", + "type": "Literal['yfinance']", + "description": "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.", + "default": "yfinance", + "optional": true + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityGainers]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false + }, + { + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false + } + ], + "yfinance": [ + { + "name": "market_cap", + "type": "float", + "description": "Market Cap.", + "default": "", + "optional": false + }, + { + "name": "avg_volume_3_months", + "type": "float", + "description": "Average volume over the last 3 months in millions.", + "default": "", + "optional": false + }, + { + "name": "pe_ratio_ttm", + "type": "float", + "description": "PE Ratio (TTM).", + "default": null, + "optional": true + } + ] + }, + "model": "EquityGainers" + }, + "/equity/discovery/losers": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the top price losers in the stock market.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.losers(provider='yfinance')\nobb.equity.discovery.losers(sort='desc', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true + }, + { + "name": "provider", + "type": "Literal['yfinance']", + "description": "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.", + "default": "yfinance", + "optional": true + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityLosers]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false + }, + { + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false + } + ], + "yfinance": [ + { + "name": "market_cap", + "type": "float", + "description": "Market Cap.", + "default": "", + "optional": false + }, + { + "name": "avg_volume_3_months", + "type": "float", + "description": "Average volume over the last 3 months in millions.", + "default": "", + "optional": false + }, + { + "name": "pe_ratio_ttm", + "type": "float", + "description": "PE Ratio (TTM).", + "default": null, + "optional": true + } + ] + }, + "model": "EquityLosers" + }, + "/equity/discovery/active": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the most actively traded stocks based on volume.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.active(provider='yfinance')\nobb.equity.discovery.active(sort='desc', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true + }, + { + "name": "provider", + "type": "Literal['yfinance']", + "description": "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.", + "default": "yfinance", + "optional": true + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityActive]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false + }, + { + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false + } + ], + "yfinance": [ + { + "name": "market_cap", + "type": "float", + "description": "Market Cap displayed in billions.", + "default": "", + "optional": false + }, + { + "name": "avg_volume_3_months", + "type": "float", + "description": "Average volume over the last 3 months in millions.", + "default": "", + "optional": false + }, + { + "name": "pe_ratio_ttm", + "type": "float", + "description": "PE Ratio (TTM).", + "default": null, + "optional": true + } + ] + }, + "model": "EquityActive" + }, + "/equity/discovery/undervalued_large_caps": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get potentially undervalued large cap stocks.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.undervalued_large_caps(provider='yfinance')\nobb.equity.discovery.undervalued_large_caps(sort='desc', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true + }, + { + "name": "provider", + "type": "Literal['yfinance']", + "description": "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.", + "default": "yfinance", + "optional": true + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityUndervaluedLargeCaps]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false + }, + { + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false + } + ], + "yfinance": [ + { + "name": "market_cap", + "type": "float", + "description": "Market Cap.", + "default": null, + "optional": true + }, + { + "name": "avg_volume_3_months", + "type": "float", + "description": "Average volume over the last 3 months in millions.", + "default": null, + "optional": true + }, + { + "name": "pe_ratio_ttm", + "type": "float", + "description": "PE Ratio (TTM).", + "default": null, + "optional": true + } + ] + }, + "model": "EquityUndervaluedLargeCaps" + }, + "/equity/discovery/undervalued_growth": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get potentially undervalued growth stocks.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.undervalued_growth(provider='yfinance')\nobb.equity.discovery.undervalued_growth(sort='desc', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true + }, + { + "name": "provider", + "type": "Literal['yfinance']", + "description": "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.", + "default": "yfinance", + "optional": true + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityUndervaluedGrowth]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false + }, + { + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false + } + ], + "yfinance": [ + { + "name": "market_cap", + "type": "float", + "description": "Market Cap.", + "default": null, + "optional": true + }, + { + "name": "avg_volume_3_months", + "type": "float", + "description": "Average volume over the last 3 months in millions.", + "default": null, + "optional": true + }, + { + "name": "pe_ratio_ttm", + "type": "float", + "description": "PE Ratio (TTM).", + "default": null, + "optional": true + } + ] + }, + "model": "EquityUndervaluedGrowth" + }, + "/equity/discovery/aggressive_small_caps": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get top small cap stocks based on earnings growth.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.aggressive_small_caps(provider='yfinance')\nobb.equity.discovery.aggressive_small_caps(sort='desc', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true + }, + { + "name": "provider", + "type": "Literal['yfinance']", + "description": "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.", + "default": "yfinance", + "optional": true + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityAggressiveSmallCaps]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false + }, + { + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false + } + ], + "yfinance": [ + { + "name": "market_cap", + "type": "float", + "description": "Market Cap.", + "default": null, + "optional": true + }, + { + "name": "avg_volume_3_months", + "type": "float", + "description": "Average volume over the last 3 months in millions.", + "default": null, + "optional": true + }, + { + "name": "pe_ratio_ttm", + "type": "float", + "description": "PE Ratio (TTM).", + "default": null, + "optional": true + } + ] + }, + "model": "EquityAggressiveSmallCaps" + }, + "/equity/discovery/growth_tech": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get top tech stocks based on revenue and earnings growth.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.growth_tech(provider='yfinance')\nobb.equity.discovery.growth_tech(sort='desc', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true + }, + { + "name": "provider", + "type": "Literal['yfinance']", + "description": "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.", + "default": "yfinance", + "optional": true + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[GrowthTechEquities]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false + }, + { + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false + } + ], + "yfinance": [ + { + "name": "market_cap", + "type": "float", + "description": "Market Cap.", + "default": null, + "optional": true + }, + { + "name": "avg_volume_3_months", + "type": "float", + "description": "Average volume over the last 3 months in millions.", + "default": null, + "optional": true + }, + { + "name": "pe_ratio_ttm", + "type": "float", + "description": "PE Ratio (TTM).", + "default": null, + "optional": true + } + ] + }, + "model": "GrowthTechEquities" + }, + "/equity/discovery/filings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more.\n\nSEC filings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114,\nForeign Investment Disclosures and others. The annual 10-K report is required to be\nfiled annually and includes the company's financial statements, management discussion and analysis,\nand audited financial statements.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.filings(provider='fmp')\n# Get filings for the year 2023, limited to 100 results\nobb.equity.discovery.filings(start_date='2023-01-01', end_date='2023-12-31', limit=100, provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "form_type", + "type": "str", + "description": "Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "is_done", + "type": "bool", + "description": "Flag for whether or not the filing is done.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[DiscoveryFilings]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "", + "optional": false + }, + { + "name": "title", + "type": "str", + "description": "Title of the filing.", + "default": "", + "optional": false + }, + { + "name": "date", + "type": "datetime", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "form_type", + "type": "str", + "description": "The form type of the filing", + "default": "", + "optional": false + }, + { + "name": "link", + "type": "str", + "description": "URL to the filing page on the SEC site.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "DiscoveryFilings" + }, + "/equity/fundamental/multiples": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get equity valuation multiples for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.multiples(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityValuationMultiples]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "revenue_per_share_ttm", + "type": "float", + "description": "Revenue per share calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "net_income_per_share_ttm", + "type": "float", + "description": "Net income per share calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "operating_cash_flow_per_share_ttm", + "type": "float", + "description": "Operating cash flow per share calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "free_cash_flow_per_share_ttm", + "type": "float", + "description": "Free cash flow per share calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "cash_per_share_ttm", + "type": "float", + "description": "Cash per share calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "book_value_per_share_ttm", + "type": "float", + "description": "Book value per share calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "tangible_book_value_per_share_ttm", + "type": "float", + "description": "Tangible book value per share calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "shareholders_equity_per_share_ttm", + "type": "float", + "description": "Shareholders equity per share calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "interest_debt_per_share_ttm", + "type": "float", + "description": "Interest debt per share calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "market_cap_ttm", + "type": "float", + "description": "Market capitalization calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "enterprise_value_ttm", + "type": "float", + "description": "Enterprise value calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "pe_ratio_ttm", + "type": "float", + "description": "Price-to-earnings ratio (P/E ratio) calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "price_to_sales_ratio_ttm", + "type": "float", + "description": "Price-to-sales ratio calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "pocf_ratio_ttm", + "type": "float", + "description": "Price-to-operating cash flow ratio calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "pfcf_ratio_ttm", + "type": "float", + "description": "Price-to-free cash flow ratio calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "pb_ratio_ttm", + "type": "float", + "description": "Price-to-book ratio calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "ptb_ratio_ttm", + "type": "float", + "description": "Price-to-tangible book ratio calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "ev_to_sales_ttm", + "type": "float", + "description": "Enterprise value-to-sales ratio calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "enterprise_value_over_ebitda_ttm", + "type": "float", + "description": "Enterprise value-to-EBITDA ratio calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "ev_to_operating_cash_flow_ttm", + "type": "float", + "description": "Enterprise value-to-operating cash flow ratio calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "ev_to_free_cash_flow_ttm", + "type": "float", + "description": "Enterprise value-to-free cash flow ratio calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "earnings_yield_ttm", + "type": "float", + "description": "Earnings yield calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "free_cash_flow_yield_ttm", + "type": "float", + "description": "Free cash flow yield calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "debt_to_equity_ttm", + "type": "float", + "description": "Debt-to-equity ratio calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "debt_to_assets_ttm", + "type": "float", + "description": "Debt-to-assets ratio calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "net_debt_to_ebitda_ttm", + "type": "float", + "description": "Net debt-to-EBITDA ratio calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "current_ratio_ttm", + "type": "float", + "description": "Current ratio calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "interest_coverage_ttm", + "type": "float", + "description": "Interest coverage calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "income_quality_ttm", + "type": "float", + "description": "Income quality calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "dividend_yield_ttm", + "type": "float", + "description": "Dividend yield calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "dividend_yield_percentage_ttm", + "type": "float", + "description": "Dividend yield percentage calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "dividend_to_market_cap_ttm", + "type": "float", + "description": "Dividend to market capitalization ratio calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "dividend_per_share_ttm", + "type": "float", + "description": "Dividend per share calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "payout_ratio_ttm", + "type": "float", + "description": "Payout ratio calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "sales_general_and_administrative_to_revenue_ttm", + "type": "float", + "description": "Sales general and administrative expenses-to-revenue ratio calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "research_and_development_to_revenue_ttm", + "type": "float", + "description": "Research and development expenses-to-revenue ratio calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "intangibles_to_total_assets_ttm", + "type": "float", + "description": "Intangibles-to-total assets ratio calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "capex_to_operating_cash_flow_ttm", + "type": "float", + "description": "Capital expenditures-to-operating cash flow ratio calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "capex_to_revenue_ttm", + "type": "float", + "description": "Capital expenditures-to-revenue ratio calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "capex_to_depreciation_ttm", + "type": "float", + "description": "Capital expenditures-to-depreciation ratio calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "stock_based_compensation_to_revenue_ttm", + "type": "float", + "description": "Stock-based compensation-to-revenue ratio calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "graham_number_ttm", + "type": "float", + "description": "Graham number calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "roic_ttm", + "type": "float", + "description": "Return on invested capital calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "return_on_tangible_assets_ttm", + "type": "float", + "description": "Return on tangible assets calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "graham_net_net_ttm", + "type": "float", + "description": "Graham net-net working capital calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "working_capital_ttm", + "type": "float", + "description": "Working capital calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "tangible_asset_value_ttm", + "type": "float", + "description": "Tangible asset value calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "net_current_asset_value_ttm", + "type": "float", + "description": "Net current asset value calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "invested_capital_ttm", + "type": "float", + "description": "Invested capital calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "average_receivables_ttm", + "type": "float", + "description": "Average receivables calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "average_payables_ttm", + "type": "float", + "description": "Average payables calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "average_inventory_ttm", + "type": "float", + "description": "Average inventory calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "days_sales_outstanding_ttm", + "type": "float", + "description": "Days sales outstanding calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "days_payables_outstanding_ttm", + "type": "float", + "description": "Days payables outstanding calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "days_of_inventory_on_hand_ttm", + "type": "float", + "description": "Days of inventory on hand calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "receivables_turnover_ttm", + "type": "float", + "description": "Receivables turnover calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "payables_turnover_ttm", + "type": "float", + "description": "Payables turnover calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "inventory_turnover_ttm", + "type": "float", + "description": "Inventory turnover calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "roe_ttm", + "type": "float", + "description": "Return on equity calculated as trailing twelve months.", + "default": null, + "optional": true + }, + { + "name": "capex_per_share_ttm", + "type": "float", + "description": "Capital expenditures per share calculated as trailing twelve months.", + "default": null, + "optional": true + } + ], + "fmp": [] + }, + "model": "EquityValuationMultiples" + }, + "/equity/fundamental/balance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the balance sheet for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.balance(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.balance(symbol='AAPL', period='annual', limit=5, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "limit", + "type": "Annotated[int, Ge(ge=0)]", + "description": "The number of data entries to return.", + "default": 5, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true + } + ], + "intrinio": [ + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm']", + "description": "None", + "default": "annual", + "optional": true + }, + { + "name": "filing_date", + "type": "date", + "description": "Filing date of the financial statement.", + "default": null, + "optional": true + }, + { + "name": "filing_date_lt", + "type": "date", + "description": "Filing date less than the given date.", + "default": null, + "optional": true + }, + { + "name": "filing_date_lte", + "type": "date", + "description": "Filing date less than or equal to the given date.", + "default": null, + "optional": true + }, + { + "name": "filing_date_gt", + "type": "date", + "description": "Filing date greater than the given date.", + "default": null, + "optional": true + }, + { + "name": "filing_date_gte", + "type": "date", + "description": "Filing date greater than or equal to the given date.", + "default": null, + "optional": true + }, + { + "name": "period_of_report_date", + "type": "date", + "description": "Period of report date of the financial statement.", + "default": null, + "optional": true + }, + { + "name": "period_of_report_date_lt", + "type": "date", + "description": "Period of report date less than the given date.", + "default": null, + "optional": true + }, + { + "name": "period_of_report_date_lte", + "type": "date", + "description": "Period of report date less than or equal to the given date.", + "default": null, + "optional": true + }, + { + "name": "period_of_report_date_gt", + "type": "date", + "description": "Period of report date greater than the given date.", + "default": null, + "optional": true + }, + { + "name": "period_of_report_date_gte", + "type": "date", + "description": "Period of report date greater than or equal to the given date.", + "default": null, + "optional": true + }, + { + "name": "include_sources", + "type": "bool", + "description": "Whether to include the sources of the financial statement.", + "default": true, + "optional": true + }, + { + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order of the financial statement.", + "default": null, + "optional": true + }, + { + "name": "sort", + "type": "Literal['filing_date', 'period_of_report_date']", + "description": "Sort of the financial statement.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[BalanceSheet]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", + "default": null, + "optional": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "filing_date", + "type": "date", + "description": "The date when the filing was made.", + "default": null, + "optional": true + }, + { + "name": "accepted_date", + "type": "datetime", + "description": "The date and time when the filing was accepted.", + "default": null, + "optional": true + }, + { + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet was reported.", + "default": null, + "optional": true + }, + { + "name": "cash_and_cash_equivalents", + "type": "float", + "description": "Cash and cash equivalents.", + "default": null, + "optional": true + }, + { + "name": "short_term_investments", + "type": "float", + "description": "Short term investments.", + "default": null, + "optional": true + }, + { + "name": "cash_and_short_term_investments", + "type": "float", + "description": "Cash and short term investments.", + "default": null, + "optional": true + }, + { + "name": "net_receivables", + "type": "float", + "description": "Net receivables.", + "default": null, + "optional": true + }, + { + "name": "inventory", + "type": "float", + "description": "Inventory.", + "default": null, + "optional": true + }, + { + "name": "other_current_assets", + "type": "float", + "description": "Other current assets.", + "default": null, + "optional": true + }, + { + "name": "total_current_assets", + "type": "float", + "description": "Total current assets.", + "default": null, + "optional": true + }, + { + "name": "plant_property_equipment_net", + "type": "float", + "description": "Plant property equipment net.", + "default": null, + "optional": true + }, + { + "name": "goodwill", + "type": "float", + "description": "Goodwill.", + "default": null, + "optional": true + }, + { + "name": "intangible_assets", + "type": "float", + "description": "Intangible assets.", + "default": null, + "optional": true + }, + { + "name": "goodwill_and_intangible_assets", + "type": "float", + "description": "Goodwill and intangible assets.", + "default": null, + "optional": true + }, + { + "name": "long_term_investments", + "type": "float", + "description": "Long term investments.", + "default": null, + "optional": true + }, + { + "name": "tax_assets", + "type": "float", + "description": "Tax assets.", + "default": null, + "optional": true + }, + { + "name": "other_non_current_assets", + "type": "float", + "description": "Other non current assets.", + "default": null, + "optional": true + }, + { + "name": "non_current_assets", + "type": "float", + "description": "Total non current assets.", + "default": null, + "optional": true + }, + { + "name": "other_assets", + "type": "float", + "description": "Other assets.", + "default": null, + "optional": true + }, + { + "name": "total_assets", + "type": "float", + "description": "Total assets.", + "default": null, + "optional": true + }, + { + "name": "accounts_payable", + "type": "float", + "description": "Accounts payable.", + "default": null, + "optional": true + }, + { + "name": "short_term_debt", + "type": "float", + "description": "Short term debt.", + "default": null, + "optional": true + }, + { + "name": "tax_payables", + "type": "float", + "description": "Tax payables.", + "default": null, + "optional": true + }, + { + "name": "current_deferred_revenue", + "type": "float", + "description": "Current deferred revenue.", + "default": null, + "optional": true + }, + { + "name": "other_current_liabilities", + "type": "float", + "description": "Other current liabilities.", + "default": null, + "optional": true + }, + { + "name": "total_current_liabilities", + "type": "float", + "description": "Total current liabilities.", + "default": null, + "optional": true + }, + { + "name": "long_term_debt", + "type": "float", + "description": "Long term debt.", + "default": null, + "optional": true + }, + { + "name": "deferred_revenue_non_current", + "type": "float", + "description": "Non current deferred revenue.", + "default": null, + "optional": true + }, + { + "name": "deferred_tax_liabilities_non_current", + "type": "float", + "description": "Deferred tax liabilities non current.", + "default": null, + "optional": true + }, + { + "name": "other_non_current_liabilities", + "type": "float", + "description": "Other non current liabilities.", + "default": null, + "optional": true + }, + { + "name": "total_non_current_liabilities", + "type": "float", + "description": "Total non current liabilities.", + "default": null, + "optional": true + }, + { + "name": "other_liabilities", + "type": "float", + "description": "Other liabilities.", + "default": null, + "optional": true + }, + { + "name": "capital_lease_obligations", + "type": "float", + "description": "Capital lease obligations.", + "default": null, + "optional": true + }, + { + "name": "total_liabilities", + "type": "float", + "description": "Total liabilities.", + "default": null, + "optional": true + }, + { + "name": "preferred_stock", + "type": "float", + "description": "Preferred stock.", + "default": null, + "optional": true + }, + { + "name": "common_stock", + "type": "float", + "description": "Common stock.", + "default": null, + "optional": true + }, + { + "name": "retained_earnings", + "type": "float", + "description": "Retained earnings.", + "default": null, + "optional": true + }, + { + "name": "accumulated_other_comprehensive_income", + "type": "float", + "description": "Accumulated other comprehensive income (loss).", + "default": null, + "optional": true + }, + { + "name": "other_shareholders_equity", + "type": "float", + "description": "Other shareholders equity.", + "default": null, + "optional": true + }, + { + "name": "other_total_shareholders_equity", + "type": "float", + "description": "Other total shareholders equity.", + "default": null, + "optional": true + }, + { + "name": "total_common_equity", + "type": "float", + "description": "Total common equity.", + "default": null, + "optional": true + }, + { + "name": "total_equity_non_controlling_interests", + "type": "float", + "description": "Total equity non controlling interests.", + "default": null, + "optional": true + }, + { + "name": "total_liabilities_and_shareholders_equity", + "type": "float", + "description": "Total liabilities and shareholders equity.", + "default": null, + "optional": true + }, + { + "name": "minority_interest", + "type": "float", + "description": "Minority interest.", + "default": null, + "optional": true + }, + { + "name": "total_liabilities_and_total_equity", + "type": "float", + "description": "Total liabilities and total equity.", + "default": null, + "optional": true + }, + { + "name": "total_investments", + "type": "float", + "description": "Total investments.", + "default": null, + "optional": true + }, + { + "name": "total_debt", + "type": "float", + "description": "Total debt.", + "default": null, + "optional": true + }, + { + "name": "net_debt", + "type": "float", + "description": "Net debt.", + "default": null, + "optional": true + }, + { + "name": "link", + "type": "str", + "description": "Link to the filing.", + "default": null, + "optional": true + }, + { + "name": "final_link", + "type": "str", + "description": "Link to the filing document.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet is reported.", + "default": null, + "optional": true + }, + { + "name": "cash_and_cash_equivalents", + "type": "float", + "description": "Cash and cash equivalents.", + "default": null, + "optional": true + }, + { + "name": "cash_and_due_from_banks", + "type": "float", + "description": "Cash and due from banks.", + "default": null, + "optional": true + }, + { + "name": "restricted_cash", + "type": "float", + "description": "Restricted cash.", + "default": null, + "optional": true + }, + { + "name": "short_term_investments", + "type": "float", + "description": "Short term investments.", + "default": null, + "optional": true + }, + { + "name": "federal_funds_sold", + "type": "float", + "description": "Federal funds sold.", + "default": null, + "optional": true + }, + { + "name": "accounts_receivable", + "type": "float", + "description": "Accounts receivable.", + "default": null, + "optional": true + }, + { + "name": "note_and_lease_receivable", + "type": "float", + "description": "Note and lease receivable. (Vendor non-trade receivables)", + "default": null, + "optional": true + }, + { + "name": "inventories", + "type": "float", + "description": "Net Inventories.", + "default": null, + "optional": true + }, + { + "name": "customer_and_other_receivables", + "type": "float", + "description": "Customer and other receivables.", + "default": null, + "optional": true + }, + { + "name": "interest_bearing_deposits_at_other_banks", + "type": "float", + "description": "Interest bearing deposits at other banks.", + "default": null, + "optional": true + }, + { + "name": "time_deposits_placed_and_other_short_term_investments", + "type": "float", + "description": "Time deposits placed and other short term investments.", + "default": null, + "optional": true + }, + { + "name": "trading_account_securities", + "type": "float", + "description": "Trading account securities.", + "default": null, + "optional": true + }, + { + "name": "loans_and_leases", + "type": "float", + "description": "Loans and leases.", + "default": null, + "optional": true + }, + { + "name": "allowance_for_loan_and_lease_losses", + "type": "float", + "description": "Allowance for loan and lease losses.", + "default": null, + "optional": true + }, + { + "name": "current_deferred_refundable_income_taxes", + "type": "float", + "description": "Current deferred refundable income taxes.", + "default": null, + "optional": true + }, + { + "name": "other_current_assets", + "type": "float", + "description": "Other current assets.", + "default": null, + "optional": true + }, + { + "name": "loans_and_leases_net_of_allowance", + "type": "float", + "description": "Loans and leases net of allowance.", + "default": null, + "optional": true + }, + { + "name": "accrued_investment_income", + "type": "float", + "description": "Accrued investment income.", + "default": null, + "optional": true + }, + { + "name": "other_current_non_operating_assets", + "type": "float", + "description": "Other current non-operating assets.", + "default": null, + "optional": true + }, + { + "name": "loans_held_for_sale", + "type": "float", + "description": "Loans held for sale.", + "default": null, + "optional": true + }, + { + "name": "prepaid_expenses", + "type": "float", + "description": "Prepaid expenses.", + "default": null, + "optional": true + }, + { + "name": "total_current_assets", + "type": "float", + "description": "Total current assets.", + "default": null, + "optional": true + }, + { + "name": "plant_property_equipment_gross", + "type": "float", + "description": "Plant property equipment gross.", + "default": null, + "optional": true + }, + { + "name": "accumulated_depreciation", + "type": "float", + "description": "Accumulated depreciation.", + "default": null, + "optional": true + }, + { + "name": "premises_and_equipment_net", + "type": "float", + "description": "Net premises and equipment.", + "default": null, + "optional": true + }, + { + "name": "plant_property_equipment_net", + "type": "float", + "description": "Net plant property equipment.", + "default": null, + "optional": true + }, + { + "name": "long_term_investments", + "type": "float", + "description": "Long term investments.", + "default": null, + "optional": true + }, + { + "name": "mortgage_servicing_rights", + "type": "float", + "description": "Mortgage servicing rights.", + "default": null, + "optional": true + }, + { + "name": "unearned_premiums_asset", + "type": "float", + "description": "Unearned premiums asset.", + "default": null, + "optional": true + }, + { + "name": "non_current_note_lease_receivables", + "type": "float", + "description": "Non-current note lease receivables.", + "default": null, + "optional": true + }, + { + "name": "deferred_acquisition_cost", + "type": "float", + "description": "Deferred acquisition cost.", + "default": null, + "optional": true + }, + { + "name": "goodwill", + "type": "float", + "description": "Goodwill.", + "default": null, + "optional": true + }, + { + "name": "separate_account_business_assets", + "type": "float", + "description": "Separate account business assets.", + "default": null, + "optional": true + }, + { + "name": "non_current_deferred_refundable_income_taxes", + "type": "float", + "description": "Noncurrent deferred refundable income taxes.", + "default": null, + "optional": true + }, + { + "name": "intangible_assets", + "type": "float", + "description": "Intangible assets.", + "default": null, + "optional": true + }, + { + "name": "employee_benefit_assets", + "type": "float", + "description": "Employee benefit assets.", + "default": null, + "optional": true + }, + { + "name": "other_assets", + "type": "float", + "description": "Other assets.", + "default": null, + "optional": true + }, + { + "name": "other_non_current_operating_assets", + "type": "float", + "description": "Other noncurrent operating assets.", + "default": null, + "optional": true + }, + { + "name": "other_non_current_non_operating_assets", + "type": "float", + "description": "Other noncurrent non-operating assets.", + "default": null, + "optional": true + }, + { + "name": "interest_bearing_deposits", + "type": "float", + "description": "Interest bearing deposits.", + "default": null, + "optional": true + }, + { + "name": "total_non_current_assets", + "type": "float", + "description": "Total noncurrent assets.", + "default": null, + "optional": true + }, + { + "name": "total_assets", + "type": "float", + "description": "Total assets.", + "default": null, + "optional": true + }, + { + "name": "non_interest_bearing_deposits", + "type": "float", + "description": "Non interest bearing deposits.", + "default": null, + "optional": true + }, + { + "name": "federal_funds_purchased_and_securities_sold", + "type": "float", + "description": "Federal funds purchased and securities sold.", + "default": null, + "optional": true + }, + { + "name": "bankers_acceptance_outstanding", + "type": "float", + "description": "Bankers acceptance outstanding.", + "default": null, + "optional": true + }, + { + "name": "short_term_debt", + "type": "float", + "description": "Short term debt.", + "default": null, + "optional": true + }, + { + "name": "accounts_payable", + "type": "float", + "description": "Accounts payable.", + "default": null, + "optional": true + }, + { + "name": "current_deferred_revenue", + "type": "float", + "description": "Current deferred revenue.", + "default": null, + "optional": true + }, + { + "name": "current_deferred_payable_income_tax_liabilities", + "type": "float", + "description": "Current deferred payable income tax liabilities.", + "default": null, + "optional": true + }, + { + "name": "accrued_interest_payable", + "type": "float", + "description": "Accrued interest payable.", + "default": null, + "optional": true + }, + { + "name": "accrued_expenses", + "type": "float", + "description": "Accrued expenses.", + "default": null, + "optional": true + }, + { + "name": "other_short_term_payables", + "type": "float", + "description": "Other short term payables.", + "default": null, + "optional": true + }, + { + "name": "customer_deposits", + "type": "float", + "description": "Customer deposits.", + "default": null, + "optional": true + }, + { + "name": "dividends_payable", + "type": "float", + "description": "Dividends payable.", + "default": null, + "optional": true + }, + { + "name": "claims_and_claim_expense", + "type": "float", + "description": "Claims and claim expense.", + "default": null, + "optional": true + }, + { + "name": "future_policy_benefits", + "type": "float", + "description": "Future policy benefits.", + "default": null, + "optional": true + }, + { + "name": "current_employee_benefit_liabilities", + "type": "float", + "description": "Current employee benefit liabilities.", + "default": null, + "optional": true + }, + { + "name": "unearned_premiums_liability", + "type": "float", + "description": "Unearned premiums liability.", + "default": null, + "optional": true + }, + { + "name": "other_taxes_payable", + "type": "float", + "description": "Other taxes payable.", + "default": null, + "optional": true + }, + { + "name": "policy_holder_funds", + "type": "float", + "description": "Policy holder funds.", + "default": null, + "optional": true + }, + { + "name": "other_current_liabilities", + "type": "float", + "description": "Other current liabilities.", + "default": null, + "optional": true + }, + { + "name": "other_current_non_operating_liabilities", + "type": "float", + "description": "Other current non-operating liabilities.", + "default": null, + "optional": true + }, + { + "name": "separate_account_business_liabilities", + "type": "float", + "description": "Separate account business liabilities.", + "default": null, + "optional": true + }, + { + "name": "total_current_liabilities", + "type": "float", + "description": "Total current liabilities.", + "default": null, + "optional": true + }, + { + "name": "long_term_debt", + "type": "float", + "description": "Long term debt.", + "default": null, + "optional": true + }, + { + "name": "other_long_term_liabilities", + "type": "float", + "description": "Other long term liabilities.", + "default": null, + "optional": true + }, + { + "name": "non_current_deferred_revenue", + "type": "float", + "description": "Non-current deferred revenue.", + "default": null, + "optional": true + }, + { + "name": "non_current_deferred_payable_income_tax_liabilities", + "type": "float", + "description": "Non-current deferred payable income tax liabilities.", + "default": null, + "optional": true + }, + { + "name": "non_current_employee_benefit_liabilities", + "type": "float", + "description": "Non-current employee benefit liabilities.", + "default": null, + "optional": true + }, + { + "name": "other_non_current_operating_liabilities", + "type": "float", + "description": "Other non-current operating liabilities.", + "default": null, + "optional": true + }, + { + "name": "other_non_current_non_operating_liabilities", + "type": "float", + "description": "Other non-current, non-operating liabilities.", + "default": null, + "optional": true + }, + { + "name": "total_non_current_liabilities", + "type": "float", + "description": "Total non-current liabilities.", + "default": null, + "optional": true + }, + { + "name": "capital_lease_obligations", + "type": "float", + "description": "Capital lease obligations.", + "default": null, + "optional": true + }, + { + "name": "asset_retirement_reserve_litigation_obligation", + "type": "float", + "description": "Asset retirement reserve litigation obligation.", + "default": null, + "optional": true + }, + { + "name": "total_liabilities", + "type": "float", + "description": "Total liabilities.", + "default": null, + "optional": true + }, + { + "name": "commitments_contingencies", + "type": "float", + "description": "Commitments contingencies.", + "default": null, + "optional": true + }, + { + "name": "redeemable_non_controlling_interest", + "type": "float", + "description": "Redeemable non-controlling interest.", + "default": null, + "optional": true + }, + { + "name": "preferred_stock", + "type": "float", + "description": "Preferred stock.", + "default": null, + "optional": true + }, + { + "name": "common_stock", + "type": "float", + "description": "Common stock.", + "default": null, + "optional": true + }, + { + "name": "retained_earnings", + "type": "float", + "description": "Retained earnings.", + "default": null, + "optional": true + }, + { + "name": "treasury_stock", + "type": "float", + "description": "Treasury stock.", + "default": null, + "optional": true + }, + { + "name": "accumulated_other_comprehensive_income", + "type": "float", + "description": "Accumulated other comprehensive income.", + "default": null, + "optional": true + }, + { + "name": "participating_policy_holder_equity", + "type": "float", + "description": "Participating policy holder equity.", + "default": null, + "optional": true + }, + { + "name": "other_equity_adjustments", + "type": "float", + "description": "Other equity adjustments.", + "default": null, + "optional": true + }, + { + "name": "total_common_equity", + "type": "float", + "description": "Total common equity.", + "default": null, + "optional": true + }, + { + "name": "total_preferred_common_equity", + "type": "float", + "description": "Total preferred common equity.", + "default": null, + "optional": true + }, + { + "name": "non_controlling_interest", + "type": "float", + "description": "Non-controlling interest.", + "default": null, + "optional": true + }, + { + "name": "total_equity_non_controlling_interests", + "type": "float", + "description": "Total equity non-controlling interests.", + "default": null, + "optional": true + }, + { + "name": "total_liabilities_shareholders_equity", + "type": "float", + "description": "Total liabilities and shareholders equity.", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "accounts_receivable", + "type": "int", + "description": "Accounts receivable", + "default": null, + "optional": true + }, + { + "name": "marketable_securities", + "type": "int", + "description": "Marketable securities", + "default": null, + "optional": true + }, + { + "name": "prepaid_expenses", + "type": "int", + "description": "Prepaid expenses", + "default": null, + "optional": true + }, + { + "name": "other_current_assets", + "type": "int", + "description": "Other current assets", + "default": null, + "optional": true + }, + { + "name": "total_current_assets", + "type": "int", + "description": "Total current assets", + "default": null, + "optional": true + }, + { + "name": "property_plant_equipment_net", + "type": "int", + "description": "Property plant and equipment net", + "default": null, + "optional": true + }, + { + "name": "inventory", + "type": "int", + "description": "Inventory", + "default": null, + "optional": true + }, + { + "name": "other_non_current_assets", + "type": "int", + "description": "Other non-current assets", + "default": null, + "optional": true + }, + { + "name": "total_non_current_assets", + "type": "int", + "description": "Total non-current assets", + "default": null, + "optional": true + }, + { + "name": "intangible_assets", + "type": "int", + "description": "Intangible assets", + "default": null, + "optional": true + }, + { + "name": "total_assets", + "type": "int", + "description": "Total assets", + "default": null, + "optional": true + }, + { + "name": "accounts_payable", + "type": "int", + "description": "Accounts payable", + "default": null, + "optional": true + }, + { + "name": "employee_wages", + "type": "int", + "description": "Employee wages", + "default": null, + "optional": true + }, + { + "name": "other_current_liabilities", + "type": "int", + "description": "Other current liabilities", + "default": null, + "optional": true + }, + { + "name": "total_current_liabilities", + "type": "int", + "description": "Total current liabilities", + "default": null, + "optional": true + }, + { + "name": "other_non_current_liabilities", + "type": "int", + "description": "Other non-current liabilities", + "default": null, + "optional": true + }, + { + "name": "total_non_current_liabilities", + "type": "int", + "description": "Total non-current liabilities", + "default": null, + "optional": true + }, + { + "name": "long_term_debt", + "type": "int", + "description": "Long term debt", + "default": null, + "optional": true + }, + { + "name": "total_liabilities", + "type": "int", + "description": "Total liabilities", + "default": null, + "optional": true + }, + { + "name": "minority_interest", + "type": "int", + "description": "Minority interest", + "default": null, + "optional": true + }, + { + "name": "temporary_equity_attributable_to_parent", + "type": "int", + "description": "Temporary equity attributable to parent", + "default": null, + "optional": true + }, + { + "name": "equity_attributable_to_parent", + "type": "int", + "description": "Equity attributable to parent", + "default": null, + "optional": true + }, + { + "name": "temporary_equity", + "type": "int", + "description": "Temporary equity", + "default": null, + "optional": true + }, + { + "name": "preferred_stock", + "type": "int", + "description": "Preferred stock", + "default": null, + "optional": true + }, + { + "name": "redeemable_non_controlling_interest", + "type": "int", + "description": "Redeemable non-controlling interest", + "default": null, + "optional": true + }, + { + "name": "redeemable_non_controlling_interest_other", + "type": "int", + "description": "Redeemable non-controlling interest other", + "default": null, + "optional": true + }, + { + "name": "total_stock_holders_equity", + "type": "int", + "description": "Total stock holders equity", + "default": null, + "optional": true + }, + { + "name": "total_liabilities_and_stock_holders_equity", + "type": "int", + "description": "Total liabilities and stockholders equity", + "default": null, + "optional": true + }, + { + "name": "total_equity", + "type": "int", + "description": "Total equity", + "default": null, + "optional": true + } + ], + "yfinance": [] + }, + "model": "BalanceSheet" + }, + "/equity/fundamental/balance_growth": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the growth of a company's balance sheet items over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.balance_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.balance_growth(symbol='AAPL', limit=10, provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[BalanceSheetGrowth]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "period", + "type": "str", + "description": "Reporting period.", + "default": "", + "optional": false + }, + { + "name": "growth_cash_and_cash_equivalents", + "type": "float", + "description": "Growth rate of cash and cash equivalents.", + "default": "", + "optional": false + }, + { + "name": "growth_short_term_investments", + "type": "float", + "description": "Growth rate of short-term investments.", + "default": "", + "optional": false + }, + { + "name": "growth_cash_and_short_term_investments", + "type": "float", + "description": "Growth rate of cash and short-term investments.", + "default": "", + "optional": false + }, + { + "name": "growth_net_receivables", + "type": "float", + "description": "Growth rate of net receivables.", + "default": "", + "optional": false + }, + { + "name": "growth_inventory", + "type": "float", + "description": "Growth rate of inventory.", + "default": "", + "optional": false + }, + { + "name": "growth_other_current_assets", + "type": "float", + "description": "Growth rate of other current assets.", + "default": "", + "optional": false + }, + { + "name": "growth_total_current_assets", + "type": "float", + "description": "Growth rate of total current assets.", + "default": "", + "optional": false + }, + { + "name": "growth_property_plant_equipment_net", + "type": "float", + "description": "Growth rate of net property, plant, and equipment.", + "default": "", + "optional": false + }, + { + "name": "growth_goodwill", + "type": "float", + "description": "Growth rate of goodwill.", + "default": "", + "optional": false + }, + { + "name": "growth_intangible_assets", + "type": "float", + "description": "Growth rate of intangible assets.", + "default": "", + "optional": false + }, + { + "name": "growth_goodwill_and_intangible_assets", + "type": "float", + "description": "Growth rate of goodwill and intangible assets.", + "default": "", + "optional": false + }, + { + "name": "growth_long_term_investments", + "type": "float", + "description": "Growth rate of long-term investments.", + "default": "", + "optional": false + }, + { + "name": "growth_tax_assets", + "type": "float", + "description": "Growth rate of tax assets.", + "default": "", + "optional": false + }, + { + "name": "growth_other_non_current_assets", + "type": "float", + "description": "Growth rate of other non-current assets.", + "default": "", + "optional": false + }, + { + "name": "growth_total_non_current_assets", + "type": "float", + "description": "Growth rate of total non-current assets.", + "default": "", + "optional": false + }, + { + "name": "growth_other_assets", + "type": "float", + "description": "Growth rate of other assets.", + "default": "", + "optional": false + }, + { + "name": "growth_total_assets", + "type": "float", + "description": "Growth rate of total assets.", + "default": "", + "optional": false + }, + { + "name": "growth_account_payables", + "type": "float", + "description": "Growth rate of accounts payable.", + "default": "", + "optional": false + }, + { + "name": "growth_short_term_debt", + "type": "float", + "description": "Growth rate of short-term debt.", + "default": "", + "optional": false + }, + { + "name": "growth_tax_payables", + "type": "float", + "description": "Growth rate of tax payables.", + "default": "", + "optional": false + }, + { + "name": "growth_deferred_revenue", + "type": "float", + "description": "Growth rate of deferred revenue.", + "default": "", + "optional": false + }, + { + "name": "growth_other_current_liabilities", + "type": "float", + "description": "Growth rate of other current liabilities.", + "default": "", + "optional": false + }, + { + "name": "growth_total_current_liabilities", + "type": "float", + "description": "Growth rate of total current liabilities.", + "default": "", + "optional": false + }, + { + "name": "growth_long_term_debt", + "type": "float", + "description": "Growth rate of long-term debt.", + "default": "", + "optional": false + }, + { + "name": "growth_deferred_revenue_non_current", + "type": "float", + "description": "Growth rate of non-current deferred revenue.", + "default": "", + "optional": false + }, + { + "name": "growth_deferrred_tax_liabilities_non_current", + "type": "float", + "description": "Growth rate of non-current deferred tax liabilities.", + "default": "", + "optional": false + }, + { + "name": "growth_other_non_current_liabilities", + "type": "float", + "description": "Growth rate of other non-current liabilities.", + "default": "", + "optional": false + }, + { + "name": "growth_total_non_current_liabilities", + "type": "float", + "description": "Growth rate of total non-current liabilities.", + "default": "", + "optional": false + }, + { + "name": "growth_other_liabilities", + "type": "float", + "description": "Growth rate of other liabilities.", + "default": "", + "optional": false + }, + { + "name": "growth_total_liabilities", + "type": "float", + "description": "Growth rate of total liabilities.", + "default": "", + "optional": false + }, + { + "name": "growth_common_stock", + "type": "float", + "description": "Growth rate of common stock.", + "default": "", + "optional": false + }, + { + "name": "growth_retained_earnings", + "type": "float", + "description": "Growth rate of retained earnings.", + "default": "", + "optional": false + }, + { + "name": "growth_accumulated_other_comprehensive_income_loss", + "type": "float", + "description": "Growth rate of accumulated other comprehensive income/loss.", + "default": "", + "optional": false + }, + { + "name": "growth_othertotal_stockholders_equity", + "type": "float", + "description": "Growth rate of other total stockholders' equity.", + "default": "", + "optional": false + }, + { + "name": "growth_total_stockholders_equity", + "type": "float", + "description": "Growth rate of total stockholders' equity.", + "default": "", + "optional": false + }, + { + "name": "growth_total_liabilities_and_stockholders_equity", + "type": "float", + "description": "Growth rate of total liabilities and stockholders' equity.", + "default": "", + "optional": false + }, + { + "name": "growth_total_investments", + "type": "float", + "description": "Growth rate of total investments.", + "default": "", + "optional": false + }, + { + "name": "growth_total_debt", + "type": "float", + "description": "Growth rate of total debt.", + "default": "", + "optional": false + }, + { + "name": "growth_net_debt", + "type": "float", + "description": "Growth rate of net debt.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "BalanceSheetGrowth" + }, + "/equity/fundamental/cash": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the cash flow statement for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.cash(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.cash(symbol='AAPL', period='annual', limit=5, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "limit", + "type": "Annotated[int, Ge(ge=0)]", + "description": "The number of data entries to return.", + "default": 5, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true + } + ], + "intrinio": [ + { + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", + "description": "None", + "default": "annual", + "optional": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true + }, + { + "name": "filing_date", + "type": "date", + "description": "Filing date of the financial statement.", + "default": null, + "optional": true + }, + { + "name": "filing_date_lt", + "type": "date", + "description": "Filing date less than the given date.", + "default": null, + "optional": true + }, + { + "name": "filing_date_lte", + "type": "date", + "description": "Filing date less than or equal to the given date.", + "default": null, + "optional": true + }, + { + "name": "filing_date_gt", + "type": "date", + "description": "Filing date greater than the given date.", + "default": null, + "optional": true + }, + { + "name": "filing_date_gte", + "type": "date", + "description": "Filing date greater than or equal to the given date.", + "default": null, + "optional": true + }, + { + "name": "period_of_report_date", + "type": "date", + "description": "Period of report date of the financial statement.", + "default": null, + "optional": true + }, + { + "name": "period_of_report_date_lt", + "type": "date", + "description": "Period of report date less than the given date.", + "default": null, + "optional": true + }, + { + "name": "period_of_report_date_lte", + "type": "date", + "description": "Period of report date less than or equal to the given date.", + "default": null, + "optional": true + }, + { + "name": "period_of_report_date_gt", + "type": "date", + "description": "Period of report date greater than the given date.", + "default": null, + "optional": true + }, + { + "name": "period_of_report_date_gte", + "type": "date", + "description": "Period of report date greater than or equal to the given date.", + "default": null, + "optional": true + }, + { + "name": "include_sources", + "type": "bool", + "description": "Whether to include the sources of the financial statement.", + "default": false, + "optional": true + }, + { + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order of the financial statement.", + "default": null, + "optional": true + }, + { + "name": "sort", + "type": "Literal['filing_date', 'period_of_report_date']", + "description": "Sort of the financial statement.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CashFlowStatement]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", + "default": null, + "optional": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true + }, + { + "name": "filing_date", + "type": "date", + "description": "The date of the filing.", + "default": null, + "optional": true + }, + { + "name": "accepted_date", + "type": "datetime", + "description": "The date the filing was accepted.", + "default": null, + "optional": true + }, + { + "name": "reported_currency", + "type": "str", + "description": "The currency in which the cash flow statement was reported.", + "default": null, + "optional": true + }, + { + "name": "net_income", + "type": "float", + "description": "Net income.", + "default": null, + "optional": true + }, + { + "name": "depreciation_and_amortization", + "type": "float", + "description": "Depreciation and amortization.", + "default": null, + "optional": true + }, + { + "name": "deferred_income_tax", + "type": "float", + "description": "Deferred income tax.", + "default": null, + "optional": true + }, + { + "name": "stock_based_compensation", + "type": "float", + "description": "Stock-based compensation.", + "default": null, + "optional": true + }, + { + "name": "change_in_working_capital", + "type": "float", + "description": "Change in working capital.", + "default": null, + "optional": true + }, + { + "name": "change_in_account_receivables", + "type": "float", + "description": "Change in account receivables.", + "default": null, + "optional": true + }, + { + "name": "change_in_inventory", + "type": "float", + "description": "Change in inventory.", + "default": null, + "optional": true + }, + { + "name": "change_in_account_payable", + "type": "float", + "description": "Change in account payable.", + "default": null, + "optional": true + }, + { + "name": "change_in_other_working_capital", + "type": "float", + "description": "Change in other working capital.", + "default": null, + "optional": true + }, + { + "name": "change_in_other_non_cash_items", + "type": "float", + "description": "Change in other non-cash items.", + "default": null, + "optional": true + }, + { + "name": "net_cash_from_operating_activities", + "type": "float", + "description": "Net cash from operating activities.", + "default": null, + "optional": true + }, + { + "name": "purchase_of_property_plant_and_equipment", + "type": "float", + "description": "Purchase of property, plant and equipment.", + "default": null, + "optional": true + }, + { + "name": "acquisitions", + "type": "float", + "description": "Acquisitions.", + "default": null, + "optional": true + }, + { + "name": "purchase_of_investment_securities", + "type": "float", + "description": "Purchase of investment securities.", + "default": null, + "optional": true + }, + { + "name": "sale_and_maturity_of_investments", + "type": "float", + "description": "Sale and maturity of investments.", + "default": null, + "optional": true + }, + { + "name": "other_investing_activities", + "type": "float", + "description": "Other investing activities.", + "default": null, + "optional": true + }, + { + "name": "net_cash_from_investing_activities", + "type": "float", + "description": "Net cash from investing activities.", + "default": null, + "optional": true + }, + { + "name": "repayment_of_debt", + "type": "float", + "description": "Repayment of debt.", + "default": null, + "optional": true + }, + { + "name": "issuance_of_common_equity", + "type": "float", + "description": "Issuance of common equity.", + "default": null, + "optional": true + }, + { + "name": "repurchase_of_common_equity", + "type": "float", + "description": "Repurchase of common equity.", + "default": null, + "optional": true + }, + { + "name": "payment_of_dividends", + "type": "float", + "description": "Payment of dividends.", + "default": null, + "optional": true + }, + { + "name": "other_financing_activities", + "type": "float", + "description": "Other financing activities.", + "default": null, + "optional": true + }, + { + "name": "net_cash_from_financing_activities", + "type": "float", + "description": "Net cash from financing activities.", + "default": null, + "optional": true + }, + { + "name": "effect_of_exchange_rate_changes_on_cash", + "type": "float", + "description": "Effect of exchange rate changes on cash.", + "default": null, + "optional": true + }, + { + "name": "net_change_in_cash_and_equivalents", + "type": "float", + "description": "Net change in cash and equivalents.", + "default": null, + "optional": true + }, + { + "name": "cash_at_beginning_of_period", + "type": "float", + "description": "Cash at beginning of period.", + "default": null, + "optional": true + }, + { + "name": "cash_at_end_of_period", + "type": "float", + "description": "Cash at end of period.", + "default": null, + "optional": true + }, + { + "name": "operating_cash_flow", + "type": "float", + "description": "Operating cash flow.", + "default": null, + "optional": true + }, + { + "name": "capital_expenditure", + "type": "float", + "description": "Capital expenditure.", + "default": null, + "optional": true + }, + { + "name": "free_cash_flow", + "type": "float", + "description": "None", + "default": null, + "optional": true + }, + { + "name": "link", + "type": "str", + "description": "Link to the filing.", + "default": null, + "optional": true + }, + { + "name": "final_link", + "type": "str", + "description": "Link to the filing document.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet is reported.", + "default": null, + "optional": true + }, + { + "name": "net_income_continuing_operations", + "type": "float", + "description": "Net Income (Continuing Operations)", + "default": null, + "optional": true + }, + { + "name": "net_income_discontinued_operations", + "type": "float", + "description": "Net Income (Discontinued Operations)", + "default": null, + "optional": true + }, + { + "name": "net_income", + "type": "float", + "description": "Consolidated Net Income.", + "default": null, + "optional": true + }, + { + "name": "provision_for_loan_losses", + "type": "float", + "description": "Provision for Loan Losses", + "default": null, + "optional": true + }, + { + "name": "provision_for_credit_losses", + "type": "float", + "description": "Provision for credit losses", + "default": null, + "optional": true + }, + { + "name": "depreciation_expense", + "type": "float", + "description": "Depreciation Expense.", + "default": null, + "optional": true + }, + { + "name": "amortization_expense", + "type": "float", + "description": "Amortization Expense.", + "default": null, + "optional": true + }, + { + "name": "share_based_compensation", + "type": "float", + "description": "Share-based compensation.", + "default": null, + "optional": true + }, + { + "name": "non_cash_adjustments_to_reconcile_net_income", + "type": "float", + "description": "Non-Cash Adjustments to Reconcile Net Income.", + "default": null, + "optional": true + }, + { + "name": "changes_in_operating_assets_and_liabilities", + "type": "float", + "description": "Changes in Operating Assets and Liabilities (Net)", + "default": null, + "optional": true + }, + { + "name": "net_cash_from_continuing_operating_activities", + "type": "float", + "description": "Net Cash from Continuing Operating Activities", + "default": null, + "optional": true + }, + { + "name": "net_cash_from_discontinued_operating_activities", + "type": "float", + "description": "Net Cash from Discontinued Operating Activities", + "default": null, + "optional": true + }, + { + "name": "net_cash_from_operating_activities", + "type": "float", + "description": "Net Cash from Operating Activities", + "default": null, + "optional": true + }, + { + "name": "divestitures", + "type": "float", + "description": "Divestitures", + "default": null, + "optional": true + }, + { + "name": "sale_of_property_plant_and_equipment", + "type": "float", + "description": "Sale of Property, Plant, and Equipment", + "default": null, + "optional": true + }, + { + "name": "acquisitions", + "type": "float", + "description": "Acquisitions", + "default": null, + "optional": true + }, + { + "name": "purchase_of_investments", + "type": "float", + "description": "Purchase of Investments", + "default": null, + "optional": true + }, + { + "name": "purchase_of_investment_securities", + "type": "float", + "description": "Purchase of Investment Securities", + "default": null, + "optional": true + }, + { + "name": "sale_and_maturity_of_investments", + "type": "float", + "description": "Sale and Maturity of Investments", + "default": null, + "optional": true + }, + { + "name": "loans_held_for_sale", + "type": "float", + "description": "Loans Held for Sale (Net)", + "default": null, + "optional": true + }, + { + "name": "purchase_of_property_plant_and_equipment", + "type": "float", + "description": "Purchase of Property, Plant, and Equipment", + "default": null, + "optional": true + }, + { + "name": "other_investing_activities", + "type": "float", + "description": "Other Investing Activities (Net)", + "default": null, + "optional": true + }, + { + "name": "net_cash_from_continuing_investing_activities", + "type": "float", + "description": "Net Cash from Continuing Investing Activities", + "default": null, + "optional": true + }, + { + "name": "net_cash_from_discontinued_investing_activities", + "type": "float", + "description": "Net Cash from Discontinued Investing Activities", + "default": null, + "optional": true + }, + { + "name": "net_cash_from_investing_activities", + "type": "float", + "description": "Net Cash from Investing Activities", + "default": null, + "optional": true + }, + { + "name": "payment_of_dividends", + "type": "float", + "description": "Payment of Dividends", + "default": null, + "optional": true + }, + { + "name": "repurchase_of_common_equity", + "type": "float", + "description": "Repurchase of Common Equity", + "default": null, + "optional": true + }, + { + "name": "repurchase_of_preferred_equity", + "type": "float", + "description": "Repurchase of Preferred Equity", + "default": null, + "optional": true + }, + { + "name": "issuance_of_common_equity", + "type": "float", + "description": "Issuance of Common Equity", + "default": null, + "optional": true + }, + { + "name": "issuance_of_preferred_equity", + "type": "float", + "description": "Issuance of Preferred Equity", + "default": null, + "optional": true + }, + { + "name": "issuance_of_debt", + "type": "float", + "description": "Issuance of Debt", + "default": null, + "optional": true + }, + { + "name": "repayment_of_debt", + "type": "float", + "description": "Repayment of Debt", + "default": null, + "optional": true + }, + { + "name": "other_financing_activities", + "type": "float", + "description": "Other Financing Activities (Net)", + "default": null, + "optional": true + }, + { + "name": "cash_interest_received", + "type": "float", + "description": "Cash Interest Received", + "default": null, + "optional": true + }, + { + "name": "net_change_in_deposits", + "type": "float", + "description": "Net Change in Deposits", + "default": null, + "optional": true + }, + { + "name": "net_increase_in_fed_funds_sold", + "type": "float", + "description": "Net Increase in Fed Funds Sold", + "default": null, + "optional": true + }, + { + "name": "net_cash_from_continuing_financing_activities", + "type": "float", + "description": "Net Cash from Continuing Financing Activities", + "default": null, + "optional": true + }, + { + "name": "net_cash_from_discontinued_financing_activities", + "type": "float", + "description": "Net Cash from Discontinued Financing Activities", + "default": null, + "optional": true + }, + { + "name": "net_cash_from_financing_activities", + "type": "float", + "description": "Net Cash from Financing Activities", + "default": null, + "optional": true + }, + { + "name": "effect_of_exchange_rate_changes", + "type": "float", + "description": "Effect of Exchange Rate Changes", + "default": null, + "optional": true + }, + { + "name": "other_net_changes_in_cash", + "type": "float", + "description": "Other Net Changes in Cash", + "default": null, + "optional": true + }, + { + "name": "net_change_in_cash_and_equivalents", + "type": "float", + "description": "Net Change in Cash and Equivalents", + "default": null, + "optional": true + }, + { + "name": "cash_income_taxes_paid", + "type": "float", + "description": "Cash Income Taxes Paid", + "default": null, + "optional": true + }, + { + "name": "cash_interest_paid", + "type": "float", + "description": "Cash Interest Paid", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "net_cash_flow_from_operating_activities_continuing", + "type": "int", + "description": "Net cash flow from operating activities continuing.", + "default": null, + "optional": true + }, + { + "name": "net_cash_flow_from_operating_activities_discontinued", + "type": "int", + "description": "Net cash flow from operating activities discontinued.", + "default": null, + "optional": true + }, + { + "name": "net_cash_flow_from_operating_activities", + "type": "int", + "description": "Net cash flow from operating activities.", + "default": null, + "optional": true + }, + { + "name": "net_cash_flow_from_investing_activities_continuing", + "type": "int", + "description": "Net cash flow from investing activities continuing.", + "default": null, + "optional": true + }, + { + "name": "net_cash_flow_from_investing_activities_discontinued", + "type": "int", + "description": "Net cash flow from investing activities discontinued.", + "default": null, + "optional": true + }, + { + "name": "net_cash_flow_from_investing_activities", + "type": "int", + "description": "Net cash flow from investing activities.", + "default": null, + "optional": true + }, + { + "name": "net_cash_flow_from_financing_activities_continuing", + "type": "int", + "description": "Net cash flow from financing activities continuing.", + "default": null, + "optional": true + }, + { + "name": "net_cash_flow_from_financing_activities_discontinued", + "type": "int", + "description": "Net cash flow from financing activities discontinued.", + "default": null, + "optional": true + }, + { + "name": "net_cash_flow_from_financing_activities", + "type": "int", + "description": "Net cash flow from financing activities.", + "default": null, + "optional": true + }, + { + "name": "net_cash_flow_continuing", + "type": "int", + "description": "Net cash flow continuing.", + "default": null, + "optional": true + }, + { + "name": "net_cash_flow_discontinued", + "type": "int", + "description": "Net cash flow discontinued.", + "default": null, + "optional": true + }, + { + "name": "exchange_gains_losses", + "type": "int", + "description": "Exchange gains losses.", + "default": null, + "optional": true + }, + { + "name": "net_cash_flow", + "type": "int", + "description": "Net cash flow.", + "default": null, + "optional": true + } + ], + "yfinance": [] + }, + "model": "CashFlowStatement" + }, + "/equity/fundamental/reported_financials": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get financial statements as reported by the company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.reported_financials(symbol='AAPL', provider='intrinio')\n# Get AAPL balance sheet with a limit of 10 items.\nobb.equity.fundamental.reported_financials(symbol='AAPL', period='annual', statement_type='balance', limit=10, provider='intrinio')\n# Get reported income statement\nobb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='income', provider='intrinio')\n# Get reported cash flow statement\nobb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='cash', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "statement_type", + "type": "str", + "description": "The type of financial statement - i.e, balance, income, cash.", + "default": "balance", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return. Although the response object contains multiple results, because of the variance in the fields, year-to-year and quarter-to-quarter, it is recommended to view results in small chunks.", + "default": 100, + "optional": true + }, + { + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", + "optional": true + } + ], + "intrinio": [ + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true + }, + { + "name": "statement_type", + "type": "Literal['balance', 'income', 'cash']", + "description": "Cash flow statements are reported as YTD, Q4 is the same as FY.", + "default": "income", + "optional": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[ReportedFinancials]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['intrinio']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The ending date of the reporting period.", + "default": "", + "optional": false + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report (e.g. FY, Q1, etc.).", + "default": "", + "optional": false + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true + } + ], + "intrinio": [] + }, + "model": "ReportedFinancials" + }, + "/equity/fundamental/cash_growth": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the growth of a company's cash flow statement items over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.cash_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.cash_growth(symbol='AAPL', limit=10, provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CashFlowStatementGrowth]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "period", + "type": "str", + "description": "Period the statement is returned for.", + "default": "", + "optional": false + }, + { + "name": "growth_net_income", + "type": "float", + "description": "Growth rate of net income.", + "default": "", + "optional": false + }, + { + "name": "growth_depreciation_and_amortization", + "type": "float", + "description": "Growth rate of depreciation and amortization.", + "default": "", + "optional": false + }, + { + "name": "growth_deferred_income_tax", + "type": "float", + "description": "Growth rate of deferred income tax.", + "default": "", + "optional": false + }, + { + "name": "growth_stock_based_compensation", + "type": "float", + "description": "Growth rate of stock-based compensation.", + "default": "", + "optional": false + }, + { + "name": "growth_change_in_working_capital", + "type": "float", + "description": "Growth rate of change in working capital.", + "default": "", + "optional": false + }, + { + "name": "growth_accounts_receivables", + "type": "float", + "description": "Growth rate of accounts receivables.", + "default": "", + "optional": false + }, + { + "name": "growth_inventory", + "type": "float", + "description": "Growth rate of inventory.", + "default": "", + "optional": false + }, + { + "name": "growth_accounts_payables", + "type": "float", + "description": "Growth rate of accounts payables.", + "default": "", + "optional": false + }, + { + "name": "growth_other_working_capital", + "type": "float", + "description": "Growth rate of other working capital.", + "default": "", + "optional": false + }, + { + "name": "growth_other_non_cash_items", + "type": "float", + "description": "Growth rate of other non-cash items.", + "default": "", + "optional": false + }, + { + "name": "growth_net_cash_provided_by_operating_activities", + "type": "float", + "description": "Growth rate of net cash provided by operating activities.", + "default": "", + "optional": false + }, + { + "name": "growth_investments_in_property_plant_and_equipment", + "type": "float", + "description": "Growth rate of investments in property, plant, and equipment.", + "default": "", + "optional": false + }, + { + "name": "growth_acquisitions_net", + "type": "float", + "description": "Growth rate of net acquisitions.", + "default": "", + "optional": false + }, + { + "name": "growth_purchases_of_investments", + "type": "float", + "description": "Growth rate of purchases of investments.", + "default": "", + "optional": false + }, + { + "name": "growth_sales_maturities_of_investments", + "type": "float", + "description": "Growth rate of sales maturities of investments.", + "default": "", + "optional": false + }, + { + "name": "growth_other_investing_activities", + "type": "float", + "description": "Growth rate of other investing activities.", + "default": "", + "optional": false + }, + { + "name": "growth_net_cash_used_for_investing_activities", + "type": "float", + "description": "Growth rate of net cash used for investing activities.", + "default": "", + "optional": false + }, + { + "name": "growth_debt_repayment", + "type": "float", + "description": "Growth rate of debt repayment.", + "default": "", + "optional": false + }, + { + "name": "growth_common_stock_issued", + "type": "float", + "description": "Growth rate of common stock issued.", + "default": "", + "optional": false + }, + { + "name": "growth_common_stock_repurchased", + "type": "float", + "description": "Growth rate of common stock repurchased.", + "default": "", + "optional": false + }, + { + "name": "growth_dividends_paid", + "type": "float", + "description": "Growth rate of dividends paid.", + "default": "", + "optional": false + }, + { + "name": "growth_other_financing_activities", + "type": "float", + "description": "Growth rate of other financing activities.", + "default": "", + "optional": false + }, + { + "name": "growth_net_cash_used_provided_by_financing_activities", + "type": "float", + "description": "Growth rate of net cash used/provided by financing activities.", + "default": "", + "optional": false + }, + { + "name": "growth_effect_of_forex_changes_on_cash", + "type": "float", + "description": "Growth rate of the effect of foreign exchange changes on cash.", + "default": "", + "optional": false + }, + { + "name": "growth_net_change_in_cash", + "type": "float", + "description": "Growth rate of net change in cash.", + "default": "", + "optional": false + }, + { + "name": "growth_cash_at_end_of_period", + "type": "float", + "description": "Growth rate of cash at the end of the period.", + "default": "", + "optional": false + }, + { + "name": "growth_cash_at_beginning_of_period", + "type": "float", + "description": "Growth rate of cash at the beginning of the period.", + "default": "", + "optional": false + }, + { + "name": "growth_operating_cash_flow", + "type": "float", + "description": "Growth rate of operating cash flow.", + "default": "", + "optional": false + }, + { + "name": "growth_capital_expenditure", + "type": "float", + "description": "Growth rate of capital expenditure.", + "default": "", + "optional": false + }, + { + "name": "growth_free_cash_flow", + "type": "float", + "description": "Growth rate of free cash flow.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "CashFlowStatementGrowth" + }, + "/equity/fundamental/dividends": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical dividend data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.dividends(symbol='AAPL', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [], + "intrinio": [ + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100, + "optional": true + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[HistoricalDividends]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "ex_dividend_date", + "type": "date", + "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", + "default": "", + "optional": false + }, + { + "name": "amount", + "type": "float", + "description": "The dividend amount per share.", + "default": "", + "optional": false + } + ], + "fmp": [ + { + "name": "label", + "type": "str", + "description": "Label of the historical dividends.", + "default": "", + "optional": false + }, + { + "name": "adj_dividend", + "type": "float", + "description": "Adjusted dividend of the historical dividends.", + "default": "", + "optional": false + }, + { + "name": "record_date", + "type": "date", + "description": "Record date of the historical dividends.", + "default": null, + "optional": true + }, + { + "name": "payment_date", + "type": "date", + "description": "Payment date of the historical dividends.", + "default": null, + "optional": true + }, + { + "name": "declaration_date", + "type": "date", + "description": "Declaration date of the historical dividends.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "factor", + "type": "float", + "description": "factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "The currency in which the dividend is paid.", + "default": null, + "optional": true + }, + { + "name": "split_ratio", + "type": "float", + "description": "The ratio of the stock split, if a stock split occurred.", + "default": null, + "optional": true + } + ], + "yfinance": [] + }, + "model": "HistoricalDividends" + }, + "/equity/fundamental/historical_eps": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical earnings per share data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_eps(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[HistoricalEps]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": null, + "optional": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "announce_time", + "type": "str", + "description": "Timing of the earnings announcement.", + "default": null, + "optional": true + }, + { + "name": "eps_actual", + "type": "float", + "description": "Actual EPS from the earnings date.", + "default": null, + "optional": true + }, + { + "name": "eps_estimated", + "type": "float", + "description": "Estimated EPS for the earnings date.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "revenue_estimated", + "type": "float", + "description": "Estimated consensus revenue for the reporting period.", + "default": null, + "optional": true + }, + { + "name": "revenue_actual", + "type": "float", + "description": "The actual reported revenue.", + "default": null, + "optional": true + }, + { + "name": "reporting_time", + "type": "str", + "description": "The reporting time - e.g. after market close.", + "default": null, + "optional": true + }, + { + "name": "updated_at", + "type": "date", + "description": "The date when the data was last updated.", + "default": null, + "optional": true + }, + { + "name": "period_ending", + "type": "date", + "description": "The fiscal period end date.", + "default": null, + "optional": true + } + ] + }, + "model": "HistoricalEps" + }, + "/equity/fundamental/employee_count": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical employee count data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.employee_count(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[HistoricalEmployees]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "cik", + "type": "int", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "", + "optional": false + }, + { + "name": "acceptance_time", + "type": "datetime", + "description": "Time of acceptance of the company employee.", + "default": "", + "optional": false + }, + { + "name": "period_of_report", + "type": "date", + "description": "Date of reporting of the company employee.", + "default": "", + "optional": false + }, + { + "name": "company_name", + "type": "str", + "description": "Registered name of the company to retrieve the historical employees of.", + "default": "", + "optional": false + }, + { + "name": "form_type", + "type": "str", + "description": "Form type of the company employee.", + "default": "", + "optional": false + }, + { + "name": "filing_date", + "type": "date", + "description": "Filing date of the company employee", + "default": "", + "optional": false + }, + { + "name": "employee_count", + "type": "int", + "description": "Count of employees of the company.", + "default": "", + "optional": false + }, + { + "name": "source", + "type": "str", + "description": "Source URL which retrieves this data for the company.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "HistoricalEmployees" + }, + "/equity/fundamental/search_attributes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search Intrinio data tags to search in latest or historical attributes.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.search_attributes(query='ebitda', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str", + "description": "Query to search for.", + "default": "", + "optional": false + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 1000, + "optional": true + }, + { + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", + "optional": true + } + ], + "intrinio": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[SearchAttributes]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['intrinio']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "id", + "type": "str", + "description": "ID of the financial attribute.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the financial attribute.", + "default": "", + "optional": false + }, + { + "name": "tag", + "type": "str", + "description": "Tag of the financial attribute.", + "default": "", + "optional": false + }, + { + "name": "statement_code", + "type": "str", + "description": "Code of the financial statement.", + "default": "", + "optional": false + }, + { + "name": "statement_type", + "type": "str", + "description": "Type of the financial statement.", + "default": null, + "optional": true + }, + { + "name": "parent_name", + "type": "str", + "description": "Parent's name of the financial attribute.", + "default": null, + "optional": true + }, + { + "name": "sequence", + "type": "int", + "description": "Sequence of the financial statement.", + "default": null, + "optional": true + }, + { + "name": "factor", + "type": "str", + "description": "Unit of the financial attribute.", + "default": null, + "optional": true + }, + { + "name": "transaction", + "type": "str", + "description": "Transaction type (credit/debit) of the financial attribute.", + "default": null, + "optional": true + }, + { + "name": "type", + "type": "str", + "description": "Type of the financial attribute.", + "default": null, + "optional": true + }, + { + "name": "unit", + "type": "str", + "description": "Unit of the financial attribute.", + "default": null, + "optional": true + } + ], + "intrinio": [] + }, + "model": "SearchAttributes" + }, + "/equity/fundamental/latest_attributes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the latest value of a data tag from Intrinio.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.latest_attributes(symbol='AAPL', tag='ceo', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", + "default": "", + "optional": false + }, + { + "name": "tag", + "type": "Union[str, List[str]]", + "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", + "optional": true + } + ], + "intrinio": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[LatestAttributes]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['intrinio']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "tag", + "type": "str", + "description": "Tag name for the fetched data.", + "default": null, + "optional": true + }, + { + "name": "value", + "type": "Union[str, float]", + "description": "The value of the data.", + "default": null, + "optional": true + } + ], + "intrinio": [] + }, + "model": "LatestAttributes" + }, + "/equity/fundamental/historical_attributes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the historical values of a data tag from Intrinio.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_attributes(symbol='AAPL', tag='ebitda', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", + "default": "", + "optional": false + }, + { + "name": "tag", + "type": "Union[str, List[str]]", + "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", + "default": "", + "optional": false + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "frequency", + "type": "Literal['daily', 'weekly', 'monthly', 'quarterly', 'yearly']", + "description": "The frequency of the data.", + "default": "yearly", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 1000, + "optional": true + }, + { + "name": "tag_type", + "type": "str", + "description": "Filter by type, when applicable.", + "default": null, + "optional": true + }, + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order.", + "default": "desc", + "optional": true + }, + { + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", + "optional": true + } + ], + "intrinio": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[HistoricalAttributes]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['intrinio']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "tag", + "type": "str", + "description": "Tag name for the fetched data.", + "default": null, + "optional": true + }, + { + "name": "value", + "type": "float", + "description": "The value of the data.", + "default": null, + "optional": true + } + ], + "intrinio": [] + }, + "model": "HistoricalAttributes" + }, + "/equity/fundamental/income": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the income statement for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.income(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.income(symbol='AAPL', period='annual', limit=5, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "limit", + "type": "Annotated[int, Ge(ge=0)]", + "description": "The number of data entries to return.", + "default": 5, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true + } + ], + "intrinio": [ + { + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", + "description": "None", + "default": "annual", + "optional": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm']", + "description": "None", + "default": "annual", + "optional": true + }, + { + "name": "filing_date", + "type": "date", + "description": "Filing date of the financial statement.", + "default": null, + "optional": true + }, + { + "name": "filing_date_lt", + "type": "date", + "description": "Filing date less than the given date.", + "default": null, + "optional": true + }, + { + "name": "filing_date_lte", + "type": "date", + "description": "Filing date less than or equal to the given date.", + "default": null, + "optional": true + }, + { + "name": "filing_date_gt", + "type": "date", + "description": "Filing date greater than the given date.", + "default": null, + "optional": true + }, + { + "name": "filing_date_gte", + "type": "date", + "description": "Filing date greater than or equal to the given date.", + "default": null, + "optional": true + }, + { + "name": "period_of_report_date", + "type": "date", + "description": "Period of report date of the financial statement.", + "default": null, + "optional": true + }, + { + "name": "period_of_report_date_lt", + "type": "date", + "description": "Period of report date less than the given date.", + "default": null, + "optional": true + }, + { + "name": "period_of_report_date_lte", + "type": "date", + "description": "Period of report date less than or equal to the given date.", + "default": null, + "optional": true + }, + { + "name": "period_of_report_date_gt", + "type": "date", + "description": "Period of report date greater than the given date.", + "default": null, + "optional": true + }, + { + "name": "period_of_report_date_gte", + "type": "date", + "description": "Period of report date greater than or equal to the given date.", + "default": null, + "optional": true + }, + { + "name": "include_sources", + "type": "bool", + "description": "Whether to include the sources of the financial statement.", + "default": null, + "optional": true + }, + { + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order of the financial statement.", + "default": null, + "optional": true + }, + { + "name": "sort", + "type": "Literal['filing_date', 'period_of_report_date']", + "description": "Sort of the financial statement.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[IncomeStatement]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", + "default": null, + "optional": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "filing_date", + "type": "date", + "description": "The date when the filing was made.", + "default": null, + "optional": true + }, + { + "name": "accepted_date", + "type": "datetime", + "description": "The date and time when the filing was accepted.", + "default": null, + "optional": true + }, + { + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet was reported.", + "default": null, + "optional": true + }, + { + "name": "revenue", + "type": "float", + "description": "Total revenue.", + "default": null, + "optional": true + }, + { + "name": "cost_of_revenue", + "type": "float", + "description": "Cost of revenue.", + "default": null, + "optional": true + }, + { + "name": "gross_profit", + "type": "float", + "description": "Gross profit.", + "default": null, + "optional": true + }, + { + "name": "gross_profit_margin", + "type": "float", + "description": "Gross profit margin.", + "default": null, + "optional": true + }, + { + "name": "general_and_admin_expense", + "type": "float", + "description": "General and administrative expenses.", + "default": null, + "optional": true + }, + { + "name": "research_and_development_expense", + "type": "float", + "description": "Research and development expenses.", + "default": null, + "optional": true + }, + { + "name": "selling_and_marketing_expense", + "type": "float", + "description": "Selling and marketing expenses.", + "default": null, + "optional": true + }, + { + "name": "selling_general_and_admin_expense", + "type": "float", + "description": "Selling, general and administrative expenses.", + "default": null, + "optional": true + }, + { + "name": "other_expenses", + "type": "float", + "description": "Other expenses.", + "default": null, + "optional": true + }, + { + "name": "total_operating_expenses", + "type": "float", + "description": "Total operating expenses.", + "default": null, + "optional": true + }, + { + "name": "cost_and_expenses", + "type": "float", + "description": "Cost and expenses.", + "default": null, + "optional": true + }, + { + "name": "interest_income", + "type": "float", + "description": "Interest income.", + "default": null, + "optional": true + }, + { + "name": "total_interest_expense", + "type": "float", + "description": "Total interest expenses.", + "default": null, + "optional": true + }, + { + "name": "depreciation_and_amortization", + "type": "float", + "description": "Depreciation and amortization.", + "default": null, + "optional": true + }, + { + "name": "ebitda", + "type": "float", + "description": "EBITDA.", + "default": null, + "optional": true + }, + { + "name": "ebitda_margin", + "type": "float", + "description": "EBITDA margin.", + "default": null, + "optional": true + }, + { + "name": "total_operating_income", + "type": "float", + "description": "Total operating income.", + "default": null, + "optional": true + }, + { + "name": "operating_income_margin", + "type": "float", + "description": "Operating income margin.", + "default": null, + "optional": true + }, + { + "name": "total_other_income_expenses", + "type": "float", + "description": "Total other income and expenses.", + "default": null, + "optional": true + }, + { + "name": "total_pre_tax_income", + "type": "float", + "description": "Total pre-tax income.", + "default": null, + "optional": true + }, + { + "name": "pre_tax_income_margin", + "type": "float", + "description": "Pre-tax income margin.", + "default": null, + "optional": true + }, + { + "name": "income_tax_expense", + "type": "float", + "description": "Income tax expense.", + "default": null, + "optional": true + }, + { + "name": "consolidated_net_income", + "type": "float", + "description": "Consolidated net income.", + "default": null, + "optional": true + }, + { + "name": "net_income_margin", + "type": "float", + "description": "Net income margin.", + "default": null, + "optional": true + }, + { + "name": "basic_earnings_per_share", + "type": "float", + "description": "Basic earnings per share.", + "default": null, + "optional": true + }, + { + "name": "diluted_earnings_per_share", + "type": "float", + "description": "Diluted earnings per share.", + "default": null, + "optional": true + }, + { + "name": "weighted_average_basic_shares_outstanding", + "type": "float", + "description": "Weighted average basic shares outstanding.", + "default": null, + "optional": true + }, + { + "name": "weighted_average_diluted_shares_outstanding", + "type": "float", + "description": "Weighted average diluted shares outstanding.", + "default": null, + "optional": true + }, + { + "name": "link", + "type": "str", + "description": "Link to the filing.", + "default": null, + "optional": true + }, + { + "name": "final_link", + "type": "str", + "description": "Link to the filing document.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet is reported.", + "default": null, + "optional": true + }, + { + "name": "revenue", + "type": "float", + "description": "Total revenue", + "default": null, + "optional": true + }, + { + "name": "operating_revenue", + "type": "float", + "description": "Total operating revenue", + "default": null, + "optional": true + }, + { + "name": "cost_of_revenue", + "type": "float", + "description": "Total cost of revenue", + "default": null, + "optional": true + }, + { + "name": "operating_cost_of_revenue", + "type": "float", + "description": "Total operating cost of revenue", + "default": null, + "optional": true + }, + { + "name": "gross_profit", + "type": "float", + "description": "Total gross profit", + "default": null, + "optional": true + }, + { + "name": "gross_profit_margin", + "type": "float", + "description": "Gross margin ratio.", + "default": null, + "optional": true + }, + { + "name": "provision_for_credit_losses", + "type": "float", + "description": "Provision for credit losses", + "default": null, + "optional": true + }, + { + "name": "research_and_development_expense", + "type": "float", + "description": "Research and development expense", + "default": null, + "optional": true + }, + { + "name": "selling_general_and_admin_expense", + "type": "float", + "description": "Selling, general, and admin expense", + "default": null, + "optional": true + }, + { + "name": "salaries_and_employee_benefits", + "type": "float", + "description": "Salaries and employee benefits", + "default": null, + "optional": true + }, + { + "name": "marketing_expense", + "type": "float", + "description": "Marketing expense", + "default": null, + "optional": true + }, + { + "name": "net_occupancy_and_equipment_expense", + "type": "float", + "description": "Net occupancy and equipment expense", + "default": null, + "optional": true + }, + { + "name": "other_operating_expenses", + "type": "float", + "description": "Other operating expenses", + "default": null, + "optional": true + }, + { + "name": "depreciation_expense", + "type": "float", + "description": "Depreciation expense", + "default": null, + "optional": true + }, + { + "name": "amortization_expense", + "type": "float", + "description": "Amortization expense", + "default": null, + "optional": true + }, + { + "name": "amortization_of_deferred_policy_acquisition_costs", + "type": "float", + "description": "Amortization of deferred policy acquisition costs", + "default": null, + "optional": true + }, + { + "name": "exploration_expense", + "type": "float", + "description": "Exploration expense", + "default": null, + "optional": true + }, + { + "name": "depletion_expense", + "type": "float", + "description": "Depletion expense", + "default": null, + "optional": true + }, + { + "name": "total_operating_expenses", + "type": "float", + "description": "Total operating expenses", + "default": null, + "optional": true + }, + { + "name": "total_operating_income", + "type": "float", + "description": "Total operating income", + "default": null, + "optional": true + }, + { + "name": "deposits_and_money_market_investments_interest_income", + "type": "float", + "description": "Deposits and money market investments interest income", + "default": null, + "optional": true + }, + { + "name": "federal_funds_sold_and_securities_borrowed_interest_income", + "type": "float", + "description": "Federal funds sold and securities borrowed interest income", + "default": null, + "optional": true + }, + { + "name": "investment_securities_interest_income", + "type": "float", + "description": "Investment securities interest income", + "default": null, + "optional": true + }, + { + "name": "loans_and_leases_interest_income", + "type": "float", + "description": "Loans and leases interest income", + "default": null, + "optional": true + }, + { + "name": "trading_account_interest_income", + "type": "float", + "description": "Trading account interest income", + "default": null, + "optional": true + }, + { + "name": "other_interest_income", + "type": "float", + "description": "Other interest income", + "default": null, + "optional": true + }, + { + "name": "total_non_interest_income", + "type": "float", + "description": "Total non-interest income", + "default": null, + "optional": true + }, + { + "name": "interest_and_investment_income", + "type": "float", + "description": "Interest and investment income", + "default": null, + "optional": true + }, + { + "name": "short_term_borrowings_interest_expense", + "type": "float", + "description": "Short-term borrowings interest expense", + "default": null, + "optional": true + }, + { + "name": "long_term_debt_interest_expense", + "type": "float", + "description": "Long-term debt interest expense", + "default": null, + "optional": true + }, + { + "name": "capitalized_lease_obligations_interest_expense", + "type": "float", + "description": "Capitalized lease obligations interest expense", + "default": null, + "optional": true + }, + { + "name": "deposits_interest_expense", + "type": "float", + "description": "Deposits interest expense", + "default": null, + "optional": true + }, + { + "name": "federal_funds_purchased_and_securities_sold_interest_expense", + "type": "float", + "description": "Federal funds purchased and securities sold interest expense", + "default": null, + "optional": true + }, + { + "name": "other_interest_expense", + "type": "float", + "description": "Other interest expense", + "default": null, + "optional": true + }, + { + "name": "total_interest_expense", + "type": "float", + "description": "Total interest expense", + "default": null, + "optional": true + }, + { + "name": "net_interest_income", + "type": "float", + "description": "Net interest income", + "default": null, + "optional": true + }, + { + "name": "other_non_interest_income", + "type": "float", + "description": "Other non-interest income", + "default": null, + "optional": true + }, + { + "name": "investment_banking_income", + "type": "float", + "description": "Investment banking income", + "default": null, + "optional": true + }, + { + "name": "trust_fees_by_commissions", + "type": "float", + "description": "Trust fees by commissions", + "default": null, + "optional": true + }, + { + "name": "premiums_earned", + "type": "float", + "description": "Premiums earned", + "default": null, + "optional": true + }, + { + "name": "insurance_policy_acquisition_costs", + "type": "float", + "description": "Insurance policy acquisition costs", + "default": null, + "optional": true + }, + { + "name": "current_and_future_benefits", + "type": "float", + "description": "Current and future benefits", + "default": null, + "optional": true + }, + { + "name": "property_and_liability_insurance_claims", + "type": "float", + "description": "Property and liability insurance claims", + "default": null, + "optional": true + }, + { + "name": "total_non_interest_expense", + "type": "float", + "description": "Total non-interest expense", + "default": null, + "optional": true + }, + { + "name": "net_realized_and_unrealized_capital_gains_on_investments", + "type": "float", + "description": "Net realized and unrealized capital gains on investments", + "default": null, + "optional": true + }, + { + "name": "other_gains", + "type": "float", + "description": "Other gains", + "default": null, + "optional": true + }, + { + "name": "non_operating_income", + "type": "float", + "description": "Non-operating income", + "default": null, + "optional": true + }, + { + "name": "other_income", + "type": "float", + "description": "Other income", + "default": null, + "optional": true + }, + { + "name": "other_revenue", + "type": "float", + "description": "Other revenue", + "default": null, + "optional": true + }, + { + "name": "extraordinary_income", + "type": "float", + "description": "Extraordinary income", + "default": null, + "optional": true + }, + { + "name": "total_other_income", + "type": "float", + "description": "Total other income", + "default": null, + "optional": true + }, + { + "name": "ebitda", + "type": "float", + "description": "Earnings Before Interest, Taxes, Depreciation and Amortization.", + "default": null, + "optional": true + }, + { + "name": "ebitda_margin", + "type": "float", + "description": "Margin on Earnings Before Interest, Taxes, Depreciation and Amortization.", + "default": null, + "optional": true + }, + { + "name": "total_pre_tax_income", + "type": "float", + "description": "Total pre-tax income", + "default": null, + "optional": true + }, + { + "name": "ebit", + "type": "float", + "description": "Earnings Before Interest and Taxes.", + "default": null, + "optional": true + }, + { + "name": "pre_tax_income_margin", + "type": "float", + "description": "Pre-Tax Income Margin.", + "default": null, + "optional": true + }, + { + "name": "income_tax_expense", + "type": "float", + "description": "Income tax expense", + "default": null, + "optional": true + }, + { + "name": "impairment_charge", + "type": "float", + "description": "Impairment charge", + "default": null, + "optional": true + }, + { + "name": "restructuring_charge", + "type": "float", + "description": "Restructuring charge", + "default": null, + "optional": true + }, + { + "name": "service_charges_on_deposit_accounts", + "type": "float", + "description": "Service charges on deposit accounts", + "default": null, + "optional": true + }, + { + "name": "other_service_charges", + "type": "float", + "description": "Other service charges", + "default": null, + "optional": true + }, + { + "name": "other_special_charges", + "type": "float", + "description": "Other special charges", + "default": null, + "optional": true + }, + { + "name": "other_cost_of_revenue", + "type": "float", + "description": "Other cost of revenue", + "default": null, + "optional": true + }, + { + "name": "net_income_continuing_operations", + "type": "float", + "description": "Net income (continuing operations)", + "default": null, + "optional": true + }, + { + "name": "net_income_discontinued_operations", + "type": "float", + "description": "Net income (discontinued operations)", + "default": null, + "optional": true + }, + { + "name": "consolidated_net_income", + "type": "float", + "description": "Consolidated net income", + "default": null, + "optional": true + }, + { + "name": "other_adjustments_to_consolidated_net_income", + "type": "float", + "description": "Other adjustments to consolidated net income", + "default": null, + "optional": true + }, + { + "name": "other_adjustment_to_net_income_attributable_to_common_shareholders", + "type": "float", + "description": "Other adjustment to net income attributable to common shareholders", + "default": null, + "optional": true + }, + { + "name": "net_income_attributable_to_noncontrolling_interest", + "type": "float", + "description": "Net income attributable to noncontrolling interest", + "default": null, + "optional": true + }, + { + "name": "net_income_attributable_to_common_shareholders", + "type": "float", + "description": "Net income attributable to common shareholders", + "default": null, + "optional": true + }, + { + "name": "basic_earnings_per_share", + "type": "float", + "description": "Basic earnings per share", + "default": null, + "optional": true + }, + { + "name": "diluted_earnings_per_share", + "type": "float", + "description": "Diluted earnings per share", + "default": null, + "optional": true + }, + { + "name": "basic_and_diluted_earnings_per_share", + "type": "float", + "description": "Basic and diluted earnings per share", + "default": null, + "optional": true + }, + { + "name": "cash_dividends_to_common_per_share", + "type": "float", + "description": "Cash dividends to common per share", + "default": null, + "optional": true + }, + { + "name": "preferred_stock_dividends_declared", + "type": "float", + "description": "Preferred stock dividends declared", + "default": null, + "optional": true + }, + { + "name": "weighted_average_basic_shares_outstanding", + "type": "float", + "description": "Weighted average basic shares outstanding", + "default": null, + "optional": true + }, + { + "name": "weighted_average_diluted_shares_outstanding", + "type": "float", + "description": "Weighted average diluted shares outstanding", + "default": null, + "optional": true + }, + { + "name": "weighted_average_basic_and_diluted_shares_outstanding", + "type": "float", + "description": "Weighted average basic and diluted shares outstanding", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "revenue", + "type": "float", + "description": "Total Revenue", + "default": null, + "optional": true + }, + { + "name": "cost_of_revenue_goods", + "type": "float", + "description": "Cost of Revenue - Goods", + "default": null, + "optional": true + }, + { + "name": "cost_of_revenue_services", + "type": "float", + "description": "Cost of Revenue - Services", + "default": null, + "optional": true + }, + { + "name": "cost_of_revenue", + "type": "float", + "description": "Cost of Revenue", + "default": null, + "optional": true + }, + { + "name": "gross_profit", + "type": "float", + "description": "Gross Profit", + "default": null, + "optional": true + }, + { + "name": "provisions_for_loan_lease_and_other_losses", + "type": "float", + "description": "Provisions for loan lease and other losses", + "default": null, + "optional": true + }, + { + "name": "depreciation_and_amortization", + "type": "float", + "description": "Depreciation and Amortization", + "default": null, + "optional": true + }, + { + "name": "income_tax_expense_benefit_current", + "type": "float", + "description": "Income tax expense benefit current", + "default": null, + "optional": true + }, + { + "name": "deferred_tax_benefit", + "type": "float", + "description": "Deferred tax benefit", + "default": null, + "optional": true + }, + { + "name": "benefits_costs_expenses", + "type": "float", + "description": "Benefits, costs and expenses", + "default": null, + "optional": true + }, + { + "name": "selling_general_and_administrative_expense", + "type": "float", + "description": "Selling, general and administrative expense", + "default": null, + "optional": true + }, + { + "name": "research_and_development", + "type": "float", + "description": "Research and development", + "default": null, + "optional": true + }, + { + "name": "costs_and_expenses", + "type": "float", + "description": "Costs and expenses", + "default": null, + "optional": true + }, + { + "name": "other_operating_expenses", + "type": "float", + "description": "Other Operating Expenses", + "default": null, + "optional": true + }, + { + "name": "operating_expenses", + "type": "float", + "description": "Operating expenses", + "default": null, + "optional": true + }, + { + "name": "operating_income", + "type": "float", + "description": "Operating Income/Loss", + "default": null, + "optional": true + }, + { + "name": "non_operating_income", + "type": "float", + "description": "Non Operating Income/Loss", + "default": null, + "optional": true + }, + { + "name": "interest_and_dividend_income", + "type": "float", + "description": "Interest and Dividend Income", + "default": null, + "optional": true + }, + { + "name": "total_interest_expense", + "type": "float", + "description": "Interest Expense", + "default": null, + "optional": true + }, + { + "name": "interest_and_debt_expense", + "type": "float", + "description": "Interest and Debt Expense", + "default": null, + "optional": true + }, + { + "name": "net_interest_income", + "type": "float", + "description": "Interest Income Net", + "default": null, + "optional": true + }, + { + "name": "interest_income_after_provision_for_losses", + "type": "float", + "description": "Interest Income After Provision for Losses", + "default": null, + "optional": true + }, + { + "name": "non_interest_expense", + "type": "float", + "description": "Non-Interest Expense", + "default": null, + "optional": true + }, + { + "name": "non_interest_income", + "type": "float", + "description": "Non-Interest Income", + "default": null, + "optional": true + }, + { + "name": "income_from_discontinued_operations_net_of_tax_on_disposal", + "type": "float", + "description": "Income From Discontinued Operations Net of Tax on Disposal", + "default": null, + "optional": true + }, + { + "name": "income_from_discontinued_operations_net_of_tax", + "type": "float", + "description": "Income From Discontinued Operations Net of Tax", + "default": null, + "optional": true + }, + { + "name": "income_before_equity_method_investments", + "type": "float", + "description": "Income Before Equity Method Investments", + "default": null, + "optional": true + }, + { + "name": "income_from_equity_method_investments", + "type": "float", + "description": "Income From Equity Method Investments", + "default": null, + "optional": true + }, + { + "name": "total_pre_tax_income", + "type": "float", + "description": "Income Before Tax", + "default": null, + "optional": true + }, + { + "name": "income_tax_expense", + "type": "float", + "description": "Income Tax Expense", + "default": null, + "optional": true + }, + { + "name": "income_after_tax", + "type": "float", + "description": "Income After Tax", + "default": null, + "optional": true + }, + { + "name": "consolidated_net_income", + "type": "float", + "description": "Net Income/Loss", + "default": null, + "optional": true + }, + { + "name": "net_income_attributable_noncontrolling_interest", + "type": "float", + "description": "Net income (loss) attributable to noncontrolling interest", + "default": null, + "optional": true + }, + { + "name": "net_income_attributable_to_parent", + "type": "float", + "description": "Net income (loss) attributable to parent", + "default": null, + "optional": true + }, + { + "name": "net_income_attributable_to_common_shareholders", + "type": "float", + "description": "Net Income/Loss Available To Common Stockholders Basic", + "default": null, + "optional": true + }, + { + "name": "participating_securities_earnings", + "type": "float", + "description": "Participating Securities Distributed And Undistributed Earnings Loss Basic", + "default": null, + "optional": true + }, + { + "name": "undistributed_earnings_allocated_to_participating_securities", + "type": "float", + "description": "Undistributed Earnings Allocated To Participating Securities", + "default": null, + "optional": true + }, + { + "name": "common_stock_dividends", + "type": "float", + "description": "Common Stock Dividends", + "default": null, + "optional": true + }, + { + "name": "preferred_stock_dividends_and_other_adjustments", + "type": "float", + "description": "Preferred stock dividends and other adjustments", + "default": null, + "optional": true + }, + { + "name": "basic_earnings_per_share", + "type": "float", + "description": "Earnings Per Share", + "default": null, + "optional": true + }, + { + "name": "diluted_earnings_per_share", + "type": "float", + "description": "Diluted Earnings Per Share", + "default": null, + "optional": true + }, + { + "name": "weighted_average_basic_shares_outstanding", + "type": "float", + "description": "Basic Average Shares", + "default": null, + "optional": true + }, + { + "name": "weighted_average_diluted_shares_outstanding", + "type": "float", + "description": "Diluted Average Shares", + "default": null, + "optional": true + } + ], + "yfinance": [] + }, + "model": "IncomeStatement" + }, + "/equity/fundamental/income_growth": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the growth of a company's income statement items over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.income_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.income_growth(symbol='AAPL', limit=10, period='annual', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10, + "optional": true + }, + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[IncomeStatementGrowth]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "period", + "type": "str", + "description": "Period the statement is returned for.", + "default": "", + "optional": false + }, + { + "name": "growth_revenue", + "type": "float", + "description": "Growth rate of total revenue.", + "default": "", + "optional": false + }, + { + "name": "growth_cost_of_revenue", + "type": "float", + "description": "Growth rate of cost of goods sold.", + "default": "", + "optional": false + }, + { + "name": "growth_gross_profit", + "type": "float", + "description": "Growth rate of gross profit.", + "default": "", + "optional": false + }, + { + "name": "growth_gross_profit_ratio", + "type": "float", + "description": "Growth rate of gross profit as a percentage of revenue.", + "default": "", + "optional": false + }, + { + "name": "growth_research_and_development_expenses", + "type": "float", + "description": "Growth rate of expenses on research and development.", + "default": "", + "optional": false + }, + { + "name": "growth_general_and_administrative_expenses", + "type": "float", + "description": "Growth rate of general and administrative expenses.", + "default": "", + "optional": false + }, + { + "name": "growth_selling_and_marketing_expenses", + "type": "float", + "description": "Growth rate of expenses on selling and marketing activities.", + "default": "", + "optional": false + }, + { + "name": "growth_other_expenses", + "type": "float", + "description": "Growth rate of other operating expenses.", + "default": "", + "optional": false + }, + { + "name": "growth_operating_expenses", + "type": "float", + "description": "Growth rate of total operating expenses.", + "default": "", + "optional": false + }, + { + "name": "growth_cost_and_expenses", + "type": "float", + "description": "Growth rate of total costs and expenses.", + "default": "", + "optional": false + }, + { + "name": "growth_interest_expense", + "type": "float", + "description": "Growth rate of interest expenses.", + "default": "", + "optional": false + }, + { + "name": "growth_depreciation_and_amortization", + "type": "float", + "description": "Growth rate of depreciation and amortization expenses.", + "default": "", + "optional": false + }, + { + "name": "growth_ebitda", + "type": "float", + "description": "Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization.", + "default": "", + "optional": false + }, + { + "name": "growth_ebitda_ratio", + "type": "float", + "description": "Growth rate of EBITDA as a percentage of revenue.", + "default": "", + "optional": false + }, + { + "name": "growth_operating_income", + "type": "float", + "description": "Growth rate of operating income.", + "default": "", + "optional": false + }, + { + "name": "growth_operating_income_ratio", + "type": "float", + "description": "Growth rate of operating income as a percentage of revenue.", + "default": "", + "optional": false + }, + { + "name": "growth_total_other_income_expenses_net", + "type": "float", + "description": "Growth rate of net total other income and expenses.", + "default": "", + "optional": false + }, + { + "name": "growth_income_before_tax", + "type": "float", + "description": "Growth rate of income before taxes.", + "default": "", + "optional": false + }, + { + "name": "growth_income_before_tax_ratio", + "type": "float", + "description": "Growth rate of income before taxes as a percentage of revenue.", + "default": "", + "optional": false + }, + { + "name": "growth_income_tax_expense", + "type": "float", + "description": "Growth rate of income tax expenses.", + "default": "", + "optional": false + }, + { + "name": "growth_net_income", + "type": "float", + "description": "Growth rate of net income.", + "default": "", + "optional": false + }, + { + "name": "growth_net_income_ratio", + "type": "float", + "description": "Growth rate of net income as a percentage of revenue.", + "default": "", + "optional": false + }, + { + "name": "growth_eps", + "type": "float", + "description": "Growth rate of Earnings Per Share (EPS).", + "default": "", + "optional": false + }, + { + "name": "growth_eps_diluted", + "type": "float", + "description": "Growth rate of diluted Earnings Per Share (EPS).", + "default": "", + "optional": false + }, + { + "name": "growth_weighted_average_shs_out", + "type": "float", + "description": "Growth rate of weighted average shares outstanding.", + "default": "", + "optional": false + }, + { + "name": "growth_weighted_average_shs_out_dil", + "type": "float", + "description": "Growth rate of diluted weighted average shares outstanding.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "IncomeStatementGrowth" + }, + "/equity/fundamental/metrics": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get fundamental metrics for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.metrics(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.metrics(symbol='AAPL', period='annual', limit=100, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", + "default": "", + "optional": false + }, + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "with_ttm", + "type": "bool", + "description": "Include trailing twelve months (TTM) data.", + "default": false, + "optional": true + } + ], + "intrinio": [], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[KeyMetrics]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "market_cap", + "type": "float", + "description": "Market capitalization", + "default": null, + "optional": true + }, + { + "name": "pe_ratio", + "type": "float", + "description": "Price-to-earnings ratio (P/E ratio)", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "period", + "type": "str", + "description": "Period of the data.", + "default": "", + "optional": false + }, + { + "name": "calendar_year", + "type": "int", + "description": "Calendar year.", + "default": null, + "optional": true + }, + { + "name": "revenue_per_share", + "type": "float", + "description": "Revenue per share", + "default": null, + "optional": true + }, + { + "name": "net_income_per_share", + "type": "float", + "description": "Net income per share", + "default": null, + "optional": true + }, + { + "name": "operating_cash_flow_per_share", + "type": "float", + "description": "Operating cash flow per share", + "default": null, + "optional": true + }, + { + "name": "free_cash_flow_per_share", + "type": "float", + "description": "Free cash flow per share", + "default": null, + "optional": true + }, + { + "name": "cash_per_share", + "type": "float", + "description": "Cash per share", + "default": null, + "optional": true + }, + { + "name": "book_value_per_share", + "type": "float", + "description": "Book value per share", + "default": null, + "optional": true + }, + { + "name": "tangible_book_value_per_share", + "type": "float", + "description": "Tangible book value per share", + "default": null, + "optional": true + }, + { + "name": "shareholders_equity_per_share", + "type": "float", + "description": "Shareholders equity per share", + "default": null, + "optional": true + }, + { + "name": "interest_debt_per_share", + "type": "float", + "description": "Interest debt per share", + "default": null, + "optional": true + }, + { + "name": "enterprise_value", + "type": "float", + "description": "Enterprise value", + "default": null, + "optional": true + }, + { + "name": "price_to_sales_ratio", + "type": "float", + "description": "Price-to-sales ratio", + "default": null, + "optional": true + }, + { + "name": "pocf_ratio", + "type": "float", + "description": "Price-to-operating cash flow ratio", + "default": null, + "optional": true + }, + { + "name": "pfcf_ratio", + "type": "float", + "description": "Price-to-free cash flow ratio", + "default": null, + "optional": true + }, + { + "name": "pb_ratio", + "type": "float", + "description": "Price-to-book ratio", + "default": null, + "optional": true + }, + { + "name": "ptb_ratio", + "type": "float", + "description": "Price-to-tangible book ratio", + "default": null, + "optional": true + }, + { + "name": "ev_to_sales", + "type": "float", + "description": "Enterprise value-to-sales ratio", + "default": null, + "optional": true + }, + { + "name": "enterprise_value_over_ebitda", + "type": "float", + "description": "Enterprise value-to-EBITDA ratio", + "default": null, + "optional": true + }, + { + "name": "ev_to_operating_cash_flow", + "type": "float", + "description": "Enterprise value-to-operating cash flow ratio", + "default": null, + "optional": true + }, + { + "name": "ev_to_free_cash_flow", + "type": "float", + "description": "Enterprise value-to-free cash flow ratio", + "default": null, + "optional": true + }, + { + "name": "earnings_yield", + "type": "float", + "description": "Earnings yield", + "default": null, + "optional": true + }, + { + "name": "free_cash_flow_yield", + "type": "float", + "description": "Free cash flow yield", + "default": null, + "optional": true + }, + { + "name": "debt_to_equity", + "type": "float", + "description": "Debt-to-equity ratio", + "default": null, + "optional": true + }, + { + "name": "debt_to_assets", + "type": "float", + "description": "Debt-to-assets ratio", + "default": null, + "optional": true + }, + { + "name": "net_debt_to_ebitda", + "type": "float", + "description": "Net debt-to-EBITDA ratio", + "default": null, + "optional": true + }, + { + "name": "current_ratio", + "type": "float", + "description": "Current ratio", + "default": null, + "optional": true + }, + { + "name": "interest_coverage", + "type": "float", + "description": "Interest coverage", + "default": null, + "optional": true + }, + { + "name": "income_quality", + "type": "float", + "description": "Income quality", + "default": null, + "optional": true + }, + { + "name": "dividend_yield", + "type": "float", + "description": "Dividend yield, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "payout_ratio", + "type": "float", + "description": "Payout ratio", + "default": null, + "optional": true + }, + { + "name": "sales_general_and_administrative_to_revenue", + "type": "float", + "description": "Sales general and administrative expenses-to-revenue ratio", + "default": null, + "optional": true + }, + { + "name": "research_and_development_to_revenue", + "type": "float", + "description": "Research and development expenses-to-revenue ratio", + "default": null, + "optional": true + }, + { + "name": "intangibles_to_total_assets", + "type": "float", + "description": "Intangibles-to-total assets ratio", + "default": null, + "optional": true + }, + { + "name": "capex_to_operating_cash_flow", + "type": "float", + "description": "Capital expenditures-to-operating cash flow ratio", + "default": null, + "optional": true + }, + { + "name": "capex_to_revenue", + "type": "float", + "description": "Capital expenditures-to-revenue ratio", + "default": null, + "optional": true + }, + { + "name": "capex_to_depreciation", + "type": "float", + "description": "Capital expenditures-to-depreciation ratio", + "default": null, + "optional": true + }, + { + "name": "stock_based_compensation_to_revenue", + "type": "float", + "description": "Stock-based compensation-to-revenue ratio", + "default": null, + "optional": true + }, + { + "name": "graham_number", + "type": "float", + "description": "Graham number", + "default": null, + "optional": true + }, + { + "name": "roic", + "type": "float", + "description": "Return on invested capital", + "default": null, + "optional": true + }, + { + "name": "return_on_tangible_assets", + "type": "float", + "description": "Return on tangible assets", + "default": null, + "optional": true + }, + { + "name": "graham_net_net", + "type": "float", + "description": "Graham net-net working capital", + "default": null, + "optional": true + }, + { + "name": "working_capital", + "type": "float", + "description": "Working capital", + "default": null, + "optional": true + }, + { + "name": "tangible_asset_value", + "type": "float", + "description": "Tangible asset value", + "default": null, + "optional": true + }, + { + "name": "net_current_asset_value", + "type": "float", + "description": "Net current asset value", + "default": null, + "optional": true + }, + { + "name": "invested_capital", + "type": "float", + "description": "Invested capital", + "default": null, + "optional": true + }, + { + "name": "average_receivables", + "type": "float", + "description": "Average receivables", + "default": null, + "optional": true + }, + { + "name": "average_payables", + "type": "float", + "description": "Average payables", + "default": null, + "optional": true + }, + { + "name": "average_inventory", + "type": "float", + "description": "Average inventory", + "default": null, + "optional": true + }, + { + "name": "days_sales_outstanding", + "type": "float", + "description": "Days sales outstanding", + "default": null, + "optional": true + }, + { + "name": "days_payables_outstanding", + "type": "float", + "description": "Days payables outstanding", + "default": null, + "optional": true + }, + { + "name": "days_of_inventory_on_hand", + "type": "float", + "description": "Days of inventory on hand", + "default": null, + "optional": true + }, + { + "name": "receivables_turnover", + "type": "float", + "description": "Receivables turnover", + "default": null, + "optional": true + }, + { + "name": "payables_turnover", + "type": "float", + "description": "Payables turnover", + "default": null, + "optional": true + }, + { + "name": "inventory_turnover", + "type": "float", + "description": "Inventory turnover", + "default": null, + "optional": true + }, + { + "name": "roe", + "type": "float", + "description": "Return on equity", + "default": null, + "optional": true + }, + { + "name": "capex_per_share", + "type": "float", + "description": "Capital expenditures per share", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "price_to_book", + "type": "float", + "description": "Price to book ratio.", + "default": null, + "optional": true + }, + { + "name": "price_to_tangible_book", + "type": "float", + "description": "Price to tangible book ratio.", + "default": null, + "optional": true + }, + { + "name": "price_to_revenue", + "type": "float", + "description": "Price to revenue ratio.", + "default": null, + "optional": true + }, + { + "name": "quick_ratio", + "type": "float", + "description": "Quick ratio.", + "default": null, + "optional": true + }, + { + "name": "gross_margin", + "type": "float", + "description": "Gross margin, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "ebit_margin", + "type": "float", + "description": "EBIT margin, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "profit_margin", + "type": "float", + "description": "Profit margin, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "eps", + "type": "float", + "description": "Basic earnings per share.", + "default": null, + "optional": true + }, + { + "name": "eps_growth", + "type": "float", + "description": "EPS growth, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "revenue_growth", + "type": "float", + "description": "Revenue growth, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "ebitda_growth", + "type": "float", + "description": "EBITDA growth, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "ebit_growth", + "type": "float", + "description": "EBIT growth, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "net_income_growth", + "type": "float", + "description": "Net income growth, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "free_cash_flow_to_firm_growth", + "type": "float", + "description": "Free cash flow to firm growth, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "invested_capital_growth", + "type": "float", + "description": "Invested capital growth, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "return_on_assets", + "type": "float", + "description": "Return on assets, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "return_on_equity", + "type": "float", + "description": "Return on equity, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "return_on_invested_capital", + "type": "float", + "description": "Return on invested capital, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "ebitda", + "type": "int", + "description": "Earnings before interest, taxes, depreciation, and amortization.", + "default": null, + "optional": true + }, + { + "name": "ebit", + "type": "int", + "description": "Earnings before interest and taxes.", + "default": null, + "optional": true + }, + { + "name": "long_term_debt", + "type": "int", + "description": "Long-term debt.", + "default": null, + "optional": true + }, + { + "name": "total_debt", + "type": "int", + "description": "Total debt.", + "default": null, + "optional": true + }, + { + "name": "total_capital", + "type": "int", + "description": "The sum of long-term debt and total shareholder equity.", + "default": null, + "optional": true + }, + { + "name": "enterprise_value", + "type": "int", + "description": "Enterprise value.", + "default": null, + "optional": true + }, + { + "name": "free_cash_flow_to_firm", + "type": "int", + "description": "Free cash flow to firm.", + "default": null, + "optional": true + }, + { + "name": "altman_z_score", + "type": "float", + "description": "Altman Z-score.", + "default": null, + "optional": true + }, + { + "name": "beta", + "type": "float", + "description": "Beta relative to the broad market (rolling three-year).", + "default": null, + "optional": true + }, + { + "name": "dividend_yield", + "type": "float", + "description": "Dividend yield, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "earnings_yield", + "type": "float", + "description": "Earnings yield, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "last_price", + "type": "float", + "description": "Last price of the stock.", + "default": null, + "optional": true + }, + { + "name": "year_high", + "type": "float", + "description": "52 week high", + "default": null, + "optional": true + }, + { + "name": "year_low", + "type": "float", + "description": "52 week low", + "default": null, + "optional": true + }, + { + "name": "volume_avg", + "type": "int", + "description": "Average daily volume.", + "default": null, + "optional": true + }, + { + "name": "short_interest", + "type": "int", + "description": "Number of shares reported as sold short.", + "default": null, + "optional": true + }, + { + "name": "shares_outstanding", + "type": "int", + "description": "Weighted average shares outstanding (TTM).", + "default": null, + "optional": true + }, + { + "name": "days_to_cover", + "type": "float", + "description": "Days to cover short interest, based on average daily volume.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "forward_pe", + "type": "float", + "description": "Forward price-to-earnings ratio.", + "default": null, + "optional": true + }, + { + "name": "peg_ratio", + "type": "float", + "description": "PEG ratio (5-year expected).", + "default": null, + "optional": true + }, + { + "name": "peg_ratio_ttm", + "type": "float", + "description": "PEG ratio (TTM).", + "default": null, + "optional": true + }, + { + "name": "eps_ttm", + "type": "float", + "description": "Earnings per share (TTM).", + "default": null, + "optional": true + }, + { + "name": "eps_forward", + "type": "float", + "description": "Forward earnings per share.", + "default": null, + "optional": true + }, + { + "name": "enterprise_to_ebitda", + "type": "float", + "description": "Enterprise value to EBITDA ratio.", + "default": null, + "optional": true + }, + { + "name": "earnings_growth", + "type": "float", + "description": "Earnings growth (Year Over Year), as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "earnings_growth_quarterly", + "type": "float", + "description": "Quarterly earnings growth (Year Over Year), as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "revenue_per_share", + "type": "float", + "description": "Revenue per share (TTM).", + "default": null, + "optional": true + }, + { + "name": "revenue_growth", + "type": "float", + "description": "Revenue growth (Year Over Year), as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "enterprise_to_revenue", + "type": "float", + "description": "Enterprise value to revenue ratio.", + "default": null, + "optional": true + }, + { + "name": "cash_per_share", + "type": "float", + "description": "Cash per share.", + "default": null, + "optional": true + }, + { + "name": "quick_ratio", + "type": "float", + "description": "Quick ratio.", + "default": null, + "optional": true + }, + { + "name": "current_ratio", + "type": "float", + "description": "Current ratio.", + "default": null, + "optional": true + }, + { + "name": "debt_to_equity", + "type": "float", + "description": "Debt-to-equity ratio.", + "default": null, + "optional": true + }, + { + "name": "gross_margin", + "type": "float", + "description": "Gross margin, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "operating_margin", + "type": "float", + "description": "Operating margin, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "ebitda_margin", + "type": "float", + "description": "EBITDA margin, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "profit_margin", + "type": "float", + "description": "Profit margin, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "return_on_assets", + "type": "float", + "description": "Return on assets, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "return_on_equity", + "type": "float", + "description": "Return on equity, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "dividend_yield", + "type": "float", + "description": "Dividend yield, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "dividend_yield_5y_avg", + "type": "float", + "description": "5-year average dividend yield, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "payout_ratio", + "type": "float", + "description": "Payout ratio.", + "default": null, + "optional": true + }, + { + "name": "book_value", + "type": "float", + "description": "Book value per share.", + "default": null, + "optional": true + }, + { + "name": "price_to_book", + "type": "float", + "description": "Price-to-book ratio.", + "default": null, + "optional": true + }, + { + "name": "enterprise_value", + "type": "int", + "description": "Enterprise value.", + "default": null, + "optional": true + }, + { + "name": "overall_risk", + "type": "float", + "description": "Overall risk score.", + "default": null, + "optional": true + }, + { + "name": "audit_risk", + "type": "float", + "description": "Audit risk score.", + "default": null, + "optional": true + }, + { + "name": "board_risk", + "type": "float", + "description": "Board risk score.", + "default": null, + "optional": true + }, + { + "name": "compensation_risk", + "type": "float", + "description": "Compensation risk score.", + "default": null, + "optional": true + }, + { + "name": "shareholder_rights_risk", + "type": "float", + "description": "Shareholder rights risk score.", + "default": null, + "optional": true + }, + { + "name": "beta", + "type": "float", + "description": "Beta relative to the broad market (5-year monthly).", + "default": null, + "optional": true + }, + { + "name": "price_return_1y", + "type": "float", + "description": "One-year price return, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency in which the data is presented.", + "default": null, + "optional": true + } + ] + }, + "model": "KeyMetrics" + }, + "/equity/fundamental/management": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get executive management team data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.management(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[KeyExecutives]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "title", + "type": "str", + "description": "Designation of the key executive.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the key executive.", + "default": "", + "optional": false + }, + { + "name": "pay", + "type": "int", + "description": "Pay of the key executive.", + "default": null, + "optional": true + }, + { + "name": "currency_pay", + "type": "str", + "description": "Currency of the pay.", + "default": null, + "optional": true + }, + { + "name": "gender", + "type": "str", + "description": "Gender of the key executive.", + "default": null, + "optional": true + }, + { + "name": "year_born", + "type": "int", + "description": "Birth year of the key executive.", + "default": null, + "optional": true + }, + { + "name": "title_since", + "type": "int", + "description": "Date the tile was held since.", + "default": null, + "optional": true + } + ], + "fmp": [], + "yfinance": [ + { + "name": "exercised_value", + "type": "int", + "description": "Value of shares exercised.", + "default": null, + "optional": true + }, + { + "name": "unexercised_value", + "type": "int", + "description": "Value of shares not exercised.", + "default": null, + "optional": true + } + ] + }, + "model": "KeyExecutives" + }, + "/equity/fundamental/management_compensation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get executive management team compensation for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.management_compensation(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "year", + "type": "int", + "description": "Year of the compensation.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[ExecutiveCompensation]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true + }, + { + "name": "company_name", + "type": "str", + "description": "The name of the company.", + "default": null, + "optional": true + }, + { + "name": "industry", + "type": "str", + "description": "The industry of the company.", + "default": null, + "optional": true + }, + { + "name": "year", + "type": "int", + "description": "Year of the compensation.", + "default": null, + "optional": true + }, + { + "name": "name_and_position", + "type": "str", + "description": "Name and position.", + "default": null, + "optional": true + }, + { + "name": "salary", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Salary.", + "default": null, + "optional": true + }, + { + "name": "bonus", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Bonus payments.", + "default": null, + "optional": true + }, + { + "name": "stock_award", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Stock awards.", + "default": null, + "optional": true + }, + { + "name": "incentive_plan_compensation", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Incentive plan compensation.", + "default": null, + "optional": true + }, + { + "name": "all_other_compensation", + "type": "Annotated[float, Ge(ge=0)]", + "description": "All other compensation.", + "default": null, + "optional": true + }, + { + "name": "total", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Total compensation.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "filing_date", + "type": "date", + "description": "Date of the filing.", + "default": null, + "optional": true + }, + { + "name": "accepted_date", + "type": "datetime", + "description": "Date the filing was accepted.", + "default": null, + "optional": true + }, + { + "name": "url", + "type": "str", + "description": "URL to the filing data.", + "default": null, + "optional": true + } + ] + }, + "model": "ExecutiveCompensation" + }, + "/equity/fundamental/overview": { + "deprecated": { + "flag": true, + "message": "This endpoint is deprecated; use `/equity/profile` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.3." + }, + "description": "Get company general business and stock data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.overview(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CompanyOverview]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "price", + "type": "float", + "description": "Price of the company.", + "default": null, + "optional": true + }, + { + "name": "beta", + "type": "float", + "description": "Beta of the company.", + "default": null, + "optional": true + }, + { + "name": "vol_avg", + "type": "int", + "description": "Volume average of the company.", + "default": null, + "optional": true + }, + { + "name": "mkt_cap", + "type": "int", + "description": "Market capitalization of the company.", + "default": null, + "optional": true + }, + { + "name": "last_div", + "type": "float", + "description": "Last dividend of the company.", + "default": null, + "optional": true + }, + { + "name": "range", + "type": "str", + "description": "Range of the company.", + "default": null, + "optional": true + }, + { + "name": "changes", + "type": "float", + "description": "Changes of the company.", + "default": null, + "optional": true + }, + { + "name": "company_name", + "type": "str", + "description": "Company name of the company.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency of the company.", + "default": null, + "optional": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true + }, + { + "name": "isin", + "type": "str", + "description": "ISIN of the company.", + "default": null, + "optional": true + }, + { + "name": "cusip", + "type": "str", + "description": "CUSIP of the company.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "Exchange of the company.", + "default": null, + "optional": true + }, + { + "name": "exchange_short_name", + "type": "str", + "description": "Exchange short name of the company.", + "default": null, + "optional": true + }, + { + "name": "industry", + "type": "str", + "description": "Industry of the company.", + "default": null, + "optional": true + }, + { + "name": "website", + "type": "str", + "description": "Website of the company.", + "default": null, + "optional": true + }, + { + "name": "description", + "type": "str", + "description": "Description of the company.", + "default": null, + "optional": true + }, + { + "name": "ceo", + "type": "str", + "description": "CEO of the company.", + "default": null, + "optional": true + }, + { + "name": "sector", + "type": "str", + "description": "Sector of the company.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Country of the company.", + "default": null, + "optional": true + }, + { + "name": "full_time_employees", + "type": "str", + "description": "Full time employees of the company.", + "default": null, + "optional": true + }, + { + "name": "phone", + "type": "str", + "description": "Phone of the company.", + "default": null, + "optional": true + }, + { + "name": "address", + "type": "str", + "description": "Address of the company.", + "default": null, + "optional": true + }, + { + "name": "city", + "type": "str", + "description": "City of the company.", + "default": null, + "optional": true + }, + { + "name": "state", + "type": "str", + "description": "State of the company.", + "default": null, + "optional": true + }, + { + "name": "zip", + "type": "str", + "description": "Zip of the company.", + "default": null, + "optional": true + }, + { + "name": "dcf_diff", + "type": "float", + "description": "Discounted cash flow difference of the company.", + "default": null, + "optional": true + }, + { + "name": "dcf", + "type": "float", + "description": "Discounted cash flow of the company.", + "default": null, + "optional": true + }, + { + "name": "image", + "type": "str", + "description": "Image of the company.", + "default": null, + "optional": true + }, + { + "name": "ipo_date", + "type": "date", + "description": "IPO date of the company.", + "default": null, + "optional": true + }, + { + "name": "default_image", + "type": "bool", + "description": "If the image is the default image.", + "default": "", + "optional": false + }, + { + "name": "is_etf", + "type": "bool", + "description": "If the company is an ETF.", + "default": "", + "optional": false + }, + { + "name": "is_actively_trading", + "type": "bool", + "description": "If the company is actively trading.", + "default": "", + "optional": false + }, + { + "name": "is_adr", + "type": "bool", + "description": "If the company is an ADR.", + "default": "", + "optional": false + }, + { + "name": "is_fund", + "type": "bool", + "description": "If the company is a fund.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "CompanyOverview" + }, + "/equity/fundamental/ratios": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get an extensive set of financial and accounting ratios for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.ratios(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.ratios(symbol='AAPL', period='annual', limit=12, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 12, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + } + ], + "intrinio": [ + { + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[FinancialRatios]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "str", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "fiscal_period", + "type": "str", + "description": "Period of the financial ratios.", + "default": "", + "optional": false + }, + { + "name": "fiscal_year", + "type": "int", + "description": "Fiscal year.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "current_ratio", + "type": "float", + "description": "Current ratio.", + "default": null, + "optional": true + }, + { + "name": "quick_ratio", + "type": "float", + "description": "Quick ratio.", + "default": null, + "optional": true + }, + { + "name": "cash_ratio", + "type": "float", + "description": "Cash ratio.", + "default": null, + "optional": true + }, + { + "name": "days_of_sales_outstanding", + "type": "float", + "description": "Days of sales outstanding.", + "default": null, + "optional": true + }, + { + "name": "days_of_inventory_outstanding", + "type": "float", + "description": "Days of inventory outstanding.", + "default": null, + "optional": true + }, + { + "name": "operating_cycle", + "type": "float", + "description": "Operating cycle.", + "default": null, + "optional": true + }, + { + "name": "days_of_payables_outstanding", + "type": "float", + "description": "Days of payables outstanding.", + "default": null, + "optional": true + }, + { + "name": "cash_conversion_cycle", + "type": "float", + "description": "Cash conversion cycle.", + "default": null, + "optional": true + }, + { + "name": "gross_profit_margin", + "type": "float", + "description": "Gross profit margin.", + "default": null, + "optional": true + }, + { + "name": "operating_profit_margin", + "type": "float", + "description": "Operating profit margin.", + "default": null, + "optional": true + }, + { + "name": "pretax_profit_margin", + "type": "float", + "description": "Pretax profit margin.", + "default": null, + "optional": true + }, + { + "name": "net_profit_margin", + "type": "float", + "description": "Net profit margin.", + "default": null, + "optional": true + }, + { + "name": "effective_tax_rate", + "type": "float", + "description": "Effective tax rate.", + "default": null, + "optional": true + }, + { + "name": "return_on_assets", + "type": "float", + "description": "Return on assets.", + "default": null, + "optional": true + }, + { + "name": "return_on_equity", + "type": "float", + "description": "Return on equity.", + "default": null, + "optional": true + }, + { + "name": "return_on_capital_employed", + "type": "float", + "description": "Return on capital employed.", + "default": null, + "optional": true + }, + { + "name": "net_income_per_ebt", + "type": "float", + "description": "Net income per EBT.", + "default": null, + "optional": true + }, + { + "name": "ebt_per_ebit", + "type": "float", + "description": "EBT per EBIT.", + "default": null, + "optional": true + }, + { + "name": "ebit_per_revenue", + "type": "float", + "description": "EBIT per revenue.", + "default": null, + "optional": true + }, + { + "name": "debt_ratio", + "type": "float", + "description": "Debt ratio.", + "default": null, + "optional": true + }, + { + "name": "debt_equity_ratio", + "type": "float", + "description": "Debt equity ratio.", + "default": null, + "optional": true + }, + { + "name": "long_term_debt_to_capitalization", + "type": "float", + "description": "Long term debt to capitalization.", + "default": null, + "optional": true + }, + { + "name": "total_debt_to_capitalization", + "type": "float", + "description": "Total debt to capitalization.", + "default": null, + "optional": true + }, + { + "name": "interest_coverage", + "type": "float", + "description": "Interest coverage.", + "default": null, + "optional": true + }, + { + "name": "cash_flow_to_debt_ratio", + "type": "float", + "description": "Cash flow to debt ratio.", + "default": null, + "optional": true + }, + { + "name": "company_equity_multiplier", + "type": "float", + "description": "Company equity multiplier.", + "default": null, + "optional": true + }, + { + "name": "receivables_turnover", + "type": "float", + "description": "Receivables turnover.", + "default": null, + "optional": true + }, + { + "name": "payables_turnover", + "type": "float", + "description": "Payables turnover.", + "default": null, + "optional": true + }, + { + "name": "inventory_turnover", + "type": "float", + "description": "Inventory turnover.", + "default": null, + "optional": true + }, + { + "name": "fixed_asset_turnover", + "type": "float", + "description": "Fixed asset turnover.", + "default": null, + "optional": true + }, + { + "name": "asset_turnover", + "type": "float", + "description": "Asset turnover.", + "default": null, + "optional": true + }, + { + "name": "operating_cash_flow_per_share", + "type": "float", + "description": "Operating cash flow per share.", + "default": null, + "optional": true + }, + { + "name": "free_cash_flow_per_share", + "type": "float", + "description": "Free cash flow per share.", + "default": null, + "optional": true + }, + { + "name": "cash_per_share", + "type": "float", + "description": "Cash per share.", + "default": null, + "optional": true + }, + { + "name": "payout_ratio", + "type": "float", + "description": "Payout ratio.", + "default": null, + "optional": true + }, + { + "name": "operating_cash_flow_sales_ratio", + "type": "float", + "description": "Operating cash flow sales ratio.", + "default": null, + "optional": true + }, + { + "name": "free_cash_flow_operating_cash_flow_ratio", + "type": "float", + "description": "Free cash flow operating cash flow ratio.", + "default": null, + "optional": true + }, + { + "name": "cash_flow_coverage_ratios", + "type": "float", + "description": "Cash flow coverage ratios.", + "default": null, + "optional": true + }, + { + "name": "short_term_coverage_ratios", + "type": "float", + "description": "Short term coverage ratios.", + "default": null, + "optional": true + }, + { + "name": "capital_expenditure_coverage_ratio", + "type": "float", + "description": "Capital expenditure coverage ratio.", + "default": null, + "optional": true + }, + { + "name": "dividend_paid_and_capex_coverage_ratio", + "type": "float", + "description": "Dividend paid and capex coverage ratio.", + "default": null, + "optional": true + }, + { + "name": "dividend_payout_ratio", + "type": "float", + "description": "Dividend payout ratio.", + "default": null, + "optional": true + }, + { + "name": "price_book_value_ratio", + "type": "float", + "description": "Price book value ratio.", + "default": null, + "optional": true + }, + { + "name": "price_to_book_ratio", + "type": "float", + "description": "Price to book ratio.", + "default": null, + "optional": true + }, + { + "name": "price_to_sales_ratio", + "type": "float", + "description": "Price to sales ratio.", + "default": null, + "optional": true + }, + { + "name": "price_earnings_ratio", + "type": "float", + "description": "Price earnings ratio.", + "default": null, + "optional": true + }, + { + "name": "price_to_free_cash_flows_ratio", + "type": "float", + "description": "Price to free cash flows ratio.", + "default": null, + "optional": true + }, + { + "name": "price_to_operating_cash_flows_ratio", + "type": "float", + "description": "Price to operating cash flows ratio.", + "default": null, + "optional": true + }, + { + "name": "price_cash_flow_ratio", + "type": "float", + "description": "Price cash flow ratio.", + "default": null, + "optional": true + }, + { + "name": "price_earnings_to_growth_ratio", + "type": "float", + "description": "Price earnings to growth ratio.", + "default": null, + "optional": true + }, + { + "name": "price_sales_ratio", + "type": "float", + "description": "Price sales ratio.", + "default": null, + "optional": true + }, + { + "name": "dividend_yield", + "type": "float", + "description": "Dividend yield.", + "default": null, + "optional": true + }, + { + "name": "dividend_yield_percentage", + "type": "float", + "description": "Dividend yield percentage.", + "default": null, + "optional": true + }, + { + "name": "dividend_per_share", + "type": "float", + "description": "Dividend per share.", + "default": null, + "optional": true + }, + { + "name": "enterprise_value_multiple", + "type": "float", + "description": "Enterprise value multiple.", + "default": null, + "optional": true + }, + { + "name": "price_fair_value", + "type": "float", + "description": "Price fair value.", + "default": null, + "optional": true + } + ], + "intrinio": [] + }, + "model": "FinancialRatios" + }, + "/equity/fundamental/revenue_per_geography": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the revenue geographic breakdown for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.revenue_per_geography(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.revenue_per_geography(symbol='AAPL', period='annual', structure='flat', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "structure", + "type": "Literal['hierarchical', 'flat']", + "description": "Structure of the returned data.", + "default": "flat", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[RevenueGeographic]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the reporting period.", + "default": null, + "optional": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the reporting period.", + "default": null, + "optional": true + }, + { + "name": "filing_date", + "type": "date", + "description": "The filing date of the report.", + "default": null, + "optional": true + }, + { + "name": "geographic_segment", + "type": "int", + "description": "Dictionary of the revenue by geographic segment.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "RevenueGeographic" + }, + "/equity/fundamental/revenue_per_segment": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the revenue breakdown by business segment for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.revenue_per_segment(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.revenue_per_segment(symbol='AAPL', period='annual', structure='flat', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "structure", + "type": "Literal['hierarchical', 'flat']", + "description": "Structure of the returned data.", + "default": "flat", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[RevenueBusinessLine]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the reporting period.", + "default": null, + "optional": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the reporting period.", + "default": null, + "optional": true + }, + { + "name": "filing_date", + "type": "date", + "description": "The filing date of the report.", + "default": null, + "optional": true + }, + { + "name": "business_line", + "type": "int", + "description": "Dictionary containing the revenue of the business line.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "RevenueBusinessLine" + }, + "/equity/fundamental/filings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more. SEC\nfilings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114,\nForeign Investment Disclosures and others. The annual 10-K report is required to be\nfiled annually and includes the company's financial statements, management discussion and analysis,\nand audited financial statements.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.filings(provider='fmp')\nobb.equity.fundamental.filings(limit=100, provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": true + }, + { + "name": "form_type", + "type": "str", + "description": "Filter by form type. Check the data provider for available types.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'sec']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [], + "intrinio": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "thea_enabled", + "type": "bool", + "description": "Return filings that have been read by Intrinio's Thea NLP.", + "default": null, + "optional": true + } + ], + "sec": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": true + }, + { + "name": "form_type", + "type": "Literal['1', '1-A', '1-A POS', '1-A-W', '1-E', '1-E AD', '1-K', '1-SA', '1-U', '1-Z', '1-Z-W', '10-12B', '10-12G', '10-D', '10-K', '10-KT', '10-Q', '10-QT', '11-K', '11-KT', '13F-HR', '13F-NT', '13FCONP', '144', '15-12B', '15-12G', '15-15D', '15F-12B', '15F-12G', '15F-15D', '18-12B', '18-K', '19B-4E', '2-A', '2-AF', '2-E', '20-F', '20FR12B', '20FR12G', '24F-2NT', '25', '25-NSE', '253G1', '253G2', '253G3', '253G4', '3', '305B2', '34-12H', '4', '40-17F1', '40-17F2', '40-17G', '40-17GCS', '40-202A', '40-203A', '40-206A', '40-24B2', '40-33', '40-6B', '40-8B25', '40-8F-2', '40-APP', '40-F', '40-OIP', '40FR12B', '40FR12G', '424A', '424B1', '424B2', '424B3', '424B4', '424B5', '424B7', '424B8', '424H', '425', '485APOS', '485BPOS', '485BXT', '486APOS', '486BPOS', '486BXT', '487', '497', '497AD', '497H2', '497J', '497K', '497VPI', '497VPU', '5', '6-K', '6B NTC', '6B ORDR', '8-A12B', '8-A12G', '8-K', '8-K12B', '8-K12G3', '8-K15D5', '8-M', '8F-2 NTC', '8F-2 ORDR', '9-M', 'ABS-15G', 'ABS-EE', 'ADN-MTL', 'ADV-E', 'ADV-H-C', 'ADV-H-T', 'ADV-NR', 'ANNLRPT', 'APP NTC', 'APP ORDR', 'APP WD', 'APP WDG', 'ARS', 'ATS-N', 'ATS-N-C', 'ATS-N/UA', 'AW', 'AW WD', 'C', 'C-AR', 'C-AR-W', 'C-TR', 'C-TR-W', 'C-U', 'C-U-W', 'C-W', 'CB', 'CERT', 'CERTARCA', 'CERTBATS', 'CERTCBO', 'CERTNAS', 'CERTNYS', 'CERTPAC', 'CFPORTAL', 'CFPORTAL-W', 'CORRESP', 'CT ORDER', 'D', 'DEF 14A', 'DEF 14C', 'DEFA14A', 'DEFA14C', 'DEFC14A', 'DEFC14C', 'DEFM14A', 'DEFM14C', 'DEFN14A', 'DEFR14A', 'DEFR14C', 'DEL AM', 'DFAN14A', 'DFRN14A', 'DOS', 'DOSLTR', 'DRS', 'DRSLTR', 'DSTRBRPT', 'EFFECT', 'F-1', 'F-10', 'F-10EF', 'F-10POS', 'F-1MEF', 'F-3', 'F-3ASR', 'F-3D', 'F-3DPOS', 'F-3MEF', 'F-4', 'F-4 POS', 'F-4MEF', 'F-6', 'F-6 POS', 'F-6EF', 'F-7', 'F-7 POS', 'F-8', 'F-8 POS', 'F-80', 'F-80POS', 'F-9', 'F-9 POS', 'F-N', 'F-X', 'FOCUSN', 'FWP', 'G-405', 'G-405N', 'G-FIN', 'G-FINW', 'IRANNOTICE', 'MA', 'MA-A', 'MA-I', 'MA-W', 'MSD', 'MSDCO', 'MSDW', 'N-1', 'N-14', 'N-14 8C', 'N-14MEF', 'N-18F1', 'N-1A', 'N-2', 'N-2 POSASR', 'N-23C-2', 'N-23C3A', 'N-23C3B', 'N-23C3C', 'N-2ASR', 'N-2MEF', 'N-30B-2', 'N-30D', 'N-4', 'N-5', 'N-54A', 'N-54C', 'N-6', 'N-6F', 'N-8A', 'N-8B-2', 'N-8F', 'N-8F NTC', 'N-8F ORDR', 'N-CEN', 'N-CR', 'N-CSR', 'N-CSRS', 'N-MFP', 'N-MFP1', 'N-MFP2', 'N-PX', 'N-Q', 'N-VP', 'N-VPFS', 'NO ACT', 'NPORT-EX', 'NPORT-NP', 'NPORT-P', 'NRSRO-CE', 'NRSRO-UPD', 'NSAR-A', 'NSAR-AT', 'NSAR-B', 'NSAR-BT', 'NSAR-U', 'NT 10-D', 'NT 10-K', 'NT 10-Q', 'NT 11-K', 'NT 20-F', 'NT N-CEN', 'NT N-MFP', 'NT N-MFP1', 'NT N-MFP2', 'NT NPORT-EX', 'NT NPORT-P', 'NT-NCEN', 'NT-NCSR', 'NT-NSAR', 'NTFNCEN', 'NTFNCSR', 'NTFNSAR', 'NTN 10D', 'NTN 10K', 'NTN 10Q', 'NTN 20F', 'OIP NTC', 'OIP ORDR', 'POS 8C', 'POS AM', 'POS AMI', 'POS EX', 'POS462B', 'POS462C', 'POSASR', 'PRE 14A', 'PRE 14C', 'PREC14A', 'PREC14C', 'PREM14A', 'PREM14C', 'PREN14A', 'PRER14A', 'PRER14C', 'PRRN14A', 'PX14A6G', 'PX14A6N', 'QRTLYRPT', 'QUALIF', 'REG-NR', 'REVOKED', 'RW', 'RW WD', 'S-1', 'S-11', 'S-11MEF', 'S-1MEF', 'S-20', 'S-3', 'S-3ASR', 'S-3D', 'S-3DPOS', 'S-3MEF', 'S-4', 'S-4 POS', 'S-4EF', 'S-4MEF', 'S-6', 'S-8', 'S-8 POS', 'S-B', 'S-BMEF', 'SBSE', 'SBSE-A', 'SBSE-BD', 'SBSE-C', 'SBSE-W', 'SC 13D', 'SC 13E1', 'SC 13E3', 'SC 13G', 'SC 14D9', 'SC 14F1', 'SC 14N', 'SC TO-C', 'SC TO-I', 'SC TO-T', 'SC13E4F', 'SC14D1F', 'SC14D9C', 'SC14D9F', 'SD', 'SDR', 'SE', 'SEC ACTION', 'SEC STAFF ACTION', 'SEC STAFF LETTER', 'SF-1', 'SF-3', 'SL', 'SP 15D2', 'STOP ORDER', 'SUPPL', 'T-3', 'TA-1', 'TA-2', 'TA-W', 'TACO', 'TH', 'TTW', 'UNDER', 'UPLOAD', 'WDL-REQ', 'X-17A-5']", + "description": "Type of the SEC filing form.", + "default": null, + "optional": true + }, + { + "name": "cik", + "type": "Union[int, str]", + "description": "Lookup filings by Central Index Key (CIK) instead of by symbol.", + "default": null, + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache. If True, cache will store for one day.", + "default": true, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CompanyFilings]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'sec']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "filing_date", + "type": "date", + "description": "The date of the filing.", + "default": "", + "optional": false + }, + { + "name": "accepted_date", + "type": "datetime", + "description": "Accepted date of the filing.", + "default": null, + "optional": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true + }, + { + "name": "report_type", + "type": "str", + "description": "Type of filing.", + "default": null, + "optional": true + }, + { + "name": "filing_url", + "type": "str", + "description": "URL to the filing page.", + "default": null, + "optional": true + }, + { + "name": "report_url", + "type": "str", + "description": "URL to the actual report.", + "default": "", + "optional": false + } + ], + "fmp": [], + "intrinio": [ + { + "name": "id", + "type": "str", + "description": "Intrinio ID of the filing.", + "default": "", + "optional": false + }, + { + "name": "period_end_date", + "type": "date", + "description": "Ending date of the fiscal period for the filing.", + "default": null, + "optional": true + }, + { + "name": "sec_unique_id", + "type": "str", + "description": "SEC unique ID of the filing.", + "default": "", + "optional": false + }, + { + "name": "instance_url", + "type": "str", + "description": "URL for the XBRL filing for the report.", + "default": null, + "optional": true + }, + { + "name": "industry_group", + "type": "str", + "description": "Industry group of the company.", + "default": "", + "optional": false + }, + { + "name": "industry_category", + "type": "str", + "description": "Industry category of the company.", + "default": "", + "optional": false + } + ], + "sec": [ + { + "name": "report_date", + "type": "date", + "description": "The date of the filing.", + "default": null, + "optional": true + }, + { + "name": "act", + "type": "Union[int, str]", + "description": "The SEC Act number.", + "default": null, + "optional": true + }, + { + "name": "items", + "type": "Union[str, float]", + "description": "The SEC Item numbers.", + "default": null, + "optional": true + }, + { + "name": "primary_doc_description", + "type": "str", + "description": "The description of the primary document.", + "default": null, + "optional": true + }, + { + "name": "primary_doc", + "type": "str", + "description": "The filename of the primary document.", + "default": null, + "optional": true + }, + { + "name": "accession_number", + "type": "Union[int, str]", + "description": "The accession number.", + "default": null, + "optional": true + }, + { + "name": "file_number", + "type": "Union[int, str]", + "description": "The file number.", + "default": null, + "optional": true + }, + { + "name": "film_number", + "type": "Union[int, str]", + "description": "The film number.", + "default": null, + "optional": true + }, + { + "name": "is_inline_xbrl", + "type": "Union[int, str]", + "description": "Whether the filing is an inline XBRL filing.", + "default": null, + "optional": true + }, + { + "name": "is_xbrl", + "type": "Union[int, str]", + "description": "Whether the filing is an XBRL filing.", + "default": null, + "optional": true + }, + { + "name": "size", + "type": "Union[int, str]", + "description": "The size of the filing.", + "default": null, + "optional": true + }, + { + "name": "complete_submission_url", + "type": "str", + "description": "The URL to the complete filing submission.", + "default": null, + "optional": true + }, + { + "name": "filing_detail_url", + "type": "str", + "description": "The URL to the filing details.", + "default": null, + "optional": true + } + ] + }, + "model": "CompanyFilings" + }, + "/equity/fundamental/historical_splits": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical stock splits for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_splits(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[HistoricalSplits]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "numerator", + "type": "float", + "description": "Numerator of the split.", + "default": null, + "optional": true + }, + { + "name": "denominator", + "type": "float", + "description": "Denominator of the split.", + "default": null, + "optional": true + }, + { + "name": "split_ratio", + "type": "str", + "description": "Split ratio.", + "default": null, + "optional": true + } + ], + "fmp": [] + }, + "model": "HistoricalSplits" + }, + "/equity/fundamental/transcript": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get earnings call transcripts for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.transcript(symbol='AAPL', year=2020, provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "year", + "type": "int", + "description": "Year of the earnings call transcript.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EarningsCallTranscript]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "quarter", + "type": "int", + "description": "Quarter of the earnings call transcript.", + "default": "", + "optional": false + }, + { + "name": "year", + "type": "int", + "description": "Year of the earnings call transcript.", + "default": "", + "optional": false + }, + { + "name": "date", + "type": "datetime", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "content", + "type": "str", + "description": "Content of the earnings call transcript.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "EarningsCallTranscript" + }, + "/equity/fundamental/trailing_dividend_yield": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the 1 year trailing dividend yield for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.trailing_dividend_yield(symbol='AAPL', provider='tiingo')\nobb.equity.fundamental.trailing_dividend_yield(symbol='AAPL', limit=252, provider='tiingo')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return. Default is 252, the number of trading days in a year.", + "default": 252, + "optional": true + }, + { + "name": "provider", + "type": "Literal['tiingo']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tiingo' if there is no default.", + "default": "tiingo", + "optional": true + } + ], + "tiingo": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[TrailingDividendYield]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['tiingo']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "trailing_dividend_yield", + "type": "float", + "description": "Trailing dividend yield.", + "default": "", + "optional": false + } + ], + "tiingo": [] + }, + "model": "TrailingDividendYield" + }, + "/equity/ownership/major_holders": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get data about major holders for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.major_holders(symbol='AAPL', provider='fmp')\nobb.equity.ownership.major_holders(symbol='AAPL', page=0, provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": null, + "optional": true + }, + { + "name": "page", + "type": "int", + "description": "Page number of the data to fetch.", + "default": 0, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityOwnership]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "cik", + "type": "int", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "", + "optional": false + }, + { + "name": "filing_date", + "type": "date", + "description": "Filing date of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "investor_name", + "type": "str", + "description": "Investor name of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "security_name", + "type": "str", + "description": "Security name of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "type_of_security", + "type": "str", + "description": "Type of security of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "security_cusip", + "type": "str", + "description": "Security cusip of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "shares_type", + "type": "str", + "description": "Shares type of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "put_call_share", + "type": "str", + "description": "Put call share of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "investment_discretion", + "type": "str", + "description": "Investment discretion of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "industry_title", + "type": "str", + "description": "Industry title of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "weight", + "type": "float", + "description": "Weight of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "last_weight", + "type": "float", + "description": "Last weight of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "change_in_weight", + "type": "float", + "description": "Change in weight of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "change_in_weight_percentage", + "type": "float", + "description": "Change in weight percentage of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "market_value", + "type": "int", + "description": "Market value of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "last_market_value", + "type": "int", + "description": "Last market value of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "change_in_market_value", + "type": "int", + "description": "Change in market value of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "change_in_market_value_percentage", + "type": "float", + "description": "Change in market value percentage of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "shares_number", + "type": "int", + "description": "Shares number of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "last_shares_number", + "type": "int", + "description": "Last shares number of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "change_in_shares_number", + "type": "float", + "description": "Change in shares number of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "change_in_shares_number_percentage", + "type": "float", + "description": "Change in shares number percentage of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "quarter_end_price", + "type": "float", + "description": "Quarter end price of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "avg_price_paid", + "type": "float", + "description": "Average price paid of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "is_new", + "type": "bool", + "description": "Is the stock ownership new.", + "default": "", + "optional": false + }, + { + "name": "is_sold_out", + "type": "bool", + "description": "Is the stock ownership sold out.", + "default": "", + "optional": false + }, + { + "name": "ownership", + "type": "float", + "description": "How much is the ownership.", + "default": "", + "optional": false + }, + { + "name": "last_ownership", + "type": "float", + "description": "Last ownership amount.", + "default": "", + "optional": false + }, + { + "name": "change_in_ownership", + "type": "float", + "description": "Change in ownership amount.", + "default": "", + "optional": false + }, + { + "name": "change_in_ownership_percentage", + "type": "float", + "description": "Change in ownership percentage.", + "default": "", + "optional": false + }, + { + "name": "holding_period", + "type": "int", + "description": "Holding period of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "first_added", + "type": "date", + "description": "First added date of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "performance", + "type": "float", + "description": "Performance of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "performance_percentage", + "type": "float", + "description": "Performance percentage of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "last_performance", + "type": "float", + "description": "Last performance of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "change_in_performance", + "type": "float", + "description": "Change in performance of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "is_counted_for_performance", + "type": "bool", + "description": "Is the stock ownership counted for performance.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "EquityOwnership" + }, + "/equity/ownership/institutional": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get data about institutional ownership for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.institutional(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "include_current_quarter", + "type": "bool", + "description": "Include current quarter data.", + "default": false, + "optional": true + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[InstitutionalOwnership]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + } + ], + "fmp": [ + { + "name": "investors_holding", + "type": "int", + "description": "Number of investors holding the stock.", + "default": "", + "optional": false + }, + { + "name": "last_investors_holding", + "type": "int", + "description": "Number of investors holding the stock in the last quarter.", + "default": "", + "optional": false + }, + { + "name": "investors_holding_change", + "type": "int", + "description": "Change in the number of investors holding the stock.", + "default": "", + "optional": false + }, + { + "name": "number_of_13f_shares", + "type": "int", + "description": "Number of 13F shares.", + "default": null, + "optional": true + }, + { + "name": "last_number_of_13f_shares", + "type": "int", + "description": "Number of 13F shares in the last quarter.", + "default": null, + "optional": true + }, + { + "name": "number_of_13f_shares_change", + "type": "int", + "description": "Change in the number of 13F shares.", + "default": null, + "optional": true + }, + { + "name": "total_invested", + "type": "float", + "description": "Total amount invested.", + "default": "", + "optional": false + }, + { + "name": "last_total_invested", + "type": "float", + "description": "Total amount invested in the last quarter.", + "default": "", + "optional": false + }, + { + "name": "total_invested_change", + "type": "float", + "description": "Change in the total amount invested.", + "default": "", + "optional": false + }, + { + "name": "ownership_percent", + "type": "float", + "description": "Ownership percent.", + "default": "", + "optional": false + }, + { + "name": "last_ownership_percent", + "type": "float", + "description": "Ownership percent in the last quarter.", + "default": "", + "optional": false + }, + { + "name": "ownership_percent_change", + "type": "float", + "description": "Change in the ownership percent.", + "default": "", + "optional": false + }, + { + "name": "new_positions", + "type": "int", + "description": "Number of new positions.", + "default": "", + "optional": false + }, + { + "name": "last_new_positions", + "type": "int", + "description": "Number of new positions in the last quarter.", + "default": "", + "optional": false + }, + { + "name": "new_positions_change", + "type": "int", + "description": "Change in the number of new positions.", + "default": "", + "optional": false + }, + { + "name": "increased_positions", + "type": "int", + "description": "Number of increased positions.", + "default": "", + "optional": false + }, + { + "name": "last_increased_positions", + "type": "int", + "description": "Number of increased positions in the last quarter.", + "default": "", + "optional": false + }, + { + "name": "increased_positions_change", + "type": "int", + "description": "Change in the number of increased positions.", + "default": "", + "optional": false + }, + { + "name": "closed_positions", + "type": "int", + "description": "Number of closed positions.", + "default": "", + "optional": false + }, + { + "name": "last_closed_positions", + "type": "int", + "description": "Number of closed positions in the last quarter.", + "default": "", + "optional": false + }, + { + "name": "closed_positions_change", + "type": "int", + "description": "Change in the number of closed positions.", + "default": "", + "optional": false + }, + { + "name": "reduced_positions", + "type": "int", + "description": "Number of reduced positions.", + "default": "", + "optional": false + }, + { + "name": "last_reduced_positions", + "type": "int", + "description": "Number of reduced positions in the last quarter.", + "default": "", + "optional": false + }, + { + "name": "reduced_positions_change", + "type": "int", + "description": "Change in the number of reduced positions.", + "default": "", + "optional": false + }, + { + "name": "total_calls", + "type": "int", + "description": "Total number of call options contracts traded for Apple Inc. on the specified date.", + "default": "", + "optional": false + }, + { + "name": "last_total_calls", + "type": "int", + "description": "Total number of call options contracts traded for Apple Inc. on the previous reporting date.", + "default": "", + "optional": false + }, + { + "name": "total_calls_change", + "type": "int", + "description": "Change in the total number of call options contracts traded between the current and previous reporting dates.", + "default": "", + "optional": false + }, + { + "name": "total_puts", + "type": "int", + "description": "Total number of put options contracts traded for Apple Inc. on the specified date.", + "default": "", + "optional": false + }, + { + "name": "last_total_puts", + "type": "int", + "description": "Total number of put options contracts traded for Apple Inc. on the previous reporting date.", + "default": "", + "optional": false + }, + { + "name": "total_puts_change", + "type": "int", + "description": "Change in the total number of put options contracts traded between the current and previous reporting dates.", + "default": "", + "optional": false + }, + { + "name": "put_call_ratio", + "type": "float", + "description": "Put-call ratio, which is the ratio of the total number of put options to call options traded on the specified date.", + "default": "", + "optional": false + }, + { + "name": "last_put_call_ratio", + "type": "float", + "description": "Put-call ratio on the previous reporting date.", + "default": "", + "optional": false + }, + { + "name": "put_call_ratio_change", + "type": "float", + "description": "Change in the put-call ratio between the current and previous reporting dates.", + "default": "", + "optional": false + } + ] + }, + "model": "InstitutionalOwnership" + }, + "/equity/ownership/insider_trading": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get data about trading by a company's management team and board of directors.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.insider_trading(symbol='AAPL', provider='fmp')\nobb.equity.ownership.insider_trading(symbol='AAPL', limit=500, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 500, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "transaction_type", + "type": "Literal[None, 'award', 'conversion', 'return', 'expire_short', 'in_kind', 'gift', 'expire_long', 'discretionary', 'other', 'small', 'exempt', 'otm', 'purchase', 'sale', 'tender', 'will', 'itm', 'trust']", + "description": "Type of the transaction.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "", + "optional": false + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "", + "optional": false + }, + { + "name": "ownership_type", + "type": "Literal['D', 'I']", + "description": "Type of ownership.", + "default": null, + "optional": true + }, + { + "name": "sort_by", + "type": "Literal['filing_date', 'updated_on']", + "description": "Field to sort by.", + "default": "updated_on", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[InsiderTrading]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "company_cik", + "type": "Union[int, str]", + "description": "CIK number of the company.", + "default": null, + "optional": true + }, + { + "name": "filing_date", + "type": "Union[date, datetime]", + "description": "Filing date of the trade.", + "default": null, + "optional": true + }, + { + "name": "transaction_date", + "type": "date", + "description": "Date of the transaction.", + "default": null, + "optional": true + }, + { + "name": "owner_cik", + "type": "Union[int, str]", + "description": "Reporting individual's CIK.", + "default": null, + "optional": true + }, + { + "name": "owner_name", + "type": "str", + "description": "Name of the reporting individual.", + "default": null, + "optional": true + }, + { + "name": "owner_title", + "type": "str", + "description": "The title held by the reporting individual.", + "default": null, + "optional": true + }, + { + "name": "transaction_type", + "type": "str", + "description": "Type of transaction being reported.", + "default": null, + "optional": true + }, + { + "name": "acquisition_or_disposition", + "type": "str", + "description": "Acquisition or disposition of the shares.", + "default": null, + "optional": true + }, + { + "name": "security_type", + "type": "str", + "description": "The type of security transacted.", + "default": null, + "optional": true + }, + { + "name": "securities_owned", + "type": "float", + "description": "Number of securities owned by the reporting individual.", + "default": null, + "optional": true + }, + { + "name": "securities_transacted", + "type": "float", + "description": "Number of securities transacted by the reporting individual.", + "default": null, + "optional": true + }, + { + "name": "transaction_price", + "type": "float", + "description": "The price of the transaction.", + "default": null, + "optional": true + }, + { + "name": "filing_url", + "type": "str", + "description": "Link to the filing.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "form_type", + "type": "str", + "description": "Form type of the insider trading.", + "default": "", + "optional": false + } + ], + "intrinio": [ + { + "name": "filing_url", + "type": "str", + "description": "URL of the filing.", + "default": null, + "optional": true + }, + { + "name": "company_name", + "type": "str", + "description": "Name of the company.", + "default": "", + "optional": false + }, + { + "name": "conversion_exercise_price", + "type": "float", + "description": "Conversion/Exercise price of the shares.", + "default": null, + "optional": true + }, + { + "name": "deemed_execution_date", + "type": "date", + "description": "Deemed execution date of the trade.", + "default": null, + "optional": true + }, + { + "name": "exercise_date", + "type": "date", + "description": "Exercise date of the trade.", + "default": null, + "optional": true + }, + { + "name": "expiration_date", + "type": "date", + "description": "Expiration date of the derivative.", + "default": null, + "optional": true + }, + { + "name": "underlying_security_title", + "type": "str", + "description": "Name of the underlying non-derivative security related to this derivative transaction.", + "default": null, + "optional": true + }, + { + "name": "underlying_shares", + "type": "Union[int, float]", + "description": "Number of underlying shares related to this derivative transaction.", + "default": null, + "optional": true + }, + { + "name": "nature_of_ownership", + "type": "str", + "description": "Nature of ownership of the insider trading.", + "default": null, + "optional": true + }, + { + "name": "director", + "type": "bool", + "description": "Whether the owner is a director.", + "default": null, + "optional": true + }, + { + "name": "officer", + "type": "bool", + "description": "Whether the owner is an officer.", + "default": null, + "optional": true + }, + { + "name": "ten_percent_owner", + "type": "bool", + "description": "Whether the owner is a 10% owner.", + "default": null, + "optional": true + }, + { + "name": "other_relation", + "type": "bool", + "description": "Whether the owner is having another relation.", + "default": null, + "optional": true + }, + { + "name": "derivative_transaction", + "type": "bool", + "description": "Whether the owner is having a derivative transaction.", + "default": null, + "optional": true + }, + { + "name": "report_line_number", + "type": "int", + "description": "Report line number of the insider trading.", + "default": null, + "optional": true + } + ] + }, + "model": "InsiderTrading" + }, + "/equity/ownership/share_statistics": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get data about share float for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.share_statistics(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [], + "intrinio": [], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[ShareStatistics]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": null, + "optional": true + }, + { + "name": "free_float", + "type": "float", + "description": "Percentage of unrestricted shares of a publicly-traded company.", + "default": null, + "optional": true + }, + { + "name": "float_shares", + "type": "float", + "description": "Number of shares available for trading by the general public.", + "default": null, + "optional": true + }, + { + "name": "outstanding_shares", + "type": "float", + "description": "Total number of shares of a publicly-traded company.", + "default": null, + "optional": true + }, + { + "name": "source", + "type": "str", + "description": "Source of the received data.", + "default": null, + "optional": true + } + ], + "fmp": [], + "intrinio": [ + { + "name": "adjusted_outstanding_shares", + "type": "float", + "description": "Total number of shares of a publicly-traded company, adjusted for splits.", + "default": null, + "optional": true + }, + { + "name": "public_float", + "type": "float", + "description": "Aggregate market value of the shares of a publicly-traded company.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "implied_shares_outstanding", + "type": "int", + "description": "Implied Shares Outstanding of common equity, assuming the conversion of all convertible subsidiary equity into common.", + "default": null, + "optional": true + }, + { + "name": "short_interest", + "type": "int", + "description": "Number of shares that are reported short.", + "default": null, + "optional": true + }, + { + "name": "short_percent_of_float", + "type": "float", + "description": "Percentage of shares that are reported short, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "days_to_cover", + "type": "float", + "description": "Number of days to repurchase the shares as a ratio of average daily volume", + "default": null, + "optional": true + }, + { + "name": "short_interest_prev_month", + "type": "int", + "description": "Number of shares that were reported short in the previous month.", + "default": null, + "optional": true + }, + { + "name": "short_interest_prev_date", + "type": "date", + "description": "Date of the previous month's report.", + "default": null, + "optional": true + }, + { + "name": "insider_ownership", + "type": "float", + "description": "Percentage of shares held by insiders, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "institution_ownership", + "type": "float", + "description": "Percentage of shares held by institutions, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "institution_float_ownership", + "type": "float", + "description": "Percentage of float held by institutions, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "institutions_count", + "type": "int", + "description": "Number of institutions holding shares.", + "default": null, + "optional": true + } + ] + }, + "model": "ShareStatistics" + }, + "/equity/ownership/form_13f": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the form 13F.\n\nThe Securities and Exchange Commission's (SEC) Form 13F is a quarterly report\nthat is required to be filed by all institutional investment managers with at least\n$100 million in assets under management.\nManagers are required to file Form 13F within 45 days after the last day of the calendar quarter.\nMost funds wait until the end of this period in order to conceal\ntheir investment strategy from competitors and the public.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.form_13f(symbol='NVDA', provider='sec')\n# Enter a date (calendar quarter ending) for a specific report.\nobb.equity.ownership.form_13f(symbol='BRK-A', date='2016-09-30', provider='sec')\n# Example finding Michael Burry's filings.\ncik = obb.regulators.sec.institutions_search(\"Scion Asset Management\").results[0].cik\n# Use the `limit` parameter to return N number of reports from the most recent.\nobb.equity.ownership.form_13f(cik, limit=2).to_df()\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. A CIK or Symbol can be used.", + "default": "", + "optional": false + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter.", + "default": 1, + "optional": true + }, + { + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", + "optional": true + } + ], + "sec": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[Form13FHR]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['sec']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end-of-quarter date of the filing.", + "default": "", + "optional": false + }, + { + "name": "issuer", + "type": "str", + "description": "The name of the issuer.", + "default": "", + "optional": false + }, + { + "name": "cusip", + "type": "str", + "description": "The CUSIP of the security.", + "default": "", + "optional": false + }, + { + "name": "asset_class", + "type": "str", + "description": "The title of the asset class for the security.", + "default": "", + "optional": false + }, + { + "name": "security_type", + "type": "Literal['SH', 'PRN']", + "description": "The total number of shares of the class of security or the principal amount of such class. 'SH' for shares. 'PRN' for principal amount. Convertible debt securities are reported as 'PRN'.", + "default": null, + "optional": true + }, + { + "name": "option_type", + "type": "Literal['call', 'put']", + "description": "Defined when the holdings being reported are put or call options. Only long positions are reported.", + "default": null, + "optional": true + }, + { + "name": "voting_authority_sole", + "type": "int", + "description": "The number of shares for which the Manager exercises sole voting authority (none).", + "default": null, + "optional": true + }, + { + "name": "voting_authority_shared", + "type": "int", + "description": "The number of shares for which the Manager exercises a defined shared voting authority (none).", + "default": null, + "optional": true + }, + { + "name": "voting_authority_other", + "type": "int", + "description": "The number of shares for which the Manager exercises other shared voting authority (none).", + "default": null, + "optional": true + }, + { + "name": "principal_amount", + "type": "int", + "description": "The total number of shares of the class of security or the principal amount of such class. Only long positions are reported", + "default": "", + "optional": false + }, + { + "name": "value", + "type": "int", + "description": "The fair market value of the holding of the particular class of security. The value reported for options is the fair market value of the underlying security with respect to the number of shares controlled. Values are rounded to the nearest US dollar and use the closing price of the last trading day of the calendar year or quarter.", + "default": "", + "optional": false + } + ], + "sec": [ + { + "name": "weight", + "type": "float", + "description": "The weight of the security relative to the market value of all securities in the filing , as a normalized percent.", + "default": "", + "optional": false + } + ] + }, + "model": "Form13FHR" + }, + "/equity/price/quote": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the latest quote for a given stock. Quote includes price, volume, and other data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.quote(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", + "default": "", + "optional": false + }, + { + "name": "source", + "type": "Literal['iex', 'bats', 'bats_delayed', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed', 'intrinio_mx', 'intrinio_mx_plus', 'delayed_sip']", + "description": "Source of the data.", + "default": "iex", + "optional": true + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityQuote]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "asset_type", + "type": "str", + "description": "Type of asset - i.e, stock, ETF, etc.", + "default": null, + "optional": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the company or asset.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "The name or symbol of the venue where the data is from.", + "default": null, + "optional": true + }, + { + "name": "bid", + "type": "float", + "description": "Price of the top bid order.", + "default": null, + "optional": true + }, + { + "name": "bid_size", + "type": "int", + "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", + "default": null, + "optional": true + }, + { + "name": "bid_exchange", + "type": "str", + "description": "The specific trading venue where the purchase order was placed.", + "default": null, + "optional": true + }, + { + "name": "ask", + "type": "float", + "description": "Price of the top ask order.", + "default": null, + "optional": true + }, + { + "name": "ask_size", + "type": "int", + "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", + "default": null, + "optional": true + }, + { + "name": "ask_exchange", + "type": "str", + "description": "The specific trading venue where the sale order was placed.", + "default": null, + "optional": true + }, + { + "name": "quote_conditions", + "type": "Union[str, int, List[str], List[int]]", + "description": "Conditions or condition codes applicable to the quote.", + "default": null, + "optional": true + }, + { + "name": "quote_indicators", + "type": "Union[str, int, List[str], List[int]]", + "description": "Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO.", + "default": null, + "optional": true + }, + { + "name": "sales_conditions", + "type": "Union[str, int, List[str], List[int]]", + "description": "Conditions or condition codes applicable to the sale.", + "default": null, + "optional": true + }, + { + "name": "sequence_number", + "type": "int", + "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11).", + "default": null, + "optional": true + }, + { + "name": "market_center", + "type": "str", + "description": "The ID of the UTP participant that originated the message.", + "default": null, + "optional": true + }, + { + "name": "participant_timestamp", + "type": "datetime", + "description": "Timestamp for when the quote was generated by the exchange.", + "default": null, + "optional": true + }, + { + "name": "trf_timestamp", + "type": "datetime", + "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message.", + "default": null, + "optional": true + }, + { + "name": "sip_timestamp", + "type": "datetime", + "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange.", + "default": null, + "optional": true + }, + { + "name": "last_price", + "type": "float", + "description": "Price of the last trade.", + "default": null, + "optional": true + }, + { + "name": "last_tick", + "type": "str", + "description": "Whether the last sale was an up or down tick.", + "default": null, + "optional": true + }, + { + "name": "last_size", + "type": "int", + "description": "Size of the last trade.", + "default": null, + "optional": true + }, + { + "name": "last_timestamp", + "type": "datetime", + "description": "Date and Time when the last price was recorded.", + "default": null, + "optional": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": null, + "optional": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": null, + "optional": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": null, + "optional": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "Union[int, float]", + "description": "The trading volume.", + "default": null, + "optional": true + }, + { + "name": "exchange_volume", + "type": "Union[int, float]", + "description": "Volume of shares exchanged during the trading day on the specific exchange.", + "default": null, + "optional": true + }, + { + "name": "prev_close", + "type": "float", + "description": "The previous close price.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "Change in price from previous close.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in price as a normalized percentage.", + "default": null, + "optional": true + }, + { + "name": "year_high", + "type": "float", + "description": "The one year high (52W High).", + "default": null, + "optional": true + }, + { + "name": "year_low", + "type": "float", + "description": "The one year low (52W Low).", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "price_avg50", + "type": "float", + "description": "50 day moving average price.", + "default": null, + "optional": true + }, + { + "name": "price_avg200", + "type": "float", + "description": "200 day moving average price.", + "default": null, + "optional": true + }, + { + "name": "avg_volume", + "type": "int", + "description": "Average volume over the last 10 trading days.", + "default": null, + "optional": true + }, + { + "name": "market_cap", + "type": "float", + "description": "Market cap of the company.", + "default": null, + "optional": true + }, + { + "name": "shares_outstanding", + "type": "int", + "description": "Number of shares outstanding.", + "default": null, + "optional": true + }, + { + "name": "eps", + "type": "float", + "description": "Earnings per share.", + "default": null, + "optional": true + }, + { + "name": "pe", + "type": "float", + "description": "Price earnings ratio.", + "default": null, + "optional": true + }, + { + "name": "earnings_announcement", + "type": "datetime", + "description": "Upcoming earnings announcement date.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "is_darkpool", + "type": "bool", + "description": "Whether or not the current trade is from a darkpool.", + "default": null, + "optional": true + }, + { + "name": "source", + "type": "str", + "description": "Source of the Intrinio data.", + "default": null, + "optional": true + }, + { + "name": "updated_on", + "type": "datetime", + "description": "Date and Time when the data was last updated.", + "default": "", + "optional": false + }, + { + "name": "security", + "type": "IntrinioSecurity", + "description": "Security details related to the quote.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "ma_50d", + "type": "float", + "description": "50-day moving average price.", + "default": null, + "optional": true + }, + { + "name": "ma_200d", + "type": "float", + "description": "200-day moving average price.", + "default": null, + "optional": true + }, + { + "name": "volume_average", + "type": "float", + "description": "Average daily trading volume.", + "default": null, + "optional": true + }, + { + "name": "volume_average_10d", + "type": "float", + "description": "Average daily trading volume in the last 10 days.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency of the price.", + "default": null, + "optional": true + } + ] + }, + "model": "EquityQuote" + }, + "/equity/price/nbbo": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the National Best Bid and Offer for a given stock.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.nbbo(symbol='AAPL', provider='polygon')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['polygon']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'polygon' if there is no default.", + "default": "polygon", + "optional": true + } + ], + "polygon": [ + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return. Up to ten million records will be returned. Pagination occurs in groups of 50,000. Remaining limit values will always return 50,000 more records unless it is the last page. High volume tickers will require multiple max requests for a single day's NBBO records. Expect stocks, like SPY, to approach 1GB in size, per day, as a raw CSV. Splitting large requests into chunks is recommended for full-day requests of high-volume symbols.", + "default": 50000, + "optional": true + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for. Use bracketed the timestamp parameters to specify exact time ranges.", + "default": null, + "optional": true + }, + { + "name": "timestamp_lt", + "type": "Union[datetime, str]", + "description": "Query by datetime, less than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", + "default": null, + "optional": true + }, + { + "name": "timestamp_gt", + "type": "Union[datetime, str]", + "description": "Query by datetime, greater than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", + "default": null, + "optional": true + }, + { + "name": "timestamp_lte", + "type": "Union[datetime, str]", + "description": "Query by datetime, less than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", + "default": null, + "optional": true + }, + { + "name": "timestamp_gte", + "type": "Union[datetime, str]", + "description": "Query by datetime, greater than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityNBBO]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['polygon']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "ask_exchange", + "type": "str", + "description": "The exchange ID for the ask.", + "default": "", + "optional": false + }, + { + "name": "ask", + "type": "float", + "description": "The last ask price.", + "default": "", + "optional": false + }, + { + "name": "ask_size", + "type": "int", + "description": "The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price.", + "default": "", + "optional": false + }, + { + "name": "bid_size", + "type": "int", + "description": "The bid size in round lots.", + "default": "", + "optional": false + }, + { + "name": "bid", + "type": "float", + "description": "The last bid price.", + "default": "", + "optional": false + }, + { + "name": "bid_exchange", + "type": "str", + "description": "The exchange ID for the bid.", + "default": "", + "optional": false + } + ], + "polygon": [ + { + "name": "tape", + "type": "str", + "description": "The exchange tape.", + "default": null, + "optional": true + }, + { + "name": "conditions", + "type": "Union[str, List[int], List[str]]", + "description": "A list of condition codes.", + "default": null, + "optional": true + }, + { + "name": "indicators", + "type": "List[int]", + "description": "A list of indicator codes.", + "default": null, + "optional": true + }, + { + "name": "sequence_num", + "type": "int", + "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11)", + "default": null, + "optional": true + }, + { + "name": "participant_timestamp", + "type": "datetime", + "description": "The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.", + "default": null, + "optional": true + }, + { + "name": "sip_timestamp", + "type": "datetime", + "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it.", + "default": null, + "optional": true + }, + { + "name": "trf_timestamp", + "type": "datetime", + "description": "The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this quote.", + "default": null, + "optional": true + } + ] + }, + "model": "EquityNBBO" + }, + "/equity/price/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical price data for a given stock. This includes open, high, low, close, and volume.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.historical(symbol='AAPL', provider='fmp')\nobb.equity.price.historical(symbol='AAPL', interval='1d', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", + "default": "", + "optional": false + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", + "default": "", + "optional": false + }, + { + "name": "interval", + "type": "Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "start_time", + "type": "datetime.time", + "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'.", + "default": null, + "optional": true + }, + { + "name": "end_time", + "type": "datetime.time", + "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'.", + "default": null, + "optional": true + }, + { + "name": "timezone", + "type": "str", + "description": "Timezone of the data, in the IANA format (Continent/City).", + "default": "America/New_York", + "optional": true + }, + { + "name": "source", + "type": "Literal['realtime', 'delayed', 'nasdaq_basic']", + "description": "The source of the data.", + "default": "realtime", + "optional": true + } + ], + "polygon": [ + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", + "default": "1d", + "optional": true + }, + { + "name": "adjustment", + "type": "Literal['splits_only', 'unadjusted']", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", + "optional": true + }, + { + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": false, + "optional": true + }, + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", + "default": "asc", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 49999, + "optional": true + } + ], + "tiingo": [ + { + "name": "interval", + "type": "Literal['1d', '1W', '1M', '1Y']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ], + "yfinance": [ + { + "name": "interval", + "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": false, + "optional": true + }, + { + "name": "include_actions", + "type": "bool", + "description": "Include dividends and stock splits in results.", + "default": true, + "optional": true + }, + { + "name": "adjustment", + "type": "Literal['splits_only', 'splits_and_dividends']", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", + "optional": true + }, + { + "name": "adjusted", + "type": "bool", + "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead.", + "default": false, + "optional": true + }, + { + "name": "prepost", + "type": "bool", + "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityHistorical]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "Union[int, float]", + "description": "The trading volume.", + "default": null, + "optional": true + }, + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": null, + "optional": true + }, + { + "name": "unadjusted_volume", + "type": "float", + "description": "Unadjusted volume of the symbol.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "Change in the price from the previous close.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in the price from the previous close, as a normalized percent.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "average", + "type": "float", + "description": "Average trade price of an individual equity during the interval.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "Change in the price of the symbol from the previous day.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Percent change in the price of the symbol from the previous day.", + "default": null, + "optional": true + }, + { + "name": "adj_open", + "type": "float", + "description": "The adjusted open price.", + "default": null, + "optional": true + }, + { + "name": "adj_high", + "type": "float", + "description": "The adjusted high price.", + "default": null, + "optional": true + }, + { + "name": "adj_low", + "type": "float", + "description": "The adjusted low price.", + "default": null, + "optional": true + }, + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": null, + "optional": true + }, + { + "name": "adj_volume", + "type": "float", + "description": "The adjusted volume.", + "default": null, + "optional": true + }, + { + "name": "fifty_two_week_high", + "type": "float", + "description": "52 week high price for the symbol.", + "default": null, + "optional": true + }, + { + "name": "fifty_two_week_low", + "type": "float", + "description": "52 week low price for the symbol.", + "default": null, + "optional": true + }, + { + "name": "factor", + "type": "float", + "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices.", + "default": null, + "optional": true + }, + { + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", + "default": null, + "optional": true + }, + { + "name": "dividend", + "type": "float", + "description": "Dividend amount, if a dividend was paid.", + "default": null, + "optional": true + }, + { + "name": "close_time", + "type": "datetime", + "description": "The timestamp that represents the end of the interval span.", + "default": null, + "optional": true + }, + { + "name": "interval", + "type": "str", + "description": "The data time frequency.", + "default": null, + "optional": true + }, + { + "name": "intra_period", + "type": "bool", + "description": "If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "transactions", + "type": "Annotated[int, Gt(gt=0)]", + "description": "Number of transactions for the symbol in the time period.", + "default": null, + "optional": true + } + ], + "tiingo": [ + { + "name": "adj_open", + "type": "float", + "description": "The adjusted open price.", + "default": null, + "optional": true + }, + { + "name": "adj_high", + "type": "float", + "description": "The adjusted high price.", + "default": null, + "optional": true + }, + { + "name": "adj_low", + "type": "float", + "description": "The adjusted low price.", + "default": null, + "optional": true + }, + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": null, + "optional": true + }, + { + "name": "adj_volume", + "type": "float", + "description": "The adjusted volume.", + "default": null, + "optional": true + }, + { + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", + "default": null, + "optional": true + }, + { + "name": "dividend", + "type": "float", + "description": "Dividend amount, if a dividend was paid.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", + "default": null, + "optional": true + }, + { + "name": "dividend", + "type": "float", + "description": "Dividend amount (split-adjusted), if a dividend was paid.", + "default": null, + "optional": true + } + ] + }, + "model": "EquityHistorical" + }, + "/equity/price/performance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get price performance data for a given stock. This includes price changes for different time periods.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.performance(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[PricePerformance]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "one_day", + "type": "float", + "description": "One-day return.", + "default": null, + "optional": true + }, + { + "name": "wtd", + "type": "float", + "description": "Week to date return.", + "default": null, + "optional": true + }, + { + "name": "one_week", + "type": "float", + "description": "One-week return.", + "default": null, + "optional": true + }, + { + "name": "mtd", + "type": "float", + "description": "Month to date return.", + "default": null, + "optional": true + }, + { + "name": "one_month", + "type": "float", + "description": "One-month return.", + "default": null, + "optional": true + }, + { + "name": "qtd", + "type": "float", + "description": "Quarter to date return.", + "default": null, + "optional": true + }, + { + "name": "three_month", + "type": "float", + "description": "Three-month return.", + "default": null, + "optional": true + }, + { + "name": "six_month", + "type": "float", + "description": "Six-month return.", + "default": null, + "optional": true + }, + { + "name": "ytd", + "type": "float", + "description": "Year to date return.", + "default": null, + "optional": true + }, + { + "name": "one_year", + "type": "float", + "description": "One-year return.", + "default": null, + "optional": true + }, + { + "name": "two_year", + "type": "float", + "description": "Two-year return.", + "default": null, + "optional": true + }, + { + "name": "three_year", + "type": "float", + "description": "Three-year return.", + "default": null, + "optional": true + }, + { + "name": "four_year", + "type": "float", + "description": "Four-year", + "default": null, + "optional": true + }, + { + "name": "five_year", + "type": "float", + "description": "Five-year return.", + "default": null, + "optional": true + }, + { + "name": "ten_year", + "type": "float", + "description": "Ten-year return.", + "default": null, + "optional": true + }, + { + "name": "max", + "type": "float", + "description": "Return from the beginning of the time series.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": "", + "optional": false + } + ] + }, + "model": "PricePerformance" + }, + "/equity/shorts/fails_to_deliver": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get reported Fail-to-deliver (FTD) data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.shorts.fails_to_deliver(symbol='AAPL', provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", + "optional": true + } + ], + "sec": [ + { + "name": "limit", + "type": "int", + "description": "Limit the number of reports to parse, from most recent. Approximately 24 reports per year, going back to 2009.", + "default": 24, + "optional": true + }, + { + "name": "skip_reports", + "type": "int", + "description": "Skip N number of reports from current. A value of 1 will skip the most recent report.", + "default": 0, + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache for the request, default is True. Each reporting period is a separate URL, new reports will be added to the cache.", + "default": true, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityFTD]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['sec']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "settlement_date", + "type": "date", + "description": "The settlement date of the fail.", + "default": null, + "optional": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "cusip", + "type": "str", + "description": "CUSIP of the Security.", + "default": null, + "optional": true + }, + { + "name": "quantity", + "type": "int", + "description": "The number of fails on that settlement date.", + "default": null, + "optional": true + }, + { + "name": "price", + "type": "float", + "description": "The price at the previous closing price from the settlement date.", + "default": null, + "optional": true + }, + { + "name": "description", + "type": "str", + "description": "The description of the Security.", + "default": null, + "optional": true + } + ], + "sec": [] + }, + "model": "EquityFTD" + }, + "/equity/search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search for stock symbol, CIK, LEI, or company name.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.search(provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", + "optional": true + }, + { + "name": "is_symbol", + "type": "bool", + "description": "Whether to search by ticker symbol.", + "default": false, + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether to use the cache or not.", + "default": true, + "optional": true + }, + { + "name": "provider", + "type": "Literal['intrinio', 'sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", + "optional": true + } + ], + "intrinio": [ + { + "name": "active", + "type": "bool", + "description": "When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded.", + "default": true, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10000, + "optional": true + } + ], + "sec": [ + { + "name": "is_fund", + "type": "bool", + "description": "Whether to direct the search to the list of mutual funds and ETFs.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquitySearch]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['intrinio', 'sec']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the company.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "cik", + "type": "str", + "description": "", + "default": "", + "optional": false + }, + { + "name": "lei", + "type": "str", + "description": "The Legal Entity Identifier (LEI) of the company.", + "default": "", + "optional": false + }, + { + "name": "intrinio_id", + "type": "str", + "description": "The Intrinio ID of the company.", + "default": "", + "optional": false + } + ], + "sec": [ + { + "name": "cik", + "type": "str", + "description": "Central Index Key", + "default": "", + "optional": false + } + ] + }, + "model": "EquitySearch" + }, + "/equity/screener": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Screen for companies meeting various criteria.\n\nThese criteria include market cap, price, beta, volume, and dividend yield.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.screener(provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "mktcap_min", + "type": "int", + "description": "Filter by market cap greater than this value.", + "default": null, + "optional": true + }, + { + "name": "mktcap_max", + "type": "int", + "description": "Filter by market cap less than this value.", + "default": null, + "optional": true + }, + { + "name": "price_min", + "type": "float", + "description": "Filter by price greater than this value.", + "default": null, + "optional": true + }, + { + "name": "price_max", + "type": "float", + "description": "Filter by price less than this value.", + "default": null, + "optional": true + }, + { + "name": "beta_min", + "type": "float", + "description": "Filter by a beta greater than this value.", + "default": null, + "optional": true + }, + { + "name": "beta_max", + "type": "float", + "description": "Filter by a beta less than this value.", + "default": null, + "optional": true + }, + { + "name": "volume_min", + "type": "int", + "description": "Filter by volume greater than this value.", + "default": null, + "optional": true + }, + { + "name": "volume_max", + "type": "int", + "description": "Filter by volume less than this value.", + "default": null, + "optional": true + }, + { + "name": "dividend_min", + "type": "float", + "description": "Filter by dividend amount greater than this value.", + "default": null, + "optional": true + }, + { + "name": "dividend_max", + "type": "float", + "description": "Filter by dividend amount less than this value.", + "default": null, + "optional": true + }, + { + "name": "is_etf", + "type": "bool", + "description": "If true, returns only ETFs.", + "default": false, + "optional": true + }, + { + "name": "is_active", + "type": "bool", + "description": "If false, returns only inactive tickers.", + "default": true, + "optional": true + }, + { + "name": "sector", + "type": "Literal['Consumer Cyclical', 'Energy', 'Technology', 'Industrials', 'Financial Services', 'Basic Materials', 'Communication Services', 'Consumer Defensive', 'Healthcare', 'Real Estate', 'Utilities', 'Industrial Goods', 'Financial', 'Services', 'Conglomerates']", + "description": "Filter by sector.", + "default": null, + "optional": true + }, + { + "name": "industry", + "type": "str", + "description": "Filter by industry.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Filter by country, as a two-letter country code.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra']", + "description": "Filter by exchange.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "Limit the number of results to return.", + "default": 50000, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityScreener]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the company.", + "default": "", + "optional": false + } + ], + "fmp": [ + { + "name": "market_cap", + "type": "int", + "description": "The market cap of ticker.", + "default": null, + "optional": true + }, + { + "name": "sector", + "type": "str", + "description": "The sector the ticker belongs to.", + "default": null, + "optional": true + }, + { + "name": "industry", + "type": "str", + "description": "The industry ticker belongs to.", + "default": null, + "optional": true + }, + { + "name": "beta", + "type": "float", + "description": "The beta of the ETF.", + "default": null, + "optional": true + }, + { + "name": "price", + "type": "float", + "description": "The current price.", + "default": null, + "optional": true + }, + { + "name": "last_annual_dividend", + "type": "float", + "description": "The last annual amount dividend paid.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "int", + "description": "The current trading volume.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "The exchange code the asset trades on.", + "default": null, + "optional": true + }, + { + "name": "exchange_name", + "type": "str", + "description": "The full name of the primary exchange.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "The two-letter country abbreviation where the head office is located.", + "default": null, + "optional": true + }, + { + "name": "is_etf", + "type": "Literal[True, False]", + "description": "Whether the ticker is an ETF.", + "default": null, + "optional": true + }, + { + "name": "actively_trading", + "type": "Literal[True, False]", + "description": "Whether the ETF is actively trading.", + "default": null, + "optional": true + } + ] + }, + "model": "EquityScreener" + }, + "/equity/profile": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get general information about a company. This includes company name, industry, sector and price data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.profile(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [], + "intrinio": [], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityInfo]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Common name of the company.", + "default": null, + "optional": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true + }, + { + "name": "cusip", + "type": "str", + "description": "CUSIP identifier for the company.", + "default": null, + "optional": true + }, + { + "name": "isin", + "type": "str", + "description": "International Securities Identification Number.", + "default": null, + "optional": true + }, + { + "name": "lei", + "type": "str", + "description": "Legal Entity Identifier assigned to the company.", + "default": null, + "optional": true + }, + { + "name": "legal_name", + "type": "str", + "description": "Official legal name of the company.", + "default": null, + "optional": true + }, + { + "name": "stock_exchange", + "type": "str", + "description": "Stock exchange where the company is traded.", + "default": null, + "optional": true + }, + { + "name": "sic", + "type": "int", + "description": "Standard Industrial Classification code for the company.", + "default": null, + "optional": true + }, + { + "name": "short_description", + "type": "str", + "description": "Short description of the company.", + "default": null, + "optional": true + }, + { + "name": "long_description", + "type": "str", + "description": "Long description of the company.", + "default": null, + "optional": true + }, + { + "name": "ceo", + "type": "str", + "description": "Chief Executive Officer of the company.", + "default": null, + "optional": true + }, + { + "name": "company_url", + "type": "str", + "description": "URL of the company's website.", + "default": null, + "optional": true + }, + { + "name": "business_address", + "type": "str", + "description": "Address of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "mailing_address", + "type": "str", + "description": "Mailing address of the company.", + "default": null, + "optional": true + }, + { + "name": "business_phone_no", + "type": "str", + "description": "Phone number of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "hq_address1", + "type": "str", + "description": "Address of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "hq_address2", + "type": "str", + "description": "Address of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "hq_address_city", + "type": "str", + "description": "City of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "hq_address_postal_code", + "type": "str", + "description": "Zip code of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "hq_state", + "type": "str", + "description": "State of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "hq_country", + "type": "str", + "description": "Country of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "inc_state", + "type": "str", + "description": "State in which the company is incorporated.", + "default": null, + "optional": true + }, + { + "name": "inc_country", + "type": "str", + "description": "Country in which the company is incorporated.", + "default": null, + "optional": true + }, + { + "name": "employees", + "type": "int", + "description": "Number of employees working for the company.", + "default": null, + "optional": true + }, + { + "name": "entity_legal_form", + "type": "str", + "description": "Legal form of the company.", + "default": null, + "optional": true + }, + { + "name": "entity_status", + "type": "str", + "description": "Status of the company.", + "default": null, + "optional": true + }, + { + "name": "latest_filing_date", + "type": "date", + "description": "Date of the company's latest filing.", + "default": null, + "optional": true + }, + { + "name": "irs_number", + "type": "str", + "description": "IRS number assigned to the company.", + "default": null, + "optional": true + }, + { + "name": "sector", + "type": "str", + "description": "Sector in which the company operates.", + "default": null, + "optional": true + }, + { + "name": "industry_category", + "type": "str", + "description": "Category of industry in which the company operates.", + "default": null, + "optional": true + }, + { + "name": "industry_group", + "type": "str", + "description": "Group of industry in which the company operates.", + "default": null, + "optional": true + }, + { + "name": "template", + "type": "str", + "description": "Template used to standardize the company's financial statements.", + "default": null, + "optional": true + }, + { + "name": "standardized_active", + "type": "bool", + "description": "Whether the company is active or not.", + "default": null, + "optional": true + }, + { + "name": "first_fundamental_date", + "type": "date", + "description": "Date of the company's first fundamental.", + "default": null, + "optional": true + }, + { + "name": "last_fundamental_date", + "type": "date", + "description": "Date of the company's last fundamental.", + "default": null, + "optional": true + }, + { + "name": "first_stock_price_date", + "type": "date", + "description": "Date of the company's first stock price.", + "default": null, + "optional": true + }, + { + "name": "last_stock_price_date", + "type": "date", + "description": "Date of the company's last stock price.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "is_etf", + "type": "bool", + "description": "If the symbol is an ETF.", + "default": "", + "optional": false + }, + { + "name": "is_actively_trading", + "type": "bool", + "description": "If the company is actively trading.", + "default": "", + "optional": false + }, + { + "name": "is_adr", + "type": "bool", + "description": "If the stock is an ADR.", + "default": "", + "optional": false + }, + { + "name": "is_fund", + "type": "bool", + "description": "If the company is a fund.", + "default": "", + "optional": false + }, + { + "name": "image", + "type": "str", + "description": "Image of the company.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency in which the stock is traded.", + "default": null, + "optional": true + }, + { + "name": "market_cap", + "type": "int", + "description": "Market capitalization of the company.", + "default": null, + "optional": true + }, + { + "name": "last_price", + "type": "float", + "description": "The last traded price.", + "default": null, + "optional": true + }, + { + "name": "year_high", + "type": "float", + "description": "The one-year high of the price.", + "default": null, + "optional": true + }, + { + "name": "year_low", + "type": "float", + "description": "The one-year low of the price.", + "default": null, + "optional": true + }, + { + "name": "volume_avg", + "type": "int", + "description": "Average daily trading volume.", + "default": null, + "optional": true + }, + { + "name": "annualized_dividend_amount", + "type": "float", + "description": "The annualized dividend payment based on the most recent regular dividend payment.", + "default": null, + "optional": true + }, + { + "name": "beta", + "type": "float", + "description": "Beta of the stock relative to the market.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "id", + "type": "str", + "description": "Intrinio ID for the company.", + "default": null, + "optional": true + }, + { + "name": "thea_enabled", + "type": "bool", + "description": "Whether the company has been enabled for Thea.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "exchange_timezone", + "type": "str", + "description": "The timezone of the exchange.", + "default": null, + "optional": true + }, + { + "name": "issue_type", + "type": "str", + "description": "The issuance type of the asset.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "The currency in which the asset is traded.", + "default": null, + "optional": true + }, + { + "name": "market_cap", + "type": "int", + "description": "The market capitalization of the asset.", + "default": null, + "optional": true + }, + { + "name": "shares_outstanding", + "type": "int", + "description": "The number of listed shares outstanding.", + "default": null, + "optional": true + }, + { + "name": "shares_float", + "type": "int", + "description": "The number of shares in the public float.", + "default": null, + "optional": true + }, + { + "name": "shares_implied_outstanding", + "type": "int", + "description": "Implied shares outstanding of common equityassuming the conversion of all convertible subsidiary equity into common.", + "default": null, + "optional": true + }, + { + "name": "shares_short", + "type": "int", + "description": "The reported number of shares short.", + "default": null, + "optional": true + }, + { + "name": "dividend_yield", + "type": "float", + "description": "The dividend yield of the asset, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "beta", + "type": "float", + "description": "The beta of the asset relative to the broad market.", + "default": null, + "optional": true + } + ] + }, + "model": "EquityInfo" + }, + "/equity/market_snapshots": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get an updated equity market snapshot. This includes price data for thousands of stocks.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.market_snapshots(provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "market", + "type": "Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra']", + "description": "The market to fetch data for.", + "default": "nasdaq", + "optional": true + } + ], + "intrinio": [ + { + "name": "date", + "type": "Union[Union[date, datetime, str], str]", + "description": "The date of the data. Can be a datetime or an ISO datetime string. Historical data appears to go back to mid-June 2022. Example: '2024-03-08T12:15:00+0400'", + "default": null, + "optional": true + } + ], + "polygon": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[MarketSnapshots]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": null, + "optional": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": null, + "optional": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": null, + "optional": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": null, + "optional": true + }, + { + "name": "prev_close", + "type": "float", + "description": "The previous close price.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "The change in price from the previous close.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "The change in price from the previous close, as a normalized percent.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "last_price", + "type": "float", + "description": "The last price of the stock.", + "default": null, + "optional": true + }, + { + "name": "last_price_timestamp", + "type": "Union[date, datetime]", + "description": "The timestamp of the last price.", + "default": null, + "optional": true + }, + { + "name": "ma50", + "type": "float", + "description": "The 50-day moving average.", + "default": null, + "optional": true + }, + { + "name": "ma200", + "type": "float", + "description": "The 200-day moving average.", + "default": null, + "optional": true + }, + { + "name": "year_high", + "type": "float", + "description": "The 52-week high.", + "default": null, + "optional": true + }, + { + "name": "year_low", + "type": "float", + "description": "The 52-week low.", + "default": null, + "optional": true + }, + { + "name": "volume_avg", + "type": "int", + "description": "Average daily trading volume.", + "default": null, + "optional": true + }, + { + "name": "market_cap", + "type": "int", + "description": "Market cap of the stock.", + "default": null, + "optional": true + }, + { + "name": "eps", + "type": "float", + "description": "Earnings per share.", + "default": null, + "optional": true + }, + { + "name": "pe", + "type": "float", + "description": "Price to earnings ratio.", + "default": null, + "optional": true + }, + { + "name": "shares_outstanding", + "type": "int", + "description": "Number of shares outstanding.", + "default": null, + "optional": true + }, + { + "name": "name", + "type": "str", + "description": "The company name associated with the symbol.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "The exchange of the stock.", + "default": null, + "optional": true + }, + { + "name": "earnings_date", + "type": "Union[date, datetime]", + "description": "The upcoming earnings announcement date.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "last_price", + "type": "float", + "description": "The last trade price.", + "default": null, + "optional": true + }, + { + "name": "last_size", + "type": "int", + "description": "The last trade size.", + "default": null, + "optional": true + }, + { + "name": "last_volume", + "type": "int", + "description": "The last trade volume.", + "default": null, + "optional": true + }, + { + "name": "last_trade_timestamp", + "type": "datetime", + "description": "The timestamp of the last trade.", + "default": null, + "optional": true + }, + { + "name": "bid_size", + "type": "int", + "description": "The size of the last bid price. Bid price and size is not always available.", + "default": null, + "optional": true + }, + { + "name": "bid_price", + "type": "float", + "description": "The last bid price. Bid price and size is not always available.", + "default": null, + "optional": true + }, + { + "name": "ask_price", + "type": "float", + "description": "The last ask price. Ask price and size is not always available.", + "default": null, + "optional": true + }, + { + "name": "ask_size", + "type": "int", + "description": "The size of the last ask price. Ask price and size is not always available.", + "default": null, + "optional": true + }, + { + "name": "last_bid_timestamp", + "type": "datetime", + "description": "The timestamp of the last bid price. Bid price and size is not always available.", + "default": null, + "optional": true + }, + { + "name": "last_ask_timestamp", + "type": "datetime", + "description": "The timestamp of the last ask price. Ask price and size is not always available.", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "vwap", + "type": "float", + "description": "The volume weighted average price of the stock on the current trading day.", + "default": null, + "optional": true + }, + { + "name": "prev_open", + "type": "float", + "description": "The previous trading session opening price.", + "default": null, + "optional": true + }, + { + "name": "prev_high", + "type": "float", + "description": "The previous trading session high price.", + "default": null, + "optional": true + }, + { + "name": "prev_low", + "type": "float", + "description": "The previous trading session low price.", + "default": null, + "optional": true + }, + { + "name": "prev_volume", + "type": "float", + "description": "The previous trading session volume.", + "default": null, + "optional": true + }, + { + "name": "prev_vwap", + "type": "float", + "description": "The previous trading session VWAP.", + "default": null, + "optional": true + }, + { + "name": "last_updated", + "type": "datetime", + "description": "The last time the data was updated.", + "default": "", + "optional": false + }, + { + "name": "bid", + "type": "float", + "description": "The current bid price.", + "default": null, + "optional": true + }, + { + "name": "bid_size", + "type": "int", + "description": "The current bid size.", + "default": null, + "optional": true + }, + { + "name": "ask_size", + "type": "int", + "description": "The current ask size.", + "default": null, + "optional": true + }, + { + "name": "ask", + "type": "float", + "description": "The current ask price.", + "default": null, + "optional": true + }, + { + "name": "quote_timestamp", + "type": "datetime", + "description": "The timestamp of the last quote.", + "default": null, + "optional": true + }, + { + "name": "last_trade_price", + "type": "float", + "description": "The last trade price.", + "default": null, + "optional": true + }, + { + "name": "last_trade_size", + "type": "int", + "description": "The last trade size.", + "default": null, + "optional": true + }, + { + "name": "last_trade_conditions", + "type": "List[int]", + "description": "The last trade condition codes.", + "default": null, + "optional": true + }, + { + "name": "last_trade_exchange", + "type": "int", + "description": "The last trade exchange ID code.", + "default": null, + "optional": true + }, + { + "name": "last_trade_timestamp", + "type": "datetime", + "description": "The last trade timestamp.", + "default": null, + "optional": true + } + ] + }, + "model": "MarketSnapshots" + }, + "/etf/search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search for ETFs.\n\nAn empty query returns the full list of ETFs from the provider.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# An empty query returns the full list of ETFs from the provider.\nobb.etf.search(provider='fmp')\n# The query will return results from text-based fields containing the term.\nobb.etf.search(query='commercial real estate', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "exchange", + "type": "Literal['AMEX', 'NYSE', 'NASDAQ', 'ETF', 'TSX', 'EURONEXT']", + "description": "The exchange code the ETF trades on.", + "default": null, + "optional": true + }, + { + "name": "is_active", + "type": "Literal[True, False]", + "description": "Whether the ETF is actively trading.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "exchange", + "type": "Literal['xnas', 'arcx', 'bats', 'xnys', 'bvmf', 'xshg', 'xshe', 'xhkg', 'xbom', 'xnse', 'xidx', 'tase', 'xkrx', 'xkls', 'xmex', 'xses', 'roco', 'xtai', 'xbkk', 'xist']", + "description": "Target a specific exchange by providing the MIC code.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfSearch]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.(ETF)", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the ETF.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "market_cap", + "type": "float", + "description": "The market cap of the ETF.", + "default": null, + "optional": true + }, + { + "name": "sector", + "type": "str", + "description": "The sector of the ETF.", + "default": null, + "optional": true + }, + { + "name": "industry", + "type": "str", + "description": "The industry of the ETF.", + "default": null, + "optional": true + }, + { + "name": "beta", + "type": "float", + "description": "The beta of the ETF.", + "default": null, + "optional": true + }, + { + "name": "price", + "type": "float", + "description": "The current price of the ETF.", + "default": null, + "optional": true + }, + { + "name": "last_annual_dividend", + "type": "float", + "description": "The last annual dividend paid.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "float", + "description": "The current trading volume of the ETF.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "The exchange code the ETF trades on.", + "default": null, + "optional": true + }, + { + "name": "exchange_name", + "type": "str", + "description": "The full name of the exchange the ETF trades on.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "The country the ETF is registered in.", + "default": null, + "optional": true + }, + { + "name": "actively_trading", + "type": "Literal[True, False]", + "description": "Whether the ETF is actively trading.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "exchange", + "type": "str", + "description": "The exchange MIC code.", + "default": null, + "optional": true + }, + { + "name": "figi_ticker", + "type": "str", + "description": "The OpenFIGI ticker.", + "default": null, + "optional": true + }, + { + "name": "ric", + "type": "str", + "description": "The Reuters Instrument Code.", + "default": null, + "optional": true + }, + { + "name": "isin", + "type": "str", + "description": "The International Securities Identification Number.", + "default": null, + "optional": true + }, + { + "name": "sedol", + "type": "str", + "description": "The Stock Exchange Daily Official List.", + "default": null, + "optional": true + }, + { + "name": "intrinio_id", + "type": "str", + "description": "The unique Intrinio ID for the security.", + "default": null, + "optional": true + } + ] + }, + "model": "EtfSearch" + }, + "/etf/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "ETF Historical Market Price.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.historical(symbol='SPY', provider='fmp')\nobb.etf.historical(symbol='SPY', provider='yfinance')\n# This function accepts multiple tickers.\nobb.etf.historical(symbol='SPY,IWM,QQQ,DJIA', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", + "default": "", + "optional": false + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", + "default": "", + "optional": false + }, + { + "name": "interval", + "type": "Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "start_time", + "type": "datetime.time", + "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'.", + "default": null, + "optional": true + }, + { + "name": "end_time", + "type": "datetime.time", + "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'.", + "default": null, + "optional": true + }, + { + "name": "timezone", + "type": "str", + "description": "Timezone of the data, in the IANA format (Continent/City).", + "default": "America/New_York", + "optional": true + }, + { + "name": "source", + "type": "Literal['realtime', 'delayed', 'nasdaq_basic']", + "description": "The source of the data.", + "default": "realtime", + "optional": true + } + ], + "polygon": [ + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", + "default": "1d", + "optional": true + }, + { + "name": "adjustment", + "type": "Literal['splits_only', 'unadjusted']", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", + "optional": true + }, + { + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": false, + "optional": true + }, + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", + "default": "asc", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 49999, + "optional": true + } + ], + "tiingo": [ + { + "name": "interval", + "type": "Literal['1d', '1W', '1M', '1Y']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ], + "yfinance": [ + { + "name": "interval", + "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": false, + "optional": true + }, + { + "name": "include_actions", + "type": "bool", + "description": "Include dividends and stock splits in results.", + "default": true, + "optional": true + }, + { + "name": "adjustment", + "type": "Literal['splits_only', 'splits_and_dividends']", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", + "optional": true + }, + { + "name": "adjusted", + "type": "bool", + "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead.", + "default": false, + "optional": true + }, + { + "name": "prepost", + "type": "bool", + "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfHistorical]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "Union[int, float]", + "description": "The trading volume.", + "default": null, + "optional": true + }, + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": null, + "optional": true + }, + { + "name": "unadjusted_volume", + "type": "float", + "description": "Unadjusted volume of the symbol.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "Change in the price from the previous close.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in the price from the previous close, as a normalized percent.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "average", + "type": "float", + "description": "Average trade price of an individual equity during the interval.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "Change in the price of the symbol from the previous day.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Percent change in the price of the symbol from the previous day.", + "default": null, + "optional": true + }, + { + "name": "adj_open", + "type": "float", + "description": "The adjusted open price.", + "default": null, + "optional": true + }, + { + "name": "adj_high", + "type": "float", + "description": "The adjusted high price.", + "default": null, + "optional": true + }, + { + "name": "adj_low", + "type": "float", + "description": "The adjusted low price.", + "default": null, + "optional": true + }, + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": null, + "optional": true + }, + { + "name": "adj_volume", + "type": "float", + "description": "The adjusted volume.", + "default": null, + "optional": true + }, + { + "name": "fifty_two_week_high", + "type": "float", + "description": "52 week high price for the symbol.", + "default": null, + "optional": true + }, + { + "name": "fifty_two_week_low", + "type": "float", + "description": "52 week low price for the symbol.", + "default": null, + "optional": true + }, + { + "name": "factor", + "type": "float", + "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices.", + "default": null, + "optional": true + }, + { + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", + "default": null, + "optional": true + }, + { + "name": "dividend", + "type": "float", + "description": "Dividend amount, if a dividend was paid.", + "default": null, + "optional": true + }, + { + "name": "close_time", + "type": "datetime", + "description": "The timestamp that represents the end of the interval span.", + "default": null, + "optional": true + }, + { + "name": "interval", + "type": "str", + "description": "The data time frequency.", + "default": null, + "optional": true + }, + { + "name": "intra_period", + "type": "bool", + "description": "If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "transactions", + "type": "Annotated[int, Gt(gt=0)]", + "description": "Number of transactions for the symbol in the time period.", + "default": null, + "optional": true + } + ], + "tiingo": [ + { + "name": "adj_open", + "type": "float", + "description": "The adjusted open price.", + "default": null, + "optional": true + }, + { + "name": "adj_high", + "type": "float", + "description": "The adjusted high price.", + "default": null, + "optional": true + }, + { + "name": "adj_low", + "type": "float", + "description": "The adjusted low price.", + "default": null, + "optional": true + }, + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": null, + "optional": true + }, + { + "name": "adj_volume", + "type": "float", + "description": "The adjusted volume.", + "default": null, + "optional": true + }, + { + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", + "default": null, + "optional": true + }, + { + "name": "dividend", + "type": "float", + "description": "Dividend amount, if a dividend was paid.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", + "default": null, + "optional": true + }, + { + "name": "dividend", + "type": "float", + "description": "Dividend amount (split-adjusted), if a dividend was paid.", + "default": null, + "optional": true + } + ] + }, + "model": "EtfHistorical" + }, + "/etf/info": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "ETF Information Overview.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.info(symbol='SPY', provider='fmp')\n# This function accepts multiple tickers.\nobb.etf.info(symbol='SPY,IWM,QQQ,DJIA', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, intrinio, yfinance.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [], + "intrinio": [], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfInfo]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. (ETF)", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the ETF.", + "default": "", + "optional": false + }, + { + "name": "description", + "type": "str", + "description": "Description of the fund.", + "default": null, + "optional": true + }, + { + "name": "inception_date", + "type": "str", + "description": "Inception date of the ETF.", + "default": "", + "optional": false + } + ], + "fmp": [ + { + "name": "issuer", + "type": "str", + "description": "Company of the ETF.", + "default": null, + "optional": true + }, + { + "name": "cusip", + "type": "str", + "description": "CUSIP of the ETF.", + "default": null, + "optional": true + }, + { + "name": "isin", + "type": "str", + "description": "ISIN of the ETF.", + "default": null, + "optional": true + }, + { + "name": "domicile", + "type": "str", + "description": "Domicile of the ETF.", + "default": null, + "optional": true + }, + { + "name": "asset_class", + "type": "str", + "description": "Asset class of the ETF.", + "default": null, + "optional": true + }, + { + "name": "aum", + "type": "float", + "description": "Assets under management.", + "default": null, + "optional": true + }, + { + "name": "nav", + "type": "float", + "description": "Net asset value of the ETF.", + "default": null, + "optional": true + }, + { + "name": "nav_currency", + "type": "str", + "description": "Currency of the ETF's net asset value.", + "default": null, + "optional": true + }, + { + "name": "expense_ratio", + "type": "float", + "description": "The expense ratio, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "holdings_count", + "type": "int", + "description": "Number of holdings.", + "default": null, + "optional": true + }, + { + "name": "avg_volume", + "type": "float", + "description": "Average daily trading volume.", + "default": null, + "optional": true + }, + { + "name": "website", + "type": "str", + "description": "Website of the issuer.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "fund_listing_date", + "type": "date", + "description": "The date on which the Exchange Traded Product (ETP) or share class of the ETP is listed on a specific exchange.", + "default": null, + "optional": true + }, + { + "name": "data_change_date", + "type": "date", + "description": "The last date on which there was a change in a classifications data field for this ETF.", + "default": null, + "optional": true + }, + { + "name": "etn_maturity_date", + "type": "date", + "description": "If the product is an ETN, this field identifies the maturity date for the ETN.", + "default": null, + "optional": true + }, + { + "name": "is_listed", + "type": "bool", + "description": "If true, the ETF is still listed on an exchange.", + "default": null, + "optional": true + }, + { + "name": "close_date", + "type": "date", + "description": "The date on which the ETF was de-listed if it is no longer listed.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "The exchange Market Identifier Code (MIC).", + "default": null, + "optional": true + }, + { + "name": "isin", + "type": "str", + "description": "International Securities Identification Number (ISIN).", + "default": null, + "optional": true + }, + { + "name": "ric", + "type": "str", + "description": "Reuters Instrument Code (RIC).", + "default": null, + "optional": true + }, + { + "name": "sedol", + "type": "str", + "description": "Stock Exchange Daily Official List (SEDOL).", + "default": null, + "optional": true + }, + { + "name": "figi_symbol", + "type": "str", + "description": "Financial Instrument Global Identifier (FIGI) symbol.", + "default": null, + "optional": true + }, + { + "name": "share_class_figi", + "type": "str", + "description": "Financial Instrument Global Identifier (FIGI).", + "default": null, + "optional": true + }, + { + "name": "firstbridge_id", + "type": "str", + "description": "The FirstBridge unique identifier for the Exchange Traded Fund (ETF).", + "default": null, + "optional": true + }, + { + "name": "firstbridge_parent_id", + "type": "str", + "description": "The FirstBridge unique identifier for the parent Exchange Traded Fund (ETF), if applicable.", + "default": null, + "optional": true + }, + { + "name": "intrinio_id", + "type": "str", + "description": "Intrinio unique identifier for the security.", + "default": null, + "optional": true + }, + { + "name": "intraday_nav_symbol", + "type": "str", + "description": "Intraday Net Asset Value (NAV) symbol.", + "default": null, + "optional": true + }, + { + "name": "primary_symbol", + "type": "str", + "description": "The primary ticker field is used for Exchange Traded Products (ETPs) that have multiple listings and share classes. If an ETP has multiple listings or share classes, the same primary ticker is assigned to all the listings and share classes.", + "default": null, + "optional": true + }, + { + "name": "etp_structure_type", + "type": "str", + "description": "Classifies Exchange Traded Products (ETPs) into very broad categories based on its legal structure.", + "default": null, + "optional": true + }, + { + "name": "legal_structure", + "type": "str", + "description": "Legal structure of the fund.", + "default": null, + "optional": true + }, + { + "name": "issuer", + "type": "str", + "description": "Issuer of the ETF.", + "default": null, + "optional": true + }, + { + "name": "etn_issuing_bank", + "type": "str", + "description": "If the product is an Exchange Traded Note (ETN), this field identifies the issuing bank.", + "default": null, + "optional": true + }, + { + "name": "fund_family", + "type": "str", + "description": "This field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor.", + "default": null, + "optional": true + }, + { + "name": "investment_style", + "type": "str", + "description": "Investment style of the ETF.", + "default": null, + "optional": true + }, + { + "name": "derivatives_based", + "type": "str", + "description": "This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio.", + "default": null, + "optional": true + }, + { + "name": "income_category", + "type": "str", + "description": "Identifies if an Exchange Traded Fund (ETF) falls into a category that is specifically designed to provide a high yield or income", + "default": null, + "optional": true + }, + { + "name": "asset_class", + "type": "str", + "description": "Captures the underlying nature of the securities in the Exchanged Traded Product (ETP).", + "default": null, + "optional": true + }, + { + "name": "other_asset_types", + "type": "str", + "description": "If 'asset_class' field is classified as 'Other Asset Types' this field captures the specific category of the underlying assets.", + "default": null, + "optional": true + }, + { + "name": "single_category_designation", + "type": "str", + "description": "This categorization is created for those users who want every ETF to be 'forced' into a single bucket, so that the assets for all categories will always sum to the total market.", + "default": null, + "optional": true + }, + { + "name": "beta_type", + "type": "str", + "description": "This field identifies whether an ETF provides 'Traditional' beta exposure or 'Smart' beta exposure. ETFs that are active (i.e. non-indexed), leveraged / inverse or have a proprietary quant model (i.e. that don't provide indexed exposure to a targeted factor) are classified separately.", + "default": null, + "optional": true + }, + { + "name": "beta_details", + "type": "str", + "description": "This field provides further detail within the traditional and smart beta categories.", + "default": null, + "optional": true + }, + { + "name": "market_cap_range", + "type": "str", + "description": "Equity ETFs are classified as falling into categories based on the description of their investment strategy in the prospectus. Examples ('Mega Cap', 'Large Cap', 'Mid Cap', etc.)", + "default": null, + "optional": true + }, + { + "name": "market_cap_weighting_type", + "type": "str", + "description": "For ETFs that take the value 'Market Cap Weighted' in the 'index_weighting_scheme' field, this field provides detail on the market cap weighting type.", + "default": null, + "optional": true + }, + { + "name": "index_weighting_scheme", + "type": "str", + "description": "For ETFs that track an underlying index, this field provides detail on the index weighting type.", + "default": null, + "optional": true + }, + { + "name": "index_linked", + "type": "str", + "description": "This field identifies whether an ETF is index linked or active.", + "default": null, + "optional": true + }, + { + "name": "index_name", + "type": "str", + "description": "This field identifies the name of the underlying index tracked by the ETF, if applicable.", + "default": null, + "optional": true + }, + { + "name": "index_symbol", + "type": "str", + "description": "This field identifies the OpenFIGI ticker for the Index underlying the ETF.", + "default": null, + "optional": true + }, + { + "name": "parent_index", + "type": "str", + "description": "This field identifies the name of the parent index, which represents the broader universe from which the index underlying the ETF is created, if applicable.", + "default": null, + "optional": true + }, + { + "name": "index_family", + "type": "str", + "description": "This field identifies the index family to which the index underlying the ETF belongs. The index family is represented as categorized by the index provider.", + "default": null, + "optional": true + }, + { + "name": "broader_index_family", + "type": "str", + "description": "This field identifies the broader index family to which the index underlying the ETF belongs. The broader index family is represented as categorized by the index provider.", + "default": null, + "optional": true + }, + { + "name": "index_provider", + "type": "str", + "description": "This field identifies the Index provider for the index underlying the ETF, if applicable.", + "default": null, + "optional": true + }, + { + "name": "index_provider_code", + "type": "str", + "description": "This field provides the First Bridge code for each Index provider, corresponding to the index underlying the ETF if applicable.", + "default": null, + "optional": true + }, + { + "name": "replication_structure", + "type": "str", + "description": "The replication structure of the Exchange Traded Product (ETP).", + "default": null, + "optional": true + }, + { + "name": "growth_value_tilt", + "type": "str", + "description": "Classifies equity ETFs as either 'Growth' or Value' based on the stated style tilt in the ETF prospectus. Equity ETFs that do not have a stated style tilt are classified as 'Core / Blend'.", + "default": null, + "optional": true + }, + { + "name": "growth_type", + "type": "str", + "description": "For ETFs that are classified as 'Growth' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their growth (style factor) scores.", + "default": null, + "optional": true + }, + { + "name": "value_type", + "type": "str", + "description": "For ETFs that are classified as 'Value' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their value (style factor) scores.", + "default": null, + "optional": true + }, + { + "name": "sector", + "type": "str", + "description": "For equity ETFs that aim to provide targeted exposure to a sector or industry, this field identifies the Sector that it provides the exposure to.", + "default": null, + "optional": true + }, + { + "name": "industry", + "type": "str", + "description": "For equity ETFs that aim to provide targeted exposure to an industry, this field identifies the Industry that it provides the exposure to.", + "default": null, + "optional": true + }, + { + "name": "industry_group", + "type": "str", + "description": "For equity ETFs that aim to provide targeted exposure to a sub-industry, this field identifies the sub-Industry that it provides the exposure to.", + "default": null, + "optional": true + }, + { + "name": "cross_sector_theme", + "type": "str", + "description": "For equity ETFs that aim to provide targeted exposure to a specific investment theme that cuts across GICS sectors, this field identifies the specific cross-sector theme. Examples ('Agri-business', 'Natural Resources', 'Green Investing', etc.)", + "default": null, + "optional": true + }, + { + "name": "natural_resources_type", + "type": "str", + "description": "For ETFs that are classified as 'Natural Resources' in the 'cross_sector_theme' field, this field provides further detail on the type of Natural Resources exposure.", + "default": null, + "optional": true + }, + { + "name": "us_or_excludes_us", + "type": "str", + "description": "Takes the value of 'Domestic' for US exposure, 'International' for non-US exposure and 'Global' for exposure that includes all regions including the US.", + "default": null, + "optional": true + }, + { + "name": "developed_emerging", + "type": "str", + "description": "This field identifies the stage of development of the markets that the ETF provides exposure to.", + "default": null, + "optional": true + }, + { + "name": "specialized_region", + "type": "str", + "description": "This field is populated if the ETF provides targeted exposure to a specific type of geography-based grouping that does not fall into a specific country or continent grouping. Examples ('BRIC', 'Chindia', etc.)", + "default": null, + "optional": true + }, + { + "name": "continent", + "type": "str", + "description": "This field is populated if the ETF provides targeted exposure to a specific continent or country within that Continent.", + "default": null, + "optional": true + }, + { + "name": "latin_america_sub_group", + "type": "str", + "description": "For ETFs that are classified as 'Latin America' in the 'continent' field, this field provides further detail on the type of regional exposure.", + "default": null, + "optional": true + }, + { + "name": "europe_sub_group", + "type": "str", + "description": "For ETFs that are classified as 'Europe' in the 'continent' field, this field provides further detail on the type of regional exposure.", + "default": null, + "optional": true + }, + { + "name": "asia_sub_group", + "type": "str", + "description": "For ETFs that are classified as 'Asia' in the 'continent' field, this field provides further detail on the type of regional exposure.", + "default": null, + "optional": true + }, + { + "name": "specific_country", + "type": "str", + "description": "This field is populated if the ETF provides targeted exposure to a specific country.", + "default": null, + "optional": true + }, + { + "name": "china_listing_location", + "type": "str", + "description": "For ETFs that are classified as 'China' in the 'country' field, this field provides further detail on the type of exposure in the underlying securities.", + "default": null, + "optional": true + }, + { + "name": "us_state", + "type": "str", + "description": "Takes the value of a US state if the ETF provides targeted exposure to the municipal bonds or equities of companies.", + "default": null, + "optional": true + }, + { + "name": "real_estate", + "type": "str", + "description": "For ETFs that provide targeted real estate exposure, this field is populated if the ETF provides targeted exposure to a specific segment of the real estate market.", + "default": null, + "optional": true + }, + { + "name": "fundamental_weighting_type", + "type": "str", + "description": "For ETFs that take the value 'Fundamental Weighted' in the 'index_weighting_scheme' field, this field provides detail on the fundamental weighting methodology.", + "default": null, + "optional": true + }, + { + "name": "dividend_weighting_type", + "type": "str", + "description": "For ETFs that take the value 'Dividend Weighted' in the 'index_weighting_scheme' field, this field provides detail on the dividend weighting methodology.", + "default": null, + "optional": true + }, + { + "name": "bond_type", + "type": "str", + "description": "For ETFs where 'asset_class_type' is 'Bonds', this field provides detail on the type of bonds held in the ETF.", + "default": null, + "optional": true + }, + { + "name": "government_bond_types", + "type": "str", + "description": "For bond ETFs that take the value 'Treasury & Government' in 'bond_type', this field provides detail on the exposure.", + "default": null, + "optional": true + }, + { + "name": "municipal_bond_region", + "type": "str", + "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field provides additional detail on the geographic exposure.", + "default": null, + "optional": true + }, + { + "name": "municipal_vrdo", + "type": "bool", + "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field identifies those ETFs that specifically provide exposure to Variable Rate Demand Obligations.", + "default": null, + "optional": true + }, + { + "name": "mortgage_bond_types", + "type": "str", + "description": "For bond ETFs that take the value 'Mortgage' in 'bond_type', this field provides additional detail on the type of underlying securities.", + "default": null, + "optional": true + }, + { + "name": "bond_tax_status", + "type": "str", + "description": "For all US bond ETFs, this field provides additional detail on the tax treatment of the underlying securities.", + "default": null, + "optional": true + }, + { + "name": "credit_quality", + "type": "str", + "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific credit quality range.", + "default": null, + "optional": true + }, + { + "name": "average_maturity", + "type": "str", + "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific maturity range.", + "default": null, + "optional": true + }, + { + "name": "specific_maturity_year", + "type": "int", + "description": "For all bond ETFs that take the value 'Specific Maturity Year' in the 'average_maturity' field, this field specifies the calendar year.", + "default": null, + "optional": true + }, + { + "name": "commodity_types", + "type": "str", + "description": "For ETFs where 'asset_class_type' is 'Commodities', this field provides detail on the type of commodities held in the ETF.", + "default": null, + "optional": true + }, + { + "name": "energy_type", + "type": "str", + "description": "For ETFs where 'commodity_type' is 'Energy', this field provides detail on the type of energy exposure provided by the ETF.", + "default": null, + "optional": true + }, + { + "name": "agricultural_type", + "type": "str", + "description": "For ETFs where 'commodity_type' is 'Agricultural', this field provides detail on the type of agricultural exposure provided by the ETF.", + "default": null, + "optional": true + }, + { + "name": "livestock_type", + "type": "str", + "description": "For ETFs where 'commodity_type' is 'Livestock', this field provides detail on the type of livestock exposure provided by the ETF.", + "default": null, + "optional": true + }, + { + "name": "metal_type", + "type": "str", + "description": "For ETFs where 'commodity_type' is 'Gold & Metals', this field provides detail on the type of exposure provided by the ETF.", + "default": null, + "optional": true + }, + { + "name": "inverse_leveraged", + "type": "str", + "description": "This field is populated if the ETF provides inverse or leveraged exposure.", + "default": null, + "optional": true + }, + { + "name": "target_date_multi_asset_type", + "type": "str", + "description": "For ETFs where 'asset_class_type' is 'Target Date / MultiAsset', this field provides detail on the type of commodities held in the ETF.", + "default": null, + "optional": true + }, + { + "name": "currency_pair", + "type": "str", + "description": "This field is populated if the ETF's strategy involves providing exposure to the movements of a currency or involves hedging currency exposure.", + "default": null, + "optional": true + }, + { + "name": "social_environmental_type", + "type": "str", + "description": "This field is populated if the ETF's strategy involves providing exposure to a specific social or environmental theme.", + "default": null, + "optional": true + }, + { + "name": "clean_energy_type", + "type": "str", + "description": "This field is populated if the ETF has a value of 'Clean Energy' in the 'social_environmental_type' field.", + "default": null, + "optional": true + }, + { + "name": "dividend_type", + "type": "str", + "description": "This field is populated if the ETF has an intended investment objective of holding dividend-oriented stocks as stated in the prospectus.", + "default": null, + "optional": true + }, + { + "name": "regular_dividend_payor_type", + "type": "str", + "description": "This field is populated if the ETF has a value of'Dividend - Regular Payors' in the 'dividend_type' field.", + "default": null, + "optional": true + }, + { + "name": "quant_strategies_type", + "type": "str", + "description": "This field is populated if the ETF has either an index-linked or active strategy that is based on a proprietary quantitative strategy.", + "default": null, + "optional": true + }, + { + "name": "other_quant_models", + "type": "str", + "description": "For ETFs where 'quant_strategies_type' is 'Other Quant Model', this field provides the name of the specific proprietary quant model used as the underlying strategy for the ETF.", + "default": null, + "optional": true + }, + { + "name": "hedge_fund_type", + "type": "str", + "description": "For ETFs where 'other_asset_types' is 'Hedge Fund Replication', this field provides detail on the type of hedge fund replication strategy.", + "default": null, + "optional": true + }, + { + "name": "excludes_financials", + "type": "bool", + "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold financials stocks, based on the funds intended objective.", + "default": null, + "optional": true + }, + { + "name": "excludes_technology", + "type": "bool", + "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold technology stocks, based on the funds intended objective.", + "default": null, + "optional": true + }, + { + "name": "holds_only_nyse_stocks", + "type": "bool", + "description": "If true, the ETF is an equity ETF and holds only stocks listed on NYSE.", + "default": null, + "optional": true + }, + { + "name": "holds_only_nasdaq_stocks", + "type": "bool", + "description": "If true, the ETF is an equity ETF and holds only stocks listed on Nasdaq.", + "default": null, + "optional": true + }, + { + "name": "holds_mlp", + "type": "bool", + "description": "If true, the ETF's investment objective explicitly specifies that it holds MLPs as an intended part of its investment strategy.", + "default": null, + "optional": true + }, + { + "name": "holds_preferred_stock", + "type": "bool", + "description": "If true, the ETF's investment objective explicitly specifies that it holds preferred stock as an intended part of its investment strategy.", + "default": null, + "optional": true + }, + { + "name": "holds_closed_end_funds", + "type": "bool", + "description": "If true, the ETF's investment objective explicitly specifies that it holds closed end funds as an intended part of its investment strategy.", + "default": null, + "optional": true + }, + { + "name": "holds_adr", + "type": "bool", + "description": "If true, he ETF's investment objective explicitly specifies that it holds American Depositary Receipts (ADRs) as an intended part of its investment strategy.", + "default": null, + "optional": true + }, + { + "name": "laddered", + "type": "bool", + "description": "For bond ETFs, this field identifies those ETFs that specifically hold bonds in a laddered structure, where the bonds are scheduled to mature in an annual, sequential structure.", + "default": null, + "optional": true + }, + { + "name": "zero_coupon", + "type": "bool", + "description": "For bond ETFs, this field identifies those ETFs that specifically hold zero coupon Treasury Bills.", + "default": null, + "optional": true + }, + { + "name": "floating_rate", + "type": "bool", + "description": "For bond ETFs, this field identifies those ETFs that specifically hold floating rate bonds.", + "default": null, + "optional": true + }, + { + "name": "build_america_bonds", + "type": "bool", + "description": "For municipal bond ETFs, this field identifies those ETFs that specifically hold Build America Bonds.", + "default": null, + "optional": true + }, + { + "name": "dynamic_futures_roll", + "type": "bool", + "description": "If the product holds futures contracts, this field identifies those products where the roll strategy is dynamic (rather than entirely rules based), so as to minimize roll costs.", + "default": null, + "optional": true + }, + { + "name": "currency_hedged", + "type": "bool", + "description": "This field is populated if the ETF's strategy involves hedging currency exposure.", + "default": null, + "optional": true + }, + { + "name": "includes_short_exposure", + "type": "bool", + "description": "This field is populated if the ETF has short exposure in any of its holdings e.g. in a long/short or inverse ETF.", + "default": null, + "optional": true + }, + { + "name": "ucits", + "type": "bool", + "description": "If true, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant", + "default": null, + "optional": true + }, + { + "name": "registered_countries", + "type": "str", + "description": "The list of countries where the ETF is legally registered for sale. This may differ from where the ETF is domiciled or traded, particularly in Europe.", + "default": null, + "optional": true + }, + { + "name": "issuer_country", + "type": "str", + "description": "2 letter ISO country code for the country where the issuer is located.", + "default": null, + "optional": true + }, + { + "name": "domicile", + "type": "str", + "description": "2 letter ISO country code for the country where the ETP is domiciled.", + "default": null, + "optional": true + }, + { + "name": "listing_country", + "type": "str", + "description": "2 letter ISO country code for the country of the primary listing.", + "default": null, + "optional": true + }, + { + "name": "listing_region", + "type": "str", + "description": "Geographic region in the country of the primary listing falls.", + "default": null, + "optional": true + }, + { + "name": "bond_currency_denomination", + "type": "str", + "description": "For all bond ETFs, this field provides additional detail on the currency denomination of the underlying securities.", + "default": null, + "optional": true + }, + { + "name": "base_currency", + "type": "str", + "description": "Base currency in which NAV is reported.", + "default": null, + "optional": true + }, + { + "name": "listing_currency", + "type": "str", + "description": "Listing currency of the Exchange Traded Product (ETP) in which it is traded. Reported using the 3-digit ISO currency code.", + "default": null, + "optional": true + }, + { + "name": "number_of_holdings", + "type": "int", + "description": "The number of holdings in the ETF.", + "default": null, + "optional": true + }, + { + "name": "month_end_assets", + "type": "float", + "description": "Net assets in millions of dollars as of the most recent month end.", + "default": null, + "optional": true + }, + { + "name": "net_expense_ratio", + "type": "float", + "description": "Gross expense net of Fee Waivers, as a percentage of net assets as published by the ETF issuer.", + "default": null, + "optional": true + }, + { + "name": "etf_portfolio_turnover", + "type": "float", + "description": "The percentage of positions turned over in the last 12 months.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "fund_type", + "type": "str", + "description": "The legal type of fund.", + "default": null, + "optional": true + }, + { + "name": "fund_family", + "type": "str", + "description": "The fund family.", + "default": null, + "optional": true + }, + { + "name": "category", + "type": "str", + "description": "The fund category.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "The exchange the fund is listed on.", + "default": null, + "optional": true + }, + { + "name": "exchange_timezone", + "type": "str", + "description": "The timezone of the exchange.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "The currency in which the fund is listed.", + "default": null, + "optional": true + }, + { + "name": "nav_price", + "type": "float", + "description": "The net asset value per unit of the fund.", + "default": null, + "optional": true + }, + { + "name": "total_assets", + "type": "int", + "description": "The total value of assets held by the fund.", + "default": null, + "optional": true + }, + { + "name": "trailing_pe", + "type": "float", + "description": "The trailing twelve month P/E ratio of the fund's assets.", + "default": null, + "optional": true + }, + { + "name": "dividend_yield", + "type": "float", + "description": "The dividend yield of the fund, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "dividend_rate_ttm", + "type": "float", + "description": "The trailing twelve month annual dividend rate of the fund, in currency units.", + "default": null, + "optional": true + }, + { + "name": "dividend_yield_ttm", + "type": "float", + "description": "The trailing twelve month annual dividend yield of the fund, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "year_high", + "type": "float", + "description": "The fifty-two week high price.", + "default": null, + "optional": true + }, + { + "name": "year_low", + "type": "float", + "description": "The fifty-two week low price.", + "default": null, + "optional": true + }, + { + "name": "ma_50d", + "type": "float", + "description": "50-day moving average price.", + "default": null, + "optional": true + }, + { + "name": "ma_200d", + "type": "float", + "description": "200-day moving average price.", + "default": null, + "optional": true + }, + { + "name": "return_ytd", + "type": "float", + "description": "The year-to-date return of the fund, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "return_3y_avg", + "type": "float", + "description": "The three year average return of the fund, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "return_5y_avg", + "type": "float", + "description": "The five year average return of the fund, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "beta_3y_avg", + "type": "float", + "description": "The three year average beta of the fund.", + "default": null, + "optional": true + }, + { + "name": "volume_avg", + "type": "float", + "description": "The average daily trading volume of the fund.", + "default": null, + "optional": true + }, + { + "name": "volume_avg_10d", + "type": "float", + "description": "The average daily trading volume of the fund over the past ten days.", + "default": null, + "optional": true + }, + { + "name": "bid", + "type": "float", + "description": "The current bid price.", + "default": null, + "optional": true + }, + { + "name": "bid_size", + "type": "float", + "description": "The current bid size.", + "default": null, + "optional": true + }, + { + "name": "ask", + "type": "float", + "description": "The current ask price.", + "default": null, + "optional": true + }, + { + "name": "ask_size", + "type": "float", + "description": "The current ask size.", + "default": null, + "optional": true + }, + { + "name": "open", + "type": "float", + "description": "The open price of the most recent trading session.", + "default": null, + "optional": true + }, + { + "name": "high", + "type": "float", + "description": "The highest price of the most recent trading session.", + "default": null, + "optional": true + }, + { + "name": "low", + "type": "float", + "description": "The lowest price of the most recent trading session.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume of the most recent trading session.", + "default": null, + "optional": true + }, + { + "name": "prev_close", + "type": "float", + "description": "The previous closing price.", + "default": null, + "optional": true + } + ] + }, + "model": "EtfInfo" + }, + "/etf/sectors": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "ETF Sector weighting.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.sectors(symbol='SPY', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfSectors]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "sector", + "type": "str", + "description": "Sector of exposure.", + "default": "", + "optional": false + }, + { + "name": "weight", + "type": "float", + "description": "Exposure of the ETF to the sector in normalized percentage points.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "EtfSectors" + }, + "/etf/countries": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "ETF Country weighting.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.countries(symbol='VT', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfCountries]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "country", + "type": "str", + "description": "The country of the exposure. Corresponding values are normalized percentage points.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "EtfCountries" + }, + "/etf/price_performance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Price performance as a return, over different periods.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.price_performance(symbol='QQQ', provider='fmp')\nobb.etf.price_performance(symbol='SPY,QQQ,IWM,DJIA', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [], + "intrinio": [ + { + "name": "return_type", + "type": "Literal['trailing', 'calendar']", + "description": "The type of returns to return, a trailing or calendar window.", + "default": "trailing", + "optional": true + }, + { + "name": "adjustment", + "type": "Literal['splits_only', 'splits_and_dividends']", + "description": "The adjustment factor, 'splits_only' will return pure price performance.", + "default": "splits_and_dividends", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfPricePerformance]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "one_day", + "type": "float", + "description": "One-day return.", + "default": null, + "optional": true + }, + { + "name": "wtd", + "type": "float", + "description": "Week to date return.", + "default": null, + "optional": true + }, + { + "name": "one_week", + "type": "float", + "description": "One-week return.", + "default": null, + "optional": true + }, + { + "name": "mtd", + "type": "float", + "description": "Month to date return.", + "default": null, + "optional": true + }, + { + "name": "one_month", + "type": "float", + "description": "One-month return.", + "default": null, + "optional": true + }, + { + "name": "qtd", + "type": "float", + "description": "Quarter to date return.", + "default": null, + "optional": true + }, + { + "name": "three_month", + "type": "float", + "description": "Three-month return.", + "default": null, + "optional": true + }, + { + "name": "six_month", + "type": "float", + "description": "Six-month return.", + "default": null, + "optional": true + }, + { + "name": "ytd", + "type": "float", + "description": "Year to date return.", + "default": null, + "optional": true + }, + { + "name": "one_year", + "type": "float", + "description": "One-year return.", + "default": null, + "optional": true + }, + { + "name": "two_year", + "type": "float", + "description": "Two-year return.", + "default": null, + "optional": true + }, + { + "name": "three_year", + "type": "float", + "description": "Three-year return.", + "default": null, + "optional": true + }, + { + "name": "four_year", + "type": "float", + "description": "Four-year", + "default": null, + "optional": true + }, + { + "name": "five_year", + "type": "float", + "description": "Five-year return.", + "default": null, + "optional": true + }, + { + "name": "ten_year", + "type": "float", + "description": "Ten-year return.", + "default": null, + "optional": true + }, + { + "name": "max", + "type": "float", + "description": "Return from the beginning of the time series.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": "", + "optional": false + } + ], + "intrinio": [ + { + "name": "max_annualized", + "type": "float", + "description": "Annualized rate of return from inception.", + "default": null, + "optional": true + }, + { + "name": "volatility_one_year", + "type": "float", + "description": "Trailing one-year annualized volatility.", + "default": null, + "optional": true + }, + { + "name": "volatility_three_year", + "type": "float", + "description": "Trailing three-year annualized volatility.", + "default": null, + "optional": true + }, + { + "name": "volatility_five_year", + "type": "float", + "description": "Trailing five-year annualized volatility.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": null, + "optional": true + }, + { + "name": "volume_avg_30", + "type": "float", + "description": "The one-month average daily volume.", + "default": null, + "optional": true + }, + { + "name": "volume_avg_90", + "type": "float", + "description": "The three-month average daily volume.", + "default": null, + "optional": true + }, + { + "name": "volume_avg_180", + "type": "float", + "description": "The six-month average daily volume.", + "default": null, + "optional": true + }, + { + "name": "beta", + "type": "float", + "description": "Beta compared to the S&P 500.", + "default": null, + "optional": true + }, + { + "name": "nav", + "type": "float", + "description": "Net asset value per share.", + "default": null, + "optional": true + }, + { + "name": "year_high", + "type": "float", + "description": "The 52-week high price.", + "default": null, + "optional": true + }, + { + "name": "year_low", + "type": "float", + "description": "The 52-week low price.", + "default": null, + "optional": true + }, + { + "name": "market_cap", + "type": "float", + "description": "The market capitalization.", + "default": null, + "optional": true + }, + { + "name": "shares_outstanding", + "type": "int", + "description": "The number of shares outstanding.", + "default": null, + "optional": true + }, + { + "name": "updated", + "type": "date", + "description": "The date of the data.", + "default": null, + "optional": true + } + ] + }, + "model": "EtfPricePerformance" + }, + "/etf/holdings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the holdings for an individual ETF.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings(symbol='XLK', provider='fmp')\n# Including a date (FMP, SEC) will return the holdings as per NPORT-P filings.\nobb.etf.holdings(symbol='XLK', date=2022-03-31, provider='fmp')\n# The same data can be returned from the SEC directly.\nobb.etf.holdings(symbol='XLK', date=2022-03-31, provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'sec']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "date", + "type": "Union[Union[str, date], str]", + "description": "A specific date to get data for. Entering a date will attempt to return the NPORT-P filing for the entered date. This needs to be _exactly_ the date of the filing. Use the holdings_date command/endpoint to find available filing dates for the ETF.", + "default": null, + "optional": true + }, + { + "name": "cik", + "type": "str", + "description": "The CIK of the filing entity. Overrides symbol.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": null, + "optional": true + } + ], + "sec": [ + { + "name": "date", + "type": "Union[Union[str, date], str]", + "description": "A specific date to get data for. The date represents the period ending. The date entered will return the closest filing.", + "default": null, + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache for the request.", + "default": true, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfHoldings]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'sec']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. (ETF)", + "default": null, + "optional": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the ETF holding.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "lei", + "type": "str", + "description": "The LEI of the holding.", + "default": null, + "optional": true + }, + { + "name": "title", + "type": "str", + "description": "The title of the holding.", + "default": null, + "optional": true + }, + { + "name": "cusip", + "type": "str", + "description": "The CUSIP of the holding.", + "default": null, + "optional": true + }, + { + "name": "isin", + "type": "str", + "description": "The ISIN of the holding.", + "default": null, + "optional": true + }, + { + "name": "balance", + "type": "int", + "description": "The balance of the holding, in shares or units.", + "default": null, + "optional": true + }, + { + "name": "units", + "type": "Union[str, float]", + "description": "The type of units.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "The currency of the holding.", + "default": null, + "optional": true + }, + { + "name": "value", + "type": "float", + "description": "The value of the holding, in dollars.", + "default": null, + "optional": true + }, + { + "name": "weight", + "type": "float", + "description": "The weight of the holding, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "payoff_profile", + "type": "str", + "description": "The payoff profile of the holding.", + "default": null, + "optional": true + }, + { + "name": "asset_category", + "type": "str", + "description": "The asset category of the holding.", + "default": null, + "optional": true + }, + { + "name": "issuer_category", + "type": "str", + "description": "The issuer category of the holding.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "The country of the holding.", + "default": null, + "optional": true + }, + { + "name": "is_restricted", + "type": "str", + "description": "Whether the holding is restricted.", + "default": null, + "optional": true + }, + { + "name": "fair_value_level", + "type": "int", + "description": "The fair value level of the holding.", + "default": null, + "optional": true + }, + { + "name": "is_cash_collateral", + "type": "str", + "description": "Whether the holding is cash collateral.", + "default": null, + "optional": true + }, + { + "name": "is_non_cash_collateral", + "type": "str", + "description": "Whether the holding is non-cash collateral.", + "default": null, + "optional": true + }, + { + "name": "is_loan_by_fund", + "type": "str", + "description": "Whether the holding is loan by fund.", + "default": null, + "optional": true + }, + { + "name": "cik", + "type": "str", + "description": "The CIK of the filing.", + "default": null, + "optional": true + }, + { + "name": "acceptance_datetime", + "type": "str", + "description": "The acceptance datetime of the filing.", + "default": null, + "optional": true + }, + { + "name": "updated", + "type": "Union[date, datetime]", + "description": "The date the data was updated.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "name", + "type": "str", + "description": "The common name for the holding.", + "default": null, + "optional": true + }, + { + "name": "security_type", + "type": "str", + "description": "The type of instrument for this holding. Examples(Bond='BOND', Equity='EQUI')", + "default": null, + "optional": true + }, + { + "name": "isin", + "type": "str", + "description": "The International Securities Identification Number.", + "default": null, + "optional": true + }, + { + "name": "ric", + "type": "str", + "description": "The Reuters Instrument Code.", + "default": null, + "optional": true + }, + { + "name": "sedol", + "type": "str", + "description": "The Stock Exchange Daily Official List.", + "default": null, + "optional": true + }, + { + "name": "share_class_figi", + "type": "str", + "description": "The OpenFIGI symbol for the holding.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "The country or region of the holding.", + "default": null, + "optional": true + }, + { + "name": "maturity_date", + "type": "date", + "description": "The maturity date for the debt security, if available.", + "default": null, + "optional": true + }, + { + "name": "contract_expiry_date", + "type": "date", + "description": "Expiry date for the futures contract held, if available.", + "default": null, + "optional": true + }, + { + "name": "coupon", + "type": "float", + "description": "The coupon rate of the debt security, if available.", + "default": null, + "optional": true + }, + { + "name": "balance", + "type": "Union[int, float]", + "description": "The number of units of the security held, if available.", + "default": null, + "optional": true + }, + { + "name": "unit", + "type": "str", + "description": "The units of the 'balance' field.", + "default": null, + "optional": true + }, + { + "name": "units_per_share", + "type": "float", + "description": "Number of units of the security held per share outstanding of the ETF, if available.", + "default": null, + "optional": true + }, + { + "name": "face_value", + "type": "float", + "description": "The face value of the debt security, if available.", + "default": null, + "optional": true + }, + { + "name": "derivatives_value", + "type": "float", + "description": "The notional value of derivatives contracts held.", + "default": null, + "optional": true + }, + { + "name": "value", + "type": "float", + "description": "The market value of the holding, on the 'as_of' date.", + "default": null, + "optional": true + }, + { + "name": "weight", + "type": "float", + "description": "The weight of the holding, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "updated", + "type": "date", + "description": "The 'as_of' date for the holding.", + "default": null, + "optional": true + } + ], + "sec": [ + { + "name": "lei", + "type": "str", + "description": "The LEI of the holding.", + "default": null, + "optional": true + }, + { + "name": "cusip", + "type": "str", + "description": "The CUSIP of the holding.", + "default": null, + "optional": true + }, + { + "name": "isin", + "type": "str", + "description": "The ISIN of the holding.", + "default": null, + "optional": true + }, + { + "name": "other_id", + "type": "str", + "description": "Internal identifier for the holding.", + "default": null, + "optional": true + }, + { + "name": "balance", + "type": "float", + "description": "The balance of the holding.", + "default": null, + "optional": true + }, + { + "name": "weight", + "type": "float", + "description": "The weight of the holding in ETF in %.", + "default": null, + "optional": true + }, + { + "name": "value", + "type": "float", + "description": "The value of the holding in USD.", + "default": null, + "optional": true + }, + { + "name": "payoff_profile", + "type": "str", + "description": "The payoff profile of the holding.", + "default": null, + "optional": true + }, + { + "name": "units", + "type": "Union[str, float]", + "description": "The units of the holding.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "The currency of the holding.", + "default": null, + "optional": true + }, + { + "name": "asset_category", + "type": "str", + "description": "The asset category of the holding.", + "default": null, + "optional": true + }, + { + "name": "issuer_category", + "type": "str", + "description": "The issuer category of the holding.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "The country of the holding.", + "default": null, + "optional": true + }, + { + "name": "is_restricted", + "type": "str", + "description": "Whether the holding is restricted.", + "default": null, + "optional": true + }, + { + "name": "fair_value_level", + "type": "int", + "description": "The fair value level of the holding.", + "default": null, + "optional": true + }, + { + "name": "is_cash_collateral", + "type": "str", + "description": "Whether the holding is cash collateral.", + "default": null, + "optional": true + }, + { + "name": "is_non_cash_collateral", + "type": "str", + "description": "Whether the holding is non-cash collateral.", + "default": null, + "optional": true + }, + { + "name": "is_loan_by_fund", + "type": "str", + "description": "Whether the holding is loan by fund.", + "default": null, + "optional": true + }, + { + "name": "loan_value", + "type": "float", + "description": "The loan value of the holding.", + "default": null, + "optional": true + }, + { + "name": "issuer_conditional", + "type": "str", + "description": "The issuer conditions of the holding.", + "default": null, + "optional": true + }, + { + "name": "asset_conditional", + "type": "str", + "description": "The asset conditions of the holding.", + "default": null, + "optional": true + }, + { + "name": "maturity_date", + "type": "date", + "description": "The maturity date of the debt security.", + "default": null, + "optional": true + }, + { + "name": "coupon_kind", + "type": "str", + "description": "The type of coupon for the debt security.", + "default": null, + "optional": true + }, + { + "name": "rate_type", + "type": "str", + "description": "The type of rate for the debt security, floating or fixed.", + "default": null, + "optional": true + }, + { + "name": "annualized_return", + "type": "float", + "description": "The annualized return on the debt security.", + "default": null, + "optional": true + }, + { + "name": "is_default", + "type": "str", + "description": "If the debt security is defaulted.", + "default": null, + "optional": true + }, + { + "name": "in_arrears", + "type": "str", + "description": "If the debt security is in arrears.", + "default": null, + "optional": true + }, + { + "name": "is_paid_kind", + "type": "str", + "description": "If the debt security payments are paid in kind.", + "default": null, + "optional": true + }, + { + "name": "derivative_category", + "type": "str", + "description": "The derivative category of the holding.", + "default": null, + "optional": true + }, + { + "name": "counterparty", + "type": "str", + "description": "The counterparty of the derivative.", + "default": null, + "optional": true + }, + { + "name": "underlying_name", + "type": "str", + "description": "The name of the underlying asset associated with the derivative.", + "default": null, + "optional": true + }, + { + "name": "option_type", + "type": "str", + "description": "The type of option.", + "default": null, + "optional": true + }, + { + "name": "derivative_payoff", + "type": "str", + "description": "The payoff profile of the derivative.", + "default": null, + "optional": true + }, + { + "name": "expiry_date", + "type": "date", + "description": "The expiry or termination date of the derivative.", + "default": null, + "optional": true + }, + { + "name": "exercise_price", + "type": "float", + "description": "The exercise price of the option.", + "default": null, + "optional": true + }, + { + "name": "exercise_currency", + "type": "str", + "description": "The currency of the option exercise price.", + "default": null, + "optional": true + }, + { + "name": "shares_per_contract", + "type": "float", + "description": "The number of shares per contract.", + "default": null, + "optional": true + }, + { + "name": "delta", + "type": "Union[str, float]", + "description": "The delta of the option.", + "default": null, + "optional": true + }, + { + "name": "rate_type_rec", + "type": "str", + "description": "The type of rate for receivable portion of the swap.", + "default": null, + "optional": true + }, + { + "name": "receive_currency", + "type": "str", + "description": "The receive currency of the swap.", + "default": null, + "optional": true + }, + { + "name": "upfront_receive", + "type": "float", + "description": "The upfront amount received of the swap.", + "default": null, + "optional": true + }, + { + "name": "floating_rate_index_rec", + "type": "str", + "description": "The floating rate index for receivable portion of the swap.", + "default": null, + "optional": true + }, + { + "name": "floating_rate_spread_rec", + "type": "float", + "description": "The floating rate spread for reveivable portion of the swap.", + "default": null, + "optional": true + }, + { + "name": "rate_tenor_rec", + "type": "str", + "description": "The rate tenor for receivable portion of the swap.", + "default": null, + "optional": true + }, + { + "name": "rate_tenor_unit_rec", + "type": "Union[int, str]", + "description": "The rate tenor unit for receivable portion of the swap.", + "default": null, + "optional": true + }, + { + "name": "reset_date_rec", + "type": "str", + "description": "The reset date for receivable portion of the swap.", + "default": null, + "optional": true + }, + { + "name": "reset_date_unit_rec", + "type": "Union[int, str]", + "description": "The reset date unit for receivable portion of the swap.", + "default": null, + "optional": true + }, + { + "name": "rate_type_pmnt", + "type": "str", + "description": "The type of rate for payment portion of the swap.", + "default": null, + "optional": true + }, + { + "name": "payment_currency", + "type": "str", + "description": "The payment currency of the swap.", + "default": null, + "optional": true + }, + { + "name": "upfront_payment", + "type": "float", + "description": "The upfront amount received of the swap.", + "default": null, + "optional": true + }, + { + "name": "floating_rate_index_pmnt", + "type": "str", + "description": "The floating rate index for payment portion of the swap.", + "default": null, + "optional": true + }, + { + "name": "floating_rate_spread_pmnt", + "type": "float", + "description": "The floating rate spread for payment portion of the swap.", + "default": null, + "optional": true + }, + { + "name": "rate_tenor_pmnt", + "type": "str", + "description": "The rate tenor for payment portion of the swap.", + "default": null, + "optional": true + }, + { + "name": "rate_tenor_unit_pmnt", + "type": "Union[int, str]", + "description": "The rate tenor unit for payment portion of the swap.", + "default": null, + "optional": true + }, + { + "name": "reset_date_pmnt", + "type": "str", + "description": "The reset date for payment portion of the swap.", + "default": null, + "optional": true + }, + { + "name": "reset_date_unit_pmnt", + "type": "Union[int, str]", + "description": "The reset date unit for payment portion of the swap.", + "default": null, + "optional": true + }, + { + "name": "repo_type", + "type": "str", + "description": "The type of repo.", + "default": null, + "optional": true + }, + { + "name": "is_cleared", + "type": "str", + "description": "If the repo is cleared.", + "default": null, + "optional": true + }, + { + "name": "is_tri_party", + "type": "str", + "description": "If the repo is tri party.", + "default": null, + "optional": true + }, + { + "name": "principal_amount", + "type": "float", + "description": "The principal amount of the repo.", + "default": null, + "optional": true + }, + { + "name": "principal_currency", + "type": "str", + "description": "The currency of the principal amount.", + "default": null, + "optional": true + }, + { + "name": "collateral_type", + "type": "str", + "description": "The collateral type of the repo.", + "default": null, + "optional": true + }, + { + "name": "collateral_amount", + "type": "float", + "description": "The collateral amount of the repo.", + "default": null, + "optional": true + }, + { + "name": "collateral_currency", + "type": "str", + "description": "The currency of the collateral amount.", + "default": null, + "optional": true + }, + { + "name": "exchange_currency", + "type": "str", + "description": "The currency of the exchange rate.", + "default": null, + "optional": true + }, + { + "name": "exchange_rate", + "type": "float", + "description": "The exchange rate.", + "default": null, + "optional": true + }, + { + "name": "currency_sold", + "type": "str", + "description": "The currency sold in a Forward Derivative.", + "default": null, + "optional": true + }, + { + "name": "currency_amount_sold", + "type": "float", + "description": "The amount of currency sold in a Forward Derivative.", + "default": null, + "optional": true + }, + { + "name": "currency_bought", + "type": "str", + "description": "The currency bought in a Forward Derivative.", + "default": null, + "optional": true + }, + { + "name": "currency_amount_bought", + "type": "float", + "description": "The amount of currency bought in a Forward Derivative.", + "default": null, + "optional": true + }, + { + "name": "notional_amount", + "type": "float", + "description": "The notional amount of the derivative.", + "default": null, + "optional": true + }, + { + "name": "notional_currency", + "type": "str", + "description": "The currency of the derivative's notional amount.", + "default": null, + "optional": true + }, + { + "name": "unrealized_gain", + "type": "float", + "description": "The unrealized gain or loss on the derivative.", + "default": null, + "optional": true + } + ] + }, + "model": "EtfHoldings" + }, + "/etf/holdings_date": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Use this function to get the holdings dates, if available.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings_date(symbol='XLK', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "cik", + "type": "str", + "description": "The CIK of the filing entity. Overrides symbol.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfHoldingsDate]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "EtfHoldingsDate" + }, + "/etf/holdings_performance": { + "deprecated": { + "flag": true, + "message": "This endpoint is deprecated; pass a list of holdings symbols directly to `/equity/price/performance` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.2." + }, + "description": "Get the recent price performance of each ticker held in the ETF.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings_performance(symbol='XLK', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfHoldingsPerformance]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "one_day", + "type": "float", + "description": "One-day return.", + "default": null, + "optional": true + }, + { + "name": "wtd", + "type": "float", + "description": "Week to date return.", + "default": null, + "optional": true + }, + { + "name": "one_week", + "type": "float", + "description": "One-week return.", + "default": null, + "optional": true + }, + { + "name": "mtd", + "type": "float", + "description": "Month to date return.", + "default": null, + "optional": true + }, + { + "name": "one_month", + "type": "float", + "description": "One-month return.", + "default": null, + "optional": true + }, + { + "name": "qtd", + "type": "float", + "description": "Quarter to date return.", + "default": null, + "optional": true + }, + { + "name": "three_month", + "type": "float", + "description": "Three-month return.", + "default": null, + "optional": true + }, + { + "name": "six_month", + "type": "float", + "description": "Six-month return.", + "default": null, + "optional": true + }, + { + "name": "ytd", + "type": "float", + "description": "Year to date return.", + "default": null, + "optional": true + }, + { + "name": "one_year", + "type": "float", + "description": "One-year return.", + "default": null, + "optional": true + }, + { + "name": "two_year", + "type": "float", + "description": "Two-year return.", + "default": null, + "optional": true + }, + { + "name": "three_year", + "type": "float", + "description": "Three-year return.", + "default": null, + "optional": true + }, + { + "name": "four_year", + "type": "float", + "description": "Four-year", + "default": null, + "optional": true + }, + { + "name": "five_year", + "type": "float", + "description": "Five-year return.", + "default": null, + "optional": true + }, + { + "name": "ten_year", + "type": "float", + "description": "Ten-year return.", + "default": null, + "optional": true + }, + { + "name": "max", + "type": "float", + "description": "Return from the beginning of the time series.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": "", + "optional": false + } + ] + }, + "model": "EtfHoldingsPerformance" + }, + "/etf/equity_exposure": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the exposure to ETFs for a specific stock.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.equity_exposure(symbol='MSFT', provider='fmp')\n# This function accepts multiple tickers.\nobb.etf.equity_exposure(symbol='MSFT,AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfEquityExposure]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "equity_symbol", + "type": "str", + "description": "The symbol of the equity requested.", + "default": "", + "optional": false + }, + { + "name": "etf_symbol", + "type": "str", + "description": "The symbol of the ETF with exposure to the requested equity.", + "default": "", + "optional": false + }, + { + "name": "shares", + "type": "float", + "description": "The number of shares held in the ETF.", + "default": null, + "optional": true + }, + { + "name": "weight", + "type": "float", + "description": "The weight of the equity in the ETF, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "market_value", + "type": "Union[int, float]", + "description": "The market value of the equity position in the ETF.", + "default": null, + "optional": true + } + ], + "fmp": [] + }, + "model": "EtfEquityExposure" + }, + "/fixedincome/rate/ameribor": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Ameribor.\n\nAmeribor (short for the American interbank offered rate) is a benchmark interest rate that reflects the true cost of\nshort-term interbank borrowing. This rate is based on transactions in overnight unsecured loans conducted on the\nAmerican Financial Exchange (AFX).", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.ameribor(provider='fred')\nobb.fixedincome.rate.ameribor(parameter=30_day_ma, provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [ + { + "name": "parameter", + "type": "Literal['overnight', 'term_30', 'term_90', '1_week_term_structure', '1_month_term_structure', '3_month_term_structure', '6_month_term_structure', '1_year_term_structure', '2_year_term_structure', '30_day_ma', '90_day_ma']", + "description": "Period of AMERIBOR rate.", + "default": "overnight", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[AMERIBOR]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "AMERIBOR rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "AMERIBOR" + }, + "/fixedincome/rate/sonia": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Sterling Overnight Index Average.\n\nSONIA (Sterling Overnight Index Average) is an important interest rate benchmark. SONIA is based on actual\ntransactions and reflects the average of the interest rates that banks pay to borrow sterling overnight from other\nfinancial institutions and other institutional investors.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.sonia(provider='fred')\nobb.fixedincome.rate.sonia(parameter=total_nominal_value, provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [ + { + "name": "parameter", + "type": "Literal['rate', 'index', '10th_percentile', '25th_percentile', '75th_percentile', '90th_percentile', 'total_nominal_value']", + "description": "Period of SONIA rate.", + "default": "rate", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[SONIA]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "SONIA rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "SONIA" + }, + "/fixedincome/rate/iorb": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Interest on Reserve Balances.\n\nGet Interest Rate on Reserve Balances data A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.iorb(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[IORB]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "IORB rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "IORB" + }, + "/fixedincome/rate/effr": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fed Funds Rate.\n\nGet Effective Federal Funds Rate data. A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.effr(provider='fred')\nobb.fixedincome.rate.effr(parameter=daily, provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['federal_reserve', 'fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default.", + "default": "federal_reserve", + "optional": true + } + ], + "federal_reserve": [], + "fred": [ + { + "name": "parameter", + "type": "Literal['monthly', 'daily', 'weekly', 'daily_excl_weekend', 'annual', 'biweekly', 'volume']", + "description": "Period of FED rate.", + "default": "weekly", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[FEDFUNDS]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['federal_reserve', 'fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "FED rate.", + "default": "", + "optional": false + } + ], + "federal_reserve": [], + "fred": [] + }, + "model": "FEDFUNDS" + }, + "/fixedincome/rate/effr_forecast": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fed Funds Rate Projections.\n\nThe projections for the federal funds rate are the value of the midpoint of the\nprojected appropriate target range for the federal funds rate or the projected\nappropriate target level for the federal funds rate at the end of the specified\ncalendar year or over the longer run.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.effr_forecast(provider='fred')\nobb.fixedincome.rate.effr_forecast(long_run=True, provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [ + { + "name": "long_run", + "type": "bool", + "description": "Flag to show long run projections", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[PROJECTIONS]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "range_high", + "type": "float", + "description": "High projection of rates.", + "default": "", + "optional": false + }, + { + "name": "central_tendency_high", + "type": "float", + "description": "Central tendency of high projection of rates.", + "default": "", + "optional": false + }, + { + "name": "median", + "type": "float", + "description": "Median projection of rates.", + "default": "", + "optional": false + }, + { + "name": "range_midpoint", + "type": "float", + "description": "Midpoint projection of rates.", + "default": "", + "optional": false + }, + { + "name": "central_tendency_midpoint", + "type": "float", + "description": "Central tendency of midpoint projection of rates.", + "default": "", + "optional": false + }, + { + "name": "range_low", + "type": "float", + "description": "Low projection of rates.", + "default": "", + "optional": false + }, + { + "name": "central_tendency_low", + "type": "float", + "description": "Central tendency of low projection of rates.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "PROJECTIONS" + }, + "/fixedincome/rate/estr": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Euro Short-Term Rate.\n\nThe euro short-term rate (\u20acSTR) reflects the wholesale euro unsecured overnight borrowing costs of banks located in\nthe euro area. The \u20acSTR is published on each TARGET2 business day based on transactions conducted and settled on\nthe previous TARGET2 business day (the reporting date \u201cT\u201d) with a maturity date of T+1 which are deemed to have been\nexecuted at arm\u2019s length and thus reflect market rates in an unbiased way.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.estr(provider='fred')\nobb.fixedincome.rate.estr(parameter=number_of_active_banks, provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [ + { + "name": "parameter", + "type": "Literal['volume_weighted_trimmed_mean_rate', 'number_of_transactions', 'number_of_active_banks', 'total_volume', 'share_of_volume_of_the_5_largest_active_banks', 'rate_at_75th_percentile_of_volume', 'rate_at_25th_percentile_of_volume']", + "description": "Period of ESTR rate.", + "default": "volume_weighted_trimmed_mean_rate", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[ESTR]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "ESTR rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "ESTR" + }, + "/fixedincome/rate/ecb": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "European Central Bank Interest Rates.\n\nThe Governing Council of the ECB sets the key interest rates for the euro area:\n\n- The interest rate on the main refinancing operations (MRO), which provide\nthe bulk of liquidity to the banking system.\n- The rate on the deposit facility, which banks may use to make overnight deposits with the Eurosystem.\n- The rate on the marginal lending facility, which offers overnight credit to banks from the Eurosystem.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.ecb(provider='fred')\nobb.fixedincome.rate.ecb(interest_rate_type='refinancing', provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "interest_rate_type", + "type": "Literal['deposit', 'lending', 'refinancing']", + "description": "The type of interest rate.", + "default": "lending", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EuropeanCentralBankInterestRates]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "European Central Bank Interest Rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "EuropeanCentralBankInterestRates" + }, + "/fixedincome/rate/dpcredit": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Discount Window Primary Credit Rate.\n\nA bank rate is the interest rate a nation's central bank charges to its domestic banks to borrow money.\nThe rates central banks charge are set to stabilize the economy.\nIn the United States, the Federal Reserve System's Board of Governors set the bank rate,\nalso known as the discount rate.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.dpcredit(provider='fred')\nobb.fixedincome.rate.dpcredit(start_date='2023-02-01', end_date='2023-05-01', provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [ + { + "name": "parameter", + "type": "Literal['daily_excl_weekend', 'monthly', 'weekly', 'daily', 'annual']", + "description": "FRED series ID of DWPCR data.", + "default": "daily_excl_weekend", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[DiscountWindowPrimaryCreditRate]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "Discount Window Primary Credit Rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "DiscountWindowPrimaryCreditRate" + }, + "/fixedincome/spreads/tcm": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Treasury Constant Maturity.\n\nGet data for 10-Year Treasury Constant Maturity Minus Selected Treasury Constant Maturity.\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S.\nTreasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.tcm(provider='fred')\nobb.fixedincome.spreads.tcm(maturity='2y', provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "maturity", + "type": "Literal['3m', '2y']", + "description": "The maturity", + "default": "3m", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[TreasuryConstantMaturity]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "TreasuryConstantMaturity Rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "TreasuryConstantMaturity" + }, + "/fixedincome/spreads/tcm_effr": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Select Treasury Constant Maturity.\n\nGet data for Selected Treasury Constant Maturity Minus Federal Funds Rate\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S.\nTreasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.tcm_effr(provider='fred')\nobb.fixedincome.spreads.tcm_effr(maturity='10y', provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "maturity", + "type": "Literal['10y', '5y', '1y', '6m', '3m']", + "description": "The maturity", + "default": "10y", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[SelectedTreasuryConstantMaturity]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "Selected Treasury Constant Maturity Rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "SelectedTreasuryConstantMaturity" + }, + "/fixedincome/spreads/treasury_effr": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Select Treasury Bill.\n\nGet Selected Treasury Bill Minus Federal Funds Rate.\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of\nauctioned U.S. Treasuries.\nThe value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.treasury_effr(provider='fred')\nobb.fixedincome.spreads.treasury_effr(maturity='6m', provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "maturity", + "type": "Literal['3m', '6m']", + "description": "The maturity", + "default": "3m", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[SelectedTreasuryBill]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "SelectedTreasuryBill Rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "SelectedTreasuryBill" + }, + "/fixedincome/government/us_yield_curve": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "US Yield Curve. Get United States yield curve.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.us_yield_curve(provider='fred')\nobb.fixedincome.government.us_yield_curve(inflation_adjusted=True, provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for. Defaults to the most recent FRED entry.", + "default": null, + "optional": true + }, + { + "name": "inflation_adjusted", + "type": "bool", + "description": "Get inflation adjusted rates.", + "default": false, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[USYieldCurve]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "maturity", + "type": "float", + "description": "Maturity of the treasury rate in years.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "Associated rate given in decimal form (0.05 is 5%)", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "USYieldCurve" + }, + "/fixedincome/government/treasury_rates": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Government Treasury Rates.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.treasury_rates(provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['federal_reserve', 'fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default.", + "default": "federal_reserve", + "optional": true + } + ], + "federal_reserve": [], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[TreasuryRates]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['federal_reserve', 'fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "week_4", + "type": "float", + "description": "4 week Treasury bills rate (secondary market).", + "default": null, + "optional": true + }, + { + "name": "month_1", + "type": "float", + "description": "1 month Treasury rate.", + "default": null, + "optional": true + }, + { + "name": "month_2", + "type": "float", + "description": "2 month Treasury rate.", + "default": null, + "optional": true + }, + { + "name": "month_3", + "type": "float", + "description": "3 month Treasury rate.", + "default": null, + "optional": true + }, + { + "name": "month_6", + "type": "float", + "description": "6 month Treasury rate.", + "default": null, + "optional": true + }, + { + "name": "year_1", + "type": "float", + "description": "1 year Treasury rate.", + "default": null, + "optional": true + }, + { + "name": "year_2", + "type": "float", + "description": "2 year Treasury rate.", + "default": null, + "optional": true + }, + { + "name": "year_3", + "type": "float", + "description": "3 year Treasury rate.", + "default": null, + "optional": true + }, + { + "name": "year_5", + "type": "float", + "description": "5 year Treasury rate.", + "default": null, + "optional": true + }, + { + "name": "year_7", + "type": "float", + "description": "7 year Treasury rate.", + "default": null, + "optional": true + }, + { + "name": "year_10", + "type": "float", + "description": "10 year Treasury rate.", + "default": null, + "optional": true + }, + { + "name": "year_20", + "type": "float", + "description": "20 year Treasury rate.", + "default": null, + "optional": true + }, + { + "name": "year_30", + "type": "float", + "description": "30 year Treasury rate.", + "default": null, + "optional": true + } + ], + "federal_reserve": [], + "fmp": [] + }, + "model": "TreasuryRates" + }, + "/fixedincome/corporate/ice_bofa": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "ICE BofA US Corporate Bond Indices.\n\nThe ICE BofA US Corporate Index tracks the performance of US dollar denominated investment grade corporate debt\npublicly issued in the US domestic market. Qualifying securities must have an investment grade rating (based on an\naverage of Moody\u2019s, S&P and Fitch), at least 18 months to final maturity at the time of issuance, at least one year\nremaining term to final maturity as of the rebalance date, a fixed coupon schedule and a minimum amount\noutstanding of $250 million. The ICE BofA US Corporate Index is a component of the US Corporate Master Index.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.corporate.ice_bofa(provider='fred')\nobb.fixedincome.corporate.ice_bofa(index_type='yield_to_worst', provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "index_type", + "type": "Literal['yield', 'yield_to_worst', 'total_return', 'spread']", + "description": "The type of series.", + "default": "yield", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [ + { + "name": "category", + "type": "Literal['all', 'duration', 'eur', 'usd']", + "description": "The type of category.", + "default": "all", + "optional": true + }, + { + "name": "area", + "type": "Literal['asia', 'emea', 'eu', 'ex_g10', 'latin_america', 'us']", + "description": "The type of area.", + "default": "us", + "optional": true + }, + { + "name": "grade", + "type": "Literal['a', 'aa', 'aaa', 'b', 'bb', 'bbb', 'ccc', 'crossover', 'high_grade', 'high_yield', 'non_financial', 'non_sovereign', 'private_sector', 'public_sector']", + "description": "The type of grade.", + "default": "non_sovereign", + "optional": true + }, + { + "name": "options", + "type": "bool", + "description": "Whether to include options in the results.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[ICEBofA]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "ICE BofA US Corporate Bond Indices Rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "ICEBofA" + }, + "/fixedincome/corporate/moody": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Moody Corporate Bond Index.\n\nMoody's Aaa and Baa are investment bonds that acts as an index of\nthe performance of all bonds given an Aaa or Baa rating by Moody's Investors Service respectively.\nThese corporate bonds often are used in macroeconomics as an alternative to the federal ten-year\nTreasury Bill as an indicator of the interest rate.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.corporate.moody(provider='fred')\nobb.fixedincome.corporate.moody(index_type='baa', provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "index_type", + "type": "Literal['aaa', 'baa']", + "description": "The type of series.", + "default": "aaa", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [ + { + "name": "spread", + "type": "Literal['treasury', 'fed_funds']", + "description": "The type of spread.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[MoodyCorporateBondIndex]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "Moody Corporate Bond Index Rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "MoodyCorporateBondIndex" + }, + "/fixedincome/corporate/hqm": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "High Quality Market Corporate Bond.\n\nThe HQM yield curve represents the high quality corporate bond market, i.e.,\ncorporate bonds rated AAA, AA, or A. The HQM curve contains two regression terms.\nThese terms are adjustment factors that blend AAA, AA, and A bonds into a single HQM yield curve\nthat is the market-weighted average (MWA) quality of high quality bonds.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.corporate.hqm(provider='fred')\nobb.fixedincome.corporate.hqm(yield_curve='par', provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": null, + "optional": true + }, + { + "name": "yield_curve", + "type": "Literal['spot', 'par']", + "description": "The yield curve type.", + "default": "spot", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[HighQualityMarketCorporateBond]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "HighQualityMarketCorporateBond Rate.", + "default": "", + "optional": false + }, + { + "name": "maturity", + "type": "str", + "description": "Maturity.", + "default": "", + "optional": false + }, + { + "name": "yield_curve", + "type": "Literal['spot', 'par']", + "description": "The yield curve type.", + "default": "", + "optional": false + } + ], + "fred": [ + { + "name": "series_id", + "type": "str", + "description": "FRED series id.", + "default": "", + "optional": false + } + ] + }, + "model": "HighQualityMarketCorporateBond" + }, + "/fixedincome/corporate/spot_rates": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Spot Rates.\n\nThe spot rates for any maturity is the yield on a bond that provides a single payment at that maturity.\nThis is a zero coupon bond.\nBecause each spot rate pertains to a single cashflow, it is the relevant interest rate\nconcept for discounting a pension liability at the same maturity.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.corporate.spot_rates(provider='fred')\nobb.fixedincome.corporate.spot_rates(maturity='10,20,30,50', provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "maturity", + "type": "Union[Union[float, str], List[Union[float, str]]]", + "description": "Maturities in years. Multiple items allowed for provider(s): fred.", + "default": 10.0, + "optional": true + }, + { + "name": "category", + "type": "Union[str, List[str]]", + "description": "Rate category. Options: spot_rate, par_yield. Multiple items allowed for provider(s): fred.", + "default": "spot_rate", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[SpotRate]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "Spot Rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "SpotRate" + }, + "/fixedincome/corporate/commercial_paper": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Commercial Paper.\n\nCommercial paper (CP) consists of short-term, promissory notes issued primarily by corporations.\nMaturities range up to 270 days but average about 30 days.\nMany companies use CP to raise cash needed for current transactions,\nand many find it to be a lower-cost alternative to bank loans.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.corporate.commercial_paper(provider='fred')\nobb.fixedincome.corporate.commercial_paper(maturity='15d', provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "maturity", + "type": "Literal['overnight', '7d', '15d', '30d', '60d', '90d']", + "description": "The maturity.", + "default": "30d", + "optional": true + }, + { + "name": "category", + "type": "Literal['asset_backed', 'financial', 'nonfinancial']", + "description": "The category.", + "default": "financial", + "optional": true + }, + { + "name": "grade", + "type": "Literal['aa', 'a2_p2']", + "description": "The grade.", + "default": "aa", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CommercialPaper]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "Commercial Paper Rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "CommercialPaper" + }, + "/fixedincome/sofr": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Secured Overnight Financing Rate.\n\nThe Secured Overnight Financing Rate (SOFR) is a broad measure of the cost of\nborrowing cash overnight collateralizing by Treasury securities.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.sofr(provider='fred')\nobb.fixedincome.sofr(period=overnight, provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "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.", + "default": "fred", + "optional": true + } + ], + "fred": [ + { + "name": "period", + "type": "Literal['overnight', '30_day', '90_day', '180_day', 'index']", + "description": "Period of SOFR rate.", + "default": "overnight", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[SOFR]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "SOFR rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "SOFR" + }, + "/index/price/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Historical Index Levels.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.price.historical(symbol='^GSPC', provider='fmp')\n# Not all providers have the same symbols.\nobb.index.price.historical(symbol='SPX', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, polygon, yfinance.", + "default": "", + "optional": false + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ], + "intrinio": [ + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10000, + "optional": true + } + ], + "polygon": [ + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", + "default": "1d", + "optional": true + }, + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", + "default": "asc", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 49999, + "optional": true + } + ], + "yfinance": [ + { + "name": "interval", + "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[IndexHistorical]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "open", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The open price.", + "default": null, + "optional": true + }, + { + "name": "high", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The high price.", + "default": null, + "optional": true + }, + { + "name": "low", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The low price.", + "default": null, + "optional": true + }, + { + "name": "close", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The close price.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "Change in the price from the previous close.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in the price from the previous close, as a normalized percent.", + "default": null, + "optional": true + } + ], + "intrinio": [], + "polygon": [ + { + "name": "transactions", + "type": "Annotated[int, Gt(gt=0)]", + "description": "Number of transactions for the symbol in the time period.", + "default": null, + "optional": true + } + ], + "yfinance": [] + }, + "model": "IndexHistorical" + }, + "/index/market": { + "deprecated": { + "flag": true, + "message": "This endpoint is deprecated; use `/index/price/historical` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.3." + }, + "description": "Get Historical Market Indices.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.market(symbol='^IBEX', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, polygon, yfinance.", + "default": "", + "optional": false + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ], + "intrinio": [ + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10000, + "optional": true + } + ], + "polygon": [ + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", + "default": "1d", + "optional": true + }, + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", + "default": "asc", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 49999, + "optional": true + } + ], + "yfinance": [ + { + "name": "interval", + "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[MarketIndices]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "open", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The open price.", + "default": null, + "optional": true + }, + { + "name": "high", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The high price.", + "default": null, + "optional": true + }, + { + "name": "low", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The low price.", + "default": null, + "optional": true + }, + { + "name": "close", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The close price.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "Change in the price from the previous close.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in the price from the previous close, as a normalized percent.", + "default": null, + "optional": true + } + ], + "intrinio": [], + "polygon": [ + { + "name": "transactions", + "type": "Annotated[int, Gt(gt=0)]", + "description": "Number of transactions for the symbol in the time period.", + "default": null, + "optional": true + } + ], + "yfinance": [] + }, + "model": "MarketIndices" + }, + "/index/constituents": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Index Constituents.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.constituents(symbol='dowjones', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "Literal['dowjones', 'sp500', 'nasdaq']", + "description": "None", + "default": "dowjones", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[IndexConstituents]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the constituent company in the index.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "sector", + "type": "str", + "description": "Sector the constituent company in the index belongs to.", + "default": "", + "optional": false + }, + { + "name": "sub_sector", + "type": "str", + "description": "Sub-sector the constituent company in the index belongs to.", + "default": null, + "optional": true + }, + { + "name": "headquarter", + "type": "str", + "description": "Location of the headquarter of the constituent company in the index.", + "default": null, + "optional": true + }, + { + "name": "date_first_added", + "type": "Union[str, date]", + "description": "Date the constituent company was added to the index.", + "default": null, + "optional": true + }, + { + "name": "cik", + "type": "int", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true + }, + { + "name": "founded", + "type": "Union[str, date]", + "description": "Founding year of the constituent company in the index.", + "default": null, + "optional": true + } + ] + }, + "model": "IndexConstituents" + }, + "/index/available": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "All indices available from a given provider.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.available(provider='fmp')\nobb.index.available(provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "provider", + "type": "Literal['fmp', 'yfinance']", + "description": "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.", + "default": "fmp", + "optional": true + } + ], + "fmp": [], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[AvailableIndices]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "name", + "type": "str", + "description": "Name of the index.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency the index is traded in.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "stock_exchange", + "type": "str", + "description": "Stock exchange where the index is listed.", + "default": "", + "optional": false + }, + { + "name": "exchange_short_name", + "type": "str", + "description": "Short name of the stock exchange where the index is listed.", + "default": "", + "optional": false + } + ], + "yfinance": [ + { + "name": "code", + "type": "str", + "description": "ID code for keying the index in the OpenBB Terminal.", + "default": "", + "optional": false + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol for the index.", + "default": "", + "optional": false + } + ] + }, + "model": "AvailableIndices" + }, + "/news/world": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "World News. Global news data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.news.world(provider='fmp')\nobb.news.world(limit=100, provider='intrinio')\n# Get news on the specified dates.\nobb.news.world(start_date='2024-02-01', end_date='2024-02-07', provider='intrinio')\n# Display the headlines of the news.\nobb.news.world(display=headline, provider='benzinga')\n# Get news by topics.\nobb.news.world(topics=finance, provider='benzinga')\n# Get news by source using 'tingo' as provider.\nobb.news.world(provider='tiingo', source=bloomberg)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return. The number of articles to return.", + "default": 2500, + "optional": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['benzinga', 'fmp', 'intrinio', 'tiingo']", + "description": "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.", + "default": "benzinga", + "optional": true + } + ], + "benzinga": [ + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": null, + "optional": true + }, + { + "name": "display", + "type": "Literal['headline', 'abstract', 'full']", + "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full).", + "default": "full", + "optional": true + }, + { + "name": "updated_since", + "type": "int", + "description": "Number of seconds since the news was updated.", + "default": null, + "optional": true + }, + { + "name": "published_since", + "type": "int", + "description": "Number of seconds since the news was published.", + "default": null, + "optional": true + }, + { + "name": "sort", + "type": "Literal['id', 'created', 'updated']", + "description": "Key to sort the news by.", + "default": "created", + "optional": true + }, + { + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order to sort the news by.", + "default": "desc", + "optional": true + }, + { + "name": "isin", + "type": "str", + "description": "The ISIN of the news to retrieve.", + "default": null, + "optional": true + }, + { + "name": "cusip", + "type": "str", + "description": "The CUSIP of the news to retrieve.", + "default": null, + "optional": true + }, + { + "name": "channels", + "type": "str", + "description": "Channels of the news to retrieve.", + "default": null, + "optional": true + }, + { + "name": "topics", + "type": "str", + "description": "Topics of the news to retrieve.", + "default": null, + "optional": true + }, + { + "name": "authors", + "type": "str", + "description": "Authors of the news to retrieve.", + "default": null, + "optional": true + }, + { + "name": "content_types", + "type": "str", + "description": "Content types of the news to retrieve.", + "default": null, + "optional": true + } + ], + "fmp": [], + "intrinio": [ + { + "name": "source", + "type": "Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases']", + "description": "The source of the news article.", + "default": null, + "optional": true + }, + { + "name": "sentiment", + "type": "Literal['positive', 'neutral', 'negative']", + "description": "Return news only from this source.", + "default": null, + "optional": true + }, + { + "name": "language", + "type": "str", + "description": "Filter by language. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "topic", + "type": "str", + "description": "Filter by topic. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "word_count_greater_than", + "type": "int", + "description": "News stories will have a word count greater than this value. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "word_count_less_than", + "type": "int", + "description": "News stories will have a word count less than this value. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "is_spam", + "type": "bool", + "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "business_relevance_greater_than", + "type": "float", + "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "business_relevance_less_than", + "type": "float", + "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source.", + "default": null, + "optional": true + } + ], + "tiingo": [ + { + "name": "offset", + "type": "int", + "description": "Page offset, used in conjunction with limit.", + "default": 0, + "optional": true + }, + { + "name": "source", + "type": "str", + "description": "A comma-separated list of the domains requested.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[WorldNews]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['benzinga', 'fmp', 'intrinio', 'tiingo']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "datetime", + "description": "The date of the data. The published date of the article.", + "default": "", + "optional": false + }, + { + "name": "title", + "type": "str", + "description": "Title of the article.", + "default": "", + "optional": false + }, + { + "name": "images", + "type": "List[Dict[str, str]]", + "description": "Images associated with the article.", + "default": null, + "optional": true + }, + { + "name": "text", + "type": "str", + "description": "Text/body of the article.", + "default": null, + "optional": true + }, + { + "name": "url", + "type": "str", + "description": "URL to the article.", + "default": null, + "optional": true + } + ], + "benzinga": [ + { + "name": "id", + "type": "str", + "description": "Article ID.", + "default": "", + "optional": false + }, + { + "name": "author", + "type": "str", + "description": "Author of the news.", + "default": null, + "optional": true + }, + { + "name": "teaser", + "type": "str", + "description": "Teaser of the news.", + "default": null, + "optional": true + }, + { + "name": "channels", + "type": "str", + "description": "Channels associated with the news.", + "default": null, + "optional": true + }, + { + "name": "stocks", + "type": "str", + "description": "Stocks associated with the news.", + "default": null, + "optional": true + }, + { + "name": "tags", + "type": "str", + "description": "Tags associated with the news.", + "default": null, + "optional": true + }, + { + "name": "updated", + "type": "datetime", + "description": "Updated date of the news.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "site", + "type": "str", + "description": "News source.", + "default": "", + "optional": false + } + ], + "intrinio": [ + { + "name": "source", + "type": "str", + "description": "The source of the news article.", + "default": null, + "optional": true + }, + { + "name": "summary", + "type": "str", + "description": "The summary of the news article.", + "default": null, + "optional": true + }, + { + "name": "topics", + "type": "str", + "description": "The topics related to the news article.", + "default": null, + "optional": true + }, + { + "name": "word_count", + "type": "int", + "description": "The word count of the news article.", + "default": null, + "optional": true + }, + { + "name": "business_relevance", + "type": "float", + "description": "How strongly correlated the news article is to the business", + "default": null, + "optional": true + }, + { + "name": "sentiment", + "type": "str", + "description": "The sentiment of the news article - i.e, negative, positive.", + "default": null, + "optional": true + }, + { + "name": "sentiment_confidence", + "type": "float", + "description": "The confidence score of the sentiment rating.", + "default": null, + "optional": true + }, + { + "name": "language", + "type": "str", + "description": "The language of the news article.", + "default": null, + "optional": true + }, + { + "name": "spam", + "type": "bool", + "description": "Whether the news article is spam.", + "default": null, + "optional": true + }, + { + "name": "copyright", + "type": "str", + "description": "The copyright notice of the news article.", + "default": null, + "optional": true + }, + { + "name": "id", + "type": "str", + "description": "Article ID.", + "default": "", + "optional": false + }, + { + "name": "company", + "type": "IntrinioCompany", + "description": "The Intrinio Company object. Contains details company reference data.", + "default": null, + "optional": true + }, + { + "name": "security", + "type": "IntrinioSecurity", + "description": "The Intrinio Security object. Contains the security details related to the news article.", + "default": null, + "optional": true + } + ], + "tiingo": [ + { + "name": "symbols", + "type": "str", + "description": "Ticker tagged in the fetched news.", + "default": null, + "optional": true + }, + { + "name": "article_id", + "type": "int", + "description": "Unique ID of the news article.", + "default": "", + "optional": false + }, + { + "name": "site", + "type": "str", + "description": "News source.", + "default": "", + "optional": false + }, + { + "name": "tags", + "type": "str", + "description": "Tags associated with the news article.", + "default": null, + "optional": true + }, + { + "name": "crawl_date", + "type": "datetime", + "description": "Date the news article was crawled.", + "default": "", + "optional": false + } + ] + }, + "model": "WorldNews" + }, + "/news/company": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Company News. Get news for one or more companies.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.news.company(provider='benzinga')\nobb.news.company(limit=100, provider='benzinga')\n# Get news on the specified dates.\nobb.news.company(symbol='AAPL', start_date='2024-02-01', end_date='2024-02-07', provider='intrinio')\n# Display the headlines of the news.\nobb.news.company(symbol='AAPL', display=headline, provider='benzinga')\n# Get news for multiple symbols.\nobb.news.company(symbol='aapl,tsla', provider='fmp')\n# Get news company's ISIN.\nobb.news.company(symbol='NVDA', isin=US0378331005, provider='benzinga')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, yfinance.", + "default": null, + "optional": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "Annotated[int, Ge(ge=0)]", + "description": "The number of data entries to return.", + "default": 2500, + "optional": true + }, + { + "name": "provider", + "type": "Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']", + "description": "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.", + "default": "benzinga", + "optional": true + } + ], + "benzinga": [ + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": null, + "optional": true + }, + { + "name": "display", + "type": "Literal['headline', 'abstract', 'full']", + "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full).", + "default": "full", + "optional": true + }, + { + "name": "updated_since", + "type": "int", + "description": "Number of seconds since the news was updated.", + "default": null, + "optional": true + }, + { + "name": "published_since", + "type": "int", + "description": "Number of seconds since the news was published.", + "default": null, + "optional": true + }, + { + "name": "sort", + "type": "Literal['id', 'created', 'updated']", + "description": "Key to sort the news by.", + "default": "created", + "optional": true + }, + { + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order to sort the news by.", + "default": "desc", + "optional": true + }, + { + "name": "isin", + "type": "str", + "description": "The company's ISIN.", + "default": null, + "optional": true + }, + { + "name": "cusip", + "type": "str", + "description": "The company's CUSIP.", + "default": null, + "optional": true + }, + { + "name": "channels", + "type": "str", + "description": "Channels of the news to retrieve.", + "default": null, + "optional": true + }, + { + "name": "topics", + "type": "str", + "description": "Topics of the news to retrieve.", + "default": null, + "optional": true + }, + { + "name": "authors", + "type": "str", + "description": "Authors of the news to retrieve.", + "default": null, + "optional": true + }, + { + "name": "content_types", + "type": "str", + "description": "Content types of the news to retrieve.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "page", + "type": "int", + "description": "Page number of the results. Use in combination with limit.", + "default": 0, + "optional": true + } + ], + "intrinio": [ + { + "name": "source", + "type": "Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases']", + "description": "The source of the news article.", + "default": null, + "optional": true + }, + { + "name": "sentiment", + "type": "Literal['positive', 'neutral', 'negative']", + "description": "Return news only from this source.", + "default": null, + "optional": true + }, + { + "name": "language", + "type": "str", + "description": "Filter by language. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "topic", + "type": "str", + "description": "Filter by topic. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "word_count_greater_than", + "type": "int", + "description": "News stories will have a word count greater than this value. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "word_count_less_than", + "type": "int", + "description": "News stories will have a word count less than this value. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "is_spam", + "type": "bool", + "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "business_relevance_greater_than", + "type": "float", + "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "business_relevance_less_than", + "type": "float", + "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source.", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Sort order of the articles.", + "default": "desc", + "optional": true + } + ], + "tiingo": [ + { + "name": "offset", + "type": "int", + "description": "Page offset, used in conjunction with limit.", + "default": 0, + "optional": true + }, + { + "name": "source", + "type": "str", + "description": "A comma-separated list of the domains requested.", + "default": null, + "optional": true + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CompanyNews]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "datetime", + "description": "The date of the data. Here it is the published date of the article.", + "default": "", + "optional": false + }, + { + "name": "title", + "type": "str", + "description": "Title of the article.", + "default": "", + "optional": false + }, + { + "name": "text", + "type": "str", + "description": "Text/body of the article.", + "default": null, + "optional": true + }, + { + "name": "images", + "type": "List[Dict[str, str]]", + "description": "Images associated with the article.", + "default": null, + "optional": true + }, + { + "name": "url", + "type": "str", + "description": "URL to the article.", + "default": "", + "optional": false + }, + { + "name": "symbols", + "type": "str", + "description": "Symbols associated with the article.", + "default": null, + "optional": true + } + ], + "benzinga": [ + { + "name": "images", + "type": "List[Dict[str, str]]", + "description": "URL to the images of the news.", + "default": null, + "optional": true + }, + { + "name": "id", + "type": "str", + "description": "Article ID.", + "default": "", + "optional": false + }, + { + "name": "author", + "type": "str", + "description": "Author of the article.", + "default": null, + "optional": true + }, + { + "name": "teaser", + "type": "str", + "description": "Teaser of the news.", + "default": null, + "optional": true + }, + { + "name": "channels", + "type": "str", + "description": "Channels associated with the news.", + "default": null, + "optional": true + }, + { + "name": "stocks", + "type": "str", + "description": "Stocks associated with the news.", + "default": null, + "optional": true + }, + { + "name": "tags", + "type": "str", + "description": "Tags associated with the news.", + "default": null, + "optional": true + }, + { + "name": "updated", + "type": "datetime", + "description": "Updated date of the news.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "source", + "type": "str", + "description": "Name of the news source.", + "default": "", + "optional": false + } + ], + "intrinio": [ + { + "name": "source", + "type": "str", + "description": "The source of the news article.", + "default": null, + "optional": true + }, + { + "name": "summary", + "type": "str", + "description": "The summary of the news article.", + "default": null, + "optional": true + }, + { + "name": "topics", + "type": "str", + "description": "The topics related to the news article.", + "default": null, + "optional": true + }, + { + "name": "word_count", + "type": "int", + "description": "The word count of the news article.", + "default": null, + "optional": true + }, + { + "name": "business_relevance", + "type": "float", + "description": "How strongly correlated the news article is to the business", + "default": null, + "optional": true + }, + { + "name": "sentiment", + "type": "str", + "description": "The sentiment of the news article - i.e, negative, positive.", + "default": null, + "optional": true + }, + { + "name": "sentiment_confidence", + "type": "float", + "description": "The confidence score of the sentiment rating.", + "default": null, + "optional": true + }, + { + "name": "language", + "type": "str", + "description": "The language of the news article.", + "default": null, + "optional": true + }, + { + "name": "spam", + "type": "bool", + "description": "Whether the news article is spam.", + "default": null, + "optional": true + }, + { + "name": "copyright", + "type": "str", + "description": "The copyright notice of the news article.", + "default": null, + "optional": true + }, + { + "name": "id", + "type": "str", + "description": "Article ID.", + "default": "", + "optional": false + }, + { + "name": "security", + "type": "IntrinioSecurity", + "description": "The Intrinio Security object. Contains the security details related to the news article.", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "source", + "type": "str", + "description": "Source of the article.", + "default": null, + "optional": true + }, + { + "name": "tags", + "type": "str", + "description": "Keywords/tags in the article", + "default": null, + "optional": true + }, + { + "name": "id", + "type": "str", + "description": "Article ID.", + "default": "", + "optional": false + }, + { + "name": "amp_url", + "type": "str", + "description": "AMP URL.", + "default": null, + "optional": true + }, + { + "name": "publisher", + "type": "PolygonPublisher", + "description": "Publisher of the article.", + "default": "", + "optional": false + } + ], + "tiingo": [ + { + "name": "tags", + "type": "str", + "description": "Tags associated with the news article.", + "default": null, + "optional": true + }, + { + "name": "article_id", + "type": "int", + "description": "Unique ID of the news article.", + "default": "", + "optional": false + }, + { + "name": "source", + "type": "str", + "description": "News source.", + "default": "", + "optional": false + }, + { + "name": "crawl_date", + "type": "datetime", + "description": "Date the news article was crawled.", + "default": "", + "optional": false + } + ], + "yfinance": [ + { + "name": "source", + "type": "str", + "description": "Source of the news article", + "default": "", + "optional": false + } + ] + }, + "model": "CompanyNews" + }, + "/regulators/sec/cik_map": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Map a ticker symbol to a CIK number.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.cik_map(symbol='MSFT', provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", + "optional": true + } + ], + "sec": [ + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache for the request, default is True.", + "default": true, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CikMap]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['sec']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "cik", + "type": "Union[int, str]", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true + } + ], + "sec": [] + }, + "model": "CikMap" + }, + "/regulators/sec/institutions_search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search SEC-regulated institutions by name and return a list of results with CIK numbers.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.institutions_search(provider='sec')\nobb.regulators.sec.institutions_search(query='blackstone real estate', provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache.", + "default": true, + "optional": true + }, + { + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", + "optional": true + } + ], + "sec": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[InstitutionsSearch]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['sec']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "name", + "type": "str", + "description": "The name of the institution.", + "default": null, + "optional": true + }, + { + "name": "cik", + "type": "Union[int, str]", + "description": "Central Index Key (CIK)", + "default": null, + "optional": true + } + ] + }, + "model": "InstitutionsSearch" + }, + "/regulators/sec/schema_files": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Use tool for navigating the directory of SEC XML schema files by year.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.schema_files(provider='sec')\n# Get a list of schema files.\ndata = obb.regulators.sec.schema_files().results\ndata.files[0]\n'https://xbrl.fasb.org/us-gaap/'\n# The directory structure can be navigated by constructing a URL from the 'results' list.\nurl = data.files[0]+data.files[-1]\n# The URL base will always be the 0 position in the list, feed the URL back in as a parameter.\nobb.regulators.sec.schema_files(url=url).results.files\n['https://xbrl.fasb.org/us-gaap/2024/'\n'USGAAP2024FileList.xml'\n'dis/'\n'dqcrules/'\n'ebp/'\n'elts/'\n'entire/'\n'meta/'\n'stm/'\n'us-gaap-2024.zip']\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache.", + "default": true, + "optional": true + }, + { + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", + "optional": true + } + ], + "sec": [ + { + "name": "url", + "type": "str", + "description": "Enter an optional URL path to fetch the next level.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[SchemaFiles]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['sec']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "files", + "type": "List[str]", + "description": "Dictionary of URLs to SEC Schema Files", + "default": "", + "optional": false + } + ] + }, + "model": "SchemaFiles" + }, + "/regulators/sec/symbol_map": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Map a CIK number to a ticker symbol, leading 0s can be omitted or included.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.symbol_map(query='0000789019', provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", + "optional": false + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache. If True, cache will store for seven days.", + "default": true, + "optional": true + }, + { + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", + "optional": true + } + ], + "sec": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[SymbolMap]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['sec']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + } + ] + }, + "model": "SymbolMap" + }, + "/regulators/sec/rss_litigation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the RSS feed that provides links to litigation releases concerning civil lawsuits brought by the Commission in federal court.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.rss_litigation(provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", + "optional": true + } + ], + "sec": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[RssLitigation]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['sec']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "published", + "type": "datetime", + "description": "The date of publication.", + "default": "", + "optional": false + }, + { + "name": "title", + "type": "str", + "description": "The title of the release.", + "default": "", + "optional": false + }, + { + "name": "summary", + "type": "str", + "description": "Short summary of the release.", + "default": "", + "optional": false + }, + { + "name": "id", + "type": "str", + "description": "The identifier associated with the release.", + "default": "", + "optional": false + }, + { + "name": "link", + "type": "str", + "description": "URL to the release.", + "default": "", + "optional": false + } + ] + }, + "model": "RssLitigation" + }, + "/regulators/sec/sic_search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search for Industry Titles, Reporting Office, and SIC Codes. An empty query string returns all results.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.sic_search(provider='sec')\nobb.regulators.sec.sic_search(query='real estate investment trusts', provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache.", + "default": true, + "optional": true + }, + { + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", + "optional": true + } + ], + "sec": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[SicSearch]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['sec']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "sic", + "type": "int", + "description": "Sector Industrial Code (SIC)", + "default": "", + "optional": false + }, + { + "name": "industry", + "type": "str", + "description": "Industry title.", + "default": "", + "optional": false + }, + { + "name": "office", + "type": "str", + "description": "Reporting office within the Corporate Finance Office", + "default": "", + "optional": false + } + ] + }, + "model": "SicSearch" + } + }, + "routers": { + "/crypto": { + "description": "Cryptocurrency market data." + }, + "/currency": { + "description": "Foreign exchange (FX) market data." + }, + "/derivatives": { + "description": "Derivatives market data." + }, + "/economy": { + "description": "Economic data." + }, + "/equity": { + "description": "Equity market data." + }, + "/etf": { + "description": "Exchange Traded Funds market data." + }, + "/fixedincome": { + "description": "Fixed Income market data." + }, + "/index": { + "description": "Indices data." + }, + "/news": { + "description": "Financial market news data." + }, + "/regulators": { + "description": "Financial market regulators data." + } + } +} \ No newline at end of file From f05826de6e79f813b2d0418b29c5a3df65121084 Mon Sep 17 00:00:00 2001 From: hjoaquim Date: Thu, 9 May 2024 16:26:51 +0100 Subject: [PATCH 23/24] cli fix: if the argument is required (aka standard) it means we don't want to touch it, unless choices need to be added --- .../argparse_translator/argparse_translator.py | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/cli/openbb_cli/argparse_translator/argparse_translator.py b/cli/openbb_cli/argparse_translator/argparse_translator.py index bf5917207d50..3b1a8c6d29cf 100644 --- a/cli/openbb_cli/argparse_translator/argparse_translator.py +++ b/cli/openbb_cli/argparse_translator/argparse_translator.py @@ -225,9 +225,9 @@ def __init__( def _handle_argument_in_groups(self, argument, group): """Handle the argument and add it to the parser.""" - def _in_optional_arguments(arg): + def _in_group(arg, group_title): for action_group in self._parser._action_groups: - if action_group.title == "optional arguments": + if action_group.title == group_title: for action in action_group._group_actions: opts = action.option_strings if (opts and opts[0] == arg) or action.dest == arg: @@ -286,12 +286,21 @@ def _update_providers( # extend choices choices = tuple(set(_get_arg_choices(argument.name) + model_choices)) + # check if the argument is in the required arguments + if _in_group(argument.name, group_title="required arguments"): + for action in self._required._group_actions: + if action.dest == argument.name and choices: + # update choices + action.choices = choices + return + # check if the argument is in the optional arguments - if _in_optional_arguments(argument.name): + if _in_group(argument.name, group_title="optional arguments"): for action in self._parser._actions: if action.dest == argument.name: # update choices - action.choices = choices + if choices: + action.choices = choices # update help action.help = _update_providers( action.help or "", [group.title] From 12cf07e3a0195c98010ecc842be2449c0d3ece60 Mon Sep 17 00:00:00 2001 From: hjoaquim Date: Thu, 9 May 2024 16:37:48 +0100 Subject: [PATCH 24/24] cli fix: touch the help message (with the available providers) only if it's not on the signature (aka standard field) --- .../argparse_translator/argparse_translator.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/cli/openbb_cli/argparse_translator/argparse_translator.py b/cli/openbb_cli/argparse_translator/argparse_translator.py index 3b1a8c6d29cf..001e7afce04d 100644 --- a/cli/openbb_cli/argparse_translator/argparse_translator.py +++ b/cli/openbb_cli/argparse_translator/argparse_translator.py @@ -301,10 +301,11 @@ def _update_providers( # update choices if choices: action.choices = choices - # update help - action.help = _update_providers( - action.help or "", [group.title] - ) + if argument.name not in self.signature.parameters: + # update help + action.help = _update_providers( + action.help or "", [group.title] + ) return # if the argument is in use, remove it from all groups