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 20b2fc433a8e..9de60e148376 100644 --- a/openbb_platform/core/openbb_core/app/static/package_builder.py +++ b/openbb_platform/core/openbb_core/app/static/package_builder.py @@ -3,13 +3,15 @@ # pylint: disable=too-many-lines import builtins import inspect +import re import shutil import sys from dataclasses import Field from inspect import Parameter, _empty, isclass, signature -from json import dumps, load +from json import dump, dumps, load from pathlib import Path from typing import ( + Any, Callable, Dict, List, @@ -112,9 +114,9 @@ def build( self._clean(modules) ext_map = self._get_extension_map() self._save_extension_map(ext_map) - self._save_module_map() self._save_modules(modules, ext_map) self._save_package() + self._save_reference_file() if self.lint: self._run_linters() @@ -147,17 +149,6 @@ def _save_extension_map(self, ext_map: Dict[str, List[str]]) -> None: self.console.log("Writing extension map...") self._write(code=code, name="extension_map", extension="json", folder="assets") - def _save_module_map(self): - """Save the module map.""" - route_map = PathHandler.build_route_map() - path_list = PathHandler.build_path_list(route_map=route_map) - module_map = { - PathHandler.build_module_name(path=path): path for path in path_list - } - code = dumps(obj=dict(sorted(module_map.items())), indent=4) - self.console.log("\nWriting module map...") - self._write(code=code, name="module_map", extension="json", folder="assets") - def _save_modules( self, modules: Optional[Union[str, List[str]]] = None, @@ -194,6 +185,16 @@ def _save_package(self): code = "### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###\n" self._write(code=code, name="__init__") + def _save_reference_file(self): + """Save the reference.json file.""" + self.console.log("\nWriting reference file...") + data = ReferenceGenerator.get_reference_data() + file_path = self.directory / "assets" / "reference.json" + # Dumping the reference dictionary as a JSON file + self.console.log(str(file_path)) + with open(file_path, "w", encoding="utf-8") as f: + dump(data, f, indent=4) + def _run_linters(self): """Run the linters.""" self.console.log("\nRunning linters...") @@ -886,12 +887,14 @@ class DocstringGenerator: @staticmethod def get_field_type( - field: FieldInfo, target: Literal["docstring", "website"] = "docstring" + field_type: Any, + is_required: bool, + target: Literal["docstring", "website"] = "docstring", ) -> str: """Get the implicit data type of a defined Pydantic field. - Args - ---- + Parameters + ---------- field (FieldInfo): Pydantic field object containing field information. target (Literal["docstring", "website"], optional): Target to return type for. Defaults to "docstring". @@ -899,10 +902,10 @@ def get_field_type( ------- str: String representation of the field type. """ - is_optional = not field.is_required() if target == "docstring" else False + is_optional = not is_required try: - _type = field.annotation + _type = field_type if "BeforeValidator" in str(_type): _type = "Optional[int]" if is_optional else "int" # type: ignore @@ -918,38 +921,47 @@ def get_field_type( .replace("NoneType", "None") .replace(", None", "") ) + field_type = ( f"Optional[{field_type}]" if is_optional and "Optional" not in str(_type) else field_type ) + + if target == "website": + field_type = re.sub(r"Optional\[(.*)\]", r"\1", field_type) + field_type = re.sub(r"Annotated\[(.*)\]", r"\1", field_type) + + return field_type + except TypeError: # Fallback to the annotation if the repr fails - field_type = field.annotation # type: ignore - - return field_type + return field_type # type: ignore @staticmethod def get_OBBject_description( results_type: str, providers: Optional[str], + target: Literal["docstring", "website"] = "docstring", ) -> str: """Get the command output description.""" available_providers = providers or "Optional[str]" + indent = 2 if target == "docstring" else 0 obbject_description = ( - f"{create_indent(2)}OBBject\n" - f"{create_indent(3)}results : {results_type}\n" - f"{create_indent(4)}Serializable results.\n" - f"{create_indent(3)}provider : {available_providers}\n" - f"{create_indent(4)}Provider name.\n" - f"{create_indent(3)}warnings : Optional[List[Warning_]]\n" - f"{create_indent(4)}List of warnings.\n" - f"{create_indent(3)}chart : Optional[Chart]\n" - f"{create_indent(4)}Chart object.\n" - f"{create_indent(3)}extra : Dict[str, Any]\n" - f"{create_indent(4)}Extra info.\n" + f"{create_indent(indent)}OBBject\n" + f"{create_indent(indent+1)}results : {results_type}\n" + f"{create_indent(indent+2)}Serializable results.\n" + f"{create_indent(indent+1)}provider : {available_providers}\n" + f"{create_indent(indent+2)}Provider name.\n" + f"{create_indent(indent+1)}warnings : Optional[List[Warning_]]\n" + f"{create_indent(indent+2)}List of warnings.\n" + f"{create_indent(indent+1)}chart : Optional[Chart]\n" + f"{create_indent(indent+2)}Chart object.\n" + f"{create_indent(indent+1)}extra : Dict[str, Any]\n" + f"{create_indent(indent+2)}Extra info.\n" ) + obbject_description = obbject_description.replace("NoneType", "None") return obbject_description @@ -1066,7 +1078,7 @@ def get_param_info(parameter: Parameter) -> Tuple[str, str]: docstring += f"{create_indent(2)}{underline}\n" for name, field in returns.items(): - field_type = cls.get_field_type(field) + field_type = cls.get_field_type(field.annotation, field.is_required()) description = getattr(field, "description", "") docstring += f"{create_indent(2)}{field.alias or name} : {field_type}\n" docstring += f"{create_indent(3)}{format_description(description)}\n" @@ -1190,3 +1202,376 @@ def build_module_class(cls, path: str) -> str: if not path: return "Extensions" return f"ROUTER_{cls.clean_path(path=path)}" + + +class ReferenceGenerator: + """Generate the reference for the Platform.""" + + REFERENCE_FIELDS = [ + "deprecated", + "description", + "examples", + "parameters", + "returns", + "data", + ] + + # pylint: disable=protected-access + pi = DocstringGenerator.provider_interface + + @classmethod + def get_endpoint_examples( + cls, + path: str, + func: Callable, + examples: Optional[List[Example]], + ) -> str: + """Get the examples for the given standard model or function. + + For a given standard model or function, the examples are fetched from the + list of Example objects and formatted into a string. + + Parameters + ---------- + path (str): + Path of the router. + func (Callable): + Router endpoint function. + examples (Optional[List[Example]]): + List of Examples (APIEx or PythonEx type) + for the endpoint. + + Returns + ------- + str: + Formatted string containing the examples for the endpoint. + """ + sig = signature(func) + parameter_map = dict(sig.parameters) + formatted_params = MethodDefinition.format_params( + path=path, parameter_map=parameter_map + ) + explicit_params = dict(formatted_params) + explicit_params.pop("extra_params", None) + param_types = {k: v.annotation for k, v in explicit_params.items()} + + return DocstringGenerator.build_examples( + path.replace("/", "."), + param_types, + examples, + "website", + ) + + @classmethod + def get_provider_parameter_info(cls, model: str) -> Dict[str, str]: + """Get the name, type, description, default value and optionality information for the provider parameter. + + Parameters + ---------- + model (str): + Standard model to access the model providers. + + Returns + ------- + Dict[str, str]: + Dictionary of the provider parameter information + """ + pi_model_provider = cls.pi.model_providers[model] + provider_params_field = pi_model_provider.__dataclass_fields__["provider"] + + name = provider_params_field.name + field_type = DocstringGenerator.get_field_type( + provider_params_field.type, False, "website" + ) + default = provider_params_field.type.__args__[0] + description = ( + "The provider to use for the query, by default None. " + "If None, the provider specified in defaults is selected " + f"or '{default}' if there is no default." + ) + + provider_parameter_info = { + "name": name, + "type": field_type, + "description": description, + "default": default, + "optional": True, + } + + return provider_parameter_info + + @classmethod + def get_provider_field_params( + cls, + model: str, + params_type: str, + provider: str = "openbb", + ) -> List[Dict[str, Any]]: + """Get the fields of the given parameter type for the given provider of the standard_model. + + Parameters + ---------- + model (str): + Model name to access the provider interface + params_type (str): + Parameters to fetch data for (QueryParams or Data) + provider (str, optional): + Provider name. Defaults to "openbb". + + Returns + ------- + List[Dict[str, str]]: + List of dictionaries containing the field name, type, description, default, + optional flag and standard flag for each provider. + """ + provider_field_params = [] + expanded_types = MethodDefinition.TYPE_EXPANSION + model_map = cls.pi._map[model] # pylint: disable=protected-access + + 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 + is_required = field_info.is_required() + field_type = DocstringGenerator.get_field_type( + field_type, is_required, "website" + ) + + if params_type == "QueryParams" and field in expanded_types: + expanded_type = DocstringGenerator.get_field_type( + expanded_types[field], is_required, "website" + ) + field_type = f"Union[{field_type}, {expanded_type}]" + + cleaned_description = ( + str(field_info.description) + .strip().replace("\n", " ").replace(" ", " ").replace('"', "'") + ) # 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) + cleaned_description += ( + f" Multiple items allowed for provider(s): {multiple_items}." + ) + # Manually setting to List[] for multiple items + # Should be removed if TYPE_EXPANSION is updated to include this + field_type = f"Union[{field_type}, List[{field_type}]]" + + default_value = "" if field_info.default is PydanticUndefined else str(field_info.default) # fmt: skip + + provider_field_params.append( + { + "name": field, + "type": field_type, + "description": cleaned_description, + "default": default_value, + "optional": not is_required, + } + ) + + return provider_field_params + + @staticmethod + def get_post_method_parameters_info( + docstring: str, + ) -> List[Dict[str, Union[bool, str]]]: + """Get the parameters for the POST method endpoints. + + Parameters + ---------- + docstring (str): + Router endpoint function's docstring + + Returns + ------- + List[Dict[str, str]]: + List of dictionaries containing the name,type, description, default + and optionality of each parameter. + """ + # Define a regex pattern to match parameter blocks + # This pattern looks for a parameter name followed by " : ", then captures the type and description + pattern = re.compile( + r"\n\s*(?P\w+)\s*:\s*(?P[^\n]+?)(?:\s*=\s*(?P[^\n]+))?\n\s*(?P[^\n]+)" + ) + + # Find all matches in the docstring + matches = pattern.finditer(docstring) + + # Initialize an empty list to store parameter dictionaries + parameters_list = [] + + # Iterate over the matches to extract details + for match in matches: + # Extract named groups as a dictionary + param_info = match.groupdict() + + # Determine if the parameter is optional + is_optional = "Optional" in param_info["type"] + + # If no default value is captured, set it to an empty string + default_value = ( + param_info["default"] if param_info["default"] is not None else "" + ) + + # Create a new dictionary with fields in the desired order + param_dict = { + "name": param_info["name"], + "type": param_info["type"], + "description": param_info["description"], + "default": default_value, + "optional": is_optional, + } + + # Append the dictionary to the list + parameters_list.append(param_dict) + + return parameters_list + + @staticmethod + def get_post_method_returns_info(docstring: str) -> str: + """Get the returns information for the POST method endpoints. + + Parameters + ---------- + docstring (str): + Router endpoint function's docstring + + Returns + ------- + Dict[str, str]: + Dictionary containing the name, type, description of the return value + """ + # Define a regex pattern to match the Returns section + # This pattern captures the model name inside "OBBject[]" and its description + match = re.search(r"Returns\n\s*-------\n\s*([^\n]+)\n\s*([^\n]+)", docstring) + return_type = match.group(1).strip() # type: ignore + # Remove newlines and indentation from the description + description = match.group(2).strip().replace("\n", "").replace(" ", "") # type: ignore + # Adjust regex to correctly capture content inside brackets, including nested brackets + content_inside_brackets = re.search( + r"OBBject\[\s*((?:[^\[\]]|\[[^\[\]]*\])*)\s*\]", return_type + ) + return_type_content = content_inside_brackets.group(1) # type: ignore + + return_info = ( + f"OBBject\n" + f"{create_indent(1)}results : {return_type_content}\n" + f"{create_indent(2)}{description}" + ) + + return return_info + + @classmethod + def get_reference_data(cls) -> Dict[str, Dict[str, Any]]: + """Get the reference data for the Platform. + + The reference data is a dictionary containing the description, parameters, + returns and examples for each endpoint. This is currently useful for + automating the creation of the website documentation files. + + Returns + ------- + Dict[str, Dict[str, Any]]: + Dictionary containing the description, parameters, returns and + examples for each endpoint. + """ + reference: Dict[str, Dict] = {} + route_map = PathHandler.build_route_map() + + for path, route in route_map.items(): + # Initialize the reference fields as empty dictionaries + reference[path] = {field: {} for field in cls.REFERENCE_FIELDS} + # Route method is used to distinguish between GET and POST methods + route_method = getattr(route, "methods", None) + # Route endpoint is the callable function + route_func = getattr(route, "endpoint", None) + # Attribute contains the model and examples info for the endpoint + openapi_extra = getattr(route, "openapi_extra", {}) + # Standard model is used as the key for the ProviderInterface Map dictionary + standard_model = openapi_extra.get("model", "") + # Add endpoint model for GET methods + reference[path]["model"] = standard_model + # Add endpoint deprecation details + reference[path]["deprecated"] = { + "flag": MethodDefinition.is_deprecated_function(path), + "message": MethodDefinition.get_deprecation_message(path), + } + # Add endpoint examples + examples = openapi_extra.get("examples", []) + reference[path]["examples"] = cls.get_endpoint_examples( + path, route_func, examples # type: ignore + ) + # Add data for the endpoints having a standard model + if route_method == {"GET"}: + reference[path]["description"] = getattr( + route, "description", "No description available." + ) + # Access model map from the ProviderInterface + model_map = cls.pi._map[ + standard_model + ] # pylint: disable=protected-access + + for provider in model_map: + if provider == "openbb": + # openbb provider is always present hence its the standard field + reference[path]["parameters"]["standard"] = ( + cls.get_provider_field_params(standard_model, "QueryParams") + ) + # Add `provider` parameter fields to the openbb provider + provider_parameter_fields = cls.get_provider_parameter_info( + standard_model + ) + reference[path]["parameters"]["standard"].append( + provider_parameter_fields + ) + + # Add endpoint data fields for standard provider + reference[path]["data"]["standard"] = ( + cls.get_provider_field_params(standard_model, "Data") + ) + continue + # Adds provider specific parameter fields to the reference + reference[path]["parameters"][provider] = ( + cls.get_provider_field_params( + standard_model, "QueryParams", provider + ) + ) + # Adds provider specific data fields to the reference + reference[path]["data"][provider] = cls.get_provider_field_params( + standard_model, "Data", provider + ) + # Add endpoint returns data + # Currently only OBBject object is returned + providers = provider_parameter_fields["type"] + reference[path]["returns"]["OBBject"] = ( + DocstringGenerator.get_OBBject_description( + standard_model, providers, "website" + ) + ) + # Add data for the endpoints without a standard model (data processing endpoints) + elif route_method == {"POST"}: + # POST method router `description` attribute is unreliable as it may or + # may not contain the "Parameters" and "Returns" sections. Hence, the + # endpoint function docstring is used instead. + description = route_func.__doc__.split("Parameters")[0].strip() # type: ignore + # Remove extra spaces in between the string + reference[path]["description"] = re.sub(" +", " ", description) + # Add endpoint parameters fields for POST methods + reference[path]["parameters"][ + "standard" + ] = ReferenceGenerator.get_post_method_parameters_info( + route_func.__doc__ # type: ignore + ) + # Add endpoint returns data + # Currently only OBBject object is returned + reference[path]["returns"][ + "OBBject" + ] = cls.get_post_method_returns_info( + route_func.__doc__ # type: ignore + ) + + return reference diff --git a/openbb_platform/core/tests/app/static/test_package_builder.py b/openbb_platform/core/tests/app/static/test_package_builder.py index eb1fe3a1d2e2..aa7c00294757 100644 --- a/openbb_platform/core/tests/app/static/test_package_builder.py +++ b/openbb_platform/core/tests/app/static/test_package_builder.py @@ -46,11 +46,6 @@ def test_package_builder_build(package_builder): package_builder.build() -def test_save_module_map(package_builder): - """Test save module map.""" - package_builder._save_module_map() - - def test_save_modules(package_builder): """Test save module.""" package_builder._save_modules() diff --git a/openbb_platform/extensions/econometrics/openbb_econometrics/econometrics_router.py b/openbb_platform/extensions/econometrics/openbb_econometrics/econometrics_router.py index bb9f2bd9a43d..f4c8f48386e5 100644 --- a/openbb_platform/extensions/econometrics/openbb_econometrics/econometrics_router.py +++ b/openbb_platform/extensions/econometrics/openbb_econometrics/econometrics_router.py @@ -58,7 +58,7 @@ def correlation_matrix(data: List[Data]) -> OBBject[List[Data]]: Returns ------- - OBBject[List[Data]]: + OBBject[List[Data]] Correlation matrix. """ df = basemodel_to_df(data) @@ -120,7 +120,7 @@ def ols_regression( Returns ------- - OBBject[Dict]: + OBBject[Dict] OBBject with the results being model and results objects. """ X = sm.add_constant(get_target_columns(basemodel_to_df(data), x_columns)) @@ -169,7 +169,7 @@ def ols_regression_summary( Returns ------- - OBBject[Data]: + OBBject[Data] OBBject with the results being summary object. """ X = sm.add_constant(get_target_columns(basemodel_to_df(data), x_columns)) @@ -260,7 +260,7 @@ def autocorrelation( Returns ------- - OBBject[Dict]: + OBBject[Dict] OBBject with the results being the score from the test. """ X = sm.add_constant(get_target_columns(basemodel_to_df(data), x_columns)) @@ -317,7 +317,7 @@ def residual_autocorrelation( Returns ------- - OBBject[Data]: + OBBject[Data] OBBject with the results being the score from the test. """ X = sm.add_constant(get_target_columns(basemodel_to_df(data), x_columns)) @@ -374,7 +374,7 @@ def cointegration( Returns ------- - OBBject[Data]: + OBBject[Data] OBBject with the results being the score from the test. """ pairs = list(combinations(columns, 2)) @@ -450,7 +450,7 @@ def causality( Returns ------- - OBBject[Data]: + OBBject[Data] OBBject with the results being the score from the test. """ X = get_target_column(basemodel_to_df(data), x_column) @@ -518,7 +518,7 @@ def unit_root( Returns ------- - OBBject[Data]: + OBBject[Data] OBBject with the results being the score from the test. """ dataset = get_target_column(basemodel_to_df(data), column) @@ -568,7 +568,7 @@ def panel_random_effects( Returns ------- - OBBject[Dict]: + OBBject[Dict] OBBject with the fit model returned """ X = get_target_columns(basemodel_to_df(data), x_columns) @@ -615,7 +615,7 @@ def panel_between( Returns ------- - OBBject[Dict]: + OBBject[Dict] OBBject with the fit model returned """ X = get_target_columns(basemodel_to_df(data), x_columns) @@ -661,7 +661,7 @@ def panel_pooled( Returns ------- - OBBject[Dict]: + OBBject[Dict] OBBject with the fit model returned """ X = get_target_columns(basemodel_to_df(data), x_columns) @@ -706,7 +706,7 @@ def panel_fixed( Returns ------- - OBBject[Dict]: + OBBject[Dict] OBBject with the fit model returned """ X = get_target_columns(basemodel_to_df(data), x_columns) @@ -751,7 +751,7 @@ def panel_first_difference( Returns ------- - OBBject[Dict]: + OBBject[Dict] OBBject with the fit model returned """ X = get_target_columns(basemodel_to_df(data), x_columns) @@ -797,7 +797,7 @@ def panel_fmac( Returns ------- - OBBject[Dict]: + OBBject[Dict] OBBject with the fit model returned """ X = get_target_columns(basemodel_to_df(data), x_columns) diff --git a/openbb_platform/extensions/quantitative/openbb_quantitative/rolling/rolling_router.py b/openbb_platform/extensions/quantitative/openbb_quantitative/rolling/rolling_router.py index fb02b5f051a7..34ef9be67a1b 100644 --- a/openbb_platform/extensions/quantitative/openbb_quantitative/rolling/rolling_router.py +++ b/openbb_platform/extensions/quantitative/openbb_quantitative/rolling/rolling_router.py @@ -76,7 +76,6 @@ def skew( Rolling skew. """ - df = basemodel_to_df(data, index=index) series_target = get_target_column(df, target) series_target.name = f"rolling_skew_{window}" @@ -132,7 +131,7 @@ def variance( index: str, optional The name of the index column, default is "date". - Returns: + Returns ------- OBBject[List[Data]] An object containing the rolling variance values. @@ -177,8 +176,8 @@ def stdev( Calculate the rolling standard deviation of a target column within a given window size. Standard deviation is a measure of the amount of variation or dispersion of a set of values. - It is widely used to assess the risk and volatility of financial returns or other time series data - over a specified rolling window. It is the square root of the variance. + It is widely used to assess the risk and volatility of financial returns or other time series data + over a specified rolling window. It is the square root of the variance. Parameters ---------- @@ -191,12 +190,11 @@ def stdev( index: str, optional The name of the index column, default is "date". - Returns: + Returns ------- OBBject[List[Data]] An object containing the rolling standard deviation values. """ - df = basemodel_to_df(data, index=index) series_target = get_target_column(df, target) series_target.name = f"rolling_stdev_{window}" @@ -255,12 +253,11 @@ def kurtosis( index: str, optional The name of the index column, default is "date". - Returns: + Returns ------- OBBject[List[Data]] An object containing the rolling kurtosis values. """ - df = basemodel_to_df(data, index=index) series_target = get_target_column(df, target) series_target.name = f"rolling_kurtosis_{window}" @@ -324,12 +321,11 @@ def quantile( index: str, optional The name of the index column, default is "date". - Returns: + Returns ------- OBBject[List[Data]] An object containing the rolling quantile values with the median. """ - df = basemodel_to_df(data, index=index) series_target = get_target_column(df, target) validate_window(series_target, window) @@ -398,11 +394,11 @@ def mean( index: str, optional The name of the index column, default is "date". - Returns: - OBBject[List[Data]] - An object containing the rolling mean values. + Returns + ------- + OBBject[List[Data]] + An object containing the rolling mean values. """ - df = basemodel_to_df(data, index=index) series_target = get_target_column(df, target) series_target.name = f"rolling_mean_{window}" diff --git a/openbb_platform/extensions/quantitative/openbb_quantitative/stats/stats_router.py b/openbb_platform/extensions/quantitative/openbb_quantitative/stats/stats_router.py index 41e93a160208..68be4b675cfc 100644 --- a/openbb_platform/extensions/quantitative/openbb_quantitative/stats/stats_router.py +++ b/openbb_platform/extensions/quantitative/openbb_quantitative/stats/stats_router.py @@ -50,7 +50,7 @@ def skew( data: List[Data], target: str, ) -> OBBject[List[Data]]: - """Get the skew. of the data set + """Get the skew of the data set. Skew is a statistical measure that reveals the degree of asymmetry of a distribution around its mean. Positive skewness indicates a distribution with an extended tail to the right, while negative skewness shows a tail @@ -70,7 +70,6 @@ def skew( OBBject[List[Data]] Rolling skew. """ - df = basemodel_to_df(data) series_target = get_target_column(df, target) results = pd.DataFrame([skew_(series_target)], columns=["skew"]) @@ -170,7 +169,6 @@ def stdev(data: List[Data], target: str) -> OBBject[List[Data]]: OBBject[List[Data]] An object containing the rolling standard deviation values. """ - df = basemodel_to_df(data) series_target = get_target_column(df, target) results = pd.DataFrame([std_dev_(series_target)], columns=["stdev"]) @@ -218,11 +216,10 @@ def kurtosis(data: List[Data], target: str) -> OBBject[List[Data]]: The name of the column for which to calculate kurtosis. Returns - ------ + ------- OBBject[List[Data]] An object containing the kurtosis value """ - df = basemodel_to_df(data) series_target = get_target_column(df, target) results = pd.DataFrame([kurtosis_(series_target)], columns=["kurtosis"]) @@ -278,7 +275,6 @@ def quantile( OBBject[List[Data]] An object containing the rolling quantile values with the median. """ - df = basemodel_to_df( data, ) @@ -335,7 +331,6 @@ def mean( OBBject[List[Data]] An object containing the mean value. """ - df = basemodel_to_df(data) series_target = get_target_column(df, target) results = pd.DataFrame([mean_(series_target)], columns=["mean"]) diff --git a/openbb_platform/extensions/technical/openbb_technical/technical_router.py b/openbb_platform/extensions/technical/openbb_technical/technical_router.py index b516585115ad..69405a3e3fe4 100644 --- a/openbb_platform/extensions/technical/openbb_technical/technical_router.py +++ b/openbb_platform/extensions/technical/openbb_technical/technical_router.py @@ -315,6 +315,7 @@ def adosc( Returns ------- OBBject[List[Data]] + The calculated data. """ validate_data(data, [fast, slow]) df = basemodel_to_df(data, index=index) @@ -1093,6 +1094,7 @@ def ad(data: List[Data], index: str = "date", offset: int = 0) -> OBBject[List[D Returns ------- OBBject[List[Data]] + The calculated data. """ df = basemodel_to_df(data, index=index) df_target = get_target_columns(df, ["high", "low", "close", "volume"]) diff --git a/openbb_platform/openbb/assets/extension_map.json b/openbb_platform/openbb/assets/extension_map.json index c326eda7652f..74405cc2f074 100644 --- a/openbb_platform/openbb/assets/extension_map.json +++ b/openbb_platform/openbb/assets/extension_map.json @@ -12,6 +12,7 @@ "news@1.1.3", "regulators@1.1.3" ], + "openbb_obbject_extension": [], "openbb_provider_extension": [ "benzinga@1.1.3", "federal_reserve@1.1.3", diff --git a/openbb_platform/openbb/assets/module_map.json b/openbb_platform/openbb/assets/module_map.json deleted file mode 100644 index 0163f3c6803c..000000000000 --- a/openbb_platform/openbb/assets/module_map.json +++ /dev/null @@ -1,152 +0,0 @@ -{ - "__extensions__": "", - "crypto": "/crypto", - "crypto_price": "/crypto/price", - "crypto_price_historical": "/crypto/price/historical", - "crypto_search": "/crypto/search", - "currency": "/currency", - "currency_price": "/currency/price", - "currency_price_historical": "/currency/price/historical", - "currency_search": "/currency/search", - "currency_snapshots": "/currency/snapshots", - "derivatives": "/derivatives", - "derivatives_futures": "/derivatives/futures", - "derivatives_futures_curve": "/derivatives/futures/curve", - "derivatives_futures_historical": "/derivatives/futures/historical", - "derivatives_options": "/derivatives/options", - "derivatives_options_chains": "/derivatives/options/chains", - "derivatives_options_unusual": "/derivatives/options/unusual", - "economy": "/economy", - "economy_calendar": "/economy/calendar", - "economy_composite_leading_indicator": "/economy/composite_leading_indicator", - "economy_cpi": "/economy/cpi", - "economy_fred_regional": "/economy/fred_regional", - "economy_fred_search": "/economy/fred_search", - "economy_fred_series": "/economy/fred_series", - "economy_gdp": "/economy/gdp", - "economy_gdp_forecast": "/economy/gdp/forecast", - "economy_gdp_nominal": "/economy/gdp/nominal", - "economy_gdp_real": "/economy/gdp/real", - "economy_long_term_interest_rate": "/economy/long_term_interest_rate", - "economy_money_measures": "/economy/money_measures", - "economy_risk_premium": "/economy/risk_premium", - "economy_short_term_interest_rate": "/economy/short_term_interest_rate", - "economy_unemployment": "/economy/unemployment", - "equity": "/equity", - "equity_calendar": "/equity/calendar", - "equity_calendar_dividend": "/equity/calendar/dividend", - "equity_calendar_earnings": "/equity/calendar/earnings", - "equity_calendar_ipo": "/equity/calendar/ipo", - "equity_calendar_splits": "/equity/calendar/splits", - "equity_compare": "/equity/compare", - "equity_compare_peers": "/equity/compare/peers", - "equity_discovery": "/equity/discovery", - "equity_discovery_active": "/equity/discovery/active", - "equity_discovery_aggressive_small_caps": "/equity/discovery/aggressive_small_caps", - "equity_discovery_filings": "/equity/discovery/filings", - "equity_discovery_gainers": "/equity/discovery/gainers", - "equity_discovery_growth_tech": "/equity/discovery/growth_tech", - "equity_discovery_losers": "/equity/discovery/losers", - "equity_discovery_undervalued_growth": "/equity/discovery/undervalued_growth", - "equity_discovery_undervalued_large_caps": "/equity/discovery/undervalued_large_caps", - "equity_estimates": "/equity/estimates", - "equity_estimates_analyst_search": "/equity/estimates/analyst_search", - "equity_estimates_consensus": "/equity/estimates/consensus", - "equity_estimates_historical": "/equity/estimates/historical", - "equity_estimates_price_target": "/equity/estimates/price_target", - "equity_fundamental": "/equity/fundamental", - "equity_fundamental_balance": "/equity/fundamental/balance", - "equity_fundamental_balance_growth": "/equity/fundamental/balance_growth", - "equity_fundamental_cash": "/equity/fundamental/cash", - "equity_fundamental_cash_growth": "/equity/fundamental/cash_growth", - "equity_fundamental_dividends": "/equity/fundamental/dividends", - "equity_fundamental_employee_count": "/equity/fundamental/employee_count", - "equity_fundamental_filings": "/equity/fundamental/filings", - "equity_fundamental_historical_attributes": "/equity/fundamental/historical_attributes", - "equity_fundamental_historical_eps": "/equity/fundamental/historical_eps", - "equity_fundamental_historical_splits": "/equity/fundamental/historical_splits", - "equity_fundamental_income": "/equity/fundamental/income", - "equity_fundamental_income_growth": "/equity/fundamental/income_growth", - "equity_fundamental_latest_attributes": "/equity/fundamental/latest_attributes", - "equity_fundamental_management": "/equity/fundamental/management", - "equity_fundamental_management_compensation": "/equity/fundamental/management_compensation", - "equity_fundamental_metrics": "/equity/fundamental/metrics", - "equity_fundamental_multiples": "/equity/fundamental/multiples", - "equity_fundamental_overview": "/equity/fundamental/overview", - "equity_fundamental_ratios": "/equity/fundamental/ratios", - "equity_fundamental_reported_financials": "/equity/fundamental/reported_financials", - "equity_fundamental_revenue_per_geography": "/equity/fundamental/revenue_per_geography", - "equity_fundamental_revenue_per_segment": "/equity/fundamental/revenue_per_segment", - "equity_fundamental_search_attributes": "/equity/fundamental/search_attributes", - "equity_fundamental_trailing_dividend_yield": "/equity/fundamental/trailing_dividend_yield", - "equity_fundamental_transcript": "/equity/fundamental/transcript", - "equity_market_snapshots": "/equity/market_snapshots", - "equity_ownership": "/equity/ownership", - "equity_ownership_form_13f": "/equity/ownership/form_13f", - "equity_ownership_insider_trading": "/equity/ownership/insider_trading", - "equity_ownership_institutional": "/equity/ownership/institutional", - "equity_ownership_major_holders": "/equity/ownership/major_holders", - "equity_ownership_share_statistics": "/equity/ownership/share_statistics", - "equity_price": "/equity/price", - "equity_price_historical": "/equity/price/historical", - "equity_price_nbbo": "/equity/price/nbbo", - "equity_price_performance": "/equity/price/performance", - "equity_price_quote": "/equity/price/quote", - "equity_profile": "/equity/profile", - "equity_screener": "/equity/screener", - "equity_search": "/equity/search", - "equity_shorts": "/equity/shorts", - "equity_shorts_fails_to_deliver": "/equity/shorts/fails_to_deliver", - "etf": "/etf", - "etf_countries": "/etf/countries", - "etf_equity_exposure": "/etf/equity_exposure", - "etf_historical": "/etf/historical", - "etf_holdings": "/etf/holdings", - "etf_holdings_date": "/etf/holdings_date", - "etf_holdings_performance": "/etf/holdings_performance", - "etf_info": "/etf/info", - "etf_price_performance": "/etf/price_performance", - "etf_search": "/etf/search", - "etf_sectors": "/etf/sectors", - "fixedincome": "/fixedincome", - "fixedincome_corporate": "/fixedincome/corporate", - "fixedincome_corporate_commercial_paper": "/fixedincome/corporate/commercial_paper", - "fixedincome_corporate_hqm": "/fixedincome/corporate/hqm", - "fixedincome_corporate_ice_bofa": "/fixedincome/corporate/ice_bofa", - "fixedincome_corporate_moody": "/fixedincome/corporate/moody", - "fixedincome_corporate_spot_rates": "/fixedincome/corporate/spot_rates", - "fixedincome_government": "/fixedincome/government", - "fixedincome_government_treasury_rates": "/fixedincome/government/treasury_rates", - "fixedincome_government_us_yield_curve": "/fixedincome/government/us_yield_curve", - "fixedincome_rate": "/fixedincome/rate", - "fixedincome_rate_ameribor": "/fixedincome/rate/ameribor", - "fixedincome_rate_dpcredit": "/fixedincome/rate/dpcredit", - "fixedincome_rate_ecb": "/fixedincome/rate/ecb", - "fixedincome_rate_effr": "/fixedincome/rate/effr", - "fixedincome_rate_effr_forecast": "/fixedincome/rate/effr_forecast", - "fixedincome_rate_estr": "/fixedincome/rate/estr", - "fixedincome_rate_iorb": "/fixedincome/rate/iorb", - "fixedincome_rate_sonia": "/fixedincome/rate/sonia", - "fixedincome_sofr": "/fixedincome/sofr", - "fixedincome_spreads": "/fixedincome/spreads", - "fixedincome_spreads_tcm": "/fixedincome/spreads/tcm", - "fixedincome_spreads_tcm_effr": "/fixedincome/spreads/tcm_effr", - "fixedincome_spreads_treasury_effr": "/fixedincome/spreads/treasury_effr", - "index": "/index", - "index_available": "/index/available", - "index_constituents": "/index/constituents", - "index_market": "/index/market", - "index_price": "/index/price", - "index_price_historical": "/index/price/historical", - "news": "/news", - "news_company": "/news/company", - "news_world": "/news/world", - "regulators": "/regulators", - "regulators_sec": "/regulators/sec", - "regulators_sec_cik_map": "/regulators/sec/cik_map", - "regulators_sec_institutions_search": "/regulators/sec/institutions_search", - "regulators_sec_rss_litigation": "/regulators/sec/rss_litigation", - "regulators_sec_schema_files": "/regulators/sec/schema_files", - "regulators_sec_sic_search": "/regulators/sec/sic_search", - "regulators_sec_symbol_map": "/regulators/sec/symbol_map" -} \ No newline at end of file diff --git a/openbb_platform/openbb/assets/reference.json b/openbb_platform/openbb/assets/reference.json new file mode 100644 index 000000000000..623bd113d81e --- /dev/null +++ b/openbb_platform/openbb/assets/reference.json @@ -0,0 +1,41065 @@ +{ + "/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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": false + } + ], + "polygon": [ + { + "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "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, + "standard": 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, + "standard": false + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "49999", + "optional": true, + "standard": false + } + ], + "tiingo": [ + { + "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": false + }, + { + "name": "exchanges", + "type": "List[str]", + "description": "To limit the query to a subset of exchanges e.g. ['POLONIEX', 'GDAX']", + "default": "None", + "optional": true, + "standard": false + } + ], + "yfinance": [ + { + "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "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, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : CryptoHistorical\n Serializable results.\n provider : Literal['fmp', 'polygon', 'tiingo', 'yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "vwap", + "type": "float, Gt(gt=0)", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "vwap", + "type": "float, Gt(gt=0)", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change", + "type": "float", + "description": "Change in the price from the previous close.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in the price from the previous close, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + } + ], + "polygon": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "vwap", + "type": "float, Gt(gt=0)", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "transactions", + "type": "int, Gt(gt=0)", + "description": "Number of transactions for the symbol in the time period.", + "default": "None", + "optional": true, + "standard": false + } + ], + "tiingo": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "vwap", + "type": "float, Gt(gt=0)", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "transactions", + "type": "int", + "description": "Number of transactions for the symbol in the time period.", + "default": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + } + ], + "yfinance": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "vwap", + "type": "float, Gt(gt=0)", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": true + } + ] + }, + "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": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : CryptoSearch\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. (Crypto)", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the crypto.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. (Crypto)", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the crypto.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "currency", + "type": "str", + "description": "The currency the crypto trades for.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "exchange", + "type": "str", + "description": "The exchange code the crypto trades on.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "exchange_name", + "type": "str", + "description": "The short name of the exchange the crypto trades on.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": false + } + ], + "polygon": [ + { + "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "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, + "standard": 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, + "standard": false + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "49999", + "optional": true, + "standard": false + } + ], + "tiingo": [ + { + "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": false + } + ], + "yfinance": [ + { + "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "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, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : CurrencyHistorical\n Serializable results.\n provider : Literal['fmp', 'polygon', 'tiingo', 'yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vwap", + "type": "float, Gt(gt=0)", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vwap", + "type": "float, Gt(gt=0)", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change", + "type": "float", + "description": "Change in the price from the previous close.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in the price from the previous close, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + } + ], + "polygon": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vwap", + "type": "float, Gt(gt=0)", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "transactions", + "type": "int, Gt(gt=0)", + "description": "Number of transactions for the symbol in the time period.", + "default": "None", + "optional": true, + "standard": false + } + ], + "tiingo": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vwap", + "type": "float, Gt(gt=0)", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": true + } + ], + "yfinance": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vwap", + "type": "float, Gt(gt=0)", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": true + } + ] + }, + "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='intrinio')\n# Search for 'EURUSD' currency pair using 'intrinio' as provider.\nobb.currency.search(provider='intrinio', symbol=EURUSD)\n# Search for actively traded currency pairs on the queried date using 'polygon' as provider.\nobb.currency.search(provider='polygon', date=2024-01-02, active=True)\n# Search for terms using 'polygon' as provider.\nobb.currency.search(provider='polygon', search=Euro zone)\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, + "standard": true + } + ], + "fmp": [ + { + "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, + "standard": true + } + ], + "intrinio": [ + { + "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, + "standard": true + } + ], + "polygon": [ + { + "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, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol of the pair to search.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "search", + "type": "str", + "description": "Search for terms within the ticker and/or company name.", + "default": "", + "optional": true, + "standard": false + }, + { + "name": "active", + "type": "bool", + "description": "Specify if the tickers returned should be actively traded on the queried date.", + "default": "True", + "optional": true, + "standard": false + }, + { + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order data by ascending or descending.", + "default": "asc", + "optional": true, + "standard": false + }, + { + "name": "sort", + "type": "Literal['ticker', 'name', 'market', 'locale', 'currency_symbol', 'currency_name', 'base_currency_symbol', 'base_currency_name', 'last_updated_utc', 'delisted_utc']", + "description": "Sort field used for ordering.", + "default": "", + "optional": true, + "standard": false + }, + { + "name": "limit", + "type": "int, Gt(gt=0)", + "description": "The number of data entries to return.", + "default": "1000", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : CurrencyPairs\n Serializable results.\n provider : Literal['fmp', 'intrinio', 'polygon']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "name", + "type": "str", + "description": "Name of the currency pair.", + "default": "", + "optional": false, + "standard": true + } + ], + "fmp": [ + { + "name": "name", + "type": "str", + "description": "Name of the currency pair.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol of the currency pair.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "currency", + "type": "str", + "description": "Base currency of the currency pair.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "stock_exchange", + "type": "str", + "description": "Stock exchange of the currency pair.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "exchange_short_name", + "type": "str", + "description": "Short name of the stock exchange of the currency pair.", + "default": "None", + "optional": true, + "standard": false + } + ], + "intrinio": [ + { + "name": "name", + "type": "str", + "description": "Name of the currency pair.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "code", + "type": "str", + "description": "Code of the currency pair.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "base_currency", + "type": "str", + "description": "ISO 4217 currency code of the base currency.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "quote_currency", + "type": "str", + "description": "ISO 4217 currency code of the quote currency.", + "default": "", + "optional": false, + "standard": false + } + ], + "polygon": [ + { + "name": "name", + "type": "str", + "description": "Name of the currency pair.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "market", + "type": "str", + "description": "Name of the trading market. Always 'fx'.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "locale", + "type": "str", + "description": "Locale of the currency pair.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "currency_symbol", + "type": "str", + "description": "The symbol of the quote currency.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "currency_name", + "type": "str", + "description": "Name of the quote currency.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "base_currency_symbol", + "type": "str", + "description": "The symbol of the base currency.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "base_currency_name", + "type": "str", + "description": "Name of the base currency.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "last_updated_utc", + "type": "datetime", + "description": "The last updated timestamp in UTC.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "delisted_utc", + "type": "datetime", + "description": "The delisted timestamp in UTC.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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.", + "default": "usd", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "counter_currencies", + "type": "Union[str, List[str]]", + "description": "An optional list of counter currency symbols to filter for. None returns all.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "base", + "type": "Union[str, List[str]]", + "description": "The base currency symbol. Multiple items allowed for provider(s): fmp.", + "default": "usd", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "counter_currencies", + "type": "Union[str, List[str]]", + "description": "An optional list of counter currency symbols to filter for. None returns all.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : CurrencySnapshots\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "base_currency", + "type": "str", + "description": "The base, or domestic, currency.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "counter_currency", + "type": "str", + "description": "The counter, or foreign, currency.", + "default": "", + "optional": false, + "standard": true + }, + { + "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, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "prev_close", + "type": "float", + "description": "The previous close price.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "base_currency", + "type": "str", + "description": "The base, or domestic, currency.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "counter_currency", + "type": "str", + "description": "The counter, or foreign, currency.", + "default": "", + "optional": false, + "standard": true + }, + { + "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, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "prev_close", + "type": "float", + "description": "The previous close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "The change in the price from the previous close.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change_percent", + "type": "float", + "description": "The change in the price from the previous close, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ma50", + "type": "float", + "description": "The 50-day moving average.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ma200", + "type": "float", + "description": "The 200-day moving average.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "year_high", + "type": "float", + "description": "The 52-week high.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "year_low", + "type": "float", + "description": "The 52-week low.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "last_rate_timestamp", + "type": "datetime", + "description": "The timestamp of the last rate.", + "default": "None", + "optional": true, + "standard": 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, + "standard": 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, + "standard": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "The end-of-day date for options chains data.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : OptionsChains\n Serializable results.\n provider : Literal['intrinio']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "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": "None", + "optional": true, + "standard": true + }, + { + "name": "contract_symbol", + "type": "str", + "description": "Contract symbol for the option.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "eod_date", + "type": "date", + "description": "Date for which the options chains are returned.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "expiration", + "type": "date", + "description": "Expiration date of the contract.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "strike", + "type": "float", + "description": "Strike price of the contract.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "option_type", + "type": "str", + "description": "Call or Put.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open_interest", + "type": "int", + "description": "Open interest on the contract.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "theoretical_price", + "type": "float", + "description": "Theoretical value of the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_trade_price", + "type": "float", + "description": "Last trade price of the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "tick", + "type": "str", + "description": "Whether the last tick was up or down in price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "bid", + "type": "float", + "description": "Current bid price for the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "bid_size", + "type": "int", + "description": "Bid size for the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ask", + "type": "float", + "description": "Current ask price for the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ask_size", + "type": "int", + "description": "Ask size for the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "mark", + "type": "float", + "description": "The mid-price between the latest bid and ask.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "open_bid", + "type": "float", + "description": "The opening bid price for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "open_ask", + "type": "float", + "description": "The opening ask price for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "bid_high", + "type": "float", + "description": "The highest bid price for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ask_high", + "type": "float", + "description": "The highest ask price for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "bid_low", + "type": "float", + "description": "The lowest bid price for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ask_low", + "type": "float", + "description": "The lowest ask price for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close_size", + "type": "int", + "description": "The closing trade size for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close_time", + "type": "datetime", + "description": "The time of the closing price for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close_bid", + "type": "float", + "description": "The closing bid price for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close_bid_size", + "type": "int", + "description": "The closing bid size for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close_bid_time", + "type": "datetime", + "description": "The time of the bid closing price for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close_ask", + "type": "float", + "description": "The closing ask price for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close_ask_size", + "type": "int", + "description": "The closing ask size for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close_ask_time", + "type": "datetime", + "description": "The time of the ask closing price for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "prev_close", + "type": "float", + "description": "The previous close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "The change in the price of the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Change, in normalizezd percentage points, of the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "implied_volatility", + "type": "float", + "description": "Implied volatility of the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "delta", + "type": "float", + "description": "Delta of the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "gamma", + "type": "float", + "description": "Gamma of the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "theta", + "type": "float", + "description": "Theta of the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vega", + "type": "float", + "description": "Vega of the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "rho", + "type": "float", + "description": "Rho of the option.", + "default": "None", + "optional": true, + "standard": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. Here, it is the underlying symbol for the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "contract_symbol", + "type": "str", + "description": "Contract symbol for the option.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "eod_date", + "type": "date", + "description": "Date for which the options chains are returned.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "expiration", + "type": "date", + "description": "Expiration date of the contract.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "strike", + "type": "float", + "description": "Strike price of the contract.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "option_type", + "type": "str", + "description": "Call or Put.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open_interest", + "type": "int", + "description": "Open interest on the contract.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "theoretical_price", + "type": "float", + "description": "Theoretical value of the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_trade_price", + "type": "float", + "description": "Last trade price of the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "tick", + "type": "str", + "description": "Whether the last tick was up or down in price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "bid", + "type": "float", + "description": "Current bid price for the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "bid_size", + "type": "int", + "description": "Bid size for the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ask", + "type": "float", + "description": "Current ask price for the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ask_size", + "type": "int", + "description": "Ask size for the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "mark", + "type": "float", + "description": "The mid-price between the latest bid and ask.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "open_bid", + "type": "float", + "description": "The opening bid price for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "open_ask", + "type": "float", + "description": "The opening ask price for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "bid_high", + "type": "float", + "description": "The highest bid price for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ask_high", + "type": "float", + "description": "The highest ask price for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "bid_low", + "type": "float", + "description": "The lowest bid price for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ask_low", + "type": "float", + "description": "The lowest ask price for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close_size", + "type": "int", + "description": "The closing trade size for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close_time", + "type": "datetime", + "description": "The time of the closing price for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close_bid", + "type": "float", + "description": "The closing bid price for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close_bid_size", + "type": "int", + "description": "The closing bid size for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close_bid_time", + "type": "datetime", + "description": "The time of the bid closing price for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close_ask", + "type": "float", + "description": "The closing ask price for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close_ask_size", + "type": "int", + "description": "The closing ask size for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close_ask_time", + "type": "datetime", + "description": "The time of the ask closing price for the option that day.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "prev_close", + "type": "float", + "description": "The previous close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "The change in the price of the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Change, in normalizezd percentage points, of the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "implied_volatility", + "type": "float", + "description": "Implied volatility of the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "delta", + "type": "float", + "description": "Delta of the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "gamma", + "type": "float", + "description": "Gamma of the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "theta", + "type": "float", + "description": "Theta of the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vega", + "type": "float", + "description": "Vega of the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "rho", + "type": "float", + "description": "Rho of the option.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "exercise_style", + "type": "str", + "description": "The exercise style of the option, American or European.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (the underlying symbol)", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "name": "trade_type", + "type": "Literal['block', 'sweep', 'large']", + "description": "The type of unusual activity to query for.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "sentiment", + "type": "Literal['bullish', 'bearish', 'neutral']", + "description": "The sentiment type to query for.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "min_value", + "type": "Union[float, int]", + "description": "The inclusive minimum total value for the unusual activity.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "max_value", + "type": "Union[float, int]", + "description": "The inclusive maximum total value for the unusual activity.", + "default": "None", + "optional": true, + "standard": false + }, + { + "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, + "standard": false + }, + { + "name": "source", + "type": "Literal['delayed', 'realtime']", + "description": "The source of the data. Either realtime or delayed.", + "default": "delayed", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : OptionsUnusual\n Serializable results.\n provider : Literal['intrinio']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "underlying_symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. (the underlying symbol)", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "contract_symbol", + "type": "str", + "description": "Contract symbol for the option.", + "default": "", + "optional": false, + "standard": true + } + ], + "intrinio": [ + { + "name": "underlying_symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. (the underlying symbol)", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "contract_symbol", + "type": "str", + "description": "Contract symbol for the option.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "trade_timestamp", + "type": "datetime", + "description": "The datetime of order placement.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "trade_type", + "type": "Literal['block', 'sweep', 'large']", + "description": "The type of unusual trade.", + "default": "", + "optional": false, + "standard": 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, + "standard": false + }, + { + "name": "bid_at_execution", + "type": "float", + "description": "Bid price at execution.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "ask_at_execution", + "type": "float", + "description": "Ask price at execution.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "average_price", + "type": "float", + "description": "The average premium paid per option contract.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "underlying_price_at_execution", + "type": "float", + "description": "Price of the underlying security at execution of trade.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_size", + "type": "int", + "description": "The total number of contracts involved in a single transaction.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "total_value", + "type": "Union[int, float]", + "description": "The aggregated value of all option contract premiums included in the trade.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "expiration", + "type": "str", + "description": "Future expiry date with format YYYY-MM", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "expiration", + "type": "str", + "description": "Future expiry date with format YYYY-MM", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "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, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : FuturesHistorical\n Serializable results.\n provider : Literal['yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "datetime", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false, + "standard": true + } + ], + "yfinance": [ + { + "name": "date", + "type": "datetime", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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, + "standard": true + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : FuturesCurve\n Serializable results.\n provider : Literal['yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "expiration", + "type": "str", + "description": "Futures expiration month.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "price", + "type": "float", + "description": "The close price.", + "default": "None", + "optional": true, + "standard": true + } + ], + "yfinance": [ + { + "name": "expiration", + "type": "str", + "description": "Futures expiration month.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "price", + "type": "float", + "description": "The close price.", + "default": "None", + "optional": true, + "standard": true + } + ] + }, + "model": "FuturesCurve" + }, + "/economy/gdp/forecast": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "type", + "type": "Literal['nominal', 'real']", + "description": "Type of GDP to get forecast of. Either nominal or real.", + "default": "real", + "optional": true, + "standard": 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, + "standard": true + } + ], + "oecd": [ + { + "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "type", + "type": "Literal['nominal', 'real']", + "description": "Type of GDP to get forecast of. Either nominal or real.", + "default": "real", + "optional": true, + "standard": 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, + "standard": true + }, + { + "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, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : GdpForecast\n Serializable results.\n provider : Literal['oecd']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "value", + "type": "float", + "description": "Nominal GDP value on the date.", + "default": "None", + "optional": true, + "standard": true + } + ], + "oecd": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "value", + "type": "float", + "description": "Nominal GDP value on the date.", + "default": "None", + "optional": true, + "standard": true + } + ] + }, + "model": "GdpForecast" + }, + "/economy/gdp/nominal": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "oecd": [ + { + "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "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, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : GdpNominal\n Serializable results.\n provider : Literal['oecd']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "value", + "type": "float", + "description": "Nominal GDP value on the date.", + "default": "None", + "optional": true, + "standard": true + } + ], + "oecd": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "value", + "type": "float", + "description": "Nominal GDP value on the date.", + "default": "None", + "optional": true, + "standard": true + } + ] + }, + "model": "GdpNominal" + }, + "/economy/gdp/real": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "oecd": [ + { + "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "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, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : GdpReal\n Serializable results.\n provider : Literal['oecd']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "value", + "type": "float", + "description": "Nominal GDP value on the date.", + "default": "None", + "optional": true, + "standard": true + } + ], + "oecd": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "value", + "type": "float", + "description": "Nominal GDP value on the date.", + "default": "None", + "optional": true, + "standard": true + } + ] + }, + "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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "tradingeconomics": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "country", + "type": "Union[str, List[str]]", + "description": "Country of the event. Multiple items allowed for provider(s): tradingeconomics.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "importance", + "type": "Literal['Low', 'Medium', 'High']", + "description": "Importance of the event.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "group", + "type": "Literal['interest rate', 'inflation', 'bonds', 'consumer', 'gdp', 'government', 'housing', 'labour', 'markets', 'money', 'prices', 'trade', 'business']", + "description": "Grouping of events", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EconomicCalendar\n Serializable results.\n provider : Literal['fmp', 'tradingeconomics']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "datetime", + "description": "The date of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "country", + "type": "str", + "description": "Country of event.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "event", + "type": "str", + "description": "Event name.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "reference", + "type": "str", + "description": "Abbreviated period for which released data refers to.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "source", + "type": "str", + "description": "Source of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "sourceurl", + "type": "str", + "description": "Source URL.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "actual", + "type": "Union[str, float]", + "description": "Latest released value.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "previous", + "type": "Union[str, float]", + "description": "Value for the previous period after the revision (if revision is applicable).", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "consensus", + "type": "Union[str, float]", + "description": "Average forecast among a representative group of economists.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "forecast", + "type": "Union[str, float]", + "description": "Trading Economics projections", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "url", + "type": "str", + "description": "Trading Economics URL", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "importance", + "type": "Union[Literal[0, 1, 2, 3], str]", + "description": "Importance of the event. 1-Low, 2-Medium, 3-High", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "unit", + "type": "str", + "description": "Unit of the data.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "date", + "type": "datetime", + "description": "The date of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "country", + "type": "str", + "description": "Country of event.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "event", + "type": "str", + "description": "Event name.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "reference", + "type": "str", + "description": "Abbreviated period for which released data refers to.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "source", + "type": "str", + "description": "Source of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "sourceurl", + "type": "str", + "description": "Source URL.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "actual", + "type": "Union[str, float]", + "description": "Latest released value.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "previous", + "type": "Union[str, float]", + "description": "Value for the previous period after the revision (if revision is applicable).", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "consensus", + "type": "Union[str, float]", + "description": "Average forecast among a representative group of economists.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "forecast", + "type": "Union[str, float]", + "description": "Trading Economics projections", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "url", + "type": "str", + "description": "Trading Economics URL", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "importance", + "type": "Union[Literal[0, 1, 2, 3], str]", + "description": "Importance of the event. 1-Low, 2-Medium, 3-High", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "unit", + "type": "str", + "description": "Unit of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "Value change since previous.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change_percent", + "type": "float", + "description": "Percentage change since previous.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "updated_at", + "type": "datetime", + "description": "Last updated timestamp.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "created_at", + "type": "datetime", + "description": "Created at timestamp.", + "default": "None", + "optional": true, + "standard": false + } + ], + "tradingeconomics": [ + { + "name": "date", + "type": "datetime", + "description": "The date of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "country", + "type": "str", + "description": "Country of event.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "event", + "type": "str", + "description": "Event name.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "reference", + "type": "str", + "description": "Abbreviated period for which released data refers to.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "source", + "type": "str", + "description": "Source of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "sourceurl", + "type": "str", + "description": "Source URL.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "actual", + "type": "Union[str, float]", + "description": "Latest released value.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "previous", + "type": "Union[str, float]", + "description": "Value for the previous period after the revision (if revision is applicable).", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "consensus", + "type": "Union[str, float]", + "description": "Average forecast among a representative group of economists.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "forecast", + "type": "Union[str, float]", + "description": "Trading Economics projections", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "url", + "type": "str", + "description": "Trading Economics URL", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "importance", + "type": "Union[Literal[0, 1, 2, 3], str]", + "description": "Importance of the event. 1-Low, 2-Medium, 3-High", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "unit", + "type": "str", + "description": "Unit of the data.", + "default": "None", + "optional": true, + "standard": true + } + ] + }, + "model": "EconomicCalendar" + }, + "/economy/cpi": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Consumer Price Index (CPI). Returns 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, + "standard": 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", + "optional": true, + "standard": true + }, + { + "name": "frequency", + "type": "Literal['monthly', 'quarter', 'annual']", + "description": "The frequency of the data. Options: `monthly`, `quarter`, and `annual`.", + "default": "monthly", + "optional": true, + "standard": true + }, + { + "name": "harmonized", + "type": "bool", + "description": "Whether you wish to obtain harmonized data.", + "default": "False", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fred": [ + { + "name": "country", + "type": "Union[str, List[str]]", + "description": "The country to get data. Multiple items allowed for provider(s): fred.", + "default": "", + "optional": false, + "standard": 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", + "optional": true, + "standard": true + }, + { + "name": "frequency", + "type": "Literal['monthly', 'quarter', 'annual']", + "description": "The frequency of the data. Options: `monthly`, `quarter`, and `annual`.", + "default": "monthly", + "optional": true, + "standard": true + }, + { + "name": "harmonized", + "type": "bool", + "description": "Whether you wish to obtain harmonized data.", + "default": "False", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : ConsumerPriceIndex\n Serializable results.\n provider : Literal['fred']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + } + ], + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "model": "ConsumerPriceIndex" + }, + "/economy/risk_premium": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "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, + "standard": true + } + ], + "fmp": [ + { + "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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : RiskPremium\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "country", + "type": "str", + "description": "Market country.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "continent", + "type": "str", + "description": "Continent of the country.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "total_equity_risk_premium", + "type": "float, Gt(gt=0)", + "description": "Total equity risk premium for the country.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "country_risk_premium", + "type": "float, Ge(ge=0)", + "description": "Country-specific risk premium.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "country", + "type": "str", + "description": "Market country.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "continent", + "type": "str", + "description": "Continent of the country.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "total_equity_risk_premium", + "type": "float, Gt(gt=0)", + "description": "Total equity risk premium for the country.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "country_risk_premium", + "type": "float, Ge(ge=0)", + "description": "Country-specific risk premium.", + "default": "None", + "optional": true, + "standard": true + } + ] + }, + "model": "RiskPremium" + }, + "/economy/fred_search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search for FRED series or economic releases by ID or string.\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": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fred": [ + { + "name": "query", + "type": "str", + "description": "The search word(s).", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "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, + "standard": false + }, + { + "name": "release_id", + "type": "Union[int, str]", + "description": "A specific release ID to target.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return. (1-1000)", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "offset", + "type": "int, Ge(ge=0)", + "description": "Offset the results in conjunction with limit.", + "default": "0", + "optional": true, + "standard": false + }, + { + "name": "filter_variable", + "type": "Literal[None, 'frequency', 'units', 'seasonal_adjustment']", + "description": "Filter by an attribute.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "filter_value", + "type": "str", + "description": "String value to filter the variable by. Used in conjunction with filter_variable.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "tag_names", + "type": "str", + "description": "A semicolon delimited list of tag names that series match all of. Example: 'japan;imports'", + "default": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : FredSearch\n Serializable results.\n provider : Literal['fred']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "release_id", + "type": "Union[int, str]", + "description": "The release ID for queries.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "series_id", + "type": "str", + "description": "The series ID for the item in the release.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "The name of the release.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "title", + "type": "str", + "description": "The title of the series.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "observation_start", + "type": "date", + "description": "The date of the first observation in the series.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "observation_end", + "type": "date", + "description": "The date of the last observation in the series.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "frequency", + "type": "str", + "description": "The frequency of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "frequency_short", + "type": "str", + "description": "Short form of the data frequency.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "units", + "type": "str", + "description": "The units of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "units_short", + "type": "str", + "description": "Short form of the data units.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "seasonal_adjustment", + "type": "str", + "description": "The seasonal adjustment of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "seasonal_adjustment_short", + "type": "str", + "description": "Short form of the data seasonal adjustment.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_updated", + "type": "datetime", + "description": "The datetime of the last update to the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "notes", + "type": "str", + "description": "Description of the release.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "press_release", + "type": "bool", + "description": "If the release is a press release.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "url", + "type": "str", + "description": "URL to the release.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fred": [ + { + "name": "release_id", + "type": "Union[int, str]", + "description": "The release ID for queries.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "series_id", + "type": "str", + "description": "The series ID for the item in the release.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "The name of the release.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "title", + "type": "str", + "description": "The title of the series.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "observation_start", + "type": "date", + "description": "The date of the first observation in the series.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "observation_end", + "type": "date", + "description": "The date of the last observation in the series.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "frequency", + "type": "str", + "description": "The frequency of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "frequency_short", + "type": "str", + "description": "Short form of the data frequency.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "units", + "type": "str", + "description": "The units of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "units_short", + "type": "str", + "description": "Short form of the data units.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "seasonal_adjustment", + "type": "str", + "description": "The seasonal adjustment of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "seasonal_adjustment_short", + "type": "str", + "description": "Short form of the data seasonal adjustment.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_updated", + "type": "datetime", + "description": "The datetime of the last update to the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "notes", + "type": "str", + "description": "Description of the release.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "press_release", + "type": "bool", + "description": "If the release is a press release.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "url", + "type": "str", + "description": "URL to the release.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "popularity", + "type": "int", + "description": "Popularity of the series", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "group_popularity", + "type": "int", + "description": "Group popularity of the release", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "region_type", + "type": "str", + "description": "The region type of the series.", + "default": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + } + ] + }, + "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "100000", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fred": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fred.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "100000", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "frequency", + "type": "Literal[None, '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": "None", + "optional": true, + "standard": false + }, + { + "name": "aggregation_method", + "type": "Literal[None, '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, + "standard": false + }, + { + "name": "transform", + "type": "Literal[None, '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": "None", + "optional": true, + "standard": false + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fred.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "100000", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "all_pages", + "type": "bool", + "description": "Returns all pages of data from the API call at once.", + "default": "False", + "optional": true, + "standard": false + }, + { + "name": "sleep", + "type": "float", + "description": "Time to sleep between requests to avoid rate limiting.", + "default": "1.0", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : FredSeries\n Serializable results.\n provider : Literal['fred', 'intrinio']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + } + ], + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + } + ], + "intrinio": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "value", + "type": "float", + "description": "Value of the index.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "model": "FredSeries" + }, + "/economy/money_measures": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Money Measures (M1/M2 and components). The 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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "adjusted", + "type": "bool", + "description": "Whether to return seasonally adjusted data.", + "default": "True", + "optional": true, + "standard": 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, + "standard": true + } + ], + "federal_reserve": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "adjusted", + "type": "bool", + "description": "Whether to return seasonally adjusted data.", + "default": "True", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : MoneyMeasures\n Serializable results.\n provider : Literal['federal_reserve']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "month", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "M1", + "type": "float", + "description": "Value of the M1 money supply in billions.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "M2", + "type": "float", + "description": "Value of the M2 money supply in billions.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "currency", + "type": "float", + "description": "Value of currency in circulation in billions.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "demand_deposits", + "type": "float", + "description": "Value of demand deposits in billions.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "retail_money_market_funds", + "type": "float", + "description": "Value of retail money market funds in billions.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "other_liquid_deposits", + "type": "float", + "description": "Value of other liquid deposits in billions.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "small_denomination_time_deposits", + "type": "float", + "description": "Value of small denomination time deposits in billions.", + "default": "None", + "optional": true, + "standard": true + } + ], + "federal_reserve": [ + { + "name": "month", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "M1", + "type": "float", + "description": "Value of the M1 money supply in billions.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "M2", + "type": "float", + "description": "Value of the M2 money supply in billions.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "currency", + "type": "float", + "description": "Value of currency in circulation in billions.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "demand_deposits", + "type": "float", + "description": "Value of demand deposits in billions.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "retail_money_market_funds", + "type": "float", + "description": "Value of retail money market funds in billions.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "other_liquid_deposits", + "type": "float", + "description": "Value of other liquid deposits in billions.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "small_denomination_time_deposits", + "type": "float", + "description": "Value of small denomination time deposits in billions.", + "default": "None", + "optional": true, + "standard": true + } + ] + }, + "model": "MoneyMeasures" + }, + "/economy/unemployment": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "oecd": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "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, + "standard": false + }, + { + "name": "sex", + "type": "Literal['total', 'male', 'female']", + "description": "Sex to get unemployment for.", + "default": "total", + "optional": true, + "standard": false + }, + { + "name": "frequency", + "type": "Literal['monthly', 'quarterly', 'annual']", + "description": "Frequency to get unemployment for.", + "default": "monthly", + "optional": true, + "standard": false + }, + { + "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, + "standard": false + }, + { + "name": "seasonal_adjustment", + "type": "bool", + "description": "Whether to get seasonally adjusted unemployment. Defaults to False.", + "default": "False", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : Unemployment\n Serializable results.\n provider : Literal['oecd']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "value", + "type": "float", + "description": "Unemployment rate (given as a whole number, i.e 10=10%)", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "country", + "type": "str", + "description": "Country for which unemployment rate is given", + "default": "None", + "optional": true, + "standard": true + } + ], + "oecd": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "value", + "type": "float", + "description": "Unemployment rate (given as a whole number, i.e 10=10%)", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "country", + "type": "str", + "description": "Country for which unemployment rate is given", + "default": "None", + "optional": true, + "standard": true + } + ] + }, + "model": "Unemployment" + }, + "/economy/composite_leading_indicator": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "The composite leading indicator (CLI) is designed to provide early signals of turning points\nin business cycles showing fluctuation of the economic activity around its long term potential level.\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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "oecd": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "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, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : CLI\n Serializable results.\n provider : Literal['oecd']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "value", + "type": "float", + "description": "CLI value", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "country", + "type": "str", + "description": "Country for which CLI is given", + "default": "None", + "optional": true, + "standard": true + } + ], + "oecd": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "value", + "type": "float", + "description": "CLI value", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "country", + "type": "str", + "description": "Country for which CLI is given", + "default": "None", + "optional": true, + "standard": true + } + ] + }, + "model": "CLI" + }, + "/economy/short_term_interest_rate": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Short-term interest rates 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.\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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "oecd": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "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, + "standard": false + }, + { + "name": "frequency", + "type": "Literal['monthly', 'quarterly', 'annual']", + "description": "Frequency to get interest rate for for.", + "default": "monthly", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : STIR\n Serializable results.\n provider : Literal['oecd']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "value", + "type": "float", + "description": "Interest rate (given as a whole number, i.e 10=10%)", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "country", + "type": "str", + "description": "Country for which interest rate is given", + "default": "None", + "optional": true, + "standard": true + } + ], + "oecd": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "value", + "type": "float", + "description": "Interest rate (given as a whole number, i.e 10=10%)", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "country", + "type": "str", + "description": "Country for which interest rate is given", + "default": "None", + "optional": true, + "standard": true + } + ] + }, + "model": "STIR" + }, + "/economy/long_term_interest_rate": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Long-term interest rates refer to government bonds maturing in ten years.\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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "oecd": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "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, + "standard": false + }, + { + "name": "frequency", + "type": "Literal['monthly', 'quarterly', 'annual']", + "description": "Frequency to get interest rate for for.", + "default": "monthly", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : LTIR\n Serializable results.\n provider : Literal['oecd']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "value", + "type": "float", + "description": "Interest rate (given as a whole number, i.e 10=10%)", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "country", + "type": "str", + "description": "Country for which interest rate is given", + "default": "None", + "optional": true, + "standard": true + } + ], + "oecd": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "value", + "type": "float", + "description": "Interest rate (given as a whole number, i.e 10=10%)", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "country", + "type": "str", + "description": "Country for which interest rate is given", + "default": "None", + "optional": true, + "standard": true + } + ] + }, + "model": "LTIR" + }, + "/economy/fred_regional": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Query the Geo Fred API for regional economic data by series group.\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": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fred.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "100000", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fred": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fred.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "100000", + "optional": true, + "standard": 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, + "standard": true + }, + { + "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, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "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, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "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, + "standard": false + }, + { + "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, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : FredRegional\n Serializable results.\n provider : Literal['fred']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + } + ], + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "region", + "type": "str", + "description": "The name of the region.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "code", + "type": "Union[str, int]", + "description": "The code of the region.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "value", + "type": "Union[float, int]", + "description": "The obersvation value. The units are defined in the search results by series ID.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "series_id", + "type": "str", + "description": "The individual series ID for the region.", + "default": "", + "optional": false, + "standard": false + } + ] + }, + "model": "FredRegional" + }, + "/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": "None", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "100", + "optional": true, + "standard": 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, + "standard": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "100", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "status", + "type": "Literal['upcoming', 'priced', 'withdrawn']", + "description": "Status of the IPO. [upcoming, priced, or withdrawn]", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "min_value", + "type": "int", + "description": "Return IPOs with an offer dollar amount greater than the given amount.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "max_value", + "type": "int", + "description": "Return IPOs with an offer dollar amount less than the given amount.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : CalendarIpo\n Serializable results.\n provider : Literal['intrinio']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ipo_date", + "type": "date", + "description": "The date of the IPO, when the stock first trades on a major exchange.", + "default": "None", + "optional": true, + "standard": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ipo_date", + "type": "date", + "description": "The date of the IPO, when the stock first trades on a major exchange.", + "default": "None", + "optional": true, + "standard": true + }, + { + "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 and did not take place", + "default": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "name": "offer_amount", + "type": "float", + "description": "The total dollar amount of shares offered in the IPO. Typically this is share price * share count", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "share_price", + "type": "float", + "description": "The price per share at which the IPO was offered.", + "default": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "name": "share_count", + "type": "int", + "description": "The number of shares offered in the IPO.", + "default": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "name": "announcement_url", + "type": "str", + "description": "The URL to the company's announcement of the IPO", + "default": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "name": "open_price", + "type": "float", + "description": "The opening price at the beginning of the first trading day (only available for priced IPOs).", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "close_price", + "type": "float", + "description": "The closing price at the end of the first trading day (only available for priced IPOs).", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "volume", + "type": "int", + "description": "The volume at the end of the first trading day (only available for priced IPOs).", + "default": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "name": "id", + "type": "str", + "description": "The Intrinio ID of the IPO.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "company", + "type": "openbb_intrinio.utils.references.IntrinioCompany", + "description": "The company that is going public via the IPO.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "security", + "type": "openbb_intrinio.utils.references.IntrinioSecurity", + "description": "The primary Security for the Company that is going public via the IPO", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : CalendarDividend\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "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, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "amount", + "type": "float", + "description": "The dividend amount per share.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "record_date", + "type": "date", + "description": "The record date of ownership for eligibility.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "payment_date", + "type": "date", + "description": "The payment date of the dividend.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "declaration_date", + "type": "date", + "description": "Declaration date of the dividend.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "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, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "amount", + "type": "float", + "description": "The dividend amount per share.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "record_date", + "type": "date", + "description": "The record date of ownership for eligibility.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "payment_date", + "type": "date", + "description": "The payment date of the dividend.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "declaration_date", + "type": "date", + "description": "Declaration date of the dividend.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "adjusted_amount", + "type": "float", + "description": "The adjusted-dividend amount.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "label", + "type": "str", + "description": "Ex-dividend date formatted for display.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : CalendarSplits\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "label", + "type": "str", + "description": "Label of the stock splits.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "numerator", + "type": "float", + "description": "Numerator of the stock splits.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "denominator", + "type": "float", + "description": "Denominator of the stock splits.", + "default": "", + "optional": false, + "standard": true + } + ], + "fmp": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "label", + "type": "str", + "description": "Label of the stock splits.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "numerator", + "type": "float", + "description": "Numerator of the stock splits.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "denominator", + "type": "float", + "description": "Denominator of the stock splits.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : CalendarEarnings\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "report_date", + "type": "date", + "description": "The date of the earnings report.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "eps_previous", + "type": "float", + "description": "The earnings-per-share from the same previously reported period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "eps_consensus", + "type": "float", + "description": "The analyst conesus earnings-per-share estimate.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "report_date", + "type": "date", + "description": "The date of the earnings report.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "eps_previous", + "type": "float", + "description": "The earnings-per-share from the same previously reported period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "eps_consensus", + "type": "float", + "description": "The analyst conesus earnings-per-share estimate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "eps_actual", + "type": "float", + "description": "The actual earnings per share announced.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "revenue_actual", + "type": "float", + "description": "The actual reported revenue.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "revenue_consensus", + "type": "float", + "description": "The revenue forecast consensus.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "period_ending", + "type": "date", + "description": "The fiscal period end date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "reporting_time", + "type": "str", + "description": "The reporting time - e.g. after market close.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "updated_date", + "type": "date", + "description": "The date the data was updated last.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EquityPeers\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "peers_list", + "type": "List[str]", + "description": "A list of equity peers based on sector, exchange and market cap.", + "default": "", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "peers_list", + "type": "List[str]", + "description": "A list of equity peers based on sector, exchange and market cap.", + "default": "", + "optional": true, + "standard": true + } + ] + }, + "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.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "200", + "optional": true, + "standard": 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, + "standard": true + } + ], + "benzinga": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "200", + "optional": true, + "standard": 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, + "standard": 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. Used in conjunction with the limit and date parameters.", + "default": "0", + "optional": true, + "standard": false + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "Date for calendar data, shorthand for date_from and date_to.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "name": "importance", + "type": "int", + "description": "Importance level to filter by. Uses Greater Than or Equal To the importance indicated", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "action", + "type": "Literal['downgrades', 'maintains', 'reinstates', 'reiterates', 'upgrades', 'assumes', 'initiates', 'terminates', 'removes', 'suspends', 'firm_dissolved']", + "description": "Filter by a specific action_company.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "analyst_ids", + "type": "Union[str, List[str]]", + "description": "Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "firm_ids", + "type": "Union[str, List[str]]", + "description": "Comma-separated list of firm IDs.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "fields", + "type": "Union[str, List[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": "None", + "optional": true, + "standard": false + } + ], + "fmp": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "200", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "with_grade", + "type": "bool", + "description": "Include upgrades and downgrades in the response.", + "default": "False", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : PriceTarget\n Serializable results.\n provider : Literal['benzinga', 'fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "published_date", + "type": "Union[date, datetime]", + "description": "Published date of the price target.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "published_time", + "type": "datetime.time", + "description": "Time of the original rating, UTC.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "exchange", + "type": "str", + "description": "Exchange where the company is traded.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "company_name", + "type": "str", + "description": "Name of company that is the subject of rating.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "analyst_name", + "type": "str", + "description": "Analyst name.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "analyst_firm", + "type": "str", + "description": "Name of the analyst firm that published the price target.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency the data is denominated in.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "price_target", + "type": "float", + "description": "The current price target.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "adj_price_target", + "type": "float", + "description": "Adjusted price target for splits and stock dividends.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "price_target_previous", + "type": "float", + "description": "Previous price target.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "previous_adj_price_target", + "type": "float", + "description": "Previous adjusted price target.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "price_when_posted", + "type": "float", + "description": "Price when posted.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "rating_current", + "type": "str", + "description": "The analyst's rating for the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "rating_previous", + "type": "str", + "description": "Previous analyst rating for the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "action", + "type": "str", + "description": "Description of the change in rating from firm's last rating.", + "default": "None", + "optional": true, + "standard": true + } + ], + "benzinga": [ + { + "name": "published_date", + "type": "Union[date, datetime]", + "description": "Published date of the price target.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "published_time", + "type": "datetime.time", + "description": "Time of the original rating, UTC.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "exchange", + "type": "str", + "description": "Exchange where the company is traded.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "company_name", + "type": "str", + "description": "Name of company that is the subject of rating.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "analyst_name", + "type": "str", + "description": "Analyst name.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "analyst_firm", + "type": "str", + "description": "Name of the analyst firm that published the price target.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency the data is denominated in.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "price_target", + "type": "float", + "description": "The current price target.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "adj_price_target", + "type": "float", + "description": "Adjusted price target for splits and stock dividends.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "price_target_previous", + "type": "float", + "description": "Previous price target.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "previous_adj_price_target", + "type": "float", + "description": "Previous adjusted price target.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "price_when_posted", + "type": "float", + "description": "Price when posted.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "rating_current", + "type": "str", + "description": "The analyst's rating for the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "rating_previous", + "type": "str", + "description": "Previous analyst rating for the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "action", + "type": "str", + "description": "Description of the change in rating from firm's last rating.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": false + }, + { + "name": "importance", + "type": "Literal[0, 1, 2, 3, 4, 5]", + "description": "Subjective Basis of How Important Event is to Market. 5 = High", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "notes", + "type": "str", + "description": "Notes of the price target.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "analyst_id", + "type": "str", + "description": "Id of the analyst.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "url_news", + "type": "str", + "description": "URL for analyst ratings news articles for this ticker on Benzinga.com.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "url_analyst", + "type": "str", + "description": "URL for analyst ratings page for this ticker on Benzinga.com.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "id", + "type": "str", + "description": "Unique ID of this entry.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "last_updated", + "type": "datetime", + "description": "Last updated timestamp, UTC.", + "default": "None", + "optional": true, + "standard": false + } + ], + "fmp": [ + { + "name": "published_date", + "type": "Union[date, datetime]", + "description": "Published date of the price target.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "published_time", + "type": "datetime.time", + "description": "Time of the original rating, UTC.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "exchange", + "type": "str", + "description": "Exchange where the company is traded.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "company_name", + "type": "str", + "description": "Name of company that is the subject of rating.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "analyst_name", + "type": "str", + "description": "Analyst name.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "analyst_firm", + "type": "str", + "description": "Name of the analyst firm that published the price target.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency the data is denominated in.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "price_target", + "type": "float", + "description": "The current price target.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "adj_price_target", + "type": "float", + "description": "Adjusted price target for splits and stock dividends.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "price_target_previous", + "type": "float", + "description": "Previous price target.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "previous_adj_price_target", + "type": "float", + "description": "Previous adjusted price target.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "price_when_posted", + "type": "float", + "description": "Price when posted.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "rating_current", + "type": "str", + "description": "The analyst's rating for the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "rating_previous", + "type": "str", + "description": "Previous analyst rating for the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "action", + "type": "str", + "description": "Description of the change in rating from firm's last rating.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "news_url", + "type": "str", + "description": "News URL of the price target.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "news_title", + "type": "str", + "description": "News title of the price target.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "news_publisher", + "type": "str", + "description": "News publisher of the price target.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "news_base_url", + "type": "str", + "description": "News base URL of the price target.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "30", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "30", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : AnalystEstimates\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_revenue_low", + "type": "int", + "description": "Estimated revenue low.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_revenue_high", + "type": "int", + "description": "Estimated revenue high.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_revenue_avg", + "type": "int", + "description": "Estimated revenue average.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_ebitda_low", + "type": "int", + "description": "Estimated EBITDA low.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_ebitda_high", + "type": "int", + "description": "Estimated EBITDA high.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_ebitda_avg", + "type": "int", + "description": "Estimated EBITDA average.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_ebit_low", + "type": "int", + "description": "Estimated EBIT low.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_ebit_high", + "type": "int", + "description": "Estimated EBIT high.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_ebit_avg", + "type": "int", + "description": "Estimated EBIT average.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_net_income_low", + "type": "int", + "description": "Estimated net income low.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_net_income_high", + "type": "int", + "description": "Estimated net income high.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_net_income_avg", + "type": "int", + "description": "Estimated net income average.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_sga_expense_low", + "type": "int", + "description": "Estimated SGA expense low.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_sga_expense_high", + "type": "int", + "description": "Estimated SGA expense high.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_sga_expense_avg", + "type": "int", + "description": "Estimated SGA expense average.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_eps_avg", + "type": "float", + "description": "Estimated EPS average.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_eps_high", + "type": "float", + "description": "Estimated EPS high.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_eps_low", + "type": "float", + "description": "Estimated EPS low.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "number_analyst_estimated_revenue", + "type": "int", + "description": "Number of analysts who estimated revenue.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "number_analysts_estimated_eps", + "type": "int", + "description": "Number of analysts who estimated EPS.", + "default": "", + "optional": false, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_revenue_low", + "type": "int", + "description": "Estimated revenue low.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_revenue_high", + "type": "int", + "description": "Estimated revenue high.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_revenue_avg", + "type": "int", + "description": "Estimated revenue average.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_ebitda_low", + "type": "int", + "description": "Estimated EBITDA low.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_ebitda_high", + "type": "int", + "description": "Estimated EBITDA high.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_ebitda_avg", + "type": "int", + "description": "Estimated EBITDA average.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_ebit_low", + "type": "int", + "description": "Estimated EBIT low.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_ebit_high", + "type": "int", + "description": "Estimated EBIT high.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_ebit_avg", + "type": "int", + "description": "Estimated EBIT average.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_net_income_low", + "type": "int", + "description": "Estimated net income low.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_net_income_high", + "type": "int", + "description": "Estimated net income high.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_net_income_avg", + "type": "int", + "description": "Estimated net income average.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_sga_expense_low", + "type": "int", + "description": "Estimated SGA expense low.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_sga_expense_high", + "type": "int", + "description": "Estimated SGA expense high.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_sga_expense_avg", + "type": "int", + "description": "Estimated SGA expense average.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_eps_avg", + "type": "float", + "description": "Estimated EPS average.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_eps_high", + "type": "float", + "description": "Estimated EPS high.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "estimated_eps_low", + "type": "float", + "description": "Estimated EPS low.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "number_analyst_estimated_revenue", + "type": "int", + "description": "Number of analysts who estimated revenue.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "number_analysts_estimated_eps", + "type": "int", + "description": "Number of analysts who estimated EPS.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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): yfinance.", + "default": "", + "optional": false, + "standard": true + }, + { + "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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": "", + "optional": false, + "standard": true + }, + { + "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, + "standard": true + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": "", + "optional": false, + "standard": true + }, + { + "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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : PriceTargetConsensus\n Serializable results.\n provider : Literal['fmp', 'yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "target_high", + "type": "float", + "description": "High target of the price target consensus.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "target_low", + "type": "float", + "description": "Low target of the price target consensus.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "target_consensus", + "type": "float", + "description": "Consensus target of the price target consensus.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "target_median", + "type": "float", + "description": "Median target of the price target consensus.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "target_high", + "type": "float", + "description": "High target of the price target consensus.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "target_low", + "type": "float", + "description": "Low target of the price target consensus.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "target_consensus", + "type": "float", + "description": "Consensus target of the price target consensus.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "target_median", + "type": "float", + "description": "Median target of the price target consensus.", + "default": "None", + "optional": true, + "standard": true + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "target_high", + "type": "float", + "description": "High target of the price target consensus.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "target_low", + "type": "float", + "description": "Low target of the price target consensus.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "target_consensus", + "type": "float", + "description": "Consensus target of the price target consensus.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "target_median", + "type": "float", + "description": "Median target of the price target consensus.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "recommendation", + "type": "str", + "description": "Recommendation - buy, sell, etc.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "recommendation_mean", + "type": "float", + "description": "Mean recommendation score where 1 is strong buy and 5 is strong sell.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "number_of_analysts", + "type": "int", + "description": "Number of analysts providing opinions.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "current_price", + "type": "float", + "description": "Current price of the stock.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "currency", + "type": "str", + "description": "Currency the stock is priced in.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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": "str", + "description": "A comma separated list of analyst names to bring back. Omitting will bring back all available analysts.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "firm_name", + "type": "str", + "description": "A comma separated list of firm names to bring back. Omitting will bring back all available firms.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "benzinga": [ + { + "name": "analyst_name", + "type": "str", + "description": "A comma separated list of analyst names to bring back. Omitting will bring back all available analysts.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "firm_name", + "type": "str", + "description": "A comma separated list of firm names to bring back. Omitting will bring back all available firms.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "analyst_ids", + "type": "Union[str, List[str]]", + "description": "A comma separated list of analyst IDs to bring back.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "firm_ids", + "type": "Union[str, List[str]]", + "description": "A comma separated list of firm IDs to bring back.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "limit", + "type": "int", + "description": "Number of results returned. Limit 1000.", + "default": "100", + "optional": true, + "standard": false + }, + { + "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, + "standard": false + }, + { + "name": "fields", + "type": "Union[str, List[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": "None", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : AnalystSearch\n Serializable results.\n provider : Literal['benzinga']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "last_updated", + "type": "datetime", + "description": "Date of the last update.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "firm_name", + "type": "str", + "description": "Firm name of the analyst.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "name_first", + "type": "str", + "description": "Analyst first name.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "name_last", + "type": "str", + "description": "Analyst last name.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "name_full", + "type": "str", + "description": "Analyst full name.", + "default": "", + "optional": false, + "standard": true + } + ], + "benzinga": [ + { + "name": "last_updated", + "type": "datetime", + "description": "Date of the last update.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "firm_name", + "type": "str", + "description": "Firm name of the analyst.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "name_first", + "type": "str", + "description": "Analyst first name.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "name_last", + "type": "str", + "description": "Analyst last name.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "name_full", + "type": "str", + "description": "Analyst full name.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "analyst_id", + "type": "str", + "description": "ID of the analyst.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "firm_id", + "type": "str", + "description": "ID of the analyst firm.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "smart_score", + "type": "float", + "description": "A weighted average of the total_ratings_percentile, overall_avg_return_percentile, and overall_success_rate", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "overall_success_rate", + "type": "float", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain overall.", + "default": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "name": "total_ratings", + "type": "int", + "description": "Number of recommendations made by this analyst.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "overall_gain_count", + "type": "int", + "description": "The number of ratings that have gained value since the date of recommendation", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "overall_loss_count", + "type": "int", + "description": "The number of ratings that have lost value since the date of recommendation", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "overall_average_return", + "type": "float", + "description": "The average percent (normalized) price difference per rating since the date of recommendation", + "default": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "name": "gain_count_1m", + "type": "int", + "description": "The number of ratings that have gained value over the last month", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "loss_count_1m", + "type": "int", + "description": "The number of ratings that have lost value over the last month", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "average_return_1m", + "type": "float", + "description": "The average percent (normalized) price difference per rating over the last month", + "default": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "name": "gain_count_3m", + "type": "int", + "description": "The number of ratings that have gained value over the last 3 months", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "loss_count_3m", + "type": "int", + "description": "The number of ratings that have lost value over the last 3 months", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "average_return_3m", + "type": "float", + "description": "The average percent (normalized) price difference per rating over the last 3 months", + "default": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "name": "gain_count_6m", + "type": "int", + "description": "The number of ratings that have gained value over the last 6 months", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "loss_count_6m", + "type": "int", + "description": "The number of ratings that have lost value over the last 6 months", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "average_return_6m", + "type": "float", + "description": "The average percent (normalized) price difference per rating over the last 6 months", + "default": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "name": "gain_count_9m", + "type": "int", + "description": "The number of ratings that have gained value over the last 9 months", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "loss_count_9m", + "type": "int", + "description": "The number of ratings that have lost value over the last 9 months", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "average_return_9m", + "type": "float", + "description": "The average percent (normalized) price difference per rating over the last 9 months", + "default": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "name": "gain_count_1y", + "type": "int", + "description": "The number of ratings that have gained value over the last 1 year", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "loss_count_1y", + "type": "int", + "description": "The number of ratings that have lost value over the last 1 year", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "average_return_1y", + "type": "float", + "description": "The average percent (normalized) price difference per rating over the last 1 year", + "default": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "name": "gain_count_2y", + "type": "int", + "description": "The number of ratings that have gained value over the last 2 years", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "loss_count_2y", + "type": "int", + "description": "The number of ratings that have lost value over the last 2 years", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "average_return_2y", + "type": "float", + "description": "The average percent (normalized) price difference per rating over the last 2 years", + "default": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "name": "gain_count_3y", + "type": "int", + "description": "The number of ratings that have gained value over the last 3 years", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "loss_count_3y", + "type": "int", + "description": "The number of ratings that have lost value over the last 3 years", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "average_return_3y", + "type": "float", + "description": "The average percent (normalized) price difference per rating over the last 3 years", + "default": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + } + ] + }, + "model": "AnalystSearch" + }, + "/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, + "standard": 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, + "standard": true + } + ], + "yfinance": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EquityGainers\n Serializable results.\n provider : Literal['yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false, + "standard": true + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "market_cap", + "type": "float", + "description": "Market Cap.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "avg_volume_3_months", + "type": "float", + "description": "Average volume over the last 3 months in millions.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "pe_ratio_ttm", + "type": "float", + "description": "PE Ratio (TTM).", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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, + "standard": 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, + "standard": true + } + ], + "yfinance": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EquityLosers\n Serializable results.\n provider : Literal['yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false, + "standard": true + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "market_cap", + "type": "float", + "description": "Market Cap.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "avg_volume_3_months", + "type": "float", + "description": "Average volume over the last 3 months in millions.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "pe_ratio_ttm", + "type": "float", + "description": "PE Ratio (TTM).", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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, + "standard": 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, + "standard": true + } + ], + "yfinance": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EquityActive\n Serializable results.\n provider : Literal['yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false, + "standard": true + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "market_cap", + "type": "float", + "description": "Market Cap displayed in billions.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "avg_volume_3_months", + "type": "float", + "description": "Average volume over the last 3 months in millions.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "pe_ratio_ttm", + "type": "float", + "description": "PE Ratio (TTM).", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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, + "standard": 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, + "standard": true + } + ], + "yfinance": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EquityUndervaluedLargeCaps\n Serializable results.\n provider : Literal['yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false, + "standard": true + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "market_cap", + "type": "float", + "description": "Market Cap.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "avg_volume_3_months", + "type": "float", + "description": "Average volume over the last 3 months in millions.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "pe_ratio_ttm", + "type": "float", + "description": "PE Ratio (TTM).", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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, + "standard": 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, + "standard": true + } + ], + "yfinance": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EquityUndervaluedGrowth\n Serializable results.\n provider : Literal['yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false, + "standard": true + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "market_cap", + "type": "float", + "description": "Market Cap.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "avg_volume_3_months", + "type": "float", + "description": "Average volume over the last 3 months in millions.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "pe_ratio_ttm", + "type": "float", + "description": "PE Ratio (TTM).", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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, + "standard": 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, + "standard": true + } + ], + "yfinance": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EquityAggressiveSmallCaps\n Serializable results.\n provider : Literal['yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false, + "standard": true + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "market_cap", + "type": "float", + "description": "Market Cap.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "avg_volume_3_months", + "type": "float", + "description": "Average volume over the last 3 months in millions.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "pe_ratio_ttm", + "type": "float", + "description": "PE Ratio (TTM).", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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, + "standard": 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, + "standard": true + } + ], + "yfinance": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : GrowthTechEquities\n Serializable results.\n provider : Literal['yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false, + "standard": true + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "market_cap", + "type": "float", + "description": "Market Cap.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "avg_volume_3_months", + "type": "float", + "description": "Average volume over the last 3 months in millions.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "pe_ratio_ttm", + "type": "float", + "description": "PE Ratio (TTM).", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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. 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.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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "100", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "100", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "is_done", + "type": "bool", + "description": "Flag for whether or not the filing is done.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : DiscoveryFilings\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "title", + "type": "str", + "description": "Title of the filing.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "date", + "type": "datetime", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "form_type", + "type": "str", + "description": "The form type of the filing", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "link", + "type": "str", + "description": "URL to the filing page on the SEC site.", + "default": "", + "optional": false, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "title", + "type": "str", + "description": "Title of the filing.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "date", + "type": "datetime", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "form_type", + "type": "str", + "description": "The form type of the filing", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "link", + "type": "str", + "description": "URL to the filing page on the SEC site.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EquityValuationMultiples\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "revenue_per_share_ttm", + "type": "float", + "description": "Revenue per share calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "net_income_per_share_ttm", + "type": "float", + "description": "Net income per share calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "operating_cash_flow_per_share_ttm", + "type": "float", + "description": "Operating cash flow per share calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "free_cash_flow_per_share_ttm", + "type": "float", + "description": "Free cash flow per share calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "cash_per_share_ttm", + "type": "float", + "description": "Cash per share calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "book_value_per_share_ttm", + "type": "float", + "description": "Book value per share calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "tangible_book_value_per_share_ttm", + "type": "float", + "description": "Tangible book value per share calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "shareholders_equity_per_share_ttm", + "type": "float", + "description": "Shareholders equity per share calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "interest_debt_per_share_ttm", + "type": "float", + "description": "Interest debt per share calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "market_cap_ttm", + "type": "float", + "description": "Market capitalization calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "enterprise_value_ttm", + "type": "float", + "description": "Enterprise value calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "pe_ratio_ttm", + "type": "float", + "description": "Price-to-earnings ratio (P/E ratio) calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "price_to_sales_ratio_ttm", + "type": "float", + "description": "Price-to-sales ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "pocf_ratio_ttm", + "type": "float", + "description": "Price-to-operating cash flow ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "pfcf_ratio_ttm", + "type": "float", + "description": "Price-to-free cash flow ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "pb_ratio_ttm", + "type": "float", + "description": "Price-to-book ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ptb_ratio_ttm", + "type": "float", + "description": "Price-to-tangible book ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ev_to_sales_ttm", + "type": "float", + "description": "Enterprise value-to-sales ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "enterprise_value_over_ebitda_ttm", + "type": "float", + "description": "Enterprise value-to-EBITDA ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ev_to_operating_cash_flow_ttm", + "type": "float", + "description": "Enterprise value-to-operating cash flow ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ev_to_free_cash_flow_ttm", + "type": "float", + "description": "Enterprise value-to-free cash flow ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "earnings_yield_ttm", + "type": "float", + "description": "Earnings yield calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "free_cash_flow_yield_ttm", + "type": "float", + "description": "Free cash flow yield calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "debt_to_equity_ttm", + "type": "float", + "description": "Debt-to-equity ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "debt_to_assets_ttm", + "type": "float", + "description": "Debt-to-assets ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "net_debt_to_ebitda_ttm", + "type": "float", + "description": "Net debt-to-EBITDA ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "current_ratio_ttm", + "type": "float", + "description": "Current ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "interest_coverage_ttm", + "type": "float", + "description": "Interest coverage calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "income_quality_ttm", + "type": "float", + "description": "Income quality calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "dividend_yield_ttm", + "type": "float", + "description": "Dividend yield calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "dividend_yield_percentage_ttm", + "type": "float", + "description": "Dividend yield percentage calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "dividend_to_market_cap_ttm", + "type": "float", + "description": "Dividend to market capitalization ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "dividend_per_share_ttm", + "type": "float", + "description": "Dividend per share calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "payout_ratio_ttm", + "type": "float", + "description": "Payout ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": true + }, + { + "name": "research_and_development_to_revenue_ttm", + "type": "float", + "description": "Research and development expenses-to-revenue ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "intangibles_to_total_assets_ttm", + "type": "float", + "description": "Intangibles-to-total assets ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "capex_to_operating_cash_flow_ttm", + "type": "float", + "description": "Capital expenditures-to-operating cash flow ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "capex_to_revenue_ttm", + "type": "float", + "description": "Capital expenditures-to-revenue ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "capex_to_depreciation_ttm", + "type": "float", + "description": "Capital expenditures-to-depreciation ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "stock_based_compensation_to_revenue_ttm", + "type": "float", + "description": "Stock-based compensation-to-revenue ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "graham_number_ttm", + "type": "float", + "description": "Graham number calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "roic_ttm", + "type": "float", + "description": "Return on invested capital calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "return_on_tangible_assets_ttm", + "type": "float", + "description": "Return on tangible assets calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "graham_net_net_ttm", + "type": "float", + "description": "Graham net-net working capital calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "working_capital_ttm", + "type": "float", + "description": "Working capital calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "tangible_asset_value_ttm", + "type": "float", + "description": "Tangible asset value calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "net_current_asset_value_ttm", + "type": "float", + "description": "Net current asset value calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "invested_capital_ttm", + "type": "float", + "description": "Invested capital calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "average_receivables_ttm", + "type": "float", + "description": "Average receivables calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "average_payables_ttm", + "type": "float", + "description": "Average payables calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "average_inventory_ttm", + "type": "float", + "description": "Average inventory calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "days_sales_outstanding_ttm", + "type": "float", + "description": "Days sales outstanding calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "days_payables_outstanding_ttm", + "type": "float", + "description": "Days payables outstanding calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "days_of_inventory_on_hand_ttm", + "type": "float", + "description": "Days of inventory on hand calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "receivables_turnover_ttm", + "type": "float", + "description": "Receivables turnover calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "payables_turnover_ttm", + "type": "float", + "description": "Payables turnover calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "inventory_turnover_ttm", + "type": "float", + "description": "Inventory turnover calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "roe_ttm", + "type": "float", + "description": "Return on equity calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "capex_per_share_ttm", + "type": "float", + "description": "Capital expenditures per share calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "revenue_per_share_ttm", + "type": "float", + "description": "Revenue per share calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "net_income_per_share_ttm", + "type": "float", + "description": "Net income per share calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "operating_cash_flow_per_share_ttm", + "type": "float", + "description": "Operating cash flow per share calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "free_cash_flow_per_share_ttm", + "type": "float", + "description": "Free cash flow per share calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "cash_per_share_ttm", + "type": "float", + "description": "Cash per share calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "book_value_per_share_ttm", + "type": "float", + "description": "Book value per share calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "tangible_book_value_per_share_ttm", + "type": "float", + "description": "Tangible book value per share calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "shareholders_equity_per_share_ttm", + "type": "float", + "description": "Shareholders equity per share calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "interest_debt_per_share_ttm", + "type": "float", + "description": "Interest debt per share calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "market_cap_ttm", + "type": "float", + "description": "Market capitalization calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "enterprise_value_ttm", + "type": "float", + "description": "Enterprise value calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "pe_ratio_ttm", + "type": "float", + "description": "Price-to-earnings ratio (P/E ratio) calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "price_to_sales_ratio_ttm", + "type": "float", + "description": "Price-to-sales ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "pocf_ratio_ttm", + "type": "float", + "description": "Price-to-operating cash flow ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "pfcf_ratio_ttm", + "type": "float", + "description": "Price-to-free cash flow ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "pb_ratio_ttm", + "type": "float", + "description": "Price-to-book ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ptb_ratio_ttm", + "type": "float", + "description": "Price-to-tangible book ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ev_to_sales_ttm", + "type": "float", + "description": "Enterprise value-to-sales ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "enterprise_value_over_ebitda_ttm", + "type": "float", + "description": "Enterprise value-to-EBITDA ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ev_to_operating_cash_flow_ttm", + "type": "float", + "description": "Enterprise value-to-operating cash flow ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ev_to_free_cash_flow_ttm", + "type": "float", + "description": "Enterprise value-to-free cash flow ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "earnings_yield_ttm", + "type": "float", + "description": "Earnings yield calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "free_cash_flow_yield_ttm", + "type": "float", + "description": "Free cash flow yield calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "debt_to_equity_ttm", + "type": "float", + "description": "Debt-to-equity ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "debt_to_assets_ttm", + "type": "float", + "description": "Debt-to-assets ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "net_debt_to_ebitda_ttm", + "type": "float", + "description": "Net debt-to-EBITDA ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "current_ratio_ttm", + "type": "float", + "description": "Current ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "interest_coverage_ttm", + "type": "float", + "description": "Interest coverage calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "income_quality_ttm", + "type": "float", + "description": "Income quality calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "dividend_yield_ttm", + "type": "float", + "description": "Dividend yield calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "dividend_yield_percentage_ttm", + "type": "float", + "description": "Dividend yield percentage calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "dividend_to_market_cap_ttm", + "type": "float", + "description": "Dividend to market capitalization ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "dividend_per_share_ttm", + "type": "float", + "description": "Dividend per share calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "payout_ratio_ttm", + "type": "float", + "description": "Payout ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": true + }, + { + "name": "research_and_development_to_revenue_ttm", + "type": "float", + "description": "Research and development expenses-to-revenue ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "intangibles_to_total_assets_ttm", + "type": "float", + "description": "Intangibles-to-total assets ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "capex_to_operating_cash_flow_ttm", + "type": "float", + "description": "Capital expenditures-to-operating cash flow ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "capex_to_revenue_ttm", + "type": "float", + "description": "Capital expenditures-to-revenue ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "capex_to_depreciation_ttm", + "type": "float", + "description": "Capital expenditures-to-depreciation ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "stock_based_compensation_to_revenue_ttm", + "type": "float", + "description": "Stock-based compensation-to-revenue ratio calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "graham_number_ttm", + "type": "float", + "description": "Graham number calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "roic_ttm", + "type": "float", + "description": "Return on invested capital calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "return_on_tangible_assets_ttm", + "type": "float", + "description": "Return on tangible assets calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "graham_net_net_ttm", + "type": "float", + "description": "Graham net-net working capital calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "working_capital_ttm", + "type": "float", + "description": "Working capital calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "tangible_asset_value_ttm", + "type": "float", + "description": "Tangible asset value calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "net_current_asset_value_ttm", + "type": "float", + "description": "Net current asset value calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "invested_capital_ttm", + "type": "float", + "description": "Invested capital calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "average_receivables_ttm", + "type": "float", + "description": "Average receivables calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "average_payables_ttm", + "type": "float", + "description": "Average payables calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "average_inventory_ttm", + "type": "float", + "description": "Average inventory calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "days_sales_outstanding_ttm", + "type": "float", + "description": "Days sales outstanding calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "days_payables_outstanding_ttm", + "type": "float", + "description": "Days payables outstanding calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "days_of_inventory_on_hand_ttm", + "type": "float", + "description": "Days of inventory on hand calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "receivables_turnover_ttm", + "type": "float", + "description": "Receivables turnover calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "payables_turnover_ttm", + "type": "float", + "description": "Payables turnover calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "inventory_turnover_ttm", + "type": "float", + "description": "Inventory turnover calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "roe_ttm", + "type": "float", + "description": "Return on equity calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "capex_per_share_ttm", + "type": "float", + "description": "Capital expenditures per share calculated as trailing twelve months.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int, Ge(ge=0)", + "description": "The number of data entries to return.", + "default": "5", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int, Ge(ge=0)", + "description": "The number of data entries to return.", + "default": "5", + "optional": true, + "standard": 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, + "standard": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int, Ge(ge=0)", + "description": "The number of data entries to return.", + "default": "5", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", + "default": "None", + "optional": true, + "standard": false + } + ], + "polygon": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int, Ge(ge=0)", + "description": "The number of data entries to return.", + "default": "5", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "filing_date", + "type": "date", + "description": "Filing date of the financial statement.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "filing_date_lt", + "type": "date", + "description": "Filing date less than the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "filing_date_lte", + "type": "date", + "description": "Filing date less than or equal to the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "filing_date_gt", + "type": "date", + "description": "Filing date greater than the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "filing_date_gte", + "type": "date", + "description": "Filing date greater than or equal to the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "period_of_report_date", + "type": "date", + "description": "Period of report date of the financial statement.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "period_of_report_date_lt", + "type": "date", + "description": "Period of report date less than the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "period_of_report_date_lte", + "type": "date", + "description": "Period of report date less than or equal to the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "period_of_report_date_gt", + "type": "date", + "description": "Period of report date greater than the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "period_of_report_date_gte", + "type": "date", + "description": "Period of report date greater than or equal to the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "include_sources", + "type": "bool", + "description": "Whether to include the sources of the financial statement.", + "default": "True", + "optional": true, + "standard": false + }, + { + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order of the financial statement.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "sort", + "type": "Literal['filing_date', 'period_of_report_date']", + "description": "Sort of the financial statement.", + "default": "None", + "optional": true, + "standard": false + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int, Ge(ge=0)", + "description": "The number of data entries to return.", + "default": "5", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : BalanceSheet\n Serializable results.\n provider : Literal['fmp', 'intrinio', 'polygon', 'yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "filing_date", + "type": "date", + "description": "The date when the filing was made.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "accepted_date", + "type": "datetime", + "description": "The date and time when the filing was accepted.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet was reported.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cash_and_cash_equivalents", + "type": "float", + "description": "Cash and cash equivalents.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "short_term_investments", + "type": "float", + "description": "Short term investments.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cash_and_short_term_investments", + "type": "float", + "description": "Cash and short term investments.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_receivables", + "type": "float", + "description": "Net receivables.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "inventory", + "type": "float", + "description": "Inventory.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_current_assets", + "type": "float", + "description": "Other current assets.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_current_assets", + "type": "float", + "description": "Total current assets.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "plant_property_equipment_net", + "type": "float", + "description": "Plant property equipment net.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "goodwill", + "type": "float", + "description": "Goodwill.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "intangible_assets", + "type": "float", + "description": "Intangible assets.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "goodwill_and_intangible_assets", + "type": "float", + "description": "Goodwill and intangible assets.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "long_term_investments", + "type": "float", + "description": "Long term investments.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "tax_assets", + "type": "float", + "description": "Tax assets.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_non_current_assets", + "type": "float", + "description": "Other non current assets.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "non_current_assets", + "type": "float", + "description": "Total non current assets.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_assets", + "type": "float", + "description": "Other assets.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_assets", + "type": "float", + "description": "Total assets.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "accounts_payable", + "type": "float", + "description": "Accounts payable.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "short_term_debt", + "type": "float", + "description": "Short term debt.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "tax_payables", + "type": "float", + "description": "Tax payables.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "current_deferred_revenue", + "type": "float", + "description": "Current deferred revenue.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_current_liabilities", + "type": "float", + "description": "Other current liabilities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_current_liabilities", + "type": "float", + "description": "Total current liabilities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "long_term_debt", + "type": "float", + "description": "Long term debt.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "deferred_revenue_non_current", + "type": "float", + "description": "Non current deferred revenue.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "deferred_tax_liabilities_non_current", + "type": "float", + "description": "Deferred tax liabilities non current.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_non_current_liabilities", + "type": "float", + "description": "Other non current liabilities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_non_current_liabilities", + "type": "float", + "description": "Total non current liabilities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_liabilities", + "type": "float", + "description": "Other liabilities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "capital_lease_obligations", + "type": "float", + "description": "Capital lease obligations.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_liabilities", + "type": "float", + "description": "Total liabilities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "preferred_stock", + "type": "float", + "description": "Preferred stock.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "common_stock", + "type": "float", + "description": "Common stock.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "retained_earnings", + "type": "float", + "description": "Retained earnings.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "accumulated_other_comprehensive_income", + "type": "float", + "description": "Accumulated other comprehensive income (loss).", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_shareholders_equity", + "type": "float", + "description": "Other shareholders equity.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_total_shareholders_equity", + "type": "float", + "description": "Other total shareholders equity.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_common_equity", + "type": "float", + "description": "Total common equity.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_equity_non_controlling_interests", + "type": "float", + "description": "Total equity non controlling interests.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_liabilities_and_shareholders_equity", + "type": "float", + "description": "Total liabilities and shareholders equity.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "minority_interest", + "type": "float", + "description": "Minority interest.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_liabilities_and_total_equity", + "type": "float", + "description": "Total liabilities and total equity.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_investments", + "type": "float", + "description": "Total investments.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_debt", + "type": "float", + "description": "Total debt.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_debt", + "type": "float", + "description": "Net debt.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "link", + "type": "str", + "description": "Link to the filing.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "final_link", + "type": "str", + "description": "Link to the filing document.", + "default": "None", + "optional": true, + "standard": false + } + ], + "intrinio": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet is reported.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cash_and_cash_equivalents", + "type": "float", + "description": "Cash and cash equivalents.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cash_and_due_from_banks", + "type": "float", + "description": "Cash and due from banks.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "restricted_cash", + "type": "float", + "description": "Restricted cash.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "short_term_investments", + "type": "float", + "description": "Short term investments.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "federal_funds_sold", + "type": "float", + "description": "Federal funds sold.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "accounts_receivable", + "type": "float", + "description": "Accounts receivable.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "note_and_lease_receivable", + "type": "float", + "description": "Note and lease receivable. (Vendor non-trade receivables)", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "inventories", + "type": "float", + "description": "Net Inventories.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "customer_and_other_receivables", + "type": "float", + "description": "Customer and other receivables.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "interest_bearing_deposits_at_other_banks", + "type": "float", + "description": "Interest bearing deposits at other banks.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "time_deposits_placed_and_other_short_term_investments", + "type": "float", + "description": "Time deposits placed and other short term investments.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "trading_account_securities", + "type": "float", + "description": "Trading account securities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "loans_and_leases", + "type": "float", + "description": "Loans and leases.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "allowance_for_loan_and_lease_losses", + "type": "float", + "description": "Allowance for loan and lease losses.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "current_deferred_refundable_income_taxes", + "type": "float", + "description": "Current deferred refundable income taxes.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_current_assets", + "type": "float", + "description": "Other current assets.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "loans_and_leases_net_of_allowance", + "type": "float", + "description": "Loans and leases net of allowance.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "accrued_investment_income", + "type": "float", + "description": "Accrued investment income.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_current_non_operating_assets", + "type": "float", + "description": "Other current non-operating assets.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "loans_held_for_sale", + "type": "float", + "description": "Loans held for sale.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "prepaid_expenses", + "type": "float", + "description": "Prepaid expenses.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_current_assets", + "type": "float", + "description": "Total current assets.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "plant_property_equipment_gross", + "type": "float", + "description": "Plant property equipment gross.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "accumulated_depreciation", + "type": "float", + "description": "Accumulated depreciation.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "premises_and_equipment_net", + "type": "float", + "description": "Net premises and equipment.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "plant_property_equipment_net", + "type": "float", + "description": "Net plant property equipment.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "long_term_investments", + "type": "float", + "description": "Long term investments.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "mortgage_servicing_rights", + "type": "float", + "description": "Mortgage servicing rights.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "unearned_premiums_asset", + "type": "float", + "description": "Unearned premiums asset.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "non_current_note_lease_receivables", + "type": "float", + "description": "Non-current note lease receivables.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "deferred_acquisition_cost", + "type": "float", + "description": "Deferred acquisition cost.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "goodwill", + "type": "float", + "description": "Goodwill.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "separate_account_business_assets", + "type": "float", + "description": "Separate account business assets.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "non_current_deferred_refundable_income_taxes", + "type": "float", + "description": "Noncurrent deferred refundable income taxes.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "intangible_assets", + "type": "float", + "description": "Intangible assets.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "employee_benefit_assets", + "type": "float", + "description": "Employee benefit assets.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_assets", + "type": "float", + "description": "Other assets.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_non_current_operating_assets", + "type": "float", + "description": "Other noncurrent operating assets.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_non_current_non_operating_assets", + "type": "float", + "description": "Other noncurrent non-operating assets.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "interest_bearing_deposits", + "type": "float", + "description": "Interest bearing deposits.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_non_current_assets", + "type": "float", + "description": "Total noncurrent assets.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_assets", + "type": "float", + "description": "Total assets.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "non_interest_bearing_deposits", + "type": "float", + "description": "Non interest bearing deposits.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "federal_funds_purchased_and_securities_sold", + "type": "float", + "description": "Federal funds purchased and securities sold.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "bankers_acceptance_outstanding", + "type": "float", + "description": "Bankers acceptance outstanding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "short_term_debt", + "type": "float", + "description": "Short term debt.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "accounts_payable", + "type": "float", + "description": "Accounts payable.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "current_deferred_revenue", + "type": "float", + "description": "Current deferred revenue.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "current_deferred_payable_income_tax_liabilities", + "type": "float", + "description": "Current deferred payable income tax liabilities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "accrued_interest_payable", + "type": "float", + "description": "Accrued interest payable.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "accrued_expenses", + "type": "float", + "description": "Accrued expenses.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_short_term_payables", + "type": "float", + "description": "Other short term payables.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "customer_deposits", + "type": "float", + "description": "Customer deposits.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "dividends_payable", + "type": "float", + "description": "Dividends payable.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "claims_and_claim_expense", + "type": "float", + "description": "Claims and claim expense.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "future_policy_benefits", + "type": "float", + "description": "Future policy benefits.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "current_employee_benefit_liabilities", + "type": "float", + "description": "Current employee benefit liabilities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "unearned_premiums_liability", + "type": "float", + "description": "Unearned premiums liability.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_taxes_payable", + "type": "float", + "description": "Other taxes payable.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "policy_holder_funds", + "type": "float", + "description": "Policy holder funds.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_current_liabilities", + "type": "float", + "description": "Other current liabilities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_current_non_operating_liabilities", + "type": "float", + "description": "Other current non-operating liabilities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "separate_account_business_liabilities", + "type": "float", + "description": "Separate account business liabilities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_current_liabilities", + "type": "float", + "description": "Total current liabilities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "long_term_debt", + "type": "float", + "description": "Long term debt.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_long_term_liabilities", + "type": "float", + "description": "Other long term liabilities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "non_current_deferred_revenue", + "type": "float", + "description": "Non-current deferred revenue.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "non_current_deferred_payable_income_tax_liabilities", + "type": "float", + "description": "Non-current deferred payable income tax liabilities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "non_current_employee_benefit_liabilities", + "type": "float", + "description": "Non-current employee benefit liabilities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_non_current_operating_liabilities", + "type": "float", + "description": "Other non-current operating liabilities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_non_current_non_operating_liabilities", + "type": "float", + "description": "Other non-current, non-operating liabilities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_non_current_liabilities", + "type": "float", + "description": "Total non-current liabilities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "capital_lease_obligations", + "type": "float", + "description": "Capital lease obligations.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "asset_retirement_reserve_litigation_obligation", + "type": "float", + "description": "Asset retirement reserve litigation obligation.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_liabilities", + "type": "float", + "description": "Total liabilities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "commitments_contingencies", + "type": "float", + "description": "Commitments contingencies.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "redeemable_non_controlling_interest", + "type": "float", + "description": "Redeemable non-controlling interest.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "preferred_stock", + "type": "float", + "description": "Preferred stock.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "common_stock", + "type": "float", + "description": "Common stock.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "retained_earnings", + "type": "float", + "description": "Retained earnings.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "treasury_stock", + "type": "float", + "description": "Treasury stock.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "accumulated_other_comprehensive_income", + "type": "float", + "description": "Accumulated other comprehensive income.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "participating_policy_holder_equity", + "type": "float", + "description": "Participating policy holder equity.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_equity_adjustments", + "type": "float", + "description": "Other equity adjustments.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_common_equity", + "type": "float", + "description": "Total common equity.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_preferred_common_equity", + "type": "float", + "description": "Total preferred common equity.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "non_controlling_interest", + "type": "float", + "description": "Non-controlling interest.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_equity_non_controlling_interests", + "type": "float", + "description": "Total equity non-controlling interests.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_liabilities_shareholders_equity", + "type": "float", + "description": "Total liabilities and shareholders equity.", + "default": "None", + "optional": true, + "standard": false + } + ], + "polygon": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "accounts_receivable", + "type": "int", + "description": "Accounts receivable", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "marketable_securities", + "type": "int", + "description": "Marketable securities", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "prepaid_expenses", + "type": "int", + "description": "Prepaid expenses", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_current_assets", + "type": "int", + "description": "Other current assets", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_current_assets", + "type": "int", + "description": "Total current assets", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "property_plant_equipment_net", + "type": "int", + "description": "Property plant and equipment net", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "inventory", + "type": "int", + "description": "Inventory", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_non_current_assets", + "type": "int", + "description": "Other non-current assets", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_non_current_assets", + "type": "int", + "description": "Total non-current assets", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "intangible_assets", + "type": "int", + "description": "Intangible assets", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_assets", + "type": "int", + "description": "Total assets", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "accounts_payable", + "type": "int", + "description": "Accounts payable", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "employee_wages", + "type": "int", + "description": "Employee wages", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_current_liabilities", + "type": "int", + "description": "Other current liabilities", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_current_liabilities", + "type": "int", + "description": "Total current liabilities", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_non_current_liabilities", + "type": "int", + "description": "Other non-current liabilities", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_non_current_liabilities", + "type": "int", + "description": "Total non-current liabilities", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "long_term_debt", + "type": "int", + "description": "Long term debt", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_liabilities", + "type": "int", + "description": "Total liabilities", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "minority_interest", + "type": "int", + "description": "Minority interest", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "temporary_equity_attributable_to_parent", + "type": "int", + "description": "Temporary equity attributable to parent", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "equity_attributable_to_parent", + "type": "int", + "description": "Equity attributable to parent", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "temporary_equity", + "type": "int", + "description": "Temporary equity", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "preferred_stock", + "type": "int", + "description": "Preferred stock", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "redeemable_non_controlling_interest", + "type": "int", + "description": "Redeemable non-controlling interest", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "redeemable_non_controlling_interest_other", + "type": "int", + "description": "Redeemable non-controlling interest other", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_stock_holders_equity", + "type": "int", + "description": "Total stock holders equity", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_liabilities_and_stock_holders_equity", + "type": "int", + "description": "Total liabilities and stockholders equity", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_equity", + "type": "int", + "description": "Total equity", + "default": "None", + "optional": true, + "standard": false + } + ], + "yfinance": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "10", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "10", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : BalanceSheetGrowth\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Reporting period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_cash_and_cash_equivalents", + "type": "float", + "description": "Growth rate of cash and cash equivalents.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_short_term_investments", + "type": "float", + "description": "Growth rate of short-term investments.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_cash_and_short_term_investments", + "type": "float", + "description": "Growth rate of cash and short-term investments.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_net_receivables", + "type": "float", + "description": "Growth rate of net receivables.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_inventory", + "type": "float", + "description": "Growth rate of inventory.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_other_current_assets", + "type": "float", + "description": "Growth rate of other current assets.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_total_current_assets", + "type": "float", + "description": "Growth rate of total current assets.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_property_plant_equipment_net", + "type": "float", + "description": "Growth rate of net property, plant, and equipment.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_goodwill", + "type": "float", + "description": "Growth rate of goodwill.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_intangible_assets", + "type": "float", + "description": "Growth rate of intangible assets.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_goodwill_and_intangible_assets", + "type": "float", + "description": "Growth rate of goodwill and intangible assets.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_long_term_investments", + "type": "float", + "description": "Growth rate of long-term investments.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_tax_assets", + "type": "float", + "description": "Growth rate of tax assets.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_other_non_current_assets", + "type": "float", + "description": "Growth rate of other non-current assets.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_total_non_current_assets", + "type": "float", + "description": "Growth rate of total non-current assets.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_other_assets", + "type": "float", + "description": "Growth rate of other assets.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_total_assets", + "type": "float", + "description": "Growth rate of total assets.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_account_payables", + "type": "float", + "description": "Growth rate of accounts payable.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_short_term_debt", + "type": "float", + "description": "Growth rate of short-term debt.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_tax_payables", + "type": "float", + "description": "Growth rate of tax payables.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_deferred_revenue", + "type": "float", + "description": "Growth rate of deferred revenue.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_other_current_liabilities", + "type": "float", + "description": "Growth rate of other current liabilities.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_total_current_liabilities", + "type": "float", + "description": "Growth rate of total current liabilities.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_long_term_debt", + "type": "float", + "description": "Growth rate of long-term debt.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_deferred_revenue_non_current", + "type": "float", + "description": "Growth rate of non-current deferred revenue.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_deferrred_tax_liabilities_non_current", + "type": "float", + "description": "Growth rate of non-current deferred tax liabilities.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_other_non_current_liabilities", + "type": "float", + "description": "Growth rate of other non-current liabilities.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_total_non_current_liabilities", + "type": "float", + "description": "Growth rate of total non-current liabilities.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_other_liabilities", + "type": "float", + "description": "Growth rate of other liabilities.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_total_liabilities", + "type": "float", + "description": "Growth rate of total liabilities.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_common_stock", + "type": "float", + "description": "Growth rate of common stock.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_retained_earnings", + "type": "float", + "description": "Growth rate of retained earnings.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_accumulated_other_comprehensive_income_loss", + "type": "float", + "description": "Growth rate of accumulated other comprehensive income/loss.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_othertotal_stockholders_equity", + "type": "float", + "description": "Growth rate of other total stockholders' equity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_total_stockholders_equity", + "type": "float", + "description": "Growth rate of total stockholders' equity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_total_liabilities_and_stockholders_equity", + "type": "float", + "description": "Growth rate of total liabilities and stockholders' equity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_total_investments", + "type": "float", + "description": "Growth rate of total investments.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_total_debt", + "type": "float", + "description": "Growth rate of total debt.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_net_debt", + "type": "float", + "description": "Growth rate of net debt.", + "default": "", + "optional": false, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Reporting period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_cash_and_cash_equivalents", + "type": "float", + "description": "Growth rate of cash and cash equivalents.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_short_term_investments", + "type": "float", + "description": "Growth rate of short-term investments.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_cash_and_short_term_investments", + "type": "float", + "description": "Growth rate of cash and short-term investments.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_net_receivables", + "type": "float", + "description": "Growth rate of net receivables.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_inventory", + "type": "float", + "description": "Growth rate of inventory.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_other_current_assets", + "type": "float", + "description": "Growth rate of other current assets.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_total_current_assets", + "type": "float", + "description": "Growth rate of total current assets.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_property_plant_equipment_net", + "type": "float", + "description": "Growth rate of net property, plant, and equipment.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_goodwill", + "type": "float", + "description": "Growth rate of goodwill.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_intangible_assets", + "type": "float", + "description": "Growth rate of intangible assets.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_goodwill_and_intangible_assets", + "type": "float", + "description": "Growth rate of goodwill and intangible assets.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_long_term_investments", + "type": "float", + "description": "Growth rate of long-term investments.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_tax_assets", + "type": "float", + "description": "Growth rate of tax assets.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_other_non_current_assets", + "type": "float", + "description": "Growth rate of other non-current assets.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_total_non_current_assets", + "type": "float", + "description": "Growth rate of total non-current assets.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_other_assets", + "type": "float", + "description": "Growth rate of other assets.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_total_assets", + "type": "float", + "description": "Growth rate of total assets.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_account_payables", + "type": "float", + "description": "Growth rate of accounts payable.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_short_term_debt", + "type": "float", + "description": "Growth rate of short-term debt.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_tax_payables", + "type": "float", + "description": "Growth rate of tax payables.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_deferred_revenue", + "type": "float", + "description": "Growth rate of deferred revenue.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_other_current_liabilities", + "type": "float", + "description": "Growth rate of other current liabilities.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_total_current_liabilities", + "type": "float", + "description": "Growth rate of total current liabilities.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_long_term_debt", + "type": "float", + "description": "Growth rate of long-term debt.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_deferred_revenue_non_current", + "type": "float", + "description": "Growth rate of non-current deferred revenue.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_deferrred_tax_liabilities_non_current", + "type": "float", + "description": "Growth rate of non-current deferred tax liabilities.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_other_non_current_liabilities", + "type": "float", + "description": "Growth rate of other non-current liabilities.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_total_non_current_liabilities", + "type": "float", + "description": "Growth rate of total non-current liabilities.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_other_liabilities", + "type": "float", + "description": "Growth rate of other liabilities.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_total_liabilities", + "type": "float", + "description": "Growth rate of total liabilities.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_common_stock", + "type": "float", + "description": "Growth rate of common stock.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_retained_earnings", + "type": "float", + "description": "Growth rate of retained earnings.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_accumulated_other_comprehensive_income_loss", + "type": "float", + "description": "Growth rate of accumulated other comprehensive income/loss.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_othertotal_stockholders_equity", + "type": "float", + "description": "Growth rate of other total stockholders' equity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_total_stockholders_equity", + "type": "float", + "description": "Growth rate of total stockholders' equity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_total_liabilities_and_stockholders_equity", + "type": "float", + "description": "Growth rate of total liabilities and stockholders' equity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_total_investments", + "type": "float", + "description": "Growth rate of total investments.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_total_debt", + "type": "float", + "description": "Growth rate of total debt.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_net_debt", + "type": "float", + "description": "Growth rate of net debt.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int, Ge(ge=0)", + "description": "The number of data entries to return.", + "default": "5", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int, Ge(ge=0)", + "description": "The number of data entries to return.", + "default": "5", + "optional": true, + "standard": 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, + "standard": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int, Ge(ge=0)", + "description": "The number of data entries to return.", + "default": "5", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", + "default": "None", + "optional": true, + "standard": false + } + ], + "polygon": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int, Ge(ge=0)", + "description": "The number of data entries to return.", + "default": "5", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "filing_date", + "type": "date", + "description": "Filing date of the financial statement.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "filing_date_lt", + "type": "date", + "description": "Filing date less than the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "filing_date_lte", + "type": "date", + "description": "Filing date less than or equal to the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "filing_date_gt", + "type": "date", + "description": "Filing date greater than the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "filing_date_gte", + "type": "date", + "description": "Filing date greater than or equal to the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "period_of_report_date", + "type": "date", + "description": "Period of report date of the financial statement.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "period_of_report_date_lt", + "type": "date", + "description": "Period of report date less than the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "period_of_report_date_lte", + "type": "date", + "description": "Period of report date less than or equal to the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "period_of_report_date_gt", + "type": "date", + "description": "Period of report date greater than the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "period_of_report_date_gte", + "type": "date", + "description": "Period of report date greater than or equal to the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "include_sources", + "type": "bool", + "description": "Whether to include the sources of the financial statement.", + "default": "False", + "optional": true, + "standard": false + }, + { + "name": "order", + "type": "Literal[None, 'asc', 'desc']", + "description": "Order of the financial statement.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "sort", + "type": "Literal[None, 'filing_date', 'period_of_report_date']", + "description": "Sort of the financial statement.", + "default": "None", + "optional": true, + "standard": false + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int, Ge(ge=0)", + "description": "The number of data entries to return.", + "default": "5", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : CashFlowStatement\n Serializable results.\n provider : Literal['fmp', 'intrinio', 'polygon', 'yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "filing_date", + "type": "date", + "description": "The date of the filing.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "accepted_date", + "type": "datetime", + "description": "The date the filing was accepted.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "reported_currency", + "type": "str", + "description": "The currency in which the cash flow statement was reported.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_income", + "type": "float", + "description": "Net income.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "depreciation_and_amortization", + "type": "float", + "description": "Depreciation and amortization.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "deferred_income_tax", + "type": "float", + "description": "Deferred income tax.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "stock_based_compensation", + "type": "float", + "description": "Stock-based compensation.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change_in_working_capital", + "type": "float", + "description": "Change in working capital.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change_in_account_receivables", + "type": "float", + "description": "Change in account receivables.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change_in_inventory", + "type": "float", + "description": "Change in inventory.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change_in_account_payable", + "type": "float", + "description": "Change in account payable.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change_in_other_working_capital", + "type": "float", + "description": "Change in other working capital.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change_in_other_non_cash_items", + "type": "float", + "description": "Change in other non-cash items.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_cash_from_operating_activities", + "type": "float", + "description": "Net cash from operating activities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "purchase_of_property_plant_and_equipment", + "type": "float", + "description": "Purchase of property, plant and equipment.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "acquisitions", + "type": "float", + "description": "Acquisitions.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "purchase_of_investment_securities", + "type": "float", + "description": "Purchase of investment securities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "sale_and_maturity_of_investments", + "type": "float", + "description": "Sale and maturity of investments.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_investing_activities", + "type": "float", + "description": "Other investing activities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_cash_from_investing_activities", + "type": "float", + "description": "Net cash from investing activities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "repayment_of_debt", + "type": "float", + "description": "Repayment of debt.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "issuance_of_common_equity", + "type": "float", + "description": "Issuance of common equity.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "repurchase_of_common_equity", + "type": "float", + "description": "Repurchase of common equity.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "payment_of_dividends", + "type": "float", + "description": "Payment of dividends.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_financing_activities", + "type": "float", + "description": "Other financing activities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_cash_from_financing_activities", + "type": "float", + "description": "Net cash from financing activities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "effect_of_exchange_rate_changes_on_cash", + "type": "float", + "description": "Effect of exchange rate changes on cash.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_change_in_cash_and_equivalents", + "type": "float", + "description": "Net change in cash and equivalents.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cash_at_beginning_of_period", + "type": "float", + "description": "Cash at beginning of period.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cash_at_end_of_period", + "type": "float", + "description": "Cash at end of period.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "operating_cash_flow", + "type": "float", + "description": "Operating cash flow.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "capital_expenditure", + "type": "float", + "description": "Capital expenditure.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "free_cash_flow", + "type": "float", + "description": "None", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "link", + "type": "str", + "description": "Link to the filing.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "final_link", + "type": "str", + "description": "Link to the filing document.", + "default": "None", + "optional": true, + "standard": false + } + ], + "intrinio": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet is reported.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_income_continuing_operations", + "type": "float", + "description": "Net Income (Continuing Operations)", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_income_discontinued_operations", + "type": "float", + "description": "Net Income (Discontinued Operations)", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_income", + "type": "float", + "description": "Consolidated Net Income.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "provision_for_loan_losses", + "type": "float", + "description": "Provision for Loan Losses", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "provision_for_credit_losses", + "type": "float", + "description": "Provision for credit losses", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "depreciation_expense", + "type": "float", + "description": "Depreciation Expense.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "amortization_expense", + "type": "float", + "description": "Amortization Expense.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "share_based_compensation", + "type": "float", + "description": "Share-based compensation.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "non_cash_adjustments_to_reconcile_net_income", + "type": "float", + "description": "Non-Cash Adjustments to Reconcile Net Income.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "changes_in_operating_assets_and_liabilities", + "type": "float", + "description": "Changes in Operating Assets and Liabilities (Net)", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_cash_from_continuing_operating_activities", + "type": "float", + "description": "Net Cash from Continuing Operating Activities", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_cash_from_discontinued_operating_activities", + "type": "float", + "description": "Net Cash from Discontinued Operating Activities", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_cash_from_operating_activities", + "type": "float", + "description": "Net Cash from Operating Activities", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "divestitures", + "type": "float", + "description": "Divestitures", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "sale_of_property_plant_and_equipment", + "type": "float", + "description": "Sale of Property, Plant, and Equipment", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "acquisitions", + "type": "float", + "description": "Acquisitions", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "purchase_of_investments", + "type": "float", + "description": "Purchase of Investments", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "purchase_of_investment_securities", + "type": "float", + "description": "Purchase of Investment Securities", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "sale_and_maturity_of_investments", + "type": "float", + "description": "Sale and Maturity of Investments", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "loans_held_for_sale", + "type": "float", + "description": "Loans Held for Sale (Net)", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "purchase_of_property_plant_and_equipment", + "type": "float", + "description": "Purchase of Property, Plant, and Equipment", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_investing_activities", + "type": "float", + "description": "Other Investing Activities (Net)", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_cash_from_continuing_investing_activities", + "type": "float", + "description": "Net Cash from Continuing Investing Activities", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_cash_from_discontinued_investing_activities", + "type": "float", + "description": "Net Cash from Discontinued Investing Activities", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_cash_from_investing_activities", + "type": "float", + "description": "Net Cash from Investing Activities", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "payment_of_dividends", + "type": "float", + "description": "Payment of Dividends", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "repurchase_of_common_equity", + "type": "float", + "description": "Repurchase of Common Equity", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "repurchase_of_preferred_equity", + "type": "float", + "description": "Repurchase of Preferred Equity", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "issuance_of_common_equity", + "type": "float", + "description": "Issuance of Common Equity", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "issuance_of_preferred_equity", + "type": "float", + "description": "Issuance of Preferred Equity", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "issuance_of_debt", + "type": "float", + "description": "Issuance of Debt", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "repayment_of_debt", + "type": "float", + "description": "Repayment of Debt", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_financing_activities", + "type": "float", + "description": "Other Financing Activities (Net)", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cash_interest_received", + "type": "float", + "description": "Cash Interest Received", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_change_in_deposits", + "type": "float", + "description": "Net Change in Deposits", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_increase_in_fed_funds_sold", + "type": "float", + "description": "Net Increase in Fed Funds Sold", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_cash_from_continuing_financing_activities", + "type": "float", + "description": "Net Cash from Continuing Financing Activities", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_cash_from_discontinued_financing_activities", + "type": "float", + "description": "Net Cash from Discontinued Financing Activities", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_cash_from_financing_activities", + "type": "float", + "description": "Net Cash from Financing Activities", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "effect_of_exchange_rate_changes", + "type": "float", + "description": "Effect of Exchange Rate Changes", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_net_changes_in_cash", + "type": "float", + "description": "Other Net Changes in Cash", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_change_in_cash_and_equivalents", + "type": "float", + "description": "Net Change in Cash and Equivalents", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cash_income_taxes_paid", + "type": "float", + "description": "Cash Income Taxes Paid", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cash_interest_paid", + "type": "float", + "description": "Cash Interest Paid", + "default": "None", + "optional": true, + "standard": false + } + ], + "polygon": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "net_cash_flow_from_operating_activities_continuing", + "type": "int", + "description": "Net cash flow from operating activities continuing.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_cash_flow_from_operating_activities_discontinued", + "type": "int", + "description": "Net cash flow from operating activities discontinued.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_cash_flow_from_operating_activities", + "type": "int", + "description": "Net cash flow from operating activities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_cash_flow_from_investing_activities_continuing", + "type": "int", + "description": "Net cash flow from investing activities continuing.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_cash_flow_from_investing_activities_discontinued", + "type": "int", + "description": "Net cash flow from investing activities discontinued.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_cash_flow_from_investing_activities", + "type": "int", + "description": "Net cash flow from investing activities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_cash_flow_from_financing_activities_continuing", + "type": "int", + "description": "Net cash flow from financing activities continuing.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_cash_flow_from_financing_activities_discontinued", + "type": "int", + "description": "Net cash flow from financing activities discontinued.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_cash_flow_from_financing_activities", + "type": "int", + "description": "Net cash flow from financing activities.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_cash_flow_continuing", + "type": "int", + "description": "Net cash flow continuing.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_cash_flow_discontinued", + "type": "int", + "description": "Net cash flow discontinued.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "exchange_gains_losses", + "type": "int", + "description": "Exchange gains losses.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_cash_flow", + "type": "int", + "description": "Net cash flow.", + "default": "None", + "optional": true, + "standard": false + } + ], + "yfinance": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": "None", + "optional": true, + "standard": true + } + ] + }, + "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, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "statement_type", + "type": "str", + "description": "The type of financial statement - i.e, balance, income, cash.", + "default": "balance", + "optional": true, + "standard": 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, + "standard": 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, + "standard": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "statement_type", + "type": "str", + "description": "The type of financial statement - i.e, balance, income, cash.", + "default": "balance", + "optional": true, + "standard": 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, + "standard": 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, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : ReportedFinancials\n Serializable results.\n provider : Literal['intrinio']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The ending date of the reporting period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report (e.g. FY, Q1, etc.).", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": "None", + "optional": true, + "standard": true + } + ], + "intrinio": [ + { + "name": "period_ending", + "type": "date", + "description": "The ending date of the reporting period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report (e.g. FY, Q1, etc.).", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": "None", + "optional": true, + "standard": 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": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "10", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "10", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : CashFlowStatementGrowth\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Period the statement is returned for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_net_income", + "type": "float", + "description": "Growth rate of net income.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_depreciation_and_amortization", + "type": "float", + "description": "Growth rate of depreciation and amortization.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_deferred_income_tax", + "type": "float", + "description": "Growth rate of deferred income tax.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_stock_based_compensation", + "type": "float", + "description": "Growth rate of stock-based compensation.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_change_in_working_capital", + "type": "float", + "description": "Growth rate of change in working capital.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_accounts_receivables", + "type": "float", + "description": "Growth rate of accounts receivables.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_inventory", + "type": "float", + "description": "Growth rate of inventory.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_accounts_payables", + "type": "float", + "description": "Growth rate of accounts payables.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_other_working_capital", + "type": "float", + "description": "Growth rate of other working capital.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_other_non_cash_items", + "type": "float", + "description": "Growth rate of other non-cash items.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_net_cash_provided_by_operating_activities", + "type": "float", + "description": "Growth rate of net cash provided by operating activities.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_investments_in_property_plant_and_equipment", + "type": "float", + "description": "Growth rate of investments in property, plant, and equipment.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_acquisitions_net", + "type": "float", + "description": "Growth rate of net acquisitions.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_purchases_of_investments", + "type": "float", + "description": "Growth rate of purchases of investments.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_sales_maturities_of_investments", + "type": "float", + "description": "Growth rate of sales maturities of investments.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_other_investing_activities", + "type": "float", + "description": "Growth rate of other investing activities.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_net_cash_used_for_investing_activities", + "type": "float", + "description": "Growth rate of net cash used for investing activities.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_debt_repayment", + "type": "float", + "description": "Growth rate of debt repayment.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_common_stock_issued", + "type": "float", + "description": "Growth rate of common stock issued.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_common_stock_repurchased", + "type": "float", + "description": "Growth rate of common stock repurchased.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_dividends_paid", + "type": "float", + "description": "Growth rate of dividends paid.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_other_financing_activities", + "type": "float", + "description": "Growth rate of other financing activities.", + "default": "", + "optional": false, + "standard": 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, + "standard": 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, + "standard": true + }, + { + "name": "growth_net_change_in_cash", + "type": "float", + "description": "Growth rate of net change in cash.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_cash_at_end_of_period", + "type": "float", + "description": "Growth rate of cash at the end of the period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_cash_at_beginning_of_period", + "type": "float", + "description": "Growth rate of cash at the beginning of the period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_operating_cash_flow", + "type": "float", + "description": "Growth rate of operating cash flow.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_capital_expenditure", + "type": "float", + "description": "Growth rate of capital expenditure.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_free_cash_flow", + "type": "float", + "description": "Growth rate of free cash flow.", + "default": "", + "optional": false, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Period the statement is returned for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_net_income", + "type": "float", + "description": "Growth rate of net income.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_depreciation_and_amortization", + "type": "float", + "description": "Growth rate of depreciation and amortization.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_deferred_income_tax", + "type": "float", + "description": "Growth rate of deferred income tax.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_stock_based_compensation", + "type": "float", + "description": "Growth rate of stock-based compensation.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_change_in_working_capital", + "type": "float", + "description": "Growth rate of change in working capital.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_accounts_receivables", + "type": "float", + "description": "Growth rate of accounts receivables.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_inventory", + "type": "float", + "description": "Growth rate of inventory.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_accounts_payables", + "type": "float", + "description": "Growth rate of accounts payables.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_other_working_capital", + "type": "float", + "description": "Growth rate of other working capital.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_other_non_cash_items", + "type": "float", + "description": "Growth rate of other non-cash items.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_net_cash_provided_by_operating_activities", + "type": "float", + "description": "Growth rate of net cash provided by operating activities.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_investments_in_property_plant_and_equipment", + "type": "float", + "description": "Growth rate of investments in property, plant, and equipment.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_acquisitions_net", + "type": "float", + "description": "Growth rate of net acquisitions.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_purchases_of_investments", + "type": "float", + "description": "Growth rate of purchases of investments.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_sales_maturities_of_investments", + "type": "float", + "description": "Growth rate of sales maturities of investments.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_other_investing_activities", + "type": "float", + "description": "Growth rate of other investing activities.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_net_cash_used_for_investing_activities", + "type": "float", + "description": "Growth rate of net cash used for investing activities.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_debt_repayment", + "type": "float", + "description": "Growth rate of debt repayment.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_common_stock_issued", + "type": "float", + "description": "Growth rate of common stock issued.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_common_stock_repurchased", + "type": "float", + "description": "Growth rate of common stock repurchased.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_dividends_paid", + "type": "float", + "description": "Growth rate of dividends paid.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_other_financing_activities", + "type": "float", + "description": "Growth rate of other financing activities.", + "default": "", + "optional": false, + "standard": 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, + "standard": 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, + "standard": true + }, + { + "name": "growth_net_change_in_cash", + "type": "float", + "description": "Growth rate of net change in cash.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_cash_at_end_of_period", + "type": "float", + "description": "Growth rate of cash at the end of the period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_cash_at_beginning_of_period", + "type": "float", + "description": "Growth rate of cash at the beginning of the period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_operating_cash_flow", + "type": "float", + "description": "Growth rate of operating cash flow.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_capital_expenditure", + "type": "float", + "description": "Growth rate of capital expenditure.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_free_cash_flow", + "type": "float", + "description": "Growth rate of free cash flow.", + "default": "", + "optional": false, + "standard": 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": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "100", + "optional": true, + "standard": false + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : HistoricalDividends\n Serializable results.\n provider : Literal['fmp', 'intrinio', 'yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "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, + "standard": true + }, + { + "name": "amount", + "type": "float", + "description": "The dividend amount per share.", + "default": "", + "optional": false, + "standard": true + } + ], + "fmp": [ + { + "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, + "standard": true + }, + { + "name": "amount", + "type": "float", + "description": "The dividend amount per share.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "label", + "type": "str", + "description": "Label of the historical dividends.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "adj_dividend", + "type": "float", + "description": "Adjusted dividend of the historical dividends.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "record_date", + "type": "date", + "description": "Record date of the historical dividends.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "payment_date", + "type": "date", + "description": "Payment date of the historical dividends.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "declaration_date", + "type": "date", + "description": "Declaration date of the historical dividends.", + "default": "None", + "optional": true, + "standard": false + } + ], + "intrinio": [ + { + "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, + "standard": true + }, + { + "name": "amount", + "type": "float", + "description": "The dividend amount per share.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "factor", + "type": "float", + "description": "factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "currency", + "type": "str", + "description": "The currency in which the dividend is paid.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "split_ratio", + "type": "float", + "description": "The ratio of the stock split, if a stock split occurred.", + "default": "None", + "optional": true, + "standard": false + } + ], + "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, + "standard": true + }, + { + "name": "amount", + "type": "float", + "description": "The dividend amount per share.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : HistoricalEps\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "announce_time", + "type": "str", + "description": "Timing of the earnings announcement.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "eps_actual", + "type": "float", + "description": "Actual EPS from the earnings date.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "eps_estimated", + "type": "float", + "description": "Estimated EPS for the earnings date.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "announce_time", + "type": "str", + "description": "Timing of the earnings announcement.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "eps_actual", + "type": "float", + "description": "Actual EPS from the earnings date.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "eps_estimated", + "type": "float", + "description": "Estimated EPS for the earnings date.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "revenue_estimated", + "type": "float", + "description": "Estimated consensus revenue for the reporting period.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "revenue_actual", + "type": "float", + "description": "The actual reported revenue.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "reporting_time", + "type": "str", + "description": "The reporting time - e.g. after market close.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "updated_at", + "type": "date", + "description": "The date when the data was last updated.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "period_ending", + "type": "date", + "description": "The fiscal period end date.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : HistoricalEmployees\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "cik", + "type": "int", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "acceptance_time", + "type": "datetime", + "description": "Time of acceptance of the company employee.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period_of_report", + "type": "date", + "description": "Date of reporting of the company employee.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "company_name", + "type": "str", + "description": "Registered name of the company to retrieve the historical employees of.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "form_type", + "type": "str", + "description": "Form type of the company employee.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "filing_date", + "type": "date", + "description": "Filing date of the company employee", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "employee_count", + "type": "int", + "description": "Count of employees of the company.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "source", + "type": "str", + "description": "Source URL which retrieves this data for the company.", + "default": "", + "optional": false, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "cik", + "type": "int", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "acceptance_time", + "type": "datetime", + "description": "Time of acceptance of the company employee.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period_of_report", + "type": "date", + "description": "Date of reporting of the company employee.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "company_name", + "type": "str", + "description": "Registered name of the company to retrieve the historical employees of.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "form_type", + "type": "str", + "description": "Form type of the company employee.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "filing_date", + "type": "date", + "description": "Filing date of the company employee", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "employee_count", + "type": "int", + "description": "Count of employees of the company.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "source", + "type": "str", + "description": "Source URL which retrieves this data for the company.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "1000", + "optional": true, + "standard": 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, + "standard": true + } + ], + "intrinio": [ + { + "name": "query", + "type": "str", + "description": "Query to search for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "1000", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : SearchAttributes\n Serializable results.\n provider : Literal['intrinio']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "id", + "type": "str", + "description": "ID of the financial attribute.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the financial attribute.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "tag", + "type": "str", + "description": "Tag of the financial attribute.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "statement_code", + "type": "str", + "description": "Code of the financial statement.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "statement_type", + "type": "str", + "description": "Type of the financial statement.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "parent_name", + "type": "str", + "description": "Parent's name of the financial attribute.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "sequence", + "type": "int", + "description": "Sequence of the financial statement.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "factor", + "type": "str", + "description": "Unit of the financial attribute.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "transaction", + "type": "str", + "description": "Transaction type (credit/debit) of the financial attribute.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "type", + "type": "str", + "description": "Type of the financial attribute.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "unit", + "type": "str", + "description": "Unit of the financial attribute.", + "default": "None", + "optional": true, + "standard": true + } + ], + "intrinio": [ + { + "name": "id", + "type": "str", + "description": "ID of the financial attribute.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the financial attribute.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "tag", + "type": "str", + "description": "Tag of the financial attribute.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "statement_code", + "type": "str", + "description": "Code of the financial statement.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "statement_type", + "type": "str", + "description": "Type of the financial statement.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "parent_name", + "type": "str", + "description": "Parent's name of the financial attribute.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "sequence", + "type": "int", + "description": "Sequence of the financial statement.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "factor", + "type": "str", + "description": "Unit of the financial attribute.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "transaction", + "type": "str", + "description": "Transaction type (credit/debit) of the financial attribute.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "type", + "type": "str", + "description": "Type of the financial attribute.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "unit", + "type": "str", + "description": "Unit of the financial attribute.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "tag", + "type": "Union[str, List[str]]", + "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "tag", + "type": "Union[str, List[str]]", + "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : LatestAttributes\n Serializable results.\n provider : Literal['intrinio']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "tag", + "type": "str", + "description": "Tag name for the fetched data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "value", + "type": "Union[str, float]", + "description": "The value of the data.", + "default": "None", + "optional": true, + "standard": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "tag", + "type": "str", + "description": "Tag name for the fetched data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "value", + "type": "Union[str, float]", + "description": "The value of the data.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "tag", + "type": "Union[str, List[str]]", + "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "frequency", + "type": "Literal['daily', 'weekly', 'monthly', 'quarterly', 'yearly']", + "description": "The frequency of the data.", + "default": "yearly", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "1000", + "optional": true, + "standard": true + }, + { + "name": "tag_type", + "type": "str", + "description": "Filter by type, when applicable.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order.", + "default": "desc", + "optional": true, + "standard": 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, + "standard": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "tag", + "type": "Union[str, List[str]]", + "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "frequency", + "type": "Literal['daily', 'weekly', 'monthly', 'quarterly', 'yearly']", + "description": "The frequency of the data.", + "default": "yearly", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "1000", + "optional": true, + "standard": true + }, + { + "name": "tag_type", + "type": "str", + "description": "Filter by type, when applicable.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order.", + "default": "desc", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : HistoricalAttributes\n Serializable results.\n provider : Literal['intrinio']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "tag", + "type": "str", + "description": "Tag name for the fetched data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "value", + "type": "float", + "description": "The value of the data.", + "default": "None", + "optional": true, + "standard": true + } + ], + "intrinio": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "tag", + "type": "str", + "description": "Tag name for the fetched data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "value", + "type": "float", + "description": "The value of the data.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int, Ge(ge=0)", + "description": "The number of data entries to return.", + "default": "5", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int, Ge(ge=0)", + "description": "The number of data entries to return.", + "default": "5", + "optional": true, + "standard": 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, + "standard": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int, Ge(ge=0)", + "description": "The number of data entries to return.", + "default": "5", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", + "default": "None", + "optional": true, + "standard": false + } + ], + "polygon": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int, Ge(ge=0)", + "description": "The number of data entries to return.", + "default": "5", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "filing_date", + "type": "date", + "description": "Filing date of the financial statement.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "filing_date_lt", + "type": "date", + "description": "Filing date less than the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "filing_date_lte", + "type": "date", + "description": "Filing date less than or equal to the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "filing_date_gt", + "type": "date", + "description": "Filing date greater than the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "filing_date_gte", + "type": "date", + "description": "Filing date greater than or equal to the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "period_of_report_date", + "type": "date", + "description": "Period of report date of the financial statement.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "period_of_report_date_lt", + "type": "date", + "description": "Period of report date less than the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "period_of_report_date_lte", + "type": "date", + "description": "Period of report date less than or equal to the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "period_of_report_date_gt", + "type": "date", + "description": "Period of report date greater than the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "period_of_report_date_gte", + "type": "date", + "description": "Period of report date greater than or equal to the given date.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "include_sources", + "type": "bool", + "description": "Whether to include the sources of the financial statement.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order of the financial statement.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "sort", + "type": "Literal['filing_date', 'period_of_report_date']", + "description": "Sort of the financial statement.", + "default": "None", + "optional": true, + "standard": false + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int, Ge(ge=0)", + "description": "The number of data entries to return.", + "default": "5", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : IncomeStatement\n Serializable results.\n provider : Literal['fmp', 'intrinio', 'polygon', 'yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "filing_date", + "type": "date", + "description": "The date when the filing was made.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "accepted_date", + "type": "datetime", + "description": "The date and time when the filing was accepted.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet was reported.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "revenue", + "type": "float", + "description": "Total revenue.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cost_of_revenue", + "type": "float", + "description": "Cost of revenue.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "gross_profit", + "type": "float", + "description": "Gross profit.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "gross_profit_margin", + "type": "float", + "description": "Gross profit margin.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "general_and_admin_expense", + "type": "float", + "description": "General and administrative expenses.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "research_and_development_expense", + "type": "float", + "description": "Research and development expenses.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "selling_and_marketing_expense", + "type": "float", + "description": "Selling and marketing expenses.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "selling_general_and_admin_expense", + "type": "float", + "description": "Selling, general and administrative expenses.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_expenses", + "type": "float", + "description": "Other expenses.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_operating_expenses", + "type": "float", + "description": "Total operating expenses.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cost_and_expenses", + "type": "float", + "description": "Cost and expenses.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "interest_income", + "type": "float", + "description": "Interest income.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_interest_expense", + "type": "float", + "description": "Total interest expenses.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "depreciation_and_amortization", + "type": "float", + "description": "Depreciation and amortization.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ebitda", + "type": "float", + "description": "EBITDA.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ebitda_margin", + "type": "float", + "description": "EBITDA margin.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_operating_income", + "type": "float", + "description": "Total operating income.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "operating_income_margin", + "type": "float", + "description": "Operating income margin.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_other_income_expenses", + "type": "float", + "description": "Total other income and expenses.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_pre_tax_income", + "type": "float", + "description": "Total pre-tax income.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "pre_tax_income_margin", + "type": "float", + "description": "Pre-tax income margin.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "income_tax_expense", + "type": "float", + "description": "Income tax expense.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "consolidated_net_income", + "type": "float", + "description": "Consolidated net income.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_income_margin", + "type": "float", + "description": "Net income margin.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "basic_earnings_per_share", + "type": "float", + "description": "Basic earnings per share.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "diluted_earnings_per_share", + "type": "float", + "description": "Diluted earnings per share.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "weighted_average_basic_shares_outstanding", + "type": "float", + "description": "Weighted average basic shares outstanding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "weighted_average_diluted_shares_outstanding", + "type": "float", + "description": "Weighted average diluted shares outstanding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "link", + "type": "str", + "description": "Link to the filing.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "final_link", + "type": "str", + "description": "Link to the filing document.", + "default": "None", + "optional": true, + "standard": false + } + ], + "intrinio": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet is reported.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "revenue", + "type": "float", + "description": "Total revenue", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "operating_revenue", + "type": "float", + "description": "Total operating revenue", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cost_of_revenue", + "type": "float", + "description": "Total cost of revenue", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "operating_cost_of_revenue", + "type": "float", + "description": "Total operating cost of revenue", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "gross_profit", + "type": "float", + "description": "Total gross profit", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "gross_profit_margin", + "type": "float", + "description": "Gross margin ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "provision_for_credit_losses", + "type": "float", + "description": "Provision for credit losses", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "research_and_development_expense", + "type": "float", + "description": "Research and development expense", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "selling_general_and_admin_expense", + "type": "float", + "description": "Selling, general, and admin expense", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "salaries_and_employee_benefits", + "type": "float", + "description": "Salaries and employee benefits", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "marketing_expense", + "type": "float", + "description": "Marketing expense", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_occupancy_and_equipment_expense", + "type": "float", + "description": "Net occupancy and equipment expense", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_operating_expenses", + "type": "float", + "description": "Other operating expenses", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "depreciation_expense", + "type": "float", + "description": "Depreciation expense", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "amortization_expense", + "type": "float", + "description": "Amortization expense", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "amortization_of_deferred_policy_acquisition_costs", + "type": "float", + "description": "Amortization of deferred policy acquisition costs", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "exploration_expense", + "type": "float", + "description": "Exploration expense", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "depletion_expense", + "type": "float", + "description": "Depletion expense", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_operating_expenses", + "type": "float", + "description": "Total operating expenses", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_operating_income", + "type": "float", + "description": "Total operating income", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "deposits_and_money_market_investments_interest_income", + "type": "float", + "description": "Deposits and money market investments interest income", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "federal_funds_sold_and_securities_borrowed_interest_income", + "type": "float", + "description": "Federal funds sold and securities borrowed interest income", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "investment_securities_interest_income", + "type": "float", + "description": "Investment securities interest income", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "loans_and_leases_interest_income", + "type": "float", + "description": "Loans and leases interest income", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "trading_account_interest_income", + "type": "float", + "description": "Trading account interest income", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_interest_income", + "type": "float", + "description": "Other interest income", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_non_interest_income", + "type": "float", + "description": "Total non-interest income", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "interest_and_investment_income", + "type": "float", + "description": "Interest and investment income", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "short_term_borrowings_interest_expense", + "type": "float", + "description": "Short-term borrowings interest expense", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "long_term_debt_interest_expense", + "type": "float", + "description": "Long-term debt interest expense", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "capitalized_lease_obligations_interest_expense", + "type": "float", + "description": "Capitalized lease obligations interest expense", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "deposits_interest_expense", + "type": "float", + "description": "Deposits interest expense", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "federal_funds_purchased_and_securities_sold_interest_expense", + "type": "float", + "description": "Federal funds purchased and securities sold interest expense", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_interest_expense", + "type": "float", + "description": "Other interest expense", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_interest_expense", + "type": "float", + "description": "Total interest expense", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_interest_income", + "type": "float", + "description": "Net interest income", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_non_interest_income", + "type": "float", + "description": "Other non-interest income", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "investment_banking_income", + "type": "float", + "description": "Investment banking income", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "trust_fees_by_commissions", + "type": "float", + "description": "Trust fees by commissions", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "premiums_earned", + "type": "float", + "description": "Premiums earned", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "insurance_policy_acquisition_costs", + "type": "float", + "description": "Insurance policy acquisition costs", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "current_and_future_benefits", + "type": "float", + "description": "Current and future benefits", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "property_and_liability_insurance_claims", + "type": "float", + "description": "Property and liability insurance claims", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_non_interest_expense", + "type": "float", + "description": "Total non-interest expense", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_realized_and_unrealized_capital_gains_on_investments", + "type": "float", + "description": "Net realized and unrealized capital gains on investments", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_gains", + "type": "float", + "description": "Other gains", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "non_operating_income", + "type": "float", + "description": "Non-operating income", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_income", + "type": "float", + "description": "Other income", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_revenue", + "type": "float", + "description": "Other revenue", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "extraordinary_income", + "type": "float", + "description": "Extraordinary income", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_other_income", + "type": "float", + "description": "Total other income", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ebitda", + "type": "float", + "description": "Earnings Before Interest, Taxes, Depreciation and Amortization.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ebitda_margin", + "type": "float", + "description": "Margin on Earnings Before Interest, Taxes, Depreciation and Amortization.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_pre_tax_income", + "type": "float", + "description": "Total pre-tax income", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ebit", + "type": "float", + "description": "Earnings Before Interest and Taxes.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "pre_tax_income_margin", + "type": "float", + "description": "Pre-Tax Income Margin.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "income_tax_expense", + "type": "float", + "description": "Income tax expense", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "impairment_charge", + "type": "float", + "description": "Impairment charge", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "restructuring_charge", + "type": "float", + "description": "Restructuring charge", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "service_charges_on_deposit_accounts", + "type": "float", + "description": "Service charges on deposit accounts", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_service_charges", + "type": "float", + "description": "Other service charges", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_special_charges", + "type": "float", + "description": "Other special charges", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_cost_of_revenue", + "type": "float", + "description": "Other cost of revenue", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_income_continuing_operations", + "type": "float", + "description": "Net income (continuing operations)", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_income_discontinued_operations", + "type": "float", + "description": "Net income (discontinued operations)", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "consolidated_net_income", + "type": "float", + "description": "Consolidated net income", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_adjustments_to_consolidated_net_income", + "type": "float", + "description": "Other adjustments to consolidated net income", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_adjustment_to_net_income_attributable_to_common_shareholders", + "type": "float", + "description": "Other adjustment to net income attributable to common shareholders", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_income_attributable_to_noncontrolling_interest", + "type": "float", + "description": "Net income attributable to noncontrolling interest", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_income_attributable_to_common_shareholders", + "type": "float", + "description": "Net income attributable to common shareholders", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "basic_earnings_per_share", + "type": "float", + "description": "Basic earnings per share", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "diluted_earnings_per_share", + "type": "float", + "description": "Diluted earnings per share", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "basic_and_diluted_earnings_per_share", + "type": "float", + "description": "Basic and diluted earnings per share", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cash_dividends_to_common_per_share", + "type": "float", + "description": "Cash dividends to common per share", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "preferred_stock_dividends_declared", + "type": "float", + "description": "Preferred stock dividends declared", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "weighted_average_basic_shares_outstanding", + "type": "float", + "description": "Weighted average basic shares outstanding", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "weighted_average_diluted_shares_outstanding", + "type": "float", + "description": "Weighted average diluted shares outstanding", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "weighted_average_basic_and_diluted_shares_outstanding", + "type": "float", + "description": "Weighted average basic and diluted shares outstanding", + "default": "None", + "optional": true, + "standard": false + } + ], + "polygon": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "revenue", + "type": "float", + "description": "Total Revenue", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cost_of_revenue_goods", + "type": "float", + "description": "Cost of Revenue - Goods", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cost_of_revenue_services", + "type": "float", + "description": "Cost of Revenue - Services", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cost_of_revenue", + "type": "float", + "description": "Cost of Revenue", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "gross_profit", + "type": "float", + "description": "Gross Profit", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "provisions_for_loan_lease_and_other_losses", + "type": "float", + "description": "Provisions for loan lease and other losses", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "depreciation_and_amortization", + "type": "float", + "description": "Depreciation and Amortization", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "income_tax_expense_benefit_current", + "type": "float", + "description": "Income tax expense benefit current", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "deferred_tax_benefit", + "type": "float", + "description": "Deferred tax benefit", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "benefits_costs_expenses", + "type": "float", + "description": "Benefits, costs and expenses", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "selling_general_and_administrative_expense", + "type": "float", + "description": "Selling, general and administrative expense", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "research_and_development", + "type": "float", + "description": "Research and development", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "costs_and_expenses", + "type": "float", + "description": "Costs and expenses", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_operating_expenses", + "type": "float", + "description": "Other Operating Expenses", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "operating_expenses", + "type": "float", + "description": "Operating expenses", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "operating_income", + "type": "float", + "description": "Operating Income/Loss", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "non_operating_income", + "type": "float", + "description": "Non Operating Income/Loss", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "interest_and_dividend_income", + "type": "float", + "description": "Interest and Dividend Income", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_interest_expense", + "type": "float", + "description": "Interest Expense", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "interest_and_debt_expense", + "type": "float", + "description": "Interest and Debt Expense", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_interest_income", + "type": "float", + "description": "Interest Income Net", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "interest_income_after_provision_for_losses", + "type": "float", + "description": "Interest Income After Provision for Losses", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "non_interest_expense", + "type": "float", + "description": "Non-Interest Expense", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "non_interest_income", + "type": "float", + "description": "Non-Interest Income", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "income_from_discontinued_operations_net_of_tax_on_disposal", + "type": "float", + "description": "Income From Discontinued Operations Net of Tax on Disposal", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "income_from_discontinued_operations_net_of_tax", + "type": "float", + "description": "Income From Discontinued Operations Net of Tax", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "income_before_equity_method_investments", + "type": "float", + "description": "Income Before Equity Method Investments", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "income_from_equity_method_investments", + "type": "float", + "description": "Income From Equity Method Investments", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_pre_tax_income", + "type": "float", + "description": "Income Before Tax", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "income_tax_expense", + "type": "float", + "description": "Income Tax Expense", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "income_after_tax", + "type": "float", + "description": "Income After Tax", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "consolidated_net_income", + "type": "float", + "description": "Net Income/Loss", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_income_attributable_noncontrolling_interest", + "type": "float", + "description": "Net income (loss) attributable to noncontrolling interest", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_income_attributable_to_parent", + "type": "float", + "description": "Net income (loss) attributable to parent", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_income_attributable_to_common_shareholders", + "type": "float", + "description": "Net Income/Loss Available To Common Stockholders Basic", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "participating_securities_earnings", + "type": "float", + "description": "Participating Securities Distributed And Undistributed Earnings Loss Basic", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "undistributed_earnings_allocated_to_participating_securities", + "type": "float", + "description": "Undistributed Earnings Allocated To Participating Securities", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "common_stock_dividends", + "type": "float", + "description": "Common Stock Dividends", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "preferred_stock_dividends_and_other_adjustments", + "type": "float", + "description": "Preferred stock dividends and other adjustments", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "basic_earnings_per_share", + "type": "float", + "description": "Earnings Per Share", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "diluted_earnings_per_share", + "type": "float", + "description": "Diluted Earnings Per Share", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "weighted_average_basic_shares_outstanding", + "type": "float", + "description": "Basic Average Shares", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "weighted_average_diluted_shares_outstanding", + "type": "float", + "description": "Diluted Average Shares", + "default": "None", + "optional": true, + "standard": false + } + ], + "yfinance": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", + "default": "None", + "optional": true, + "standard": true + } + ] + }, + "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, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "10", + "optional": true, + "standard": true + }, + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "10", + "optional": true, + "standard": true + }, + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : IncomeStatementGrowth\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Period the statement is returned for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_revenue", + "type": "float", + "description": "Growth rate of total revenue.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_cost_of_revenue", + "type": "float", + "description": "Growth rate of cost of goods sold.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_gross_profit", + "type": "float", + "description": "Growth rate of gross profit.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_gross_profit_ratio", + "type": "float", + "description": "Growth rate of gross profit as a percentage of revenue.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_research_and_development_expenses", + "type": "float", + "description": "Growth rate of expenses on research and development.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_general_and_administrative_expenses", + "type": "float", + "description": "Growth rate of general and administrative expenses.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_selling_and_marketing_expenses", + "type": "float", + "description": "Growth rate of expenses on selling and marketing activities.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_other_expenses", + "type": "float", + "description": "Growth rate of other operating expenses.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_operating_expenses", + "type": "float", + "description": "Growth rate of total operating expenses.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_cost_and_expenses", + "type": "float", + "description": "Growth rate of total costs and expenses.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_interest_expense", + "type": "float", + "description": "Growth rate of interest expenses.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_depreciation_and_amortization", + "type": "float", + "description": "Growth rate of depreciation and amortization expenses.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_ebitda", + "type": "float", + "description": "Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_ebitda_ratio", + "type": "float", + "description": "Growth rate of EBITDA as a percentage of revenue.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_operating_income", + "type": "float", + "description": "Growth rate of operating income.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_operating_income_ratio", + "type": "float", + "description": "Growth rate of operating income as a percentage of revenue.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_total_other_income_expenses_net", + "type": "float", + "description": "Growth rate of net total other income and expenses.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_income_before_tax", + "type": "float", + "description": "Growth rate of income before taxes.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_income_before_tax_ratio", + "type": "float", + "description": "Growth rate of income before taxes as a percentage of revenue.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_income_tax_expense", + "type": "float", + "description": "Growth rate of income tax expenses.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_net_income", + "type": "float", + "description": "Growth rate of net income.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_net_income_ratio", + "type": "float", + "description": "Growth rate of net income as a percentage of revenue.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_eps", + "type": "float", + "description": "Growth rate of Earnings Per Share (EPS).", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_eps_diluted", + "type": "float", + "description": "Growth rate of diluted Earnings Per Share (EPS).", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_weighted_average_shs_out", + "type": "float", + "description": "Growth rate of weighted average shares outstanding.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_weighted_average_shs_out_dil", + "type": "float", + "description": "Growth rate of diluted weighted average shares outstanding.", + "default": "", + "optional": false, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Period the statement is returned for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_revenue", + "type": "float", + "description": "Growth rate of total revenue.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_cost_of_revenue", + "type": "float", + "description": "Growth rate of cost of goods sold.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_gross_profit", + "type": "float", + "description": "Growth rate of gross profit.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_gross_profit_ratio", + "type": "float", + "description": "Growth rate of gross profit as a percentage of revenue.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_research_and_development_expenses", + "type": "float", + "description": "Growth rate of expenses on research and development.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_general_and_administrative_expenses", + "type": "float", + "description": "Growth rate of general and administrative expenses.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_selling_and_marketing_expenses", + "type": "float", + "description": "Growth rate of expenses on selling and marketing activities.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_other_expenses", + "type": "float", + "description": "Growth rate of other operating expenses.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_operating_expenses", + "type": "float", + "description": "Growth rate of total operating expenses.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_cost_and_expenses", + "type": "float", + "description": "Growth rate of total costs and expenses.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_interest_expense", + "type": "float", + "description": "Growth rate of interest expenses.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_depreciation_and_amortization", + "type": "float", + "description": "Growth rate of depreciation and amortization expenses.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_ebitda", + "type": "float", + "description": "Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_ebitda_ratio", + "type": "float", + "description": "Growth rate of EBITDA as a percentage of revenue.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_operating_income", + "type": "float", + "description": "Growth rate of operating income.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_operating_income_ratio", + "type": "float", + "description": "Growth rate of operating income as a percentage of revenue.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_total_other_income_expenses_net", + "type": "float", + "description": "Growth rate of net total other income and expenses.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_income_before_tax", + "type": "float", + "description": "Growth rate of income before taxes.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_income_before_tax_ratio", + "type": "float", + "description": "Growth rate of income before taxes as a percentage of revenue.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_income_tax_expense", + "type": "float", + "description": "Growth rate of income tax expenses.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_net_income", + "type": "float", + "description": "Growth rate of net income.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_net_income_ratio", + "type": "float", + "description": "Growth rate of net income as a percentage of revenue.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_eps", + "type": "float", + "description": "Growth rate of Earnings Per Share (EPS).", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_eps_diluted", + "type": "float", + "description": "Growth rate of diluted Earnings Per Share (EPS).", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_weighted_average_shs_out", + "type": "float", + "description": "Growth rate of weighted average shares outstanding.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "growth_weighted_average_shs_out_dil", + "type": "float", + "description": "Growth rate of diluted weighted average shares outstanding.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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, + "standard": true + }, + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "100", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "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, + "standard": true + }, + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "100", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "with_ttm", + "type": "bool", + "description": "Include trailing twelve months (TTM) data.", + "default": "False", + "optional": true, + "standard": false + } + ], + "intrinio": [ + { + "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, + "standard": true + }, + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "100", + "optional": true, + "standard": 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, + "standard": true + } + ], + "yfinance": [ + { + "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, + "standard": true + }, + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "100", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : KeyMetrics\n Serializable results.\n provider : Literal['fmp', 'intrinio', 'yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "market_cap", + "type": "float", + "description": "Market capitalization", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "pe_ratio", + "type": "float", + "description": "Price-to-earnings ratio (P/E ratio)", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "market_cap", + "type": "float", + "description": "Market capitalization", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "pe_ratio", + "type": "float", + "description": "Price-to-earnings ratio (P/E ratio)", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "period", + "type": "str", + "description": "Period of the data.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "calendar_year", + "type": "int", + "description": "Calendar year.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "revenue_per_share", + "type": "float", + "description": "Revenue per share", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_income_per_share", + "type": "float", + "description": "Net income per share", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "operating_cash_flow_per_share", + "type": "float", + "description": "Operating cash flow per share", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "free_cash_flow_per_share", + "type": "float", + "description": "Free cash flow per share", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cash_per_share", + "type": "float", + "description": "Cash per share", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "book_value_per_share", + "type": "float", + "description": "Book value per share", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "tangible_book_value_per_share", + "type": "float", + "description": "Tangible book value per share", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "shareholders_equity_per_share", + "type": "float", + "description": "Shareholders equity per share", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "interest_debt_per_share", + "type": "float", + "description": "Interest debt per share", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "enterprise_value", + "type": "float", + "description": "Enterprise value", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "price_to_sales_ratio", + "type": "float", + "description": "Price-to-sales ratio", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "pocf_ratio", + "type": "float", + "description": "Price-to-operating cash flow ratio", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "pfcf_ratio", + "type": "float", + "description": "Price-to-free cash flow ratio", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "pb_ratio", + "type": "float", + "description": "Price-to-book ratio", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ptb_ratio", + "type": "float", + "description": "Price-to-tangible book ratio", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ev_to_sales", + "type": "float", + "description": "Enterprise value-to-sales ratio", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "enterprise_value_over_ebitda", + "type": "float", + "description": "Enterprise value-to-EBITDA ratio", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ev_to_operating_cash_flow", + "type": "float", + "description": "Enterprise value-to-operating cash flow ratio", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ev_to_free_cash_flow", + "type": "float", + "description": "Enterprise value-to-free cash flow ratio", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "earnings_yield", + "type": "float", + "description": "Earnings yield", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "free_cash_flow_yield", + "type": "float", + "description": "Free cash flow yield", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "debt_to_equity", + "type": "float", + "description": "Debt-to-equity ratio", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "debt_to_assets", + "type": "float", + "description": "Debt-to-assets ratio", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_debt_to_ebitda", + "type": "float", + "description": "Net debt-to-EBITDA ratio", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "current_ratio", + "type": "float", + "description": "Current ratio", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "interest_coverage", + "type": "float", + "description": "Interest coverage", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "income_quality", + "type": "float", + "description": "Income quality", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "dividend_yield", + "type": "float", + "description": "Dividend yield, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "payout_ratio", + "type": "float", + "description": "Payout ratio", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "sales_general_and_administrative_to_revenue", + "type": "float", + "description": "Sales general and administrative expenses-to-revenue ratio", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "research_and_development_to_revenue", + "type": "float", + "description": "Research and development expenses-to-revenue ratio", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "intangibles_to_total_assets", + "type": "float", + "description": "Intangibles-to-total assets ratio", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "capex_to_operating_cash_flow", + "type": "float", + "description": "Capital expenditures-to-operating cash flow ratio", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "capex_to_revenue", + "type": "float", + "description": "Capital expenditures-to-revenue ratio", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "capex_to_depreciation", + "type": "float", + "description": "Capital expenditures-to-depreciation ratio", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "stock_based_compensation_to_revenue", + "type": "float", + "description": "Stock-based compensation-to-revenue ratio", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "graham_number", + "type": "float", + "description": "Graham number", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "roic", + "type": "float", + "description": "Return on invested capital", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "return_on_tangible_assets", + "type": "float", + "description": "Return on tangible assets", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "graham_net_net", + "type": "float", + "description": "Graham net-net working capital", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "working_capital", + "type": "float", + "description": "Working capital", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "tangible_asset_value", + "type": "float", + "description": "Tangible asset value", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_current_asset_value", + "type": "float", + "description": "Net current asset value", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "invested_capital", + "type": "float", + "description": "Invested capital", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "average_receivables", + "type": "float", + "description": "Average receivables", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "average_payables", + "type": "float", + "description": "Average payables", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "average_inventory", + "type": "float", + "description": "Average inventory", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "days_sales_outstanding", + "type": "float", + "description": "Days sales outstanding", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "days_payables_outstanding", + "type": "float", + "description": "Days payables outstanding", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "days_of_inventory_on_hand", + "type": "float", + "description": "Days of inventory on hand", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "receivables_turnover", + "type": "float", + "description": "Receivables turnover", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "payables_turnover", + "type": "float", + "description": "Payables turnover", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "inventory_turnover", + "type": "float", + "description": "Inventory turnover", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "roe", + "type": "float", + "description": "Return on equity", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "capex_per_share", + "type": "float", + "description": "Capital expenditures per share", + "default": "None", + "optional": true, + "standard": false + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "market_cap", + "type": "float", + "description": "Market capitalization", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "pe_ratio", + "type": "float", + "description": "Price-to-earnings ratio (P/E ratio)", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "price_to_book", + "type": "float", + "description": "Price to book ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "price_to_tangible_book", + "type": "float", + "description": "Price to tangible book ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "price_to_revenue", + "type": "float", + "description": "Price to revenue ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "quick_ratio", + "type": "float", + "description": "Quick ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "gross_margin", + "type": "float", + "description": "Gross margin, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ebit_margin", + "type": "float", + "description": "EBIT margin, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "profit_margin", + "type": "float", + "description": "Profit margin, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "eps", + "type": "float", + "description": "Basic earnings per share.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "eps_growth", + "type": "float", + "description": "EPS growth, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "revenue_growth", + "type": "float", + "description": "Revenue growth, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ebitda_growth", + "type": "float", + "description": "EBITDA growth, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ebit_growth", + "type": "float", + "description": "EBIT growth, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_income_growth", + "type": "float", + "description": "Net income growth, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "free_cash_flow_to_firm_growth", + "type": "float", + "description": "Free cash flow to firm growth, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "invested_capital_growth", + "type": "float", + "description": "Invested capital growth, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "return_on_assets", + "type": "float", + "description": "Return on assets, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "return_on_equity", + "type": "float", + "description": "Return on equity, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "return_on_invested_capital", + "type": "float", + "description": "Return on invested capital, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ebitda", + "type": "int", + "description": "Earnings before interest, taxes, depreciation, and amortization.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ebit", + "type": "int", + "description": "Earnings before interest and taxes.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "long_term_debt", + "type": "int", + "description": "Long-term debt.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_debt", + "type": "int", + "description": "Total debt.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_capital", + "type": "int", + "description": "The sum of long-term debt and total shareholder equity.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "enterprise_value", + "type": "int", + "description": "Enterprise value.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "free_cash_flow_to_firm", + "type": "int", + "description": "Free cash flow to firm.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "altman_z_score", + "type": "float", + "description": "Altman Z-score.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "beta", + "type": "float", + "description": "Beta relative to the broad market (rolling three-year).", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "dividend_yield", + "type": "float", + "description": "Dividend yield, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "earnings_yield", + "type": "float", + "description": "Earnings yield, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "last_price", + "type": "float", + "description": "Last price of the stock.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "year_high", + "type": "float", + "description": "52 week high", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "year_low", + "type": "float", + "description": "52 week low", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "volume_avg", + "type": "int", + "description": "Average daily volume.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "short_interest", + "type": "int", + "description": "Number of shares reported as sold short.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "shares_outstanding", + "type": "int", + "description": "Weighted average shares outstanding (TTM).", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "days_to_cover", + "type": "float", + "description": "Days to cover short interest, based on average daily volume.", + "default": "None", + "optional": true, + "standard": false + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "market_cap", + "type": "float", + "description": "Market capitalization", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "pe_ratio", + "type": "float", + "description": "Price-to-earnings ratio (P/E ratio)", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "forward_pe", + "type": "float", + "description": "Forward price-to-earnings ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "peg_ratio", + "type": "float", + "description": "PEG ratio (5-year expected).", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "peg_ratio_ttm", + "type": "float", + "description": "PEG ratio (TTM).", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "eps_ttm", + "type": "float", + "description": "Earnings per share (TTM).", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "eps_forward", + "type": "float", + "description": "Forward earnings per share.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "enterprise_to_ebitda", + "type": "float", + "description": "Enterprise value to EBITDA ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "earnings_growth", + "type": "float", + "description": "Earnings growth (Year Over Year), as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "earnings_growth_quarterly", + "type": "float", + "description": "Quarterly earnings growth (Year Over Year), as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "revenue_per_share", + "type": "float", + "description": "Revenue per share (TTM).", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "revenue_growth", + "type": "float", + "description": "Revenue growth (Year Over Year), as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "enterprise_to_revenue", + "type": "float", + "description": "Enterprise value to revenue ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cash_per_share", + "type": "float", + "description": "Cash per share.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "quick_ratio", + "type": "float", + "description": "Quick ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "current_ratio", + "type": "float", + "description": "Current ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "debt_to_equity", + "type": "float", + "description": "Debt-to-equity ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "gross_margin", + "type": "float", + "description": "Gross margin, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "operating_margin", + "type": "float", + "description": "Operating margin, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ebitda_margin", + "type": "float", + "description": "EBITDA margin, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "profit_margin", + "type": "float", + "description": "Profit margin, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "return_on_assets", + "type": "float", + "description": "Return on assets, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "return_on_equity", + "type": "float", + "description": "Return on equity, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "dividend_yield", + "type": "float", + "description": "Dividend yield, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "dividend_yield_5y_avg", + "type": "float", + "description": "5-year average dividend yield, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "payout_ratio", + "type": "float", + "description": "Payout ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "book_value", + "type": "float", + "description": "Book value per share.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "price_to_book", + "type": "float", + "description": "Price-to-book ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "enterprise_value", + "type": "int", + "description": "Enterprise value.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "overall_risk", + "type": "float", + "description": "Overall risk score.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "audit_risk", + "type": "float", + "description": "Audit risk score.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "board_risk", + "type": "float", + "description": "Board risk score.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "compensation_risk", + "type": "float", + "description": "Compensation risk score.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "shareholder_rights_risk", + "type": "float", + "description": "Shareholder rights risk score.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "beta", + "type": "float", + "description": "Beta relative to the broad market (5-year monthly).", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "price_return_1y", + "type": "float", + "description": "One-year price return, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "currency", + "type": "str", + "description": "Currency in which the data is presented.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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, + "standard": true + }, + { + "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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "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, + "standard": true + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : KeyExecutives\n Serializable results.\n provider : Literal['fmp', 'yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "title", + "type": "str", + "description": "Designation of the key executive.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the key executive.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "pay", + "type": "int", + "description": "Pay of the key executive.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "currency_pay", + "type": "str", + "description": "Currency of the pay.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "gender", + "type": "str", + "description": "Gender of the key executive.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_born", + "type": "int", + "description": "Birth year of the key executive.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "title_since", + "type": "int", + "description": "Date the tile was held since.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "title", + "type": "str", + "description": "Designation of the key executive.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the key executive.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "pay", + "type": "int", + "description": "Pay of the key executive.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "currency_pay", + "type": "str", + "description": "Currency of the pay.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "gender", + "type": "str", + "description": "Gender of the key executive.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_born", + "type": "int", + "description": "Birth year of the key executive.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "title_since", + "type": "int", + "description": "Date the tile was held since.", + "default": "None", + "optional": true, + "standard": true + } + ], + "yfinance": [ + { + "name": "title", + "type": "str", + "description": "Designation of the key executive.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the key executive.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "pay", + "type": "int", + "description": "Pay of the key executive.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "currency_pay", + "type": "str", + "description": "Currency of the pay.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "gender", + "type": "str", + "description": "Gender of the key executive.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_born", + "type": "int", + "description": "Birth year of the key executive.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "title_since", + "type": "int", + "description": "Date the tile was held since.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "exercised_value", + "type": "int", + "description": "Value of shares exercised.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "unexercised_value", + "type": "int", + "description": "Value of shares not exercised.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : ExecutiveCompensation\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "filing_date", + "type": "date", + "description": "Date of the filing.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "accepted_date", + "type": "datetime", + "description": "Date the filing was accepted.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name_and_position", + "type": "str", + "description": "Name and position of the executive.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "year", + "type": "int", + "description": "Year of the compensation.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "salary", + "type": "float", + "description": "Salary of the executive.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "bonus", + "type": "float", + "description": "Bonus of the executive.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "stock_award", + "type": "float", + "description": "Stock award of the executive.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "incentive_plan_compensation", + "type": "float", + "description": "Incentive plan compensation of the executive.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "all_other_compensation", + "type": "float", + "description": "All other compensation of the executive.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "total", + "type": "float", + "description": "Total compensation of the executive.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "url", + "type": "str", + "description": "URL of the filing data.", + "default": "", + "optional": false, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "filing_date", + "type": "date", + "description": "Date of the filing.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "accepted_date", + "type": "datetime", + "description": "Date the filing was accepted.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name_and_position", + "type": "str", + "description": "Name and position of the executive.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "year", + "type": "int", + "description": "Year of the compensation.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "salary", + "type": "float", + "description": "Salary of the executive.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "bonus", + "type": "float", + "description": "Bonus of the executive.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "stock_award", + "type": "float", + "description": "Stock award of the executive.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "incentive_plan_compensation", + "type": "float", + "description": "Incentive plan compensation of the executive.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "all_other_compensation", + "type": "float", + "description": "All other compensation of the executive.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "total", + "type": "float", + "description": "Total compensation of the executive.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "url", + "type": "str", + "description": "URL of the filing data.", + "default": "", + "optional": false, + "standard": 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, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : CompanyOverview\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "price", + "type": "float", + "description": "Price of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "beta", + "type": "float", + "description": "Beta of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vol_avg", + "type": "int", + "description": "Volume average of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "mkt_cap", + "type": "int", + "description": "Market capitalization of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_div", + "type": "float", + "description": "Last dividend of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "range", + "type": "str", + "description": "Range of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "changes", + "type": "float", + "description": "Changes of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "company_name", + "type": "str", + "description": "Company name of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "isin", + "type": "str", + "description": "ISIN of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "cusip", + "type": "str", + "description": "CUSIP of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "exchange", + "type": "str", + "description": "Exchange of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "exchange_short_name", + "type": "str", + "description": "Exchange short name of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "industry", + "type": "str", + "description": "Industry of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "website", + "type": "str", + "description": "Website of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "description", + "type": "str", + "description": "Description of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ceo", + "type": "str", + "description": "CEO of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "sector", + "type": "str", + "description": "Sector of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "country", + "type": "str", + "description": "Country of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "full_time_employees", + "type": "str", + "description": "Full time employees of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "phone", + "type": "str", + "description": "Phone of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "address", + "type": "str", + "description": "Address of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "city", + "type": "str", + "description": "City of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "state", + "type": "str", + "description": "State of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "zip", + "type": "str", + "description": "Zip of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "dcf_diff", + "type": "float", + "description": "Discounted cash flow difference of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "dcf", + "type": "float", + "description": "Discounted cash flow of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "image", + "type": "str", + "description": "Image of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ipo_date", + "type": "date", + "description": "IPO date of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "default_image", + "type": "bool", + "description": "If the image is the default image.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "is_etf", + "type": "bool", + "description": "If the company is an ETF.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "is_actively_trading", + "type": "bool", + "description": "If the company is actively trading.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "is_adr", + "type": "bool", + "description": "If the company is an ADR.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "is_fund", + "type": "bool", + "description": "If the company is a fund.", + "default": "", + "optional": false, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "price", + "type": "float", + "description": "Price of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "beta", + "type": "float", + "description": "Beta of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vol_avg", + "type": "int", + "description": "Volume average of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "mkt_cap", + "type": "int", + "description": "Market capitalization of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_div", + "type": "float", + "description": "Last dividend of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "range", + "type": "str", + "description": "Range of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "changes", + "type": "float", + "description": "Changes of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "company_name", + "type": "str", + "description": "Company name of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "isin", + "type": "str", + "description": "ISIN of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "cusip", + "type": "str", + "description": "CUSIP of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "exchange", + "type": "str", + "description": "Exchange of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "exchange_short_name", + "type": "str", + "description": "Exchange short name of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "industry", + "type": "str", + "description": "Industry of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "website", + "type": "str", + "description": "Website of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "description", + "type": "str", + "description": "Description of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ceo", + "type": "str", + "description": "CEO of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "sector", + "type": "str", + "description": "Sector of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "country", + "type": "str", + "description": "Country of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "full_time_employees", + "type": "str", + "description": "Full time employees of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "phone", + "type": "str", + "description": "Phone of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "address", + "type": "str", + "description": "Address of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "city", + "type": "str", + "description": "City of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "state", + "type": "str", + "description": "State of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "zip", + "type": "str", + "description": "Zip of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "dcf_diff", + "type": "float", + "description": "Discounted cash flow difference of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "dcf", + "type": "float", + "description": "Discounted cash flow of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "image", + "type": "str", + "description": "Image of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ipo_date", + "type": "date", + "description": "IPO date of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "default_image", + "type": "bool", + "description": "If the image is the default image.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "is_etf", + "type": "bool", + "description": "If the company is an ETF.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "is_actively_trading", + "type": "bool", + "description": "If the company is actively trading.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "is_adr", + "type": "bool", + "description": "If the company is an ADR.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "is_fund", + "type": "bool", + "description": "If the company is a fund.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "12", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "12", + "optional": true, + "standard": 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, + "standard": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "12", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : FinancialRatios\n Serializable results.\n provider : Literal['fmp', 'intrinio']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "str", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "Period of the financial ratios.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "Fiscal year.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "period_ending", + "type": "str", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "Period of the financial ratios.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "Fiscal year.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "current_ratio", + "type": "float", + "description": "Current ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "quick_ratio", + "type": "float", + "description": "Quick ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cash_ratio", + "type": "float", + "description": "Cash ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "days_of_sales_outstanding", + "type": "float", + "description": "Days of sales outstanding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "days_of_inventory_outstanding", + "type": "float", + "description": "Days of inventory outstanding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "operating_cycle", + "type": "float", + "description": "Operating cycle.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "days_of_payables_outstanding", + "type": "float", + "description": "Days of payables outstanding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cash_conversion_cycle", + "type": "float", + "description": "Cash conversion cycle.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "gross_profit_margin", + "type": "float", + "description": "Gross profit margin.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "operating_profit_margin", + "type": "float", + "description": "Operating profit margin.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "pretax_profit_margin", + "type": "float", + "description": "Pretax profit margin.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_profit_margin", + "type": "float", + "description": "Net profit margin.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "effective_tax_rate", + "type": "float", + "description": "Effective tax rate.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "return_on_assets", + "type": "float", + "description": "Return on assets.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "return_on_equity", + "type": "float", + "description": "Return on equity.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "return_on_capital_employed", + "type": "float", + "description": "Return on capital employed.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "net_income_per_ebt", + "type": "float", + "description": "Net income per EBT.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ebt_per_ebit", + "type": "float", + "description": "EBT per EBIT.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ebit_per_revenue", + "type": "float", + "description": "EBIT per revenue.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "debt_ratio", + "type": "float", + "description": "Debt ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "debt_equity_ratio", + "type": "float", + "description": "Debt equity ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "long_term_debt_to_capitalization", + "type": "float", + "description": "Long term debt to capitalization.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_debt_to_capitalization", + "type": "float", + "description": "Total debt to capitalization.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "interest_coverage", + "type": "float", + "description": "Interest coverage.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cash_flow_to_debt_ratio", + "type": "float", + "description": "Cash flow to debt ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "company_equity_multiplier", + "type": "float", + "description": "Company equity multiplier.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "receivables_turnover", + "type": "float", + "description": "Receivables turnover.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "payables_turnover", + "type": "float", + "description": "Payables turnover.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "inventory_turnover", + "type": "float", + "description": "Inventory turnover.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "fixed_asset_turnover", + "type": "float", + "description": "Fixed asset turnover.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "asset_turnover", + "type": "float", + "description": "Asset turnover.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "operating_cash_flow_per_share", + "type": "float", + "description": "Operating cash flow per share.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "free_cash_flow_per_share", + "type": "float", + "description": "Free cash flow per share.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cash_per_share", + "type": "float", + "description": "Cash per share.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "payout_ratio", + "type": "float", + "description": "Payout ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "operating_cash_flow_sales_ratio", + "type": "float", + "description": "Operating cash flow sales ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "free_cash_flow_operating_cash_flow_ratio", + "type": "float", + "description": "Free cash flow operating cash flow ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cash_flow_coverage_ratios", + "type": "float", + "description": "Cash flow coverage ratios.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "short_term_coverage_ratios", + "type": "float", + "description": "Short term coverage ratios.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "capital_expenditure_coverage_ratio", + "type": "float", + "description": "Capital expenditure coverage ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "dividend_paid_and_capex_coverage_ratio", + "type": "float", + "description": "Dividend paid and capex coverage ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "dividend_payout_ratio", + "type": "float", + "description": "Dividend payout ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "price_book_value_ratio", + "type": "float", + "description": "Price book value ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "price_to_book_ratio", + "type": "float", + "description": "Price to book ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "price_to_sales_ratio", + "type": "float", + "description": "Price to sales ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "price_earnings_ratio", + "type": "float", + "description": "Price earnings ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "price_to_free_cash_flows_ratio", + "type": "float", + "description": "Price to free cash flows ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "price_to_operating_cash_flows_ratio", + "type": "float", + "description": "Price to operating cash flows ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "price_cash_flow_ratio", + "type": "float", + "description": "Price cash flow ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "price_earnings_to_growth_ratio", + "type": "float", + "description": "Price earnings to growth ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "price_sales_ratio", + "type": "float", + "description": "Price sales ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "dividend_yield", + "type": "float", + "description": "Dividend yield.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "dividend_yield_percentage", + "type": "float", + "description": "Dividend yield percentage.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "dividend_per_share", + "type": "float", + "description": "Dividend per share.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "enterprise_value_multiple", + "type": "float", + "description": "Enterprise value multiple.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "price_fair_value", + "type": "float", + "description": "Price fair value.", + "default": "None", + "optional": true, + "standard": false + } + ], + "intrinio": [ + { + "name": "period_ending", + "type": "str", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "Period of the financial ratios.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "Fiscal year.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "structure", + "type": "Literal['hierarchical', 'flat']", + "description": "Structure of the returned data.", + "default": "flat", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "structure", + "type": "Literal['hierarchical', 'flat']", + "description": "Structure of the returned data.", + "default": "flat", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : RevenueGeographic\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the reporting period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the reporting period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "filing_date", + "type": "date", + "description": "The filing date of the report.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "geographic_segment", + "type": "int", + "description": "Dictionary of the revenue by geographic segment.", + "default": "", + "optional": false, + "standard": true + } + ], + "fmp": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the reporting period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the reporting period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "filing_date", + "type": "date", + "description": "The filing date of the report.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "geographic_segment", + "type": "int", + "description": "Dictionary of the revenue by geographic segment.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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, + "standard": true + }, + { + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "structure", + "type": "Literal['hierarchical', 'flat']", + "description": "Structure of the returned data.", + "default": "flat", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "standard": true + }, + { + "name": "structure", + "type": "Literal['hierarchical', 'flat']", + "description": "Structure of the returned data.", + "default": "flat", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : RevenueBusinessLine\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the reporting period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the reporting period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "filing_date", + "type": "date", + "description": "The filing date of the report.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "business_line", + "type": "int", + "description": "Dictionary containing the revenue of the business line.", + "default": "", + "optional": false, + "standard": true + } + ], + "fmp": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the reporting period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the reporting period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "filing_date", + "type": "date", + "description": "The filing date of the report.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "business_line", + "type": "int", + "description": "Dictionary containing the revenue of the business line.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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": "None", + "optional": true, + "standard": true + }, + { + "name": "form_type", + "type": "str", + "description": "Filter by form type. Check the data provider for available types.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "100", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "form_type", + "type": "str", + "description": "Filter by form type. Check the data provider for available types.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "100", + "optional": true, + "standard": 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, + "standard": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "form_type", + "type": "str", + "description": "Filter by form type. Check the data provider for available types.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "100", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "thea_enabled", + "type": "bool", + "description": "Return filings that have been read by Intrinio's Thea NLP.", + "default": "None", + "optional": true, + "standard": false + } + ], + "sec": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "form_type", + "type": "str", + "description": "Filter by form type. Check the data provider for available types.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "100", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "cik", + "type": "Union[int, str]", + "description": "Lookup filings by Central Index Key (CIK) instead of by symbol.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "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": "None", + "optional": true, + "standard": false + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache. If True, cache will store for one day.", + "default": "True", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : CompanyFilings\n Serializable results.\n provider : Literal['fmp', 'intrinio', 'sec']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "filing_date", + "type": "date", + "description": "The date of the filing.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "accepted_date", + "type": "datetime", + "description": "Accepted date of the filing.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "report_type", + "type": "str", + "description": "Type of filing.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "filing_url", + "type": "str", + "description": "URL to the filing page.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "report_url", + "type": "str", + "description": "URL to the actual report.", + "default": "", + "optional": false, + "standard": true + } + ], + "fmp": [ + { + "name": "filing_date", + "type": "date", + "description": "The date of the filing.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "accepted_date", + "type": "datetime", + "description": "Accepted date of the filing.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "report_type", + "type": "str", + "description": "Type of filing.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "filing_url", + "type": "str", + "description": "URL to the filing page.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "report_url", + "type": "str", + "description": "URL to the actual report.", + "default": "", + "optional": false, + "standard": true + } + ], + "intrinio": [ + { + "name": "filing_date", + "type": "date", + "description": "The date of the filing.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "accepted_date", + "type": "datetime", + "description": "Accepted date of the filing.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "report_type", + "type": "str", + "description": "Type of filing.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "filing_url", + "type": "str", + "description": "URL to the filing page.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "report_url", + "type": "str", + "description": "URL to the actual report.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "id", + "type": "str", + "description": "Intrinio ID of the filing.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "period_end_date", + "type": "date", + "description": "Ending date of the fiscal period for the filing.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "sec_unique_id", + "type": "str", + "description": "SEC unique ID of the filing.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "instance_url", + "type": "str", + "description": "URL for the XBRL filing for the report.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "industry_group", + "type": "str", + "description": "Industry group of the company.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "industry_category", + "type": "str", + "description": "Industry category of the company.", + "default": "", + "optional": false, + "standard": false + } + ], + "sec": [ + { + "name": "filing_date", + "type": "date", + "description": "The date of the filing.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "accepted_date", + "type": "datetime", + "description": "Accepted date of the filing.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "report_type", + "type": "str", + "description": "Type of filing.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "filing_url", + "type": "str", + "description": "URL to the filing page.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "report_url", + "type": "str", + "description": "URL to the actual report.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "report_date", + "type": "date", + "description": "The date of the filing.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "act", + "type": "Union[int, str]", + "description": "The SEC Act number.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "items", + "type": "Union[str, float]", + "description": "The SEC Item numbers.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "primary_doc_description", + "type": "str", + "description": "The description of the primary document.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "primary_doc", + "type": "str", + "description": "The filename of the primary document.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "accession_number", + "type": "Union[int, str]", + "description": "The accession number.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "file_number", + "type": "Union[int, str]", + "description": "The file number.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "film_number", + "type": "Union[int, str]", + "description": "The film number.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "is_inline_xbrl", + "type": "Union[int, str]", + "description": "Whether the filing is an inline XBRL filing.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "is_xbrl", + "type": "Union[int, str]", + "description": "Whether the filing is an XBRL filing.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "size", + "type": "Union[int, str]", + "description": "The size of the filing.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "complete_submission_url", + "type": "str", + "description": "The URL to the complete filing submission.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "filing_detail_url", + "type": "str", + "description": "The URL to the filing details.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : HistoricalSplits\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "label", + "type": "str", + "description": "Label of the historical stock splits.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "numerator", + "type": "float", + "description": "Numerator of the historical stock splits.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "denominator", + "type": "float", + "description": "Denominator of the historical stock splits.", + "default": "", + "optional": false, + "standard": true + } + ], + "fmp": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "label", + "type": "str", + "description": "Label of the historical stock splits.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "numerator", + "type": "float", + "description": "Numerator of the historical stock splits.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "denominator", + "type": "float", + "description": "Denominator of the historical stock splits.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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, + "standard": true + }, + { + "name": "year", + "type": "int", + "description": "Year of the earnings call transcript.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "year", + "type": "int", + "description": "Year of the earnings call transcript.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EarningsCallTranscript\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "quarter", + "type": "int", + "description": "Quarter of the earnings call transcript.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "year", + "type": "int", + "description": "Year of the earnings call transcript.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "date", + "type": "datetime", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "content", + "type": "str", + "description": "Content of the earnings call transcript.", + "default": "", + "optional": false, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "quarter", + "type": "int", + "description": "Quarter of the earnings call transcript.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "year", + "type": "int", + "description": "Year of the earnings call transcript.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "date", + "type": "datetime", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "content", + "type": "str", + "description": "Content of the earnings call transcript.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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, + "standard": 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", + "optional": true, + "standard": 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, + "standard": true + } + ], + "tiingo": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": 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", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : TrailingDividendYield\n Serializable results.\n provider : Literal['tiingo']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "trailing_dividend_yield", + "type": "float", + "description": "Trailing dividend yield.", + "default": "", + "optional": false, + "standard": true + } + ], + "tiingo": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "trailing_dividend_yield", + "type": "float", + "description": "Trailing dividend yield.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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, + "standard": true + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "page", + "type": "int", + "description": "Page number of the data to fetch.", + "default": "0", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "page", + "type": "int", + "description": "Page number of the data to fetch.", + "default": "0", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EquityOwnership\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "cik", + "type": "int", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "filing_date", + "type": "date", + "description": "Filing date of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "investor_name", + "type": "str", + "description": "Investor name of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "security_name", + "type": "str", + "description": "Security name of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "type_of_security", + "type": "str", + "description": "Type of security of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "security_cusip", + "type": "str", + "description": "Security cusip of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "shares_type", + "type": "str", + "description": "Shares type of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "put_call_share", + "type": "str", + "description": "Put call share of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "investment_discretion", + "type": "str", + "description": "Investment discretion of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "industry_title", + "type": "str", + "description": "Industry title of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "weight", + "type": "float", + "description": "Weight of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "last_weight", + "type": "float", + "description": "Last weight of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change_in_weight", + "type": "float", + "description": "Change in weight of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change_in_weight_percentage", + "type": "float", + "description": "Change in weight percentage of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "market_value", + "type": "int", + "description": "Market value of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "last_market_value", + "type": "int", + "description": "Last market value of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change_in_market_value", + "type": "int", + "description": "Change in market value of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change_in_market_value_percentage", + "type": "float", + "description": "Change in market value percentage of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "shares_number", + "type": "int", + "description": "Shares number of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "last_shares_number", + "type": "int", + "description": "Last shares number of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change_in_shares_number", + "type": "float", + "description": "Change in shares number of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change_in_shares_number_percentage", + "type": "float", + "description": "Change in shares number percentage of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "quarter_end_price", + "type": "float", + "description": "Quarter end price of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "avg_price_paid", + "type": "float", + "description": "Average price paid of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "is_new", + "type": "bool", + "description": "Is the stock ownership new.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "is_sold_out", + "type": "bool", + "description": "Is the stock ownership sold out.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "ownership", + "type": "float", + "description": "How much is the ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "last_ownership", + "type": "float", + "description": "Last ownership amount.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change_in_ownership", + "type": "float", + "description": "Change in ownership amount.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change_in_ownership_percentage", + "type": "float", + "description": "Change in ownership percentage.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "holding_period", + "type": "int", + "description": "Holding period of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "first_added", + "type": "date", + "description": "First added date of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "performance", + "type": "float", + "description": "Performance of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "performance_percentage", + "type": "float", + "description": "Performance percentage of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "last_performance", + "type": "float", + "description": "Last performance of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change_in_performance", + "type": "float", + "description": "Change in performance of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "is_counted_for_performance", + "type": "bool", + "description": "Is the stock ownership counted for performance.", + "default": "", + "optional": false, + "standard": true + } + ], + "fmp": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "cik", + "type": "int", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "filing_date", + "type": "date", + "description": "Filing date of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "investor_name", + "type": "str", + "description": "Investor name of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "security_name", + "type": "str", + "description": "Security name of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "type_of_security", + "type": "str", + "description": "Type of security of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "security_cusip", + "type": "str", + "description": "Security cusip of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "shares_type", + "type": "str", + "description": "Shares type of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "put_call_share", + "type": "str", + "description": "Put call share of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "investment_discretion", + "type": "str", + "description": "Investment discretion of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "industry_title", + "type": "str", + "description": "Industry title of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "weight", + "type": "float", + "description": "Weight of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "last_weight", + "type": "float", + "description": "Last weight of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change_in_weight", + "type": "float", + "description": "Change in weight of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change_in_weight_percentage", + "type": "float", + "description": "Change in weight percentage of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "market_value", + "type": "int", + "description": "Market value of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "last_market_value", + "type": "int", + "description": "Last market value of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change_in_market_value", + "type": "int", + "description": "Change in market value of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change_in_market_value_percentage", + "type": "float", + "description": "Change in market value percentage of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "shares_number", + "type": "int", + "description": "Shares number of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "last_shares_number", + "type": "int", + "description": "Last shares number of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change_in_shares_number", + "type": "float", + "description": "Change in shares number of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change_in_shares_number_percentage", + "type": "float", + "description": "Change in shares number percentage of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "quarter_end_price", + "type": "float", + "description": "Quarter end price of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "avg_price_paid", + "type": "float", + "description": "Average price paid of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "is_new", + "type": "bool", + "description": "Is the stock ownership new.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "is_sold_out", + "type": "bool", + "description": "Is the stock ownership sold out.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "ownership", + "type": "float", + "description": "How much is the ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "last_ownership", + "type": "float", + "description": "Last ownership amount.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change_in_ownership", + "type": "float", + "description": "Change in ownership amount.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change_in_ownership_percentage", + "type": "float", + "description": "Change in ownership percentage.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "holding_period", + "type": "int", + "description": "Holding period of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "first_added", + "type": "date", + "description": "First added date of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "performance", + "type": "float", + "description": "Performance of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "performance_percentage", + "type": "float", + "description": "Performance percentage of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "last_performance", + "type": "float", + "description": "Last performance of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "change_in_performance", + "type": "float", + "description": "Change in performance of the stock ownership.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "is_counted_for_performance", + "type": "bool", + "description": "Is the stock ownership counted for performance.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + }, + { + "name": "include_current_quarter", + "type": "bool", + "description": "Include current quarter data.", + "default": "False", + "optional": true, + "standard": false + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : InstitutionalOwnership\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "investors_holding", + "type": "int", + "description": "Number of investors holding the stock.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "last_investors_holding", + "type": "int", + "description": "Number of investors holding the stock in the last quarter.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "investors_holding_change", + "type": "int", + "description": "Change in the number of investors holding the stock.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "number_of_13f_shares", + "type": "int", + "description": "Number of 13F shares.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "last_number_of_13f_shares", + "type": "int", + "description": "Number of 13F shares in the last quarter.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "number_of_13f_shares_change", + "type": "int", + "description": "Change in the number of 13F shares.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_invested", + "type": "float", + "description": "Total amount invested.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "last_total_invested", + "type": "float", + "description": "Total amount invested in the last quarter.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "total_invested_change", + "type": "float", + "description": "Change in the total amount invested.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "ownership_percent", + "type": "float", + "description": "Ownership percent.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "last_ownership_percent", + "type": "float", + "description": "Ownership percent in the last quarter.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "ownership_percent_change", + "type": "float", + "description": "Change in the ownership percent.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "new_positions", + "type": "int", + "description": "Number of new positions.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "last_new_positions", + "type": "int", + "description": "Number of new positions in the last quarter.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "new_positions_change", + "type": "int", + "description": "Change in the number of new positions.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "increased_positions", + "type": "int", + "description": "Number of increased positions.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "last_increased_positions", + "type": "int", + "description": "Number of increased positions in the last quarter.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "increased_positions_change", + "type": "int", + "description": "Change in the number of increased positions.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "closed_positions", + "type": "int", + "description": "Number of closed positions.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "last_closed_positions", + "type": "int", + "description": "Number of closed positions in the last quarter.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "closed_positions_change", + "type": "int", + "description": "Change in the number of closed positions.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "reduced_positions", + "type": "int", + "description": "Number of reduced positions.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "last_reduced_positions", + "type": "int", + "description": "Number of reduced positions in the last quarter.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "reduced_positions_change", + "type": "int", + "description": "Change in the number of reduced positions.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "total_calls", + "type": "int", + "description": "Total number of call options contracts traded for Apple Inc. on the specified date.", + "default": "", + "optional": false, + "standard": 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, + "standard": 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, + "standard": false + }, + { + "name": "total_puts", + "type": "int", + "description": "Total number of put options contracts traded for Apple Inc. on the specified date.", + "default": "", + "optional": false, + "standard": 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, + "standard": 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, + "standard": 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, + "standard": false + }, + { + "name": "last_put_call_ratio", + "type": "float", + "description": "Put-call ratio on the previous reporting date.", + "default": "", + "optional": false, + "standard": 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, + "standard": 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, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "500", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "500", + "optional": true, + "standard": 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, + "standard": true + }, + { + "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": "None", + "optional": true, + "standard": false + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "500", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "ownership_type", + "type": "Literal['D', 'I']", + "description": "Type of ownership.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "sort_by", + "type": "Literal['filing_date', 'updated_on']", + "description": "Field to sort by.", + "default": "updated_on", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : InsiderTrading\n Serializable results.\n provider : Literal['fmp', 'intrinio']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "company_cik", + "type": "Union[int, str]", + "description": "CIK number of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "filing_date", + "type": "Union[date, datetime]", + "description": "Filing date of the trade.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "transaction_date", + "type": "date", + "description": "Date of the transaction.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "owner_cik", + "type": "Union[int, str]", + "description": "Reporting individual's CIK.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "owner_name", + "type": "str", + "description": "Name of the reporting individual.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "owner_title", + "type": "str", + "description": "The title held by the reporting individual.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "transaction_type", + "type": "str", + "description": "Type of transaction being reported.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "acquisition_or_disposition", + "type": "str", + "description": "Acquisition or disposition of the shares.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "security_type", + "type": "str", + "description": "The type of security transacted.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "securities_owned", + "type": "float", + "description": "Number of securities owned by the reporting individual.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "securities_transacted", + "type": "float", + "description": "Number of securities transacted by the reporting individual.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "transaction_price", + "type": "float", + "description": "The price of the transaction.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "filing_url", + "type": "str", + "description": "Link to the filing.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "company_cik", + "type": "Union[int, str]", + "description": "CIK number of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "filing_date", + "type": "Union[date, datetime]", + "description": "Filing date of the trade.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "transaction_date", + "type": "date", + "description": "Date of the transaction.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "owner_cik", + "type": "Union[int, str]", + "description": "Reporting individual's CIK.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "owner_name", + "type": "str", + "description": "Name of the reporting individual.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "owner_title", + "type": "str", + "description": "The title held by the reporting individual.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "transaction_type", + "type": "str", + "description": "Type of transaction being reported.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "acquisition_or_disposition", + "type": "str", + "description": "Acquisition or disposition of the shares.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "security_type", + "type": "str", + "description": "The type of security transacted.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "securities_owned", + "type": "float", + "description": "Number of securities owned by the reporting individual.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "securities_transacted", + "type": "float", + "description": "Number of securities transacted by the reporting individual.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "transaction_price", + "type": "float", + "description": "The price of the transaction.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "filing_url", + "type": "str", + "description": "Link to the filing.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "form_type", + "type": "str", + "description": "Form type of the insider trading.", + "default": "", + "optional": false, + "standard": false + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "company_cik", + "type": "Union[int, str]", + "description": "CIK number of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "filing_date", + "type": "Union[date, datetime]", + "description": "Filing date of the trade.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "transaction_date", + "type": "date", + "description": "Date of the transaction.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "owner_cik", + "type": "Union[int, str]", + "description": "Reporting individual's CIK.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "owner_name", + "type": "str", + "description": "Name of the reporting individual.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "owner_title", + "type": "str", + "description": "The title held by the reporting individual.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "transaction_type", + "type": "str", + "description": "Type of transaction being reported.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "acquisition_or_disposition", + "type": "str", + "description": "Acquisition or disposition of the shares.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "security_type", + "type": "str", + "description": "The type of security transacted.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "securities_owned", + "type": "float", + "description": "Number of securities owned by the reporting individual.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "securities_transacted", + "type": "float", + "description": "Number of securities transacted by the reporting individual.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "transaction_price", + "type": "float", + "description": "The price of the transaction.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "filing_url", + "type": "str", + "description": "Link to the filing.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "company_name", + "type": "str", + "description": "Name of the company.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "conversion_exercise_price", + "type": "float", + "description": "Conversion/Exercise price of the shares.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "deemed_execution_date", + "type": "date", + "description": "Deemed execution date of the trade.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "exercise_date", + "type": "date", + "description": "Exercise date of the trade.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "expiration_date", + "type": "date", + "description": "Expiration date of the derivative.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "underlying_security_title", + "type": "str", + "description": "Name of the underlying non-derivative security related to this derivative transaction.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "underlying_shares", + "type": "Union[float, int]", + "description": "Number of underlying shares related to this derivative transaction.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "nature_of_ownership", + "type": "str", + "description": "Nature of ownership of the insider trading.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "director", + "type": "bool", + "description": "Whether the owner is a director.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "officer", + "type": "bool", + "description": "Whether the owner is an officer.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ten_percent_owner", + "type": "bool", + "description": "Whether the owner is a 10% owner.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_relation", + "type": "bool", + "description": "Whether the owner is having another relation.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "derivative_transaction", + "type": "bool", + "description": "Whether the owner is having a derivative transaction.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "report_line_number", + "type": "int", + "description": "Report line number of the insider trading.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : ShareStatistics\n Serializable results.\n provider : Literal['fmp', 'intrinio', 'yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "free_float", + "type": "float", + "description": "Percentage of unrestricted shares of a publicly-traded company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "float_shares", + "type": "float", + "description": "Number of shares available for trading by the general public.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "outstanding_shares", + "type": "float", + "description": "Total number of shares of a publicly-traded company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "source", + "type": "str", + "description": "Source of the received data.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "free_float", + "type": "float", + "description": "Percentage of unrestricted shares of a publicly-traded company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "float_shares", + "type": "float", + "description": "Number of shares available for trading by the general public.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "outstanding_shares", + "type": "float", + "description": "Total number of shares of a publicly-traded company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "source", + "type": "str", + "description": "Source of the received data.", + "default": "None", + "optional": true, + "standard": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "free_float", + "type": "float", + "description": "Percentage of unrestricted shares of a publicly-traded company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "float_shares", + "type": "float", + "description": "Number of shares available for trading by the general public.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "outstanding_shares", + "type": "float", + "description": "Total number of shares of a publicly-traded company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "source", + "type": "str", + "description": "Source of the received data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "adjusted_outstanding_shares", + "type": "float", + "description": "Total number of shares of a publicly-traded company, adjusted for splits.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "public_float", + "type": "float", + "description": "Aggregate market value of the shares of a publicly-traded company.", + "default": "None", + "optional": true, + "standard": false + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "free_float", + "type": "float", + "description": "Percentage of unrestricted shares of a publicly-traded company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "float_shares", + "type": "float", + "description": "Number of shares available for trading by the general public.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "outstanding_shares", + "type": "float", + "description": "Total number of shares of a publicly-traded company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "source", + "type": "str", + "description": "Source of the received data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "implied_shares_outstanding", + "type": "int", + "description": "Implied Shares Outstanding of common equity, assuming the conversion of all convertible subsidiary equity into common.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "short_interest", + "type": "int", + "description": "Number of shares that are reported short.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "short_percent_of_float", + "type": "float", + "description": "Percentage of shares that are reported short, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "days_to_cover", + "type": "float", + "description": "Number of days to repurchase the shares as a ratio of average daily volume", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "short_interest_prev_month", + "type": "int", + "description": "Number of shares that were reported short in the previous month.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "short_interest_prev_date", + "type": "date", + "description": "Date of the previous month's report.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "insider_ownership", + "type": "float", + "description": "Percentage of shares held by insiders, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "institution_ownership", + "type": "float", + "description": "Percentage of shares held by institutions, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "institution_float_ownership", + "type": "float", + "description": "Percentage of float held by institutions, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "institutions_count", + "type": "int", + "description": "Number of institutions holding shares.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "model": "ShareStatistics" + }, + "/equity/ownership/form_13f": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "The 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, + "standard": 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.", + "default": "None", + "optional": true, + "standard": 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, + "standard": 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, + "standard": true + } + ], + "sec": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. A CIK or Symbol can be used.", + "default": "", + "optional": false, + "standard": 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.", + "default": "None", + "optional": true, + "standard": 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, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : Form13FHR\n Serializable results.\n provider : Literal['sec']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end-of-quarter date of the filing.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "issuer", + "type": "str", + "description": "The name of the issuer.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "cusip", + "type": "str", + "description": "The CUSIP of the security.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "asset_class", + "type": "str", + "description": "The title of the asset class for the security.", + "default": "", + "optional": false, + "standard": true + }, + { + "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": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": true + }, + { + "name": "voting_authority_sole", + "type": "int", + "description": "The number of shares for which the Manager exercises sole voting authority (none).", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "voting_authority_shared", + "type": "int", + "description": "The number of shares for which the Manager exercises a defined shared voting authority (none).", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "voting_authority_other", + "type": "int", + "description": "The number of shares for which the Manager exercises other shared voting authority (none).", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "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, + "standard": true + } + ], + "sec": [ + { + "name": "period_ending", + "type": "date", + "description": "The end-of-quarter date of the filing.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "issuer", + "type": "str", + "description": "The name of the issuer.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "cusip", + "type": "str", + "description": "The CUSIP of the security.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "asset_class", + "type": "str", + "description": "The title of the asset class for the security.", + "default": "", + "optional": false, + "standard": true + }, + { + "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": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": true + }, + { + "name": "voting_authority_sole", + "type": "int", + "description": "The number of shares for which the Manager exercises sole voting authority (none).", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "voting_authority_shared", + "type": "int", + "description": "The number of shares for which the Manager exercises a defined shared voting authority (none).", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "voting_authority_other", + "type": "int", + "description": "The number of shares for which the Manager exercises other shared voting authority (none).", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "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, + "standard": true + }, + { + "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, + "standard": 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. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + }, + { + "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, + "standard": false + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EquityQuote\n Serializable results.\n provider : Literal['fmp', 'intrinio', 'yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "asset_type", + "type": "str", + "description": "Type of asset - i.e, stock, ETF, etc.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the company or asset.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "exchange", + "type": "str", + "description": "The name or symbol of the venue where the data is from.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "bid", + "type": "float", + "description": "Price of the top bid order.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": true + }, + { + "name": "bid_exchange", + "type": "str", + "description": "The specific trading venue where the purchase order was placed.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ask", + "type": "float", + "description": "Price of the top ask order.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": true + }, + { + "name": "ask_exchange", + "type": "str", + "description": "The specific trading venue where the sale order was placed.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "quote_conditions", + "type": "Union[str, int, List[str], List[int]]", + "description": "Conditions or condition codes applicable to the quote.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": true + }, + { + "name": "sales_conditions", + "type": "Union[str, int, List[str], List[int]]", + "description": "Conditions or condition codes applicable to the sale.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": true + }, + { + "name": "market_center", + "type": "str", + "description": "The ID of the UTP participant that originated the message.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "participant_timestamp", + "type": "datetime", + "description": "Timestamp for when the quote was generated by the exchange.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "trf_timestamp", + "type": "datetime", + "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "sip_timestamp", + "type": "datetime", + "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_price", + "type": "float", + "description": "Price of the last trade.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_tick", + "type": "str", + "description": "Whether the last sale was an up or down tick.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_size", + "type": "int", + "description": "Size of the last trade.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_timestamp", + "type": "datetime", + "description": "Date and Time when the last price was recorded.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "volume", + "type": "Union[float, int]", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "exchange_volume", + "type": "Union[float, int]", + "description": "Volume of shares exchanged during the trading day on the specific exchange.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "prev_close", + "type": "float", + "description": "The previous close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "Change in price from previous close.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in price as a normalized percentage.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_high", + "type": "float", + "description": "The one year high (52W High).", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_low", + "type": "float", + "description": "The one year low (52W Low).", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "asset_type", + "type": "str", + "description": "Type of asset - i.e, stock, ETF, etc.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the company or asset.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "exchange", + "type": "str", + "description": "The name or symbol of the venue where the data is from.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "bid", + "type": "float", + "description": "Price of the top bid order.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": true + }, + { + "name": "bid_exchange", + "type": "str", + "description": "The specific trading venue where the purchase order was placed.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ask", + "type": "float", + "description": "Price of the top ask order.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": true + }, + { + "name": "ask_exchange", + "type": "str", + "description": "The specific trading venue where the sale order was placed.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "quote_conditions", + "type": "Union[str, int, List[str], List[int]]", + "description": "Conditions or condition codes applicable to the quote.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": true + }, + { + "name": "sales_conditions", + "type": "Union[str, int, List[str], List[int]]", + "description": "Conditions or condition codes applicable to the sale.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": true + }, + { + "name": "market_center", + "type": "str", + "description": "The ID of the UTP participant that originated the message.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "participant_timestamp", + "type": "datetime", + "description": "Timestamp for when the quote was generated by the exchange.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "trf_timestamp", + "type": "datetime", + "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "sip_timestamp", + "type": "datetime", + "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_price", + "type": "float", + "description": "Price of the last trade.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_tick", + "type": "str", + "description": "Whether the last sale was an up or down tick.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_size", + "type": "int", + "description": "Size of the last trade.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_timestamp", + "type": "datetime", + "description": "Date and Time when the last price was recorded.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "volume", + "type": "Union[float, int]", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "exchange_volume", + "type": "Union[float, int]", + "description": "Volume of shares exchanged during the trading day on the specific exchange.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "prev_close", + "type": "float", + "description": "The previous close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "Change in price from previous close.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in price as a normalized percentage.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_high", + "type": "float", + "description": "The one year high (52W High).", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_low", + "type": "float", + "description": "The one year low (52W Low).", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "price_avg50", + "type": "float", + "description": "50 day moving average price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "price_avg200", + "type": "float", + "description": "200 day moving average price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "avg_volume", + "type": "int", + "description": "Average volume over the last 10 trading days.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "market_cap", + "type": "float", + "description": "Market cap of the company.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "shares_outstanding", + "type": "int", + "description": "Number of shares outstanding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "eps", + "type": "float", + "description": "Earnings per share.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "pe", + "type": "float", + "description": "Price earnings ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "earnings_announcement", + "type": "Union[datetime, str]", + "description": "Upcoming earnings announcement date.", + "default": "None", + "optional": true, + "standard": false + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "asset_type", + "type": "str", + "description": "Type of asset - i.e, stock, ETF, etc.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the company or asset.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "exchange", + "type": "str", + "description": "The name or symbol of the venue where the data is from.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "bid", + "type": "float", + "description": "Price of the top bid order.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": true + }, + { + "name": "bid_exchange", + "type": "str", + "description": "The specific trading venue where the purchase order was placed.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ask", + "type": "float", + "description": "Price of the top ask order.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": true + }, + { + "name": "ask_exchange", + "type": "str", + "description": "The specific trading venue where the sale order was placed.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "quote_conditions", + "type": "Union[str, int, List[str], List[int]]", + "description": "Conditions or condition codes applicable to the quote.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": true + }, + { + "name": "sales_conditions", + "type": "Union[str, int, List[str], List[int]]", + "description": "Conditions or condition codes applicable to the sale.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": true + }, + { + "name": "market_center", + "type": "str", + "description": "The ID of the UTP participant that originated the message.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "participant_timestamp", + "type": "datetime", + "description": "Timestamp for when the quote was generated by the exchange.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "trf_timestamp", + "type": "datetime", + "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "sip_timestamp", + "type": "datetime", + "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_price", + "type": "float", + "description": "Price of the last trade.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_tick", + "type": "str", + "description": "Whether the last sale was an up or down tick.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_size", + "type": "int", + "description": "Size of the last trade.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_timestamp", + "type": "datetime", + "description": "Date and Time when the last price was recorded.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "volume", + "type": "Union[float, int]", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "exchange_volume", + "type": "Union[float, int]", + "description": "Volume of shares exchanged during the trading day on the specific exchange.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "prev_close", + "type": "float", + "description": "The previous close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "Change in price from previous close.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in price as a normalized percentage.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_high", + "type": "float", + "description": "The one year high (52W High).", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_low", + "type": "float", + "description": "The one year low (52W Low).", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "is_darkpool", + "type": "bool", + "description": "Whether or not the current trade is from a darkpool.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "source", + "type": "str", + "description": "Source of the Intrinio data.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "updated_on", + "type": "datetime", + "description": "Date and Time when the data was last updated.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "security", + "type": "openbb_intrinio.utils.references.IntrinioSecurity", + "description": "Security details related to the quote.", + "default": "None", + "optional": true, + "standard": false + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "asset_type", + "type": "str", + "description": "Type of asset - i.e, stock, ETF, etc.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the company or asset.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "exchange", + "type": "str", + "description": "The name or symbol of the venue where the data is from.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "bid", + "type": "float", + "description": "Price of the top bid order.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": true + }, + { + "name": "bid_exchange", + "type": "str", + "description": "The specific trading venue where the purchase order was placed.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ask", + "type": "float", + "description": "Price of the top ask order.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": true + }, + { + "name": "ask_exchange", + "type": "str", + "description": "The specific trading venue where the sale order was placed.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "quote_conditions", + "type": "Union[str, int, List[str], List[int]]", + "description": "Conditions or condition codes applicable to the quote.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": true + }, + { + "name": "sales_conditions", + "type": "Union[str, int, List[str], List[int]]", + "description": "Conditions or condition codes applicable to the sale.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": true + }, + { + "name": "market_center", + "type": "str", + "description": "The ID of the UTP participant that originated the message.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "participant_timestamp", + "type": "datetime", + "description": "Timestamp for when the quote was generated by the exchange.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "trf_timestamp", + "type": "datetime", + "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "sip_timestamp", + "type": "datetime", + "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_price", + "type": "float", + "description": "Price of the last trade.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_tick", + "type": "str", + "description": "Whether the last sale was an up or down tick.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_size", + "type": "int", + "description": "Size of the last trade.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_timestamp", + "type": "datetime", + "description": "Date and Time when the last price was recorded.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "volume", + "type": "Union[float, int]", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "exchange_volume", + "type": "Union[float, int]", + "description": "Volume of shares exchanged during the trading day on the specific exchange.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "prev_close", + "type": "float", + "description": "The previous close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "Change in price from previous close.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in price as a normalized percentage.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_high", + "type": "float", + "description": "The one year high (52W High).", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_low", + "type": "float", + "description": "The one year low (52W Low).", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ma_50d", + "type": "float", + "description": "50-day moving average price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ma_200d", + "type": "float", + "description": "200-day moving average price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "volume_average", + "type": "float", + "description": "Average daily trading volume.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "volume_average_10d", + "type": "float", + "description": "Average daily trading volume in the last 10 days.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "currency", + "type": "str", + "description": "Currency of the price.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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, + "standard": true + }, + { + "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, + "standard": true + } + ], + "polygon": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": true + }, + { + "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, + "standard": true + }, + { + "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, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EquityNBBO\n Serializable results.\n provider : Literal['polygon']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "ask_exchange", + "type": "str", + "description": "The exchange ID for the ask.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "ask", + "type": "float", + "description": "The last ask price.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + }, + { + "name": "bid_size", + "type": "int", + "description": "The bid size in round lots.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "bid", + "type": "float", + "description": "The last bid price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "bid_exchange", + "type": "str", + "description": "The exchange ID for the bid.", + "default": "", + "optional": false, + "standard": true + } + ], + "polygon": [ + { + "name": "ask_exchange", + "type": "str", + "description": "The exchange ID for the ask.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "ask", + "type": "float", + "description": "The last ask price.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + }, + { + "name": "bid_size", + "type": "int", + "description": "The bid size in round lots.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "bid", + "type": "float", + "description": "The last bid price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "bid_exchange", + "type": "str", + "description": "The exchange ID for the bid.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "tape", + "type": "str", + "description": "The exchange tape.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "conditions", + "type": "Union[str, List[int], List[str]]", + "description": "A list of condition codes.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "indicators", + "type": "List[int]", + "description": "A list of indicator codes.", + "default": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + } + ] + }, + "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, + "standard": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "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, + "standard": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "intrinio": [ + { + "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, + "standard": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": 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": "None", + "optional": true, + "standard": false + }, + { + "name": "end_time", + "type": "datetime.time", + "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "timezone", + "type": "str", + "description": "Timezone of the data, in the IANA format (Continent/City).", + "default": "America/New_York", + "optional": true, + "standard": false + }, + { + "name": "source", + "type": "Literal['realtime', 'delayed', 'nasdaq_basic']", + "description": "The source of the data.", + "default": "realtime", + "optional": true, + "standard": false + } + ], + "polygon": [ + { + "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, + "standard": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "adjustment", + "type": "Literal['splits_only', 'unadjusted']", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", + "optional": true, + "standard": false + }, + { + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": "False", + "optional": true, + "standard": 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, + "standard": false + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "49999", + "optional": true, + "standard": false + } + ], + "tiingo": [ + { + "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, + "standard": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "yfinance": [ + { + "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, + "standard": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": "False", + "optional": true, + "standard": false + }, + { + "name": "include_actions", + "type": "bool", + "description": "Include dividends and stock splits in results.", + "default": "True", + "optional": true, + "standard": false + }, + { + "name": "adjustment", + "type": "Literal['splits_only', 'splits_and_dividends']", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", + "optional": true, + "standard": false + }, + { + "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, + "standard": false + }, + { + "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, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EquityHistorical\n Serializable results.\n provider : Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "Union[float, int]", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "Union[float, int]", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "unadjusted_volume", + "type": "float", + "description": "Unadjusted volume of the symbol.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change", + "type": "float", + "description": "Change in the price from the previous close.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in the price from the previous close, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + } + ], + "intrinio": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "Union[float, int]", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "average", + "type": "float", + "description": "Average trade price of an individual equity during the interval.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change", + "type": "float", + "description": "Change in the price of the symbol from the previous day.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change_percent", + "type": "float", + "description": "Percent change in the price of the symbol from the previous day.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "adj_open", + "type": "float", + "description": "The adjusted open price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "adj_high", + "type": "float", + "description": "The adjusted high price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "adj_low", + "type": "float", + "description": "The adjusted low price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "adj_volume", + "type": "float", + "description": "The adjusted volume.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "fifty_two_week_high", + "type": "float", + "description": "52 week high price for the symbol.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "fifty_two_week_low", + "type": "float", + "description": "52 week low price for the symbol.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": false + }, + { + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "dividend", + "type": "float", + "description": "Dividend amount, if a dividend was paid.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "close_time", + "type": "datetime", + "description": "The timestamp that represents the end of the interval span.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "interval", + "type": "str", + "description": "The data time frequency.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": false + } + ], + "polygon": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "Union[float, int]", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "transactions", + "type": "int, Gt(gt=0)", + "description": "Number of transactions for the symbol in the time period.", + "default": "None", + "optional": true, + "standard": false + } + ], + "tiingo": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "Union[float, int]", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "adj_open", + "type": "float", + "description": "The adjusted open price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "adj_high", + "type": "float", + "description": "The adjusted high price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "adj_low", + "type": "float", + "description": "The adjusted low price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "adj_volume", + "type": "float", + "description": "The adjusted volume.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "dividend", + "type": "float", + "description": "Dividend amount, if a dividend was paid.", + "default": "None", + "optional": true, + "standard": false + } + ], + "yfinance": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "Union[float, int]", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "dividend", + "type": "float", + "description": "Dividend amount (split-adjusted), if a dividend was paid.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : PricePerformance\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "one_day", + "type": "float", + "description": "One-day return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "wtd", + "type": "float", + "description": "Week to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "one_week", + "type": "float", + "description": "One-week return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "mtd", + "type": "float", + "description": "Month to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "one_month", + "type": "float", + "description": "One-month return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "qtd", + "type": "float", + "description": "Quarter to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "three_month", + "type": "float", + "description": "Three-month return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "six_month", + "type": "float", + "description": "Six-month return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ytd", + "type": "float", + "description": "Year to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "one_year", + "type": "float", + "description": "One-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "three_year", + "type": "float", + "description": "Three-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "five_year", + "type": "float", + "description": "Five-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ten_year", + "type": "float", + "description": "Ten-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "max", + "type": "float", + "description": "Return from the beginning of the time series.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "one_day", + "type": "float", + "description": "One-day return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "wtd", + "type": "float", + "description": "Week to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "one_week", + "type": "float", + "description": "One-week return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "mtd", + "type": "float", + "description": "Month to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "one_month", + "type": "float", + "description": "One-month return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "qtd", + "type": "float", + "description": "Quarter to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "three_month", + "type": "float", + "description": "Three-month return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "six_month", + "type": "float", + "description": "Six-month return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ytd", + "type": "float", + "description": "Year to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "one_year", + "type": "float", + "description": "One-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "three_year", + "type": "float", + "description": "Three-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "five_year", + "type": "float", + "description": "Five-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ten_year", + "type": "float", + "description": "Ten-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "max", + "type": "float", + "description": "Return from the beginning of the time series.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": "", + "optional": false, + "standard": 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, + "standard": 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, + "standard": true + } + ], + "sec": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + }, + { + "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, + "standard": 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, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EquityFTD\n Serializable results.\n provider : Literal['sec']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "settlement_date", + "type": "date", + "description": "The settlement date of the fail.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "cusip", + "type": "str", + "description": "CUSIP of the Security.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "quantity", + "type": "int", + "description": "The number of fails on that settlement date.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "price", + "type": "float", + "description": "The price at the previous closing price from the settlement date.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "description", + "type": "str", + "description": "The description of the Security.", + "default": "None", + "optional": true, + "standard": true + } + ], + "sec": [ + { + "name": "settlement_date", + "type": "date", + "description": "The settlement date of the fail.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "cusip", + "type": "str", + "description": "CUSIP of the Security.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "quantity", + "type": "int", + "description": "The number of fails on that settlement date.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "price", + "type": "float", + "description": "The price at the previous closing price from the settlement date.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "description", + "type": "str", + "description": "The description of the Security.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "is_symbol", + "type": "bool", + "description": "Whether to search by ticker symbol.", + "default": "False", + "optional": true, + "standard": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether to use the cache or not.", + "default": "True", + "optional": true, + "standard": 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, + "standard": true + } + ], + "intrinio": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", + "optional": true, + "standard": true + }, + { + "name": "is_symbol", + "type": "bool", + "description": "Whether to search by ticker symbol.", + "default": "False", + "optional": true, + "standard": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether to use the cache or not.", + "default": "True", + "optional": true, + "standard": 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, + "standard": true + }, + { + "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, + "standard": false + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "10000", + "optional": true, + "standard": false + } + ], + "sec": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", + "optional": true, + "standard": true + }, + { + "name": "is_symbol", + "type": "bool", + "description": "Whether to search by ticker symbol.", + "default": "False", + "optional": true, + "standard": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether to use the cache or not.", + "default": "True", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "is_fund", + "type": "bool", + "description": "Whether to direct the search to the list of mutual funds and ETFs.", + "default": "False", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EquitySearch\n Serializable results.\n provider : Literal['intrinio', 'sec']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the company.", + "default": "", + "optional": false, + "standard": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the company.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "cik", + "type": "str", + "description": "", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "lei", + "type": "str", + "description": "The Legal Entity Identifier (LEI) of the company.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "intrinio_id", + "type": "str", + "description": "The Intrinio ID of the company.", + "default": "", + "optional": false, + "standard": false + } + ], + "sec": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the company.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key", + "default": "", + "optional": false, + "standard": false + } + ] + }, + "model": "EquitySearch" + }, + "/equity/screener": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Screen for companies meeting various criteria. These criteria include\nmarket 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, + "standard": true + } + ], + "fmp": [ + { + "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, + "standard": true + }, + { + "name": "mktcap_min", + "type": "int", + "description": "Filter by market cap greater than this value.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "mktcap_max", + "type": "int", + "description": "Filter by market cap less than this value.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "price_min", + "type": "float", + "description": "Filter by price greater than this value.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "price_max", + "type": "float", + "description": "Filter by price less than this value.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "beta_min", + "type": "float", + "description": "Filter by a beta greater than this value.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "beta_max", + "type": "float", + "description": "Filter by a beta less than this value.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "volume_min", + "type": "int", + "description": "Filter by volume greater than this value.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "volume_max", + "type": "int", + "description": "Filter by volume less than this value.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "dividend_min", + "type": "float", + "description": "Filter by dividend amount greater than this value.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "dividend_max", + "type": "float", + "description": "Filter by dividend amount less than this value.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "is_etf", + "type": "bool", + "description": "If true, returns only ETFs.", + "default": "False", + "optional": true, + "standard": false + }, + { + "name": "is_active", + "type": "bool", + "description": "If false, returns only inactive tickers.", + "default": "True", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": false + }, + { + "name": "industry", + "type": "str", + "description": "Filter by industry.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "country", + "type": "str", + "description": "Filter by country, as a two-letter country code.", + "default": "None", + "optional": true, + "standard": false + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "name": "limit", + "type": "int", + "description": "Limit the number of results to return.", + "default": "50000", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EquityScreener\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the company.", + "default": "", + "optional": false, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the company.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "market_cap", + "type": "int", + "description": "The market cap of ticker.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "sector", + "type": "str", + "description": "The sector the ticker belongs to.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "industry", + "type": "str", + "description": "The industry ticker belongs to.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "beta", + "type": "float", + "description": "The beta of the ETF.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "price", + "type": "float", + "description": "The current price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "last_annual_dividend", + "type": "float", + "description": "The last annual amount dividend paid.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "volume", + "type": "int", + "description": "The current trading volume.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "exchange", + "type": "str", + "description": "The exchange code the asset trades on.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "exchange_name", + "type": "str", + "description": "The full name of the primary exchange.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "country", + "type": "str", + "description": "The two-letter country abbreviation where the head office is located.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "is_etf", + "type": "Literal[True, False]", + "description": "Whether the ticker is an ETF.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "actively_trading", + "type": "Literal[True, False]", + "description": "Whether the ETF is actively trading.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "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, + "standard": 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, + "standard": true + } + ], + "intrinio": [ + { + "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, + "standard": 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, + "standard": true + } + ], + "yfinance": [ + { + "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, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EquityInfo\n Serializable results.\n provider : Literal['fmp', 'intrinio', 'yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Common name of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "cusip", + "type": "str", + "description": "CUSIP identifier for the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "isin", + "type": "str", + "description": "International Securities Identification Number.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "lei", + "type": "str", + "description": "Legal Entity Identifier assigned to the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "legal_name", + "type": "str", + "description": "Official legal name of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "stock_exchange", + "type": "str", + "description": "Stock exchange where the company is traded.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "sic", + "type": "int", + "description": "Standard Industrial Classification code for the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "short_description", + "type": "str", + "description": "Short description of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "long_description", + "type": "str", + "description": "Long description of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ceo", + "type": "str", + "description": "Chief Executive Officer of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "company_url", + "type": "str", + "description": "URL of the company's website.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "business_address", + "type": "str", + "description": "Address of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "mailing_address", + "type": "str", + "description": "Mailing address of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "business_phone_no", + "type": "str", + "description": "Phone number of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_address1", + "type": "str", + "description": "Address of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_address2", + "type": "str", + "description": "Address of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_address_city", + "type": "str", + "description": "City of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_address_postal_code", + "type": "str", + "description": "Zip code of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_state", + "type": "str", + "description": "State of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_country", + "type": "str", + "description": "Country of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "inc_state", + "type": "str", + "description": "State in which the company is incorporated.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "inc_country", + "type": "str", + "description": "Country in which the company is incorporated.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "employees", + "type": "int", + "description": "Number of employees working for the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "entity_legal_form", + "type": "str", + "description": "Legal form of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "entity_status", + "type": "str", + "description": "Status of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "latest_filing_date", + "type": "date", + "description": "Date of the company's latest filing.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "irs_number", + "type": "str", + "description": "IRS number assigned to the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "sector", + "type": "str", + "description": "Sector in which the company operates.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "industry_category", + "type": "str", + "description": "Category of industry in which the company operates.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "industry_group", + "type": "str", + "description": "Group of industry in which the company operates.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "template", + "type": "str", + "description": "Template used to standardize the company's financial statements.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "standardized_active", + "type": "bool", + "description": "Whether the company is active or not.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "first_fundamental_date", + "type": "date", + "description": "Date of the company's first fundamental.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_fundamental_date", + "type": "date", + "description": "Date of the company's last fundamental.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "first_stock_price_date", + "type": "date", + "description": "Date of the company's first stock price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_stock_price_date", + "type": "date", + "description": "Date of the company's last stock price.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Common name of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "cusip", + "type": "str", + "description": "CUSIP identifier for the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "isin", + "type": "str", + "description": "International Securities Identification Number.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "lei", + "type": "str", + "description": "Legal Entity Identifier assigned to the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "legal_name", + "type": "str", + "description": "Official legal name of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "stock_exchange", + "type": "str", + "description": "Stock exchange where the company is traded.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "sic", + "type": "int", + "description": "Standard Industrial Classification code for the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "short_description", + "type": "str", + "description": "Short description of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "long_description", + "type": "str", + "description": "Long description of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ceo", + "type": "str", + "description": "Chief Executive Officer of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "company_url", + "type": "str", + "description": "URL of the company's website.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "business_address", + "type": "str", + "description": "Address of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "mailing_address", + "type": "str", + "description": "Mailing address of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "business_phone_no", + "type": "str", + "description": "Phone number of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_address1", + "type": "str", + "description": "Address of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_address2", + "type": "str", + "description": "Address of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_address_city", + "type": "str", + "description": "City of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_address_postal_code", + "type": "str", + "description": "Zip code of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_state", + "type": "str", + "description": "State of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_country", + "type": "str", + "description": "Country of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "inc_state", + "type": "str", + "description": "State in which the company is incorporated.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "inc_country", + "type": "str", + "description": "Country in which the company is incorporated.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "employees", + "type": "int", + "description": "Number of employees working for the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "entity_legal_form", + "type": "str", + "description": "Legal form of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "entity_status", + "type": "str", + "description": "Status of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "latest_filing_date", + "type": "date", + "description": "Date of the company's latest filing.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "irs_number", + "type": "str", + "description": "IRS number assigned to the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "sector", + "type": "str", + "description": "Sector in which the company operates.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "industry_category", + "type": "str", + "description": "Category of industry in which the company operates.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "industry_group", + "type": "str", + "description": "Group of industry in which the company operates.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "template", + "type": "str", + "description": "Template used to standardize the company's financial statements.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "standardized_active", + "type": "bool", + "description": "Whether the company is active or not.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "first_fundamental_date", + "type": "date", + "description": "Date of the company's first fundamental.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_fundamental_date", + "type": "date", + "description": "Date of the company's last fundamental.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "first_stock_price_date", + "type": "date", + "description": "Date of the company's first stock price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_stock_price_date", + "type": "date", + "description": "Date of the company's last stock price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "is_etf", + "type": "bool", + "description": "If the symbol is an ETF.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "is_actively_trading", + "type": "bool", + "description": "If the company is actively trading.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "is_adr", + "type": "bool", + "description": "If the stock is an ADR.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "is_fund", + "type": "bool", + "description": "If the company is a fund.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "image", + "type": "str", + "description": "Image of the company.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "currency", + "type": "str", + "description": "Currency in which the stock is traded.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "market_cap", + "type": "int", + "description": "Market capitalization of the company.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "last_price", + "type": "float", + "description": "The last traded price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "year_high", + "type": "float", + "description": "The one-year high of the price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "year_low", + "type": "float", + "description": "The one-year low of the price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "volume_avg", + "type": "int", + "description": "Average daily trading volume.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "annualized_dividend_amount", + "type": "float", + "description": "The annualized dividend payment based on the most recent regular dividend payment.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "beta", + "type": "float", + "description": "Beta of the stock relative to the market.", + "default": "None", + "optional": true, + "standard": false + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Common name of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "cusip", + "type": "str", + "description": "CUSIP identifier for the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "isin", + "type": "str", + "description": "International Securities Identification Number.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "lei", + "type": "str", + "description": "Legal Entity Identifier assigned to the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "legal_name", + "type": "str", + "description": "Official legal name of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "stock_exchange", + "type": "str", + "description": "Stock exchange where the company is traded.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "sic", + "type": "int", + "description": "Standard Industrial Classification code for the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "short_description", + "type": "str", + "description": "Short description of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "long_description", + "type": "str", + "description": "Long description of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ceo", + "type": "str", + "description": "Chief Executive Officer of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "company_url", + "type": "str", + "description": "URL of the company's website.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "business_address", + "type": "str", + "description": "Address of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "mailing_address", + "type": "str", + "description": "Mailing address of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "business_phone_no", + "type": "str", + "description": "Phone number of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_address1", + "type": "str", + "description": "Address of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_address2", + "type": "str", + "description": "Address of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_address_city", + "type": "str", + "description": "City of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_address_postal_code", + "type": "str", + "description": "Zip code of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_state", + "type": "str", + "description": "State of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_country", + "type": "str", + "description": "Country of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "inc_state", + "type": "str", + "description": "State in which the company is incorporated.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "inc_country", + "type": "str", + "description": "Country in which the company is incorporated.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "employees", + "type": "int", + "description": "Number of employees working for the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "entity_legal_form", + "type": "str", + "description": "Legal form of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "entity_status", + "type": "str", + "description": "Status of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "latest_filing_date", + "type": "date", + "description": "Date of the company's latest filing.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "irs_number", + "type": "str", + "description": "IRS number assigned to the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "sector", + "type": "str", + "description": "Sector in which the company operates.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "industry_category", + "type": "str", + "description": "Category of industry in which the company operates.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "industry_group", + "type": "str", + "description": "Group of industry in which the company operates.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "template", + "type": "str", + "description": "Template used to standardize the company's financial statements.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "standardized_active", + "type": "bool", + "description": "Whether the company is active or not.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "first_fundamental_date", + "type": "date", + "description": "Date of the company's first fundamental.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_fundamental_date", + "type": "date", + "description": "Date of the company's last fundamental.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "first_stock_price_date", + "type": "date", + "description": "Date of the company's first stock price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_stock_price_date", + "type": "date", + "description": "Date of the company's last stock price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "id", + "type": "str", + "description": "Intrinio ID for the company.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "thea_enabled", + "type": "bool", + "description": "Whether the company has been enabled for Thea.", + "default": "None", + "optional": true, + "standard": false + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Common name of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "cusip", + "type": "str", + "description": "CUSIP identifier for the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "isin", + "type": "str", + "description": "International Securities Identification Number.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "lei", + "type": "str", + "description": "Legal Entity Identifier assigned to the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "legal_name", + "type": "str", + "description": "Official legal name of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "stock_exchange", + "type": "str", + "description": "Stock exchange where the company is traded.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "sic", + "type": "int", + "description": "Standard Industrial Classification code for the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "short_description", + "type": "str", + "description": "Short description of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "long_description", + "type": "str", + "description": "Long description of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ceo", + "type": "str", + "description": "Chief Executive Officer of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "company_url", + "type": "str", + "description": "URL of the company's website.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "business_address", + "type": "str", + "description": "Address of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "mailing_address", + "type": "str", + "description": "Mailing address of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "business_phone_no", + "type": "str", + "description": "Phone number of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_address1", + "type": "str", + "description": "Address of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_address2", + "type": "str", + "description": "Address of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_address_city", + "type": "str", + "description": "City of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_address_postal_code", + "type": "str", + "description": "Zip code of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_state", + "type": "str", + "description": "State of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "hq_country", + "type": "str", + "description": "Country of the company's headquarters.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "inc_state", + "type": "str", + "description": "State in which the company is incorporated.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "inc_country", + "type": "str", + "description": "Country in which the company is incorporated.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "employees", + "type": "int", + "description": "Number of employees working for the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "entity_legal_form", + "type": "str", + "description": "Legal form of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "entity_status", + "type": "str", + "description": "Status of the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "latest_filing_date", + "type": "date", + "description": "Date of the company's latest filing.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "irs_number", + "type": "str", + "description": "IRS number assigned to the company.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "sector", + "type": "str", + "description": "Sector in which the company operates.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "industry_category", + "type": "str", + "description": "Category of industry in which the company operates.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "industry_group", + "type": "str", + "description": "Group of industry in which the company operates.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "template", + "type": "str", + "description": "Template used to standardize the company's financial statements.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "standardized_active", + "type": "bool", + "description": "Whether the company is active or not.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "first_fundamental_date", + "type": "date", + "description": "Date of the company's first fundamental.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_fundamental_date", + "type": "date", + "description": "Date of the company's last fundamental.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "first_stock_price_date", + "type": "date", + "description": "Date of the company's first stock price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_stock_price_date", + "type": "date", + "description": "Date of the company's last stock price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "exchange_timezone", + "type": "str", + "description": "The timezone of the exchange.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "issue_type", + "type": "str", + "description": "The issuance type of the asset.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "currency", + "type": "str", + "description": "The currency in which the asset is traded.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "market_cap", + "type": "int", + "description": "The market capitalization of the asset.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "shares_outstanding", + "type": "int", + "description": "The number of listed shares outstanding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "shares_float", + "type": "int", + "description": "The number of shares in the public float.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "shares_implied_outstanding", + "type": "int", + "description": "Implied shares outstanding of common equityassuming the conversion of all convertible subsidiary equity into common.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "shares_short", + "type": "int", + "description": "The reported number of shares short.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "dividend_yield", + "type": "float", + "description": "The dividend yield of the asset, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "beta", + "type": "float", + "description": "The beta of the asset relative to the broad market.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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', '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, + "standard": true + } + ], + "fmp": [ + { + "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, + "standard": true + }, + { + "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, + "standard": false + } + ], + "polygon": [ + { + "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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : MarketSnapshots\n Serializable results.\n provider : Literal['fmp', 'polygon']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "prev_close", + "type": "float", + "description": "The previous close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "The change in price from the previous close.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "change_percent", + "type": "float", + "description": "The change in price from the previous close, as a normalized percent.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "prev_close", + "type": "float", + "description": "The previous close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "The change in price from the previous close.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "change_percent", + "type": "float", + "description": "The change in price from the previous close, as a normalized percent.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "last_price", + "type": "float", + "description": "The last price of the stock.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "last_price_timestamp", + "type": "Union[date, datetime]", + "description": "The timestamp of the last price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ma50", + "type": "float", + "description": "The 50-day moving average.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ma200", + "type": "float", + "description": "The 200-day moving average.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "year_high", + "type": "float", + "description": "The 52-week high.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "year_low", + "type": "float", + "description": "The 52-week low.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "volume_avg", + "type": "int", + "description": "Average daily trading volume.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "market_cap", + "type": "int", + "description": "Market cap of the stock.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "eps", + "type": "float", + "description": "Earnings per share.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "pe", + "type": "float", + "description": "Price to earnings ratio.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "shares_outstanding", + "type": "int", + "description": "Number of shares outstanding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "name", + "type": "str", + "description": "The company name associated with the symbol.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "exchange", + "type": "str", + "description": "The exchange of the stock.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "earnings_date", + "type": "Union[date, datetime]", + "description": "The upcoming earnings announcement date.", + "default": "None", + "optional": true, + "standard": false + } + ], + "polygon": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "prev_close", + "type": "float", + "description": "The previous close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "change", + "type": "float", + "description": "The change in price from the previous close.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "change_percent", + "type": "float", + "description": "The change in price from the previous close, as a normalized percent.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vwap", + "type": "float", + "description": "The volume weighted average price of the stock on the current trading day.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "prev_open", + "type": "float", + "description": "The previous trading session opening price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "prev_high", + "type": "float", + "description": "The previous trading session high price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "prev_low", + "type": "float", + "description": "The previous trading session low price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "prev_volume", + "type": "float", + "description": "The previous trading session volume.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "prev_vwap", + "type": "float", + "description": "The previous trading session VWAP.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "last_updated", + "type": "datetime", + "description": "The last time the data was updated.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "bid", + "type": "float", + "description": "The current bid price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "bid_size", + "type": "int", + "description": "The current bid size.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ask_size", + "type": "int", + "description": "The current ask size.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ask", + "type": "float", + "description": "The current ask price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "quote_timestamp", + "type": "datetime", + "description": "The timestamp of the last quote.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "last_trade_price", + "type": "float", + "description": "The last trade price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "last_trade_size", + "type": "int", + "description": "The last trade size.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "last_trade_conditions", + "type": "List[int]", + "description": "The last trade condition codes.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "last_trade_exchange", + "type": "int", + "description": "The last trade exchange ID code.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "last_trade_timestamp", + "type": "datetime", + "description": "The last trade timestamp.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "exchange", + "type": "Literal['AMEX', 'NYSE', 'NASDAQ', 'ETF', 'TSX', 'EURONEXT']", + "description": "The exchange code the ETF trades on.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "is_active", + "type": "Literal[True, False]", + "description": "Whether the ETF is actively trading.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EtfSearch\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.(ETF)", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the ETF.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.(ETF)", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the ETF.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "market_cap", + "type": "float", + "description": "The market cap of the ETF.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "sector", + "type": "str", + "description": "The sector of the ETF.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "industry", + "type": "str", + "description": "The industry of the ETF.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "beta", + "type": "float", + "description": "The beta of the ETF.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "price", + "type": "float", + "description": "The current price of the ETF.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "last_annual_dividend", + "type": "float", + "description": "The last annual dividend paid.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "volume", + "type": "float", + "description": "The current trading volume of the ETF.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "exchange", + "type": "str", + "description": "The exchange code the ETF trades on.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "exchange_name", + "type": "str", + "description": "The full name of the exchange the ETF trades on.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "country", + "type": "str", + "description": "The country the ETF is registered in.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "actively_trading", + "type": "Literal[True, False]", + "description": "Whether the ETF is actively trading.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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, + "standard": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "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, + "standard": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "intrinio": [ + { + "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, + "standard": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": 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": "None", + "optional": true, + "standard": false + }, + { + "name": "end_time", + "type": "datetime.time", + "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "timezone", + "type": "str", + "description": "Timezone of the data, in the IANA format (Continent/City).", + "default": "America/New_York", + "optional": true, + "standard": false + }, + { + "name": "source", + "type": "Literal['realtime', 'delayed', 'nasdaq_basic']", + "description": "The source of the data.", + "default": "realtime", + "optional": true, + "standard": false + } + ], + "polygon": [ + { + "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, + "standard": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "adjustment", + "type": "Literal['splits_only', 'unadjusted']", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", + "optional": true, + "standard": false + }, + { + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": "False", + "optional": true, + "standard": 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, + "standard": false + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "49999", + "optional": true, + "standard": false + } + ], + "tiingo": [ + { + "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, + "standard": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "yfinance": [ + { + "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, + "standard": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": "False", + "optional": true, + "standard": false + }, + { + "name": "include_actions", + "type": "bool", + "description": "Include dividends and stock splits in results.", + "default": "True", + "optional": true, + "standard": false + }, + { + "name": "adjustment", + "type": "Literal['splits_only', 'splits_and_dividends']", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", + "optional": true, + "standard": false + }, + { + "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, + "standard": false + }, + { + "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, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EtfHistorical\n Serializable results.\n provider : Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "Union[float, int]", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "Union[float, int]", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "unadjusted_volume", + "type": "float", + "description": "Unadjusted volume of the symbol.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change", + "type": "float", + "description": "Change in the price from the previous close.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in the price from the previous close, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + } + ], + "intrinio": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "Union[float, int]", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "average", + "type": "float", + "description": "Average trade price of an individual equity during the interval.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change", + "type": "float", + "description": "Change in the price of the symbol from the previous day.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change_percent", + "type": "float", + "description": "Percent change in the price of the symbol from the previous day.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "adj_open", + "type": "float", + "description": "The adjusted open price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "adj_high", + "type": "float", + "description": "The adjusted high price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "adj_low", + "type": "float", + "description": "The adjusted low price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "adj_volume", + "type": "float", + "description": "The adjusted volume.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "fifty_two_week_high", + "type": "float", + "description": "52 week high price for the symbol.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "fifty_two_week_low", + "type": "float", + "description": "52 week low price for the symbol.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": false + }, + { + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "dividend", + "type": "float", + "description": "Dividend amount, if a dividend was paid.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "close_time", + "type": "datetime", + "description": "The timestamp that represents the end of the interval span.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "interval", + "type": "str", + "description": "The data time frequency.", + "default": "None", + "optional": true, + "standard": 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": "None", + "optional": true, + "standard": false + } + ], + "polygon": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "Union[float, int]", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "transactions", + "type": "int, Gt(gt=0)", + "description": "Number of transactions for the symbol in the time period.", + "default": "None", + "optional": true, + "standard": false + } + ], + "tiingo": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "Union[float, int]", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "adj_open", + "type": "float", + "description": "The adjusted open price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "adj_high", + "type": "float", + "description": "The adjusted high price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "adj_low", + "type": "float", + "description": "The adjusted low price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "adj_volume", + "type": "float", + "description": "The adjusted volume.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "dividend", + "type": "float", + "description": "Dividend amount, if a dividend was paid.", + "default": "None", + "optional": true, + "standard": false + } + ], + "yfinance": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "volume", + "type": "Union[float, int]", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "dividend", + "type": "float", + "description": "Dividend amount (split-adjusted), if a dividend was paid.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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, yfinance.", + "default": "", + "optional": false, + "standard": true + }, + { + "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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, yfinance.", + "default": "", + "optional": false, + "standard": true + }, + { + "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, + "standard": true + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, yfinance.", + "default": "", + "optional": false, + "standard": true + }, + { + "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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EtfInfo\n Serializable results.\n provider : Literal['fmp', 'yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. (ETF)", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the ETF.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "description", + "type": "str", + "description": "Description of the fund.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "inception_date", + "type": "str", + "description": "Inception date of the ETF.", + "default": "", + "optional": false, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. (ETF)", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the ETF.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "description", + "type": "str", + "description": "Description of the fund.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "inception_date", + "type": "str", + "description": "Inception date of the ETF.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "issuer", + "type": "str", + "description": "Company of the ETF.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cusip", + "type": "str", + "description": "CUSIP of the ETF.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "isin", + "type": "str", + "description": "ISIN of the ETF.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "domicile", + "type": "str", + "description": "Domicile of the ETF.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "asset_class", + "type": "str", + "description": "Asset class of the ETF.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "aum", + "type": "float", + "description": "Assets under management.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "nav", + "type": "float", + "description": "Net asset value of the ETF.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "nav_currency", + "type": "str", + "description": "Currency of the ETF's net asset value.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "expense_ratio", + "type": "float", + "description": "The expense ratio, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "holdings_count", + "type": "int", + "description": "Number of holdings.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "avg_volume", + "type": "float", + "description": "Average daily trading volume.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "website", + "type": "str", + "description": "Website of the issuer.", + "default": "None", + "optional": true, + "standard": false + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. (ETF)", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the ETF.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "description", + "type": "str", + "description": "Description of the fund.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "inception_date", + "type": "str", + "description": "Inception date of the ETF.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "fund_type", + "type": "str", + "description": "The legal type of fund.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "fund_family", + "type": "str", + "description": "The fund family.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "category", + "type": "str", + "description": "The fund category.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "exchange", + "type": "str", + "description": "The exchange the fund is listed on.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "exchange_timezone", + "type": "str", + "description": "The timezone of the exchange.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "currency", + "type": "str", + "description": "The currency in which the fund is listed.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "nav_price", + "type": "float", + "description": "The net asset value per unit of the fund.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "total_assets", + "type": "int", + "description": "The total value of assets held by the fund.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "trailing_pe", + "type": "float", + "description": "The trailing twelve month P/E ratio of the fund's assets.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "dividend_yield", + "type": "float", + "description": "The dividend yield of the fund, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "dividend_rate_ttm", + "type": "float", + "description": "The trailing twelve month annual dividend rate of the fund, in currency units.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "dividend_yield_ttm", + "type": "float", + "description": "The trailing twelve month annual dividend yield of the fund, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "year_high", + "type": "float", + "description": "The fifty-two week high price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "year_low", + "type": "float", + "description": "The fifty-two week low price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ma_50d", + "type": "float", + "description": "50-day moving average price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ma_200d", + "type": "float", + "description": "200-day moving average price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "return_ytd", + "type": "float", + "description": "The year-to-date return of the fund, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "return_3y_avg", + "type": "float", + "description": "The three year average return of the fund, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "return_5y_avg", + "type": "float", + "description": "The five year average return of the fund, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "beta_3y_avg", + "type": "float", + "description": "The three year average beta of the fund.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "volume_avg", + "type": "float", + "description": "The average daily trading volume of the fund.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "volume_avg_10d", + "type": "float", + "description": "The average daily trading volume of the fund over the past ten days.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "bid", + "type": "float", + "description": "The current bid price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "bid_size", + "type": "float", + "description": "The current bid size.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ask", + "type": "float", + "description": "The current ask price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "ask_size", + "type": "float", + "description": "The current ask size.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "open", + "type": "float", + "description": "The open price of the most recent trading session.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "high", + "type": "float", + "description": "The highest price of the most recent trading session.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "low", + "type": "float", + "description": "The lowest price of the most recent trading session.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume of the most recent trading session.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "prev_close", + "type": "float", + "description": "The previous closing price.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EtfSectors\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "sector", + "type": "str", + "description": "Sector of exposure.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "weight", + "type": "float", + "description": "Exposure of the ETF to the sector in normalized percentage points.", + "default": "", + "optional": false, + "standard": true + } + ], + "fmp": [ + { + "name": "sector", + "type": "str", + "description": "Sector of exposure.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "weight", + "type": "float", + "description": "Exposure of the ETF to the sector in normalized percentage points.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EtfCountries\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "country", + "type": "str", + "description": "The country of the exposure. Corresponding values are normalized percentage points.", + "default": "", + "optional": false, + "standard": true + } + ], + "fmp": [ + { + "name": "country", + "type": "str", + "description": "The country of the exposure. Corresponding values are normalized percentage points.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "model": "EtfCountries" + }, + "/etf/price_performance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Price performance as a return, over different periods. This is a proxy for `equity.price.performance`.", + "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.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : PricePerformance\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "one_day", + "type": "float", + "description": "One-day return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "wtd", + "type": "float", + "description": "Week to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "one_week", + "type": "float", + "description": "One-week return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "mtd", + "type": "float", + "description": "Month to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "one_month", + "type": "float", + "description": "One-month return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "qtd", + "type": "float", + "description": "Quarter to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "three_month", + "type": "float", + "description": "Three-month return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "six_month", + "type": "float", + "description": "Six-month return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ytd", + "type": "float", + "description": "Year to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "one_year", + "type": "float", + "description": "One-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "three_year", + "type": "float", + "description": "Three-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "five_year", + "type": "float", + "description": "Five-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ten_year", + "type": "float", + "description": "Ten-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "max", + "type": "float", + "description": "Return from the beginning of the time series.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "one_day", + "type": "float", + "description": "One-day return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "wtd", + "type": "float", + "description": "Week to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "one_week", + "type": "float", + "description": "One-week return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "mtd", + "type": "float", + "description": "Month to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "one_month", + "type": "float", + "description": "One-month return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "qtd", + "type": "float", + "description": "Quarter to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "three_month", + "type": "float", + "description": "Three-month return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "six_month", + "type": "float", + "description": "Six-month return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ytd", + "type": "float", + "description": "Year to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "one_year", + "type": "float", + "description": "One-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "three_year", + "type": "float", + "description": "Three-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "five_year", + "type": "float", + "description": "Five-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ten_year", + "type": "float", + "description": "Ten-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "max", + "type": "float", + "description": "Return from the beginning of the time series.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": "", + "optional": false, + "standard": false + } + ] + }, + "model": "PricePerformance" + }, + "/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, + "standard": true + }, + { + "name": "provider", + "type": "Literal['fmp', '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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "provider", + "type": "Literal['fmp', '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, + "standard": true + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "name": "cik", + "type": "str", + "description": "The CIK of the filing entity. Overrides symbol.", + "default": "None", + "optional": true, + "standard": false + } + ], + "sec": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "provider", + "type": "Literal['fmp', '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, + "standard": true + }, + { + "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": "None", + "optional": true, + "standard": false + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache for the request.", + "default": "True", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EtfHoldings\n Serializable results.\n provider : Literal['fmp', 'sec']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. (ETF)", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the ETF holding.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. (ETF)", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the ETF holding.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "lei", + "type": "str", + "description": "The LEI of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "title", + "type": "str", + "description": "The title of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cusip", + "type": "str", + "description": "The CUSIP of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "isin", + "type": "str", + "description": "The ISIN of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "balance", + "type": "int", + "description": "The balance of the holding, in shares or units.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "units", + "type": "Union[str, float]", + "description": "The type of units.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "currency", + "type": "str", + "description": "The currency of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "value", + "type": "float", + "description": "The value of the holding, in dollars.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "weight", + "type": "float", + "description": "The weight of the holding, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "payoff_profile", + "type": "str", + "description": "The payoff profile of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "asset_category", + "type": "str", + "description": "The asset category of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "issuer_category", + "type": "str", + "description": "The issuer category of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "country", + "type": "str", + "description": "The country of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "is_restricted", + "type": "str", + "description": "Whether the holding is restricted.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "fair_value_level", + "type": "int", + "description": "The fair value level of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "is_cash_collateral", + "type": "str", + "description": "Whether the holding is cash collateral.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "is_non_cash_collateral", + "type": "str", + "description": "Whether the holding is non-cash collateral.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "is_loan_by_fund", + "type": "str", + "description": "Whether the holding is loan by fund.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cik", + "type": "str", + "description": "The CIK of the filing.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "acceptance_datetime", + "type": "str", + "description": "The acceptance datetime of the filing.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "updated", + "type": "Union[date, datetime]", + "description": "The date the data was updated.", + "default": "None", + "optional": true, + "standard": false + } + ], + "sec": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. (ETF)", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the ETF holding.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "lei", + "type": "str", + "description": "The LEI of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cusip", + "type": "str", + "description": "The CUSIP of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "isin", + "type": "str", + "description": "The ISIN of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "other_id", + "type": "str", + "description": "Internal identifier for the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "balance", + "type": "float", + "description": "The balance of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "weight", + "type": "float", + "description": "The weight of the holding in ETF in %.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "value", + "type": "float", + "description": "The value of the holding in USD.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "payoff_profile", + "type": "str", + "description": "The payoff profile of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "units", + "type": "Union[str, float]", + "description": "The units of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "currency", + "type": "str", + "description": "The currency of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "asset_category", + "type": "str", + "description": "The asset category of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "issuer_category", + "type": "str", + "description": "The issuer category of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "country", + "type": "str", + "description": "The country of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "is_restricted", + "type": "str", + "description": "Whether the holding is restricted.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "fair_value_level", + "type": "int", + "description": "The fair value level of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "is_cash_collateral", + "type": "str", + "description": "Whether the holding is cash collateral.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "is_non_cash_collateral", + "type": "str", + "description": "Whether the holding is non-cash collateral.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "is_loan_by_fund", + "type": "str", + "description": "Whether the holding is loan by fund.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "loan_value", + "type": "float", + "description": "The loan value of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "issuer_conditional", + "type": "str", + "description": "The issuer conditions of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "asset_conditional", + "type": "str", + "description": "The asset conditions of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "maturity_date", + "type": "date", + "description": "The maturity date of the debt security.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "coupon_kind", + "type": "str", + "description": "The type of coupon for the debt security.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "rate_type", + "type": "str", + "description": "The type of rate for the debt security, floating or fixed.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "annualized_return", + "type": "float", + "description": "The annualized return on the debt security.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "is_default", + "type": "str", + "description": "If the debt security is defaulted.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "in_arrears", + "type": "str", + "description": "If the debt security is in arrears.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "is_paid_kind", + "type": "str", + "description": "If the debt security payments are paid in kind.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "derivative_category", + "type": "str", + "description": "The derivative category of the holding.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "counterparty", + "type": "str", + "description": "The counterparty of the derivative.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "underlying_name", + "type": "str", + "description": "The name of the underlying asset associated with the derivative.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "option_type", + "type": "str", + "description": "The type of option.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "derivative_payoff", + "type": "str", + "description": "The payoff profile of the derivative.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "expiry_date", + "type": "date", + "description": "The expiry or termination date of the derivative.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "exercise_price", + "type": "float", + "description": "The exercise price of the option.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "exercise_currency", + "type": "str", + "description": "The currency of the option exercise price.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "shares_per_contract", + "type": "float", + "description": "The number of shares per contract.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "delta", + "type": "Union[str, float]", + "description": "The delta of the option.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "rate_type_rec", + "type": "str", + "description": "The type of rate for reveivable portion of the swap.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "receive_currency", + "type": "str", + "description": "The receive currency of the swap.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "upfront_receive", + "type": "float", + "description": "The upfront amount received of the swap.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "floating_rate_index_rec", + "type": "str", + "description": "The floating rate index for reveivable portion of the swap.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "floating_rate_spread_rec", + "type": "float", + "description": "The floating rate spread for reveivable portion of the swap.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "rate_tenor_rec", + "type": "str", + "description": "The rate tenor for reveivable portion of the swap.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "rate_tenor_unit_rec", + "type": "Union[int, str]", + "description": "The rate tenor unit for reveivable portion of the swap.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "reset_date_rec", + "type": "str", + "description": "The reset date for reveivable portion of the swap.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "reset_date_unit_rec", + "type": "Union[int, str]", + "description": "The reset date unit for reveivable portion of the swap.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "rate_type_pmnt", + "type": "str", + "description": "The type of rate for payment portion of the swap.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "payment_currency", + "type": "str", + "description": "The payment currency of the swap.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "upfront_payment", + "type": "float", + "description": "The upfront amount received of the swap.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "floating_rate_index_pmnt", + "type": "str", + "description": "The floating rate index for payment portion of the swap.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "floating_rate_spread_pmnt", + "type": "float", + "description": "The floating rate spread for payment portion of the swap.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "rate_tenor_pmnt", + "type": "str", + "description": "The rate tenor for payment portion of the swap.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "rate_tenor_unit_pmnt", + "type": "Union[int, str]", + "description": "The rate tenor unit for payment portion of the swap.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "reset_date_pmnt", + "type": "str", + "description": "The reset date for payment portion of the swap.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "reset_date_unit_pmnt", + "type": "Union[int, str]", + "description": "The reset date unit for payment portion of the swap.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "repo_type", + "type": "str", + "description": "The type of repo.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "is_cleared", + "type": "str", + "description": "If the repo is cleared.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "is_tri_party", + "type": "str", + "description": "If the repo is tri party.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "principal_amount", + "type": "float", + "description": "The principal amount of the repo.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "principal_currency", + "type": "str", + "description": "The currency of the principal amount.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "collateral_type", + "type": "str", + "description": "The collateral type of the repo.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "collateral_amount", + "type": "float", + "description": "The collateral amount of the repo.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "collateral_currency", + "type": "str", + "description": "The currency of the collateral amount.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "exchange_currency", + "type": "str", + "description": "The currency of the exchange rate.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "exchange_rate", + "type": "float", + "description": "The exchange rate.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "currency_sold", + "type": "str", + "description": "The currency sold in a Forward Derivative.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "currency_amount_sold", + "type": "float", + "description": "The amount of currency sold in a Forward Derivative.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "currency_bought", + "type": "str", + "description": "The currency bought in a Forward Derivative.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "currency_amount_bought", + "type": "float", + "description": "The amount of currency bought in a Forward Derivative.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "notional_amount", + "type": "float", + "description": "The notional amount of the derivative.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "notional_currency", + "type": "str", + "description": "The currency of the derivative's notional amount.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "unrealized_gain", + "type": "float", + "description": "The unrealized gain or loss on the derivative.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false, + "standard": 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, + "standard": true + }, + { + "name": "cik", + "type": "str", + "description": "The CIK of the filing entity. Overrides symbol.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EtfHoldingsDate\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + } + ], + "fmp": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "model": "EtfHoldingsDate" + }, + "/etf/holdings_performance": { + "deprecated": { + "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", + "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, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EtfHoldingsPerformance\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "one_day", + "type": "float", + "description": "One-day return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "wtd", + "type": "float", + "description": "Week to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "one_week", + "type": "float", + "description": "One-week return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "mtd", + "type": "float", + "description": "Month to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "one_month", + "type": "float", + "description": "One-month return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "qtd", + "type": "float", + "description": "Quarter to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "three_month", + "type": "float", + "description": "Three-month return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "six_month", + "type": "float", + "description": "Six-month return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ytd", + "type": "float", + "description": "Year to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "one_year", + "type": "float", + "description": "One-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "three_year", + "type": "float", + "description": "Three-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "five_year", + "type": "float", + "description": "Five-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ten_year", + "type": "float", + "description": "Ten-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "max", + "type": "float", + "description": "Return from the beginning of the time series.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "one_day", + "type": "float", + "description": "One-day return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "wtd", + "type": "float", + "description": "Week to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "one_week", + "type": "float", + "description": "One-week return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "mtd", + "type": "float", + "description": "Month to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "one_month", + "type": "float", + "description": "One-month return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "qtd", + "type": "float", + "description": "Quarter to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "three_month", + "type": "float", + "description": "Three-month return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "six_month", + "type": "float", + "description": "Six-month return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ytd", + "type": "float", + "description": "Year to date return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "one_year", + "type": "float", + "description": "One-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "three_year", + "type": "float", + "description": "Three-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "five_year", + "type": "float", + "description": "Five-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "ten_year", + "type": "float", + "description": "Ten-year return.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "max", + "type": "float", + "description": "Return from the beginning of the time series.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": "", + "optional": false, + "standard": 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, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EtfEquityExposure\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "equity_symbol", + "type": "str", + "description": "The symbol of the equity requested.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "etf_symbol", + "type": "str", + "description": "The symbol of the ETF with exposure to the requested equity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "shares", + "type": "int", + "description": "The number of shares held in the ETF.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "weight", + "type": "float", + "description": "The weight of the equity in the ETF, as a normalized percent.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "market_value", + "type": "Union[float, int]", + "description": "The market value of the equity position in the ETF.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "equity_symbol", + "type": "str", + "description": "The symbol of the equity requested.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "etf_symbol", + "type": "str", + "description": "The symbol of the ETF with exposure to the requested equity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "shares", + "type": "int", + "description": "The number of shares held in the ETF.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "weight", + "type": "float", + "description": "The weight of the equity in the ETF, as a normalized percent.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "market_value", + "type": "Union[float, int]", + "description": "The market value of the equity position in the ETF.", + "default": "None", + "optional": true, + "standard": true + } + ] + }, + "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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fred": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "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, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : AMERIBOR\n Serializable results.\n provider : Literal['fred']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "AMERIBOR rate.", + "default": "", + "optional": false, + "standard": true + } + ], + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "AMERIBOR rate.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fred": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "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, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : SONIA\n Serializable results.\n provider : Literal['fred']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "SONIA rate.", + "default": "", + "optional": false, + "standard": true + } + ], + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "SONIA rate.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fred": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : IORB\n Serializable results.\n provider : Literal['fred']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "IORB rate.", + "default": "", + "optional": false, + "standard": true + } + ], + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "IORB rate.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "federal_reserve": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fred": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "parameter", + "type": "Literal['monthly', 'daily', 'weekly', 'daily_excl_weekend', 'annual', 'biweekly', 'volume']", + "description": "Period of FED rate.", + "default": "weekly", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : FEDFUNDS\n Serializable results.\n provider : Literal['federal_reserve', 'fred']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "FED rate.", + "default": "", + "optional": false, + "standard": true + } + ], + "federal_reserve": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "FED rate.", + "default": "", + "optional": false, + "standard": true + } + ], + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "FED rate.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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, + "standard": true + } + ], + "fred": [ + { + "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, + "standard": true + }, + { + "name": "long_run", + "type": "bool", + "description": "Flag to show long run projections", + "default": "False", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : PROJECTIONS\n Serializable results.\n provider : Literal['fred']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "range_high", + "type": "float", + "description": "High projection of rates.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "central_tendency_high", + "type": "float", + "description": "Central tendency of high projection of rates.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "median", + "type": "float", + "description": "Median projection of rates.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "range_midpoint", + "type": "float", + "description": "Midpoint projection of rates.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "central_tendency_midpoint", + "type": "float", + "description": "Central tendency of midpoint projection of rates.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "range_low", + "type": "float", + "description": "Low projection of rates.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "central_tendency_low", + "type": "float", + "description": "Central tendency of low projection of rates.", + "default": "", + "optional": false, + "standard": true + } + ], + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "range_high", + "type": "float", + "description": "High projection of rates.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "central_tendency_high", + "type": "float", + "description": "Central tendency of high projection of rates.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "median", + "type": "float", + "description": "Median projection of rates.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "range_midpoint", + "type": "float", + "description": "Midpoint projection of rates.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "central_tendency_midpoint", + "type": "float", + "description": "Central tendency of midpoint projection of rates.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "range_low", + "type": "float", + "description": "Low projection of rates.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "central_tendency_low", + "type": "float", + "description": "Central tendency of low projection of rates.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fred": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "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, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : ESTR\n Serializable results.\n provider : Literal['fred']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "ESTR rate.", + "default": "", + "optional": false, + "standard": true + } + ], + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "ESTR rate.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "interest_rate_type", + "type": "Literal['deposit', 'lending', 'refinancing']", + "description": "The type of interest rate.", + "default": "lending", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fred": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "interest_rate_type", + "type": "Literal['deposit', 'lending', 'refinancing']", + "description": "The type of interest rate.", + "default": "lending", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : EuropeanCentralBankInterestRates\n Serializable results.\n provider : Literal['fred']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "European Central Bank Interest Rate.", + "default": "", + "optional": false, + "standard": true + } + ], + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "European Central Bank Interest Rate.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fred": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "parameter", + "type": "Literal['daily_excl_weekend', 'monthly', 'weekly', 'daily', 'annual']", + "description": "FRED series ID of DWPCR data.", + "default": "daily_excl_weekend", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : DiscountWindowPrimaryCreditRate\n Serializable results.\n provider : Literal['fred']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "Discount Window Primary Credit Rate.", + "default": "", + "optional": false, + "standard": true + } + ], + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "Discount Window Primary Credit Rate.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "maturity", + "type": "Literal['3m', '2y']", + "description": "The maturity", + "default": "3m", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fred": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "maturity", + "type": "Literal['3m', '2y']", + "description": "The maturity", + "default": "3m", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : TreasuryConstantMaturity\n Serializable results.\n provider : Literal['fred']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "TreasuryConstantMaturity Rate.", + "default": "", + "optional": false, + "standard": true + } + ], + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "TreasuryConstantMaturity Rate.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "maturity", + "type": "Literal['10y', '5y', '1y', '6m', '3m']", + "description": "The maturity", + "default": "10y", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fred": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "maturity", + "type": "Literal['10y', '5y', '1y', '6m', '3m']", + "description": "The maturity", + "default": "10y", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : SelectedTreasuryConstantMaturity\n Serializable results.\n provider : Literal['fred']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "Selected Treasury Constant Maturity Rate.", + "default": "", + "optional": false, + "standard": true + } + ], + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "Selected Treasury Constant Maturity Rate.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "maturity", + "type": "Literal['3m', '6m']", + "description": "The maturity", + "default": "3m", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fred": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "maturity", + "type": "Literal['3m', '6m']", + "description": "The maturity", + "default": "3m", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : SelectedTreasuryBill\n Serializable results.\n provider : Literal['fred']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "SelectedTreasuryBill Rate.", + "default": "", + "optional": false, + "standard": true + } + ], + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "SelectedTreasuryBill Rate.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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": "None", + "optional": true, + "standard": true + }, + { + "name": "inflation_adjusted", + "type": "bool", + "description": "Get inflation adjusted rates.", + "default": "False", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fred": [ + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for. Defaults to the most recent FRED entry.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "inflation_adjusted", + "type": "bool", + "description": "Get inflation adjusted rates.", + "default": "False", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : USYieldCurve\n Serializable results.\n provider : Literal['fred']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "maturity", + "type": "float", + "description": "Maturity of the treasury rate in years.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "Associated rate given in decimal form (0.05 is 5%)", + "default": "", + "optional": false, + "standard": true + } + ], + "fred": [ + { + "name": "maturity", + "type": "float", + "description": "Maturity of the treasury rate in years.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "Associated rate given in decimal form (0.05 is 5%)", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "federal_reserve": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : TreasuryRates\n Serializable results.\n provider : Literal['federal_reserve', 'fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "week_4", + "type": "float", + "description": "4 week Treasury bills rate (secondary market).", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "month_1", + "type": "float", + "description": "1 month Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "month_2", + "type": "float", + "description": "2 month Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "month_3", + "type": "float", + "description": "3 month Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "month_6", + "type": "float", + "description": "6 month Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_1", + "type": "float", + "description": "1 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_2", + "type": "float", + "description": "2 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_3", + "type": "float", + "description": "3 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_5", + "type": "float", + "description": "5 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_7", + "type": "float", + "description": "7 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_10", + "type": "float", + "description": "10 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_20", + "type": "float", + "description": "20 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_30", + "type": "float", + "description": "30 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + } + ], + "federal_reserve": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "week_4", + "type": "float", + "description": "4 week Treasury bills rate (secondary market).", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "month_1", + "type": "float", + "description": "1 month Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "month_2", + "type": "float", + "description": "2 month Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "month_3", + "type": "float", + "description": "3 month Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "month_6", + "type": "float", + "description": "6 month Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_1", + "type": "float", + "description": "1 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_2", + "type": "float", + "description": "2 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_3", + "type": "float", + "description": "3 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_5", + "type": "float", + "description": "5 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_7", + "type": "float", + "description": "7 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_10", + "type": "float", + "description": "10 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_20", + "type": "float", + "description": "20 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_30", + "type": "float", + "description": "30 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "week_4", + "type": "float", + "description": "4 week Treasury bills rate (secondary market).", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "month_1", + "type": "float", + "description": "1 month Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "month_2", + "type": "float", + "description": "2 month Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "month_3", + "type": "float", + "description": "3 month Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "month_6", + "type": "float", + "description": "6 month Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_1", + "type": "float", + "description": "1 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_2", + "type": "float", + "description": "2 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_3", + "type": "float", + "description": "3 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_5", + "type": "float", + "description": "5 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_7", + "type": "float", + "description": "7 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_10", + "type": "float", + "description": "10 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_20", + "type": "float", + "description": "20 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "year_30", + "type": "float", + "description": "30 year Treasury rate.", + "default": "None", + "optional": true, + "standard": true + } + ] + }, + "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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "index_type", + "type": "Literal['yield', 'yield_to_worst', 'total_return', 'spread']", + "description": "The type of series.", + "default": "yield", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fred": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "index_type", + "type": "Literal['yield', 'yield_to_worst', 'total_return', 'spread']", + "description": "The type of series.", + "default": "yield", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "category", + "type": "Literal['all', 'duration', 'eur', 'usd']", + "description": "The type of category.", + "default": "all", + "optional": true, + "standard": false + }, + { + "name": "area", + "type": "Literal['asia', 'emea', 'eu', 'ex_g10', 'latin_america', 'us']", + "description": "The type of area.", + "default": "us", + "optional": true, + "standard": false + }, + { + "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, + "standard": false + }, + { + "name": "options", + "type": "bool", + "description": "Whether to include options in the results.", + "default": "False", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : ICEBofA\n Serializable results.\n provider : Literal['fred']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "ICE BofA US Corporate Bond Indices Rate.", + "default": "", + "optional": false, + "standard": true + } + ], + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "ICE BofA US Corporate Bond Indices Rate.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "index_type", + "type": "Literal['aaa', 'baa']", + "description": "The type of series.", + "default": "aaa", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fred": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "index_type", + "type": "Literal['aaa', 'baa']", + "description": "The type of series.", + "default": "aaa", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "spread", + "type": "Literal['treasury', 'fed_funds']", + "description": "The type of spread.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : MoodyCorporateBondIndex\n Serializable results.\n provider : Literal['fred']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "Moody Corporate Bond Index Rate.", + "default": "", + "optional": false, + "standard": true + } + ], + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "Moody Corporate Bond Index Rate.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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": "None", + "optional": true, + "standard": true + }, + { + "name": "yield_curve", + "type": "Literal['spot', 'par']", + "description": "The yield curve type.", + "default": "spot", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fred": [ + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "yield_curve", + "type": "Literal['spot', 'par']", + "description": "The yield curve type.", + "default": "spot", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : HighQualityMarketCorporateBond\n Serializable results.\n provider : Literal['fred']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "HighQualityMarketCorporateBond Rate.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "maturity", + "type": "str", + "description": "Maturity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "yield_curve", + "type": "Literal['spot', 'par']", + "description": "The yield curve type.", + "default": "", + "optional": false, + "standard": true + } + ], + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "HighQualityMarketCorporateBond Rate.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "maturity", + "type": "str", + "description": "Maturity.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "yield_curve", + "type": "Literal['spot', 'par']", + "description": "The yield curve type.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "series_id", + "type": "str", + "description": "FRED series id.", + "default": "", + "optional": false, + "standard": 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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": 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, + "standard": 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, + "standard": true + } + ], + "fred": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": 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, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : SpotRate\n Serializable results.\n provider : Literal['fred']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "Spot Rate.", + "default": "", + "optional": false, + "standard": true + } + ], + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "Spot Rate.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "maturity", + "type": "Literal['overnight', '7d', '15d', '30d', '60d', '90d']", + "description": "The maturity.", + "default": "30d", + "optional": true, + "standard": true + }, + { + "name": "category", + "type": "Literal['asset_backed', 'financial', 'nonfinancial']", + "description": "The category.", + "default": "financial", + "optional": true, + "standard": true + }, + { + "name": "grade", + "type": "Literal['aa', 'a2_p2']", + "description": "The grade.", + "default": "aa", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fred": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "maturity", + "type": "Literal['overnight', '7d', '15d', '30d', '60d', '90d']", + "description": "The maturity.", + "default": "30d", + "optional": true, + "standard": true + }, + { + "name": "category", + "type": "Literal['asset_backed', 'financial', 'nonfinancial']", + "description": "The category.", + "default": "financial", + "optional": true, + "standard": true + }, + { + "name": "grade", + "type": "Literal['aa', 'a2_p2']", + "description": "The grade.", + "default": "aa", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : CommercialPaper\n Serializable results.\n provider : Literal['fred']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "Commercial Paper Rate.", + "default": "", + "optional": false, + "standard": true + } + ], + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "Commercial Paper Rate.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fred": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "period", + "type": "Literal['overnight', '30_day', '90_day', '180_day', 'index']", + "description": "Period of SOFR rate.", + "default": "overnight", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : SOFR\n Serializable results.\n provider : Literal['fred']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "SOFR rate.", + "default": "", + "optional": false, + "standard": true + } + ], + "fred": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "rate", + "type": "float", + "description": "SOFR rate.", + "default": "", + "optional": false, + "standard": true + } + ] + }, + "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": 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, + "standard": true + } + ], + "intrinio": [ + { + "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "10000", + "optional": true, + "standard": false + } + ], + "polygon": [ + { + "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": 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, + "standard": 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, + "standard": false + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "49999", + "optional": true, + "standard": false + } + ], + "yfinance": [ + { + "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : IndexHistorical\n Serializable results.\n provider : Literal['fmp', 'intrinio', 'polygon', 'yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float, Strict(strict=True)", + "description": "The open price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "high", + "type": "float, Strict(strict=True)", + "description": "The high price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "low", + "type": "float, Strict(strict=True)", + "description": "The low price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close", + "type": "float, Strict(strict=True)", + "description": "The close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float, Strict(strict=True)", + "description": "The open price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "high", + "type": "float, Strict(strict=True)", + "description": "The high price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "low", + "type": "float, Strict(strict=True)", + "description": "The low price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close", + "type": "float, Strict(strict=True)", + "description": "The close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change", + "type": "float", + "description": "Change in the price from the previous close.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in the price from the previous close, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + } + ], + "intrinio": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float, Strict(strict=True)", + "description": "The open price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "high", + "type": "float, Strict(strict=True)", + "description": "The high price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "low", + "type": "float, Strict(strict=True)", + "description": "The low price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close", + "type": "float, Strict(strict=True)", + "description": "The close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + } + ], + "polygon": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float, Strict(strict=True)", + "description": "The open price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "high", + "type": "float, Strict(strict=True)", + "description": "The high price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "low", + "type": "float, Strict(strict=True)", + "description": "The low price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close", + "type": "float, Strict(strict=True)", + "description": "The close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "transactions", + "type": "int, Gt(gt=0)", + "description": "Number of transactions for the symbol in the time period.", + "default": "None", + "optional": true, + "standard": false + } + ], + "yfinance": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float, Strict(strict=True)", + "description": "The open price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "high", + "type": "float, Strict(strict=True)", + "description": "The high price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "low", + "type": "float, Strict(strict=True)", + "description": "The low price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close", + "type": "float, Strict(strict=True)", + "description": "The close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + } + ] + }, + "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": "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": 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, + "standard": true + } + ], + "intrinio": [ + { + "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "10000", + "optional": true, + "standard": false + } + ], + "polygon": [ + { + "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": 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, + "standard": 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, + "standard": false + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": "49999", + "optional": true, + "standard": false + } + ], + "yfinance": [ + { + "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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : MarketIndices\n Serializable results.\n provider : Literal['fmp', 'intrinio', 'polygon', 'yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float, Strict(strict=True)", + "description": "The open price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "high", + "type": "float, Strict(strict=True)", + "description": "The high price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "low", + "type": "float, Strict(strict=True)", + "description": "The low price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close", + "type": "float, Strict(strict=True)", + "description": "The close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float, Strict(strict=True)", + "description": "The open price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "high", + "type": "float, Strict(strict=True)", + "description": "The high price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "low", + "type": "float, Strict(strict=True)", + "description": "The low price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close", + "type": "float, Strict(strict=True)", + "description": "The close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change", + "type": "float", + "description": "Change in the price from the previous close.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in the price from the previous close, as a normalized percent.", + "default": "None", + "optional": true, + "standard": false + } + ], + "intrinio": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float, Strict(strict=True)", + "description": "The open price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "high", + "type": "float, Strict(strict=True)", + "description": "The high price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "low", + "type": "float, Strict(strict=True)", + "description": "The low price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close", + "type": "float, Strict(strict=True)", + "description": "The close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + } + ], + "polygon": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float, Strict(strict=True)", + "description": "The open price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "high", + "type": "float, Strict(strict=True)", + "description": "The high price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "low", + "type": "float, Strict(strict=True)", + "description": "The low price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close", + "type": "float, Strict(strict=True)", + "description": "The close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "transactions", + "type": "int, Gt(gt=0)", + "description": "Number of transactions for the symbol in the time period.", + "default": "None", + "optional": true, + "standard": false + } + ], + "yfinance": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "open", + "type": "float, Strict(strict=True)", + "description": "The open price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "high", + "type": "float, Strict(strict=True)", + "description": "The high price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "low", + "type": "float, Strict(strict=True)", + "description": "The low price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "close", + "type": "float, Strict(strict=True)", + "description": "The close price.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": "None", + "optional": true, + "standard": true + } + ] + }, + "model": "MarketIndices" + }, + "/index/constituents": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "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, + "standard": 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, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : IndexConstituents\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the constituent company in the index.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the constituent company in the index.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "sector", + "type": "str", + "description": "Sector the constituent company in the index belongs to.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "sub_sector", + "type": "str", + "description": "Sub-sector the constituent company in the index belongs to.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "headquarter", + "type": "str", + "description": "Location of the headquarter of the constituent company in the index.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "date_first_added", + "type": "Union[str, date]", + "description": "Date the constituent company was added to the index.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cik", + "type": "int", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "founded", + "type": "Union[str, date]", + "description": "Founding year of the constituent company in the index.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "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, + "standard": true + } + ], + "fmp": [ + { + "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, + "standard": true + } + ], + "yfinance": [ + { + "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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : AvailableIndices\n Serializable results.\n provider : Literal['fmp', 'yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "name", + "type": "str", + "description": "Name of the index.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency the index is traded in.", + "default": "None", + "optional": true, + "standard": true + } + ], + "fmp": [ + { + "name": "name", + "type": "str", + "description": "Name of the index.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency the index is traded in.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "stock_exchange", + "type": "str", + "description": "Stock exchange where the index is listed.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "exchange_short_name", + "type": "str", + "description": "Short name of the stock exchange where the index is listed.", + "default": "", + "optional": false, + "standard": false + } + ], + "yfinance": [ + { + "name": "name", + "type": "str", + "description": "Name of the index.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency the index is traded in.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "code", + "type": "str", + "description": "ID code for keying the index in the OpenBB Terminal.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol for the index.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "benzinga": [ + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return. The number of articles to return.", + "default": "2500", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "display", + "type": "Literal['headline', 'abstract', 'full']", + "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full).", + "default": "full", + "optional": true, + "standard": false + }, + { + "name": "updated_since", + "type": "int", + "description": "Number of seconds since the news was updated.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "published_since", + "type": "int", + "description": "Number of seconds since the news was published.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "sort", + "type": "Literal['id', 'created', 'updated']", + "description": "Key to sort the news by.", + "default": "created", + "optional": true, + "standard": false + }, + { + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order to sort the news by.", + "default": "desc", + "optional": true, + "standard": false + }, + { + "name": "isin", + "type": "str", + "description": "The ISIN of the news to retrieve.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cusip", + "type": "str", + "description": "The CUSIP of the news to retrieve.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "channels", + "type": "str", + "description": "Channels of the news to retrieve.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "topics", + "type": "str", + "description": "Topics of the news to retrieve.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "authors", + "type": "str", + "description": "Authors of the news to retrieve.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "content_types", + "type": "str", + "description": "Content types of the news to retrieve.", + "default": "None", + "optional": true, + "standard": false + } + ], + "fmp": [ + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return. The number of articles to return.", + "default": "2500", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "intrinio": [ + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return. The number of articles to return.", + "default": "2500", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + } + ], + "tiingo": [ + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return. The number of articles to return.", + "default": "2500", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "offset", + "type": "int", + "description": "Page offset, used in conjunction with limit.", + "default": "0", + "optional": true, + "standard": false + }, + { + "name": "source", + "type": "str", + "description": "A comma-separated list of the domains requested.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : WorldNews\n Serializable results.\n provider : Literal['benzinga', 'fmp', 'intrinio', 'tiingo']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "datetime", + "description": "The date of the data. The published date of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "title", + "type": "str", + "description": "Title of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "images", + "type": "List[Dict[str, str]]", + "description": "Images associated with the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "text", + "type": "str", + "description": "Text/body of the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "url", + "type": "str", + "description": "URL to the article.", + "default": "None", + "optional": true, + "standard": true + } + ], + "benzinga": [ + { + "name": "date", + "type": "datetime", + "description": "The date of the data. The published date of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "title", + "type": "str", + "description": "Title of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "images", + "type": "List[Dict[str, str]]", + "description": "Images associated with the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "text", + "type": "str", + "description": "Text/body of the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "url", + "type": "str", + "description": "URL to the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "id", + "type": "str", + "description": "Article ID.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "author", + "type": "str", + "description": "Author of the news.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "teaser", + "type": "str", + "description": "Teaser of the news.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "channels", + "type": "str", + "description": "Channels associated with the news.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "stocks", + "type": "str", + "description": "Stocks associated with the news.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "tags", + "type": "str", + "description": "Tags associated with the news.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "updated", + "type": "datetime", + "description": "Updated date of the news.", + "default": "None", + "optional": true, + "standard": false + } + ], + "fmp": [ + { + "name": "date", + "type": "datetime", + "description": "The date of the data. The published date of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "title", + "type": "str", + "description": "Title of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "images", + "type": "List[Dict[str, str]]", + "description": "Images associated with the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "text", + "type": "str", + "description": "Text/body of the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "url", + "type": "str", + "description": "URL to the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "site", + "type": "str", + "description": "News source.", + "default": "", + "optional": false, + "standard": false + } + ], + "intrinio": [ + { + "name": "date", + "type": "datetime", + "description": "The date of the data. The published date of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "title", + "type": "str", + "description": "Title of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "images", + "type": "List[Dict[str, str]]", + "description": "Images associated with the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "text", + "type": "str", + "description": "Text/body of the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "url", + "type": "str", + "description": "URL to the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "id", + "type": "str", + "description": "Article ID.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "company", + "type": "Dict[str, Any]", + "description": "Company details related to the news article.", + "default": "", + "optional": false, + "standard": false + } + ], + "tiingo": [ + { + "name": "date", + "type": "datetime", + "description": "The date of the data. The published date of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "title", + "type": "str", + "description": "Title of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "images", + "type": "List[Dict[str, str]]", + "description": "Images associated with the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "text", + "type": "str", + "description": "Text/body of the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "url", + "type": "str", + "description": "URL to the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "symbols", + "type": "str", + "description": "Ticker tagged in the fetched news.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "article_id", + "type": "int", + "description": "Unique ID of the news article.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "site", + "type": "str", + "description": "News source.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "tags", + "type": "str", + "description": "Tags associated with the news article.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "crawl_date", + "type": "datetime", + "description": "Date the news article was crawled.", + "default": "", + "optional": false, + "standard": 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. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, yfinance.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int, Ge(ge=0)", + "description": "The number of data entries to return.", + "default": "2500", + "optional": true, + "standard": 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, + "standard": true + } + ], + "benzinga": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, yfinance.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int, Ge(ge=0)", + "description": "The number of data entries to return.", + "default": "2500", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "display", + "type": "Literal['headline', 'abstract', 'full']", + "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full).", + "default": "full", + "optional": true, + "standard": false + }, + { + "name": "updated_since", + "type": "int", + "description": "Number of seconds since the news was updated.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "published_since", + "type": "int", + "description": "Number of seconds since the news was published.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "sort", + "type": "Literal['id', 'created', 'updated']", + "description": "Key to sort the news by.", + "default": "created", + "optional": true, + "standard": false + }, + { + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order to sort the news by.", + "default": "desc", + "optional": true, + "standard": false + }, + { + "name": "isin", + "type": "str", + "description": "The company's ISIN.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cusip", + "type": "str", + "description": "The company's CUSIP.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "channels", + "type": "str", + "description": "Channels of the news to retrieve.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "topics", + "type": "str", + "description": "Topics of the news to retrieve.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "authors", + "type": "str", + "description": "Authors of the news to retrieve.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "content_types", + "type": "str", + "description": "Content types of the news to retrieve.", + "default": "None", + "optional": true, + "standard": false + } + ], + "fmp": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, yfinance.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int, Ge(ge=0)", + "description": "The number of data entries to return.", + "default": "2500", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "page", + "type": "int", + "description": "Page number of the results. Use in combination with limit.", + "default": "0", + "optional": true, + "standard": false + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, yfinance.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int, Ge(ge=0)", + "description": "The number of data entries to return.", + "default": "2500", + "optional": true, + "standard": 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, + "standard": true + } + ], + "polygon": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, yfinance.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int, Ge(ge=0)", + "description": "The number of data entries to return.", + "default": "2500", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Sort order of the articles.", + "default": "desc", + "optional": true, + "standard": false + } + ], + "tiingo": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, yfinance.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int, Ge(ge=0)", + "description": "The number of data entries to return.", + "default": "2500", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "offset", + "type": "int", + "description": "Page offset, used in conjunction with limit.", + "default": "0", + "optional": true, + "standard": false + }, + { + "name": "source", + "type": "str", + "description": "A comma-separated list of the domains requested.", + "default": "None", + "optional": true, + "standard": false + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, yfinance.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "limit", + "type": "int, Ge(ge=0)", + "description": "The number of data entries to return.", + "default": "2500", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : CompanyNews\n Serializable results.\n provider : Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "date", + "type": "datetime", + "description": "The date of the data. Here it is the published date of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "title", + "type": "str", + "description": "Title of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "text", + "type": "str", + "description": "Text/body of the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "images", + "type": "List[Dict[str, str]]", + "description": "Images associated with the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "url", + "type": "str", + "description": "URL to the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "symbols", + "type": "str", + "description": "Symbols associated with the article.", + "default": "None", + "optional": true, + "standard": true + } + ], + "benzinga": [ + { + "name": "date", + "type": "datetime", + "description": "The date of the data. Here it is the published date of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "title", + "type": "str", + "description": "Title of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "text", + "type": "str", + "description": "Text/body of the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "images", + "type": "List[Dict[str, str]]", + "description": "Images associated with the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "url", + "type": "str", + "description": "URL to the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "symbols", + "type": "str", + "description": "Symbols associated with the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "id", + "type": "str", + "description": "Article ID.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "author", + "type": "str", + "description": "Author of the article.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "teaser", + "type": "str", + "description": "Teaser of the news.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "channels", + "type": "str", + "description": "Channels associated with the news.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "stocks", + "type": "str", + "description": "Stocks associated with the news.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "tags", + "type": "str", + "description": "Tags associated with the news.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "updated", + "type": "datetime", + "description": "Updated date of the news.", + "default": "None", + "optional": true, + "standard": false + } + ], + "fmp": [ + { + "name": "date", + "type": "datetime", + "description": "The date of the data. Here it is the published date of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "title", + "type": "str", + "description": "Title of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "text", + "type": "str", + "description": "Text/body of the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "images", + "type": "List[Dict[str, str]]", + "description": "Images associated with the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "url", + "type": "str", + "description": "URL to the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "symbols", + "type": "str", + "description": "Symbols associated with the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "source", + "type": "str", + "description": "Name of the news source.", + "default": "", + "optional": false, + "standard": false + } + ], + "intrinio": [ + { + "name": "date", + "type": "datetime", + "description": "The date of the data. Here it is the published date of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "title", + "type": "str", + "description": "Title of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "text", + "type": "str", + "description": "Text/body of the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "images", + "type": "List[Dict[str, str]]", + "description": "Images associated with the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "url", + "type": "str", + "description": "URL to the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "symbols", + "type": "str", + "description": "Symbols associated with the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "id", + "type": "str", + "description": "Article ID.", + "default": "", + "optional": false, + "standard": false + } + ], + "polygon": [ + { + "name": "date", + "type": "datetime", + "description": "The date of the data. Here it is the published date of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "title", + "type": "str", + "description": "Title of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "text", + "type": "str", + "description": "Text/body of the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "images", + "type": "List[Dict[str, str]]", + "description": "Images associated with the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "url", + "type": "str", + "description": "URL to the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "symbols", + "type": "str", + "description": "Symbols associated with the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "source", + "type": "str", + "description": "Source of the article.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "tags", + "type": "str", + "description": "Keywords/tags in the article", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "id", + "type": "str", + "description": "Article ID.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "amp_url", + "type": "str", + "description": "AMP URL.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "publisher", + "type": "openbb_polygon.models.company_news.PolygonPublisher", + "description": "Publisher of the article.", + "default": "", + "optional": false, + "standard": false + } + ], + "tiingo": [ + { + "name": "date", + "type": "datetime", + "description": "The date of the data. Here it is the published date of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "title", + "type": "str", + "description": "Title of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "text", + "type": "str", + "description": "Text/body of the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "images", + "type": "List[Dict[str, str]]", + "description": "Images associated with the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "url", + "type": "str", + "description": "URL to the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "symbols", + "type": "str", + "description": "Symbols associated with the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "tags", + "type": "str", + "description": "Tags associated with the news article.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "article_id", + "type": "int", + "description": "Unique ID of the news article.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "source", + "type": "str", + "description": "News source.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "crawl_date", + "type": "datetime", + "description": "Date the news article was crawled.", + "default": "", + "optional": false, + "standard": false + } + ], + "yfinance": [ + { + "name": "date", + "type": "datetime", + "description": "The date of the data. Here it is the published date of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "title", + "type": "str", + "description": "Title of the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "text", + "type": "str", + "description": "Text/body of the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "images", + "type": "List[Dict[str, str]]", + "description": "Images associated with the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "url", + "type": "str", + "description": "URL to the article.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "symbols", + "type": "str", + "description": "Symbols associated with the article.", + "default": "None", + "optional": true, + "standard": true + }, + { + "name": "source", + "type": "str", + "description": "Source of the news article", + "default": "", + "optional": false, + "standard": 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, + "standard": 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, + "standard": true + } + ], + "sec": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : CikMap\n Serializable results.\n provider : Literal['sec']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [ + { + "name": "cik", + "type": "Union[int, str]", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "None", + "optional": true, + "standard": true + } + ], + "sec": [ + { + "name": "cik", + "type": "Union[int, str]", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "None", + "optional": true, + "standard": true + } + ] + }, + "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, + "standard": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache. If True, cache will store for seven days.", + "default": "True", + "optional": true, + "standard": 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, + "standard": true + } + ], + "sec": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", + "optional": true, + "standard": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache. If True, cache will store for seven days.", + "default": "True", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : InstitutionsSearch\n Serializable results.\n provider : Literal['sec']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [], + "sec": [ + { + "name": "name", + "type": "str", + "description": "The name of the institution.", + "default": "None", + "optional": true, + "standard": false + }, + { + "name": "cik", + "type": "Union[int, str]", + "description": "Central Index Key (CIK)", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "model": "InstitutionsSearch" + }, + "/regulators/sec/schema_files": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "A 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, + "standard": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache. If True, cache will store for seven days.", + "default": "True", + "optional": true, + "standard": 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, + "standard": true + } + ], + "sec": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", + "optional": true, + "standard": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache. If True, cache will store for seven days.", + "default": "True", + "optional": true, + "standard": 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, + "standard": true + }, + { + "name": "url", + "type": "str", + "description": "Enter an optional URL path to fetch the next level.", + "default": "None", + "optional": true, + "standard": false + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : SchemaFiles\n Serializable results.\n provider : Literal['sec']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [], + "sec": [ + { + "name": "files", + "type": "List[str]", + "description": "Dictionary of URLs to SEC Schema Files", + "default": "", + "optional": false, + "standard": 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, + "standard": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache. If True, cache will store for seven days.", + "default": "True", + "optional": true, + "standard": 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, + "standard": true + } + ], + "sec": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", + "optional": false, + "standard": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache. If True, cache will store for seven days.", + "default": "True", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : SymbolMap\n Serializable results.\n provider : Literal['sec']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [], + "sec": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false, + "standard": false + } + ] + }, + "model": "SymbolMap" + }, + "/regulators/sec/rss_litigation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "The RSS feed 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, + "standard": true + } + ], + "sec": [ + { + "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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : RssLitigation\n Serializable results.\n provider : Literal['sec']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [], + "sec": [ + { + "name": "published", + "type": "datetime", + "description": "The date of publication.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "title", + "type": "str", + "description": "The title of the release.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "summary", + "type": "str", + "description": "Short summary of the release.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "id", + "type": "str", + "description": "The identifier associated with the release.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "link", + "type": "str", + "description": "URL to the release.", + "default": "", + "optional": false, + "standard": 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, + "standard": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache. If True, cache will store for seven days.", + "default": "True", + "optional": true, + "standard": 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, + "standard": true + } + ], + "sec": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", + "optional": true, + "standard": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache. If True, cache will store for seven days.", + "default": "True", + "optional": true, + "standard": 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, + "standard": true + } + ] + }, + "returns": { + "OBBject": "OBBject\n results : SicSearch\n Serializable results.\n provider : Literal['sec']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n" + }, + "data": { + "standard": [], + "sec": [ + { + "name": "sic", + "type": "int", + "description": "Sector Industrial Code (SIC)", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "industry", + "type": "str", + "description": "Industry title.", + "default": "", + "optional": false, + "standard": false + }, + { + "name": "office", + "type": "str", + "description": "Reporting office within the Corporate Finance Office", + "default": "", + "optional": false, + "standard": false + } + ] + }, + "model": "SicSearch" + } +} \ No newline at end of file diff --git a/website/generate_platform_v4_markdown.py b/website/generate_platform_v4_markdown.py index f50a509e6a8b..173699d9df3e 100644 --- a/website/generate_platform_v4_markdown.py +++ b/website/generate_platform_v4_markdown.py @@ -1,20 +1,17 @@ """Platform V4 Markdown Generator Script.""" -# pylint: disable=too-many-lines - -import inspect +import argparse import json import re import shutil +import subprocess from pathlib import Path -from typing import Any, Callable, Dict, List, Optional +from typing import Dict, List, Union -from openbb_core.app.model.example import Example -from openbb_core.app.provider_interface import ProviderInterface -from openbb_core.app.router import RouterLoader -from openbb_core.app.static.package_builder import DocstringGenerator, MethodDefinition +import toml +from openbb_core.app.static.utils.console import Console from openbb_core.provider import standard_models -from pydantic_core import PydanticUndefined +from packaging import specifiers # Number of spaces to substitute tabs for indentation TAB_WIDTH = 4 @@ -22,6 +19,10 @@ # Maximum number of commands to display on the cards MAX_COMMANDS = 8 +# Path to the Platform directory and the reference.json file +PLATFORM_PATH = Path(__file__).parent.parent / "openbb_platform" +REFERENCE_FILE_PATH = Path(PLATFORM_PATH / "openbb/assets/reference.json") + # Paths to use for generating and storing the markdown files WEBSITE_PATH = Path(__file__).parent.absolute() SEO_METADATA_PATH = Path(WEBSITE_PATH / "metadata/platform_v4_seo_metadata.json") @@ -34,450 +35,157 @@ PLATFORM_REFERENCE_UL_ELEMENT = '
    ' # noqa: E501 -def get_field_data_type(field_type: Any) -> str: - """Get the implicit data type from the field type. - - String manipulation is used to extract the implicit - data type from the field type. - - Args: - field_type (Any): typing object field type - - Returns: - str: String representation of the implicit field tzxype - """ - - try: - if "BeforeValidator" in str(field_type): - field_type = "int" - - if "Optional" in str(field_type): - field_type = str(field_type.__args__[0]) - - if "Annotated[" in str(field_type): - field_type = str(field_type).rsplit("[", maxsplit=1)[-1].split(",")[0] - - if "models" in str(field_type): - field_type = str(field_type).rsplit(".", maxsplit=1)[-1] - - field_type = ( - str(field_type) - .replace("", "") - .replace("typing.", "") - .replace("pydantic.types.", "") - .replace("openbb_core.provider.abstract.data.", "") - .replace("datetime.datetime", "datetime") - .replace("datetime.date", "date") - .replace("NoneType", "None") - .replace(", None", "") - ) - except TypeError: - field_type = str(field_type) - - return field_type - - -def get_endpoint_examples( - path: str, - func: Callable, - examples: Optional[List[Example]], -) -> str: - """Get the examples for the given standard model or function. - - For a given standard model or function, the examples are fetched from the - list of Example objects and formatted into a string. - - Args: - path (str): Path of the router. - func (Callable): Router endpoint function. - examples (Optional[List[Example]]): List of Examples (APIEx or PythonEx type) - for the endpoint. - - Returns: - str: Formatted string containing the examples for the endpoint. - """ - sig = inspect.signature(func) - parameter_map = dict(sig.parameters) - formatted_params = MethodDefinition.format_params( - path=path, parameter_map=parameter_map - ) - explicit_params = dict(formatted_params) - explicit_params.pop("extra_params", None) - param_types = {k: v.annotation for k, v in explicit_params.items()} - - return DocstringGenerator.build_examples( - path.replace("/", "."), - param_types, - examples, - "website", - ) - - -def get_provider_parameter_info(endpoint: Callable) -> Dict[str, str]: - """Get the name, type, description, default value and optionality - information for the provider parameter. +# pylint: disable=redefined-outer-name +def check_installed_packages( + console: Console, + debug: bool, +) -> None: + """Checks if the installed packages are the same as those on the platform pyproject.toml file. - Function signature is insepcted to get the parameters of the router - endpoint function. The provider parameter is then extracted from the - function type annotations then the information is extracted from it. + Compares the versions of the installed packages with the versions specified in the pyproject.toml file. + The source of truth for the package versions is the pyproject.toml file, and the installed packages are + checked against the specified versions. If the installed packages do not satisfy the version requirements, + an error is raised. - Args: - endpoint (Callable): Router endpoint function - - Returns: - Dict[str, str]: Dictionary of the provider parameter information + Parameters + ---------- + console (Console): Console object to display messages and save logs + debug (bool): Flag to enable debug mode """ - params_dict = endpoint.__annotations__ - model_type = params_dict["provider_choices"].__args__[0] - provider_params_field = model_type.__dataclass_fields__["provider"] - - # Type is Union[Literal[], None] - default = provider_params_field.type.__args__[0] - description = ( - "The provider to use for the query, by default None. " - "If None, the provider specified in defaults is selected " - f"or '{default}' if there is no default." + def convert_poetry_version_specifier( + poetry_version: Union[str, Dict[str, str]] + ) -> str: + """ + Convert a Poetry version specifier to a format compatible with the packaging library. + Handles both simple string specifiers and dictionary specifiers, extracting only the version value if it's a dict. + + Parameters + ---------- + poetry_version (Union[str, Dict[str, str]]): + Poetry version specifier + + Returns + ------- + str: + Version specifier compatible with the packaging library + """ + if isinstance(poetry_version, dict): + poetry_version = poetry_version.get("version", "") + + if isinstance(poetry_version, str): + if poetry_version.startswith("^"): + base_version = poetry_version[1:] + # Use regex to split the version and convert to integers only if they are purely numeric + parts = re.split(r"\.|\-", base_version) + try: + major, minor = (int(x) for x in parts[:2]) + except ValueError: + # If conversion fails, return the original version specifier + return poetry_version + next_major_version = major + 1 + # Construct a version specifier that represents the range. + return f">={base_version},<{next_major_version}.0.0" + + if poetry_version.startswith("~"): + base_version = poetry_version[1:] + parts = re.split(r"\.|\-", base_version) + try: + major, minor = (int(x) for x in parts[:2]) + except ValueError: + # If conversion fails, return the original version specifier + return poetry_version + next_minor_version = minor + 1 + # Construct a version specifier that represents the range. + return f">={base_version},<{major}.{next_minor_version}.0" + + # No need to modify other specifiers, as they are compatible with packaging library + return poetry_version + + def check_dependency( + package_name: str, version_spec: str, installed_packages_dict: Dict[str, str] + ) -> None: + """ + Check if the installed package version satisfies the required version specifier. + Raises DependencyCheckError if the package is not installed or does not satisfy the version requirements. + + Parameters + ---------- + package_name (str): + Name of the package to check + version_spec (str): + Version specifier to check against + installed_packages_dict (Dict[str, str]): + Dictionary of installed packages and their versions + """ + installed_version = installed_packages_dict.get(package_name.lower()) + if not installed_version: + raise Exception(f"{package_name} is not installed.") + + converted_version_spec = convert_poetry_version_specifier(version_spec) + specifier_set = specifiers.SpecifierSet(converted_version_spec) + + if not specifier_set.contains(installed_version, prereleases=True): + message = f"{package_name} version {installed_version} does not satisfy the specified version {converted_version_spec}." # noqa: E501, pylint: disable=line-too-long + raise Exception(message) + + console.log("\n[CRITICAL] Ensuring all the extensions are installed before the script runs...") # fmt: skip + + # Execute the pip list command once and store the output + pip_list_output = subprocess.run( + "pip list | grep openbb", # noqa: S607 + shell=True, # noqa: S602 + capture_output=True, + text=True, + check=False, ) - - provider_parameter_info = { - "name": provider_params_field.name, - "type": str(provider_params_field.type).replace("typing.", ""), - "description": description, - "default": default, - "optional": True, - "standard": True, + installed_packages = pip_list_output.stdout.splitlines() + installed_packages_dict = { + line.split()[0].lower(): line.split()[1] for line in installed_packages } - return provider_parameter_info - - -def get_provider_field_params( - model_map: Dict[str, Any], - params_type: str, - provider: str = "openbb", -) -> List[Dict[str, Any]]: - """Get the fields of the given parameter type for the given provider - of the standard_model. - - Args: - provider_map (Dict[str, Any]): Model Map containing the QueryParams and Data parameters - params_type (str): Parameters to fetch data for (QueryParams or Data) - provider (str, optional): Provider name. Defaults to "openbb". - - Returns: - List[Dict[str, str]]: List of dictionaries containing the field name, - type, description, default, optional flag and standard flag for each provider. - """ - - provider_field_params = [] - expanded_types = MethodDefinition.TYPE_EXPANSION - - 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 = get_field_data_type(field_info.annotation) - - if params_type == "QueryParams" and field in expanded_types: - expanded_type = get_field_data_type(expanded_types[field]) - field_type = f"Union[{expanded_type}, {field_type}]" - - cleaned_description = ( - str(field_info.description) - .strip().replace("\n", " ").replace(" ", " ").replace('"', "'") - ) # fmt: skip - - # Add information for the providers supporting multiple symbols - if params_type == "QueryParams" and ( - field_extra := field_info.json_schema_extra - ): - multiple_items_list = field_extra.get("multiple_items_allowed", None) - if multiple_items_list: - multiple_items = ", ".join(multiple_items_list) - cleaned_description += ( - f" Multiple items allowed for provider(s): {multiple_items}." - ) - # Manually setting to List[] for multiple items - # Should be removed if TYPE_EXPANSION is updated to include this - field_type = f"Union[{field_type}, List[{field_type}]]" - - default_value = "" if field_info.default is PydanticUndefined else str(field_info.default) # fmt: skip - - provider_field_params.append( - { - "name": field, - "type": field_type, - "description": cleaned_description, - "default": default_value, - "optional": not field_info.is_required(), - "standard": provider == "openbb", - } - ) - - return provider_field_params - - -def get_function_params_default_value(endpoint: Callable) -> Dict: - """Get the default for the endpoint function parameters. - - Args: - endpoint (Callable): Router endpoint function - - Returns: - Dict: Endpoint function parameters and their default values - """ - - default_values = {} - - signature = inspect.signature(endpoint) - parameters = signature.parameters - - for name, param in parameters.items(): - if param.default is not inspect.Parameter.empty: - default_values[name] = param.default - else: - default_values[name] = "" - - return default_values - - -def get_post_method_parameters_info(endpoint: Callable) -> List[Dict[str, str]]: - """Get the parameters for the POST method endpoints. - - Args: - endpoint (Callable): Router endpoint function - - Returns: - List[Dict[str, str]]: List of dictionaries containing the name, - type, description, default and optionality of each parameter. - """ - parameters_info = [] - descriptions = {} - - parameters_default_values = get_function_params_default_value(endpoint) - section = endpoint.__doc__.split("Parameters")[1].split("Returns")[0] # type: ignore - - lines = section.split("\n") - current_param = None - for line in lines: - cleaned_line = line.strip() - - if ":" in cleaned_line: # This line names a parameter - current_param = cleaned_line.split(":")[0] - current_param = current_param.strip() - elif current_param: # This line describes the parameter - description = cleaned_line.strip() - descriptions[current_param] = description - # Reset current_param to ensure each description is - # correctly associated with the parameter - current_param = None - - for param, param_type in endpoint.__annotations__.items(): - if param == "return": - continue - - parameters_info.append( - { - "name": param, - "type": get_field_data_type(param_type), - "description": descriptions.get(param, ""), - "default": parameters_default_values.get(param, ""), - "optional": "Optional" in str(param_type), - } - ) - - return parameters_info - - -def get_post_method_returns_info(endpoint: Callable) -> List[Dict[str, str]]: - """Get the returns information for the POST method endpoints. - - Args: - endpoint (Callable): Router endpoint function - - Returns: - Dict[str, str]: Dictionary containing the name, type, description of the return value - """ - section = endpoint.__doc__.split("Parameters")[1].split("Returns")[-1] # type: ignore - description_lines = section.strip().split("\n") - description = description_lines[-1].strip() if len(description_lines) > 1 else "" - return_type = endpoint.__annotations__["return"].model_fields["results"].annotation - - # Only one item is returned hence its a list with a single dictionary. - # Future changes to the return type will require changes to this code snippet. - return_info = [ - { - "name": "results", - "type": get_field_data_type(return_type), - "description": description, - } - ] - - return return_info - - -# mypy: disable-error-code="attr-defined,arg-type" -def generate_reference_file() -> None: - """Generate reference.json file using the ProviderInterface map.""" - - # ProviderInterface Map contains the model and its - # corresponding QueryParams and Data fields - pi_map = ProviderInterface().map - reference: Dict[str, Dict] = {} - - # Fields for the reference dictionary to be used in the JSON file - REFERENCE_FIELDS = [ - "deprecated", - "description", - "examples", - "parameters", - "returns", - "data", - ] - - # Router object is used to get the endpoints and their - # corresponding APIRouter object - router = RouterLoader.from_extensions() - route_map = {route.path: route for route in router.api_router.routes} - - for path, route in route_map.items(): - # Initialize the reference fields as empty dictionaries - reference[path] = {field: {} for field in REFERENCE_FIELDS} - - # Route method is used to distinguish between GET and POST methods - route_method = route.methods - - # Route endpoint is the callable function - route_func = route.endpoint - - # Standard model is used as the key for the ProviderInterface Map dictionary - standard_model = route.openapi_extra["model"] if route_method == {"GET"} else "" - - # Model Map contains the QueryParams and Data fields for each provider for a standard model - model_map = pi_map[standard_model] if standard_model else "" - - # Add endpoint model for GET methods - reference[path]["model"] = standard_model - - # Add endpoint deprecation details - deprecated_value = getattr(route, "deprecated", None) - reference[path]["deprecated"] = { - "flag": bool(deprecated_value), - "message": route.summary if deprecated_value else None, - } - - # Add endpoint description - if route_method == {"GET"}: - reference[path]["description"] = route.description - elif route_method == {"POST"}: - # POST method router `description` attribute is unreliable as it may or - # may not contain the "Parameters" and "Returns" sections. Hence, the - # endpoint function docstring is used instead. - description = route.endpoint.__doc__.split("Parameters")[0].strip() - # Remove extra spaces in between the string - reference[path]["description"] = re.sub(" +", " ", description) - - # Add endpoint examples - examples = route.openapi_extra["examples"] - reference[path]["examples"] = get_endpoint_examples(path, route_func, examples) - - # Add endpoint parameters fields for standard provider - if route_method == {"GET"}: - # openbb provider is always present hence its the standard field - reference[path]["parameters"]["standard"] = get_provider_field_params( - model_map, "QueryParams" + # Load the pyproject.toml file once + with open(PLATFORM_PATH / "pyproject.toml") as f: + toml_dict = toml.load(f) + + # Extract the openbb dependencies, excluding the python dependency + dependencies = toml_dict["tool"]["poetry"]["dependencies"] + dependencies.pop("python", None) + + # Compare versions and check dependencies + for package, version_spec in dependencies.items(): + normalized_package_name = package.replace("_", "-").lower() + try: + # Convert the version specifier before checking + converted_version_spec = convert_poetry_version_specifier(version_spec) + check_dependency( + normalized_package_name, converted_version_spec, installed_packages_dict ) - # Add `provider` parameter fields to the openbb provider - provider_parameter_fields = get_provider_parameter_info(route_func) - reference[path]["parameters"]["standard"].append(provider_parameter_fields) - - # Add endpoint data fields for standard provider - reference[path]["data"]["standard"] = get_provider_field_params( - model_map, "Data" - ) - - for provider in model_map: - if provider == "openbb": - continue - - # Adds standard parameters to the provider parameters since they are - # inherited by the model. - # A copy is used to prevent the standard parameters fields from being - # modified. - reference[path]["parameters"][provider] = reference[path]["parameters"][ - "standard" - ].copy() - provider_query_params = get_provider_field_params( - model_map, "QueryParams", provider + # Ensure debug_mode output shows the processed version specifier + if debug: + installed_version = installed_packages_dict.get(normalized_package_name) + console.log( + f"{normalized_package_name}: Specified version {converted_version_spec}, Installed version {installed_version}" # noqa: E501, pylint: disable=line-too-long ) - reference[path]["parameters"][provider].extend(provider_query_params) - - # Adds standard data fields to the provider data fields since they are - # inherited by the model. - # A copy is used to prevent the standard data fields from being modified. - reference[path]["data"][provider] = reference[path]["data"][ - "standard" - ].copy() - provider_data = get_provider_field_params(model_map, "Data", provider) - reference[path]["data"][provider].extend(provider_data) - - elif route_method == {"POST"}: - # Add endpoint parameters fields for POST methods - reference[path]["parameters"]["standard"] = get_post_method_parameters_info( - route_func - ) - - # Add endpoint returns data - # Currently only OBBject object is returned - if route_method == {"GET"}: - reference[path]["returns"]["OBBject"] = [ - { - "name": "results", - "type": f"List[{standard_model}]", - "description": "Serializable results.", - }, - { - "name": "provider", - "type": f"Optional[{provider_parameter_fields['type']}]", - "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.", - }, - ] - - elif route_method == {"POST"}: - reference[path]["returns"]["OBBject"] = get_post_method_returns_info( - route_func - ) - - # Dumping the reference dictionary as a JSON file - with open(PLATFORM_CONTENT_PATH / "reference.json", "w", encoding="utf-8") as f: - json.dump(reference, f, indent=4) + except Exception as e: + raise e def create_reference_markdown_seo(path: str, description: str) -> str: """Create the SEO section for the markdown file. - Args: - path (str): Command path relative to the obb class - description (str): Description of the command - - Returns: - str: SEO section for the markdown file + Parameters + ---------- + path (str): + Command path relative to the obb class + description (str): + Description of the command + + Returns + ------- + str: + SEO section for the markdown file """ with open(SEO_METADATA_PATH) as f: @@ -518,13 +226,19 @@ def create_reference_markdown_intro( ) -> str: """Create the introduction section for the markdown file. - Args: - path (str): Command path relative to the obb class - description (str): Description of the command - deprecated (Dict[str, str]): Deprecated flag and message - - Returns: - str: Introduction section for the markdown file + Parameters + ---------- + path (str): + Command path relative to the obb class + description (str): + Description of the command + deprecated (Dict[str, str]): + Deprecated flag and message + + Returns + ------- + str: + Introduction section for the markdown file """ deprecation_message = ( @@ -552,15 +266,20 @@ def create_reference_markdown_tabular_section( ) -> str: """Create the tabular section for the markdown file. - Args: - parameters (Dict[str, List[Dict[str, str]]]): Dictionary of - providers and their corresponding parameters - heading (str): Section heading for the tabular section - - Returns: - str: Tabular section for the markdown file + Parameters + ---------- + parameters (Dict[str, List[Dict[str, str]]]): + Dictionary of providers and their corresponding parameters + heading (str): + Section heading for the tabular section + + Returns + ------- + str: + Tabular section for the markdown file """ + standard_params_list = [] tables_list = [] # params_list is a list of dictionaries containing the @@ -572,14 +291,18 @@ def create_reference_markdown_tabular_section( for params in params_list ] - # Do not add default and optional columns in the Data section - # because James and Andrew don't like it + # 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 ] + if provider == "standard": + standard_params_list = filtered_params + else: + filtered_params = standard_params_list + filtered_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. @@ -613,48 +336,39 @@ def create_reference_markdown_tabular_section( return markdown -def create_reference_markdown_returns_section(returns: List[Dict[str, str]]) -> str: +def create_reference_markdown_returns_section(returns_content: str) -> str: """Create the returns section for the markdown file. - Args: - returns (List[Dict[str, str]]): List of dictionaries containing - the name, type and description of the returns + Parameters + ---------- + returns_content (str): + Returns section formatted as a string - Returns: - str: Returns section for the markdown file + Returns + ------- + str: + Returns section for the markdown file """ - returns_data = "" - - for params in returns: - returns_data += f"{TAB_WIDTH*' '}{params['name']} : {params['type']}\n" - returns_data += f"{TAB_WIDTH*' '}{TAB_WIDTH*' '}{params['description']}\n\n" - - # Remove the last two newline characters to render Returns section properly - returns_data = returns_data.rstrip("\n\n") - - markdown = ( - "---\n\n" - "## Returns\n\n" - "```python wordwrap\n" - "OBBject\n" - f"{returns_data}\n" - "```\n\n" - ) - - return markdown + return f"---\n\n## Returns\n\n```python wordwrap\n{returns_content}\n```\n\n" def create_data_model_markdown(title: str, description: str, model: str) -> str: """Create the basic markdown file content for the data model. - Args: - title (str): Title of the data model - description (str): Description of the data model - model (str): Model name - - Returns: - str: Basic markdown file content for the data model + Parameters + ---------- + title (str): + Title of the data model + description (str): + Description of the data model + model (str): + Model name + + Returns + ------- + str: + Basic markdown file content for the data model """ # File name is used in the import statement @@ -702,11 +416,15 @@ def create_data_model_markdown(title: str, description: str, model: str) -> str: def find_data_model_implementation_file(data_model: str) -> str: """Find the file name containing the data model class. - Args: - data_model (str): Data model name + Parameters + ---------- + data_model (str): + Data model name - Returns: - str: File name containing the data model class + Returns + ------- + str: + File name containing the data model class """ # Function to search for the data model class in the file @@ -732,8 +450,10 @@ def generate_reference_index_files(reference_content: Dict[str, str]) -> None: """Generate index.mdx and _category_.json files for directories and sub-directories in the reference directory. - Args: - reference_content (Dict[str, str]): Endpoints and their corresponding descriptions. + Parameters + ---------- + reference_content (Dict[str, str]): + Endpoints and their corresponding descriptions. """ def generate_index_and_category( @@ -864,13 +584,19 @@ def generate_reference_top_level_index() -> None: def create_data_models_index(title: str, description: str, model: str) -> str: """Create the index content for the data models. - Args: - title (str): Title of the data model - description (str): Description of the data model - model (str): Model name - - Returns: - str: Index content for the data models + Parameters + ---------- + title (str): + Title of the data model + description (str): + Description of the data model + model (str): + Model name + + Returns + ------- + str: + Index content for the data models """ # Get the first sentence of the description @@ -891,8 +617,10 @@ def create_data_models_index(title: str, description: str, model: str) -> str: def generate_data_models_index_files(content: str) -> None: """Generate index.mdx and _category_.json files for the data_models directory. - Args: - content (str): Content for the data models index file + Parameters + ---------- + content (str): + Content for the data models index file """ index_content = ( @@ -918,13 +646,19 @@ def generate_data_models_index_files(content: str) -> None: def generate_markdown_file(path: str, markdown_content: str, directory: str) -> None: """Generate markdown file using the content of the specified path and directory. - Args: - path (str): Path to the markdown file - markdown_content (str): Content for the markdown file - directory (str): Directory to save the markdown file - - Raises: - ValueError: If the content type is invalid + Parameters + ---------- + path (str): + Path to the markdown file + markdown_content (str): + Content for the markdown file + directory (str): + Directory to save the markdown file + + Raises + ------ + ValueError: + If the content type is invalid """ # For reference, split the path to separate the @@ -949,30 +683,37 @@ def generate_markdown_file(path: str, markdown_content: str, directory: str) -> md_file.write(markdown_content) -def generate_platform_markdown() -> None: +# pylint: disable=redefined-outer-name +def generate_platform_markdown( + console: Console, +) -> None: """Generate markdown files for OpenBB Docusaurus website.""" data_models_index_content = [] reference_index_content_dict = {} - print("[CRITICAL] Ensure all the extensions are installed before running this script!") # fmt: skip - - # Generate and read the reference.json file - print("[INFO] Generating the reference.json file...") - generate_reference_file() - with open(PLATFORM_CONTENT_PATH / "reference.json") as f: - reference = json.load(f) + console.log(f"\n[INFO] Reading the {REFERENCE_FILE_PATH} file...") + # Load the reference.json file + try: + with open(REFERENCE_FILE_PATH) as f: + reference = json.load(f) + except FileNotFoundError as exc: + raise FileNotFoundError( + "File not found! Please ensure the file exists." + ) from exc # Clear the platform/reference folder - print("[INFO] Clearing the platform/reference folder...") + console.log(f"\n[INFO] Clearing the {PLATFORM_REFERENCE_PATH} folder...") shutil.rmtree(PLATFORM_REFERENCE_PATH, ignore_errors=True) # Clear the platform/data_models folder - print("[INFO] Clearing the platform/data_models folder...") + console.log(f"\n[INFO] Clearing the {PLATFORM_DATA_MODELS_PATH} folder...") shutil.rmtree(PLATFORM_DATA_MODELS_PATH, ignore_errors=True) - print(f"[INFO] Generating the markdown files for the {PLATFORM_REFERENCE_PATH} sub-directories...") # fmt: skip - print(f"[INFO] Generating the markdown files for the {PLATFORM_DATA_MODELS_PATH} directory...") # fmt: skip + console.log( + f"\n[INFO] Generating the markdown files for the {PLATFORM_REFERENCE_PATH} sub-directories..." + ) # noqa: E501 + console.log(f"\n[INFO] Generating the markdown files for the {PLATFORM_DATA_MODELS_PATH} directory...") # fmt: skip for path, path_data in reference.items(): reference_markdown_content = "" @@ -990,6 +731,7 @@ def generate_platform_markdown() -> None: reference_markdown_content += create_reference_markdown_intro( path[1:], description, path_data["deprecated"] ) + # reference_markdown_content += create_reference_markdown_examples(path_data["examples"]) reference_markdown_content += path_data["examples"] if path_parameters_fields := path_data["parameters"]: @@ -1036,10 +778,10 @@ def generate_platform_markdown() -> None: generate_markdown_file(model, data_markdown_content, "data_models") # Generate the index.mdx and _category_.json files for the reference directory - print(f"[INFO] Generating the index files for the {PLATFORM_REFERENCE_PATH} sub-directories...") # fmt: skip + console.log(f"\n[INFO] Generating the index files for the {PLATFORM_REFERENCE_PATH} sub-directories...") # fmt: skip generate_reference_index_files(reference_index_content_dict) - print( - f"[INFO] Generating the index files for the {PLATFORM_REFERENCE_PATH} directory..." + console.log( + f"\n[INFO] Generating the index files for the {PLATFORM_REFERENCE_PATH} directory..." ) generate_reference_top_level_index() @@ -1048,10 +790,33 @@ def generate_platform_markdown() -> None: data_models_index_content_str = "".join(data_models_index_content) # Generate the index.mdx and _category_.json files for the data_models directory - print(f"[INFO] Generating the index files for the {PLATFORM_DATA_MODELS_PATH} directory...") # fmt: skip + console.log(f"\n[INFO] Generating the index files for the {PLATFORM_DATA_MODELS_PATH} directory...") # fmt: skip generate_data_models_index_files(data_models_index_content_str) - print("[INFO] Markdown files generated successfully!") + console.log("\n[INFO] Markdown files generated successfully!") if __name__ == "__main__": - generate_platform_markdown() + parser = argparse.ArgumentParser( + prog="Platform Markdown Generator V2", + description="Generate markdown files for the Platform website docs.", + ) + + parser.add_argument( + "-v", + "--verbose", + action="store_true", + help="Enable verbose output for debugging.", + ) + + args = parser.parse_args() + console = Console(True) + verbose = False + + if args.verbose: + verbose = True + + check_installed_packages( + console=console, + debug=verbose, + ) + generate_platform_markdown(console=console)