From f2f6bd020fc2c1c149eb4e2b2e974a3083a7751c Mon Sep 17 00:00:00 2001 From: hjoaquim Date: Mon, 13 May 2024 09:38:10 +0100 Subject: [PATCH 1/9] remove hold command and its references --- cli/openbb_cli/config/setup.py | 62 --------- cli/openbb_cli/controllers/base_controller.py | 124 ------------------ cli/openbb_cli/controllers/cli_controller.py | 2 - 3 files changed, 188 deletions(-) diff --git a/cli/openbb_cli/config/setup.py b/cli/openbb_cli/config/setup.py index 4d3eece690bf..4e682a535e80 100644 --- a/cli/openbb_cli/config/setup.py +++ b/cli/openbb_cli/config/setup.py @@ -1,71 +1,9 @@ """Configuration for the CLI.""" -import copy from pathlib import Path -from typing import TYPE_CHECKING, List, Optional, TypeVar from openbb_cli.config.constants import ENV_FILE_SETTINGS, SETTINGS_DIRECTORY -if TYPE_CHECKING: - from openbb_charting.core.openbb_figure import OpenBBFigure - -# ruff: noqa:PLW0603 - -OpenBBFigureT = TypeVar("OpenBBFigureT", bound="OpenBBFigure") -HOLD: bool = False -COMMAND_ON_CHART: bool = True -current_figure: Optional[OpenBBFigureT] = None # type: ignore -new_axis: bool = True -legends: List = [] -last_legend = "" - - -# pylint: disable=global-statement -def set_last_legend(leg: str): - """Set the last legend.""" - global last_legend - last_legend = copy.deepcopy(leg) - - -def reset_legend() -> None: - """Reset the legend.""" - global legends - legends = [] - - -def get_legends() -> list: - """Get the legends.""" - return legends - - -def set_same_axis() -> None: - """Set the same axis.""" - global new_axis - new_axis = False - - -def set_new_axis() -> None: - """Set the new axis.""" - global new_axis - new_axis = True - - -def make_new_axis() -> bool: - """Make a new axis.""" - return new_axis - - -def get_current_figure() -> Optional["OpenBBFigure"]: - """Get the current figure.""" - return current_figure - - -def set_current_figure(fig: Optional[OpenBBFigureT] = None): - """Set the current figure.""" - # pylint: disable=global-statement - global current_figure - current_figure = fig - def bootstrap(): """Setup pre-launch configurations for the CLI.""" diff --git a/cli/openbb_cli/controllers/base_controller.py b/cli/openbb_cli/controllers/base_controller.py index 9db39807a093..5c644f479c9b 100644 --- a/cli/openbb_cli/controllers/base_controller.py +++ b/cli/openbb_cli/controllers/base_controller.py @@ -10,7 +10,6 @@ from typing import Any, Dict, List, Literal, Optional, Union import pandas as pd -from openbb_cli.config import setup from openbb_cli.config.completer import NestedCompleter from openbb_cli.config.constants import SCRIPT_TAGS from openbb_cli.controllers.choices import build_controller_choice_map @@ -63,14 +62,12 @@ class BaseController(metaclass=ABCMeta): "r", "reset", "stop", - "hold", "whoami", "results", ] CHOICES_COMMANDS: List[str] = [] CHOICES_MENUS: List[str] = [] - HOLD_CHOICES: dict = {} NEWS_CHOICES: dict = {} COMMAND_SEPARATOR = "/" KEYS_MENU = "keys" + COMMAND_SEPARATOR @@ -166,113 +163,6 @@ def load_class(self, class_ins, *args, **kwargs): return old_class.menu() return class_ins(*args, **kwargs).menu() - def call_hold(self, other_args: List[str]) -> None: - """Process hold command.""" - self.save_class() - parser = argparse.ArgumentParser( - add_help=False, - formatter_class=argparse.ArgumentDefaultsHelpFormatter, - prog="hold", - description="Turn on figure holding. This will stop showing images until hold off is run.", - ) - parser.add_argument( - "-o", - "--option", - choices=["on", "off"], - type=str, - default="off", - dest="option", - ) - parser.add_argument( - "-s", - "--sameaxis", - action="store_true", - default=False, - help="Put plots on the same axis. Best when numbers are on similar scales", - dest="axes", - ) - parser.add_argument( - "--title", - type=str, - default="", - dest="title", - nargs="+", - help="When using hold off, this sets the title for the figure.", - ) - if other_args and "-" not in other_args[0][0]: - other_args.insert(0, "-o") - - ns_parser = self.parse_known_args_and_warn( - parser, - other_args, - ) - if ns_parser: - if ns_parser.option == "on": - setup.HOLD = True - setup.COMMAND_ON_CHART = False - if ns_parser.axes: - setup.set_same_axis() - else: - setup.set_new_axis() - if ns_parser.option == "off": - setup.HOLD = False - if setup.get_current_figure() is not None: - # create a subplot - fig = setup.get_current_figure() - if fig is None: - return - if not fig.has_subplots and not setup.make_new_axis(): - fig.set_subplots(1, 1, specs=[[{"secondary_y": True}]]) - - if setup.make_new_axis(): - for i, trace in enumerate(fig.select_traces()): - trace.yaxis = f"y{i+1}" - - if i != 0: - fig.update_layout( - { - f"yaxis{i+1}": dict( - side="left", - overlaying="y", - showgrid=True, - showline=False, - zeroline=False, - automargin=True, - ticksuffix=( - " " * (i - 1) if i > 1 else "" - ), - tickfont=dict( - size=18, - ), - title=dict( - font=dict( - size=15, - ), - standoff=0, - ), - ), - } - ) - # pylint: disable=undefined-loop-variable - fig.update_layout(margin=dict(l=30 * i)) - - else: - fig.update_yaxes(title="") - - if any(setup.get_legends()): - for trace, new_name in zip( - fig.select_traces(), setup.get_legends() - ): - if new_name: - trace.name = new_name - - fig.update_layout(title=" ".join(ns_parser.title)) - fig.show() - setup.COMMAND_ON_CHART = True - - setup.set_current_figure(None) - setup.reset_legend() - def save_class(self) -> None: """Save the current instance of the class to be loaded later.""" if session.settings.REMEMBER_CONTEXTS: @@ -832,16 +722,6 @@ def parse_known_args_and_warn( "-h", "--help", action="store_true", help="show this help message" ) - if setup.HOLD: - parser.add_argument( - "--legend", - type=str, - dest="hold_legend_str", - default="", - nargs="+", - help="Label for legend when hold is on.", - ) - if export_allowed != "no_export": choices_export = [] help_export = "Does not export!" @@ -925,10 +805,6 @@ def parse_known_args_and_warn( return None - # This protects against the hidden loads in stocks/fa - if parser.prog != "load" and setup.HOLD: - setup.set_last_legend(" ".join(ns_parser.hold_legend_str)) - if l_unknown_args: session.console.print( f"The following args couldn't be interpreted: {l_unknown_args}" diff --git a/cli/openbb_cli/controllers/cli_controller.py b/cli/openbb_cli/controllers/cli_controller.py index aec72410a84e..d353d51d285d 100644 --- a/cli/openbb_cli/controllers/cli_controller.py +++ b/cli/openbb_cli/controllers/cli_controller.py @@ -169,8 +169,6 @@ def update_runtime_choices(self): if session.prompt_session and session.settings.USE_PROMPT_TOOLKIT: # choices: dict = self.choices_default choices: dict = {c: {} for c in self.controller_choices} # type: ignore - choices["hold"] = {c: None for c in ["on", "off", "-s", "--sameaxis"]} - choices["hold"]["off"] = {"--title": None} self.ROUTINE_FILES = { filepath.name: filepath # type: ignore From 7a50325125c260a32de4c7031faea615db38c476 Mon Sep 17 00:00:00 2001 From: hjoaquim Date: Mon, 13 May 2024 09:45:53 +0100 Subject: [PATCH 2/9] remove --local flag as we don't use it anymore @IgorWounds --- cli/openbb_cli/controllers/cli_controller.py | 2 - openbb_platform/openbb/assets/reference.json | 41629 ++++++++++------ .../openbb/package/__extensions__.py | 48 + .../openbb/package/crypto_price.py | 9 + openbb_platform/openbb/package/currency.py | 137 +- .../openbb/package/currency_price.py | 9 + .../openbb/package/derivatives_options.py | 58 +- openbb_platform/openbb/package/economy.py | 313 +- openbb_platform/openbb/package/equity.py | 120 +- .../openbb/package/equity_calendar.py | 74 +- .../openbb/package/equity_compare.py | 133 + .../openbb/package/equity_discovery.py | 169 +- .../openbb/package/equity_estimates.py | 42 +- .../openbb/package/equity_fundamental.py | 182 +- .../openbb/package/equity_ownership.py | 24 +- .../openbb/package/equity_price.py | 322 +- .../openbb/package/equity_shorts.py | 164 + openbb_platform/openbb/package/etf.py | 387 +- .../openbb/package/fixedincome_corporate.py | 176 + .../openbb/package/fixedincome_government.py | 572 + openbb_platform/openbb/package/index.py | 528 +- openbb_platform/openbb/package/news.py | 51 +- openbb_platform/openbb/package/regulators.py | 10 + 23 files changed, 29733 insertions(+), 15426 deletions(-) diff --git a/cli/openbb_cli/controllers/cli_controller.py b/cli/openbb_cli/controllers/cli_controller.py index d353d51d285d..75816ef5a11e 100644 --- a/cli/openbb_cli/controllers/cli_controller.py +++ b/cli/openbb_cli/controllers/cli_controller.py @@ -206,8 +206,6 @@ def update_runtime_choices(self): "-d": "--description", "--public": None, "-p": "--public", - "--local": None, - "-l": "--local", "--tag1": {c: None for c in constants.SCRIPT_TAGS}, "--tag2": {c: None for c in constants.SCRIPT_TAGS}, "--tag3": {c: None for c in constants.SCRIPT_TAGS}, diff --git a/openbb_platform/openbb/assets/reference.json b/openbb_platform/openbb/assets/reference.json index 5ff26093f056..291bb07f726f 100644 --- a/openbb_platform/openbb/assets/reference.json +++ b/openbb_platform/openbb/assets/reference.json @@ -10,32 +10,225 @@ "crypto@1.1.5", "currency@1.1.5", "derivatives@1.1.5", + "econometrics@1.1.5", "economy@1.1.5", "equity@1.1.5", "etf@1.1.5", "fixedincome@1.1.5", "index@1.1.5", "news@1.1.5", - "regulators@1.1.5" + "quantitative@1.1.5", + "regulators@1.1.5", + "technical@1.1.6" ], "openbb_provider_extension": [ + "alpha_vantage@1.1.5", "benzinga@1.1.5", + "biztoc@1.1.5", + "cboe@1.1.5", + "ecb@1.1.5", "econdb@1.0.0", "federal_reserve@1.1.5", + "finra@1.1.5", + "finviz@1.0.4", "fmp@1.1.5", "fred@1.1.5", + "government_us@1.1.5", "intrinio@1.1.5", + "nasdaq@1.1.6", "oecd@1.1.5", "polygon@1.1.5", "sec@1.1.5", + "seeking_alpha@1.1.5", + "stockgrid@1.1.5", "tiingo@1.1.5", + "tmx@1.0.2", + "tradier@1.0.2", "tradingeconomics@1.1.5", + "wsj@1.1.5", "yfinance@1.1.5" ], - "openbb_obbject_extension": [] + "openbb_obbject_extension": [ + "openbb_charting@2.0.3" + ] } }, "paths": { + "/commodity/lbma_fixing": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Daily LBMA Fixing Prices in USD/EUR/GBP.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.commodity.lbma_fixing(provider='nasdaq')\n# Get the daily LBMA fixing prices for silver in 2023.\nobb.commodity.lbma_fixing(asset='silver', start_date='2023-01-01', end_date='2023-12-31', transform=rdiff, collapse=monthly, provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "asset", + "type": "Literal['gold', 'silver']", + "description": "The metal to get price fixing rates for.", + "default": "gold", + "optional": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['nasdaq']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default.", + "default": "nasdaq", + "optional": true + } + ], + "nasdaq": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "transform", + "type": "Literal['diff', 'rdiff', 'cumul', 'normalize']", + "description": "Transform the data as difference, percent change, cumulative, or normalize.", + "default": null, + "optional": true + }, + { + "name": "collapse", + "type": "Literal['daily', 'weekly', 'monthly', 'quarterly', 'annual']", + "description": "Collapse the frequency of the time series.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[LbmaFixing]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['nasdaq']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "usd_am", + "type": "float", + "description": "AM fixing price in USD.", + "default": null, + "optional": true + }, + { + "name": "usd_pm", + "type": "float", + "description": "PM fixing price in USD.", + "default": null, + "optional": true + }, + { + "name": "gbp_am", + "type": "float", + "description": "AM fixing price in GBP.", + "default": null, + "optional": true + }, + { + "name": "gbp_pm", + "type": "float", + "description": "PM fixing price in GBP.", + "default": null, + "optional": true + }, + { + "name": "euro_am", + "type": "float", + "description": "AM fixing price in EUR.", + "default": null, + "optional": true + }, + { + "name": "euro_pm", + "type": "float", + "description": "PM fixing price in EUR.", + "default": null, + "optional": true + }, + { + "name": "usd", + "type": "float", + "description": "Daily fixing price in USD.", + "default": null, + "optional": true + }, + { + "name": "gbp", + "type": "float", + "description": "Daily fixing price in GBP.", + "default": null, + "optional": true + }, + { + "name": "eur", + "type": "float", + "description": "Daily fixing price in EUR.", + "default": null, + "optional": true + } + ], + "nasdaq": [] + }, + "model": "LbmaFixing" + }, "/crypto/price/historical": { "deprecated": { "flag": null, @@ -744,57 +937,35 @@ }, "model": "CurrencyPairs" }, - "/currency/snapshots": { + "/currency/reference_rates": { "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", + "description": "Get current, official, currency reference rates.\n\nForeign exchange reference rates are the exchange rates set by a major financial institution or regulatory body,\nserving as a benchmark for the value of currencies around the world.\nThese rates are used as a standard to facilitate international trade and financial transactions,\nensuring consistency and reliability in currency conversion.\nThey are typically updated on a daily basis and reflect the market conditions at a specific time.\nCentral banks and financial institutions often use these rates to guide their own exchange rates,\nimpacting global trade, loans, and investments.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.currency.reference_rates(provider='ecb')\n```\n\n", "parameters": { "standard": [ - { - "name": "base", - "type": "Union[str, List[str]]", - "description": "The base currency symbol. Multiple items allowed for provider(s): fmp, polygon.", - "default": "usd", - "optional": true - }, - { - "name": "quote_type", - "type": "Literal['direct', 'indirect']", - "description": "Whether the quote is direct or indirect. Selecting 'direct' will return the exchange rate as the amount of domestic currency required to buy one unit of the foreign currency. Selecting 'indirect' (default) will return the exchange rate as the amount of foreign currency required to buy one unit of the domestic currency.", - "default": "indirect", - "optional": true - }, - { - "name": "counter_currencies", - "type": "Union[List[str], str]", - "description": "An optional list of counter currency symbols to filter for. None returns all.", - "default": null, - "optional": true - }, { "name": "provider", - "type": "Literal['fmp', 'polygon']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "type": "Literal['ecb']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'ecb' if there is no default.", + "default": "ecb", "optional": true } ], - "fmp": [], - "polygon": [] + "ecb": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[CurrencySnapshots]", + "type": "List[CurrencyReferenceRates]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'polygon']]", + "type": "Optional[Literal['ecb']]", "description": "Provider name." }, { @@ -817,309 +988,285 @@ "data": { "standard": [ { - "name": "base_currency", - "type": "str", - "description": "The base, or domestic, currency.", - "default": "", - "optional": false - }, - { - "name": "counter_currency", - "type": "str", - "description": "The counter, or foreign, currency.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "last_rate", + "name": "EUR", "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 + "description": "Euro.", + "default": null, + "optional": true }, { - "name": "open", + "name": "USD", "type": "float", - "description": "The open price.", + "description": "US Dollar.", "default": null, "optional": true }, { - "name": "high", + "name": "JPY", "type": "float", - "description": "The high price.", + "description": "Japanese Yen.", "default": null, "optional": true }, { - "name": "low", + "name": "BGN", "type": "float", - "description": "The low price.", + "description": "Bulgarian Lev.", "default": null, "optional": true }, { - "name": "close", + "name": "CZK", "type": "float", - "description": "The close price.", + "description": "Czech Koruna.", "default": null, "optional": true }, { - "name": "volume", - "type": "int", - "description": "The trading volume.", + "name": "DKK", + "type": "float", + "description": "Danish Krone.", "default": null, "optional": true }, { - "name": "prev_close", + "name": "GBP", "type": "float", - "description": "The previous close price.", + "description": "Pound Sterling.", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "change", + "name": "HUF", "type": "float", - "description": "The change in the price from the previous close.", + "description": "Hungarian Forint.", "default": null, "optional": true }, { - "name": "change_percent", + "name": "PLN", "type": "float", - "description": "The change in the price from the previous close, as a normalized percent.", + "description": "Polish Zloty.", "default": null, "optional": true }, { - "name": "ma50", + "name": "RON", "type": "float", - "description": "The 50-day moving average.", + "description": "Romanian Leu.", "default": null, "optional": true }, { - "name": "ma200", + "name": "SEK", "type": "float", - "description": "The 200-day moving average.", + "description": "Swedish Krona.", "default": null, "optional": true }, { - "name": "year_high", + "name": "CHF", "type": "float", - "description": "The 52-week high.", + "description": "Swiss Franc.", "default": null, "optional": true }, { - "name": "year_low", + "name": "ISK", "type": "float", - "description": "The 52-week low.", + "description": "Icelandic Krona.", "default": null, "optional": true }, { - "name": "last_rate_timestamp", - "type": "datetime", - "description": "The timestamp of the last rate.", + "name": "NOK", + "type": "float", + "description": "Norwegian Krone.", "default": null, "optional": true - } - ], - "polygon": [ + }, { - "name": "vwap", + "name": "TRY", "type": "float", - "description": "The volume-weighted average price.", + "description": "Turkish Lira.", "default": null, "optional": true }, { - "name": "change", + "name": "AUD", "type": "float", - "description": "The change in price from the previous day.", + "description": "Australian Dollar.", "default": null, "optional": true }, { - "name": "change_percent", + "name": "BRL", "type": "float", - "description": "The percentage change in price from the previous day.", + "description": "Brazilian Real.", "default": null, "optional": true }, { - "name": "prev_open", + "name": "CAD", "type": "float", - "description": "The previous day's opening price.", + "description": "Canadian Dollar.", "default": null, "optional": true }, { - "name": "prev_high", + "name": "CNY", "type": "float", - "description": "The previous day's high price.", + "description": "Chinese Yuan.", "default": null, "optional": true }, { - "name": "prev_low", + "name": "HKD", "type": "float", - "description": "The previous day's low price.", + "description": "Hong Kong Dollar.", "default": null, "optional": true }, { - "name": "prev_volume", + "name": "IDR", "type": "float", - "description": "The previous day's volume.", + "description": "Indonesian Rupiah.", "default": null, "optional": true }, { - "name": "prev_vwap", + "name": "ILS", "type": "float", - "description": "The previous day's VWAP.", + "description": "Israeli Shekel.", "default": null, "optional": true }, { - "name": "bid", + "name": "INR", "type": "float", - "description": "The current bid price.", + "description": "Indian Rupee.", "default": null, "optional": true }, { - "name": "ask", + "name": "KRW", "type": "float", - "description": "The current ask price.", + "description": "South Korean Won.", "default": null, "optional": true }, { - "name": "minute_open", + "name": "MXN", "type": "float", - "description": "The open price from the most recent minute bar.", + "description": "Mexican Peso.", "default": null, "optional": true }, { - "name": "minute_high", + "name": "MYR", "type": "float", - "description": "The high price from the most recent minute bar.", + "description": "Malaysian Ringgit.", "default": null, "optional": true }, { - "name": "minute_low", + "name": "NZD", "type": "float", - "description": "The low price from the most recent minute bar.", + "description": "New Zealand Dollar.", "default": null, "optional": true }, { - "name": "minute_close", + "name": "PHP", "type": "float", - "description": "The close price from the most recent minute bar.", + "description": "Philippine Peso.", "default": null, "optional": true }, { - "name": "minute_volume", + "name": "SGD", "type": "float", - "description": "The volume from the most recent minute bar.", + "description": "Singapore Dollar.", "default": null, "optional": true }, { - "name": "minute_vwap", + "name": "THB", "type": "float", - "description": "The VWAP from the most recent minute bar.", + "description": "Thai Baht.", "default": null, "optional": true }, { - "name": "minute_transactions", + "name": "ZAR", "type": "float", - "description": "The number of transactions in the most recent minute bar.", - "default": null, - "optional": true - }, - { - "name": "quote_timestamp", - "type": "datetime", - "description": "The timestamp of the last quote.", - "default": null, - "optional": true - }, - { - "name": "minute_timestamp", - "type": "datetime", - "description": "The timestamp for the start of the most recent minute bar.", + "description": "South African Rand.", "default": null, "optional": true - }, - { - "name": "last_updated", - "type": "datetime", - "description": "The last time the data was updated.", - "default": "", - "optional": false } - ] + ], + "ecb": [] }, - "model": "CurrencySnapshots" + "model": "CurrencyReferenceRates" }, - "/derivatives/options/chains": { + "/currency/snapshots": { "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", + "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": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false + "name": "base", + "type": "Union[str, List[str]]", + "description": "The base currency symbol. Multiple items allowed for provider(s): fmp, polygon.", + "default": "usd", + "optional": true }, { - "name": "provider", - "type": "Literal['intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", + "name": "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 - } - ], - "intrinio": [ + }, { - "name": "date", - "type": "Union[date, str]", - "description": "The end-of-day date for options chains data.", + "name": "counter_currencies", + "type": "Union[str, List[str]]", + "description": "An optional list of counter currency symbols to filter for. None returns all.", "default": null, "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'polygon']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true } - ] + ], + "fmp": [], + "polygon": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[OptionsChains]", + "type": "List[CurrencySnapshots]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['intrinio']]", + "type": "Optional[Literal['fmp', 'polygon']]", "description": "Provider name." }, { @@ -1142,412 +1289,335 @@ "data": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data. Here, it is the underlying symbol for the option.", - "default": null, - "optional": true - }, - { - "name": "contract_symbol", + "name": "base_currency", "type": "str", - "description": "Contract symbol for the option.", + "description": "The base, or domestic, currency.", "default": "", "optional": false }, { - "name": "eod_date", - "type": "date", - "description": "Date for which the options chains are returned.", - "default": null, - "optional": true - }, - { - "name": "expiration", - "type": "date", - "description": "Expiration date of the contract.", + "name": "counter_currency", + "type": "str", + "description": "The counter, or foreign, currency.", "default": "", "optional": false }, { - "name": "strike", + "name": "last_rate", "type": "float", - "description": "Strike price of the contract.", - "default": "", - "optional": false - }, - { - "name": "option_type", - "type": "str", - "description": "Call or Put.", + "description": "The exchange rate, relative to the base currency. Rates are expressed as the amount of foreign currency received from selling one unit of the base currency, or the quantity of foreign currency required to purchase one unit of the domestic currency. To inverse the perspective, set the 'quote_type' parameter as 'direct'.", "default": "", "optional": false }, { - "name": "open_interest", - "type": "int", - "description": "Open interest on the contract.", + "name": "open", + "type": "float", + "description": "The open price.", "default": null, "optional": true }, { - "name": "volume", - "type": "int", - "description": "The trading volume.", + "name": "high", + "type": "float", + "description": "The high price.", "default": null, "optional": true }, { - "name": "theoretical_price", + "name": "low", "type": "float", - "description": "Theoretical value of the option.", + "description": "The low price.", "default": null, "optional": true }, { - "name": "last_trade_price", + "name": "close", "type": "float", - "description": "Last trade price of the option.", + "description": "The close price.", "default": null, "optional": true }, { - "name": "tick", - "type": "str", - "description": "Whether the last tick was up or down in price.", + "name": "volume", + "type": "int", + "description": "The trading volume.", "default": null, "optional": true }, { - "name": "bid", + "name": "prev_close", "type": "float", - "description": "Current bid price for the option.", + "description": "The previous close price.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "bid_size", - "type": "int", - "description": "Bid size for the option.", + "name": "change", + "type": "float", + "description": "The change in the price from the previous close.", "default": null, "optional": true }, { - "name": "ask", + "name": "change_percent", "type": "float", - "description": "Current ask price for the option.", + "description": "The change in the price from the previous close, as a normalized percent.", "default": null, "optional": true }, { - "name": "ask_size", - "type": "int", - "description": "Ask size for the option.", + "name": "ma50", + "type": "float", + "description": "The 50-day moving average.", "default": null, "optional": true }, { - "name": "mark", + "name": "ma200", "type": "float", - "description": "The mid-price between the latest bid and ask.", + "description": "The 200-day moving average.", "default": null, "optional": true }, { - "name": "open", + "name": "year_high", "type": "float", - "description": "The open price.", + "description": "The 52-week high.", "default": null, "optional": true }, { - "name": "open_bid", + "name": "year_low", "type": "float", - "description": "The opening bid price for the option that day.", + "description": "The 52-week low.", "default": null, "optional": true }, { - "name": "open_ask", - "type": "float", - "description": "The opening ask price for the option that day.", + "name": "last_rate_timestamp", + "type": "datetime", + "description": "The timestamp of the last rate.", "default": null, "optional": true - }, + } + ], + "polygon": [ { - "name": "high", + "name": "vwap", "type": "float", - "description": "The high price.", + "description": "The volume-weighted average price.", "default": null, "optional": true }, { - "name": "bid_high", + "name": "change", "type": "float", - "description": "The highest bid price for the option that day.", + "description": "The change in price from the previous day.", "default": null, "optional": true }, { - "name": "ask_high", + "name": "change_percent", "type": "float", - "description": "The highest ask price for the option that day.", + "description": "The percentage change in price from the previous day.", "default": null, "optional": true }, { - "name": "low", + "name": "prev_open", "type": "float", - "description": "The low price.", + "description": "The previous day's opening price.", "default": null, "optional": true }, { - "name": "bid_low", + "name": "prev_high", "type": "float", - "description": "The lowest bid price for the option that day.", + "description": "The previous day's high price.", "default": null, "optional": true }, { - "name": "ask_low", + "name": "prev_low", "type": "float", - "description": "The lowest ask price for the option that day.", + "description": "The previous day's low price.", "default": null, "optional": true }, { - "name": "close", + "name": "prev_volume", "type": "float", - "description": "The close price.", + "description": "The previous day's volume.", "default": null, "optional": true }, { - "name": "close_size", - "type": "int", - "description": "The closing trade size for the option that day.", + "name": "prev_vwap", + "type": "float", + "description": "The previous day's VWAP.", "default": null, "optional": true }, { - "name": "close_time", - "type": "datetime", - "description": "The time of the closing price for the option that day.", + "name": "bid", + "type": "float", + "description": "The current bid price.", "default": null, "optional": true }, { - "name": "close_bid", + "name": "ask", "type": "float", - "description": "The closing bid price for the option that day.", + "description": "The current ask price.", "default": null, "optional": true }, { - "name": "close_bid_size", - "type": "int", - "description": "The closing bid size for the option that day.", + "name": "minute_open", + "type": "float", + "description": "The open price from the most recent minute bar.", "default": null, "optional": true }, { - "name": "close_bid_time", - "type": "datetime", - "description": "The time of the bid closing price for the option that day.", + "name": "minute_high", + "type": "float", + "description": "The high price from the most recent minute bar.", "default": null, "optional": true }, { - "name": "close_ask", + "name": "minute_low", "type": "float", - "description": "The closing ask price for the option that day.", + "description": "The low price from the most recent minute bar.", "default": null, "optional": true }, { - "name": "close_ask_size", - "type": "int", - "description": "The closing ask size for the option that day.", + "name": "minute_close", + "type": "float", + "description": "The close price from the most recent minute bar.", "default": null, "optional": true }, { - "name": "close_ask_time", - "type": "datetime", - "description": "The time of the ask closing price for the option that day.", + "name": "minute_volume", + "type": "float", + "description": "The volume from the most recent minute bar.", "default": null, "optional": true }, { - "name": "prev_close", - "type": "float", - "description": "The previous close price.", - "default": null, - "optional": true - }, - { - "name": "change", - "type": "float", - "description": "The change in the price of the option.", - "default": null, - "optional": true - }, - { - "name": "change_percent", - "type": "float", - "description": "Change, in normalizezd percentage points, of the option.", - "default": null, - "optional": true - }, - { - "name": "implied_volatility", - "type": "float", - "description": "Implied volatility of the option.", - "default": null, - "optional": true - }, - { - "name": "delta", + "name": "minute_vwap", "type": "float", - "description": "Delta of the option.", + "description": "The VWAP from the most recent minute bar.", "default": null, "optional": true }, { - "name": "gamma", + "name": "minute_transactions", "type": "float", - "description": "Gamma of the option.", + "description": "The number of transactions in the most recent minute bar.", "default": null, "optional": true }, { - "name": "theta", - "type": "float", - "description": "Theta of the option.", + "name": "quote_timestamp", + "type": "datetime", + "description": "The timestamp of the last quote.", "default": null, "optional": true }, { - "name": "vega", - "type": "float", - "description": "Vega of the option.", + "name": "minute_timestamp", + "type": "datetime", + "description": "The timestamp for the start of the most recent minute bar.", "default": null, "optional": true }, { - "name": "rho", - "type": "float", - "description": "Rho of the option.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "exercise_style", - "type": "str", - "description": "The exercise style of the option, American or European.", - "default": null, - "optional": true + "name": "last_updated", + "type": "datetime", + "description": "The last time the data was updated.", + "default": "", + "optional": false } ] }, - "model": "OptionsChains" + "model": "CurrencySnapshots" }, - "/derivatives/options/unusual": { + "/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.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", + "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. (the underlying symbol)", - "default": null, - "optional": true + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { "name": "provider", - "type": "Literal['intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", + "type": "Literal['cboe', 'intrinio', 'tmx', 'tradier']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.", + "default": "cboe", "optional": true } ], - "intrinio": [ + "cboe": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format. If no symbol is supplied, requests are only allowed for a single date. Use the start_date for the target date. Intrinio appears to have data beginning Feb/2022, but is unclear when it actually began.", - "default": null, + "name": "use_cache", + "type": "bool", + "description": "When True, the company directories will be cached for24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass.", + "default": true, "optional": true - }, + } + ], + "intrinio": [ { - "name": "end_date", + "name": "date", "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format. If a symbol is not supplied, do not include an end date.", - "default": null, - "optional": true - }, - { - "name": "trade_type", - "type": "Literal['block', 'sweep', 'large']", - "description": "The type of unusual activity to query for.", - "default": null, - "optional": true - }, - { - "name": "sentiment", - "type": "Literal['bullish', 'bearish', 'neutral']", - "description": "The sentiment type to query for.", - "default": null, - "optional": true - }, - { - "name": "min_value", - "type": "Union[int, float]", - "description": "The inclusive minimum total value for the unusual activity.", + "description": "The end-of-day date for options chains data.", "default": null, "optional": true - }, + } + ], + "tmx": [ { - "name": "max_value", - "type": "Union[int, float]", - "description": "The inclusive maximum total value for the unusual activity.", + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. A typical day for all symbols will yield 50-80K records. The API will paginate at 1000 records. The high default limit (100K) is to be able to reliably capture the most days. The high absolute limit (1.25M) is to allow for outlier days. Queries at the absolute limit will take a long time, and might be unreliable. Apply filters to improve performance.", - "default": 100000, - "optional": true - }, - { - "name": "source", - "type": "Literal['delayed', 'realtime']", - "description": "The source of the data. Either realtime or delayed.", - "default": "delayed", + "name": "use_cache", + "type": "bool", + "description": "Caching is used to validate the supplied ticker symbol, or if a historical EOD chain is requested. To bypass, set to False.", + "default": true, "optional": true } - ] + ], + "tradier": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[OptionsUnusual]", + "type": "List[OptionsChains]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['intrinio']]", + "type": "Optional[Literal['cboe', 'intrinio', 'tmx', 'tradier']]", "description": "Provider name." }, { @@ -1570,9 +1640,9 @@ "data": { "standard": [ { - "name": "underlying_symbol", + "name": "symbol", "type": "str", - "description": "Symbol representing the entity requested in the data. (the underlying symbol)", + "description": "Symbol representing the entity requested in the data. Here, it is the underlying symbol for the option.", "default": null, "optional": true }, @@ -1582,539 +1652,546 @@ "description": "Contract symbol for the option.", "default": "", "optional": false - } - ], - "intrinio": [ - { - "name": "trade_timestamp", - "type": "datetime", - "description": "The datetime of order placement.", - "default": "", - "optional": false }, { - "name": "trade_type", - "type": "Literal['block', 'sweep', 'large']", - "description": "The type of unusual trade.", - "default": "", - "optional": false - }, - { - "name": "sentiment", - "type": "Literal['bullish', 'bearish', 'neutral']", - "description": "Bullish, Bearish, or Neutral Sentiment is estimated based on whether the trade was executed at the bid, ask, or mark price.", - "default": "", - "optional": false + "name": "eod_date", + "type": "date", + "description": "Date for which the options chains are returned.", + "default": null, + "optional": true }, { - "name": "bid_at_execution", - "type": "float", - "description": "Bid price at execution.", + "name": "expiration", + "type": "date", + "description": "Expiration date of the contract.", "default": "", "optional": false }, { - "name": "ask_at_execution", + "name": "strike", "type": "float", - "description": "Ask price at execution.", + "description": "Strike price of the contract.", "default": "", "optional": false }, { - "name": "average_price", - "type": "float", - "description": "The average premium paid per option contract.", + "name": "option_type", + "type": "str", + "description": "Call or Put.", "default": "", "optional": false }, { - "name": "underlying_price_at_execution", - "type": "float", - "description": "Price of the underlying security at execution of trade.", + "name": "open_interest", + "type": "int", + "description": "Open interest on the contract.", "default": null, "optional": true }, { - "name": "total_size", + "name": "volume", "type": "int", - "description": "The total number of contracts involved in a single transaction.", - "default": "", - "optional": false + "description": "The trading volume.", + "default": null, + "optional": true }, { - "name": "total_value", - "type": "Union[int, float]", - "description": "The aggregated value of all option contract premiums included in the trade.", - "default": "", - "optional": false - } - ] - }, - "model": "OptionsUnusual" - }, - "/derivatives/futures/historical": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Historical futures prices.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.derivatives.futures.historical(symbol='ES', provider='yfinance')\n# Enter multiple symbols.\nobb.derivatives.futures.historical(symbol='ES,NQ', provider='yfinance')\n# Enter expiration dates as \"YYYY-MM\".\nobb.derivatives.futures.historical(symbol='ES', provider='yfinance', expiration='2025-12')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", - "default": "", - "optional": false + "name": "theoretical_price", + "type": "float", + "description": "Theoretical value of the option.", + "default": null, + "optional": true }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "last_trade_price", + "type": "float", + "description": "Last trade price of the option.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "tick", + "type": "str", + "description": "Whether the last tick was up or down in price.", "default": null, "optional": true }, { - "name": "expiration", - "type": "str", - "description": "Future expiry date with format YYYY-MM", + "name": "bid", + "type": "float", + "description": "Current bid price for the option.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default.", - "default": "yfinance", + "name": "bid_size", + "type": "int", + "description": "Bid size for the option.", + "default": null, "optional": true - } - ], - "yfinance": [ + }, { - "name": "interval", - "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", - "description": "Time interval of the data to return.", - "default": "1d", + "name": "ask", + "type": "float", + "description": "Current ask price for the option.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[FuturesHistorical]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['yfinance']]", - "description": "Provider name." + "name": "ask_size", + "type": "int", + "description": "Ask size for the option.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "mark", + "type": "float", + "description": "The mid-price between the latest bid and ask.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "open", + "type": "float", + "description": "The open price.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "datetime", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "open_bid", + "type": "float", + "description": "The opening bid price for the option that day.", + "default": null, + "optional": true }, { - "name": "open", + "name": "open_ask", "type": "float", - "description": "The open price.", - "default": "", - "optional": false + "description": "The opening ask price for the option that day.", + "default": null, + "optional": true }, { "name": "high", "type": "float", "description": "The high price.", - "default": "", - "optional": false + "default": null, + "optional": true }, { - "name": "low", + "name": "bid_high", "type": "float", - "description": "The low price.", - "default": "", - "optional": false + "description": "The highest bid price for the option that day.", + "default": null, + "optional": true }, { - "name": "close", + "name": "ask_high", "type": "float", - "description": "The close price.", - "default": "", - "optional": false + "description": "The highest ask price for the option that day.", + "default": null, + "optional": true }, { - "name": "volume", + "name": "low", "type": "float", - "description": "The trading volume.", - "default": "", - "optional": false - } - ], - "yfinance": [] - }, - "model": "FuturesHistorical" - }, - "/derivatives/futures/curve": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Futures Term Structure, current or historical.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Enter a date to get the term structure from a historical date.\nobb.derivatives.futures.curve(symbol='NG', provider='yfinance', date='2023-01-01')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false + "description": "The low price.", + "default": null, + "optional": true }, { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", + "name": "bid_low", + "type": "float", + "description": "The lowest bid price for the option that day.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default.", - "default": "yfinance", + "name": "ask_low", + "type": "float", + "description": "The lowest ask price for the option that day.", + "default": null, "optional": true - } - ], - "yfinance": [] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[FuturesCurve]", - "description": "Serializable results." + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['yfinance']]", - "description": "Provider name." + "name": "close_size", + "type": "int", + "description": "The closing trade size for the option that day.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "close_time", + "type": "datetime", + "description": "The time of the closing price for the option that day.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "close_bid", + "type": "float", + "description": "The closing bid price for the option that day.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "close_bid_size", + "type": "int", + "description": "The closing bid size for the option that day.", + "default": null, + "optional": true + }, { - "name": "expiration", - "type": "str", - "description": "Futures expiration month.", - "default": "", - "optional": false + "name": "close_bid_time", + "type": "datetime", + "description": "The time of the bid closing price for the option that day.", + "default": null, + "optional": true }, { - "name": "price", + "name": "close_ask", "type": "float", - "description": "The close price.", + "description": "The closing ask price for the option that day.", "default": null, "optional": true - } - ], - "yfinance": [] - }, - "model": "FuturesCurve" - }, - "/economy/gdp/forecast": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get Forecasted GDP Data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.gdp.forecast(provider='oecd')\nobb.economy.gdp.forecast(period='annual', type='real', provider='oecd')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "period", - "type": "Literal['quarter', 'annual']", - "description": "Time period of the data to return. Units for nominal GDP period. Either quarter or annual.", - "default": "annual", + "name": "close_ask_size", + "type": "int", + "description": "The closing ask size for the option that day.", + "default": null, "optional": true }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "close_ask_time", + "type": "datetime", + "description": "The time of the ask closing price for the option that day.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "prev_close", + "type": "float", + "description": "The previous close price.", "default": null, "optional": true }, { - "name": "type", - "type": "Literal['nominal', 'real']", - "description": "Type of GDP to get forecast of. Either nominal or real.", - "default": "real", + "name": "change", + "type": "float", + "description": "The change in the price of the option.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['oecd']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default.", - "default": "oecd", + "name": "change_percent", + "type": "float", + "description": "Change, in normalizezd percentage points, of the option.", + "default": null, "optional": true - } - ], - "oecd": [ + }, { - "name": "country", - "type": "Literal['argentina', 'asia', 'australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'colombia', 'costa_rica', 'croatia', 'czech_republic', 'denmark', 'estonia', 'euro_area_17', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'india', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'non-oecd', 'norway', 'oecd_total', 'peru', 'poland', 'portugal', 'romania', 'russia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'world']", - "description": "Country to get GDP for.", - "default": "united_states", + "name": "implied_volatility", + "type": "float", + "description": "Implied volatility of the option.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[GdpForecast]", - "description": "Serializable results." + "name": "delta", + "type": "float", + "description": "Delta of the option.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['oecd']]", - "description": "Provider name." + "name": "gamma", + "type": "float", + "description": "Gamma of the option.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "theta", + "type": "float", + "description": "Theta of the option.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "vega", + "type": "float", + "description": "Vega of the option.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "rho", + "type": "float", + "description": "Rho of the option.", + "default": null, + "optional": true } - ] - }, - "data": { - "standard": [ + ], + "cboe": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "last_trade_timestamp", + "type": "datetime", + "description": "Last trade timestamp of the option.", "default": null, "optional": true }, { - "name": "value", - "type": "float", - "description": "Nominal GDP value on the date.", + "name": "dte", + "type": "int", + "description": "Days to expiration for the option.", + "default": "", + "optional": false + } + ], + "intrinio": [ + { + "name": "exercise_style", + "type": "str", + "description": "The exercise style of the option, American or European.", "default": null, "optional": true } ], - "oecd": [] - }, - "model": "GdpForecast" - }, - "/economy/gdp/nominal": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get Nominal GDP Data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.gdp.nominal(provider='oecd')\nobb.economy.gdp.nominal(units='usd', provider='oecd')\n```\n\n", - "parameters": { - "standard": [ + "tmx": [ { - "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", + "name": "transactions", + "type": "int", + "description": "Number of transactions for the contract.", + "default": null, "optional": true }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "total_value", + "type": "float", + "description": "Total value of the transactions.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "settlement_price", + "type": "float", + "description": "Settlement price on that date.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['oecd']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default.", - "default": "oecd", + "name": "underlying_price", + "type": "float", + "description": "Price of the underlying stock on that date.", + "default": null, + "optional": true + }, + { + "name": "dte", + "type": "int", + "description": "Days to expiration for the option.", + "default": null, "optional": true } ], - "oecd": [ + "tradier": [ { - "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", + "name": "phi", + "type": "float", + "description": "Phi of the option. The sensitivity of the option relative to dividend yield.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[GdpNominal]", - "description": "Serializable results." + "name": "bid_iv", + "type": "float", + "description": "Implied volatility of the bid price.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['oecd']]", - "description": "Provider name." + "name": "ask_iv", + "type": "float", + "description": "Implied volatility of the ask price.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "orats_final_iv", + "type": "float", + "description": "ORATS final implied volatility of the option, updated once per hour.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "year_high", + "type": "float", + "description": "52-week high price of the option.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "year_low", + "type": "float", + "description": "52-week low price of the option.", + "default": null, + "optional": true + }, { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "last_trade_volume", + "type": "int", + "description": "Volume of the last trade.", "default": null, "optional": true }, { - "name": "value", - "type": "float", - "description": "Nominal GDP value on the date.", + "name": "dte", + "type": "int", + "description": "Days to expiration.", + "default": null, + "optional": true + }, + { + "name": "contract_size", + "type": "int", + "description": "Size of the contract.", + "default": null, + "optional": true + }, + { + "name": "bid_exchange", + "type": "str", + "description": "Exchange of the bid price.", + "default": null, + "optional": true + }, + { + "name": "bid_timestamp", + "type": "datetime", + "description": "Timestamp of the bid price.", + "default": null, + "optional": true + }, + { + "name": "ask_exchange", + "type": "str", + "description": "Exchange of the ask price.", + "default": null, + "optional": true + }, + { + "name": "ask_timestamp", + "type": "datetime", + "description": "Timestamp of the ask price.", + "default": null, + "optional": true + }, + { + "name": "greeks_timestamp", + "type": "datetime", + "description": "Timestamp of the last greeks update. Greeks/IV data is updated once per hour.", + "default": null, + "optional": true + }, + { + "name": "last_trade_timestamp", + "type": "datetime", + "description": "Timestamp of the last trade.", "default": null, "optional": true } - ], - "oecd": [] + ] }, - "model": "GdpNominal" + "model": "OptionsChains" }, - "/economy/gdp/real": { + "/derivatives/options/unusual": { "deprecated": { "flag": null, "message": null }, - "description": "Get Real GDP Data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.gdp.real(provider='oecd')\nobb.economy.gdp.real(units='yoy', provider='oecd')\n```\n\n", + "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": "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", + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (the underlying symbol)", + "default": null, "optional": true }, + { + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", + "optional": true + } + ], + "intrinio": [ { "name": "start_date", "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "description": "Start date of the data, in YYYY-MM-DD format. If no symbol is supplied, requests are only allowed for a single date. Use the start_date for the target date. Intrinio appears to have data beginning Feb/2022, but is unclear when it actually began.", "default": null, "optional": true }, { "name": "end_date", "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "description": "End date of the data, in YYYY-MM-DD format. If a symbol is not supplied, do not include an end date.", "default": null, "optional": true }, { - "name": "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", + "name": "trade_type", + "type": "Literal['block', 'sweep', 'large']", + "description": "The type of unusual activity to query for.", + "default": null, "optional": true - } - ], - "oecd": [ + }, { - "name": "country", - "type": "Literal['G20', 'G7', 'argentina', 'australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'colombia', 'costa_rica', 'croatia', 'czech_republic', 'denmark', 'estonia', 'euro_area_19', 'europe', 'european_union_27', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'india', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'norway', 'oecd_total', 'poland', 'portugal', 'romania', 'russia', 'saudi_arabia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'all']", - "description": "Country to get GDP for.", - "default": "united_states", + "name": "sentiment", + "type": "Literal['bullish', 'bearish', 'neutral']", + "description": "The sentiment type to query for.", + "default": null, + "optional": true + }, + { + "name": "min_value", + "type": "Union[int, float]", + "description": "The inclusive minimum total value for the unusual activity.", + "default": null, + "optional": true + }, + { + "name": "max_value", + "type": "Union[int, float]", + "description": "The inclusive maximum total value for the unusual activity.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return. A typical day for all symbols will yield 50-80K records. The API will paginate at 1000 records. The high default limit (100K) is to be able to reliably capture the most days. The high absolute limit (1.25M) is to allow for outlier days. Queries at the absolute limit will take a long time, and might be unreliable. Apply filters to improve performance.", + "default": 100000, + "optional": true + }, + { + "name": "source", + "type": "Literal['delayed', 'realtime']", + "description": "The source of the data. Either realtime or delayed.", + "default": "delayed", "optional": true } ] @@ -2123,12 +2200,12 @@ "OBBject": [ { "name": "results", - "type": "List[GdpReal]", + "type": "List[OptionsUnusual]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['oecd']]", + "type": "Optional[Literal['intrinio']]", "description": "Provider name." }, { @@ -2151,33 +2228,104 @@ "data": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "underlying_symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. (the underlying symbol)", "default": null, "optional": true }, { - "name": "value", + "name": "contract_symbol", + "type": "str", + "description": "Contract symbol for the option.", + "default": "", + "optional": false + } + ], + "intrinio": [ + { + "name": "trade_timestamp", + "type": "datetime", + "description": "The datetime of order placement.", + "default": "", + "optional": false + }, + { + "name": "trade_type", + "type": "Literal['block', 'sweep', 'large']", + "description": "The type of unusual trade.", + "default": "", + "optional": false + }, + { + "name": "sentiment", + "type": "Literal['bullish', 'bearish', 'neutral']", + "description": "Bullish, Bearish, or Neutral Sentiment is estimated based on whether the trade was executed at the bid, ask, or mark price.", + "default": "", + "optional": false + }, + { + "name": "bid_at_execution", "type": "float", - "description": "Nominal GDP value on the date.", + "description": "Bid price at execution.", + "default": "", + "optional": false + }, + { + "name": "ask_at_execution", + "type": "float", + "description": "Ask price at execution.", + "default": "", + "optional": false + }, + { + "name": "average_price", + "type": "float", + "description": "The average premium paid per option contract.", + "default": "", + "optional": false + }, + { + "name": "underlying_price_at_execution", + "type": "float", + "description": "Price of the underlying security at execution of trade.", "default": null, "optional": true + }, + { + "name": "total_size", + "type": "int", + "description": "The total number of contracts involved in a single transaction.", + "default": "", + "optional": false + }, + { + "name": "total_value", + "type": "Union[int, float]", + "description": "The aggregated value of all option contract premiums included in the trade.", + "default": "", + "optional": false } - ], - "oecd": [] + ] }, - "model": "GdpReal" + "model": "OptionsUnusual" }, - "/economy/calendar": { + "/derivatives/futures/historical": { "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", + "description": "Historical futures prices.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.derivatives.futures.historical(symbol='ES', provider='yfinance')\n# Enter multiple symbols.\nobb.derivatives.futures.historical(symbol='ES,NQ', provider='yfinance')\n# Enter expiration dates as \"YYYY-MM\".\nobb.derivatives.futures.historical(symbol='ES', provider='yfinance', expiration='2025-12')\n```\n\n", "parameters": { "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": "", + "optional": false + }, { "name": "start_date", "type": "Union[date, str]", @@ -2193,34 +2341,26 @@ "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'tradingeconomics']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [], - "tradingeconomics": [ - { - "name": "country", - "type": "Union[str, List[str]]", - "description": "Country of the event. Multiple items allowed for provider(s): tradingeconomics.", + "name": "expiration", + "type": "str", + "description": "Future expiry date with format YYYY-MM", "default": null, "optional": true }, { - "name": "importance", - "type": "Literal['Low', 'Medium', 'High']", - "description": "Importance of the event.", - "default": null, + "name": "provider", + "type": "Literal['yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default.", + "default": "yfinance", "optional": true - }, + } + ], + "yfinance": [ { - "name": "group", - "type": "Literal['interest rate', 'inflation', 'bonds', 'consumer', 'gdp', 'government', 'housing', 'labour', 'markets', 'money', 'prices', 'trade', 'business']", - "description": "Grouping of events", - "default": null, + "name": "interval", + "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", + "description": "Time interval of the data to return.", + "default": "1d", "optional": true } ] @@ -2229,12 +2369,12 @@ "OBBject": [ { "name": "results", - "type": "List[EconomicCalendar]", + "type": "List[FuturesHistorical]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'tradingeconomics']]", + "type": "Optional[Literal['yfinance']]", "description": "Provider name." }, { @@ -2260,206 +2400,93 @@ "name": "date", "type": "datetime", "description": "The date of the data.", - "default": null, - "optional": true + "default": "", + "optional": false }, { - "name": "country", - "type": "str", - "description": "Country of event.", - "default": null, - "optional": true + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false }, { - "name": "event", - "type": "str", - "description": "Event name.", - "default": null, - "optional": true + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false }, { - "name": "reference", - "type": "str", - "description": "Abbreviated period for which released data refers to.", - "default": null, - "optional": true + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false }, { - "name": "source", - "type": "str", - "description": "Source of the data.", - "default": null, - "optional": true + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false }, { - "name": "sourceurl", + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false + } + ], + "yfinance": [] + }, + "model": "FuturesHistorical" + }, + "/derivatives/futures/curve": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Futures Term Structure, current or historical.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.derivatives.futures.curve(symbol='VX', provider='cboe')\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": "Source URL.", - "default": null, - "optional": true - }, - { - "name": "actual", - "type": "Union[str, float]", - "description": "Latest released value.", - "default": null, - "optional": true - }, - { - "name": "previous", - "type": "Union[str, float]", - "description": "Value for the previous period after the revision (if revision is applicable).", - "default": null, - "optional": true - }, - { - "name": "consensus", - "type": "Union[str, float]", - "description": "Average forecast among a representative group of economists.", - "default": null, - "optional": true - }, - { - "name": "forecast", - "type": "Union[str, float]", - "description": "Trading Economics projections", - "default": null, - "optional": true - }, - { - "name": "url", - "type": "str", - "description": "Trading Economics URL", - "default": null, - "optional": true - }, - { - "name": "importance", - "type": "Union[Literal[0, 1, 2, 3], str]", - "description": "Importance of the event. 1-Low, 2-Medium, 3-High", - "default": null, - "optional": true - }, - { - "name": "currency", - "type": "str", - "description": "Currency of the data.", - "default": null, - "optional": true - }, - { - "name": "unit", - "type": "str", - "description": "Unit of the data.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "change", - "type": "float", - "description": "Value change since previous.", - "default": null, - "optional": true - }, - { - "name": "change_percent", - "type": "float", - "description": "Percentage change since previous.", - "default": null, - "optional": true - }, - { - "name": "updated_at", - "type": "datetime", - "description": "Last updated timestamp.", - "default": null, - "optional": true - }, - { - "name": "created_at", - "type": "datetime", - "description": "Created at timestamp.", - "default": null, - "optional": true - } - ], - "tradingeconomics": [] - }, - "model": "EconomicCalendar" - }, - "/economy/cpi": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get Consumer Price Index (CPI).\n\nReturns either the rescaled index value, or a rate of change (inflation).", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.cpi(country='japan,china,turkey', provider='fred')\n# Use the `units` parameter to define the reference period for the change in values.\nobb.economy.cpi(country='united_states,united_kingdom', units='growth_previous', provider='fred')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "country", - "type": "Union[str, List[str]]", - "description": "The country to get data. Multiple items allowed for provider(s): fred.", - "default": "", - "optional": false - }, - { - "name": "units", - "type": "Literal['growth_previous', 'growth_same', 'index_2015']", - "description": "The unit of measurement for the data. Options: - `growth_previous`: Percent growth from the previous period. If monthly data, this is month-over-month, etc - `growth_same`: Percent growth from the same period in the previous year. If looking at monthly data, this would be year-over-year, etc. - `index_2015`: Rescaled index value, such that the value in 2015 is 100.", - "default": "growth_same", - "optional": true - }, - { - "name": "frequency", - "type": "Literal['monthly', 'quarter', 'annual']", - "description": "The frequency of the data. Options: `monthly`, `quarter`, and `annual`.", - "default": "monthly", - "optional": true - }, - { - "name": "harmonized", - "type": "bool", - "description": "Whether you wish to obtain harmonized data.", - "default": false, - "optional": true - }, - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", "default": null, "optional": true }, { "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "type": "Literal['cboe', 'yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.", + "default": "cboe", "optional": true } ], - "fred": [] + "cboe": [], + "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[ConsumerPriceIndex]", + "type": "List[FuturesCurve]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fred']]", + "type": "Optional[Literal['cboe', 'yfinance']]", "description": "Provider name." }, { @@ -2482,187 +2509,231 @@ "data": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "expiration", + "type": "str", + "description": "Futures expiration month.", + "default": "", + "optional": false + }, + { + "name": "price", + "type": "float", + "description": "The close price.", + "default": null, + "optional": true + } + ], + "cboe": [ + { + "name": "symbol", + "type": "str", + "description": "The trading symbol for the tenor of future.", "default": "", "optional": false } ], - "fred": [] + "yfinance": [] }, - "model": "ConsumerPriceIndex" + "model": "FuturesCurve" }, - "/economy/risk_premium": { + "/econometrics/correlation_matrix": { "deprecated": { "flag": null, "message": null }, - "description": "Get Market Risk Premium by country.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.risk_premium(provider='fmp')\n```\n\n", + "description": "Get the correlation matrix of an input dataset.\n\n The correlation matrix provides a view of how different variables in your dataset relate to one another.\n By quantifying the degree to which variables move in relation to each other, this matrix can help identify patterns,\n trends, and potential areas for deeper analysis. The correlation score ranges from -1 to 1, with -1 indicating a\n perfect negative correlation, 0 indicating no correlation, and 1 indicating a perfect positive correlation.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the correlation matrix of a dataset.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.econometrics.correlation_matrix(data=stock_data)\nobb.econometrics.correlation_matrix(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", "parameters": { "standard": [ { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true + "name": "data", + "type": "List[Data]", + "description": "Input dataset.", + "default": "", + "optional": false } - ], - "fmp": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[RiskPremium]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "type": "List[Data]", + "description": "Correlation matrix." } ] }, - "data": { + "data": {}, + "model": "" + }, + "/econometrics/ols_regression": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Perform Ordinary Least Squares (OLS) regression.\n\n OLS regression is a fundamental statistical method to explore and model the relationship between a\n dependent variable and one or more independent variables. By fitting the best possible linear equation to the data,\n it helps uncover how changes in the independent variables are associated with changes in the dependent variable.\n This returns the model and results objects from statsmodels library.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Perform Ordinary Least Squares (OLS) regression.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.econometrics.ols_regression(data=stock_data, y_column=\"close\", x_columns=[\"open\", \"high\", \"low\"])\nobb.econometrics.ols_regression(y_column='close', x_columns=['open', 'high', 'low'], data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { "standard": [ { - "name": "country", - "type": "str", - "description": "Market country.", + "name": "data", + "type": "List[Data]", + "description": "Input dataset.", "default": "", "optional": false }, { - "name": "continent", + "name": "y_column", "type": "str", - "description": "Continent of the country.", - "default": null, - "optional": true + "description": "Target column.", + "default": "", + "optional": false }, { - "name": "total_equity_risk_premium", - "type": "Annotated[float, Gt(gt=0)]", - "description": "Total equity risk premium for the country.", - "default": null, - "optional": true - }, + "name": "x_columns", + "type": "List[str]", + "description": "List of columns to use as exogenous variables.", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ { - "name": "country_risk_premium", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Country-specific risk premium.", - "default": null, - "optional": true + "name": "results", + "type": "Dict", + "description": "OBBject with the results being model and results objects." } - ], - "fmp": [] + ] }, - "model": "RiskPremium" + "data": {}, + "model": "" }, - "/economy/fred_search": { + "/econometrics/ols_regression_summary": { "deprecated": { "flag": null, "message": null }, - "description": "Search for FRED series or economic releases by ID or string.\n\nThis does not return the observation values, only the metadata.\nUse this function to find series IDs for `fred_series()`.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.fred_search(provider='fred')\n```\n\n", + "description": "Perform Ordinary Least Squares (OLS) regression.\n\n This returns the summary object from statsmodels.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Perform Ordinary Least Squares (OLS) regression and return the summary.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.econometrics.ols_regression_summary(data=stock_data, y_column=\"close\", x_columns=[\"open\", \"high\", \"low\"])\nobb.econometrics.ols_regression_summary(y_column='close', x_columns=['open', 'high', 'low'], data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", "parameters": { "standard": [ { - "name": "query", + "name": "data", + "type": "List[Data]", + "description": "Input dataset.", + "default": "", + "optional": false + }, + { + "name": "y_column", "type": "str", - "description": "The search word(s).", - "default": null, - "optional": true + "description": "Target column.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", - "optional": true + "name": "x_columns", + "type": "List[str]", + "description": "List of columns to use as exogenous variables.", + "default": "", + "optional": false } - ], - "fred": [ + ] + }, + "returns": { + "OBBject": [ { - "name": "is_release", - "type": "bool", - "description": "Is release? If True, other search filter variables are ignored. If no query text or release_id is supplied, this defaults to True.", - "default": false, - "optional": true - }, + "name": "results", + "type": "Data", + "description": "OBBject with the results being summary object." + } + ] + }, + "data": {}, + "model": "" + }, + "/econometrics/autocorrelation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Perform Durbin-Watson test for autocorrelation.\n\n The Durbin-Watson test is a widely used method for detecting the presence of autocorrelation in the residuals\n from a statistical or econometric model. Autocorrelation occurs when past values in the data series influence\n future values, which can be a critical issue in time-series analysis, affecting the reliability of\n model predictions. The test provides a statistic that ranges from 0 to 4, where a value around 2 suggests\n no autocorrelation, values towards 0 indicate positive autocorrelation, and values towards 4 suggest\n negative autocorrelation. Understanding the degree of autocorrelation helps in refining models to better capture\n the underlying dynamics of the data, ensuring more accurate and trustworthy results.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Perform Durbin-Watson test for autocorrelation.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.econometrics.autocorrelation(data=stock_data, y_column=\"close\", x_columns=[\"open\", \"high\", \"low\"])\nobb.econometrics.autocorrelation(y_column='close', x_columns=['open', 'high', 'low'], data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ { - "name": "release_id", - "type": "Union[int, str]", - "description": "A specific release ID to target.", - "default": null, - "optional": true + "name": "data", + "type": "List[Data]", + "description": "Input dataset.", + "default": "", + "optional": false }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. (1-1000)", - "default": null, - "optional": true + "name": "y_column", + "type": "str", + "description": "Target column.", + "default": "", + "optional": false }, { - "name": "offset", - "type": "Annotated[int, Ge(ge=0)]", - "description": "Offset the results in conjunction with limit.", - "default": 0, - "optional": true - }, + "name": "x_columns", + "type": "List[str]", + "description": "List of columns to use as exogenous variables.", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ { - "name": "filter_variable", - "type": "Literal['frequency', 'units', 'seasonal_adjustment']", - "description": "Filter by an attribute.", - "default": null, - "optional": true - }, + "name": "results", + "type": "Dict", + "description": "OBBject with the results being the score from the test." + } + ] + }, + "data": {}, + "model": "" + }, + "/econometrics/residual_autocorrelation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Perform Breusch-Godfrey Lagrange Multiplier tests for residual autocorrelation.\n\n The Breusch-Godfrey Lagrange Multiplier test is a sophisticated tool for uncovering autocorrelation within the\n residuals of a regression model. Autocorrelation in residuals can indicate that a model fails to capture some\n aspect of the underlying data structure, possibly leading to biased or inefficient estimates.\n By specifying the number of lags, you can control the depth of the test to check for autocorrelation,\n allowing for a tailored analysis that matches the specific characteristics of your data.\n This test is particularly valuable in econometrics and time-series analysis, where understanding the independence\n of errors is crucial for model validity.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Perform Breusch-Godfrey Lagrange Multiplier tests for residual autocorrelation.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.econometrics.residual_autocorrelation(data=stock_data, y_column=\"close\", x_columns=[\"open\", \"high\", \"low\"])\nobb.econometrics.residual_autocorrelation(y_column='close', x_columns=['open', 'high', 'low'], data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ { - "name": "filter_value", - "type": "str", - "description": "String value to filter the variable by. Used in conjunction with filter_variable.", - "default": null, - "optional": true + "name": "data", + "type": "List[Data]", + "description": "Input dataset.", + "default": "", + "optional": false }, { - "name": "tag_names", + "name": "y_column", "type": "str", - "description": "A semicolon delimited list of tag names that series match all of. Example: 'japan;imports'", - "default": null, - "optional": true + "description": "Target column.", + "default": "", + "optional": 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": null, - "optional": true + "name": "x_columns", + "type": "List[str]", + "description": "List of columns to use as exogenous variables.", + "default": "", + "optional": 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": null, - "optional": true + "name": "lags", + "type": "PositiveInt", + "description": "Number of lags to use in the test.", + "default": "", + "optional": false } ] }, @@ -2670,194 +2741,432 @@ "OBBject": [ { "name": "results", - "type": "List[FredSearch]", - "description": "Serializable results." - }, + "type": "Data", + "description": "OBBject with the results being the score from the test." + } + ] + }, + "data": {}, + "model": "" + }, + "/econometrics/cointegration": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Show co-integration between two timeseries using the two step Engle-Granger test.\n\n The two-step Engle-Granger test is a method designed to detect co-integration between two time series.\n Co-integration is a statistical property indicating that two or more time series move together over the long term,\n even if they are individually non-stationary. This concept is crucial in economics and finance, where identifying\n pairs or groups of assets that share a common stochastic trend can inform long-term investment strategies\n and risk management practices. The Engle-Granger test first checks for a stable, long-term relationship by\n regressing one time series on the other and then tests the residuals for stationarity.\n If the residuals are found to be stationary, it suggests that despite any short-term deviations,\n the series are bound by an equilibrium relationship over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Perform co-integration test between two timeseries.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.econometrics.cointegration(data=stock_data, columns=[\"open\", \"close\"])\n```\n\n", + "parameters": { + "standard": [ { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." + "name": "data", + "type": "List[Data]", + "description": "Input dataset.", + "default": "", + "optional": false }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "columns", + "type": "List[str]", + "description": "Data columns to check cointegration", + "default": "", + "optional": false }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, + "name": "maxlag", + "type": "PositiveInt", + "description": "Number of lags to use in the test.", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "results", + "type": "Data", + "description": "OBBject with the results being the score from the test." } ] }, - "data": { + "data": {}, + "model": "" + }, + "/econometrics/causality": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Perform Granger causality test to determine if X 'causes' y.\n\n The Granger causality test is a statistical hypothesis test to determine if one time series is useful in\n forecasting another. While 'causality' in this context does not imply a cause-and-effect relationship in\n the philosophical sense, it does test whether changes in one variable are systematically followed by changes\n in another variable, suggesting a predictive relationship. By specifying a lag, you set the number of periods to\n look back in the time series to assess this relationship. This test is particularly useful in economic and\n financial data analysis, where understanding the lead-lag relationship between indicators can inform investment\n decisions and policy making.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Perform Granger causality test to determine if X 'causes' y.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.econometrics.causality(data=stock_data, y_column=\"close\", x_column=\"open\")\n# Example with mock data.\nobb.econometrics.causality(y_column='close', x_column='open', lag=1, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { "standard": [ { - "name": "release_id", - "type": "Union[int, str]", - "description": "The release ID for queries.", - "default": null, - "optional": true + "name": "data", + "type": "List[Data]", + "description": "Input dataset.", + "default": "", + "optional": false }, { - "name": "series_id", + "name": "y_column", "type": "str", - "description": "The series ID for the item in the release.", - "default": null, - "optional": true + "description": "Target column.", + "default": "", + "optional": false }, { - "name": "name", + "name": "x_column", "type": "str", - "description": "The name of the release.", - "default": null, - "optional": true + "description": "Columns to use as exogenous variables.", + "default": "", + "optional": false }, { - "name": "title", - "type": "str", - "description": "The title of the series.", - "default": null, - "optional": true - }, + "name": "lag", + "type": "PositiveInt", + "description": "Number of lags to use in the test.", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ { - "name": "observation_start", - "type": "date", - "description": "The date of the first observation in the series.", - "default": null, - "optional": true - }, + "name": "results", + "type": "Data", + "description": "OBBject with the results being the score from the test." + } + ] + }, + "data": {}, + "model": "" + }, + "/econometrics/unit_root": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Perform Augmented Dickey-Fuller (ADF) unit root test.\n\n The ADF test is a popular method for testing the presence of a unit root in a time series.\n A unit root indicates that the series may be non-stationary, meaning its statistical properties such as mean,\n variance, and autocorrelation can change over time. The presence of a unit root suggests that the time series might\n be influenced by a random walk process, making it unpredictable and challenging for modeling and forecasting.\n The 'regression' parameter allows you to specify the model used in the test: 'c' for a constant term,\n 'ct' for a constant and trend term, and 'ctt' for a constant, linear, and quadratic trend.\n This flexibility helps tailor the test to the specific characteristics of your data, providing a more accurate\n assessment of its stationarity.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Perform Augmented Dickey-Fuller (ADF) unit root test.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.econometrics.unit_root(data=stock_data, column=\"close\")\nobb.econometrics.unit_root(data=stock_data, column=\"close\", regression=\"ct\")\nobb.econometrics.unit_root(column='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ { - "name": "observation_end", - "type": "date", - "description": "The date of the last observation in the series.", - "default": null, - "optional": true + "name": "data", + "type": "List[Data]", + "description": "Input dataset.", + "default": "", + "optional": false }, { - "name": "frequency", + "name": "column", "type": "str", - "description": "The frequency of the data.", - "default": null, - "optional": true + "description": "Data columns to check unit root", + "default": "", + "optional": false }, { - "name": "frequency_short", - "type": "str", - "description": "Short form of the data frequency.", - "default": null, - "optional": true - }, + "name": "regression", + "type": "Literal[\"c\", \"ct\", \"ctt\"]", + "description": "Regression type to use in the test. Either \"c\" for constant only, \"ct\" for constant and trend, or \"ctt\" for", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ { - "name": "units", - "type": "str", - "description": "The units of the data.", - "default": null, - "optional": true + "name": "results", + "type": "Data", + "description": "OBBject with the results being the score from the test." + } + ] + }, + "data": {}, + "model": "" + }, + "/econometrics/panel_random_effects": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Perform One-way Random Effects model for panel data.\n\n One-way Random Effects model to panel data is offering a nuanced approach to analyzing data that spans across both\n time and entities (such as individuals, companies, countries, etc.). By acknowledging and modeling the random\n variation that exists within these entities, this method provides insights into the general patterns that\n emerge across the dataset.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.panel_random_effects(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "List[Data]", + "description": "Input dataset.", + "default": "", + "optional": false }, { - "name": "units_short", + "name": "y_column", "type": "str", - "description": "Short form of the data units.", - "default": null, - "optional": true + "description": "Target column.", + "default": "", + "optional": false }, { - "name": "seasonal_adjustment", - "type": "str", - "description": "The seasonal adjustment of the data.", - "default": null, - "optional": true + "name": "x_columns", + "type": "List[str]", + "description": "List of columns to use as exogenous variables.", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Dict", + "description": "OBBject with the fit model returned" + } + ] + }, + "data": {}, + "model": "" + }, + "/econometrics/panel_between": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Perform a Between estimator regression on panel data.\n\n The Between estimator for regression analysis on panel data is focusing on the differences between entities\n (such as individuals, companies, or countries) over time. By aggregating the data for each entity and analyzing the\n average outcomes, this method provides insights into the overall impact of explanatory variables (x_columns) on\n the dependent variable (y_column) across all entities.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.panel_between(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "List[Data]", + "description": "Input dataset.", + "default": "", + "optional": false }, { - "name": "seasonal_adjustment_short", + "name": "y_column", "type": "str", - "description": "Short form of the data seasonal adjustment.", - "default": null, - "optional": true + "description": "Target column.", + "default": "", + "optional": false }, { - "name": "last_updated", - "type": "datetime", - "description": "The datetime of the last update to the data.", - "default": null, - "optional": true + "name": "x_columns", + "type": "List[str]", + "description": "List of columns to use as exogenous variables.", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Dict", + "description": "OBBject with the fit model returned" + } + ] + }, + "data": {}, + "model": "" + }, + "/econometrics/panel_pooled": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Perform a Pooled coefficient estimator regression on panel data.\n\n The Pooled coefficient estimator for regression analysis on panel data is treating the data as a large\n cross-section without distinguishing between variations across time or entities\n (such as individuals, companies, or countries). By assuming that the explanatory variables (x_columns) have a\n uniform effect on the dependent variable (y_column) across all entities and time periods, this method simplifies\n the analysis and provides a generalized view of the relationships within the data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.panel_pooled(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "List[Data]", + "description": "Input dataset.", + "default": "", + "optional": false }, { - "name": "notes", + "name": "y_column", "type": "str", - "description": "Description of the release.", - "default": null, - "optional": true + "description": "Target column.", + "default": "", + "optional": false }, { - "name": "press_release", - "type": "bool", - "description": "If the release is a press release.", - "default": null, - "optional": true + "name": "x_columns", + "type": "List[str]", + "description": "List of columns to use as exogenous variables.", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Dict", + "description": "OBBject with the fit model returned" + } + ] + }, + "data": {}, + "model": "" + }, + "/econometrics/panel_fixed": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "One- and two-way fixed effects estimator for panel data.\n\n The Fixed Effects estimator to panel data is enabling a focused analysis on the unique characteristics of entities\n (such as individuals, companies, or countries) and/or time periods. By controlling for entity-specific and/or\n time-specific influences, this method isolates the effect of explanatory variables (x_columns) on the dependent\n variable (y_column), under the assumption that these entity or time effects capture unobserved heterogeneity.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.panel_fixed(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "List[Data]", + "description": "Input dataset.", + "default": "", + "optional": false }, { - "name": "url", + "name": "y_column", "type": "str", - "description": "URL to the release.", - "default": null, - "optional": true + "description": "Target column.", + "default": "", + "optional": false + }, + { + "name": "x_columns", + "type": "List[str]", + "description": "List of columns to use as exogenous variables.", + "default": "", + "optional": false } - ], - "fred": [ + ] + }, + "returns": { + "OBBject": [ { - "name": "popularity", - "type": "int", - "description": "Popularity of the series", - "default": null, - "optional": true - }, + "name": "results", + "type": "Dict", + "description": "OBBject with the fit model returned" + } + ] + }, + "data": {}, + "model": "" + }, + "/econometrics/panel_first_difference": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Perform a first-difference estimate for panel data.\n\n The First-Difference estimator for panel data analysis is focusing on the changes between consecutive observations\n for each entity (such as individuals, companies, or countries). By differencing the data, this method effectively\n removes entity-specific effects that are constant over time, allowing for the examination of the impact of changes\n in explanatory variables (x_columns) on the change in the dependent variable (y_column).", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.panel_first_difference(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}])\n```\n\n", + "parameters": { + "standard": [ { - "name": "group_popularity", - "type": "int", - "description": "Group popularity of the release", - "default": null, - "optional": true + "name": "data", + "type": "List[Data]", + "description": "Input dataset.", + "default": "", + "optional": false }, { - "name": "region_type", + "name": "y_column", "type": "str", - "description": "The region type of the series.", - "default": null, - "optional": true + "description": "Target column.", + "default": "", + "optional": 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": null, - "optional": true + "name": "x_columns", + "type": "List[str]", + "description": "List of columns to use as exogenous variables.", + "default": "", + "optional": false } ] }, - "model": "FredSearch" + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Dict", + "description": "OBBject with the fit model returned" + } + ] + }, + "data": {}, + "model": "" }, - "/economy/fred_series": { + "/econometrics/panel_fmac": { "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", + "description": "Fama-MacBeth estimator for panel data.\n\n The Fama-MacBeth estimator, a two-step procedure renowned for its application in finance to estimate the risk\n premiums and evaluate the capital asset pricing model. By first estimating cross-sectional regressions for each\n time period and then averaging the regression coefficients over time, this method provides insights into the\n relationship between the dependent variable (y_column) and explanatory variables (x_columns) across different\n entities (such as individuals, companies, or countries).", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.panel_fmac(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}])\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.", + "name": "data", + "type": "List[Data]", + "description": "Input dataset.", + "default": "", + "optional": false + }, + { + "name": "y_column", + "type": "str", + "description": "Target column.", + "default": "", + "optional": false + }, + { + "name": "x_columns", + "type": "List[str]", + "description": "List of columns to use as exogenous variables.", "default": "", "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Dict", + "description": "OBBject with the fit model returned" + } + ] + }, + "data": {}, + "model": "" + }, + "/economy/gdp/forecast": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Forecasted GDP Data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.gdp.forecast(provider='oecd')\nobb.economy.gdp.forecast(period='annual', type='real', provider='oecd')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return. Units for nominal GDP period. Either quarter or annual.", + "default": "annual", + "optional": true }, { "name": "start_date", @@ -2874,83 +3183,46 @@ "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 100000, + "name": "type", + "type": "Literal['nominal', 'real']", + "description": "Type of GDP to get forecast of. Either nominal or real.", + "default": "real", "optional": true }, { "name": "provider", - "type": "Literal['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", + "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 } ], - "fred": [ + "oecd": [ { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 100000, + "name": "country", + "type": "Literal['argentina', 'asia', 'australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'colombia', 'costa_rica', 'croatia', 'czech_republic', 'denmark', 'estonia', 'euro_area_17', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'india', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'non-oecd', 'norway', 'oecd_total', 'peru', 'poland', 'portugal', 'romania', 'russia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'world']", + "description": "Country to get GDP for.", + "default": "united_states", "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[GdpForecast]", + "description": "Serializable results." }, { - "name": "frequency", - "type": "Literal['a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", - "description": "Frequency aggregation to convert high frequency data to lower frequency. None = No change a = Annual q = Quarterly m = Monthly w = Weekly d = Daily wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['oecd']]", + "description": "Provider name." }, { - "name": "aggregation_method", - "type": "Literal['avg', 'sum', 'eop']", - "description": "A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. avg = Average sum = Sum eop = End of Period", - "default": "eop", - "optional": true - }, - { - "name": "transform", - "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", - "description": "Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "all_pages", - "type": "bool", - "description": "Returns all pages of data from the API call at once.", - "default": false, - "optional": true - }, - { - "name": "sleep", - "type": "float", - "description": "Time to sleep between requests to avoid rate limiting.", - "default": 1.0, - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[FredSeries]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fred', 'intrinio']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { "name": "chart", @@ -2970,32 +3242,37 @@ "name": "date", "type": "date", "description": "The date of the data.", - "default": "", - "optional": false - } - ], - "fred": [], - "intrinio": [ + "default": null, + "optional": true + }, { "name": "value", "type": "float", - "description": "Value of the index.", + "description": "Nominal GDP value on the date.", "default": null, "optional": true } - ] + ], + "oecd": [] }, - "model": "FredSeries" + "model": "GdpForecast" }, - "/economy/money_measures": { + "/economy/gdp/nominal": { "deprecated": { "flag": null, "message": null }, - "description": "Get Money Measures (M1/M2 and components).\n\nThe Federal Reserve publishes as part of the H.6 Release.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.money_measures(provider='federal_reserve')\nobb.economy.money_measures(adjusted=False, provider='federal_reserve')\n```\n\n", + "description": "Get Nominal GDP Data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.gdp.nominal(provider='oecd')\nobb.economy.gdp.nominal(units='usd', provider='oecd')\n```\n\n", "parameters": { "standard": [ + { + "name": "units", + "type": "Literal['usd', 'usd_cap']", + "description": "The unit of measurement for the data. Units to get nominal GDP in. Either usd or usd_cap indicating per capita.", + "default": "usd", + "optional": true + }, { "name": "start_date", "type": "Union[date, str]", @@ -3010,33 +3287,34 @@ "default": null, "optional": true }, - { - "name": "adjusted", - "type": "bool", - "description": "Whether to return seasonally adjusted data.", - "default": true, - "optional": true - }, { "name": "provider", - "type": "Literal['federal_reserve']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default.", - "default": "federal_reserve", + "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 } ], - "federal_reserve": [] + "oecd": [ + { + "name": "country", + "type": "Literal['australia', 'austria', 'belgium', 'brazil', 'canada', 'chile', 'colombia', 'costa_rica', 'czech_republic', 'denmark', 'estonia', 'euro_area', 'european_union', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'norway', 'poland', 'portugal', 'russia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'all']", + "description": "Country to get GDP for.", + "default": "united_states", + "optional": true + } + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[MoneyMeasures]", + "type": "List[GdpNominal]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['federal_reserve']]", + "type": "Optional[Literal['oecd']]", "description": "Provider name." }, { @@ -3059,75 +3337,40 @@ "data": { "standard": [ { - "name": "month", + "name": "date", "type": "date", "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "M1", - "type": "float", - "description": "Value of the M1 money supply in billions.", - "default": "", - "optional": false - }, - { - "name": "M2", - "type": "float", - "description": "Value of the M2 money supply in billions.", - "default": "", - "optional": false - }, - { - "name": "currency", - "type": "float", - "description": "Value of currency in circulation in billions.", - "default": null, - "optional": true - }, - { - "name": "demand_deposits", - "type": "float", - "description": "Value of demand deposits in billions.", - "default": null, - "optional": true - }, - { - "name": "retail_money_market_funds", - "type": "float", - "description": "Value of retail money market funds in billions.", - "default": null, - "optional": true - }, - { - "name": "other_liquid_deposits", - "type": "float", - "description": "Value of other liquid deposits in billions.", "default": null, "optional": true }, { - "name": "small_denomination_time_deposits", + "name": "value", "type": "float", - "description": "Value of small denomination time deposits in billions.", + "description": "Nominal GDP value on the date.", "default": null, "optional": true } ], - "federal_reserve": [] + "oecd": [] }, - "model": "MoneyMeasures" + "model": "GdpNominal" }, - "/economy/unemployment": { + "/economy/gdp/real": { "deprecated": { "flag": null, "message": null }, - "description": "Get global unemployment data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.unemployment(provider='oecd')\nobb.economy.unemployment(country=all, frequency=quarterly, provider='oecd')\n# Demographics for the statistics are selected with the `age` parameter.\nobb.economy.unemployment(country=all, frequency=quarterly, age=25-54, provider='oecd')\n```\n\n", + "description": "Get Real GDP Data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.gdp.real(provider='oecd')\nobb.economy.gdp.real(units='yoy', provider='oecd')\n```\n\n", "parameters": { "standard": [ + { + "name": "units", + "type": "Literal['idx', 'qoq', 'yoy']", + "description": "The unit of measurement for the data. Either idx (indicating 2015=100), qoq (previous period) or yoy (same period, previous year).)", + "default": "yoy", + "optional": true + }, { "name": "start_date", "type": "Union[date, str]", @@ -3153,38 +3396,10 @@ "oecd": [ { "name": "country", - "type": "Literal['colombia', 'new_zealand', 'united_kingdom', 'italy', 'luxembourg', 'euro_area19', 'sweden', 'oecd', 'south_africa', 'denmark', 'canada', 'switzerland', 'slovakia', 'hungary', 'portugal', 'spain', 'france', 'czech_republic', 'costa_rica', 'japan', 'slovenia', 'russia', 'austria', 'latvia', 'netherlands', 'israel', 'iceland', 'united_states', 'ireland', 'mexico', 'germany', 'greece', 'turkey', 'australia', 'poland', 'south_korea', 'chile', 'finland', 'european_union27_2020', 'norway', 'lithuania', 'euro_area20', 'estonia', 'belgium', 'brazil', 'indonesia', 'all']", + "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 - }, - { - "name": "sex", - "type": "Literal['total', 'male', 'female']", - "description": "Sex to get unemployment for.", - "default": "total", - "optional": true - }, - { - "name": "frequency", - "type": "Literal['monthly', 'quarterly', 'annual']", - "description": "Frequency to get unemployment for.", - "default": "monthly", - "optional": true - }, - { - "name": "age", - "type": "Literal['total', '15-24', '15-64', '25-54', '55-64']", - "description": "Age group to get unemployment for. Total indicates 15 years or over", - "default": "total", - "optional": true - }, - { - "name": "seasonal_adjustment", - "type": "bool", - "description": "Whether to get seasonally adjusted unemployment. Defaults to False.", - "default": false, - "optional": true } ] }, @@ -3192,7 +3407,7 @@ "OBBject": [ { "name": "results", - "type": "List[Unemployment]", + "type": "List[GdpReal]", "description": "Serializable results." }, { @@ -3229,29 +3444,22 @@ { "name": "value", "type": "float", - "description": "Unemployment rate (given as a whole number, i.e 10=10%)", - "default": null, - "optional": true - }, - { - "name": "country", - "type": "str", - "description": "Country for which unemployment rate is given", + "description": "Nominal GDP value on the date.", "default": null, "optional": true } ], "oecd": [] }, - "model": "Unemployment" + "model": "GdpReal" }, - "/economy/composite_leading_indicator": { + "/economy/calendar": { "deprecated": { "flag": null, "message": null }, - "description": "Use the composite leading indicator (CLI).\n\nIt is designed to provide early signals of turning points\nin business cycles showing fluctuation of the economic activity around its long term potential level.\n\nCLIs show short-term economic movements in qualitative rather than quantitative terms.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.composite_leading_indicator(provider='oecd')\nobb.economy.composite_leading_indicator(country=all, provider='oecd')\n```\n\n", + "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# By default, the calendar will be forward-looking.\nobb.economy.calendar(provider='nasdaq')\n```\n\n", "parameters": { "standard": [ { @@ -3270,18 +3478,42 @@ }, { "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", + "type": "Literal['fmp', 'nasdaq', '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 } ], - "oecd": [ + "fmp": [], + "nasdaq": [ { "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", + "type": "Union[str, List[str]]", + "description": "Country of the event Multiple items allowed for provider(s): nasdaq, tradingeconomics.", + "default": null, + "optional": true + } + ], + "tradingeconomics": [ + { + "name": "country", + "type": "Union[str, List[str]]", + "description": "Country of the event. Multiple items allowed for provider(s): tradingeconomics.", + "default": null, + "optional": true + }, + { + "name": "importance", + "type": "Literal['Low', 'Medium', 'High']", + "description": "Importance of the event.", + "default": null, + "optional": true + }, + { + "name": "group", + "type": "Literal['interest rate', 'inflation', 'bonds', 'consumer', 'gdp', 'government', 'housing', 'labour', 'markets', 'money', 'prices', 'trade', 'business']", + "description": "Grouping of events", + "default": null, "optional": true } ] @@ -3290,12 +3522,12 @@ "OBBject": [ { "name": "results", - "type": "List[CLI]", + "type": "List[EconomicCalendar]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['oecd']]", + "type": "Optional[Literal['fmp', 'nasdaq', 'tradingeconomics']]", "description": "Provider name." }, { @@ -3319,144 +3551,183 @@ "standard": [ { "name": "date", - "type": "date", + "type": "datetime", "description": "The date of the data.", "default": null, "optional": true }, { - "name": "value", - "type": "float", - "description": "CLI value", + "name": "country", + "type": "str", + "description": "Country of event.", "default": null, "optional": true }, { - "name": "country", + "name": "event", "type": "str", - "description": "Country for which CLI is given", + "description": "Event name.", "default": null, "optional": true - } - ], - "oecd": [] - }, - "model": "CLI" - }, - "/economy/short_term_interest_rate": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get Short-term interest rates.\n\nThey are the rates at which short-term borrowings are effected between\nfinancial institutions or the rate at which short-term government paper is issued or traded in the market.\n\nShort-term interest rates are generally averages of daily rates, measured as a percentage.\nShort-term interest rates are based on three-month money market rates where available.\nTypical standardised names are \"money market rate\" and \"treasury bill rate\".", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.short_term_interest_rate(provider='oecd')\nobb.economy.short_term_interest_rate(country=all, frequency=quarterly, provider='oecd')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "reference", + "type": "str", + "description": "Abbreviated period for which released data refers to.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "source", + "type": "str", + "description": "Source of the data.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['oecd']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default.", - "default": "oecd", + "name": "sourceurl", + "type": "str", + "description": "Source URL.", + "default": null, "optional": true - } - ], - "oecd": [ + }, { - "name": "country", - "type": "Literal['belgium', 'ireland', 'mexico', 'indonesia', 'new_zealand', 'japan', 'united_kingdom', 'france', 'chile', 'canada', 'netherlands', 'united_states', 'south_korea', 'norway', 'austria', 'south_africa', 'denmark', 'switzerland', 'hungary', 'luxembourg', 'australia', 'germany', 'sweden', 'iceland', 'turkey', 'greece', 'israel', 'czech_republic', 'latvia', 'slovenia', 'poland', 'estonia', 'lithuania', 'portugal', 'costa_rica', 'slovakia', 'finland', 'spain', 'russia', 'euro_area19', 'colombia', 'italy', 'india', 'china', 'croatia', 'all']", - "description": "Country to get GDP for.", - "default": "united_states", + "name": "actual", + "type": "Union[str, float]", + "description": "Latest released value.", + "default": null, "optional": true }, { - "name": "frequency", - "type": "Literal['monthly', 'quarterly', 'annual']", - "description": "Frequency to get interest rate for for.", - "default": "monthly", + "name": "previous", + "type": "Union[str, float]", + "description": "Value for the previous period after the revision (if revision is applicable).", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[STIR]", - "description": "Serializable results." + "name": "consensus", + "type": "Union[str, float]", + "description": "Average forecast among a representative group of economists.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['oecd']]", - "description": "Provider name." + "name": "forecast", + "type": "Union[str, float]", + "description": "Trading Economics projections", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "url", + "type": "str", + "description": "Trading Economics URL", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "importance", + "type": "Union[Literal[0, 1, 2, 3], str]", + "description": "Importance of the event. 1-Low, 2-Medium, 3-High", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "currency", + "type": "str", + "description": "Currency of the data.", + "default": null, + "optional": true + }, + { + "name": "unit", + "type": "str", + "description": "Unit of the data.", + "default": null, + "optional": true } - ] - }, - "data": { - "standard": [ + ], + "fmp": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "change", + "type": "float", + "description": "Value change since previous.", "default": null, "optional": true }, { - "name": "value", + "name": "change_percent", "type": "float", - "description": "Interest rate (given as a whole number, i.e 10=10%)", + "description": "Percentage change since previous.", "default": null, "optional": true }, { - "name": "country", + "name": "updated_at", + "type": "datetime", + "description": "Last updated timestamp.", + "default": null, + "optional": true + }, + { + "name": "created_at", + "type": "datetime", + "description": "Created at timestamp.", + "default": null, + "optional": true + } + ], + "nasdaq": [ + { + "name": "description", "type": "str", - "description": "Country for which interest rate is given", + "description": "Event description.", "default": null, "optional": true } ], - "oecd": [] + "tradingeconomics": [] }, - "model": "STIR" + "model": "EconomicCalendar" }, - "/economy/long_term_interest_rate": { + "/economy/cpi": { "deprecated": { "flag": null, "message": null }, - "description": "Get Long-term interest rates that refer to government bonds maturing in ten years.\n\nRates are mainly determined by the price charged by the lender, the risk from the borrower and the\nfall in the capital value. Long-term interest rates are generally averages of daily rates,\nmeasured as a percentage. These interest rates are implied by the prices at which the government bonds are\ntraded on financial markets, not the interest rates at which the loans were issued.\nIn all cases, they refer to bonds whose capital repayment is guaranteed by governments.\nLong-term interest rates are one of the determinants of business investment.\nLow long-term interest rates encourage investment in new equipment and high interest rates discourage it.\nInvestment is, in turn, a major source of economic growth.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.long_term_interest_rate(provider='oecd')\nobb.economy.long_term_interest_rate(country=all, frequency=quarterly, provider='oecd')\n```\n\n", + "description": "Get Consumer Price Index (CPI).\n\nReturns either the rescaled index value, or a rate of change (inflation).", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.cpi(country='japan,china,turkey', provider='fred')\n# Use the `units` parameter to define the reference period for the change in values.\nobb.economy.cpi(country='united_states,united_kingdom', units='growth_previous', provider='fred')\n```\n\n", "parameters": { "standard": [ + { + "name": "country", + "type": "Union[str, List[str]]", + "description": "The country to get data. Multiple items allowed for provider(s): fred.", + "default": "", + "optional": false + }, + { + "name": "units", + "type": "Literal['growth_previous', 'growth_same', 'index_2015']", + "description": "The unit of measurement for the data. Options: - `growth_previous`: Percent growth from the previous period. If monthly data, this is month-over-month, etc - `growth_same`: Percent growth from the same period in the previous year. If looking at monthly data, this would be year-over-year, etc. - `index_2015`: Rescaled index value, such that the value in 2015 is 100.", + "default": "growth_same", + "optional": true + }, + { + "name": "frequency", + "type": "Literal['monthly', 'quarter', 'annual']", + "description": "The frequency of the data. Options: `monthly`, `quarter`, and `annual`.", + "default": "monthly", + "optional": true + }, + { + "name": "harmonized", + "type": "bool", + "description": "Whether you wish to obtain harmonized data.", + "default": false, + "optional": true + }, { "name": "start_date", "type": "Union[date, str]", @@ -3473,39 +3744,24 @@ }, { "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", + "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 } ], - "oecd": [ - { - "name": "country", - "type": "Literal['belgium', 'ireland', 'mexico', 'indonesia', 'new_zealand', 'japan', 'united_kingdom', 'france', 'chile', 'canada', 'netherlands', 'united_states', 'south_korea', 'norway', 'austria', 'south_africa', 'denmark', 'switzerland', 'hungary', 'luxembourg', 'australia', 'germany', 'sweden', 'iceland', 'turkey', 'greece', 'israel', 'czech_republic', 'latvia', 'slovenia', 'poland', 'estonia', 'lithuania', 'portugal', 'costa_rica', 'slovakia', 'finland', 'spain', 'russia', 'euro_area19', 'colombia', 'italy', 'india', 'china', 'croatia', 'all']", - "description": "Country to get GDP for.", - "default": "united_states", - "optional": true - }, - { - "name": "frequency", - "type": "Literal['monthly', 'quarterly', 'annual']", - "description": "Frequency to get interest rate for for.", - "default": "monthly", - "optional": true - } - ] + "fred": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[LTIR]", + "type": "List[ConsumerPriceIndex]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['oecd']]", + "type": "Optional[Literal['fred']]", "description": "Provider name." }, { @@ -3531,142 +3787,43 @@ "name": "date", "type": "date", "description": "The date of the data.", - "default": null, - "optional": true - }, - { - "name": "value", - "type": "float", - "description": "Interest rate (given as a whole number, i.e 10=10%)", - "default": null, - "optional": true - }, - { - "name": "country", - "type": "str", - "description": "Country for which interest rate is given", - "default": null, - "optional": true + "default": "", + "optional": false } ], - "oecd": [] + "fred": [] }, - "model": "LTIR" + "model": "ConsumerPriceIndex" }, - "/economy/fred_regional": { + "/economy/risk_premium": { "deprecated": { "flag": null, "message": null }, - "description": "Query the Geo Fred API for regional economic data by series group.\n\nThe series group ID is found by using `fred_search` and the `series_id` parameter.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.fred_regional(symbol='NYICLAIMS', provider='fred')\n# With a date, time series data is returned.\nobb.economy.fred_regional(symbol='NYICLAIMS', start_date='2021-01-01', end_date='2021-12-31', limit=10, provider='fred')\n```\n\n", + "description": "Get Market Risk Premium by country.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.risk_premium(provider='fmp')\n```\n\n", "parameters": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 100000, - "optional": true - }, - { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", - "optional": true - } - ], - "fred": [ - { - "name": "symbol", - "type": "str", - "description": "For this function, it is the series_group ID or series ID. If the symbol provided is for a series_group, set the `is_series_group` parameter to True. Not all series that are in FRED have geographical data.", - "default": "", - "optional": false - }, - { - "name": "is_series_group", - "type": "bool", - "description": "When True, the symbol provided is for a series_group, else it is for a series ID.", - "default": false, - "optional": true - }, - { - "name": "region_type", - "type": "Literal['bea', 'msa', 'frb', 'necta', 'state', 'country', 'county', 'censusregion']", - "description": "The type of regional data. Parameter is only valid when `is_series_group` is True.", - "default": null, - "optional": true - }, - { - "name": "season", - "type": "Literal['SA', 'NSA', 'SSA']", - "description": "The seasonal adjustments to the data. Parameter is only valid when `is_series_group` is True.", - "default": "NSA", - "optional": true - }, - { - "name": "units", - "type": "str", - "description": "The units of the data. This should match the units returned from searching by series ID. An incorrect field will not necessarily return an error. Parameter is only valid when `is_series_group` is True.", - "default": null, - "optional": true - }, - { - "name": "frequency", - "type": "Literal['d', 'w', 'bw', 'm', 'q', 'sa', 'a', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", - "description": "Frequency aggregation to convert high frequency data to lower frequency. Parameter is only valid when `is_series_group` is True. a = Annual sa= Semiannual q = Quarterly m = Monthly w = Weekly d = Daily wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday", - "default": null, - "optional": true - }, - { - "name": "aggregation_method", - "type": "Literal['avg', 'sum', 'eop']", - "description": "A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. Only valid when `is_series_group` is True. avg = Average sum = Sum eop = End of Period", - "default": "avg", - "optional": true - }, - { - "name": "transform", - "type": "Literal['lin', 'chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", - "description": "Transformation type. Only valid when `is_series_group` is True. lin = Levels (No transformation) chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log", - "default": "lin", - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[FredRegional]", - "description": "Serializable results." + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[RiskPremium]", + "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fred']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -3689,83 +3846,75 @@ "data": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - } - ], - "fred": [ - { - "name": "region", + "name": "country", "type": "str", - "description": "The name of the region.", + "description": "Market country.", "default": "", "optional": false }, { - "name": "code", - "type": "Union[str, int]", - "description": "The code of the region.", - "default": "", - "optional": false + "name": "continent", + "type": "str", + "description": "Continent of the country.", + "default": null, + "optional": true }, { - "name": "value", - "type": "Union[int, float]", - "description": "The obersvation value. The units are defined in the search results by series ID.", + "name": "total_equity_risk_premium", + "type": "Annotated[float, Gt(gt=0)]", + "description": "Total equity risk premium for the country.", "default": null, "optional": true }, { - "name": "series_id", - "type": "str", - "description": "The individual series ID for the region.", - "default": "", - "optional": false + "name": "country_risk_premium", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Country-specific risk premium.", + "default": null, + "optional": true } - ] + ], + "fmp": [] }, - "model": "FredRegional" + "model": "RiskPremium" }, - "/economy/country_profile": { + "/economy/balance_of_payments": { "deprecated": { "flag": null, "message": null }, - "description": "Get a profile of country statistics and economic indicators.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.country_profile(provider='econdb', country='united_kingdom')\n# Enter the country as the full name, or iso code. If `latest` is False, the complete history for each series is returned.\nobb.economy.country_profile(country='united_states,jp', latest=False, provider='econdb')\n```\n\n", + "description": "Balance of Payments Reports.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.balance_of_payments(provider='ecb')\nobb.economy.balance_of_payments(report_type=summary, provider='ecb')\n# The `country` parameter will override the `report_type`.\nobb.economy.balance_of_payments(country=united_states, provider='ecb')\n```\n\n", "parameters": { "standard": [ - { - "name": "country", - "type": "Union[str, List[str]]", - "description": "The country to get data. Multiple items allowed for provider(s): econdb.", - "default": "", - "optional": false - }, { "name": "provider", - "type": "Literal['econdb']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'econdb' if there is no default.", - "default": "econdb", + "type": "Literal['ecb']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'ecb' if there is no default.", + "default": "ecb", "optional": true } ], - "econdb": [ + "ecb": [ { - "name": "latest", - "type": "bool", - "description": "If True, return only the latest data. If False, return all available data for each indicator.", - "default": true, + "name": "report_type", + "type": "Literal['main', 'summary', 'services', 'investment_income', 'direct_investment', 'portfolio_investment', 'other_investment']", + "description": "The report type, the level of detail in the data.", + "default": "main", "optional": true }, { - "name": "use_cache", - "type": "bool", - "description": "If True, the request will be cached for one day.Using cache is recommended to avoid needlessly requesting the same data.", - "default": true, + "name": "frequency", + "type": "Literal['monthly', 'quarterly']", + "description": "The frequency of the data. Monthly is valid only for ['main', 'summary'].", + "default": "monthly", + "optional": true + }, + { + "name": "country", + "type": "Literal['brazil', 'canada', 'china', 'eu_ex_euro_area', 'eu_institutions', 'india', 'japan', 'russia', 'switzerland', 'united_kingdom', 'united_states', 'total']", + "description": "The country/region of the data. This parameter will override the 'report_type' parameter.", + "default": null, "optional": true } ] @@ -3774,12 +3923,12 @@ "OBBject": [ { "name": "results", - "type": "List[CountryProfile]", + "type": "List[BalanceOfPayments]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['econdb']]", + "type": "Optional[Literal['ecb']]", "description": "Provider name." }, { @@ -3802,950 +3951,866 @@ "data": { "standard": [ { - "name": "country", - "type": "str", - "description": "", - "default": "", - "optional": false + "name": "period", + "type": "date", + "description": "The date representing the beginning of the reporting period.", + "default": null, + "optional": true }, { - "name": "population", - "type": "int", - "description": "Population.", + "name": "current_account", + "type": "float", + "description": "Current Account Balance (Billions of EUR)", "default": null, "optional": true }, { - "name": "gdp_usd", + "name": "goods", "type": "float", - "description": "Gross Domestic Product, in billions of USD.", + "description": "Goods Balance (Billions of EUR)", "default": null, "optional": true }, { - "name": "gdp_qoq", + "name": "services", "type": "float", - "description": "GDP growth quarter-over-quarter change, as a normalized percent.", + "description": "Services Balance (Billions of EUR)", "default": null, "optional": true }, { - "name": "gdp_yoy", + "name": "primary_income", "type": "float", - "description": "GDP growth year-over-year change, as a normalized percent.", + "description": "Primary Income Balance (Billions of EUR)", "default": null, "optional": true }, { - "name": "cpi_yoy", + "name": "secondary_income", "type": "float", - "description": "Consumer Price Index year-over-year change, as a normalized percent.", + "description": "Secondary Income Balance (Billions of EUR)", "default": null, "optional": true }, { - "name": "core_yoy", + "name": "capital_account", "type": "float", - "description": "Core Consumer Price Index year-over-year change, as a normalized percent.", + "description": "Capital Account Balance (Billions of EUR)", "default": null, "optional": true }, { - "name": "retail_sales_yoy", + "name": "net_lending_to_rest_of_world", "type": "float", - "description": "Retail Sales year-over-year change, as a normalized percent.", + "description": "Balance of net lending to the rest of the world (Billions of EUR)", "default": null, "optional": true }, { - "name": "industrial_production_yoy", + "name": "financial_account", "type": "float", - "description": "Industrial Production year-over-year change, as a normalized percent.", + "description": "Financial Account Balance (Billions of EUR)", "default": null, "optional": true }, { - "name": "policy_rate", + "name": "direct_investment", "type": "float", - "description": "Short term policy rate, as a normalized percent.", + "description": "Direct Investment Balance (Billions of EUR)", "default": null, "optional": true }, { - "name": "yield_10y", + "name": "portfolio_investment", "type": "float", - "description": "10-year government bond yield, as a normalized percent.", + "description": "Portfolio Investment Balance (Billions of EUR)", "default": null, "optional": true }, { - "name": "govt_debt_gdp", + "name": "financial_derivatives", "type": "float", - "description": "Government debt as a percent (normalized) of GDP.", + "description": "Financial Derivatives Balance (Billions of EUR)", "default": null, "optional": true }, { - "name": "current_account_gdp", + "name": "other_investment", "type": "float", - "description": "Current account balance as a percent (normalized) of GDP.", + "description": "Other Investment Balance (Billions of EUR)", "default": null, "optional": true }, { - "name": "jobless_rate", + "name": "reserve_assets", "type": "float", - "description": "Unemployment rate, as a normalized percent.", + "description": "Reserve Assets Balance (Billions of EUR)", "default": null, "optional": true - } - ], - "econdb": [] - }, - "model": "CountryProfile" - }, - "/economy/available_indicators": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the available economic indicators for a provider.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.available_indicators(provider='econdb')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "provider", - "type": "Literal['econdb']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'econdb' if there is no default.", - "default": "econdb", + "name": "errors_and_ommissions", + "type": "float", + "description": "Errors and Omissions (Billions of EUR)", + "default": null, "optional": true - } - ], - "econdb": [ + }, { - "name": "use_cache", - "type": "bool", - "description": "Whether to use cache or not, by default is True The cache of indicator symbols will persist for one week.", - "default": true, + "name": "current_account_credit", + "type": "float", + "description": "Current Account Credits (Billions of EUR)", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[AvailableIndicators]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['econdb']]", - "description": "Provider name." + "name": "current_account_debit", + "type": "float", + "description": "Current Account Debits (Billions of EUR)", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol_root", - "type": "str", - "description": "The root symbol representing the indicator.", + "name": "current_account_balance", + "type": "float", + "description": "Current Account Balance (Billions of EUR)", "default": null, "optional": true }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data. The root symbol with additional codes.", + "name": "goods_credit", + "type": "float", + "description": "Goods Credits (Billions of EUR)", "default": null, "optional": true }, { - "name": "country", - "type": "str", - "description": "The name of the country, region, or entity represented by the symbol.", + "name": "goods_debit", + "type": "float", + "description": "Goods Debits (Billions of EUR)", "default": null, "optional": true }, { - "name": "iso", - "type": "str", - "description": "The ISO code of the country, region, or entity represented by the symbol.", + "name": "services_credit", + "type": "float", + "description": "Services Credits (Billions of EUR)", "default": null, "optional": true }, { - "name": "description", - "type": "str", - "description": "The description of the indicator.", + "name": "services_debit", + "type": "float", + "description": "Services Debits (Billions of EUR)", "default": null, "optional": true }, { - "name": "frequency", - "type": "str", - "description": "The frequency of the indicator data.", + "name": "primary_income_credit", + "type": "float", + "description": "Primary Income Credits (Billions of EUR)", "default": null, "optional": true - } - ], - "econdb": [ + }, { - "name": "currency", - "type": "str", - "description": "The currency, or unit, the data is based in.", + "name": "primary_income_employee_compensation_credit", + "type": "float", + "description": "Primary Income Employee Compensation Credit (Billions of EUR)", "default": null, "optional": true }, { - "name": "scale", - "type": "str", - "description": "The scale of the data.", + "name": "primary_income_debit", + "type": "float", + "description": "Primary Income Debits (Billions of EUR)", "default": null, "optional": true }, { - "name": "multiplier", - "type": "int", - "description": "The multiplier of the data to arrive at whole units.", - "default": "", - "optional": false + "name": "primary_income_employee_compensation_debit", + "type": "float", + "description": "Primary Income Employee Compensation Debit (Billions of EUR)", + "default": null, + "optional": true }, { - "name": "transformation", - "type": "str", - "description": "Transformation type.", - "default": "", - "optional": false + "name": "secondary_income_credit", + "type": "float", + "description": "Secondary Income Credits (Billions of EUR)", + "default": null, + "optional": true }, { - "name": "source", - "type": "str", - "description": "The original source of the data.", + "name": "secondary_income_debit", + "type": "float", + "description": "Secondary Income Debits (Billions of EUR)", "default": null, "optional": true }, { - "name": "first_date", - "type": "date", - "description": "The first date of the data.", + "name": "capital_account_credit", + "type": "float", + "description": "Capital Account Credits (Billions of EUR)", "default": null, "optional": true }, { - "name": "last_date", - "type": "date", - "description": "The last date of the data.", + "name": "capital_account_debit", + "type": "float", + "description": "Capital Account Debits (Billions of EUR)", "default": null, "optional": true }, { - "name": "last_insert_timestamp", - "type": "datetime", - "description": "The time of the last update. Data is typically reported with a lag.", + "name": "services_total_credit", + "type": "float", + "description": "Services Total Credit (Billions of EUR)", "default": null, "optional": true - } - ] - }, - "model": "AvailableIndicators" - }, - "/economy/indicators": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get economic indicators by country and indicator.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.indicators(provider='econdb', symbol='PCOCO')\n# Enter the country as the full name, or iso code. Use `available_indicators()` to get a list of supported indicators from EconDB.\nobb.economy.indicators(symbol='CPI', country='united_states,jp', provider='econdb')\n# Use the `main` symbol to get the group of main indicators for a country.\nobb.economy.indicators(provider='econdb', symbol='main', country='eu')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Multiple items allowed for provider(s): econdb.", - "default": "", - "optional": false }, { - "name": "country", - "type": "Union[str, List[str]]", - "description": "The country to get data. The country represented by the indicator, if available. Multiple items allowed for provider(s): econdb.", + "name": "services_total_debit", + "type": "float", + "description": "Services Total Debit (Billions of EUR)", "default": null, "optional": true }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "transport_credit", + "type": "float", + "description": "Transport Credit (Billions of EUR)", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "transport_debit", + "type": "float", + "description": "Transport Debit (Billions of EUR)", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['econdb']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'econdb' if there is no default.", - "default": "econdb", + "name": "travel_credit", + "type": "float", + "description": "Travel Credit (Billions of EUR)", + "default": null, "optional": true - } - ], - "econdb": [ + }, { - "name": "transform", - "type": "Literal['toya', 'tpop', 'tusd', 'tpgp']", - "description": "The transformation to apply to the data, default is None. tpop: Change from previous period toya: Change from one year ago tusd: Values as US dollars tpgp: Values as a percent of GDP Only 'tpop' and 'toya' are applicable to all indicators. Applying transformations across multiple indicators/countries may produce unexpected results. This is because not all indicators are compatible with all transformations, and the original units and scale differ between entities. `tusd` should only be used where values are currencies.", + "name": "travel_debit", + "type": "float", + "description": "Travel Debit (Billions of EUR)", "default": null, "optional": true }, { - "name": "frequency", - "type": "Literal['annual', 'quarter', 'month']", - "description": "The frequency of the data, default is 'quarter'. Only valid when 'symbol' is 'main'.", - "default": "quarter", + "name": "financial_services_credit", + "type": "float", + "description": "Financial Services Credit (Billions of EUR)", + "default": null, "optional": true }, { - "name": "use_cache", - "type": "bool", - "description": "If True, the request will be cached for one day. Using cache is recommended to avoid needlessly requesting the same data.", - "default": true, + "name": "financial_services_debit", + "type": "float", + "description": "Financial Services Debit (Billions of EUR)", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EconomicIndicators]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['econdb']]", - "description": "Provider name." + "name": "communications_credit", + "type": "float", + "description": "Communications Credit (Billions of EUR)", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "communications_debit", + "type": "float", + "description": "Communications Debit (Billions of EUR)", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "other_business_services_credit", + "type": "float", + "description": "Other Business Services Credit (Billions of EUR)", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "other_business_services_debit", + "type": "float", + "description": "Other Business Services Debit (Billions of EUR)", + "default": null, + "optional": true }, { - "name": "symbol_root", - "type": "str", - "description": "The root symbol for the indicator (e.g. GDP).", + "name": "other_services_credit", + "type": "float", + "description": "Other Services Credit (Billions of EUR)", "default": null, "optional": true }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "other_services_debit", + "type": "float", + "description": "Other Services Debit (Billions of EUR)", "default": null, "optional": true }, { - "name": "country", - "type": "str", - "description": "The country represented by the data.", + "name": "investment_total_credit", + "type": "float", + "description": "Investment Total Credit (Billions of EUR)", "default": null, "optional": true }, { - "name": "value", - "type": "Union[int, float]", - "description": "", + "name": "investment_total_debit", + "type": "float", + "description": "Investment Total Debit (Billions of EUR)", "default": null, "optional": true - } - ], - "econdb": [] - }, - "model": "EconomicIndicators" - }, - "/equity/calendar/ipo": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get historical and upcoming initial public offerings (IPOs).", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.calendar.ipo(provider='intrinio')\n# Get all IPOs available.\nobb.equity.calendar.ipo(provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "name": "equity_credit", + "type": "float", + "description": "Equity Credit (Billions of EUR)", "default": null, "optional": true }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "equity_reinvested_earnings_credit", + "type": "float", + "description": "Equity Reinvested Earnings Credit (Billions of EUR)", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "equity_debit", + "type": "float", + "description": "Equity Debit (Billions of EUR)", "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 100, + "name": "equity_reinvested_earnings_debit", + "type": "float", + "description": "Equity Reinvested Earnings Debit (Billions of EUR)", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", + "name": "debt_instruments_credit", + "type": "float", + "description": "Debt Instruments Credit (Billions of EUR)", + "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "status", - "type": "Literal['upcoming', 'priced', 'withdrawn']", - "description": "Status of the IPO. [upcoming, priced, or withdrawn]", + "name": "debt_instruments_debit", + "type": "float", + "description": "Debt Instruments Debit (Billions of EUR)", "default": null, "optional": true }, { - "name": "min_value", - "type": "int", - "description": "Return IPOs with an offer dollar amount greater than the given amount.", + "name": "portfolio_investment_equity_credit", + "type": "float", + "description": "Portfolio Investment Equity Credit (Billions of EUR)", "default": null, "optional": true }, { - "name": "max_value", - "type": "int", - "description": "Return IPOs with an offer dollar amount less than the given amount.", + "name": "portfolio_investment_equity_debit", + "type": "float", + "description": "Portfolio Investment Equity Debit (Billions of EUR)", "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[CalendarIpo]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['intrinio']]", - "description": "Provider name." + "name": "portfolio_investment_debt_instruments_credit", + "type": "float", + "description": "Portfolio Investment Debt Instruments Credit (Billions of EUR)", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "portofolio_investment_debt_instruments_debit", + "type": "float", + "description": "Portfolio Investment Debt Instruments Debit (Billions of EUR)", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "other_investment_credit", + "type": "float", + "description": "Other Investment Credit (Billions of EUR)", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "other_investment_debit", + "type": "float", + "description": "Other Investment Debit (Billions of EUR)", + "default": null, + "optional": true + }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "reserve_assets_credit", + "type": "float", + "description": "Reserve Assets Credit (Billions of EUR)", "default": null, "optional": true }, { - "name": "ipo_date", - "type": "date", - "description": "The date of the IPO, when the stock first trades on a major exchange.", + "name": "assets_total", + "type": "float", + "description": "Assets Total (Billions of EUR)", "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "status", - "type": "Literal['upcoming', 'priced', 'withdrawn']", - "description": "The status of the IPO. Upcoming IPOs have not taken place yet but are expected to. Priced IPOs have taken place. Withdrawn IPOs were expected to take place, but were subsequently withdrawn.", + "name": "assets_equity", + "type": "float", + "description": "Assets Equity (Billions of EUR)", "default": null, "optional": true }, { - "name": "exchange", - "type": "str", - "description": "The acronym of the stock exchange that the company is going to trade publicly on. Typically NYSE or NASDAQ.", + "name": "assets_debt_instruments", + "type": "float", + "description": "Assets Debt Instruments (Billions of EUR)", "default": null, "optional": true }, { - "name": "offer_amount", + "name": "assets_mfi", "type": "float", - "description": "The total dollar amount of shares offered in the IPO. Typically this is share price * share count", + "description": "Assets MFIs (Billions of EUR)", "default": null, "optional": true }, { - "name": "share_price", + "name": "assets_non_mfi", "type": "float", - "description": "The price per share at which the IPO was offered.", + "description": "Assets Non MFIs (Billions of EUR)", "default": null, "optional": true }, { - "name": "share_price_lowest", + "name": "assets_direct_investment_abroad", "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).", + "description": "Assets Direct Investment Abroad (Billions of EUR)", "default": null, "optional": true }, { - "name": "share_price_highest", + "name": "liabilities_total", "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).", + "description": "Liabilities Total (Billions of EUR)", "default": null, "optional": true }, { - "name": "share_count", - "type": "int", - "description": "The number of shares offered in the IPO.", + "name": "liabilities_equity", + "type": "float", + "description": "Liabilities Equity (Billions of EUR)", "default": null, "optional": true }, { - "name": "share_count_lowest", - "type": "int", - "description": "The expected lowest number of shares that will be offered in the IPO. Before an IPO is priced, companies typically provide a range of shares that they expect to offer in the IPO (typically available for upcoming IPOs).", + "name": "liabilities_debt_instruments", + "type": "float", + "description": "Liabilities Debt Instruments (Billions of EUR)", "default": null, "optional": true }, { - "name": "share_count_highest", - "type": "int", - "description": "The expected highest number of shares that will be offered in the IPO. Before an IPO is priced, companies typically provide a range of shares that they expect to offer in the IPO (typically available for upcoming IPOs).", + "name": "liabilities_mfi", + "type": "float", + "description": "Liabilities MFIs (Billions of EUR)", "default": null, "optional": true }, { - "name": "announcement_url", - "type": "str", - "description": "The URL to the company's announcement of the IPO", + "name": "liabilities_non_mfi", + "type": "float", + "description": "Liabilities Non MFIs (Billions of EUR)", "default": null, "optional": true }, { - "name": "sec_report_url", - "type": "str", - "description": "The URL to the company's S-1, S-1/A, F-1, or F-1/A SEC filing, which is required to be filed before an IPO takes place.", + "name": "liabilities_direct_investment_euro_area", + "type": "float", + "description": "Liabilities Direct Investment in Euro Area (Billions of EUR)", "default": null, "optional": true }, { - "name": "open_price", + "name": "assets_equity_and_fund_shares", "type": "float", - "description": "The opening price at the beginning of the first trading day (only available for priced IPOs).", + "description": "Assets Equity and Investment Fund Shares (Billions of EUR)", "default": null, "optional": true }, { - "name": "close_price", + "name": "assets_equity_shares", "type": "float", - "description": "The closing price at the end of the first trading day (only available for priced IPOs).", + "description": "Assets Equity Shares (Billions of EUR)", "default": null, "optional": true }, { - "name": "volume", - "type": "int", - "description": "The volume at the end of the first trading day (only available for priced IPOs).", + "name": "assets_investment_fund_shares", + "type": "float", + "description": "Assets Investment Fund Shares (Billions of EUR)", "default": null, "optional": true }, { - "name": "day_change", + "name": "assets_debt_short_term", "type": "float", - "description": "The percentage change between the open price and the close price on the first trading day (only available for priced IPOs).", + "description": "Assets Debt Short Term (Billions of EUR)", "default": null, "optional": true }, { - "name": "week_change", + "name": "assets_debt_long_term", "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).", + "description": "Assets Debt Long Term (Billions of EUR)", "default": null, "optional": true }, { - "name": "month_change", + "name": "assets_resident_sector_eurosystem", "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).", + "description": "Assets Resident Sector Eurosystem (Billions of EUR)", "default": null, "optional": true }, { - "name": "id", - "type": "str", - "description": "The Intrinio ID of the IPO.", + "name": "assets_resident_sector_mfi_ex_eurosystem", + "type": "float", + "description": "Assets Resident Sector MFIs outside Eurosystem (Billions of EUR)", "default": null, "optional": true }, { - "name": "company", - "type": "IntrinioCompany", - "description": "The company that is going public via the IPO.", + "name": "assets_resident_sector_government", + "type": "float", + "description": "Assets Resident Sector Government (Billions of EUR)", "default": null, "optional": true }, { - "name": "security", - "type": "IntrinioSecurity", - "description": "The primary Security for the Company that is going public via the IPO", + "name": "assets_resident_sector_other", + "type": "float", + "description": "Assets Resident Sector Other (Billions of EUR)", "default": null, "optional": true - } - ] - }, - "model": "CalendarIpo" - }, - "/equity/calendar/dividend": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get historical and upcoming dividend payments. Includes dividend amount, ex-dividend and payment dates.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.calendar.dividend(provider='fmp')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "liabilities_equity_and_fund_shares", + "type": "float", + "description": "Liabilities Equity and Investment Fund Shares (Billions of EUR)", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "liabilities_investment_fund_shares", + "type": "float", + "description": "Liabilities Investment Fund Shares (Billions of EUR)", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "liabilities_debt_short_term", + "type": "float", + "description": "Liabilities Debt Short Term (Billions of EUR)", + "default": null, "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[CalendarDividend]", - "description": "Serializable results." + "name": "liabilities_debt_long_term", + "type": "float", + "description": "Liabilities Debt Long Term (Billions of EUR)", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "liabilities_resident_sector_government", + "type": "float", + "description": "Liabilities Resident Sector Government (Billions of EUR)", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "liabilities_resident_sector_other", + "type": "float", + "description": "Liabilities Resident Sector Other (Billions of EUR)", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "assets_currency_and_deposits", + "type": "float", + "description": "Assets Currency and Deposits (Billions of EUR)", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "assets_loans", + "type": "float", + "description": "Assets Loans (Billions of EUR)", + "default": null, + "optional": true + }, { - "name": "ex_dividend_date", - "type": "date", - "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", - "default": "", - "optional": false + "name": "assets_trade_credit_and_advances", + "type": "float", + "description": "Assets Trade Credits and Advances (Billions of EUR)", + "default": null, + "optional": true }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "assets_eurosystem", + "type": "float", + "description": "Assets Eurosystem (Billions of EUR)", + "default": null, + "optional": true }, { - "name": "amount", + "name": "assets_other_mfi_ex_eurosystem", "type": "float", - "description": "The dividend amount per share.", + "description": "Assets Other MFIs outside Eurosystem (Billions of EUR)", "default": null, "optional": true }, { - "name": "name", - "type": "str", - "description": "Name of the entity.", + "name": "assets_government", + "type": "float", + "description": "Assets Government (Billions of EUR)", "default": null, "optional": true }, { - "name": "record_date", - "type": "date", - "description": "The record date of ownership for eligibility.", + "name": "assets_other_sectors", + "type": "float", + "description": "Assets Other Sectors (Billions of EUR)", "default": null, "optional": true }, { - "name": "payment_date", - "type": "date", - "description": "The payment date of the dividend.", + "name": "liabilities_currency_and_deposits", + "type": "float", + "description": "Liabilities Currency and Deposits (Billions of EUR)", "default": null, "optional": true }, { - "name": "declaration_date", - "type": "date", - "description": "Declaration date of the dividend.", + "name": "liabilities_loans", + "type": "float", + "description": "Liabilities Loans (Billions of EUR)", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "adjusted_amount", + "name": "liabilities_trade_credit_and_advances", "type": "float", - "description": "The adjusted-dividend amount.", + "description": "Liabilities Trade Credits and Advances (Billions of EUR)", "default": null, "optional": true }, { - "name": "label", - "type": "str", - "description": "Ex-dividend date formatted for display.", + "name": "liabilities_eurosystem", + "type": "float", + "description": "Liabilities Eurosystem (Billions of EUR)", "default": null, "optional": true - } - ] - }, - "model": "CalendarDividend" - }, - "/equity/calendar/splits": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get historical and upcoming stock split operations.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.calendar.splits(provider='fmp')\n# Get stock splits calendar for specific dates.\nobb.equity.calendar.splits(start_date='2024-02-01', end_date='2024-02-07', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "liabilities_other_mfi_ex_eurosystem", + "type": "float", + "description": "Liabilities Other MFIs outside Eurosystem (Billions of EUR)", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "liabilities_government", + "type": "float", + "description": "Liabilities Government (Billions of EUR)", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "liabilities_other_sectors", + "type": "float", + "description": "Liabilities Other Sectors (Billions of EUR)", + "default": null, "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[CalendarSplits]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "goods_balance", + "type": "float", + "description": "Goods Balance (Billions of EUR)", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "services_balance", + "type": "float", + "description": "Services Balance (Billions of EUR)", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "primary_income_balance", + "type": "float", + "description": "Primary Income Balance (Billions of EUR)", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "investment_income_balance", + "type": "float", + "description": "Investment Income Balance (Billions of EUR)", + "default": null, + "optional": true }, { - "name": "label", - "type": "str", - "description": "Label of the stock splits.", - "default": "", - "optional": false + "name": "investment_income_credit", + "type": "float", + "description": "Investment Income Credits (Billions of EUR)", + "default": null, + "optional": true }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "investment_income_debit", + "type": "float", + "description": "Investment Income Debits (Billions of EUR)", + "default": null, + "optional": true }, { - "name": "numerator", + "name": "secondary_income_balance", "type": "float", - "description": "Numerator of the stock splits.", - "default": "", - "optional": false + "description": "Secondary Income Balance (Billions of EUR)", + "default": null, + "optional": true }, { - "name": "denominator", + "name": "capital_account_balance", "type": "float", - "description": "Denominator of the stock splits.", - "default": "", - "optional": false + "description": "Capital Account Balance (Billions of EUR)", + "default": null, + "optional": true } ], - "fmp": [] + "ecb": [] }, - "model": "CalendarSplits" + "model": "BalanceOfPayments" }, - "/equity/calendar/earnings": { + "/economy/fred_search": { "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", + "description": "Search for FRED series or economic releases by ID or string.\n\nThis does not return the observation values, only the metadata.\nUse this function to find series IDs for `fred_series()`.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.fred_search(provider='fred')\n```\n\n", "parameters": { "standard": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "query", + "type": "str", + "description": "The search word(s).", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", + "optional": true + } + ], + "fred": [ + { + "name": "is_release", + "type": "bool", + "description": "Is release? If True, other search filter variables are ignored. If no query text or release_id is supplied, this defaults to True.", + "default": false, + "optional": true + }, + { + "name": "release_id", + "type": "Union[int, str]", + "description": "A specific release ID to target.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "limit", + "type": "int", + "description": "The number of data entries to return. (1-1000)", + "default": null, + "optional": true + }, + { + "name": "offset", + "type": "Annotated[int, Ge(ge=0)]", + "description": "Offset the results in conjunction with limit.", + "default": 0, + "optional": true + }, + { + "name": "filter_variable", + "type": "Literal['frequency', 'units', 'seasonal_adjustment']", + "description": "Filter by an attribute.", + "default": null, + "optional": true + }, + { + "name": "filter_value", + "type": "str", + "description": "String value to filter the variable by. Used in conjunction with filter_variable.", + "default": null, + "optional": true + }, + { + "name": "tag_names", + "type": "str", + "description": "A semicolon delimited list of tag names that series match all of. Example: 'japan;imports'", + "default": null, + "optional": true + }, + { + "name": "exclude_tag_names", + "type": "str", + "description": "A semicolon delimited list of tag names that series match none of. Example: 'imports;services'. Requires that variable tag_names also be set to limit the number of matching series.", + "default": null, + "optional": true + }, + { + "name": "series_id", + "type": "str", + "description": "A FRED Series ID to return series group information for. This returns the required information to query for regional data. Not all series that are in FRED have geographical data. Entering a value for series_id will override all other parameters. Multiple series_ids can be separated by commas.", + "default": null, "optional": true } - ], - "fmp": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[CalendarEarnings]", + "type": "List[FredSearch]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['fred']]", "description": "Provider name." }, { @@ -4768,202 +4833,166 @@ "data": { "standard": [ { - "name": "report_date", - "type": "date", - "description": "The date of the earnings report.", - "default": "", - "optional": false + "name": "release_id", + "type": "Union[int, str]", + "description": "The release ID for queries.", + "default": null, + "optional": true }, { - "name": "symbol", + "name": "series_id", "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "description": "The series ID for the item in the release.", + "default": null, + "optional": true }, { "name": "name", "type": "str", - "description": "Name of the entity.", + "description": "The name of the release.", "default": null, "optional": true }, { - "name": "eps_previous", - "type": "float", - "description": "The earnings-per-share from the same previously reported period.", + "name": "title", + "type": "str", + "description": "The title of the series.", "default": null, "optional": true }, { - "name": "eps_consensus", - "type": "float", - "description": "The analyst conesus earnings-per-share estimate.", + "name": "observation_start", + "type": "date", + "description": "The date of the first observation in the series.", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "eps_actual", - "type": "float", - "description": "The actual earnings per share announced.", + "name": "observation_end", + "type": "date", + "description": "The date of the last observation in the series.", "default": null, "optional": true }, { - "name": "revenue_actual", - "type": "float", - "description": "The actual reported revenue.", + "name": "frequency", + "type": "str", + "description": "The frequency of the data.", "default": null, "optional": true }, { - "name": "revenue_consensus", - "type": "float", - "description": "The revenue forecast consensus.", + "name": "frequency_short", + "type": "str", + "description": "Short form of the data frequency.", "default": null, "optional": true }, { - "name": "period_ending", - "type": "date", - "description": "The fiscal period end date.", + "name": "units", + "type": "str", + "description": "The units of the data.", "default": null, "optional": true }, { - "name": "reporting_time", + "name": "units_short", "type": "str", - "description": "The reporting time - e.g. after market close.", + "description": "Short form of the data units.", "default": null, "optional": true }, { - "name": "updated_date", - "type": "date", - "description": "The date the data was updated last.", + "name": "seasonal_adjustment", + "type": "str", + "description": "The seasonal adjustment of the data.", "default": null, "optional": true - } - ] - }, - "model": "CalendarEarnings" - }, - "/equity/compare/peers": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the closest peers for a given company.\n\nPeers consist of companies trading on the same exchange, operating within the same sector\nand with comparable market capitalizations.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.compare.peers(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "symbol", + "name": "seasonal_adjustment_short", "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "description": "Short form of the data seasonal adjustment.", + "default": null, "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EquityPeers]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "last_updated", + "type": "datetime", + "description": "The datetime of the last update to the data.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "notes", + "type": "str", + "description": "Description of the release.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "press_release", + "type": "bool", + "description": "If the release is a press release.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "peers_list", - "type": "List[str]", - "description": "A list of equity peers based on sector, exchange and market cap.", - "default": "", + "name": "url", + "type": "str", + "description": "URL to the release.", + "default": null, "optional": true } ], - "fmp": [] - }, - "model": "EquityPeers" - }, - "/equity/estimates/price_target": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get analyst price targets by company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.price_target(provider='benzinga')\n# Get price targets for Microsoft using 'benzinga' as provider.\nobb.equity.estimates.price_target(start_date=2020-01-01, end_date=2024-02-16, limit=10, symbol='msft', provider='benzinga', action=downgrades)\n```\n\n", - "parameters": { - "standard": [ + "fred": [ { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp.", + "name": "popularity", + "type": "int", + "description": "Popularity of the series", "default": null, "optional": true }, { - "name": "limit", + "name": "group_popularity", "type": "int", - "description": "The number of data entries to return.", - "default": 200, + "description": "Group popularity of the release", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['benzinga', 'fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default.", - "default": "benzinga", - "optional": true - } - ], - "benzinga": [ - { - "name": "page", - "type": "int", - "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. Used in conjunction with the limit and date parameters.", - "default": 0, + "name": "region_type", + "type": "str", + "description": "The region type of the series.", + "default": null, "optional": true }, { - "name": "date", - "type": "Union[date, str]", - "description": "Date for calendar data, shorthand for date_from and date_to.", + "name": "series_group", + "type": "Union[int, str]", + "description": "The series group ID of the series. This value is used to query for regional data.", "default": null, "optional": true + } + ] + }, + "model": "FredSearch" + }, + "/economy/fred_series": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get data by series ID from FRED.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.fred_series(symbol='NFCI', provider='fred')\n# Multiple series can be passed in as a list.\nobb.economy.fred_series(symbol='NFCI,STLFSI4', provider='fred')\n# Use the `transform` parameter to transform the data as change, log, or percent change.\nobb.economy.fred_series(symbol='CBBTCUSD', transform=pc1, provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fred.", + "default": "", + "optional": false }, { "name": "start_date", @@ -4980,55 +5009,64 @@ "optional": true }, { - "name": "updated", - "type": "Union[date, int]", - "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. The date can be a date string or a Unix timestamp. The date string must be in the format of YYYY-MM-DD.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100000, "optional": true }, { - "name": "importance", - "type": "int", - "description": "Importance level to filter by. Uses Greater Than or Equal To the importance indicated", - "default": null, + "name": "provider", + "type": "Literal['fred', 'intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", "optional": true - }, + } + ], + "fred": [ { - "name": "action", - "type": "Literal['downgrades', 'maintains', 'reinstates', 'reiterates', 'upgrades', 'assumes', 'initiates', 'terminates', 'removes', 'suspends', 'firm_dissolved']", - "description": "Filter by a specific action_company.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100000, "optional": true }, { - "name": "analyst_ids", - "type": "Union[List[str], str]", - "description": "Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts.", + "name": "frequency", + "type": "Literal['a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", + "description": "Frequency aggregation to convert high frequency data to lower frequency. None = No change a = Annual q = Quarterly m = Monthly w = Weekly d = Daily wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday", "default": null, "optional": true }, { - "name": "firm_ids", - "type": "Union[List[str], str]", - "description": "Comma-separated list of firm IDs.", - "default": null, + "name": "aggregation_method", + "type": "Literal['avg', 'sum', 'eop']", + "description": "A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. avg = Average sum = Sum eop = End of Period", + "default": "eop", "optional": true }, { - "name": "fields", - "type": "Union[List[str], str]", - "description": "Comma-separated list of fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields.", + "name": "transform", + "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", + "description": "Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log", "default": null, "optional": true } ], - "fmp": [ + "intrinio": [ { - "name": "with_grade", + "name": "all_pages", "type": "bool", - "description": "Include upgrades and downgrades in the response.", + "description": "Returns all pages of data from the API call at once.", "default": false, "optional": true + }, + { + "name": "sleep", + "type": "float", + "description": "Time to sleep between requests to avoid rate limiting.", + "default": 1.0, + "optional": true } ] }, @@ -5036,12 +5074,12 @@ "OBBject": [ { "name": "results", - "type": "List[PriceTarget]", + "type": "List[FredSeries]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['benzinga', 'fmp']]", + "type": "Optional[Literal['fred', 'intrinio']]", "description": "Provider name." }, { @@ -5064,253 +5102,223 @@ "data": { "standard": [ { - "name": "published_date", - "type": "Union[date, datetime]", - "description": "Published date of the price target.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false - }, + } + ], + "fred": [], + "intrinio": [ { - "name": "published_time", - "type": "datetime.time", - "description": "Time of the original rating, UTC.", + "name": "value", + "type": "float", + "description": "Value of the index.", "default": null, "optional": true - }, - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, + } + ] + }, + "model": "FredSeries" + }, + "/economy/money_measures": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Money Measures (M1/M2 and components).\n\nThe Federal Reserve publishes as part of the H.6 Release.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.money_measures(provider='federal_reserve')\nobb.economy.money_measures(adjusted=False, provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [ { - "name": "exchange", - "type": "str", - "description": "Exchange where the company is traded.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "company_name", - "type": "str", - "description": "Name of company that is the subject of rating.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "analyst_name", - "type": "str", - "description": "Analyst name.", - "default": null, + "name": "adjusted", + "type": "bool", + "description": "Whether to return seasonally adjusted data.", + "default": true, "optional": true }, { - "name": "analyst_firm", - "type": "str", - "description": "Name of the analyst firm that published the price target.", - "default": null, - "optional": true - }, - { - "name": "currency", - "type": "str", - "description": "Currency the data is denominated in.", - "default": null, + "name": "provider", + "type": "Literal['federal_reserve']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default.", + "default": "federal_reserve", "optional": true - }, + } + ], + "federal_reserve": [] + }, + "returns": { + "OBBject": [ { - "name": "price_target", - "type": "float", - "description": "The current price target.", - "default": null, - "optional": true + "name": "results", + "type": "List[MoneyMeasures]", + "description": "Serializable results." }, { - "name": "adj_price_target", - "type": "float", - "description": "Adjusted price target for splits and stock dividends.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['federal_reserve']]", + "description": "Provider name." }, { - "name": "price_target_previous", - "type": "float", - "description": "Previous price target.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "previous_adj_price_target", - "type": "float", - "description": "Previous adjusted price target.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "price_when_posted", - "type": "float", - "description": "Price when posted.", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "rating_current", - "type": "str", - "description": "The analyst's rating for the company.", - "default": null, - "optional": true + "name": "month", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "rating_previous", - "type": "str", - "description": "Previous analyst rating for the company.", - "default": null, - "optional": true + "name": "M1", + "type": "float", + "description": "Value of the M1 money supply in billions.", + "default": "", + "optional": false }, { - "name": "action", - "type": "str", - "description": "Description of the change in rating from firm's last rating.", - "default": null, - "optional": true - } - ], - "benzinga": [ - { - "name": "action", - "type": "Literal['Downgrades', 'Maintains', 'Reinstates', 'Reiterates', 'Upgrades', 'Assumes', 'Initiates Coverage On', 'Terminates Coverage On', 'Removes', 'Suspends', 'Firm Dissolved']", - "description": "Description of the change in rating from firm's last rating.Note that all of these terms are precisely defined.", - "default": null, - "optional": true + "name": "M2", + "type": "float", + "description": "Value of the M2 money supply in billions.", + "default": "", + "optional": false }, { - "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.", + "name": "currency", + "type": "float", + "description": "Value of currency in circulation in billions.", "default": null, "optional": true }, { - "name": "importance", - "type": "Literal[0, 1, 2, 3, 4, 5]", - "description": "Subjective Basis of How Important Event is to Market. 5 = High", + "name": "demand_deposits", + "type": "float", + "description": "Value of demand deposits in billions.", "default": null, "optional": true }, { - "name": "notes", - "type": "str", - "description": "Notes of the price target.", + "name": "retail_money_market_funds", + "type": "float", + "description": "Value of retail money market funds in billions.", "default": null, "optional": true }, { - "name": "analyst_id", - "type": "str", - "description": "Id of the analyst.", + "name": "other_liquid_deposits", + "type": "float", + "description": "Value of other liquid deposits in billions.", "default": null, "optional": true }, { - "name": "url_news", - "type": "str", - "description": "URL for analyst ratings news articles for this ticker on Benzinga.com.", + "name": "small_denomination_time_deposits", + "type": "float", + "description": "Value of small denomination time deposits in billions.", "default": null, "optional": true - }, + } + ], + "federal_reserve": [] + }, + "model": "MoneyMeasures" + }, + "/economy/unemployment": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get global unemployment data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.unemployment(provider='oecd')\nobb.economy.unemployment(country=all, frequency=quarterly, provider='oecd')\n# Demographics for the statistics are selected with the `age` parameter.\nobb.economy.unemployment(country=all, frequency=quarterly, age=25-54, provider='oecd')\n```\n\n", + "parameters": { + "standard": [ { - "name": "url_analyst", - "type": "str", - "description": "URL for analyst ratings page for this ticker on Benzinga.com.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "id", - "type": "str", - "description": "Unique ID of this entry.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "last_updated", - "type": "datetime", - "description": "Last updated timestamp, UTC.", - "default": null, + "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 } ], - "fmp": [ - { - "name": "news_url", - "type": "str", - "description": "News URL of the price target.", - "default": null, - "optional": true - }, + "oecd": [ { - "name": "news_title", - "type": "str", - "description": "News title of the price target.", - "default": null, + "name": "country", + "type": "Literal['colombia', 'new_zealand', 'united_kingdom', 'italy', 'luxembourg', 'euro_area19', 'sweden', 'oecd', 'south_africa', 'denmark', 'canada', 'switzerland', 'slovakia', 'hungary', 'portugal', 'spain', 'france', 'czech_republic', 'costa_rica', 'japan', 'slovenia', 'russia', 'austria', 'latvia', 'netherlands', 'israel', 'iceland', 'united_states', 'ireland', 'mexico', 'germany', 'greece', 'turkey', 'australia', 'poland', 'south_korea', 'chile', 'finland', 'european_union27_2020', 'norway', 'lithuania', 'euro_area20', 'estonia', 'belgium', 'brazil', 'indonesia', 'all']", + "description": "Country to get GDP for.", + "default": "united_states", "optional": true }, { - "name": "news_publisher", - "type": "str", - "description": "News publisher of the price target.", - "default": null, + "name": "sex", + "type": "Literal['total', 'male', 'female']", + "description": "Sex to get unemployment for.", + "default": "total", "optional": true }, { - "name": "news_base_url", - "type": "str", - "description": "News base URL of the price target.", - "default": null, + "name": "frequency", + "type": "Literal['monthly', 'quarterly', 'annual']", + "description": "Frequency to get unemployment for.", + "default": "monthly", "optional": true - } - ] - }, - "model": "PriceTarget" - }, - "/equity/estimates/historical": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get historical analyst estimates for earnings and revenue.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.historical(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", - "default": "", - "optional": false }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "period", - "type": "Literal['quarter', 'annual']", - "description": "Time period of the data to return.", - "default": "annual", + "name": "age", + "type": "Literal['total', '15-24', '15-64', '25-54', '55-64']", + "description": "Age group to get unemployment for. Total indicates 15 years or over", + "default": "total", "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": null, + "name": "seasonal_adjustment", + "type": "bool", + "description": "Whether to get seasonally adjusted unemployment. Defaults to False.", + "default": false, "optional": true } ] @@ -5319,12 +5327,12 @@ "OBBject": [ { "name": "results", - "type": "List[AnalystEstimates]", + "type": "List[Unemployment]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['oecd']]", "description": "Provider name." }, { @@ -5346,211 +5354,188 @@ }, "data": { "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, { "name": "date", "type": "date", "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "estimated_revenue_low", - "type": "int", - "description": "Estimated revenue low.", - "default": null, - "optional": true - }, - { - "name": "estimated_revenue_high", - "type": "int", - "description": "Estimated revenue high.", - "default": null, - "optional": true - }, - { - "name": "estimated_revenue_avg", - "type": "int", - "description": "Estimated revenue average.", - "default": null, - "optional": true - }, - { - "name": "estimated_sga_expense_low", - "type": "int", - "description": "Estimated SGA expense low.", "default": null, "optional": true }, { - "name": "estimated_sga_expense_high", - "type": "int", - "description": "Estimated SGA expense high.", - "default": null, - "optional": true - }, - { - "name": "estimated_sga_expense_avg", - "type": "int", - "description": "Estimated SGA expense average.", + "name": "value", + "type": "float", + "description": "Unemployment rate (given as a whole number, i.e 10=10%)", "default": null, "optional": true }, { - "name": "estimated_ebitda_low", - "type": "int", - "description": "Estimated EBITDA low.", + "name": "country", + "type": "str", + "description": "Country for which unemployment rate is given", "default": null, "optional": true - }, + } + ], + "oecd": [] + }, + "model": "Unemployment" + }, + "/economy/composite_leading_indicator": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Use the composite leading indicator (CLI).\n\nIt is designed to provide early signals of turning points\nin business cycles showing fluctuation of the economic activity around its long term potential level.\n\nCLIs show short-term economic movements in qualitative rather than quantitative terms.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.composite_leading_indicator(provider='oecd')\nobb.economy.composite_leading_indicator(country=all, provider='oecd')\n```\n\n", + "parameters": { + "standard": [ { - "name": "estimated_ebitda_high", - "type": "int", - "description": "Estimated EBITDA high.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "estimated_ebitda_avg", - "type": "int", - "description": "Estimated EBITDA average.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "estimated_ebit_low", - "type": "int", - "description": "Estimated EBIT low.", - "default": null, + "name": "provider", + "type": "Literal['oecd']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default.", + "default": "oecd", "optional": true - }, + } + ], + "oecd": [ { - "name": "estimated_ebit_high", - "type": "int", - "description": "Estimated EBIT high.", - "default": null, + "name": "country", + "type": "Literal['united_states', 'united_kingdom', 'japan', 'mexico', 'indonesia', 'australia', 'brazil', 'canada', 'italy', 'germany', 'turkey', 'france', 'south_africa', 'south_korea', 'spain', 'india', 'china', 'g7', 'g20', 'all']", + "description": "Country to get GDP for.", + "default": "united_states", "optional": true - }, + } + ] + }, + "returns": { + "OBBject": [ { - "name": "estimated_ebit_avg", - "type": "int", - "description": "Estimated EBIT average.", - "default": null, - "optional": true + "name": "results", + "type": "List[CLI]", + "description": "Serializable results." }, { - "name": "estimated_net_income_low", - "type": "int", - "description": "Estimated net income low.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['oecd']]", + "description": "Provider name." }, { - "name": "estimated_net_income_high", - "type": "int", - "description": "Estimated net income high.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "estimated_net_income_avg", - "type": "int", - "description": "Estimated net income average.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "estimated_eps_avg", - "type": "float", - "description": "Estimated EPS average.", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "estimated_eps_high", - "type": "float", - "description": "Estimated EPS high.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": null, "optional": true }, { - "name": "estimated_eps_low", + "name": "value", "type": "float", - "description": "Estimated EPS low.", - "default": null, - "optional": true - }, - { - "name": "number_analyst_estimated_revenue", - "type": "int", - "description": "Number of analysts who estimated revenue.", + "description": "CLI value", "default": null, "optional": true }, { - "name": "number_analysts_estimated_eps", - "type": "int", - "description": "Number of analysts who estimated EPS.", + "name": "country", + "type": "str", + "description": "Country for which CLI is given", "default": null, "optional": true } ], - "fmp": [] + "oecd": [] }, - "model": "AnalystEstimates" + "model": "CLI" }, - "/equity/estimates/consensus": { + "/economy/short_term_interest_rate": { "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", + "description": "Get Short-term interest rates.\n\nThey are the rates at which short-term borrowings are effected between\nfinancial institutions or the rate at which short-term government paper is issued or traded in the market.\n\nShort-term interest rates are generally averages of daily rates, measured as a percentage.\nShort-term interest rates are based on three-month money market rates where available.\nTypical standardised names are \"money market rate\" and \"treasury bill rate\".", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.short_term_interest_rate(provider='oecd')\nobb.economy.short_term_interest_rate(country=all, frequency=quarterly, provider='oecd')\n```\n\n", "parameters": { "standard": [ { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { "name": "provider", - "type": "Literal['fmp', 'intrinio', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "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 } ], - "fmp": [], - "intrinio": [ + "oecd": [ { - "name": "industry_group_number", - "type": "int", - "description": "The Zacks industry group number.", - "default": null, + "name": "country", + "type": "Literal['belgium', 'ireland', 'mexico', 'indonesia', 'new_zealand', 'japan', 'united_kingdom', 'france', 'chile', 'canada', 'netherlands', 'united_states', 'south_korea', 'norway', 'austria', 'south_africa', 'denmark', 'switzerland', 'hungary', 'luxembourg', 'australia', 'germany', 'sweden', 'iceland', 'turkey', 'greece', 'israel', 'czech_republic', 'latvia', 'slovenia', 'poland', 'estonia', 'lithuania', 'portugal', 'costa_rica', 'slovakia', 'finland', 'spain', 'russia', 'euro_area19', 'colombia', 'italy', 'india', 'china', 'croatia', 'all']", + "description": "Country to get GDP for.", + "default": "united_states", + "optional": true + }, + { + "name": "frequency", + "type": "Literal['monthly', 'quarterly', 'annual']", + "description": "Frequency to get interest rate for for.", + "default": "monthly", "optional": true } - ], - "yfinance": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[PriceTargetConsensus]", + "type": "List[STIR]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "type": "Optional[Literal['oecd']]", "description": "Provider name." }, { @@ -5573,199 +5558,237 @@ "data": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "name", - "type": "str", - "description": "The company name", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": null, "optional": true }, { - "name": "target_high", + "name": "value", "type": "float", - "description": "High target of the price target consensus.", + "description": "Interest rate (given as a whole number, i.e 10=10%)", "default": null, "optional": true }, { - "name": "target_low", - "type": "float", - "description": "Low target of the price target consensus.", - "default": null, - "optional": true - }, - { - "name": "target_consensus", - "type": "float", - "description": "Consensus target of the price target consensus.", - "default": null, - "optional": true - }, - { - "name": "target_median", - "type": "float", - "description": "Median target of the price target consensus.", + "name": "country", + "type": "str", + "description": "Country for which interest rate is given", "default": null, "optional": true } ], - "fmp": [], - "intrinio": [ + "oecd": [] + }, + "model": "STIR" + }, + "/economy/long_term_interest_rate": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Long-term interest rates that refer to government bonds maturing in ten years.\n\nRates are mainly determined by the price charged by the lender, the risk from the borrower and the\nfall in the capital value. Long-term interest rates are generally averages of daily rates,\nmeasured as a percentage. These interest rates are implied by the prices at which the government bonds are\ntraded on financial markets, not the interest rates at which the loans were issued.\nIn all cases, they refer to bonds whose capital repayment is guaranteed by governments.\nLong-term interest rates are one of the determinants of business investment.\nLow long-term interest rates encourage investment in new equipment and high interest rates discourage it.\nInvestment is, in turn, a major source of economic growth.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.long_term_interest_rate(provider='oecd')\nobb.economy.long_term_interest_rate(country=all, frequency=quarterly, provider='oecd')\n```\n\n", + "parameters": { + "standard": [ { - "name": "standard_deviation", - "type": "float", - "description": "The standard deviation of target price estimates.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "total_anaylsts", - "type": "int", - "description": "The total number of target price estimates in consensus.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "raised", - "type": "int", - "description": "The number of analysts that have raised their target price estimates.", - "default": null, + "name": "provider", + "type": "Literal['oecd']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default.", + "default": "oecd", "optional": true - }, + } + ], + "oecd": [ { - "name": "lowered", - "type": "int", - "description": "The number of analysts that have lowered their target price estimates.", - "default": null, + "name": "country", + "type": "Literal['belgium', 'ireland', 'mexico', 'indonesia', 'new_zealand', 'japan', 'united_kingdom', 'france', 'chile', 'canada', 'netherlands', 'united_states', 'south_korea', 'norway', 'austria', 'south_africa', 'denmark', 'switzerland', 'hungary', 'luxembourg', 'australia', 'germany', 'sweden', 'iceland', 'turkey', 'greece', 'israel', 'czech_republic', 'latvia', 'slovenia', 'poland', 'estonia', 'lithuania', 'portugal', 'costa_rica', 'slovakia', 'finland', 'spain', 'russia', 'euro_area19', 'colombia', 'italy', 'india', 'china', 'croatia', 'all']", + "description": "Country to get GDP for.", + "default": "united_states", "optional": true }, { - "name": "most_recent_date", - "type": "date", - "description": "The date of the most recent estimate.", - "default": null, + "name": "frequency", + "type": "Literal['monthly', 'quarterly', 'annual']", + "description": "Frequency to get interest rate for for.", + "default": "monthly", "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[LTIR]", + "description": "Serializable results." }, { - "name": "industry_group_number", - "type": "int", - "description": "The Zacks industry group number.", - "default": null, - "optional": true - } - ], - "yfinance": [ + "name": "provider", + "type": "Optional[Literal['oecd']]", + "description": "Provider name." + }, { - "name": "recommendation", - "type": "str", - "description": "Recommendation - buy, sell, etc.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "recommendation_mean", - "type": "float", - "description": "Mean recommendation score where 1 is strong buy and 5 is strong sell.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "number_of_analysts", - "type": "int", - "description": "Number of analysts providing opinions.", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", "default": null, "optional": true }, { - "name": "current_price", + "name": "value", "type": "float", - "description": "Current price of the stock.", + "description": "Interest rate (given as a whole number, i.e 10=10%)", "default": null, "optional": true }, { - "name": "currency", + "name": "country", "type": "str", - "description": "Currency the stock is priced in.", + "description": "Country for which interest rate is given", "default": null, "optional": true } - ] + ], + "oecd": [] }, - "model": "PriceTargetConsensus" + "model": "LTIR" }, - "/equity/estimates/analyst_search": { + "/economy/fred_regional": { "deprecated": { "flag": null, "message": null }, - "description": "Search for specific analysts and get their forecast track record.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.analyst_search(provider='benzinga')\nobb.equity.estimates.analyst_search(firm_name='Wedbush', provider='benzinga')\n```\n\n", + "description": "Query the Geo Fred API for regional economic data by series group.\n\nThe series group ID is found by using `fred_search` and the `series_id` parameter.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.fred_regional(symbol='NYICLAIMS', provider='fred')\n# With a date, time series data is returned.\nobb.economy.fred_regional(symbol='NYICLAIMS', start_date='2021-01-01', end_date='2021-12-31', limit=10, provider='fred')\n```\n\n", "parameters": { "standard": [ { - "name": "analyst_name", - "type": "Union[str, List[str]]", - "description": "Analyst names to return. Omitting will return all available analysts. Multiple items allowed for provider(s): benzinga.", + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "firm_name", - "type": "Union[str, List[str]]", - "description": "Firm names to return. Omitting will return all available firms. Multiple items allowed for provider(s): benzinga.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100000, + "optional": true + }, { "name": "provider", - "type": "Literal['benzinga']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default.", - "default": "benzinga", + "type": "Literal['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 } ], - "benzinga": [ + "fred": [ { - "name": "analyst_ids", - "type": "Union[str, List[str]]", - "description": "List of analyst IDs to return. Multiple items allowed for provider(s): benzinga.", - "default": null, + "name": "symbol", + "type": "str", + "description": "For this function, it is the series_group ID or series ID. If the symbol provided is for a series_group, set the `is_series_group` parameter to True. Not all series that are in FRED have geographical data.", + "default": "", + "optional": false + }, + { + "name": "is_series_group", + "type": "bool", + "description": "When True, the symbol provided is for a series_group, else it is for a series ID.", + "default": false, "optional": true }, { - "name": "firm_ids", - "type": "Union[str, List[str]]", - "description": "Firm IDs to return. Multiple items allowed for provider(s): benzinga.", + "name": "region_type", + "type": "Literal['bea', 'msa', 'frb', 'necta', 'state', 'country', 'county', 'censusregion']", + "description": "The type of regional data. Parameter is only valid when `is_series_group` is True.", "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "Number of results returned. Limit 1000.", - "default": 100, + "name": "season", + "type": "Literal['SA', 'NSA', 'SSA']", + "description": "The seasonal adjustments to the data. Parameter is only valid when `is_series_group` is True.", + "default": "NSA", "optional": true }, { - "name": "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, + "name": "units", + "type": "str", + "description": "The units of the data. This should match the units returned from searching by series ID. An incorrect field will not necessarily return an error. Parameter is only valid when `is_series_group` is True.", + "default": null, "optional": true }, { - "name": "fields", - "type": "Union[str, List[str]]", - "description": "Fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple items allowed for provider(s): benzinga.", + "name": "frequency", + "type": "Literal['d', 'w', 'bw', 'm', 'q', 'sa', 'a', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", + "description": "Frequency aggregation to convert high frequency data to lower frequency. Parameter is only valid when `is_series_group` is True. a = Annual sa= Semiannual q = Quarterly m = Monthly w = Weekly d = Daily wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday", "default": null, "optional": true + }, + { + "name": "aggregation_method", + "type": "Literal['avg', 'sum', 'eop']", + "description": "A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. Only valid when `is_series_group` is True. avg = Average sum = Sum eop = End of Period", + "default": "avg", + "optional": true + }, + { + "name": "transform", + "type": "Literal['lin', 'chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", + "description": "Transformation type. Only valid when `is_series_group` is True. lin = Levels (No transformation) chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log", + "default": "lin", + "optional": true } ] }, @@ -5773,12 +5796,12 @@ "OBBject": [ { "name": "results", - "type": "List[AnalystSearch]", + "type": "List[FredRegional]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['benzinga']]", + "type": "Optional[Literal['fred']]", "description": "Provider name." }, { @@ -5801,454 +5824,448 @@ "data": { "standard": [ { - "name": "last_updated", - "type": "datetime", - "description": "Date of the last update.", - "default": null, - "optional": true - }, + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + } + ], + "fred": [ { - "name": "firm_name", + "name": "region", "type": "str", - "description": "Firm name of the analyst.", - "default": null, - "optional": true + "description": "The name of the region.", + "default": "", + "optional": false }, { - "name": "name_first", - "type": "str", - "description": "Analyst first name.", - "default": null, - "optional": true + "name": "code", + "type": "Union[str, int]", + "description": "The code of the region.", + "default": "", + "optional": false }, { - "name": "name_last", - "type": "str", - "description": "Analyst last name.", + "name": "value", + "type": "Union[int, float]", + "description": "The obersvation value. The units are defined in the search results by series ID.", "default": null, "optional": true }, { - "name": "name_full", + "name": "series_id", "type": "str", - "description": "Analyst full name.", + "description": "The individual series ID for the region.", "default": "", "optional": false } - ], - "benzinga": [ + ] + }, + "model": "FredRegional" + }, + "/economy/country_profile": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get a profile of country statistics and economic indicators.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.country_profile(provider='econdb', country='united_kingdom')\n# Enter the country as the full name, or iso code. If `latest` is False, the complete history for each series is returned.\nobb.economy.country_profile(country='united_states,jp', latest=False, provider='econdb')\n```\n\n", + "parameters": { + "standard": [ { - "name": "analyst_id", - "type": "str", - "description": "ID of the analyst.", - "default": null, - "optional": true + "name": "country", + "type": "Union[str, List[str]]", + "description": "The country to get data. Multiple items allowed for provider(s): econdb.", + "default": "", + "optional": false }, { - "name": "firm_id", - "type": "str", - "description": "ID of the analyst firm.", - "default": null, + "name": "provider", + "type": "Literal['econdb']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'econdb' if there is no default.", + "default": "econdb", "optional": true - }, + } + ], + "econdb": [ { - "name": "smart_score", - "type": "float", - "description": "A weighted average of the total_ratings_percentile, overall_avg_return_percentile, and overall_success_rate", - "default": null, + "name": "latest", + "type": "bool", + "description": "If True, return only the latest data. If False, return all available data for each indicator.", + "default": true, "optional": true }, { - "name": "overall_success_rate", - "type": "float", - "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain overall.", - "default": null, + "name": "use_cache", + "type": "bool", + "description": "If True, the request will be cached for one day.Using cache is recommended to avoid needlessly requesting the same data.", + "default": true, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CountryProfile]", + "description": "Serializable results." }, { - "name": "overall_avg_return_percentile", - "type": "float", - "description": "The percentile (normalized) of this analyst's overall average return per rating in comparison to other analysts' overall average returns per rating.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['econdb']]", + "description": "Provider name." }, { - "name": "total_ratings_percentile", - "type": "float", - "description": "The percentile (normalized) of this analyst's total number of ratings in comparison to the total number of ratings published by all other analysts", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "total_ratings", - "type": "int", - "description": "Number of recommendations made by this analyst.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "overall_gain_count", - "type": "int", - "description": "The number of ratings that have gained value since the date of recommendation", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "country", + "type": "str", + "description": "", + "default": "", + "optional": false }, { - "name": "overall_loss_count", + "name": "population", "type": "int", - "description": "The number of ratings that have lost value since the date of recommendation", + "description": "Population.", "default": null, "optional": true }, { - "name": "overall_average_return", + "name": "gdp_usd", "type": "float", - "description": "The average percent (normalized) price difference per rating since the date of recommendation", + "description": "Gross Domestic Product, in billions of USD.", "default": null, "optional": true }, { - "name": "overall_std_dev", + "name": "gdp_qoq", "type": "float", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings since the date of recommendation", - "default": null, - "optional": true - }, - { - "name": "gain_count_1m", - "type": "int", - "description": "The number of ratings that have gained value over the last month", - "default": null, - "optional": true - }, - { - "name": "loss_count_1m", - "type": "int", - "description": "The number of ratings that have lost value over the last month", + "description": "GDP growth quarter-over-quarter change, as a normalized percent.", "default": null, "optional": true }, { - "name": "average_return_1m", + "name": "gdp_yoy", "type": "float", - "description": "The average percent (normalized) price difference per rating over the last month", + "description": "GDP growth year-over-year change, as a normalized percent.", "default": null, "optional": true }, { - "name": "std_dev_1m", + "name": "cpi_yoy", "type": "float", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last month", + "description": "Consumer Price Index year-over-year change, as a normalized percent.", "default": null, "optional": true }, { - "name": "smart_score_1m", + "name": "core_yoy", "type": "float", - "description": "A weighted average smart score over the last month.", + "description": "Core Consumer Price Index year-over-year change, as a normalized percent.", "default": null, "optional": true }, { - "name": "success_rate_1m", + "name": "retail_sales_yoy", "type": "float", - "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last month", + "description": "Retail Sales year-over-year change, as a normalized percent.", "default": null, "optional": true }, { - "name": "gain_count_3m", - "type": "int", - "description": "The number of ratings that have gained value over the last 3 months", + "name": "industrial_production_yoy", + "type": "float", + "description": "Industrial Production year-over-year change, as a normalized percent.", "default": null, "optional": true }, { - "name": "loss_count_3m", - "type": "int", - "description": "The number of ratings that have lost value over the last 3 months", + "name": "policy_rate", + "type": "float", + "description": "Short term policy rate, as a normalized percent.", "default": null, "optional": true }, { - "name": "average_return_3m", + "name": "yield_10y", "type": "float", - "description": "The average percent (normalized) price difference per rating over the last 3 months", + "description": "10-year government bond yield, as a normalized percent.", "default": null, "optional": true }, { - "name": "std_dev_3m", + "name": "govt_debt_gdp", "type": "float", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 months", + "description": "Government debt as a percent (normalized) of GDP.", "default": null, "optional": true }, { - "name": "smart_score_3m", + "name": "current_account_gdp", "type": "float", - "description": "A weighted average smart score over the last 3 months.", + "description": "Current account balance as a percent (normalized) of GDP.", "default": null, "optional": true }, { - "name": "success_rate_3m", + "name": "jobless_rate", "type": "float", - "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 months", + "description": "Unemployment rate, as a normalized percent.", "default": null, "optional": true - }, + } + ], + "econdb": [] + }, + "model": "CountryProfile" + }, + "/economy/available_indicators": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the available economic indicators for a provider.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.available_indicators(provider='econdb')\n```\n\n", + "parameters": { + "standard": [ { - "name": "gain_count_6m", - "type": "int", - "description": "The number of ratings that have gained value over the last 6 months", - "default": null, + "name": "provider", + "type": "Literal['econdb']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'econdb' if there is no default.", + "default": "econdb", "optional": true - }, + } + ], + "econdb": [ { - "name": "loss_count_6m", - "type": "int", - "description": "The number of ratings that have lost value over the last 6 months", - "default": null, + "name": "use_cache", + "type": "bool", + "description": "Whether to use cache or not, by default is True The cache of indicator symbols will persist for one week.", + "default": true, "optional": true - }, + } + ] + }, + "returns": { + "OBBject": [ { - "name": "average_return_6m", - "type": "float", - "description": "The average percent (normalized) price difference per rating over the last 6 months", - "default": null, - "optional": true + "name": "results", + "type": "List[AvailableIndicators]", + "description": "Serializable results." }, { - "name": "std_dev_6m", - "type": "float", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 6 months", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['econdb']]", + "description": "Provider name." }, { - "name": "gain_count_9m", - "type": "int", - "description": "The number of ratings that have gained value over the last 9 months", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "loss_count_9m", - "type": "int", - "description": "The number of ratings that have lost value over the last 9 months", - "default": null, - "optional": true - }, - { - "name": "average_return_9m", - "type": "float", - "description": "The average percent (normalized) price difference per rating over the last 9 months", - "default": null, - "optional": true - }, - { - "name": "std_dev_9m", - "type": "float", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 9 months", - "default": null, - "optional": true - }, - { - "name": "smart_score_9m", - "type": "float", - "description": "A weighted average smart score over the last 9 months.", - "default": null, - "optional": true - }, - { - "name": "success_rate_9m", - "type": "float", - "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 9 months", - "default": null, - "optional": true - }, - { - "name": "gain_count_1y", - "type": "int", - "description": "The number of ratings that have gained value over the last 1 year", - "default": null, - "optional": true - }, - { - "name": "loss_count_1y", - "type": "int", - "description": "The number of ratings that have lost value over the last 1 year", - "default": null, - "optional": true - }, - { - "name": "average_return_1y", - "type": "float", - "description": "The average percent (normalized) price difference per rating over the last 1 year", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "std_dev_1y", - "type": "float", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 1 year", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "smart_score_1y", - "type": "float", - "description": "A weighted average smart score over the last 1 year.", + "name": "symbol_root", + "type": "str", + "description": "The root symbol representing the indicator.", "default": null, "optional": true }, { - "name": "success_rate_1y", - "type": "float", - "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 1 year", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. The root symbol with additional codes.", "default": null, "optional": true }, { - "name": "gain_count_2y", - "type": "int", - "description": "The number of ratings that have gained value over the last 2 years", + "name": "country", + "type": "str", + "description": "The name of the country, region, or entity represented by the symbol.", "default": null, "optional": true }, { - "name": "loss_count_2y", - "type": "int", - "description": "The number of ratings that have lost value over the last 2 years", + "name": "iso", + "type": "str", + "description": "The ISO code of the country, region, or entity represented by the symbol.", "default": null, "optional": true }, { - "name": "average_return_2y", - "type": "float", - "description": "The average percent (normalized) price difference per rating over the last 2 years", + "name": "description", + "type": "str", + "description": "The description of the indicator.", "default": null, "optional": true }, { - "name": "std_dev_2y", - "type": "float", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 2 years", + "name": "frequency", + "type": "str", + "description": "The frequency of the indicator data.", "default": null, "optional": true - }, + } + ], + "econdb": [ { - "name": "smart_score_2y", - "type": "float", - "description": "A weighted average smart score over the last 3 years.", + "name": "currency", + "type": "str", + "description": "The currency, or unit, the data is based in.", "default": null, "optional": true }, { - "name": "success_rate_2y", - "type": "float", - "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 2 years", + "name": "scale", + "type": "str", + "description": "The scale of the data.", "default": null, "optional": true }, { - "name": "gain_count_3y", + "name": "multiplier", "type": "int", - "description": "The number of ratings that have gained value over the last 3 years", - "default": null, - "optional": true + "description": "The multiplier of the data to arrive at whole units.", + "default": "", + "optional": false }, { - "name": "loss_count_3y", - "type": "int", - "description": "The number of ratings that have lost value over the last 3 years", - "default": null, - "optional": true + "name": "transformation", + "type": "str", + "description": "Transformation type.", + "default": "", + "optional": false }, { - "name": "average_return_3y", - "type": "float", - "description": "The average percent (normalized) price difference per rating over the last 3 years", + "name": "source", + "type": "str", + "description": "The original source of the data.", "default": null, "optional": true }, { - "name": "std_dev_3y", - "type": "float", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 years", + "name": "first_date", + "type": "date", + "description": "The first date of the data.", "default": null, "optional": true }, { - "name": "smart_score_3y", - "type": "float", - "description": "A weighted average smart score over the last 3 years.", + "name": "last_date", + "type": "date", + "description": "The last date of the data.", "default": null, "optional": true }, { - "name": "success_rate_3y", - "type": "float", - "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 years", + "name": "last_insert_timestamp", + "type": "datetime", + "description": "The time of the last update. Data is typically reported with a lag.", "default": null, "optional": true } ] }, - "model": "AnalystSearch" + "model": "AvailableIndicators" }, - "/equity/estimates/forward_sales": { + "/economy/indicators": { "deprecated": { "flag": null, "message": null }, - "description": "Get forward sales estimates.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.forward_sales(symbol='AAPL', provider='intrinio')\nobb.equity.estimates.forward_sales(fiscal_year=2025, fiscal_period=fy, provider='intrinio')\n```\n\n", + "description": "Get economic indicators by country and indicator.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.indicators(provider='econdb', symbol='PCOCO')\n# Enter the country as the full name, or iso code. Use `available_indicators()` to get a list of supported indicators from EconDB.\nobb.economy.indicators(symbol='CPI', country='united_states,jp', provider='econdb')\n# Use the `main` symbol to get the group of main indicators for a country.\nobb.economy.indicators(provider='econdb', symbol='main', country='eu')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", + "description": "Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Multiple items allowed for provider(s): econdb.", + "default": "", + "optional": false + }, + { + "name": "country", + "type": "Union[str, List[str]]", + "description": "The country to get data. The country represented by the indicator, if available. Multiple items allowed for provider(s): econdb.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "fiscal_year", - "type": "int", - "description": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "fiscal_period", - "type": "Literal['fy', 'q1', 'q2', 'q3', 'q4']", - "description": "The future fiscal period to retrieve estimates for.", + "name": "provider", + "type": "Literal['econdb']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'econdb' if there is no default.", + "default": "econdb", + "optional": true + } + ], + "econdb": [ + { + "name": "transform", + "type": "Literal['toya', 'tpop', 'tusd', 'tpgp']", + "description": "The transformation to apply to the data, default is None. tpop: Change from previous period toya: Change from one year ago tusd: Values as US dollars tpgp: Values as a percent of GDP Only 'tpop' and 'toya' are applicable to all indicators. Applying transformations across multiple indicators/countries may produce unexpected results. This is because not all indicators are compatible with all transformations, and the original units and scale differ between entities. `tusd` should only be used where values are currencies.", "default": null, "optional": true }, { - "name": "calendar_year", - "type": "int", - "description": "The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", - "default": null, + "name": "frequency", + "type": "Literal['annual', 'quarter', 'month']", + "description": "The frequency of the data, default is 'quarter'. Only valid when 'symbol' is 'main'.", + "default": "quarter", "optional": true }, { - "name": "calendar_period", - "type": "Literal['q1', 'q2', 'q3', 'q4']", - "description": "The future calendar period to retrieve estimates for.", - "default": null, + "name": "use_cache", + "type": "bool", + "description": "If True, the request will be cached for one day. Using cache is recommended to avoid needlessly requesting the same data.", + "default": true, "optional": true } ] @@ -6257,12 +6274,12 @@ "OBBject": [ { "name": "results", - "type": "List[ForwardSalesEstimates]", + "type": "List[EconomicIndicators]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['intrinio']]", + "type": "Optional[Literal['econdb']]", "description": "Provider name." }, { @@ -6284,20 +6301,6 @@ }, "data": { "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "name", - "type": "str", - "description": "Name of the entity.", - "default": null, - "optional": true - }, { "name": "date", "type": "date", @@ -6306,218 +6309,119 @@ "optional": false }, { - "name": "fiscal_year", - "type": "int", - "description": "Fiscal year for the estimate.", + "name": "symbol_root", + "type": "str", + "description": "The root symbol for the indicator (e.g. GDP).", "default": null, "optional": true }, { - "name": "fiscal_period", + "name": "symbol", "type": "str", - "description": "Fiscal quarter for the estimate.", - "default": null, - "optional": true - }, - { - "name": "calendar_year", - "type": "int", - "description": "Calendar year for the estimate.", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "calendar_period", + "name": "country", "type": "str", - "description": "Calendar quarter for the estimate.", - "default": null, - "optional": true - }, - { - "name": "low_estimate", - "type": "int", - "description": "The sales estimate low for the period.", - "default": null, - "optional": true - }, - { - "name": "high_estimate", - "type": "int", - "description": "The sales estimate high for the period.", - "default": null, - "optional": true - }, - { - "name": "mean", - "type": "int", - "description": "The sales estimate mean for the period.", - "default": null, - "optional": true - }, - { - "name": "median", - "type": "int", - "description": "The sales estimate median for the period.", - "default": null, - "optional": true - }, - { - "name": "standard_deviation", - "type": "int", - "description": "The sales estimate standard deviation for the period.", + "description": "The country represented by the data.", "default": null, "optional": true }, { - "name": "number_of_analysts", - "type": "int", - "description": "Number of analysts providing estimates for the period.", + "name": "value", + "type": "Union[int, float]", + "description": "", "default": null, "optional": true } ], - "intrinio": [ - { - "name": "revisions_1w_up", - "type": "int", - "description": "Number of revisions up in the last week.", - "default": null, - "optional": true - }, - { - "name": "revisions_1w_down", - "type": "int", - "description": "Number of revisions down in the last week.", - "default": null, - "optional": true - }, - { - "name": "revisions_1w_change_percent", - "type": "float", - "description": "The analyst revisions percent change in estimate for the period of 1 week.", - "default": null, - "optional": true - }, - { - "name": "revisions_1m_up", - "type": "int", - "description": "Number of revisions up in the last month.", - "default": null, - "optional": true - }, - { - "name": "revisions_1m_down", - "type": "int", - "description": "Number of revisions down in the last month.", - "default": null, - "optional": true - }, - { - "name": "revisions_1m_change_percent", - "type": "float", - "description": "The analyst revisions percent change in estimate for the period of 1 month.", - "default": null, - "optional": true - }, - { - "name": "revisions_3m_up", - "type": "int", - "description": "Number of revisions up in the last 3 months.", - "default": null, - "optional": true - }, - { - "name": "revisions_3m_down", - "type": "int", - "description": "Number of revisions down in the last 3 months.", - "default": null, - "optional": true - }, - { - "name": "revisions_3m_change_percent", - "type": "float", - "description": "The analyst revisions percent change in estimate for the period of 3 months.", - "default": null, - "optional": true - } - ] + "econdb": [] }, - "model": "ForwardSalesEstimates" + "model": "EconomicIndicators" }, - "/equity/estimates/forward_eps": { + "/equity/calendar/ipo": { "deprecated": { "flag": null, "message": null }, - "description": "Get forward EPS estimates.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.forward_eps(symbol='AAPL', provider='intrinio')\nobb.equity.estimates.forward_eps(fiscal_year=2025, fiscal_period=fy, provider='intrinio')\n```\n\n", + "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')\nobb.equity.calendar.ipo(limit=100, provider='nasdaq')\n# Get all IPOs available.\nobb.equity.calendar.ipo(provider='intrinio')\n# Get IPOs for specific dates.\nobb.equity.calendar.ipo(start_date='2024-02-01', end_date='2024-02-07', provider='nasdaq')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", + "type": "str", + "description": "Symbol to get data for.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "fiscal_period", - "type": "Literal['annual', 'quarter']", - "description": "The future fiscal period to retrieve estimates for.", - "default": "annual", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, "optional": true }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", - "default": null, + "default": 100, "optional": true }, { - "name": "include_historical", - "type": "bool", - "description": "If True, the data will include all past data and the limit will be ignored.", - "default": false, + "name": "provider", + "type": "Literal['intrinio', 'nasdaq']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", "optional": true } ], "intrinio": [ { - "name": "fiscal_year", - "type": "int", - "description": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", + "name": "status", + "type": "Literal['upcoming', 'priced', 'withdrawn']", + "description": "Status of the IPO. [upcoming, priced, or withdrawn]", "default": null, "optional": true }, { - "name": "fiscal_period", - "type": "Literal['fy', 'q1', 'q2', 'q3', 'q4']", - "description": "The future fiscal period to retrieve estimates for.", + "name": "min_value", + "type": "int", + "description": "Return IPOs with an offer dollar amount greater than the given amount.", "default": null, "optional": true }, { - "name": "calendar_year", + "name": "max_value", "type": "int", - "description": "The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", + "description": "Return IPOs with an offer dollar amount less than the given amount.", "default": null, "optional": true + } + ], + "nasdaq": [ + { + "name": "status", + "type": "Literal['upcoming', 'priced', 'filed', 'withdrawn']", + "description": "The status of the IPO.", + "default": "priced", + "optional": true }, { - "name": "calendar_period", - "type": "Literal['q1', 'q2', 'q3', 'q4']", - "description": "The future calendar period to retrieve estimates for.", - "default": null, + "name": "is_spo", + "type": "bool", + "description": "If True, returns data for secondary public offerings (SPOs).", + "default": false, "optional": true } ] @@ -6526,12 +6430,12 @@ "OBBject": [ { "name": "results", - "type": "List[ForwardEpsEstimates]", + "type": "List[CalendarIpo]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio']]", + "type": "Optional[Literal['intrinio', 'nasdaq']]", "description": "Provider name." }, { @@ -6557,297 +6461,257 @@ "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "name", - "type": "str", - "description": "Name of the entity.", "default": null, "optional": true }, { - "name": "date", + "name": "ipo_date", "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "fiscal_year", - "type": "int", - "description": "Fiscal year for the estimate.", - "default": null, - "optional": true - }, - { - "name": "fiscal_period", - "type": "str", - "description": "Fiscal quarter for the estimate.", + "description": "The date of the IPO, when the stock first trades on a major exchange.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "calendar_year", - "type": "int", - "description": "Calendar year for the estimate.", + "name": "status", + "type": "Literal['upcoming', 'priced', 'withdrawn']", + "description": "The status of the IPO. Upcoming IPOs have not taken place yet but are expected to. Priced IPOs have taken place. Withdrawn IPOs were expected to take place, but were subsequently withdrawn.", "default": null, "optional": true }, { - "name": "calendar_period", + "name": "exchange", "type": "str", - "description": "Calendar quarter for the estimate.", + "description": "The acronym of the stock exchange that the company is going to trade publicly on. Typically NYSE or NASDAQ.", "default": null, "optional": true }, { - "name": "low_estimate", + "name": "offer_amount", "type": "float", - "description": "Estimated EPS low for the period.", + "description": "The total dollar amount of shares offered in the IPO. Typically this is share price * share count", "default": null, "optional": true }, { - "name": "high_estimate", + "name": "share_price", "type": "float", - "description": "Estimated EPS high for the period.", + "description": "The price per share at which the IPO was offered.", "default": null, "optional": true }, { - "name": "mean", + "name": "share_price_lowest", "type": "float", - "description": "Estimated EPS mean for the period.", + "description": "The expected lowest price per share at which the IPO will be offered. Before an IPO is priced, companies typically provide a range of prices per share at which they expect to offer the IPO (typically available for upcoming IPOs).", "default": null, "optional": true }, { - "name": "median", + "name": "share_price_highest", "type": "float", - "description": "Estimated EPS median for the period.", + "description": "The expected highest price per share at which the IPO will be offered. Before an IPO is priced, companies typically provide a range of prices per share at which they expect to offer the IPO (typically available for upcoming IPOs).", "default": null, "optional": true }, { - "name": "standard_deviation", - "type": "float", - "description": "Estimated EPS standard deviation for the period.", + "name": "share_count", + "type": "int", + "description": "The number of shares offered in the IPO.", "default": null, "optional": true }, { - "name": "number_of_analysts", + "name": "share_count_lowest", "type": "int", - "description": "Number of analysts providing estimates for the period.", + "description": "The expected lowest number of shares that will be offered in the IPO. Before an IPO is priced, companies typically provide a range of shares that they expect to offer in the IPO (typically available for upcoming IPOs).", "default": null, "optional": true - } - ], - "fmp": [], - "intrinio": [ + }, { - "name": "revisions_change_percent", - "type": "float", - "description": "The earnings per share (EPS) percent change in estimate for the period.", + "name": "share_count_highest", + "type": "int", + "description": "The expected highest number of shares that will be offered in the IPO. Before an IPO is priced, companies typically provide a range of shares that they expect to offer in the IPO (typically available for upcoming IPOs).", "default": null, "optional": true }, { - "name": "mean_1w", - "type": "float", - "description": "The mean estimate for the period one week ago.", + "name": "announcement_url", + "type": "str", + "description": "The URL to the company's announcement of the IPO", "default": null, "optional": true }, { - "name": "mean_1m", - "type": "float", - "description": "The mean estimate for the period one month ago.", + "name": "sec_report_url", + "type": "str", + "description": "The URL to the company's S-1, S-1/A, F-1, or F-1/A SEC filing, which is required to be filed before an IPO takes place.", "default": null, "optional": true }, { - "name": "mean_2m", + "name": "open_price", "type": "float", - "description": "The mean estimate for the period two months ago.", + "description": "The opening price at the beginning of the first trading day (only available for priced IPOs).", "default": null, "optional": true }, { - "name": "mean_3m", + "name": "close_price", "type": "float", - "description": "The mean estimate for the period three months ago.", + "description": "The closing price at the end of the first trading day (only available for priced IPOs).", "default": null, "optional": true - } - ] - }, - "model": "ForwardEpsEstimates" - }, - "/equity/discovery/gainers": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the top price gainers in the stock market.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.gainers(provider='yfinance')\nobb.equity.discovery.gainers(sort='desc', provider='yfinance')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", - "default": "desc", + "name": "volume", + "type": "int", + "description": "The volume at the end of the first trading day (only available for priced IPOs).", + "default": null, "optional": true }, { - "name": "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", + "name": "day_change", + "type": "float", + "description": "The percentage change between the open price and the close price on the first trading day (only available for priced IPOs).", + "default": null, "optional": true - } - ], - "yfinance": [] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[EquityGainers]", - "description": "Serializable results." + "name": "week_change", + "type": "float", + "description": "The percentage change between the open price on the first trading day and the close price approximately a week after the first trading day (only available for priced IPOs).", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['yfinance']]", - "description": "Provider name." + "name": "month_change", + "type": "float", + "description": "The percentage change between the open price on the first trading day and the close price approximately a month after the first trading day (only available for priced IPOs).", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "id", + "type": "str", + "description": "The Intrinio ID of the IPO.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "company", + "type": "IntrinioCompany", + "description": "The company that is going public via the IPO.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "security", + "type": "IntrinioSecurity", + "description": "The primary Security for the Company that is going public via the IPO", + "default": null, + "optional": true } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, + ], + "nasdaq": [ { "name": "name", "type": "str", - "description": "Name of the entity.", - "default": "", - "optional": false + "description": "The name of the company.", + "default": null, + "optional": true }, { - "name": "price", + "name": "offer_amount", "type": "float", - "description": "Last price.", - "default": "", - "optional": false + "description": "The dollar value of the shares offered.", + "default": null, + "optional": true }, { - "name": "change", - "type": "float", - "description": "Change in price value.", - "default": "", - "optional": false + "name": "share_count", + "type": "int", + "description": "The number of shares offered.", + "default": null, + "optional": true }, { - "name": "percent_change", - "type": "float", - "description": "Percent change.", - "default": "", - "optional": false + "name": "expected_price_date", + "type": "date", + "description": "The date the pricing is expected.", + "default": null, + "optional": true }, { - "name": "volume", - "type": "float", - "description": "The trading volume.", - "default": "", - "optional": false - } - ], - "yfinance": [ - { - "name": "market_cap", - "type": "float", - "description": "Market Cap.", - "default": "", - "optional": false + "name": "filed_date", + "type": "date", + "description": "The date the IPO was filed.", + "default": null, + "optional": true }, { - "name": "avg_volume_3_months", - "type": "float", - "description": "Average volume over the last 3 months in millions.", - "default": "", - "optional": false + "name": "withdraw_date", + "type": "date", + "description": "The date the IPO was withdrawn.", + "default": null, + "optional": true }, { - "name": "pe_ratio_ttm", - "type": "float", - "description": "PE Ratio (TTM).", + "name": "deal_status", + "type": "str", + "description": "The status of the deal.", "default": null, "optional": true } ] }, - "model": "EquityGainers" + "model": "CalendarIpo" }, - "/equity/discovery/losers": { + "/equity/calendar/dividend": { "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", + "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# Get dividend calendar for specific dates.\nobb.equity.calendar.dividend(start_date='2024-02-01', end_date='2024-02-07', provider='nasdaq')\n```\n\n", "parameters": { "standard": [ { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", - "default": "desc", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, "optional": true }, { "name": "provider", - "type": "Literal['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", + "type": "Literal['fmp', 'nasdaq']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true } ], - "yfinance": [] + "fmp": [], + "nasdaq": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EquityLosers]", + "type": "List[CalendarDividend]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['yfinance']]", + "type": "Optional[Literal['fmp', 'nasdaq']]", "description": "Provider name." }, { @@ -6870,110 +6734,126 @@ "data": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "ex_dividend_date", + "type": "date", + "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", "default": "", "optional": false }, { - "name": "name", + "name": "symbol", "type": "str", - "description": "Name of the entity.", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "price", + "name": "amount", "type": "float", - "description": "Last price.", - "default": "", - "optional": false + "description": "The dividend amount per share.", + "default": null, + "optional": true }, { - "name": "change", - "type": "float", - "description": "Change in price value.", - "default": "", - "optional": false + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": null, + "optional": true }, { - "name": "percent_change", - "type": "float", - "description": "Percent change.", - "default": "", - "optional": false + "name": "record_date", + "type": "date", + "description": "The record date of ownership for eligibility.", + "default": null, + "optional": true }, { - "name": "volume", - "type": "float", - "description": "The trading volume.", - "default": "", - "optional": false - } + "name": "payment_date", + "type": "date", + "description": "The payment date of the dividend.", + "default": null, + "optional": true + }, + { + "name": "declaration_date", + "type": "date", + "description": "Declaration date of the dividend.", + "default": null, + "optional": true + } ], - "yfinance": [ + "fmp": [ { - "name": "market_cap", + "name": "adjusted_amount", "type": "float", - "description": "Market Cap.", - "default": "", - "optional": false + "description": "The adjusted-dividend amount.", + "default": null, + "optional": true }, { - "name": "avg_volume_3_months", - "type": "float", - "description": "Average volume over the last 3 months in millions.", - "default": "", - "optional": false - }, + "name": "label", + "type": "str", + "description": "Ex-dividend date formatted for display.", + "default": null, + "optional": true + } + ], + "nasdaq": [ { - "name": "pe_ratio_ttm", + "name": "annualized_amount", "type": "float", - "description": "PE Ratio (TTM).", + "description": "The indicated annualized dividend amount.", "default": null, "optional": true } ] }, - "model": "EquityLosers" + "model": "CalendarDividend" }, - "/equity/discovery/active": { + "/equity/calendar/splits": { "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", + "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": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", - "default": "desc", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, "optional": true }, { "name": "provider", - "type": "Literal['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", + "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 } ], - "yfinance": [] + "fmp": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EquityActive]", + "type": "List[CalendarSplits]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['yfinance']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -6996,110 +6876,90 @@ "data": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "name", + "name": "label", "type": "str", - "description": "Name of the entity.", - "default": "", - "optional": false - }, - { - "name": "price", - "type": "float", - "description": "Last price.", + "description": "Label of the stock splits.", "default": "", "optional": false }, { - "name": "change", - "type": "float", - "description": "Change in price value.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "percent_change", + "name": "numerator", "type": "float", - "description": "Percent change.", + "description": "Numerator of the stock splits.", "default": "", "optional": false }, { - "name": "volume", + "name": "denominator", "type": "float", - "description": "The trading volume.", + "description": "Denominator of the stock splits.", "default": "", "optional": false } ], - "yfinance": [ - { - "name": "market_cap", - "type": "float", - "description": "Market Cap displayed in billions.", - "default": "", - "optional": false - }, - { - "name": "avg_volume_3_months", - "type": "float", - "description": "Average volume over the last 3 months in millions.", - "default": "", - "optional": false - }, - { - "name": "pe_ratio_ttm", - "type": "float", - "description": "PE Ratio (TTM).", - "default": null, - "optional": true - } - ] + "fmp": [] }, - "model": "EquityActive" + "model": "CalendarSplits" }, - "/equity/discovery/undervalued_large_caps": { + "/equity/calendar/earnings": { "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", + "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": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", - "default": "desc", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, "optional": true }, { "name": "provider", - "type": "Literal['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", + "type": "Literal['fmp', 'nasdaq', 'tmx']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true } ], - "yfinance": [] + "fmp": [], + "nasdaq": [], + "tmx": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EquityUndervaluedLargeCaps]", + "type": "List[CalendarEarnings]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['yfinance']]", + "type": "Optional[Literal['fmp', 'nasdaq', 'tmx']]", "description": "Provider name." }, { @@ -7121,6 +6981,13 @@ }, "data": { "standard": [ + { + "name": "report_date", + "type": "date", + "description": "The date of the earnings report.", + "default": "", + "optional": false + }, { "name": "symbol", "type": "str", @@ -7132,226 +6999,202 @@ "name": "name", "type": "str", "description": "Name of the entity.", - "default": "", - "optional": false - }, - { - "name": "price", - "type": "float", - "description": "Last price.", - "default": "", - "optional": false - }, - { - "name": "change", - "type": "float", - "description": "Change in price value.", - "default": "", - "optional": false + "default": null, + "optional": true }, { - "name": "percent_change", + "name": "eps_previous", "type": "float", - "description": "Percent change.", - "default": "", - "optional": false + "description": "The earnings-per-share from the same previously reported period.", + "default": null, + "optional": true }, { - "name": "volume", + "name": "eps_consensus", "type": "float", - "description": "The trading volume.", - "default": "", - "optional": false + "description": "The analyst conesus earnings-per-share estimate.", + "default": null, + "optional": true } ], - "yfinance": [ + "fmp": [ { - "name": "market_cap", + "name": "eps_actual", "type": "float", - "description": "Market Cap.", + "description": "The actual earnings per share announced.", "default": null, "optional": true }, { - "name": "avg_volume_3_months", + "name": "revenue_actual", "type": "float", - "description": "Average volume over the last 3 months in millions.", + "description": "The actual reported revenue.", "default": null, "optional": true }, { - "name": "pe_ratio_ttm", + "name": "revenue_consensus", "type": "float", - "description": "PE Ratio (TTM).", + "description": "The revenue forecast consensus.", "default": null, "optional": true - } - ] - }, - "model": "EquityUndervaluedLargeCaps" - }, - "/equity/discovery/undervalued_growth": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get potentially undervalued growth stocks.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.undervalued_growth(provider='yfinance')\nobb.equity.discovery.undervalued_growth(sort='desc', provider='yfinance')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", - "default": "desc", + "name": "period_ending", + "type": "date", + "description": "The fiscal period end date.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default.", - "default": "yfinance", + "name": "reporting_time", + "type": "str", + "description": "The reporting time - e.g. after market close.", + "default": null, + "optional": true + }, + { + "name": "updated_date", + "type": "date", + "description": "The date the data was updated last.", + "default": null, "optional": true } ], - "yfinance": [] - }, - "returns": { - "OBBject": [ + "nasdaq": [ { - "name": "results", - "type": "List[EquityUndervaluedGrowth]", - "description": "Serializable results." + "name": "eps_actual", + "type": "float", + "description": "The actual earnings per share (USD) announced.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['yfinance']]", - "description": "Provider name." + "name": "surprise_percent", + "type": "float", + "description": "The earnings surprise as normalized percentage points.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "num_estimates", + "type": "int", + "description": "The number of analysts providing estimates for the consensus.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "period_ending", + "type": "str", + "description": "The fiscal period end date.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "previous_report_date", + "type": "date", + "description": "The previous report date for the same period last year.", + "default": null, + "optional": true + }, { - "name": "symbol", + "name": "reporting_time", "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "description": "The reporting time - e.g. after market close.", + "default": null, + "optional": true }, + { + "name": "market_cap", + "type": "int", + "description": "The market cap (USD) of the reporting entity.", + "default": null, + "optional": true + } + ], + "tmx": [ { "name": "name", "type": "str", - "description": "Name of the entity.", - "default": "", - "optional": false - }, - { - "name": "price", - "type": "float", - "description": "Last price.", + "description": "The company's name.", "default": "", "optional": false }, { - "name": "change", + "name": "eps_consensus", "type": "float", - "description": "Change in price value.", - "default": "", - "optional": false + "description": "The consensus estimated EPS in dollars.", + "default": null, + "optional": true }, { - "name": "percent_change", + "name": "eps_actual", "type": "float", - "description": "Percent change.", - "default": "", - "optional": false + "description": "The actual EPS in dollars.", + "default": null, + "optional": true }, { - "name": "volume", - "type": "float", - "description": "The trading volume.", - "default": "", - "optional": false - } - ], - "yfinance": [ - { - "name": "market_cap", + "name": "eps_surprise", "type": "float", - "description": "Market Cap.", + "description": "The EPS surprise in dollars.", "default": null, "optional": true }, { - "name": "avg_volume_3_months", + "name": "surprise_percent", "type": "float", - "description": "Average volume over the last 3 months in millions.", + "description": "The EPS surprise as a normalized percent.", "default": null, "optional": true }, { - "name": "pe_ratio_ttm", - "type": "float", - "description": "PE Ratio (TTM).", + "name": "reporting_time", + "type": "str", + "description": "The time of the report - i.e., before or after market.", "default": null, "optional": true } ] }, - "model": "EquityUndervaluedGrowth" + "model": "CalendarEarnings" }, - "/equity/discovery/aggressive_small_caps": { + "/equity/compare/peers": { "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", + "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": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", - "default": "desc", - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { "name": "provider", - "type": "Literal['yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default.", - "default": "yfinance", + "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 } ], - "yfinance": [] + "fmp": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EquityAggressiveSmallCaps]", + "type": "List[EquityPeers]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['yfinance']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -7374,110 +7217,75 @@ "data": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "name", - "type": "str", - "description": "Name of the entity.", - "default": "", - "optional": false - }, - { - "name": "price", - "type": "float", - "description": "Last price.", - "default": "", - "optional": false - }, - { - "name": "change", - "type": "float", - "description": "Change in price value.", - "default": "", - "optional": false - }, - { - "name": "percent_change", - "type": "float", - "description": "Percent change.", - "default": "", - "optional": false - }, - { - "name": "volume", - "type": "float", - "description": "The trading volume.", + "name": "peers_list", + "type": "List[str]", + "description": "A list of equity peers based on sector, exchange and market cap.", "default": "", - "optional": false + "optional": true } ], - "yfinance": [ + "fmp": [] + }, + "model": "EquityPeers" + }, + "/equity/compare/groups": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get company data grouped by sector, industry or country and display either performance or valuation metrics.\n\nValuation metrics include price to earnings, price to book, price to sales ratios and price to cash flow.\nPerformance metrics include the stock price change for different time periods.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.compare.groups(provider='finviz')\n# Group by sector and analyze valuation.\nobb.equity.compare.groups(group='sector', metric='valuation', provider='finviz')\n# Group by industry and analyze performance.\nobb.equity.compare.groups(group='industry', metric='performance', provider='finviz')\n# Group by country and analyze valuation.\nobb.equity.compare.groups(group='country', metric='valuation', provider='finviz')\n```\n\n", + "parameters": { + "standard": [ { - "name": "market_cap", - "type": "float", - "description": "Market Cap.", + "name": "group", + "type": "str", + "description": "The group to compare - i.e., 'sector', 'industry', 'country'. Choices vary by provider.", "default": null, "optional": true }, { - "name": "avg_volume_3_months", - "type": "float", - "description": "Average volume over the last 3 months in millions.", + "name": "metric", + "type": "str", + "description": "The type of metrics to compare - i.e, 'valuation', 'performance'. Choices vary by provider.", "default": null, "optional": true }, { - "name": "pe_ratio_ttm", - "type": "float", - "description": "PE Ratio (TTM).", - "default": null, + "name": "provider", + "type": "Literal['finviz']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default.", + "default": "finviz", "optional": true } - ] - }, - "model": "EquityAggressiveSmallCaps" - }, - "/equity/discovery/growth_tech": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get top tech stocks based on revenue and earnings growth.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.growth_tech(provider='yfinance')\nobb.equity.discovery.growth_tech(sort='desc', provider='yfinance')\n```\n\n", - "parameters": { - "standard": [ + ], + "finviz": [ { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", - "default": "desc", + "name": "group", + "type": "Literal['sector', 'industry', 'country', 'capitalization', 'energy', 'materials', 'industrials', 'consumer_cyclical', 'consumer_defensive', 'healthcare', 'financial', 'technology', 'communication_services', 'utilities', 'real_estate']", + "description": "US-listed stocks only. When a sector is selected, it is broken down by industry. The default is sector.", + "default": "sector", "optional": true }, { - "name": "provider", - "type": "Literal['yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default.", - "default": "yfinance", + "name": "metric", + "type": "Literal['performance', 'valuation', 'overview']", + "description": "Select from: performance, valuation, overview. The default is performance.", + "default": "performance", "optional": true } - ], - "yfinance": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[GrowthTechEquities]", + "type": "List[CompareGroups]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['yfinance']]", + "type": "Optional[Literal['finviz']]", "description": "Provider name." }, { @@ -7500,83 +7308,211 @@ "data": { "standard": [ { - "name": "symbol", + "name": "name", "type": "str", - "description": "Symbol representing the entity requested in the data.", + "description": "Name or label of the group.", "default": "", "optional": false + } + ], + "finviz": [ + { + "name": "stocks", + "type": "int", + "description": "The number of stocks in the group.", + "default": null, + "optional": true }, { - "name": "name", - "type": "str", - "description": "Name of the entity.", - "default": "", - "optional": false + "name": "market_cap", + "type": "int", + "description": "The market cap of the group.", + "default": null, + "optional": true }, { - "name": "price", + "name": "performance_1D", "type": "float", - "description": "Last price.", - "default": "", - "optional": false + "description": "The performance in the last day, as a normalized percent.", + "default": null, + "optional": true }, { - "name": "change", + "name": "performance_1W", "type": "float", - "description": "Change in price value.", - "default": "", - "optional": false + "description": "The performance in the last week, as a normalized percent.", + "default": null, + "optional": true }, { - "name": "percent_change", + "name": "performance_1M", "type": "float", - "description": "Percent change.", - "default": "", - "optional": false + "description": "The performance in the last month, as a normalized percent.", + "default": null, + "optional": true }, { - "name": "volume", + "name": "performance_3M", "type": "float", - "description": "The trading volume.", - "default": "", - "optional": false - } - ], - "yfinance": [ + "description": "The performance in the last quarter, as a normalized percent.", + "default": null, + "optional": true + }, { - "name": "market_cap", + "name": "performance_6M", "type": "float", - "description": "Market Cap.", + "description": "The performance in the last half year, as a normalized percent.", "default": null, "optional": true }, { - "name": "avg_volume_3_months", + "name": "performance_1Y", "type": "float", - "description": "Average volume over the last 3 months in millions.", + "description": "The performance in the last year, as a normalized percent.", "default": null, "optional": true }, { - "name": "pe_ratio_ttm", + "name": "performance_YTD", "type": "float", - "description": "PE Ratio (TTM).", + "description": "The performance in the year to date, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "dividend_yield", + "type": "float", + "description": "The dividend yield of the group, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "pe", + "type": "float", + "description": "The P/E ratio of the group.", + "default": null, + "optional": true + }, + { + "name": "forward_pe", + "type": "float", + "description": "The forward P/E ratio of the group.", + "default": null, + "optional": true + }, + { + "name": "peg", + "type": "float", + "description": "The PEG ratio of the group.", + "default": null, + "optional": true + }, + { + "name": "eps_growth_past_5_years", + "type": "float", + "description": "The EPS growth of the group for the past 5 years, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "eps_growth_next_5_years", + "type": "float", + "description": "The estimated EPS growth of the groupo for the next 5 years, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "sales_growth_past_5_years", + "type": "float", + "description": "The sales growth of the group for the past 5 years, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "float_short", + "type": "float", + "description": "The percent of the float shorted for the group, as a normalized value.", + "default": null, + "optional": true + }, + { + "name": "analyst_recommendation", + "type": "float", + "description": "The analyst consensus, on a scale of 1-5 where 1 is a buy and 5 is a sell.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": null, + "optional": true + }, + { + "name": "volume_average", + "type": "int", + "description": "The 3-month average volume of the group.", + "default": null, + "optional": true + }, + { + "name": "volume_relative", + "type": "float", + "description": "The relative volume compared to the 3-month average volume.", "default": null, "optional": true } ] }, - "model": "GrowthTechEquities" + "model": "CompareGroups" }, - "/equity/discovery/filings": { + "/equity/estimates/price_target": { "deprecated": { "flag": null, "message": null }, - "description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more.\n\nSEC filings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114,\nForeign Investment Disclosures and others. The annual 10-K report is required to be\nfiled annually and includes the company's financial statements, management discussion and analysis,\nand audited financial statements.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.filings(provider='fmp')\n# Get filings for the year 2023, limited to 100 results\nobb.equity.discovery.filings(start_date='2023-01-01', end_date='2023-12-31', limit=100, provider='fmp')\n```\n\n", + "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, finviz, fmp.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 200, + "optional": true + }, + { + "name": "provider", + "type": "Literal['benzinga', 'finviz', 'fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default.", + "default": "benzinga", + "optional": true + } + ], + "benzinga": [ + { + "name": "page", + "type": "int", + "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. Used in conjunction with the limit and date parameters.", + "default": 0, + "optional": true + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "Date for calendar data, shorthand for date_from and date_to.", + "default": null, + "optional": true + }, { "name": "start_date", "type": "Union[date, str]", @@ -7592,33 +7528,55 @@ "optional": true }, { - "name": "form_type", - "type": "str", - "description": "Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types.", + "name": "updated", + "type": "Union[date, int]", + "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. The date can be a date string or a Unix timestamp. The date string must be in the format of YYYY-MM-DD.", "default": null, "optional": true }, { - "name": "limit", + "name": "importance", "type": "int", - "description": "The number of data entries to return.", - "default": 100, + "description": "Importance level to filter by. Uses Greater Than or Equal To the importance indicated", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "action", + "type": "Literal['downgrades', 'maintains', 'reinstates', 'reiterates', 'upgrades', 'assumes', 'initiates', 'terminates', 'removes', 'suspends', 'firm_dissolved']", + "description": "Filter by a specific action_company.", + "default": null, + "optional": true + }, + { + "name": "analyst_ids", + "type": "Union[List[str], str]", + "description": "Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts.", + "default": null, + "optional": true + }, + { + "name": "firm_ids", + "type": "Union[List[str], str]", + "description": "Comma-separated list of firm IDs.", + "default": null, + "optional": true + }, + { + "name": "fields", + "type": "Union[List[str], str]", + "description": "Comma-separated list of fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields.", + "default": null, "optional": true } ], + "finviz": [], "fmp": [ { - "name": "is_done", + "name": "with_grade", "type": "bool", - "description": "Flag for whether or not the filing is done.", - "default": null, + "description": "Include upgrades and downgrades in the response.", + "default": false, "optional": true } ] @@ -7627,12 +7585,12 @@ "OBBject": [ { "name": "results", - "type": "List[DiscoveryFilings]", + "type": "List[PriceTarget]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['benzinga', 'finviz', 'fmp']]", "description": "Provider name." }, { @@ -7655,710 +7613,768 @@ "data": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "published_date", + "type": "Union[date, datetime]", + "description": "Published date of the price target.", "default": "", "optional": false }, { - "name": "cik", + "name": "published_time", + "type": "datetime.time", + "description": "Time of the original rating, UTC.", + "default": null, + "optional": true + }, + { + "name": "symbol", "type": "str", - "description": "Central Index Key (CIK) for the requested entity.", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "title", + "name": "exchange", "type": "str", - "description": "Title of the filing.", - "default": "", - "optional": false + "description": "Exchange where the company is traded.", + "default": null, + "optional": true }, { - "name": "date", - "type": "datetime", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "company_name", + "type": "str", + "description": "Name of company that is the subject of rating.", + "default": null, + "optional": true }, { - "name": "form_type", + "name": "analyst_name", "type": "str", - "description": "The form type of the filing", - "default": "", - "optional": false + "description": "Analyst name.", + "default": null, + "optional": true }, { - "name": "link", + "name": "analyst_firm", "type": "str", - "description": "URL to the filing page on the SEC site.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "DiscoveryFilings" - }, - "/equity/fundamental/multiples": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get equity valuation multiples for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.multiples(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ + "description": "Name of the analyst firm that published the price target.", + "default": null, + "optional": true + }, { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", - "default": "", - "optional": false + "name": "currency", + "type": "str", + "description": "Currency the data is denominated in.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EquityValuationMultiples]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "revenue_per_share_ttm", + "name": "price_target", "type": "float", - "description": "Revenue per share calculated as trailing twelve months.", + "description": "The current price target.", "default": null, "optional": true }, { - "name": "net_income_per_share_ttm", + "name": "adj_price_target", "type": "float", - "description": "Net income per share calculated as trailing twelve months.", + "description": "Adjusted price target for splits and stock dividends.", "default": null, "optional": true }, { - "name": "operating_cash_flow_per_share_ttm", + "name": "price_target_previous", "type": "float", - "description": "Operating cash flow per share calculated as trailing twelve months.", + "description": "Previous price target.", "default": null, "optional": true }, { - "name": "free_cash_flow_per_share_ttm", + "name": "previous_adj_price_target", "type": "float", - "description": "Free cash flow per share calculated as trailing twelve months.", + "description": "Previous adjusted price target.", "default": null, "optional": true }, { - "name": "cash_per_share_ttm", + "name": "price_when_posted", "type": "float", - "description": "Cash per share calculated as trailing twelve months.", + "description": "Price when posted.", "default": null, "optional": true }, { - "name": "book_value_per_share_ttm", - "type": "float", - "description": "Book value per share calculated as trailing twelve months.", + "name": "rating_current", + "type": "str", + "description": "The analyst's rating for the company.", "default": null, "optional": true }, { - "name": "tangible_book_value_per_share_ttm", - "type": "float", - "description": "Tangible book value per share calculated as trailing twelve months.", + "name": "rating_previous", + "type": "str", + "description": "Previous analyst rating for the company.", "default": null, "optional": true }, { - "name": "shareholders_equity_per_share_ttm", - "type": "float", - "description": "Shareholders equity per share calculated as trailing twelve months.", + "name": "action", + "type": "str", + "description": "Description of the change in rating from firm's last rating.", "default": null, "optional": true - }, + } + ], + "benzinga": [ { - "name": "interest_debt_per_share_ttm", - "type": "float", - "description": "Interest debt per share calculated as trailing twelve months.", + "name": "action", + "type": "Literal['Downgrades', 'Maintains', 'Reinstates', 'Reiterates', 'Upgrades', 'Assumes', 'Initiates Coverage On', 'Terminates Coverage On', 'Removes', 'Suspends', 'Firm Dissolved']", + "description": "Description of the change in rating from firm's last rating.Note that all of these terms are precisely defined.", "default": null, "optional": true }, { - "name": "market_cap_ttm", - "type": "float", - "description": "Market capitalization calculated as trailing twelve months.", + "name": "action_change", + "type": "Literal['Announces', 'Maintains', 'Lowers', 'Raises', 'Removes', 'Adjusts']", + "description": "Description of the change in price target from firm's last price target.", "default": null, "optional": true }, { - "name": "enterprise_value_ttm", - "type": "float", - "description": "Enterprise value calculated as trailing twelve months.", + "name": "importance", + "type": "Literal[0, 1, 2, 3, 4, 5]", + "description": "Subjective Basis of How Important Event is to Market. 5 = High", "default": null, "optional": true }, { - "name": "pe_ratio_ttm", - "type": "float", - "description": "Price-to-earnings ratio (P/E ratio) calculated as trailing twelve months.", + "name": "notes", + "type": "str", + "description": "Notes of the price target.", "default": null, "optional": true }, { - "name": "price_to_sales_ratio_ttm", - "type": "float", - "description": "Price-to-sales ratio calculated as trailing twelve months.", + "name": "analyst_id", + "type": "str", + "description": "Id of the analyst.", "default": null, "optional": true }, { - "name": "pocf_ratio_ttm", - "type": "float", - "description": "Price-to-operating cash flow ratio calculated as trailing twelve months.", + "name": "url_news", + "type": "str", + "description": "URL for analyst ratings news articles for this ticker on Benzinga.com.", "default": null, "optional": true }, { - "name": "pfcf_ratio_ttm", - "type": "float", - "description": "Price-to-free cash flow ratio calculated as trailing twelve months.", + "name": "url_analyst", + "type": "str", + "description": "URL for analyst ratings page for this ticker on Benzinga.com.", "default": null, "optional": true }, { - "name": "pb_ratio_ttm", - "type": "float", - "description": "Price-to-book ratio calculated as trailing twelve months.", + "name": "id", + "type": "str", + "description": "Unique ID of this entry.", "default": null, "optional": true }, { - "name": "ptb_ratio_ttm", - "type": "float", - "description": "Price-to-tangible book ratio calculated as trailing twelve months.", + "name": "last_updated", + "type": "datetime", + "description": "Last updated timestamp, UTC.", "default": null, "optional": true - }, + } + ], + "finviz": [ { - "name": "ev_to_sales_ttm", - "type": "float", - "description": "Enterprise value-to-sales ratio calculated as trailing twelve months.", + "name": "status", + "type": "str", + "description": "The action taken by the firm. This could be 'Upgrade', 'Downgrade', 'Reiterated', etc.", "default": null, "optional": true }, { - "name": "enterprise_value_over_ebitda_ttm", - "type": "float", - "description": "Enterprise value-to-EBITDA ratio calculated as trailing twelve months.", + "name": "rating_change", + "type": "str", + "description": "The rating given by the analyst. This could be 'Buy', 'Sell', 'Underweight', etc. If the rating is a revision, the change is indicated by '->'", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "ev_to_operating_cash_flow_ttm", - "type": "float", - "description": "Enterprise value-to-operating cash flow ratio calculated as trailing twelve months.", + "name": "news_url", + "type": "str", + "description": "News URL of the price target.", "default": null, "optional": true }, { - "name": "ev_to_free_cash_flow_ttm", - "type": "float", - "description": "Enterprise value-to-free cash flow ratio calculated as trailing twelve months.", + "name": "news_title", + "type": "str", + "description": "News title of the price target.", "default": null, "optional": true }, { - "name": "earnings_yield_ttm", - "type": "float", - "description": "Earnings yield calculated as trailing twelve months.", + "name": "news_publisher", + "type": "str", + "description": "News publisher of the price target.", "default": null, "optional": true }, { - "name": "free_cash_flow_yield_ttm", - "type": "float", - "description": "Free cash flow yield calculated as trailing twelve months.", + "name": "news_base_url", + "type": "str", + "description": "News base URL of the price target.", "default": null, "optional": true - }, + } + ] + }, + "model": "PriceTarget" + }, + "/equity/estimates/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical analyst estimates for earnings and revenue.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.historical(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "debt_to_equity_ttm", - "type": "float", - "description": "Debt-to-equity ratio calculated as trailing twelve months.", - "default": null, - "optional": true + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false }, { - "name": "debt_to_assets_ttm", - "type": "float", - "description": "Debt-to-assets ratio calculated as trailing twelve months.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "net_debt_to_ebitda_ttm", - "type": "float", - "description": "Net debt-to-EBITDA ratio calculated as trailing twelve months.", - "default": null, + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return.", + "default": "annual", "optional": true }, { - "name": "current_ratio_ttm", - "type": "float", - "description": "Current ratio calculated as trailing twelve months.", + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", "default": null, "optional": true - }, + } + ] + }, + "returns": { + "OBBject": [ { - "name": "interest_coverage_ttm", - "type": "float", - "description": "Interest coverage calculated as trailing twelve months.", - "default": null, - "optional": true + "name": "results", + "type": "List[AnalystEstimates]", + "description": "Serializable results." }, { - "name": "income_quality_ttm", - "type": "float", - "description": "Income quality calculated as trailing twelve months.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "dividend_yield_ttm", - "type": "float", - "description": "Dividend yield calculated as trailing twelve months.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "dividend_yield_percentage_ttm", - "type": "float", - "description": "Dividend yield percentage calculated as trailing twelve months.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "dividend_to_market_cap_ttm", - "type": "float", - "description": "Dividend to market capitalization ratio calculated as trailing twelve months.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "dividend_per_share_ttm", - "type": "float", - "description": "Dividend per share calculated as trailing twelve months.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "payout_ratio_ttm", - "type": "float", - "description": "Payout ratio calculated as trailing twelve months.", + "name": "estimated_revenue_low", + "type": "int", + "description": "Estimated revenue low.", "default": null, "optional": true }, { - "name": "sales_general_and_administrative_to_revenue_ttm", - "type": "float", - "description": "Sales general and administrative expenses-to-revenue ratio calculated as trailing twelve months.", + "name": "estimated_revenue_high", + "type": "int", + "description": "Estimated revenue high.", "default": null, "optional": true }, { - "name": "research_and_development_to_revenue_ttm", - "type": "float", - "description": "Research and development expenses-to-revenue ratio calculated as trailing twelve months.", + "name": "estimated_revenue_avg", + "type": "int", + "description": "Estimated revenue average.", "default": null, "optional": true }, { - "name": "intangibles_to_total_assets_ttm", - "type": "float", - "description": "Intangibles-to-total assets ratio calculated as trailing twelve months.", + "name": "estimated_sga_expense_low", + "type": "int", + "description": "Estimated SGA expense low.", "default": null, "optional": true }, { - "name": "capex_to_operating_cash_flow_ttm", - "type": "float", - "description": "Capital expenditures-to-operating cash flow ratio calculated as trailing twelve months.", + "name": "estimated_sga_expense_high", + "type": "int", + "description": "Estimated SGA expense high.", "default": null, "optional": true }, { - "name": "capex_to_revenue_ttm", - "type": "float", - "description": "Capital expenditures-to-revenue ratio calculated as trailing twelve months.", + "name": "estimated_sga_expense_avg", + "type": "int", + "description": "Estimated SGA expense average.", "default": null, "optional": true }, { - "name": "capex_to_depreciation_ttm", - "type": "float", - "description": "Capital expenditures-to-depreciation ratio calculated as trailing twelve months.", + "name": "estimated_ebitda_low", + "type": "int", + "description": "Estimated EBITDA low.", "default": null, "optional": true }, { - "name": "stock_based_compensation_to_revenue_ttm", - "type": "float", - "description": "Stock-based compensation-to-revenue ratio calculated as trailing twelve months.", + "name": "estimated_ebitda_high", + "type": "int", + "description": "Estimated EBITDA high.", "default": null, "optional": true }, { - "name": "graham_number_ttm", - "type": "float", - "description": "Graham number calculated as trailing twelve months.", + "name": "estimated_ebitda_avg", + "type": "int", + "description": "Estimated EBITDA average.", "default": null, "optional": true }, { - "name": "roic_ttm", - "type": "float", - "description": "Return on invested capital calculated as trailing twelve months.", + "name": "estimated_ebit_low", + "type": "int", + "description": "Estimated EBIT low.", "default": null, "optional": true }, { - "name": "return_on_tangible_assets_ttm", - "type": "float", - "description": "Return on tangible assets calculated as trailing twelve months.", + "name": "estimated_ebit_high", + "type": "int", + "description": "Estimated EBIT high.", "default": null, "optional": true }, { - "name": "graham_net_net_ttm", - "type": "float", - "description": "Graham net-net working capital calculated as trailing twelve months.", + "name": "estimated_ebit_avg", + "type": "int", + "description": "Estimated EBIT average.", "default": null, "optional": true }, { - "name": "working_capital_ttm", - "type": "float", - "description": "Working capital calculated as trailing twelve months.", + "name": "estimated_net_income_low", + "type": "int", + "description": "Estimated net income low.", "default": null, "optional": true }, { - "name": "tangible_asset_value_ttm", - "type": "float", - "description": "Tangible asset value calculated as trailing twelve months.", + "name": "estimated_net_income_high", + "type": "int", + "description": "Estimated net income high.", "default": null, "optional": true }, { - "name": "net_current_asset_value_ttm", - "type": "float", - "description": "Net current asset value calculated as trailing twelve months.", + "name": "estimated_net_income_avg", + "type": "int", + "description": "Estimated net income average.", "default": null, "optional": true }, { - "name": "invested_capital_ttm", + "name": "estimated_eps_avg", "type": "float", - "description": "Invested capital calculated as trailing twelve months.", + "description": "Estimated EPS average.", "default": null, "optional": true }, { - "name": "average_receivables_ttm", + "name": "estimated_eps_high", "type": "float", - "description": "Average receivables calculated as trailing twelve months.", + "description": "Estimated EPS high.", "default": null, "optional": true }, { - "name": "average_payables_ttm", + "name": "estimated_eps_low", "type": "float", - "description": "Average payables calculated as trailing twelve months.", + "description": "Estimated EPS low.", "default": null, "optional": true }, { - "name": "average_inventory_ttm", - "type": "float", - "description": "Average inventory calculated as trailing twelve months.", + "name": "number_analyst_estimated_revenue", + "type": "int", + "description": "Number of analysts who estimated revenue.", "default": null, "optional": true }, { - "name": "days_sales_outstanding_ttm", - "type": "float", - "description": "Days sales outstanding calculated as trailing twelve months.", + "name": "number_analysts_estimated_eps", + "type": "int", + "description": "Number of analysts who estimated EPS.", "default": null, "optional": true - }, + } + ], + "fmp": [] + }, + "model": "AnalystEstimates" + }, + "/equity/estimates/consensus": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get consensus price target and recommendation.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.consensus(symbol='AAPL', provider='fmp')\nobb.equity.estimates.consensus(symbol='AAPL,MSFT', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ { - "name": "days_payables_outstanding_ttm", - "type": "float", - "description": "Days payables outstanding calculated as trailing twelve months.", + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, tmx, yfinance.", "default": null, "optional": true }, { - "name": "days_of_inventory_on_hand_ttm", - "type": "float", - "description": "Days of inventory on hand calculated as trailing twelve months.", + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'tmx', 'yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [], + "intrinio": [ + { + "name": "industry_group_number", + "type": "int", + "description": "The Zacks industry group number.", "default": null, "optional": true + } + ], + "tmx": [], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[PriceTargetConsensus]", + "description": "Serializable results." }, { - "name": "receivables_turnover_ttm", - "type": "float", - "description": "Receivables turnover calculated as trailing twelve months.", + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'tmx', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "The company name", "default": null, "optional": true }, { - "name": "payables_turnover_ttm", + "name": "target_high", "type": "float", - "description": "Payables turnover calculated as trailing twelve months.", + "description": "High target of the price target consensus.", "default": null, "optional": true }, { - "name": "inventory_turnover_ttm", + "name": "target_low", "type": "float", - "description": "Inventory turnover calculated as trailing twelve months.", + "description": "Low target of the price target consensus.", "default": null, "optional": true }, { - "name": "roe_ttm", + "name": "target_consensus", "type": "float", - "description": "Return on equity calculated as trailing twelve months.", + "description": "Consensus target of the price target consensus.", "default": null, "optional": true }, { - "name": "capex_per_share_ttm", + "name": "target_median", "type": "float", - "description": "Capital expenditures per share calculated as trailing twelve months.", + "description": "Median target of the price target consensus.", "default": null, "optional": true } ], - "fmp": [] - }, - "model": "EquityValuationMultiples" - }, - "/equity/fundamental/balance": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the balance sheet for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.balance(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.balance(symbol='AAPL', period='annual', limit=5, provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, + "fmp": [], + "intrinio": [ { - "name": "period", - "type": "str", - "description": "Time period of the data to return.", - "default": "annual", + "name": "standard_deviation", + "type": "float", + "description": "The standard deviation of target price estimates.", + "default": null, "optional": true }, { - "name": "limit", - "type": "Annotated[int, Ge(ge=0)]", - "description": "The number of data entries to return.", - "default": 5, + "name": "total_anaylsts", + "type": "int", + "description": "The total number of target price estimates in consensus.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "raised", + "type": "int", + "description": "The number of analysts that have raised their target price estimates.", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", + "name": "lowered", + "type": "int", + "description": "The number of analysts that have lowered their target price estimates.", + "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", + "name": "most_recent_date", + "type": "date", + "description": "The date of the most recent estimate.", + "default": null, "optional": true }, { - "name": "fiscal_year", + "name": "industry_group_number", "type": "int", - "description": "The specific fiscal year. Reports do not go beyond 2008.", + "description": "The Zacks industry group number.", "default": null, "optional": true } ], - "polygon": [ + "tmx": [ { - "name": "period", - "type": "Literal['annual', 'quarter', 'ttm']", - "description": "None", - "default": "annual", + "name": "target_upside", + "type": "float", + "description": "Percent of upside, as a normalized percent.", + "default": null, "optional": true }, { - "name": "filing_date", - "type": "date", - "description": "Filing date of the financial statement.", + "name": "total_analysts", + "type": "int", + "description": "Total number of analyst.", "default": null, "optional": true }, { - "name": "filing_date_lt", - "type": "date", - "description": "Filing date less than the given date.", + "name": "buy_ratings", + "type": "int", + "description": "Number of buy ratings.", "default": null, "optional": true }, { - "name": "filing_date_lte", - "type": "date", - "description": "Filing date less than or equal to the given date.", + "name": "sell_ratings", + "type": "int", + "description": "Number of sell ratings.", "default": null, "optional": true }, { - "name": "filing_date_gt", - "type": "date", - "description": "Filing date greater than the given date.", + "name": "hold_ratings", + "type": "int", + "description": "Number of hold ratings.", "default": null, "optional": true }, { - "name": "filing_date_gte", - "type": "date", - "description": "Filing date greater than or equal to the given date.", + "name": "consensus_action", + "type": "str", + "description": "Consensus action.", "default": null, "optional": true - }, + } + ], + "yfinance": [ { - "name": "period_of_report_date", - "type": "date", - "description": "Period of report date of the financial statement.", + "name": "recommendation", + "type": "str", + "description": "Recommendation - buy, sell, etc.", "default": null, "optional": true }, { - "name": "period_of_report_date_lt", - "type": "date", - "description": "Period of report date less than the given date.", + "name": "recommendation_mean", + "type": "float", + "description": "Mean recommendation score where 1 is strong buy and 5 is strong sell.", "default": null, "optional": true }, { - "name": "period_of_report_date_lte", - "type": "date", - "description": "Period of report date less than or equal to the given date.", + "name": "number_of_analysts", + "type": "int", + "description": "Number of analysts providing opinions.", "default": null, "optional": true }, { - "name": "period_of_report_date_gt", - "type": "date", - "description": "Period of report date greater than the given date.", + "name": "current_price", + "type": "float", + "description": "Current price of the stock.", "default": null, "optional": true }, { - "name": "period_of_report_date_gte", - "type": "date", - "description": "Period of report date greater than or equal to the given date.", + "name": "currency", + "type": "str", + "description": "Currency the stock is priced in.", "default": null, "optional": true - }, + } + ] + }, + "model": "PriceTargetConsensus" + }, + "/equity/estimates/analyst_search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search for specific analysts and get their forecast track record.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.analyst_search(provider='benzinga')\nobb.equity.estimates.analyst_search(firm_name='Wedbush', provider='benzinga')\n```\n\n", + "parameters": { + "standard": [ { - "name": "include_sources", - "type": "bool", - "description": "Whether to include the sources of the financial statement.", - "default": true, + "name": "analyst_name", + "type": "Union[str, List[str]]", + "description": "Analyst names to return. Omitting will return all available analysts. Multiple items allowed for provider(s): benzinga.", + "default": null, "optional": true }, { - "name": "order", - "type": "Literal['asc', 'desc']", - "description": "Order of the financial statement.", + "name": "firm_name", + "type": "Union[str, List[str]]", + "description": "Firm names to return. Omitting will return all available firms. Multiple items allowed for provider(s): benzinga.", "default": null, "optional": true }, { - "name": "sort", - "type": "Literal['filing_date', 'period_of_report_date']", - "description": "Sort of the financial statement.", - "default": null, + "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 } ], - "yfinance": [ + "benzinga": [ { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", + "name": "analyst_ids", + "type": "Union[str, List[str]]", + "description": "List of analyst IDs to return. Multiple items allowed for provider(s): benzinga.", + "default": null, + "optional": true + }, + { + "name": "firm_ids", + "type": "Union[str, List[str]]", + "description": "Firm IDs to return. Multiple items allowed for provider(s): benzinga.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "Number of results returned. Limit 1000.", + "default": 100, + "optional": true + }, + { + "name": "page", + "type": "int", + "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date.", + "default": 0, + "optional": true + }, + { + "name": "fields", + "type": "Union[str, List[str]]", + "description": "Fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple items allowed for provider(s): benzinga.", + "default": null, "optional": true } ] @@ -8367,12 +8383,12 @@ "OBBject": [ { "name": "results", - "type": "List[BalanceSheet]", + "type": "List[AnalystSearch]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", + "type": "Optional[Literal['benzinga']]", "description": "Provider name." }, { @@ -8395,1263 +8411,1295 @@ "data": { "standard": [ { - "name": "period_ending", - "type": "date", - "description": "The end date of the reporting period.", - "default": "", - "optional": false - }, - { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the report.", + "name": "last_updated", + "type": "datetime", + "description": "Date of the last update.", "default": null, "optional": true }, { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the fiscal period.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "filing_date", - "type": "date", - "description": "The date when the filing was made.", + "name": "firm_name", + "type": "str", + "description": "Firm name of the analyst.", "default": null, "optional": true }, { - "name": "accepted_date", - "type": "datetime", - "description": "The date and time when the filing was accepted.", + "name": "name_first", + "type": "str", + "description": "Analyst first name.", "default": null, "optional": true }, { - "name": "reported_currency", + "name": "name_last", "type": "str", - "description": "The currency in which the balance sheet was reported.", + "description": "Analyst last name.", "default": null, "optional": true }, { - "name": "cash_and_cash_equivalents", - "type": "float", - "description": "Cash and cash equivalents.", - "default": null, - "optional": true - }, + "name": "name_full", + "type": "str", + "description": "Analyst full name.", + "default": "", + "optional": false + } + ], + "benzinga": [ { - "name": "short_term_investments", - "type": "float", - "description": "Short term investments.", + "name": "analyst_id", + "type": "str", + "description": "ID of the analyst.", "default": null, "optional": true }, { - "name": "cash_and_short_term_investments", - "type": "float", - "description": "Cash and short term investments.", + "name": "firm_id", + "type": "str", + "description": "ID of the analyst firm.", "default": null, "optional": true }, { - "name": "net_receivables", + "name": "smart_score", "type": "float", - "description": "Net receivables.", + "description": "A weighted average of the total_ratings_percentile, overall_avg_return_percentile, and overall_success_rate", "default": null, "optional": true }, { - "name": "inventory", + "name": "overall_success_rate", "type": "float", - "description": "Inventory.", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain overall.", "default": null, "optional": true }, { - "name": "other_current_assets", + "name": "overall_avg_return_percentile", "type": "float", - "description": "Other current assets.", + "description": "The percentile (normalized) of this analyst's overall average return per rating in comparison to other analysts' overall average returns per rating.", "default": null, "optional": true }, { - "name": "total_current_assets", + "name": "total_ratings_percentile", "type": "float", - "description": "Total current assets.", + "description": "The percentile (normalized) of this analyst's total number of ratings in comparison to the total number of ratings published by all other analysts", "default": null, "optional": true }, { - "name": "plant_property_equipment_net", - "type": "float", - "description": "Plant property equipment net.", + "name": "total_ratings", + "type": "int", + "description": "Number of recommendations made by this analyst.", "default": null, "optional": true }, { - "name": "goodwill", - "type": "float", - "description": "Goodwill.", + "name": "overall_gain_count", + "type": "int", + "description": "The number of ratings that have gained value since the date of recommendation", "default": null, "optional": true }, { - "name": "intangible_assets", - "type": "float", - "description": "Intangible assets.", + "name": "overall_loss_count", + "type": "int", + "description": "The number of ratings that have lost value since the date of recommendation", "default": null, "optional": true }, { - "name": "goodwill_and_intangible_assets", + "name": "overall_average_return", "type": "float", - "description": "Goodwill and intangible assets.", + "description": "The average percent (normalized) price difference per rating since the date of recommendation", "default": null, "optional": true }, { - "name": "long_term_investments", + "name": "overall_std_dev", "type": "float", - "description": "Long term investments.", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings since the date of recommendation", "default": null, "optional": true }, { - "name": "tax_assets", - "type": "float", - "description": "Tax assets.", + "name": "gain_count_1m", + "type": "int", + "description": "The number of ratings that have gained value over the last month", "default": null, "optional": true }, { - "name": "other_non_current_assets", - "type": "float", - "description": "Other non current assets.", + "name": "loss_count_1m", + "type": "int", + "description": "The number of ratings that have lost value over the last month", "default": null, "optional": true }, { - "name": "non_current_assets", + "name": "average_return_1m", "type": "float", - "description": "Total non current assets.", + "description": "The average percent (normalized) price difference per rating over the last month", "default": null, "optional": true }, { - "name": "other_assets", + "name": "std_dev_1m", "type": "float", - "description": "Other assets.", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last month", "default": null, "optional": true }, { - "name": "total_assets", + "name": "smart_score_1m", "type": "float", - "description": "Total assets.", + "description": "A weighted average smart score over the last month.", "default": null, "optional": true }, { - "name": "accounts_payable", + "name": "success_rate_1m", "type": "float", - "description": "Accounts payable.", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last month", "default": null, "optional": true }, { - "name": "short_term_debt", - "type": "float", - "description": "Short term debt.", + "name": "gain_count_3m", + "type": "int", + "description": "The number of ratings that have gained value over the last 3 months", "default": null, "optional": true }, { - "name": "tax_payables", - "type": "float", - "description": "Tax payables.", + "name": "loss_count_3m", + "type": "int", + "description": "The number of ratings that have lost value over the last 3 months", "default": null, "optional": true }, { - "name": "current_deferred_revenue", + "name": "average_return_3m", "type": "float", - "description": "Current deferred revenue.", + "description": "The average percent (normalized) price difference per rating over the last 3 months", "default": null, "optional": true }, { - "name": "other_current_liabilities", + "name": "std_dev_3m", "type": "float", - "description": "Other current liabilities.", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 months", "default": null, "optional": true }, { - "name": "total_current_liabilities", + "name": "smart_score_3m", "type": "float", - "description": "Total current liabilities.", + "description": "A weighted average smart score over the last 3 months.", "default": null, "optional": true }, { - "name": "long_term_debt", + "name": "success_rate_3m", "type": "float", - "description": "Long term debt.", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 months", "default": null, "optional": true }, { - "name": "deferred_revenue_non_current", - "type": "float", - "description": "Non current deferred revenue.", + "name": "gain_count_6m", + "type": "int", + "description": "The number of ratings that have gained value over the last 6 months", "default": null, "optional": true }, { - "name": "deferred_tax_liabilities_non_current", - "type": "float", - "description": "Deferred tax liabilities non current.", + "name": "loss_count_6m", + "type": "int", + "description": "The number of ratings that have lost value over the last 6 months", "default": null, "optional": true }, { - "name": "other_non_current_liabilities", + "name": "average_return_6m", "type": "float", - "description": "Other non current liabilities.", + "description": "The average percent (normalized) price difference per rating over the last 6 months", "default": null, "optional": true }, { - "name": "total_non_current_liabilities", + "name": "std_dev_6m", "type": "float", - "description": "Total non current liabilities.", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 6 months", "default": null, "optional": true }, { - "name": "other_liabilities", - "type": "float", - "description": "Other liabilities.", + "name": "gain_count_9m", + "type": "int", + "description": "The number of ratings that have gained value over the last 9 months", "default": null, "optional": true }, { - "name": "capital_lease_obligations", - "type": "float", - "description": "Capital lease obligations.", + "name": "loss_count_9m", + "type": "int", + "description": "The number of ratings that have lost value over the last 9 months", "default": null, "optional": true }, { - "name": "total_liabilities", + "name": "average_return_9m", "type": "float", - "description": "Total liabilities.", + "description": "The average percent (normalized) price difference per rating over the last 9 months", "default": null, "optional": true }, { - "name": "preferred_stock", + "name": "std_dev_9m", "type": "float", - "description": "Preferred stock.", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 9 months", "default": null, "optional": true }, { - "name": "common_stock", + "name": "smart_score_9m", "type": "float", - "description": "Common stock.", + "description": "A weighted average smart score over the last 9 months.", "default": null, "optional": true }, { - "name": "retained_earnings", + "name": "success_rate_9m", "type": "float", - "description": "Retained earnings.", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 9 months", "default": null, "optional": true }, { - "name": "accumulated_other_comprehensive_income", - "type": "float", - "description": "Accumulated other comprehensive income (loss).", + "name": "gain_count_1y", + "type": "int", + "description": "The number of ratings that have gained value over the last 1 year", "default": null, "optional": true }, { - "name": "other_shareholders_equity", - "type": "float", - "description": "Other shareholders equity.", + "name": "loss_count_1y", + "type": "int", + "description": "The number of ratings that have lost value over the last 1 year", "default": null, "optional": true }, { - "name": "other_total_shareholders_equity", + "name": "average_return_1y", "type": "float", - "description": "Other total shareholders equity.", + "description": "The average percent (normalized) price difference per rating over the last 1 year", "default": null, "optional": true }, { - "name": "total_common_equity", + "name": "std_dev_1y", "type": "float", - "description": "Total common equity.", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 1 year", "default": null, "optional": true }, { - "name": "total_equity_non_controlling_interests", + "name": "smart_score_1y", "type": "float", - "description": "Total equity non controlling interests.", + "description": "A weighted average smart score over the last 1 year.", "default": null, "optional": true }, { - "name": "total_liabilities_and_shareholders_equity", + "name": "success_rate_1y", "type": "float", - "description": "Total liabilities and shareholders equity.", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 1 year", "default": null, "optional": true }, { - "name": "minority_interest", - "type": "float", - "description": "Minority interest.", + "name": "gain_count_2y", + "type": "int", + "description": "The number of ratings that have gained value over the last 2 years", "default": null, "optional": true }, { - "name": "total_liabilities_and_total_equity", - "type": "float", - "description": "Total liabilities and total equity.", + "name": "loss_count_2y", + "type": "int", + "description": "The number of ratings that have lost value over the last 2 years", "default": null, "optional": true }, { - "name": "total_investments", + "name": "average_return_2y", "type": "float", - "description": "Total investments.", + "description": "The average percent (normalized) price difference per rating over the last 2 years", "default": null, "optional": true }, { - "name": "total_debt", + "name": "std_dev_2y", "type": "float", - "description": "Total debt.", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 2 years", "default": null, "optional": true }, { - "name": "net_debt", + "name": "smart_score_2y", "type": "float", - "description": "Net debt.", + "description": "A weighted average smart score over the last 3 years.", "default": null, "optional": true }, { - "name": "link", - "type": "str", - "description": "Link to the filing.", + "name": "success_rate_2y", + "type": "float", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 2 years", "default": null, "optional": true }, { - "name": "final_link", - "type": "str", - "description": "Link to the filing document.", + "name": "gain_count_3y", + "type": "int", + "description": "The number of ratings that have gained value over the last 3 years", "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "reported_currency", - "type": "str", - "description": "The currency in which the balance sheet is reported.", + "name": "loss_count_3y", + "type": "int", + "description": "The number of ratings that have lost value over the last 3 years", "default": null, "optional": true }, { - "name": "cash_and_cash_equivalents", + "name": "average_return_3y", "type": "float", - "description": "Cash and cash equivalents.", + "description": "The average percent (normalized) price difference per rating over the last 3 years", "default": null, "optional": true }, { - "name": "cash_and_due_from_banks", + "name": "std_dev_3y", "type": "float", - "description": "Cash and due from banks.", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 years", "default": null, "optional": true }, { - "name": "restricted_cash", + "name": "smart_score_3y", "type": "float", - "description": "Restricted cash.", + "description": "A weighted average smart score over the last 3 years.", "default": null, "optional": true }, { - "name": "short_term_investments", + "name": "success_rate_3y", "type": "float", - "description": "Short term investments.", - "default": null, - "optional": true - }, - { - "name": "federal_funds_sold", - "type": "float", - "description": "Federal funds sold.", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 years", "default": null, "optional": true - }, + } + ] + }, + "model": "AnalystSearch" + }, + "/equity/estimates/forward_sales": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get forward sales estimates.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.forward_sales(symbol='AAPL', provider='intrinio')\nobb.equity.estimates.forward_sales(fiscal_year=2025, fiscal_period=fy, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ { - "name": "accounts_receivable", - "type": "float", - "description": "Accounts receivable.", + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", "default": null, "optional": true }, { - "name": "note_and_lease_receivable", - "type": "float", - "description": "Note and lease receivable. (Vendor non-trade receivables)", - "default": null, + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", "optional": true - }, + } + ], + "intrinio": [ { - "name": "inventories", - "type": "float", - "description": "Net Inventories.", + "name": "fiscal_year", + "type": "int", + "description": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", "default": null, "optional": true }, { - "name": "customer_and_other_receivables", - "type": "float", - "description": "Customer and other receivables.", + "name": "fiscal_period", + "type": "Literal['fy', 'q1', 'q2', 'q3', 'q4']", + "description": "The future fiscal period to retrieve estimates for.", "default": null, "optional": true }, { - "name": "interest_bearing_deposits_at_other_banks", - "type": "float", - "description": "Interest bearing deposits at other banks.", + "name": "calendar_year", + "type": "int", + "description": "The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", "default": null, "optional": true }, { - "name": "time_deposits_placed_and_other_short_term_investments", - "type": "float", - "description": "Time deposits placed and other short term investments.", + "name": "calendar_period", + "type": "Literal['q1', 'q2', 'q3', 'q4']", + "description": "The future calendar period to retrieve estimates for.", "default": null, "optional": true - }, + } + ] + }, + "returns": { + "OBBject": [ { - "name": "trading_account_securities", - "type": "float", - "description": "Trading account securities.", - "default": null, - "optional": true + "name": "results", + "type": "List[ForwardSalesEstimates]", + "description": "Serializable results." }, { - "name": "loans_and_leases", - "type": "float", - "description": "Loans and leases.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['intrinio']]", + "description": "Provider name." }, { - "name": "allowance_for_loan_and_lease_losses", - "type": "float", - "description": "Allowance for loan and lease losses.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "current_deferred_refundable_income_taxes", - "type": "float", - "description": "Current deferred refundable income taxes.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "other_current_assets", - "type": "float", - "description": "Other current assets.", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "loans_and_leases_net_of_allowance", - "type": "float", - "description": "Loans and leases net of allowance.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "accrued_investment_income", - "type": "float", - "description": "Accrued investment income.", + "name": "name", + "type": "str", + "description": "Name of the entity.", "default": null, "optional": true }, { - "name": "other_current_non_operating_assets", - "type": "float", - "description": "Other current non-operating assets.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "loans_held_for_sale", - "type": "float", - "description": "Loans held for sale.", + "name": "fiscal_year", + "type": "int", + "description": "Fiscal year for the estimate.", "default": null, "optional": true }, { - "name": "prepaid_expenses", - "type": "float", - "description": "Prepaid expenses.", + "name": "fiscal_period", + "type": "str", + "description": "Fiscal quarter for the estimate.", "default": null, "optional": true }, { - "name": "total_current_assets", - "type": "float", - "description": "Total current assets.", + "name": "calendar_year", + "type": "int", + "description": "Calendar year for the estimate.", "default": null, "optional": true }, { - "name": "plant_property_equipment_gross", - "type": "float", - "description": "Plant property equipment gross.", + "name": "calendar_period", + "type": "str", + "description": "Calendar quarter for the estimate.", "default": null, "optional": true }, { - "name": "accumulated_depreciation", - "type": "float", - "description": "Accumulated depreciation.", + "name": "low_estimate", + "type": "int", + "description": "The sales estimate low for the period.", "default": null, "optional": true }, { - "name": "premises_and_equipment_net", - "type": "float", - "description": "Net premises and equipment.", + "name": "high_estimate", + "type": "int", + "description": "The sales estimate high for the period.", "default": null, "optional": true }, { - "name": "plant_property_equipment_net", - "type": "float", - "description": "Net plant property equipment.", + "name": "mean", + "type": "int", + "description": "The sales estimate mean for the period.", "default": null, "optional": true }, { - "name": "long_term_investments", - "type": "float", - "description": "Long term investments.", + "name": "median", + "type": "int", + "description": "The sales estimate median for the period.", "default": null, "optional": true }, { - "name": "mortgage_servicing_rights", - "type": "float", - "description": "Mortgage servicing rights.", + "name": "standard_deviation", + "type": "int", + "description": "The sales estimate standard deviation for the period.", "default": null, "optional": true }, { - "name": "unearned_premiums_asset", - "type": "float", - "description": "Unearned premiums asset.", + "name": "number_of_analysts", + "type": "int", + "description": "Number of analysts providing estimates for the period.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "non_current_note_lease_receivables", - "type": "float", - "description": "Non-current note lease receivables.", + "name": "revisions_1w_up", + "type": "int", + "description": "Number of revisions up in the last week.", "default": null, "optional": true }, { - "name": "deferred_acquisition_cost", - "type": "float", - "description": "Deferred acquisition cost.", + "name": "revisions_1w_down", + "type": "int", + "description": "Number of revisions down in the last week.", "default": null, "optional": true }, { - "name": "goodwill", + "name": "revisions_1w_change_percent", "type": "float", - "description": "Goodwill.", + "description": "The analyst revisions percent change in estimate for the period of 1 week.", "default": null, "optional": true }, { - "name": "separate_account_business_assets", - "type": "float", - "description": "Separate account business assets.", + "name": "revisions_1m_up", + "type": "int", + "description": "Number of revisions up in the last month.", "default": null, "optional": true }, { - "name": "non_current_deferred_refundable_income_taxes", - "type": "float", - "description": "Noncurrent deferred refundable income taxes.", + "name": "revisions_1m_down", + "type": "int", + "description": "Number of revisions down in the last month.", "default": null, "optional": true }, { - "name": "intangible_assets", + "name": "revisions_1m_change_percent", "type": "float", - "description": "Intangible assets.", + "description": "The analyst revisions percent change in estimate for the period of 1 month.", "default": null, "optional": true }, { - "name": "employee_benefit_assets", - "type": "float", - "description": "Employee benefit assets.", + "name": "revisions_3m_up", + "type": "int", + "description": "Number of revisions up in the last 3 months.", "default": null, "optional": true }, { - "name": "other_assets", - "type": "float", - "description": "Other assets.", + "name": "revisions_3m_down", + "type": "int", + "description": "Number of revisions down in the last 3 months.", "default": null, "optional": true }, { - "name": "other_non_current_operating_assets", + "name": "revisions_3m_change_percent", "type": "float", - "description": "Other noncurrent operating assets.", + "description": "The analyst revisions percent change in estimate for the period of 3 months.", "default": null, "optional": true - }, + } + ] + }, + "model": "ForwardSalesEstimates" + }, + "/equity/estimates/forward_eps": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get forward EPS estimates.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.forward_eps(symbol='AAPL', provider='intrinio')\nobb.equity.estimates.forward_eps(fiscal_year=2025, fiscal_period=fy, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ { - "name": "other_non_current_non_operating_assets", - "type": "float", - "description": "Other noncurrent non-operating assets.", + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", "default": null, "optional": true }, { - "name": "interest_bearing_deposits", - "type": "float", - "description": "Interest bearing deposits.", - "default": null, + "name": "provider", + "type": "Literal['fmp', 'intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "total_non_current_assets", - "type": "float", - "description": "Total noncurrent assets.", - "default": null, + "name": "fiscal_period", + "type": "Literal['annual', 'quarter']", + "description": "The future fiscal period to retrieve estimates for.", + "default": "annual", "optional": true }, { - "name": "total_assets", - "type": "float", - "description": "Total assets.", + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", "default": null, "optional": true }, { - "name": "non_interest_bearing_deposits", - "type": "float", - "description": "Non interest bearing deposits.", - "default": null, + "name": "include_historical", + "type": "bool", + "description": "If True, the data will include all past data and the limit will be ignored.", + "default": false, "optional": true - }, + } + ], + "intrinio": [ { - "name": "federal_funds_purchased_and_securities_sold", - "type": "float", - "description": "Federal funds purchased and securities sold.", + "name": "fiscal_year", + "type": "int", + "description": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", "default": null, "optional": true }, { - "name": "bankers_acceptance_outstanding", - "type": "float", - "description": "Bankers acceptance outstanding.", + "name": "fiscal_period", + "type": "Literal['fy', 'q1', 'q2', 'q3', 'q4']", + "description": "The future fiscal period to retrieve estimates for.", "default": null, "optional": true }, { - "name": "short_term_debt", - "type": "float", - "description": "Short term debt.", + "name": "calendar_year", + "type": "int", + "description": "The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", "default": null, "optional": true }, { - "name": "accounts_payable", - "type": "float", - "description": "Accounts payable.", + "name": "calendar_period", + "type": "Literal['q1', 'q2', 'q3', 'q4']", + "description": "The future calendar period to retrieve estimates for.", "default": null, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[ForwardEpsEstimates]", + "description": "Serializable results." }, { - "name": "current_deferred_revenue", - "type": "float", - "description": "Current deferred revenue.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio']]", + "description": "Provider name." }, { - "name": "current_deferred_payable_income_tax_liabilities", - "type": "float", - "description": "Current deferred payable income tax liabilities.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "accrued_interest_payable", - "type": "float", - "description": "Accrued interest payable.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "accrued_expenses", - "type": "float", - "description": "Accrued expenses.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "other_short_term_payables", - "type": "float", - "description": "Other short term payables.", + "name": "name", + "type": "str", + "description": "Name of the entity.", "default": null, "optional": true }, { - "name": "customer_deposits", - "type": "float", - "description": "Customer deposits.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "dividends_payable", - "type": "float", - "description": "Dividends payable.", + "name": "fiscal_year", + "type": "int", + "description": "Fiscal year for the estimate.", "default": null, "optional": true }, { - "name": "claims_and_claim_expense", - "type": "float", - "description": "Claims and claim expense.", + "name": "fiscal_period", + "type": "str", + "description": "Fiscal quarter for the estimate.", "default": null, "optional": true }, { - "name": "future_policy_benefits", - "type": "float", - "description": "Future policy benefits.", + "name": "calendar_year", + "type": "int", + "description": "Calendar year for the estimate.", "default": null, "optional": true }, { - "name": "current_employee_benefit_liabilities", - "type": "float", - "description": "Current employee benefit liabilities.", + "name": "calendar_period", + "type": "str", + "description": "Calendar quarter for the estimate.", "default": null, "optional": true }, { - "name": "unearned_premiums_liability", + "name": "low_estimate", "type": "float", - "description": "Unearned premiums liability.", + "description": "Estimated EPS low for the period.", "default": null, "optional": true }, { - "name": "other_taxes_payable", + "name": "high_estimate", "type": "float", - "description": "Other taxes payable.", + "description": "Estimated EPS high for the period.", "default": null, "optional": true }, { - "name": "policy_holder_funds", + "name": "mean", "type": "float", - "description": "Policy holder funds.", + "description": "Estimated EPS mean for the period.", "default": null, "optional": true }, { - "name": "other_current_liabilities", + "name": "median", "type": "float", - "description": "Other current liabilities.", + "description": "Estimated EPS median for the period.", "default": null, "optional": true }, { - "name": "other_current_non_operating_liabilities", + "name": "standard_deviation", "type": "float", - "description": "Other current non-operating liabilities.", + "description": "Estimated EPS standard deviation for the period.", "default": null, "optional": true }, { - "name": "separate_account_business_liabilities", - "type": "float", - "description": "Separate account business liabilities.", + "name": "number_of_analysts", + "type": "int", + "description": "Number of analysts providing estimates for the period.", "default": null, "optional": true - }, + } + ], + "fmp": [], + "intrinio": [ { - "name": "total_current_liabilities", + "name": "revisions_change_percent", "type": "float", - "description": "Total current liabilities.", + "description": "The earnings per share (EPS) percent change in estimate for the period.", "default": null, "optional": true }, { - "name": "long_term_debt", + "name": "mean_1w", "type": "float", - "description": "Long term debt.", + "description": "The mean estimate for the period one week ago.", "default": null, "optional": true }, { - "name": "other_long_term_liabilities", + "name": "mean_1m", "type": "float", - "description": "Other long term liabilities.", + "description": "The mean estimate for the period one month ago.", "default": null, "optional": true }, { - "name": "non_current_deferred_revenue", + "name": "mean_2m", "type": "float", - "description": "Non-current deferred revenue.", + "description": "The mean estimate for the period two months ago.", "default": null, "optional": true }, { - "name": "non_current_deferred_payable_income_tax_liabilities", + "name": "mean_3m", "type": "float", - "description": "Non-current deferred payable income tax liabilities.", + "description": "The mean estimate for the period three months ago.", "default": null, "optional": true - }, + } + ] + }, + "model": "ForwardEpsEstimates" + }, + "/equity/darkpool/otc": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the weekly aggregate trade data for Over The Counter deals.\n\nATS and non-ATS trading data for each ATS/firm\nwith trade reporting obligations under FINRA rules.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.darkpool.otc(provider='finra')\n# Get OTC data for a symbol\nobb.equity.darkpool.otc(symbol='AAPL', provider='finra')\n```\n\n", + "parameters": { + "standard": [ { - "name": "non_current_employee_benefit_liabilities", - "type": "float", - "description": "Non-current employee benefit liabilities.", + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", "default": null, "optional": true }, { - "name": "other_non_current_operating_liabilities", - "type": "float", - "description": "Other non-current operating liabilities.", - "default": null, + "name": "provider", + "type": "Literal['finra']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finra' if there is no default.", + "default": "finra", "optional": true - }, + } + ], + "finra": [ { - "name": "other_non_current_non_operating_liabilities", - "type": "float", - "description": "Other non-current, non-operating liabilities.", - "default": null, + "name": "tier", + "type": "Literal['T1', 'T2', 'OTCE']", + "description": "'T1 - Securities included in the S&P 500, Russell 1000 and selected exchange-traded products; T2 - All other NMS stocks; OTC - Over-the-Counter equity securities", + "default": "T1", "optional": true }, { - "name": "total_non_current_liabilities", - "type": "float", - "description": "Total non-current liabilities.", - "default": null, + "name": "is_ats", + "type": "bool", + "description": "ATS data if true, NON-ATS otherwise", + "default": true, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[OTCAggregate]", + "description": "Serializable results." }, { - "name": "capital_lease_obligations", - "type": "float", - "description": "Capital lease obligations.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['finra']]", + "description": "Provider name." }, { - "name": "asset_retirement_reserve_litigation_obligation", - "type": "float", - "description": "Asset retirement reserve litigation obligation.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "total_liabilities", - "type": "float", - "description": "Total liabilities.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "commitments_contingencies", - "type": "float", - "description": "Commitments contingencies.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "update_date", + "type": "date", + "description": "Most recent date on which total trades is updated based on data received from each ATS/OTC.", + "default": "", + "optional": false }, { - "name": "redeemable_non_controlling_interest", + "name": "share_quantity", "type": "float", - "description": "Redeemable non-controlling interest.", - "default": null, - "optional": true + "description": "Aggregate weekly total number of shares reported by each ATS for the Symbol.", + "default": "", + "optional": false }, { - "name": "preferred_stock", + "name": "trade_quantity", "type": "float", - "description": "Preferred stock.", - "default": null, + "description": "Aggregate weekly total number of trades reported by each ATS for the Symbol", + "default": "", + "optional": false + } + ], + "finra": [] + }, + "model": "OTCAggregate" + }, + "/equity/discovery/gainers": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the top price gainers in the stock market.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.gainers(provider='yfinance')\nobb.equity.discovery.gainers(sort='desc', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", "optional": true }, { - "name": "common_stock", - "type": "float", - "description": "Common stock.", - "default": null, + "name": "provider", + "type": "Literal['tmx', 'yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default.", + "default": "tmx", "optional": true - }, + } + ], + "tmx": [ { - "name": "retained_earnings", - "type": "float", - "description": "Retained earnings.", - "default": null, + "name": "category", + "type": "Literal['dividend', 'energy', 'healthcare', 'industrials', 'price_performer', 'rising_stars', 'real_estate', 'tech', 'utilities', '52w_high', 'volume']", + "description": "The category of list to retrieve. Defaults to `price_performer`.", + "default": "price_performer", "optional": true + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityGainers]", + "description": "Serializable results." }, { - "name": "treasury_stock", - "type": "float", - "description": "Treasury stock.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['tmx', 'yfinance']]", + "description": "Provider name." }, { - "name": "accumulated_other_comprehensive_income", - "type": "float", - "description": "Accumulated other comprehensive income.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "participating_policy_holder_equity", - "type": "float", - "description": "Participating policy holder equity.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "other_equity_adjustments", - "type": "float", - "description": "Other equity adjustments.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "total_common_equity", - "type": "float", - "description": "Total common equity.", - "default": null, - "optional": true + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false }, { - "name": "total_preferred_common_equity", + "name": "price", "type": "float", - "description": "Total preferred common equity.", - "default": null, - "optional": true + "description": "Last price.", + "default": "", + "optional": false }, { - "name": "non_controlling_interest", + "name": "change", "type": "float", - "description": "Non-controlling interest.", - "default": null, - "optional": true + "description": "Change in price value.", + "default": "", + "optional": false }, { - "name": "total_equity_non_controlling_interests", + "name": "percent_change", "type": "float", - "description": "Total equity non-controlling interests.", - "default": null, - "optional": true + "description": "Percent change.", + "default": "", + "optional": false }, { - "name": "total_liabilities_shareholders_equity", + "name": "volume", "type": "float", - "description": "Total liabilities and shareholders equity.", - "default": null, - "optional": true + "description": "The trading volume.", + "default": "", + "optional": false } ], - "polygon": [ + "tmx": [ { - "name": "accounts_receivable", + "name": "rank", "type": "int", - "description": "Accounts receivable", - "default": null, - "optional": true - }, + "description": "The rank of the stock in the list.", + "default": "", + "optional": false + } + ], + "yfinance": [ { - "name": "marketable_securities", - "type": "int", - "description": "Marketable securities", - "default": null, - "optional": true + "name": "market_cap", + "type": "float", + "description": "Market Cap.", + "default": "", + "optional": false }, { - "name": "prepaid_expenses", - "type": "int", - "description": "Prepaid expenses", - "default": null, - "optional": true + "name": "avg_volume_3_months", + "type": "float", + "description": "Average volume over the last 3 months in millions.", + "default": "", + "optional": false }, { - "name": "other_current_assets", - "type": "int", - "description": "Other current assets", + "name": "pe_ratio_ttm", + "type": "float", + "description": "PE Ratio (TTM).", "default": null, "optional": true - }, + } + ] + }, + "model": "EquityGainers" + }, + "/equity/discovery/losers": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the top price losers in the stock market.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.losers(provider='yfinance')\nobb.equity.discovery.losers(sort='desc', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ { - "name": "total_current_assets", - "type": "int", - "description": "Total current assets", - "default": null, + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", "optional": true }, { - "name": "property_plant_equipment_net", - "type": "int", - "description": "Property plant and equipment net", - "default": null, - "optional": true - }, - { - "name": "inventory", - "type": "int", - "description": "Inventory", - "default": null, - "optional": true - }, - { - "name": "other_non_current_assets", - "type": "int", - "description": "Other non-current assets", - "default": null, - "optional": true - }, - { - "name": "total_non_current_assets", - "type": "int", - "description": "Total non-current assets", - "default": null, - "optional": true - }, - { - "name": "intangible_assets", - "type": "int", - "description": "Intangible assets", - "default": null, - "optional": true - }, - { - "name": "total_assets", - "type": "int", - "description": "Total assets", - "default": null, - "optional": true - }, - { - "name": "accounts_payable", - "type": "int", - "description": "Accounts payable", - "default": null, - "optional": true - }, - { - "name": "employee_wages", - "type": "int", - "description": "Employee wages", - "default": null, - "optional": true - }, - { - "name": "other_current_liabilities", - "type": "int", - "description": "Other current liabilities", - "default": null, - "optional": true - }, - { - "name": "total_current_liabilities", - "type": "int", - "description": "Total current liabilities", - "default": null, + "name": "provider", + "type": "Literal['yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default.", + "default": "yfinance", "optional": true - }, + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ { - "name": "other_non_current_liabilities", - "type": "int", - "description": "Other non-current liabilities", - "default": null, - "optional": true + "name": "results", + "type": "List[EquityLosers]", + "description": "Serializable results." }, { - "name": "total_non_current_liabilities", - "type": "int", - "description": "Total non-current liabilities", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['yfinance']]", + "description": "Provider name." }, { - "name": "long_term_debt", - "type": "int", - "description": "Long term debt", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "total_liabilities", - "type": "int", - "description": "Total liabilities", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "minority_interest", - "type": "int", - "description": "Minority interest", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "temporary_equity_attributable_to_parent", - "type": "int", - "description": "Temporary equity attributable to parent", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "equity_attributable_to_parent", - "type": "int", - "description": "Equity attributable to parent", - "default": null, - "optional": true + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false }, { - "name": "temporary_equity", - "type": "int", - "description": "Temporary equity", - "default": null, - "optional": true + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false }, { - "name": "preferred_stock", - "type": "int", - "description": "Preferred stock", - "default": null, - "optional": true + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false }, { - "name": "redeemable_non_controlling_interest", - "type": "int", - "description": "Redeemable non-controlling interest", - "default": null, - "optional": true + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false }, { - "name": "redeemable_non_controlling_interest_other", - "type": "int", - "description": "Redeemable non-controlling interest other", - "default": null, - "optional": true - }, + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false + } + ], + "yfinance": [ { - "name": "total_stock_holders_equity", - "type": "int", - "description": "Total stock holders equity", - "default": null, - "optional": true + "name": "market_cap", + "type": "float", + "description": "Market Cap.", + "default": "", + "optional": false }, { - "name": "total_liabilities_and_stock_holders_equity", - "type": "int", - "description": "Total liabilities and stockholders equity", - "default": null, - "optional": true + "name": "avg_volume_3_months", + "type": "float", + "description": "Average volume over the last 3 months in millions.", + "default": "", + "optional": false }, { - "name": "total_equity", - "type": "int", - "description": "Total equity", + "name": "pe_ratio_ttm", + "type": "float", + "description": "PE Ratio (TTM).", "default": null, "optional": true } - ], - "yfinance": [] + ] }, - "model": "BalanceSheet" + "model": "EquityLosers" }, - "/equity/fundamental/balance_growth": { + "/equity/discovery/active": { "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", + "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": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 10, + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", "optional": true }, { "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "type": "Literal['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 } ], - "fmp": [] + "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[BalanceSheetGrowth]", + "type": "List[EquityActive]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['yfinance']]", "description": "Provider name." }, { @@ -9677,470 +9725,688 @@ "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", - "default": null, - "optional": true + "default": "", + "optional": false }, { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "name", + "type": "str", + "description": "Name of the entity.", "default": "", "optional": false }, { - "name": "period", - "type": "str", - "description": "Reporting period.", + "name": "price", + "type": "float", + "description": "Last price.", "default": "", "optional": false }, { - "name": "growth_cash_and_cash_equivalents", + "name": "change", "type": "float", - "description": "Growth rate of cash and cash equivalents.", + "description": "Change in price value.", "default": "", "optional": false }, { - "name": "growth_short_term_investments", + "name": "percent_change", "type": "float", - "description": "Growth rate of short-term investments.", + "description": "Percent change.", "default": "", "optional": false }, { - "name": "growth_cash_and_short_term_investments", + "name": "volume", "type": "float", - "description": "Growth rate of cash and short-term investments.", + "description": "The trading volume.", "default": "", "optional": false - }, + } + ], + "yfinance": [ { - "name": "growth_net_receivables", + "name": "market_cap", "type": "float", - "description": "Growth rate of net receivables.", + "description": "Market Cap displayed in billions.", "default": "", "optional": false }, { - "name": "growth_inventory", + "name": "avg_volume_3_months", "type": "float", - "description": "Growth rate of inventory.", + "description": "Average volume over the last 3 months in millions.", "default": "", "optional": false }, { - "name": "growth_other_current_assets", + "name": "pe_ratio_ttm", "type": "float", - "description": "Growth rate of other current assets.", - "default": "", - "optional": false + "description": "PE Ratio (TTM).", + "default": null, + "optional": true + } + ] + }, + "model": "EquityActive" + }, + "/equity/discovery/undervalued_large_caps": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get potentially undervalued large cap stocks.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.undervalued_large_caps(provider='yfinance')\nobb.equity.discovery.undervalued_large_caps(sort='desc', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true }, { - "name": "growth_total_current_assets", - "type": "float", - "description": "Growth rate of total current assets.", - "default": "", - "optional": false + "name": "provider", + "type": "Literal['yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default.", + "default": "yfinance", + "optional": true + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityUndervaluedLargeCaps]", + "description": "Serializable results." }, { - "name": "growth_property_plant_equipment_net", - "type": "float", - "description": "Growth rate of net property, plant, and equipment.", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['yfinance']]", + "description": "Provider name." }, { - "name": "growth_goodwill", - "type": "float", - "description": "Growth rate of goodwill.", - "default": "", - "optional": false + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "growth_intangible_assets", - "type": "float", - "description": "Growth rate of intangible assets.", - "default": "", - "optional": false + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "growth_goodwill_and_intangible_assets", - "type": "float", - "description": "Growth rate of goodwill and intangible assets.", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "growth_long_term_investments", - "type": "float", - "description": "Growth rate of long-term investments.", + "name": "name", + "type": "str", + "description": "Name of the entity.", "default": "", "optional": false }, { - "name": "growth_tax_assets", + "name": "price", "type": "float", - "description": "Growth rate of tax assets.", + "description": "Last price.", "default": "", "optional": false }, { - "name": "growth_other_non_current_assets", + "name": "change", "type": "float", - "description": "Growth rate of other non-current assets.", + "description": "Change in price value.", "default": "", "optional": false }, { - "name": "growth_total_non_current_assets", + "name": "percent_change", "type": "float", - "description": "Growth rate of total non-current assets.", + "description": "Percent change.", "default": "", "optional": false }, { - "name": "growth_other_assets", + "name": "volume", "type": "float", - "description": "Growth rate of other assets.", + "description": "The trading volume.", "default": "", "optional": false - }, + } + ], + "yfinance": [ { - "name": "growth_total_assets", + "name": "market_cap", "type": "float", - "description": "Growth rate of total assets.", - "default": "", - "optional": false + "description": "Market Cap.", + "default": null, + "optional": true }, { - "name": "growth_account_payables", + "name": "avg_volume_3_months", "type": "float", - "description": "Growth rate of accounts payable.", - "default": "", - "optional": false + "description": "Average volume over the last 3 months in millions.", + "default": null, + "optional": true }, { - "name": "growth_short_term_debt", + "name": "pe_ratio_ttm", "type": "float", - "description": "Growth rate of short-term debt.", - "default": "", - "optional": false + "description": "PE Ratio (TTM).", + "default": null, + "optional": true + } + ] + }, + "model": "EquityUndervaluedLargeCaps" + }, + "/equity/discovery/undervalued_growth": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get potentially undervalued growth stocks.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.undervalued_growth(provider='yfinance')\nobb.equity.discovery.undervalued_growth(sort='desc', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true }, { - "name": "growth_tax_payables", - "type": "float", - "description": "Growth rate of tax payables.", + "name": "provider", + "type": "Literal['yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default.", + "default": "yfinance", + "optional": true + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityUndervaluedGrowth]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "growth_deferred_revenue", - "type": "float", - "description": "Growth rate of deferred revenue.", + "name": "name", + "type": "str", + "description": "Name of the entity.", "default": "", "optional": false }, { - "name": "growth_other_current_liabilities", + "name": "price", "type": "float", - "description": "Growth rate of other current liabilities.", + "description": "Last price.", "default": "", "optional": false }, { - "name": "growth_total_current_liabilities", + "name": "change", "type": "float", - "description": "Growth rate of total current liabilities.", + "description": "Change in price value.", "default": "", "optional": false }, { - "name": "growth_long_term_debt", + "name": "percent_change", "type": "float", - "description": "Growth rate of long-term debt.", + "description": "Percent change.", "default": "", "optional": false }, { - "name": "growth_deferred_revenue_non_current", + "name": "volume", "type": "float", - "description": "Growth rate of non-current deferred revenue.", + "description": "The trading volume.", "default": "", "optional": false + } + ], + "yfinance": [ + { + "name": "market_cap", + "type": "float", + "description": "Market Cap.", + "default": null, + "optional": true }, { - "name": "growth_deferrred_tax_liabilities_non_current", + "name": "avg_volume_3_months", "type": "float", - "description": "Growth rate of non-current deferred tax liabilities.", - "default": "", - "optional": false + "description": "Average volume over the last 3 months in millions.", + "default": null, + "optional": true }, { - "name": "growth_other_non_current_liabilities", + "name": "pe_ratio_ttm", "type": "float", - "description": "Growth rate of other non-current liabilities.", + "description": "PE Ratio (TTM).", + "default": null, + "optional": true + } + ] + }, + "model": "EquityUndervaluedGrowth" + }, + "/equity/discovery/aggressive_small_caps": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get top small cap stocks based on earnings growth.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.aggressive_small_caps(provider='yfinance')\nobb.equity.discovery.aggressive_small_caps(sort='desc', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true + }, + { + "name": "provider", + "type": "Literal['yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default.", + "default": "yfinance", + "optional": true + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityAggressiveSmallCaps]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "growth_total_non_current_liabilities", - "type": "float", - "description": "Growth rate of total non-current liabilities.", + "name": "name", + "type": "str", + "description": "Name of the entity.", "default": "", "optional": false }, { - "name": "growth_other_liabilities", + "name": "price", "type": "float", - "description": "Growth rate of other liabilities.", + "description": "Last price.", "default": "", "optional": false }, { - "name": "growth_total_liabilities", + "name": "change", "type": "float", - "description": "Growth rate of total liabilities.", + "description": "Change in price value.", "default": "", "optional": false }, { - "name": "growth_common_stock", + "name": "percent_change", "type": "float", - "description": "Growth rate of common stock.", + "description": "Percent change.", "default": "", "optional": false }, { - "name": "growth_retained_earnings", + "name": "volume", "type": "float", - "description": "Growth rate of retained earnings.", + "description": "The trading volume.", "default": "", "optional": false + } + ], + "yfinance": [ + { + "name": "market_cap", + "type": "float", + "description": "Market Cap.", + "default": null, + "optional": true }, { - "name": "growth_accumulated_other_comprehensive_income_loss", + "name": "avg_volume_3_months", "type": "float", - "description": "Growth rate of accumulated other comprehensive income/loss.", - "default": "", - "optional": false + "description": "Average volume over the last 3 months in millions.", + "default": null, + "optional": true }, { - "name": "growth_othertotal_stockholders_equity", + "name": "pe_ratio_ttm", "type": "float", - "description": "Growth rate of other total stockholders' equity.", + "description": "PE Ratio (TTM).", + "default": null, + "optional": true + } + ] + }, + "model": "EquityAggressiveSmallCaps" + }, + "/equity/discovery/growth_tech": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get top tech stocks based on revenue and earnings growth.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.growth_tech(provider='yfinance')\nobb.equity.discovery.growth_tech(sort='desc', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true + }, + { + "name": "provider", + "type": "Literal['yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default.", + "default": "yfinance", + "optional": true + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[GrowthTechEquities]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "growth_total_stockholders_equity", - "type": "float", - "description": "Growth rate of total stockholders' equity.", + "name": "name", + "type": "str", + "description": "Name of the entity.", "default": "", "optional": false }, { - "name": "growth_total_liabilities_and_stockholders_equity", + "name": "price", "type": "float", - "description": "Growth rate of total liabilities and stockholders' equity.", + "description": "Last price.", "default": "", "optional": false }, { - "name": "growth_total_investments", + "name": "change", "type": "float", - "description": "Growth rate of total investments.", + "description": "Change in price value.", "default": "", "optional": false }, { - "name": "growth_total_debt", + "name": "percent_change", "type": "float", - "description": "Growth rate of total debt.", + "description": "Percent change.", "default": "", "optional": false }, { - "name": "growth_net_debt", + "name": "volume", "type": "float", - "description": "Growth rate of net debt.", + "description": "The trading volume.", "default": "", "optional": false } ], - "fmp": [] + "yfinance": [ + { + "name": "market_cap", + "type": "float", + "description": "Market Cap.", + "default": null, + "optional": true + }, + { + "name": "avg_volume_3_months", + "type": "float", + "description": "Average volume over the last 3 months in millions.", + "default": null, + "optional": true + }, + { + "name": "pe_ratio_ttm", + "type": "float", + "description": "PE Ratio (TTM).", + "default": null, + "optional": true + } + ] }, - "model": "BalanceSheetGrowth" + "model": "GrowthTechEquities" }, - "/equity/fundamental/cash": { + "/equity/discovery/top_retail": { "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", + "description": "Track over $30B USD/day of individual investors trades.\n\nIt gives a daily view into retail activity and sentiment for over 9,500 US traded stocks,\nADRs, and ETPs.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.top_retail(provider='nasdaq')\n```\n\n", "parameters": { "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "period", - "type": "str", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - }, { "name": "limit", - "type": "Annotated[int, Ge(ge=0)]", + "type": "int", "description": "The number of data entries to return.", "default": 5, "optional": true }, { "name": "provider", - "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", - "optional": true - } - ], - "intrinio": [ - { - "name": "period", - "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", - "description": "None", - "default": "annual", - "optional": true - }, - { - "name": "fiscal_year", - "type": "int", - "description": "The specific fiscal year. Reports do not go beyond 2008.", - "default": null, + "type": "Literal['nasdaq']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default.", + "default": "nasdaq", "optional": true } ], - "polygon": [ - { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", - "optional": true - }, - { - "name": "filing_date", - "type": "date", - "description": "Filing date of the financial statement.", - "default": null, - "optional": true - }, - { - "name": "filing_date_lt", - "type": "date", - "description": "Filing date less than the given date.", - "default": null, - "optional": true - }, - { - "name": "filing_date_lte", - "type": "date", - "description": "Filing date less than or equal to the given date.", - "default": null, - "optional": true - }, + "nasdaq": [] + }, + "returns": { + "OBBject": [ { - "name": "filing_date_gt", - "type": "date", - "description": "Filing date greater than the given date.", - "default": null, - "optional": true + "name": "results", + "type": "List[TopRetail]", + "description": "Serializable results." }, { - "name": "filing_date_gte", - "type": "date", - "description": "Filing date greater than or equal to the given date.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['nasdaq']]", + "description": "Provider name." }, { - "name": "period_of_report_date", - "type": "date", - "description": "Period of report date of the financial statement.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "period_of_report_date_lt", - "type": "date", - "description": "Period of report date less than the given date.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "period_of_report_date_lte", - "type": "date", - "description": "Period of report date less than or equal to the given date.", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "period_of_report_date_gt", + "name": "date", "type": "date", - "description": "Period of report date greater than the given date.", - "default": null, - "optional": true + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "period_of_report_date_gte", - "type": "date", - "description": "Period of report date greater than or equal to the given date.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "include_sources", - "type": "bool", - "description": "Whether to include the sources of the financial statement.", - "default": false, - "optional": true + "name": "activity", + "type": "float", + "description": "Activity of the symbol.", + "default": "", + "optional": false }, { - "name": "order", - "type": "Literal['asc', 'desc']", - "description": "Order of the financial statement.", - "default": null, - "optional": true - }, + "name": "sentiment", + "type": "float", + "description": "Sentiment of the symbol. 1 is bullish, -1 is bearish.", + "default": "", + "optional": false + } + ], + "nasdaq": [] + }, + "model": "TopRetail" + }, + "/equity/discovery/upcoming_release_days": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get upcoming earnings release dates.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.upcoming_release_days(provider='seeking_alpha')\n```\n\n", + "parameters": { + "standard": [ { - "name": "sort", - "type": "Literal['filing_date', 'period_of_report_date']", - "description": "Sort of the financial statement.", - "default": null, + "name": "provider", + "type": "Literal['seeking_alpha']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'seeking_alpha' if there is no default.", + "default": "seeking_alpha", "optional": true } ], - "yfinance": [ + "seeking_alpha": [ { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", + "name": "limit", + "type": "int", + "description": "The number of data entries to return.In this case, the number of lookahead days.", + "default": 10, "optional": true } ] @@ -10149,12 +10415,12 @@ "OBBject": [ { "name": "results", - "type": "List[CashFlowStatement]", + "type": "List[UpcomingReleaseDays]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", + "type": "Optional[Literal['seeking_alpha']]", "description": "Provider name." }, { @@ -10177,761 +10443,845 @@ "data": { "standard": [ { - "name": "period_ending", - "type": "date", - "description": "The end date of the reporting period.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "fiscal_period", + "name": "name", "type": "str", - "description": "The fiscal period of the report.", - "default": null, - "optional": true + "description": "The full name of the asset.", + "default": "", + "optional": false }, { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the fiscal period.", - "default": null, - "optional": true + "name": "exchange", + "type": "str", + "description": "The exchange the asset is traded on.", + "default": "", + "optional": false + }, + { + "name": "release_time_type", + "type": "str", + "description": "The type of release time.", + "default": "", + "optional": false + }, + { + "name": "release_date", + "type": "date", + "description": "The date of the release.", + "default": "", + "optional": false } ], - "fmp": [ + "seeking_alpha": [ { - "name": "fiscal_year", + "name": "sector_id", "type": "int", - "description": "The fiscal year of the fiscal period.", - "default": null, - "optional": true - }, + "description": "The sector ID of the asset.", + "default": "", + "optional": false + } + ] + }, + "model": "UpcomingReleaseDays" + }, + "/equity/discovery/filings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more.\n\nSEC filings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114,\nForeign Investment Disclosures and others. The annual 10-K report is required to be\nfiled annually and includes the company's financial statements, management discussion and analysis,\nand audited financial statements.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.filings(provider='fmp')\n# Get filings for the year 2023, limited to 100 results\nobb.equity.discovery.filings(start_date='2023-01-01', end_date='2023-12-31', limit=100, provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "filing_date", - "type": "date", - "description": "The date of the filing.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "accepted_date", - "type": "datetime", - "description": "The date the filing was accepted.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "reported_currency", + "name": "form_type", "type": "str", - "description": "The currency in which the cash flow statement was reported.", + "description": "Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types.", "default": null, "optional": true }, { - "name": "net_income", - "type": "float", - "description": "Net income.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100, "optional": true }, { - "name": "depreciation_and_amortization", - "type": "float", - "description": "Depreciation and amortization.", + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "is_done", + "type": "bool", + "description": "Flag for whether or not the filing is done.", "default": null, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[DiscoveryFilings]", + "description": "Serializable results." }, { - "name": "deferred_income_tax", - "type": "float", - "description": "Deferred income tax.", - "default": null, + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "", + "optional": false + }, + { + "name": "title", + "type": "str", + "description": "Title of the filing.", + "default": "", + "optional": false + }, + { + "name": "date", + "type": "datetime", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "form_type", + "type": "str", + "description": "The form type of the filing", + "default": "", + "optional": false + }, + { + "name": "link", + "type": "str", + "description": "URL to the filing page on the SEC site.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "DiscoveryFilings" + }, + "/equity/fundamental/multiples": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get equity valuation multiples for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.multiples(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityValuationMultiples]", + "description": "Serializable results." }, { - "name": "stock_based_compensation", + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "revenue_per_share_ttm", "type": "float", - "description": "Stock-based compensation.", + "description": "Revenue per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "change_in_working_capital", + "name": "net_income_per_share_ttm", "type": "float", - "description": "Change in working capital.", + "description": "Net income per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "change_in_account_receivables", + "name": "operating_cash_flow_per_share_ttm", "type": "float", - "description": "Change in account receivables.", + "description": "Operating cash flow per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "change_in_inventory", + "name": "free_cash_flow_per_share_ttm", "type": "float", - "description": "Change in inventory.", + "description": "Free cash flow per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "change_in_account_payable", + "name": "cash_per_share_ttm", "type": "float", - "description": "Change in account payable.", + "description": "Cash per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "change_in_other_working_capital", + "name": "book_value_per_share_ttm", "type": "float", - "description": "Change in other working capital.", + "description": "Book value per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "change_in_other_non_cash_items", + "name": "tangible_book_value_per_share_ttm", "type": "float", - "description": "Change in other non-cash items.", + "description": "Tangible book value per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "net_cash_from_operating_activities", + "name": "shareholders_equity_per_share_ttm", "type": "float", - "description": "Net cash from operating activities.", + "description": "Shareholders equity per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "purchase_of_property_plant_and_equipment", + "name": "interest_debt_per_share_ttm", "type": "float", - "description": "Purchase of property, plant and equipment.", + "description": "Interest debt per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "acquisitions", + "name": "market_cap_ttm", "type": "float", - "description": "Acquisitions.", + "description": "Market capitalization calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "purchase_of_investment_securities", + "name": "enterprise_value_ttm", "type": "float", - "description": "Purchase of investment securities.", + "description": "Enterprise value calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "sale_and_maturity_of_investments", + "name": "pe_ratio_ttm", "type": "float", - "description": "Sale and maturity of investments.", + "description": "Price-to-earnings ratio (P/E ratio) calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "other_investing_activities", + "name": "price_to_sales_ratio_ttm", "type": "float", - "description": "Other investing activities.", + "description": "Price-to-sales ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "net_cash_from_investing_activities", + "name": "pocf_ratio_ttm", "type": "float", - "description": "Net cash from investing activities.", + "description": "Price-to-operating cash flow ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "repayment_of_debt", + "name": "pfcf_ratio_ttm", "type": "float", - "description": "Repayment of debt.", + "description": "Price-to-free cash flow ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "issuance_of_common_equity", + "name": "pb_ratio_ttm", "type": "float", - "description": "Issuance of common equity.", + "description": "Price-to-book ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "repurchase_of_common_equity", + "name": "ptb_ratio_ttm", "type": "float", - "description": "Repurchase of common equity.", + "description": "Price-to-tangible book ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "payment_of_dividends", + "name": "ev_to_sales_ttm", "type": "float", - "description": "Payment of dividends.", + "description": "Enterprise value-to-sales ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "other_financing_activities", + "name": "enterprise_value_over_ebitda_ttm", "type": "float", - "description": "Other financing activities.", + "description": "Enterprise value-to-EBITDA ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "net_cash_from_financing_activities", + "name": "ev_to_operating_cash_flow_ttm", "type": "float", - "description": "Net cash from financing activities.", + "description": "Enterprise value-to-operating cash flow ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "effect_of_exchange_rate_changes_on_cash", + "name": "ev_to_free_cash_flow_ttm", "type": "float", - "description": "Effect of exchange rate changes on cash.", + "description": "Enterprise value-to-free cash flow ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "net_change_in_cash_and_equivalents", + "name": "earnings_yield_ttm", "type": "float", - "description": "Net change in cash and equivalents.", + "description": "Earnings yield calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "cash_at_beginning_of_period", + "name": "free_cash_flow_yield_ttm", "type": "float", - "description": "Cash at beginning of period.", + "description": "Free cash flow yield calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "cash_at_end_of_period", + "name": "debt_to_equity_ttm", "type": "float", - "description": "Cash at end of period.", + "description": "Debt-to-equity ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "operating_cash_flow", + "name": "debt_to_assets_ttm", "type": "float", - "description": "Operating cash flow.", + "description": "Debt-to-assets ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "capital_expenditure", + "name": "net_debt_to_ebitda_ttm", "type": "float", - "description": "Capital expenditure.", + "description": "Net debt-to-EBITDA ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "free_cash_flow", + "name": "current_ratio_ttm", "type": "float", - "description": "None", + "description": "Current ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "link", - "type": "str", - "description": "Link to the filing.", + "name": "interest_coverage_ttm", + "type": "float", + "description": "Interest coverage calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "final_link", - "type": "str", - "description": "Link to the filing document.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "reported_currency", - "type": "str", - "description": "The currency in which the balance sheet is reported.", + "name": "income_quality_ttm", + "type": "float", + "description": "Income quality calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "net_income_continuing_operations", + "name": "dividend_yield_ttm", "type": "float", - "description": "Net Income (Continuing Operations)", + "description": "Dividend yield calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "net_income_discontinued_operations", + "name": "dividend_yield_percentage_ttm", "type": "float", - "description": "Net Income (Discontinued Operations)", + "description": "Dividend yield percentage calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "net_income", + "name": "dividend_to_market_cap_ttm", "type": "float", - "description": "Consolidated Net Income.", + "description": "Dividend to market capitalization ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "provision_for_loan_losses", + "name": "dividend_per_share_ttm", "type": "float", - "description": "Provision for Loan Losses", + "description": "Dividend per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "provision_for_credit_losses", + "name": "payout_ratio_ttm", "type": "float", - "description": "Provision for credit losses", + "description": "Payout ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "depreciation_expense", + "name": "sales_general_and_administrative_to_revenue_ttm", "type": "float", - "description": "Depreciation Expense.", + "description": "Sales general and administrative expenses-to-revenue ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "amortization_expense", + "name": "research_and_development_to_revenue_ttm", "type": "float", - "description": "Amortization Expense.", + "description": "Research and development expenses-to-revenue ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "share_based_compensation", + "name": "intangibles_to_total_assets_ttm", "type": "float", - "description": "Share-based compensation.", + "description": "Intangibles-to-total assets ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "non_cash_adjustments_to_reconcile_net_income", + "name": "capex_to_operating_cash_flow_ttm", "type": "float", - "description": "Non-Cash Adjustments to Reconcile Net Income.", + "description": "Capital expenditures-to-operating cash flow ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "changes_in_operating_assets_and_liabilities", + "name": "capex_to_revenue_ttm", "type": "float", - "description": "Changes in Operating Assets and Liabilities (Net)", + "description": "Capital expenditures-to-revenue ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "net_cash_from_continuing_operating_activities", + "name": "capex_to_depreciation_ttm", "type": "float", - "description": "Net Cash from Continuing Operating Activities", + "description": "Capital expenditures-to-depreciation ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "net_cash_from_discontinued_operating_activities", + "name": "stock_based_compensation_to_revenue_ttm", "type": "float", - "description": "Net Cash from Discontinued Operating Activities", + "description": "Stock-based compensation-to-revenue ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "net_cash_from_operating_activities", + "name": "graham_number_ttm", "type": "float", - "description": "Net Cash from Operating Activities", + "description": "Graham number calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "divestitures", + "name": "roic_ttm", "type": "float", - "description": "Divestitures", + "description": "Return on invested capital calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "sale_of_property_plant_and_equipment", + "name": "return_on_tangible_assets_ttm", "type": "float", - "description": "Sale of Property, Plant, and Equipment", + "description": "Return on tangible assets calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "acquisitions", + "name": "graham_net_net_ttm", "type": "float", - "description": "Acquisitions", + "description": "Graham net-net working capital calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "purchase_of_investments", + "name": "working_capital_ttm", "type": "float", - "description": "Purchase of Investments", + "description": "Working capital calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "purchase_of_investment_securities", + "name": "tangible_asset_value_ttm", "type": "float", - "description": "Purchase of Investment Securities", + "description": "Tangible asset value calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "sale_and_maturity_of_investments", + "name": "net_current_asset_value_ttm", "type": "float", - "description": "Sale and Maturity of Investments", + "description": "Net current asset value calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "loans_held_for_sale", + "name": "invested_capital_ttm", "type": "float", - "description": "Loans Held for Sale (Net)", + "description": "Invested capital calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "purchase_of_property_plant_and_equipment", + "name": "average_receivables_ttm", "type": "float", - "description": "Purchase of Property, Plant, and Equipment", + "description": "Average receivables calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "other_investing_activities", + "name": "average_payables_ttm", "type": "float", - "description": "Other Investing Activities (Net)", + "description": "Average payables calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "net_cash_from_continuing_investing_activities", + "name": "average_inventory_ttm", "type": "float", - "description": "Net Cash from Continuing Investing Activities", + "description": "Average inventory calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "net_cash_from_discontinued_investing_activities", + "name": "days_sales_outstanding_ttm", "type": "float", - "description": "Net Cash from Discontinued Investing Activities", + "description": "Days sales outstanding calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "net_cash_from_investing_activities", + "name": "days_payables_outstanding_ttm", "type": "float", - "description": "Net Cash from Investing Activities", + "description": "Days payables outstanding calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "payment_of_dividends", + "name": "days_of_inventory_on_hand_ttm", "type": "float", - "description": "Payment of Dividends", + "description": "Days of inventory on hand calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "repurchase_of_common_equity", + "name": "receivables_turnover_ttm", "type": "float", - "description": "Repurchase of Common Equity", + "description": "Receivables turnover calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "repurchase_of_preferred_equity", + "name": "payables_turnover_ttm", "type": "float", - "description": "Repurchase of Preferred Equity", + "description": "Payables turnover calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "issuance_of_common_equity", + "name": "inventory_turnover_ttm", "type": "float", - "description": "Issuance of Common Equity", + "description": "Inventory turnover calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "issuance_of_preferred_equity", + "name": "roe_ttm", "type": "float", - "description": "Issuance of Preferred Equity", + "description": "Return on equity calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "issuance_of_debt", + "name": "capex_per_share_ttm", "type": "float", - "description": "Issuance of Debt", + "description": "Capital expenditures per share calculated as trailing twelve months.", "default": null, "optional": true + } + ], + "fmp": [] + }, + "model": "EquityValuationMultiples" + }, + "/equity/fundamental/balance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the balance sheet for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.balance(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.balance(symbol='AAPL', period='annual', limit=5, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "repayment_of_debt", - "type": "float", - "description": "Repayment of Debt", - "default": null, + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", "optional": true }, { - "name": "other_financing_activities", - "type": "float", - "description": "Other Financing Activities (Net)", - "default": null, + "name": "limit", + "type": "Annotated[int, Ge(ge=0)]", + "description": "The number of data entries to return.", + "default": 5, "optional": true }, { - "name": "cash_interest_received", - "type": "float", - "description": "Cash Interest Received", - "default": null, + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "net_change_in_deposits", - "type": "float", - "description": "Net Change in Deposits", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", "optional": true - }, + } + ], + "intrinio": [ { - "name": "net_increase_in_fed_funds_sold", - "type": "float", - "description": "Net Increase in Fed Funds Sold", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", "optional": true }, { - "name": "net_cash_from_continuing_financing_activities", - "type": "float", - "description": "Net Cash from Continuing Financing Activities", + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", "default": null, "optional": true - }, + } + ], + "polygon": [ { - "name": "net_cash_from_discontinued_financing_activities", - "type": "float", - "description": "Net Cash from Discontinued Financing Activities", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm']", + "description": "None", + "default": "annual", "optional": true }, { - "name": "net_cash_from_financing_activities", - "type": "float", - "description": "Net Cash from Financing Activities", + "name": "filing_date", + "type": "date", + "description": "Filing date of the financial statement.", "default": null, "optional": true }, { - "name": "effect_of_exchange_rate_changes", - "type": "float", - "description": "Effect of Exchange Rate Changes", + "name": "filing_date_lt", + "type": "date", + "description": "Filing date less than the given date.", "default": null, "optional": true }, { - "name": "other_net_changes_in_cash", - "type": "float", - "description": "Other Net Changes in Cash", - "default": null, - "optional": true - }, - { - "name": "net_change_in_cash_and_equivalents", - "type": "float", - "description": "Net Change in Cash and Equivalents", - "default": null, - "optional": true - }, - { - "name": "cash_income_taxes_paid", - "type": "float", - "description": "Cash Income Taxes Paid", - "default": null, - "optional": true - }, - { - "name": "cash_interest_paid", - "type": "float", - "description": "Cash Interest Paid", - "default": null, - "optional": true - } - ], - "polygon": [ - { - "name": "net_cash_flow_from_operating_activities_continuing", - "type": "int", - "description": "Net cash flow from operating activities continuing.", - "default": null, - "optional": true - }, - { - "name": "net_cash_flow_from_operating_activities_discontinued", - "type": "int", - "description": "Net cash flow from operating activities discontinued.", - "default": null, - "optional": true - }, - { - "name": "net_cash_flow_from_operating_activities", - "type": "int", - "description": "Net cash flow from operating activities.", + "name": "filing_date_lte", + "type": "date", + "description": "Filing date less than or equal to the given date.", "default": null, "optional": true }, { - "name": "net_cash_flow_from_investing_activities_continuing", - "type": "int", - "description": "Net cash flow from investing activities continuing.", + "name": "filing_date_gt", + "type": "date", + "description": "Filing date greater than the given date.", "default": null, "optional": true }, { - "name": "net_cash_flow_from_investing_activities_discontinued", - "type": "int", - "description": "Net cash flow from investing activities discontinued.", + "name": "filing_date_gte", + "type": "date", + "description": "Filing date greater than or equal to the given date.", "default": null, "optional": true }, { - "name": "net_cash_flow_from_investing_activities", - "type": "int", - "description": "Net cash flow from investing activities.", + "name": "period_of_report_date", + "type": "date", + "description": "Period of report date of the financial statement.", "default": null, "optional": true }, { - "name": "net_cash_flow_from_financing_activities_continuing", - "type": "int", - "description": "Net cash flow from financing activities continuing.", + "name": "period_of_report_date_lt", + "type": "date", + "description": "Period of report date less than the given date.", "default": null, "optional": true }, { - "name": "net_cash_flow_from_financing_activities_discontinued", - "type": "int", - "description": "Net cash flow from financing activities discontinued.", + "name": "period_of_report_date_lte", + "type": "date", + "description": "Period of report date less than or equal to the given date.", "default": null, "optional": true }, { - "name": "net_cash_flow_from_financing_activities", - "type": "int", - "description": "Net cash flow from financing activities.", + "name": "period_of_report_date_gt", + "type": "date", + "description": "Period of report date greater than the given date.", "default": null, "optional": true }, { - "name": "net_cash_flow_continuing", - "type": "int", - "description": "Net cash flow continuing.", + "name": "period_of_report_date_gte", + "type": "date", + "description": "Period of report date greater than or equal to the given date.", "default": null, "optional": true }, { - "name": "net_cash_flow_discontinued", - "type": "int", - "description": "Net cash flow discontinued.", - "default": null, + "name": "include_sources", + "type": "bool", + "description": "Whether to include the sources of the financial statement.", + "default": true, "optional": true }, { - "name": "exchange_gains_losses", - "type": "int", - "description": "Exchange gains losses.", + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order of the financial statement.", "default": null, "optional": true }, { - "name": "net_cash_flow", - "type": "int", - "description": "Net cash flow.", + "name": "sort", + "type": "Literal['filing_date', 'period_of_report_date']", + "description": "Sort of the financial statement.", "default": null, "optional": true } ], - "yfinance": [] - }, - "model": "CashFlowStatement" - }, - "/equity/fundamental/reported_financials": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get financial statements as reported by the company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.reported_financials(symbol='AAPL', provider='intrinio')\n# Get AAPL balance sheet with a limit of 10 items.\nobb.equity.fundamental.reported_financials(symbol='AAPL', period='annual', statement_type='balance', limit=10, provider='intrinio')\n# Get reported income statement\nobb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='income', provider='intrinio')\n# Get reported cash flow statement\nobb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='cash', provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "period", - "type": "str", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - }, - { - "name": "statement_type", - "type": "str", - "description": "The type of financial statement - i.e, balance, income, cash.", - "default": "balance", - "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. Although the response object contains multiple results, because of the variance in the fields, year-to-year and quarter-to-quarter, it is recommended to view results in small chunks.", - "default": 100, - "optional": true - }, - { - "name": "provider", - "type": "Literal['intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", - "optional": true - } - ], - "intrinio": [ + "yfinance": [ { "name": "period", "type": "Literal['annual', 'quarter']", "description": "None", "default": "annual", "optional": true - }, - { - "name": "statement_type", - "type": "Literal['balance', 'income', 'cash']", - "description": "Cash flow statements are reported as YTD, Q4 is the same as FY.", - "default": "income", - "optional": true - }, - { - "name": "fiscal_year", - "type": "int", - "description": "The specific fiscal year. Reports do not go beyond 2008.", - "default": null, - "optional": true } ] }, @@ -10939,12 +11289,12 @@ "OBBject": [ { "name": "results", - "type": "List[ReportedFinancials]", + "type": "List[BalanceSheet]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['intrinio']]", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", "description": "Provider name." }, { @@ -10969,16 +11319,16 @@ { "name": "period_ending", "type": "date", - "description": "The ending date of the reporting period.", + "description": "The end date of the reporting period.", "default": "", "optional": false }, { "name": "fiscal_period", "type": "str", - "description": "The fiscal period of the report (e.g. FY, Q1, etc.).", - "default": "", - "optional": false + "description": "The fiscal period of the report.", + "default": null, + "optional": true }, { "name": "fiscal_year", @@ -10988,2771 +11338,2535 @@ "optional": true } ], - "intrinio": [] - }, - "model": "ReportedFinancials" - }, - "/equity/fundamental/cash_growth": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the growth of a company's cash flow statement items over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.cash_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.cash_growth(symbol='AAPL', limit=10, provider='fmp')\n```\n\n", - "parameters": { - "standard": [ + "fmp": [ { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false + "name": "filing_date", + "type": "date", + "description": "The date when the filing was made.", + "default": null, + "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 10, + "name": "accepted_date", + "type": "datetime", + "description": "The date and time when the filing was accepted.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet was reported.", + "default": null, "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[CashFlowStatementGrowth]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "cash_and_cash_equivalents", + "type": "float", + "description": "Cash and cash equivalents.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "short_term_investments", + "type": "float", + "description": "Short term investments.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "cash_and_short_term_investments", + "type": "float", + "description": "Cash and short term investments.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "net_receivables", + "type": "float", + "description": "Net receivables.", "default": null, "optional": true }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "inventory", + "type": "float", + "description": "Inventory.", + "default": null, + "optional": true }, { - "name": "period", - "type": "str", - "description": "Period the statement is returned for.", - "default": "", - "optional": false + "name": "other_current_assets", + "type": "float", + "description": "Other current assets.", + "default": null, + "optional": true }, { - "name": "growth_net_income", + "name": "total_current_assets", "type": "float", - "description": "Growth rate of net income.", - "default": "", - "optional": false + "description": "Total current assets.", + "default": null, + "optional": true }, { - "name": "growth_depreciation_and_amortization", + "name": "plant_property_equipment_net", "type": "float", - "description": "Growth rate of depreciation and amortization.", - "default": "", - "optional": false + "description": "Plant property equipment net.", + "default": null, + "optional": true }, { - "name": "growth_deferred_income_tax", + "name": "goodwill", "type": "float", - "description": "Growth rate of deferred income tax.", - "default": "", - "optional": false + "description": "Goodwill.", + "default": null, + "optional": true }, { - "name": "growth_stock_based_compensation", + "name": "intangible_assets", "type": "float", - "description": "Growth rate of stock-based compensation.", - "default": "", - "optional": false + "description": "Intangible assets.", + "default": null, + "optional": true }, { - "name": "growth_change_in_working_capital", + "name": "goodwill_and_intangible_assets", "type": "float", - "description": "Growth rate of change in working capital.", - "default": "", - "optional": false + "description": "Goodwill and intangible assets.", + "default": null, + "optional": true }, { - "name": "growth_accounts_receivables", + "name": "long_term_investments", "type": "float", - "description": "Growth rate of accounts receivables.", - "default": "", - "optional": false + "description": "Long term investments.", + "default": null, + "optional": true }, { - "name": "growth_inventory", + "name": "tax_assets", "type": "float", - "description": "Growth rate of inventory.", - "default": "", - "optional": false + "description": "Tax assets.", + "default": null, + "optional": true }, { - "name": "growth_accounts_payables", + "name": "other_non_current_assets", "type": "float", - "description": "Growth rate of accounts payables.", - "default": "", - "optional": false + "description": "Other non current assets.", + "default": null, + "optional": true }, { - "name": "growth_other_working_capital", + "name": "non_current_assets", "type": "float", - "description": "Growth rate of other working capital.", - "default": "", - "optional": false + "description": "Total non current assets.", + "default": null, + "optional": true }, { - "name": "growth_other_non_cash_items", + "name": "other_assets", "type": "float", - "description": "Growth rate of other non-cash items.", - "default": "", - "optional": false + "description": "Other assets.", + "default": null, + "optional": true }, { - "name": "growth_net_cash_provided_by_operating_activities", + "name": "total_assets", "type": "float", - "description": "Growth rate of net cash provided by operating activities.", - "default": "", - "optional": false + "description": "Total assets.", + "default": null, + "optional": true }, { - "name": "growth_investments_in_property_plant_and_equipment", + "name": "accounts_payable", "type": "float", - "description": "Growth rate of investments in property, plant, and equipment.", - "default": "", - "optional": false + "description": "Accounts payable.", + "default": null, + "optional": true }, { - "name": "growth_acquisitions_net", + "name": "short_term_debt", "type": "float", - "description": "Growth rate of net acquisitions.", - "default": "", - "optional": false + "description": "Short term debt.", + "default": null, + "optional": true }, { - "name": "growth_purchases_of_investments", + "name": "tax_payables", "type": "float", - "description": "Growth rate of purchases of investments.", - "default": "", - "optional": false + "description": "Tax payables.", + "default": null, + "optional": true }, { - "name": "growth_sales_maturities_of_investments", + "name": "current_deferred_revenue", "type": "float", - "description": "Growth rate of sales maturities of investments.", - "default": "", - "optional": false + "description": "Current deferred revenue.", + "default": null, + "optional": true }, { - "name": "growth_other_investing_activities", + "name": "other_current_liabilities", "type": "float", - "description": "Growth rate of other investing activities.", - "default": "", - "optional": false + "description": "Other current liabilities.", + "default": null, + "optional": true }, { - "name": "growth_net_cash_used_for_investing_activities", + "name": "total_current_liabilities", "type": "float", - "description": "Growth rate of net cash used for investing activities.", - "default": "", - "optional": false + "description": "Total current liabilities.", + "default": null, + "optional": true }, { - "name": "growth_debt_repayment", + "name": "long_term_debt", "type": "float", - "description": "Growth rate of debt repayment.", - "default": "", - "optional": false + "description": "Long term debt.", + "default": null, + "optional": true }, { - "name": "growth_common_stock_issued", + "name": "deferred_revenue_non_current", "type": "float", - "description": "Growth rate of common stock issued.", - "default": "", - "optional": false + "description": "Non current deferred revenue.", + "default": null, + "optional": true }, { - "name": "growth_common_stock_repurchased", + "name": "deferred_tax_liabilities_non_current", "type": "float", - "description": "Growth rate of common stock repurchased.", - "default": "", - "optional": false + "description": "Deferred tax liabilities non current.", + "default": null, + "optional": true }, { - "name": "growth_dividends_paid", + "name": "other_non_current_liabilities", "type": "float", - "description": "Growth rate of dividends paid.", - "default": "", - "optional": false + "description": "Other non current liabilities.", + "default": null, + "optional": true }, { - "name": "growth_other_financing_activities", + "name": "total_non_current_liabilities", "type": "float", - "description": "Growth rate of other financing activities.", - "default": "", - "optional": false + "description": "Total non current liabilities.", + "default": null, + "optional": true }, { - "name": "growth_net_cash_used_provided_by_financing_activities", + "name": "other_liabilities", "type": "float", - "description": "Growth rate of net cash used/provided by financing activities.", - "default": "", - "optional": false + "description": "Other liabilities.", + "default": null, + "optional": true }, { - "name": "growth_effect_of_forex_changes_on_cash", + "name": "capital_lease_obligations", "type": "float", - "description": "Growth rate of the effect of foreign exchange changes on cash.", - "default": "", - "optional": false + "description": "Capital lease obligations.", + "default": null, + "optional": true }, { - "name": "growth_net_change_in_cash", + "name": "total_liabilities", "type": "float", - "description": "Growth rate of net change in cash.", - "default": "", - "optional": false + "description": "Total liabilities.", + "default": null, + "optional": true }, { - "name": "growth_cash_at_end_of_period", + "name": "preferred_stock", "type": "float", - "description": "Growth rate of cash at the end of the period.", - "default": "", - "optional": false + "description": "Preferred stock.", + "default": null, + "optional": true }, { - "name": "growth_cash_at_beginning_of_period", + "name": "common_stock", "type": "float", - "description": "Growth rate of cash at the beginning of the period.", - "default": "", - "optional": false + "description": "Common stock.", + "default": null, + "optional": true }, { - "name": "growth_operating_cash_flow", + "name": "retained_earnings", "type": "float", - "description": "Growth rate of operating cash flow.", - "default": "", - "optional": false + "description": "Retained earnings.", + "default": null, + "optional": true }, { - "name": "growth_capital_expenditure", + "name": "accumulated_other_comprehensive_income", "type": "float", - "description": "Growth rate of capital expenditure.", - "default": "", - "optional": false + "description": "Accumulated other comprehensive income (loss).", + "default": null, + "optional": true }, { - "name": "growth_free_cash_flow", + "name": "other_shareholders_equity", "type": "float", - "description": "Growth rate of free cash flow.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "CashFlowStatementGrowth" - }, - "/equity/fundamental/dividends": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get historical dividend data for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.dividends(symbol='AAPL', provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false + "description": "Other shareholders equity.", + "default": null, + "optional": true }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "other_total_shareholders_equity", + "type": "float", + "description": "Other total shareholders equity.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "total_common_equity", + "type": "float", + "description": "Total common equity.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "total_equity_non_controlling_interests", + "type": "float", + "description": "Total equity non controlling interests.", + "default": null, "optional": true - } - ], - "fmp": [], - "intrinio": [ + }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 100, + "name": "total_liabilities_and_shareholders_equity", + "type": "float", + "description": "Total liabilities and shareholders equity.", + "default": null, "optional": true - } - ], - "yfinance": [] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[HistoricalDividends]", - "description": "Serializable results." + "name": "minority_interest", + "type": "float", + "description": "Minority interest.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", - "description": "Provider name." + "name": "total_liabilities_and_total_equity", + "type": "float", + "description": "Total liabilities and total equity.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "total_investments", + "type": "float", + "description": "Total investments.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "total_debt", + "type": "float", + "description": "Total debt.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "net_debt", + "type": "float", + "description": "Net debt.", + "default": null, + "optional": true + }, { - "name": "ex_dividend_date", - "type": "date", - "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", - "default": "", - "optional": false + "name": "link", + "type": "str", + "description": "Link to the filing.", + "default": null, + "optional": true }, { - "name": "amount", - "type": "float", - "description": "The dividend amount per share.", - "default": "", - "optional": false + "name": "final_link", + "type": "str", + "description": "Link to the filing document.", + "default": null, + "optional": true } ], - "fmp": [ + "intrinio": [ { - "name": "label", + "name": "reported_currency", "type": "str", - "description": "Label of the historical dividends.", - "default": "", - "optional": false + "description": "The currency in which the balance sheet is reported.", + "default": null, + "optional": true }, { - "name": "adj_dividend", + "name": "cash_and_cash_equivalents", "type": "float", - "description": "Adjusted dividend of the historical dividends.", - "default": "", - "optional": false + "description": "Cash and cash equivalents.", + "default": null, + "optional": true }, { - "name": "record_date", - "type": "date", - "description": "Record date of the historical dividends.", + "name": "cash_and_due_from_banks", + "type": "float", + "description": "Cash and due from banks.", "default": null, "optional": true }, { - "name": "payment_date", - "type": "date", - "description": "Payment date of the historical dividends.", + "name": "restricted_cash", + "type": "float", + "description": "Restricted cash.", "default": null, "optional": true }, { - "name": "declaration_date", - "type": "date", - "description": "Declaration date of the historical dividends.", + "name": "short_term_investments", + "type": "float", + "description": "Short term investments.", "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "factor", + "name": "federal_funds_sold", "type": "float", - "description": "factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.", + "description": "Federal funds sold.", "default": null, "optional": true }, { - "name": "currency", - "type": "str", - "description": "The currency in which the dividend is paid.", + "name": "accounts_receivable", + "type": "float", + "description": "Accounts receivable.", "default": null, "optional": true }, { - "name": "split_ratio", + "name": "note_and_lease_receivable", "type": "float", - "description": "The ratio of the stock split, if a stock split occurred.", + "description": "Note and lease receivable. (Vendor non-trade receivables)", "default": null, "optional": true - } - ], - "yfinance": [] - }, - "model": "HistoricalDividends" - }, - "/equity/fundamental/historical_eps": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get historical earnings per share data for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_eps(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "inventories", + "type": "float", + "description": "Net Inventories.", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", + "name": "customer_and_other_receivables", + "type": "float", + "description": "Customer and other receivables.", "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[HistoricalEps]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "interest_bearing_deposits_at_other_banks", + "type": "float", + "description": "Interest bearing deposits at other banks.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "time_deposits_placed_and_other_short_term_investments", + "type": "float", + "description": "Time deposits placed and other short term investments.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "trading_account_securities", + "type": "float", + "description": "Trading account securities.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "loans_and_leases", + "type": "float", + "description": "Loans and leases.", "default": null, "optional": true }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "allowance_for_loan_and_lease_losses", + "type": "float", + "description": "Allowance for loan and lease losses.", + "default": null, + "optional": true }, { - "name": "announce_time", - "type": "str", - "description": "Timing of the earnings announcement.", + "name": "current_deferred_refundable_income_taxes", + "type": "float", + "description": "Current deferred refundable income taxes.", "default": null, "optional": true }, { - "name": "eps_actual", + "name": "other_current_assets", "type": "float", - "description": "Actual EPS from the earnings date.", + "description": "Other current assets.", "default": null, "optional": true }, { - "name": "eps_estimated", + "name": "loans_and_leases_net_of_allowance", "type": "float", - "description": "Estimated EPS for the earnings date.", + "description": "Loans and leases net of allowance.", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "revenue_estimated", + "name": "accrued_investment_income", "type": "float", - "description": "Estimated consensus revenue for the reporting period.", + "description": "Accrued investment income.", "default": null, "optional": true }, { - "name": "revenue_actual", + "name": "other_current_non_operating_assets", "type": "float", - "description": "The actual reported revenue.", + "description": "Other current non-operating assets.", "default": null, "optional": true }, { - "name": "reporting_time", - "type": "str", - "description": "The reporting time - e.g. after market close.", + "name": "loans_held_for_sale", + "type": "float", + "description": "Loans held for sale.", "default": null, "optional": true }, { - "name": "updated_at", - "type": "date", - "description": "The date when the data was last updated.", + "name": "prepaid_expenses", + "type": "float", + "description": "Prepaid expenses.", "default": null, "optional": true }, { - "name": "period_ending", - "type": "date", - "description": "The fiscal period end date.", + "name": "total_current_assets", + "type": "float", + "description": "Total current assets.", "default": null, "optional": true - } - ] - }, - "model": "HistoricalEps" - }, - "/equity/fundamental/employee_count": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get historical employee count data for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.employee_count(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false + "name": "plant_property_equipment_gross", + "type": "float", + "description": "Plant property equipment gross.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "accumulated_depreciation", + "type": "float", + "description": "Accumulated depreciation.", + "default": null, "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[HistoricalEmployees]", - "description": "Serializable results." + "name": "premises_and_equipment_net", + "type": "float", + "description": "Net premises and equipment.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "plant_property_equipment_net", + "type": "float", + "description": "Net plant property equipment.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "long_term_investments", + "type": "float", + "description": "Long term investments.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "mortgage_servicing_rights", + "type": "float", + "description": "Mortgage servicing rights.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "unearned_premiums_asset", + "type": "float", + "description": "Unearned premiums asset.", + "default": null, + "optional": true + }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "non_current_note_lease_receivables", + "type": "float", + "description": "Non-current note lease receivables.", + "default": null, + "optional": true }, { - "name": "cik", - "type": "int", - "description": "Central Index Key (CIK) for the requested entity.", - "default": "", - "optional": false + "name": "deferred_acquisition_cost", + "type": "float", + "description": "Deferred acquisition cost.", + "default": null, + "optional": true }, { - "name": "acceptance_time", - "type": "datetime", - "description": "Time of acceptance of the company employee.", - "default": "", - "optional": false + "name": "goodwill", + "type": "float", + "description": "Goodwill.", + "default": null, + "optional": true }, { - "name": "period_of_report", - "type": "date", - "description": "Date of reporting of the company employee.", - "default": "", - "optional": false + "name": "separate_account_business_assets", + "type": "float", + "description": "Separate account business assets.", + "default": null, + "optional": true }, { - "name": "company_name", - "type": "str", - "description": "Registered name of the company to retrieve the historical employees of.", - "default": "", - "optional": false + "name": "non_current_deferred_refundable_income_taxes", + "type": "float", + "description": "Noncurrent deferred refundable income taxes.", + "default": null, + "optional": true }, { - "name": "form_type", - "type": "str", - "description": "Form type of the company employee.", - "default": "", - "optional": false + "name": "intangible_assets", + "type": "float", + "description": "Intangible assets.", + "default": null, + "optional": true }, { - "name": "filing_date", - "type": "date", - "description": "Filing date of the company employee", - "default": "", - "optional": false + "name": "employee_benefit_assets", + "type": "float", + "description": "Employee benefit assets.", + "default": null, + "optional": true }, { - "name": "employee_count", - "type": "int", - "description": "Count of employees of the company.", - "default": "", - "optional": false + "name": "other_assets", + "type": "float", + "description": "Other assets.", + "default": null, + "optional": true }, { - "name": "source", - "type": "str", - "description": "Source URL which retrieves this data for the company.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "HistoricalEmployees" - }, - "/equity/fundamental/search_attributes": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Search Intrinio data tags to search in latest or historical attributes.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.search_attributes(query='ebitda', provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "query", - "type": "str", - "description": "Query to search for.", - "default": "", - "optional": false + "name": "other_non_current_operating_assets", + "type": "float", + "description": "Other noncurrent operating assets.", + "default": null, + "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 1000, + "name": "other_non_current_non_operating_assets", + "type": "float", + "description": "Other noncurrent non-operating assets.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", + "name": "interest_bearing_deposits", + "type": "float", + "description": "Interest bearing deposits.", + "default": null, "optional": true - } - ], - "intrinio": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[SearchAttributes]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['intrinio']]", - "description": "Provider name." + "name": "total_non_current_assets", + "type": "float", + "description": "Total noncurrent assets.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "total_assets", + "type": "float", + "description": "Total assets.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "non_interest_bearing_deposits", + "type": "float", + "description": "Non interest bearing deposits.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "id", - "type": "str", - "description": "ID of the financial attribute.", - "default": "", - "optional": false + "name": "federal_funds_purchased_and_securities_sold", + "type": "float", + "description": "Federal funds purchased and securities sold.", + "default": null, + "optional": true }, { - "name": "name", - "type": "str", - "description": "Name of the financial attribute.", - "default": "", - "optional": false + "name": "bankers_acceptance_outstanding", + "type": "float", + "description": "Bankers acceptance outstanding.", + "default": null, + "optional": true }, { - "name": "tag", - "type": "str", - "description": "Tag of the financial attribute.", - "default": "", - "optional": false + "name": "short_term_debt", + "type": "float", + "description": "Short term debt.", + "default": null, + "optional": true }, { - "name": "statement_code", - "type": "str", - "description": "Code of the financial statement.", - "default": "", - "optional": false + "name": "accounts_payable", + "type": "float", + "description": "Accounts payable.", + "default": null, + "optional": true }, { - "name": "statement_type", - "type": "str", - "description": "Type of the financial statement.", + "name": "current_deferred_revenue", + "type": "float", + "description": "Current deferred revenue.", "default": null, "optional": true }, { - "name": "parent_name", - "type": "str", - "description": "Parent's name of the financial attribute.", + "name": "current_deferred_payable_income_tax_liabilities", + "type": "float", + "description": "Current deferred payable income tax liabilities.", "default": null, "optional": true }, { - "name": "sequence", - "type": "int", - "description": "Sequence of the financial statement.", + "name": "accrued_interest_payable", + "type": "float", + "description": "Accrued interest payable.", "default": null, "optional": true }, { - "name": "factor", - "type": "str", - "description": "Unit of the financial attribute.", + "name": "accrued_expenses", + "type": "float", + "description": "Accrued expenses.", "default": null, "optional": true }, { - "name": "transaction", - "type": "str", - "description": "Transaction type (credit/debit) of the financial attribute.", + "name": "other_short_term_payables", + "type": "float", + "description": "Other short term payables.", "default": null, "optional": true }, { - "name": "type", - "type": "str", - "description": "Type of the financial attribute.", + "name": "customer_deposits", + "type": "float", + "description": "Customer deposits.", "default": null, "optional": true }, { - "name": "unit", - "type": "str", - "description": "Unit of the financial attribute.", + "name": "dividends_payable", + "type": "float", + "description": "Dividends payable.", "default": null, "optional": true - } - ], - "intrinio": [] - }, - "model": "SearchAttributes" - }, - "/equity/fundamental/latest_attributes": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the latest value of a data tag from Intrinio.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.latest_attributes(symbol='AAPL', tag='ceo', provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", - "default": "", - "optional": false + "name": "claims_and_claim_expense", + "type": "float", + "description": "Claims and claim expense.", + "default": null, + "optional": 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 + "name": "future_policy_benefits", + "type": "float", + "description": "Future policy benefits.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Literal['intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", + "name": "current_employee_benefit_liabilities", + "type": "float", + "description": "Current employee benefit liabilities.", + "default": null, "optional": true - } - ], - "intrinio": [] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[LatestAttributes]", - "description": "Serializable results." + "name": "unearned_premiums_liability", + "type": "float", + "description": "Unearned premiums liability.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['intrinio']]", - "description": "Provider name." + "name": "other_taxes_payable", + "type": "float", + "description": "Other taxes payable.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "policy_holder_funds", + "type": "float", + "description": "Policy holder funds.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "other_current_liabilities", + "type": "float", + "description": "Other current liabilities.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "tag", - "type": "str", - "description": "Tag name for the fetched data.", + "name": "other_current_non_operating_liabilities", + "type": "float", + "description": "Other current non-operating liabilities.", "default": null, "optional": true }, { - "name": "value", - "type": "Union[str, float]", - "description": "The value of the data.", + "name": "separate_account_business_liabilities", + "type": "float", + "description": "Separate account business liabilities.", "default": null, "optional": true - } - ], - "intrinio": [] - }, - "model": "LatestAttributes" - }, - "/equity/fundamental/historical_attributes": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the historical values of a data tag from Intrinio.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_attributes(symbol='AAPL', tag='ebitda', provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", - "default": "", - "optional": false }, { - "name": "tag", - "type": "Union[str, List[str]]", - "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", - "default": "", - "optional": false + "name": "total_current_liabilities", + "type": "float", + "description": "Total current liabilities.", + "default": null, + "optional": true }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "long_term_debt", + "type": "float", + "description": "Long term debt.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "other_long_term_liabilities", + "type": "float", + "description": "Other long term liabilities.", "default": null, "optional": true }, { - "name": "frequency", - "type": "Literal['daily', 'weekly', 'monthly', 'quarterly', 'yearly']", - "description": "The frequency of the data.", - "default": "yearly", + "name": "non_current_deferred_revenue", + "type": "float", + "description": "Non-current deferred revenue.", + "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 1000, + "name": "non_current_deferred_payable_income_tax_liabilities", + "type": "float", + "description": "Non-current deferred payable income tax liabilities.", + "default": null, "optional": true }, { - "name": "tag_type", - "type": "str", - "description": "Filter by type, when applicable.", + "name": "non_current_employee_benefit_liabilities", + "type": "float", + "description": "Non-current employee benefit liabilities.", "default": null, "optional": true }, { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order.", - "default": "desc", + "name": "other_non_current_operating_liabilities", + "type": "float", + "description": "Other non-current operating liabilities.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", + "name": "other_non_current_non_operating_liabilities", + "type": "float", + "description": "Other non-current, non-operating liabilities.", + "default": null, "optional": true - } - ], - "intrinio": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[HistoricalAttributes]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['intrinio']]", - "description": "Provider name." + "name": "total_non_current_liabilities", + "type": "float", + "description": "Total non-current liabilities.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "capital_lease_obligations", + "type": "float", + "description": "Capital lease obligations.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "asset_retirement_reserve_litigation_obligation", + "type": "float", + "description": "Asset retirement reserve litigation obligation.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "total_liabilities", + "type": "float", + "description": "Total liabilities.", + "default": null, + "optional": true }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "commitments_contingencies", + "type": "float", + "description": "Commitments contingencies.", + "default": null, + "optional": true }, { - "name": "tag", - "type": "str", - "description": "Tag name for the fetched data.", + "name": "redeemable_non_controlling_interest", + "type": "float", + "description": "Redeemable non-controlling interest.", "default": null, "optional": true }, { - "name": "value", + "name": "preferred_stock", "type": "float", - "description": "The value of the data.", + "description": "Preferred stock.", "default": null, "optional": true - } - ], - "intrinio": [] - }, - "model": "HistoricalAttributes" - }, - "/equity/fundamental/income": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the income statement for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.income(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.income(symbol='AAPL', period='annual', limit=5, provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "period", - "type": "str", - "description": "Time period of the data to return.", - "default": "annual", + "name": "common_stock", + "type": "float", + "description": "Common stock.", + "default": null, "optional": true }, { - "name": "limit", - "type": "Annotated[int, Ge(ge=0)]", - "description": "The number of data entries to return.", - "default": 5, + "name": "retained_earnings", + "type": "float", + "description": "Retained earnings.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "treasury_stock", + "type": "float", + "description": "Treasury stock.", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", + "name": "accumulated_other_comprehensive_income", + "type": "float", + "description": "Accumulated other comprehensive income.", + "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "period", - "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", - "description": "None", - "default": "annual", + "name": "participating_policy_holder_equity", + "type": "float", + "description": "Participating policy holder equity.", + "default": null, "optional": true }, { - "name": "fiscal_year", - "type": "int", - "description": "The specific fiscal year. Reports do not go beyond 2008.", + "name": "other_equity_adjustments", + "type": "float", + "description": "Other equity adjustments.", "default": null, "optional": true - } - ], - "polygon": [ - { - "name": "period", - "type": "Literal['annual', 'quarter', 'ttm']", - "description": "None", - "default": "annual", - "optional": true }, { - "name": "filing_date", - "type": "date", - "description": "Filing date of the financial statement.", + "name": "total_common_equity", + "type": "float", + "description": "Total common equity.", "default": null, "optional": true }, { - "name": "filing_date_lt", - "type": "date", - "description": "Filing date less than the given date.", + "name": "total_preferred_common_equity", + "type": "float", + "description": "Total preferred common equity.", "default": null, "optional": true }, { - "name": "filing_date_lte", - "type": "date", - "description": "Filing date less than or equal to the given date.", + "name": "non_controlling_interest", + "type": "float", + "description": "Non-controlling interest.", "default": null, "optional": true }, { - "name": "filing_date_gt", - "type": "date", - "description": "Filing date greater than the given date.", + "name": "total_equity_non_controlling_interests", + "type": "float", + "description": "Total equity non-controlling interests.", "default": null, "optional": true }, { - "name": "filing_date_gte", - "type": "date", - "description": "Filing date greater than or equal to the given date.", + "name": "total_liabilities_shareholders_equity", + "type": "float", + "description": "Total liabilities and shareholders equity.", "default": null, "optional": true - }, + } + ], + "polygon": [ { - "name": "period_of_report_date", - "type": "date", - "description": "Period of report date of the financial statement.", + "name": "accounts_receivable", + "type": "int", + "description": "Accounts receivable", "default": null, "optional": true }, { - "name": "period_of_report_date_lt", - "type": "date", - "description": "Period of report date less than the given date.", + "name": "marketable_securities", + "type": "int", + "description": "Marketable securities", "default": null, "optional": true }, { - "name": "period_of_report_date_lte", - "type": "date", - "description": "Period of report date less than or equal to the given date.", + "name": "prepaid_expenses", + "type": "int", + "description": "Prepaid expenses", "default": null, "optional": true }, { - "name": "period_of_report_date_gt", - "type": "date", - "description": "Period of report date greater than the given date.", + "name": "other_current_assets", + "type": "int", + "description": "Other current assets", "default": null, "optional": true }, { - "name": "period_of_report_date_gte", - "type": "date", - "description": "Period of report date greater than or equal to the given date.", + "name": "total_current_assets", + "type": "int", + "description": "Total current assets", "default": null, "optional": true }, { - "name": "include_sources", - "type": "bool", - "description": "Whether to include the sources of the financial statement.", + "name": "property_plant_equipment_net", + "type": "int", + "description": "Property plant and equipment net", "default": null, "optional": true }, { - "name": "order", - "type": "Literal['asc', 'desc']", - "description": "Order of the financial statement.", + "name": "inventory", + "type": "int", + "description": "Inventory", "default": null, "optional": true }, { - "name": "sort", - "type": "Literal['filing_date', 'period_of_report_date']", - "description": "Sort of the financial statement.", + "name": "other_non_current_assets", + "type": "int", + "description": "Other non-current assets", "default": null, "optional": true - } - ], - "yfinance": [ - { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[IncomeStatement]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "period_ending", - "type": "date", - "description": "The end date of the reporting period.", - "default": "", - "optional": false }, { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the report.", + "name": "total_non_current_assets", + "type": "int", + "description": "Total non-current assets", "default": null, "optional": true }, { - "name": "fiscal_year", + "name": "intangible_assets", "type": "int", - "description": "The fiscal year of the fiscal period.", + "description": "Intangible assets", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "filing_date", - "type": "date", - "description": "The date when the filing was made.", + "name": "total_assets", + "type": "int", + "description": "Total assets", "default": null, "optional": true }, { - "name": "accepted_date", - "type": "datetime", - "description": "The date and time when the filing was accepted.", + "name": "accounts_payable", + "type": "int", + "description": "Accounts payable", "default": null, "optional": true }, { - "name": "reported_currency", - "type": "str", - "description": "The currency in which the balance sheet was reported.", + "name": "employee_wages", + "type": "int", + "description": "Employee wages", "default": null, "optional": true }, { - "name": "revenue", - "type": "float", - "description": "Total revenue.", + "name": "other_current_liabilities", + "type": "int", + "description": "Other current liabilities", "default": null, "optional": true }, { - "name": "cost_of_revenue", - "type": "float", - "description": "Cost of revenue.", + "name": "total_current_liabilities", + "type": "int", + "description": "Total current liabilities", "default": null, "optional": true }, { - "name": "gross_profit", - "type": "float", - "description": "Gross profit.", + "name": "other_non_current_liabilities", + "type": "int", + "description": "Other non-current liabilities", "default": null, "optional": true }, { - "name": "gross_profit_margin", - "type": "float", - "description": "Gross profit margin.", + "name": "total_non_current_liabilities", + "type": "int", + "description": "Total non-current liabilities", "default": null, "optional": true }, { - "name": "general_and_admin_expense", - "type": "float", - "description": "General and administrative expenses.", + "name": "long_term_debt", + "type": "int", + "description": "Long term debt", "default": null, "optional": true }, { - "name": "research_and_development_expense", - "type": "float", - "description": "Research and development expenses.", + "name": "total_liabilities", + "type": "int", + "description": "Total liabilities", "default": null, "optional": true }, { - "name": "selling_and_marketing_expense", - "type": "float", - "description": "Selling and marketing expenses.", + "name": "minority_interest", + "type": "int", + "description": "Minority interest", "default": null, "optional": true }, { - "name": "selling_general_and_admin_expense", - "type": "float", - "description": "Selling, general and administrative expenses.", + "name": "temporary_equity_attributable_to_parent", + "type": "int", + "description": "Temporary equity attributable to parent", "default": null, "optional": true }, { - "name": "other_expenses", - "type": "float", - "description": "Other expenses.", + "name": "equity_attributable_to_parent", + "type": "int", + "description": "Equity attributable to parent", "default": null, "optional": true }, { - "name": "total_operating_expenses", - "type": "float", - "description": "Total operating expenses.", + "name": "temporary_equity", + "type": "int", + "description": "Temporary equity", "default": null, "optional": true }, { - "name": "cost_and_expenses", - "type": "float", - "description": "Cost and expenses.", + "name": "preferred_stock", + "type": "int", + "description": "Preferred stock", "default": null, "optional": true }, { - "name": "interest_income", - "type": "float", - "description": "Interest income.", + "name": "redeemable_non_controlling_interest", + "type": "int", + "description": "Redeemable non-controlling interest", "default": null, "optional": true }, { - "name": "total_interest_expense", - "type": "float", - "description": "Total interest expenses.", + "name": "redeemable_non_controlling_interest_other", + "type": "int", + "description": "Redeemable non-controlling interest other", "default": null, "optional": true }, { - "name": "depreciation_and_amortization", - "type": "float", - "description": "Depreciation and amortization.", + "name": "total_stock_holders_equity", + "type": "int", + "description": "Total stock holders equity", "default": null, "optional": true }, { - "name": "ebitda", - "type": "float", - "description": "EBITDA.", + "name": "total_liabilities_and_stock_holders_equity", + "type": "int", + "description": "Total liabilities and stockholders equity", "default": null, "optional": true }, { - "name": "ebitda_margin", - "type": "float", - "description": "EBITDA margin.", + "name": "total_equity", + "type": "int", + "description": "Total equity", "default": null, "optional": true - }, + } + ], + "yfinance": [] + }, + "model": "BalanceSheet" + }, + "/equity/fundamental/balance_growth": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the growth of a company's balance sheet items over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.balance_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.balance_growth(symbol='AAPL', limit=10, provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "total_operating_income", - "type": "float", - "description": "Total operating income.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "operating_income_margin", - "type": "float", - "description": "Operating income margin.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10, "optional": true }, { - "name": "total_other_income_expenses", - "type": "float", - "description": "Total other income and expenses.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[BalanceSheetGrowth]", + "description": "Serializable results." }, { - "name": "total_pre_tax_income", - "type": "float", - "description": "Total pre-tax income.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "pre_tax_income_margin", - "type": "float", - "description": "Pre-tax income margin.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "income_tax_expense", - "type": "float", - "description": "Income tax expense.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "consolidated_net_income", - "type": "float", - "description": "Consolidated net income.", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "net_income_margin", - "type": "float", - "description": "Net income margin.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "basic_earnings_per_share", - "type": "float", - "description": "Basic earnings per share.", - "default": null, - "optional": true + "name": "period", + "type": "str", + "description": "Reporting period.", + "default": "", + "optional": false }, { - "name": "diluted_earnings_per_share", + "name": "growth_cash_and_cash_equivalents", "type": "float", - "description": "Diluted earnings per share.", - "default": null, - "optional": true + "description": "Growth rate of cash and cash equivalents.", + "default": "", + "optional": false }, { - "name": "weighted_average_basic_shares_outstanding", + "name": "growth_short_term_investments", "type": "float", - "description": "Weighted average basic shares outstanding.", - "default": null, - "optional": true + "description": "Growth rate of short-term investments.", + "default": "", + "optional": false }, { - "name": "weighted_average_diluted_shares_outstanding", + "name": "growth_cash_and_short_term_investments", "type": "float", - "description": "Weighted average diluted shares outstanding.", - "default": null, - "optional": true + "description": "Growth rate of cash and short-term investments.", + "default": "", + "optional": false }, { - "name": "link", - "type": "str", - "description": "Link to the filing.", - "default": null, - "optional": true + "name": "growth_net_receivables", + "type": "float", + "description": "Growth rate of net receivables.", + "default": "", + "optional": false }, { - "name": "final_link", - "type": "str", - "description": "Link to the filing document.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "reported_currency", - "type": "str", - "description": "The currency in which the balance sheet is reported.", - "default": null, - "optional": true + "name": "growth_inventory", + "type": "float", + "description": "Growth rate of inventory.", + "default": "", + "optional": false }, { - "name": "revenue", + "name": "growth_other_current_assets", "type": "float", - "description": "Total revenue", - "default": null, - "optional": true + "description": "Growth rate of other current assets.", + "default": "", + "optional": false }, { - "name": "operating_revenue", + "name": "growth_total_current_assets", "type": "float", - "description": "Total operating revenue", - "default": null, - "optional": true + "description": "Growth rate of total current assets.", + "default": "", + "optional": false }, { - "name": "cost_of_revenue", + "name": "growth_property_plant_equipment_net", "type": "float", - "description": "Total cost of revenue", - "default": null, - "optional": true + "description": "Growth rate of net property, plant, and equipment.", + "default": "", + "optional": false }, { - "name": "operating_cost_of_revenue", + "name": "growth_goodwill", "type": "float", - "description": "Total operating cost of revenue", - "default": null, - "optional": true + "description": "Growth rate of goodwill.", + "default": "", + "optional": false }, { - "name": "gross_profit", + "name": "growth_intangible_assets", "type": "float", - "description": "Total gross profit", - "default": null, - "optional": true + "description": "Growth rate of intangible assets.", + "default": "", + "optional": false }, { - "name": "gross_profit_margin", + "name": "growth_goodwill_and_intangible_assets", "type": "float", - "description": "Gross margin ratio.", - "default": null, - "optional": true + "description": "Growth rate of goodwill and intangible assets.", + "default": "", + "optional": false }, { - "name": "provision_for_credit_losses", + "name": "growth_long_term_investments", "type": "float", - "description": "Provision for credit losses", - "default": null, - "optional": true + "description": "Growth rate of long-term investments.", + "default": "", + "optional": false }, { - "name": "research_and_development_expense", + "name": "growth_tax_assets", "type": "float", - "description": "Research and development expense", - "default": null, - "optional": true + "description": "Growth rate of tax assets.", + "default": "", + "optional": false }, { - "name": "selling_general_and_admin_expense", + "name": "growth_other_non_current_assets", "type": "float", - "description": "Selling, general, and admin expense", - "default": null, - "optional": true + "description": "Growth rate of other non-current assets.", + "default": "", + "optional": false }, { - "name": "salaries_and_employee_benefits", + "name": "growth_total_non_current_assets", "type": "float", - "description": "Salaries and employee benefits", - "default": null, - "optional": true + "description": "Growth rate of total non-current assets.", + "default": "", + "optional": false }, { - "name": "marketing_expense", + "name": "growth_other_assets", "type": "float", - "description": "Marketing expense", - "default": null, - "optional": true + "description": "Growth rate of other assets.", + "default": "", + "optional": false }, { - "name": "net_occupancy_and_equipment_expense", + "name": "growth_total_assets", "type": "float", - "description": "Net occupancy and equipment expense", - "default": null, - "optional": true + "description": "Growth rate of total assets.", + "default": "", + "optional": false }, { - "name": "other_operating_expenses", + "name": "growth_account_payables", "type": "float", - "description": "Other operating expenses", - "default": null, - "optional": true + "description": "Growth rate of accounts payable.", + "default": "", + "optional": false }, { - "name": "depreciation_expense", + "name": "growth_short_term_debt", "type": "float", - "description": "Depreciation expense", - "default": null, - "optional": true + "description": "Growth rate of short-term debt.", + "default": "", + "optional": false }, { - "name": "amortization_expense", + "name": "growth_tax_payables", "type": "float", - "description": "Amortization expense", - "default": null, - "optional": true + "description": "Growth rate of tax payables.", + "default": "", + "optional": false }, { - "name": "amortization_of_deferred_policy_acquisition_costs", + "name": "growth_deferred_revenue", "type": "float", - "description": "Amortization of deferred policy acquisition costs", - "default": null, - "optional": true + "description": "Growth rate of deferred revenue.", + "default": "", + "optional": false }, { - "name": "exploration_expense", + "name": "growth_other_current_liabilities", "type": "float", - "description": "Exploration expense", - "default": null, - "optional": true + "description": "Growth rate of other current liabilities.", + "default": "", + "optional": false }, { - "name": "depletion_expense", + "name": "growth_total_current_liabilities", "type": "float", - "description": "Depletion expense", - "default": null, - "optional": true + "description": "Growth rate of total current liabilities.", + "default": "", + "optional": false }, { - "name": "total_operating_expenses", + "name": "growth_long_term_debt", "type": "float", - "description": "Total operating expenses", - "default": null, - "optional": true + "description": "Growth rate of long-term debt.", + "default": "", + "optional": false }, { - "name": "total_operating_income", + "name": "growth_deferred_revenue_non_current", "type": "float", - "description": "Total operating income", - "default": null, - "optional": true + "description": "Growth rate of non-current deferred revenue.", + "default": "", + "optional": false }, { - "name": "deposits_and_money_market_investments_interest_income", + "name": "growth_deferrred_tax_liabilities_non_current", "type": "float", - "description": "Deposits and money market investments interest income", - "default": null, - "optional": true + "description": "Growth rate of non-current deferred tax liabilities.", + "default": "", + "optional": false }, { - "name": "federal_funds_sold_and_securities_borrowed_interest_income", + "name": "growth_other_non_current_liabilities", "type": "float", - "description": "Federal funds sold and securities borrowed interest income", - "default": null, - "optional": true + "description": "Growth rate of other non-current liabilities.", + "default": "", + "optional": false }, { - "name": "investment_securities_interest_income", + "name": "growth_total_non_current_liabilities", "type": "float", - "description": "Investment securities interest income", - "default": null, - "optional": true + "description": "Growth rate of total non-current liabilities.", + "default": "", + "optional": false }, { - "name": "loans_and_leases_interest_income", + "name": "growth_other_liabilities", "type": "float", - "description": "Loans and leases interest income", - "default": null, - "optional": true + "description": "Growth rate of other liabilities.", + "default": "", + "optional": false }, { - "name": "trading_account_interest_income", + "name": "growth_total_liabilities", "type": "float", - "description": "Trading account interest income", - "default": null, - "optional": true + "description": "Growth rate of total liabilities.", + "default": "", + "optional": false }, { - "name": "other_interest_income", + "name": "growth_common_stock", "type": "float", - "description": "Other interest income", - "default": null, - "optional": true + "description": "Growth rate of common stock.", + "default": "", + "optional": false }, { - "name": "total_non_interest_income", + "name": "growth_retained_earnings", "type": "float", - "description": "Total non-interest income", - "default": null, - "optional": true + "description": "Growth rate of retained earnings.", + "default": "", + "optional": false }, { - "name": "interest_and_investment_income", + "name": "growth_accumulated_other_comprehensive_income_loss", "type": "float", - "description": "Interest and investment income", - "default": null, - "optional": true + "description": "Growth rate of accumulated other comprehensive income/loss.", + "default": "", + "optional": false }, { - "name": "short_term_borrowings_interest_expense", + "name": "growth_othertotal_stockholders_equity", "type": "float", - "description": "Short-term borrowings interest expense", - "default": null, - "optional": true + "description": "Growth rate of other total stockholders' equity.", + "default": "", + "optional": false }, { - "name": "long_term_debt_interest_expense", + "name": "growth_total_stockholders_equity", "type": "float", - "description": "Long-term debt interest expense", - "default": null, - "optional": true + "description": "Growth rate of total stockholders' equity.", + "default": "", + "optional": false }, { - "name": "capitalized_lease_obligations_interest_expense", + "name": "growth_total_liabilities_and_stockholders_equity", "type": "float", - "description": "Capitalized lease obligations interest expense", - "default": null, - "optional": true + "description": "Growth rate of total liabilities and stockholders' equity.", + "default": "", + "optional": false }, { - "name": "deposits_interest_expense", + "name": "growth_total_investments", "type": "float", - "description": "Deposits interest expense", - "default": null, - "optional": true + "description": "Growth rate of total investments.", + "default": "", + "optional": false }, { - "name": "federal_funds_purchased_and_securities_sold_interest_expense", + "name": "growth_total_debt", "type": "float", - "description": "Federal funds purchased and securities sold interest expense", - "default": null, - "optional": true + "description": "Growth rate of total debt.", + "default": "", + "optional": false }, { - "name": "other_interest_expense", + "name": "growth_net_debt", "type": "float", - "description": "Other interest expense", - "default": null, - "optional": true - }, + "description": "Growth rate of net debt.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "BalanceSheetGrowth" + }, + "/equity/fundamental/cash": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the cash flow statement for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.cash(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.cash(symbol='AAPL', period='annual', limit=5, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ { - "name": "total_interest_expense", - "type": "float", - "description": "Total interest expense", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "net_interest_income", - "type": "float", - "description": "Net interest income", - "default": null, + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", "optional": true }, { - "name": "other_non_interest_income", - "type": "float", - "description": "Other non-interest income", - "default": null, + "name": "limit", + "type": "Annotated[int, Ge(ge=0)]", + "description": "The number of data entries to return.", + "default": 5, "optional": true }, { - "name": "investment_banking_income", - "type": "float", - "description": "Investment banking income", - "default": null, + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "trust_fees_by_commissions", - "type": "float", - "description": "Trust fees by commissions", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", "optional": true - }, - { - "name": "premiums_earned", - "type": "float", - "description": "Premiums earned", - "default": null, + } + ], + "intrinio": [ + { + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", + "description": "None", + "default": "annual", "optional": true }, { - "name": "insurance_policy_acquisition_costs", - "type": "float", - "description": "Insurance policy acquisition costs", + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", "default": null, "optional": true + } + ], + "polygon": [ + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true }, { - "name": "current_and_future_benefits", - "type": "float", - "description": "Current and future benefits", + "name": "filing_date", + "type": "date", + "description": "Filing date of the financial statement.", "default": null, "optional": true }, { - "name": "property_and_liability_insurance_claims", - "type": "float", - "description": "Property and liability insurance claims", + "name": "filing_date_lt", + "type": "date", + "description": "Filing date less than the given date.", "default": null, "optional": true }, { - "name": "total_non_interest_expense", - "type": "float", - "description": "Total non-interest expense", + "name": "filing_date_lte", + "type": "date", + "description": "Filing date less than or equal to the given date.", "default": null, "optional": true }, { - "name": "net_realized_and_unrealized_capital_gains_on_investments", - "type": "float", - "description": "Net realized and unrealized capital gains on investments", + "name": "filing_date_gt", + "type": "date", + "description": "Filing date greater than the given date.", "default": null, "optional": true }, { - "name": "other_gains", - "type": "float", - "description": "Other gains", + "name": "filing_date_gte", + "type": "date", + "description": "Filing date greater than or equal to the given date.", "default": null, "optional": true }, { - "name": "non_operating_income", - "type": "float", - "description": "Non-operating income", + "name": "period_of_report_date", + "type": "date", + "description": "Period of report date of the financial statement.", "default": null, "optional": true }, { - "name": "other_income", - "type": "float", - "description": "Other income", + "name": "period_of_report_date_lt", + "type": "date", + "description": "Period of report date less than the given date.", "default": null, "optional": true }, { - "name": "other_revenue", - "type": "float", - "description": "Other revenue", + "name": "period_of_report_date_lte", + "type": "date", + "description": "Period of report date less than or equal to the given date.", "default": null, "optional": true }, { - "name": "extraordinary_income", - "type": "float", - "description": "Extraordinary income", + "name": "period_of_report_date_gt", + "type": "date", + "description": "Period of report date greater than the given date.", "default": null, "optional": true }, { - "name": "total_other_income", - "type": "float", - "description": "Total other income", + "name": "period_of_report_date_gte", + "type": "date", + "description": "Period of report date greater than or equal to the given date.", "default": null, "optional": true }, { - "name": "ebitda", - "type": "float", - "description": "Earnings Before Interest, Taxes, Depreciation and Amortization.", - "default": null, + "name": "include_sources", + "type": "bool", + "description": "Whether to include the sources of the financial statement.", + "default": false, "optional": true }, { - "name": "ebitda_margin", - "type": "float", - "description": "Margin on Earnings Before Interest, Taxes, Depreciation and Amortization.", + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order of the financial statement.", "default": null, "optional": true }, { - "name": "total_pre_tax_income", - "type": "float", - "description": "Total pre-tax income", + "name": "sort", + "type": "Literal['filing_date', 'period_of_report_date']", + "description": "Sort of the financial statement.", "default": null, "optional": true + } + ], + "yfinance": [ + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CashFlowStatement]", + "description": "Serializable results." }, { - "name": "ebit", - "type": "float", - "description": "Earnings Before Interest and Taxes.", + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", "default": null, "optional": true }, { - "name": "pre_tax_income_margin", - "type": "float", - "description": "Pre-Tax Income Margin.", + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "income_tax_expense", - "type": "float", - "description": "Income tax expense", + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", "default": null, "optional": true }, { - "name": "impairment_charge", - "type": "float", - "description": "Impairment charge", + "name": "filing_date", + "type": "date", + "description": "The date of the filing.", "default": null, "optional": true }, { - "name": "restructuring_charge", - "type": "float", - "description": "Restructuring charge", + "name": "accepted_date", + "type": "datetime", + "description": "The date the filing was accepted.", "default": null, "optional": true }, { - "name": "service_charges_on_deposit_accounts", - "type": "float", - "description": "Service charges on deposit accounts", + "name": "reported_currency", + "type": "str", + "description": "The currency in which the cash flow statement was reported.", "default": null, "optional": true }, { - "name": "other_service_charges", + "name": "net_income", "type": "float", - "description": "Other service charges", + "description": "Net income.", "default": null, "optional": true }, { - "name": "other_special_charges", + "name": "depreciation_and_amortization", "type": "float", - "description": "Other special charges", + "description": "Depreciation and amortization.", "default": null, "optional": true }, { - "name": "other_cost_of_revenue", + "name": "deferred_income_tax", "type": "float", - "description": "Other cost of revenue", + "description": "Deferred income tax.", "default": null, "optional": true }, { - "name": "net_income_continuing_operations", + "name": "stock_based_compensation", "type": "float", - "description": "Net income (continuing operations)", + "description": "Stock-based compensation.", "default": null, "optional": true }, { - "name": "net_income_discontinued_operations", + "name": "change_in_working_capital", "type": "float", - "description": "Net income (discontinued operations)", + "description": "Change in working capital.", "default": null, "optional": true }, { - "name": "consolidated_net_income", + "name": "change_in_account_receivables", "type": "float", - "description": "Consolidated net income", + "description": "Change in account receivables.", "default": null, "optional": true }, { - "name": "other_adjustments_to_consolidated_net_income", + "name": "change_in_inventory", "type": "float", - "description": "Other adjustments to consolidated net income", + "description": "Change in inventory.", "default": null, "optional": true }, { - "name": "other_adjustment_to_net_income_attributable_to_common_shareholders", + "name": "change_in_account_payable", "type": "float", - "description": "Other adjustment to net income attributable to common shareholders", + "description": "Change in account payable.", "default": null, "optional": true }, { - "name": "net_income_attributable_to_noncontrolling_interest", + "name": "change_in_other_working_capital", "type": "float", - "description": "Net income attributable to noncontrolling interest", + "description": "Change in other working capital.", "default": null, "optional": true }, { - "name": "net_income_attributable_to_common_shareholders", + "name": "change_in_other_non_cash_items", "type": "float", - "description": "Net income attributable to common shareholders", + "description": "Change in other non-cash items.", "default": null, "optional": true }, { - "name": "basic_earnings_per_share", + "name": "net_cash_from_operating_activities", "type": "float", - "description": "Basic earnings per share", + "description": "Net cash from operating activities.", "default": null, "optional": true }, { - "name": "diluted_earnings_per_share", + "name": "purchase_of_property_plant_and_equipment", "type": "float", - "description": "Diluted earnings per share", + "description": "Purchase of property, plant and equipment.", "default": null, "optional": true }, { - "name": "basic_and_diluted_earnings_per_share", + "name": "acquisitions", "type": "float", - "description": "Basic and diluted earnings per share", + "description": "Acquisitions.", "default": null, "optional": true }, { - "name": "cash_dividends_to_common_per_share", + "name": "purchase_of_investment_securities", "type": "float", - "description": "Cash dividends to common per share", + "description": "Purchase of investment securities.", "default": null, "optional": true }, { - "name": "preferred_stock_dividends_declared", + "name": "sale_and_maturity_of_investments", "type": "float", - "description": "Preferred stock dividends declared", + "description": "Sale and maturity of investments.", "default": null, "optional": true }, { - "name": "weighted_average_basic_shares_outstanding", + "name": "other_investing_activities", "type": "float", - "description": "Weighted average basic shares outstanding", + "description": "Other investing activities.", "default": null, "optional": true }, { - "name": "weighted_average_diluted_shares_outstanding", + "name": "net_cash_from_investing_activities", "type": "float", - "description": "Weighted average diluted shares outstanding", + "description": "Net cash from investing activities.", "default": null, "optional": true }, { - "name": "weighted_average_basic_and_diluted_shares_outstanding", + "name": "repayment_of_debt", "type": "float", - "description": "Weighted average basic and diluted shares outstanding", + "description": "Repayment of debt.", "default": null, "optional": true - } - ], - "polygon": [ + }, { - "name": "revenue", + "name": "issuance_of_common_equity", "type": "float", - "description": "Total Revenue", + "description": "Issuance of common equity.", "default": null, "optional": true }, { - "name": "cost_of_revenue_goods", + "name": "repurchase_of_common_equity", "type": "float", - "description": "Cost of Revenue - Goods", + "description": "Repurchase of common equity.", "default": null, "optional": true }, { - "name": "cost_of_revenue_services", + "name": "payment_of_dividends", "type": "float", - "description": "Cost of Revenue - Services", + "description": "Payment of dividends.", "default": null, "optional": true }, { - "name": "cost_of_revenue", + "name": "other_financing_activities", "type": "float", - "description": "Cost of Revenue", + "description": "Other financing activities.", "default": null, "optional": true }, { - "name": "gross_profit", + "name": "net_cash_from_financing_activities", "type": "float", - "description": "Gross Profit", + "description": "Net cash from financing activities.", "default": null, "optional": true }, { - "name": "provisions_for_loan_lease_and_other_losses", + "name": "effect_of_exchange_rate_changes_on_cash", "type": "float", - "description": "Provisions for loan lease and other losses", + "description": "Effect of exchange rate changes on cash.", "default": null, "optional": true }, { - "name": "depreciation_and_amortization", + "name": "net_change_in_cash_and_equivalents", "type": "float", - "description": "Depreciation and Amortization", + "description": "Net change in cash and equivalents.", "default": null, "optional": true }, { - "name": "income_tax_expense_benefit_current", + "name": "cash_at_beginning_of_period", "type": "float", - "description": "Income tax expense benefit current", + "description": "Cash at beginning of period.", "default": null, "optional": true }, { - "name": "deferred_tax_benefit", + "name": "cash_at_end_of_period", "type": "float", - "description": "Deferred tax benefit", + "description": "Cash at end of period.", "default": null, "optional": true }, { - "name": "benefits_costs_expenses", + "name": "operating_cash_flow", "type": "float", - "description": "Benefits, costs and expenses", + "description": "Operating cash flow.", "default": null, "optional": true }, { - "name": "selling_general_and_administrative_expense", + "name": "capital_expenditure", "type": "float", - "description": "Selling, general and administrative expense", + "description": "Capital expenditure.", "default": null, "optional": true }, { - "name": "research_and_development", + "name": "free_cash_flow", "type": "float", - "description": "Research and development", + "description": "None", "default": null, "optional": true }, { - "name": "costs_and_expenses", - "type": "float", - "description": "Costs and expenses", + "name": "link", + "type": "str", + "description": "Link to the filing.", "default": null, "optional": true }, { - "name": "other_operating_expenses", - "type": "float", - "description": "Other Operating Expenses", + "name": "final_link", + "type": "str", + "description": "Link to the filing document.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet is reported.", "default": null, "optional": true }, { - "name": "operating_expenses", + "name": "net_income_continuing_operations", "type": "float", - "description": "Operating expenses", + "description": "Net Income (Continuing Operations)", "default": null, "optional": true }, { - "name": "operating_income", + "name": "net_income_discontinued_operations", "type": "float", - "description": "Operating Income/Loss", + "description": "Net Income (Discontinued Operations)", "default": null, "optional": true }, { - "name": "non_operating_income", + "name": "net_income", "type": "float", - "description": "Non Operating Income/Loss", + "description": "Consolidated Net Income.", "default": null, "optional": true }, { - "name": "interest_and_dividend_income", + "name": "provision_for_loan_losses", "type": "float", - "description": "Interest and Dividend Income", + "description": "Provision for Loan Losses", "default": null, "optional": true }, { - "name": "total_interest_expense", + "name": "provision_for_credit_losses", "type": "float", - "description": "Interest Expense", + "description": "Provision for credit losses", "default": null, "optional": true }, { - "name": "interest_and_debt_expense", + "name": "depreciation_expense", "type": "float", - "description": "Interest and Debt Expense", + "description": "Depreciation Expense.", "default": null, "optional": true }, { - "name": "net_interest_income", + "name": "amortization_expense", "type": "float", - "description": "Interest Income Net", + "description": "Amortization Expense.", "default": null, "optional": true }, { - "name": "interest_income_after_provision_for_losses", + "name": "share_based_compensation", "type": "float", - "description": "Interest Income After Provision for Losses", + "description": "Share-based compensation.", "default": null, "optional": true }, { - "name": "non_interest_expense", + "name": "non_cash_adjustments_to_reconcile_net_income", "type": "float", - "description": "Non-Interest Expense", + "description": "Non-Cash Adjustments to Reconcile Net Income.", "default": null, "optional": true }, { - "name": "non_interest_income", + "name": "changes_in_operating_assets_and_liabilities", "type": "float", - "description": "Non-Interest Income", + "description": "Changes in Operating Assets and Liabilities (Net)", "default": null, "optional": true }, { - "name": "income_from_discontinued_operations_net_of_tax_on_disposal", + "name": "net_cash_from_continuing_operating_activities", "type": "float", - "description": "Income From Discontinued Operations Net of Tax on Disposal", + "description": "Net Cash from Continuing Operating Activities", "default": null, "optional": true }, { - "name": "income_from_discontinued_operations_net_of_tax", + "name": "net_cash_from_discontinued_operating_activities", "type": "float", - "description": "Income From Discontinued Operations Net of Tax", + "description": "Net Cash from Discontinued Operating Activities", "default": null, "optional": true }, { - "name": "income_before_equity_method_investments", + "name": "net_cash_from_operating_activities", "type": "float", - "description": "Income Before Equity Method Investments", + "description": "Net Cash from Operating Activities", "default": null, "optional": true }, { - "name": "income_from_equity_method_investments", + "name": "divestitures", "type": "float", - "description": "Income From Equity Method Investments", + "description": "Divestitures", "default": null, "optional": true }, { - "name": "total_pre_tax_income", + "name": "sale_of_property_plant_and_equipment", "type": "float", - "description": "Income Before Tax", + "description": "Sale of Property, Plant, and Equipment", "default": null, "optional": true }, { - "name": "income_tax_expense", + "name": "acquisitions", "type": "float", - "description": "Income Tax Expense", + "description": "Acquisitions", "default": null, "optional": true }, { - "name": "income_after_tax", + "name": "purchase_of_investments", "type": "float", - "description": "Income After Tax", + "description": "Purchase of Investments", "default": null, "optional": true }, { - "name": "consolidated_net_income", + "name": "purchase_of_investment_securities", "type": "float", - "description": "Net Income/Loss", + "description": "Purchase of Investment Securities", "default": null, "optional": true }, { - "name": "net_income_attributable_noncontrolling_interest", + "name": "sale_and_maturity_of_investments", "type": "float", - "description": "Net income (loss) attributable to noncontrolling interest", + "description": "Sale and Maturity of Investments", "default": null, "optional": true }, { - "name": "net_income_attributable_to_parent", + "name": "loans_held_for_sale", "type": "float", - "description": "Net income (loss) attributable to parent", + "description": "Loans Held for Sale (Net)", "default": null, "optional": true }, { - "name": "net_income_attributable_to_common_shareholders", + "name": "purchase_of_property_plant_and_equipment", "type": "float", - "description": "Net Income/Loss Available To Common Stockholders Basic", + "description": "Purchase of Property, Plant, and Equipment", "default": null, "optional": true }, { - "name": "participating_securities_earnings", + "name": "other_investing_activities", "type": "float", - "description": "Participating Securities Distributed And Undistributed Earnings Loss Basic", + "description": "Other Investing Activities (Net)", "default": null, "optional": true }, { - "name": "undistributed_earnings_allocated_to_participating_securities", + "name": "net_cash_from_continuing_investing_activities", "type": "float", - "description": "Undistributed Earnings Allocated To Participating Securities", + "description": "Net Cash from Continuing Investing Activities", "default": null, "optional": true }, { - "name": "common_stock_dividends", + "name": "net_cash_from_discontinued_investing_activities", "type": "float", - "description": "Common Stock Dividends", + "description": "Net Cash from Discontinued Investing Activities", "default": null, "optional": true }, { - "name": "preferred_stock_dividends_and_other_adjustments", + "name": "net_cash_from_investing_activities", "type": "float", - "description": "Preferred stock dividends and other adjustments", + "description": "Net Cash from Investing Activities", "default": null, "optional": true }, { - "name": "basic_earnings_per_share", + "name": "payment_of_dividends", "type": "float", - "description": "Earnings Per Share", + "description": "Payment of Dividends", "default": null, "optional": true }, { - "name": "diluted_earnings_per_share", + "name": "repurchase_of_common_equity", "type": "float", - "description": "Diluted Earnings Per Share", + "description": "Repurchase of Common Equity", "default": null, "optional": true }, { - "name": "weighted_average_basic_shares_outstanding", + "name": "repurchase_of_preferred_equity", "type": "float", - "description": "Basic Average Shares", + "description": "Repurchase of Preferred Equity", "default": null, "optional": true }, { - "name": "weighted_average_diluted_shares_outstanding", + "name": "issuance_of_common_equity", "type": "float", - "description": "Diluted Average Shares", + "description": "Issuance of Common Equity", "default": null, "optional": true - } - ], - "yfinance": [] - }, - "model": "IncomeStatement" - }, - "/equity/fundamental/income_growth": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the growth of a company's income statement items over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.income_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.income_growth(symbol='AAPL', limit=10, period='annual', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 10, + "name": "issuance_of_preferred_equity", + "type": "float", + "description": "Issuance of Preferred Equity", + "default": null, "optional": true }, { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "Time period of the data to return.", - "default": "annual", + "name": "issuance_of_debt", + "type": "float", + "description": "Issuance of Debt", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "repayment_of_debt", + "type": "float", + "description": "Repayment of Debt", + "default": null, "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[IncomeStatementGrowth]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "other_financing_activities", + "type": "float", + "description": "Other Financing Activities (Net)", "default": null, "optional": true }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "period", - "type": "str", - "description": "Period the statement is returned for.", - "default": "", - "optional": false - }, - { - "name": "growth_revenue", + "name": "cash_interest_received", "type": "float", - "description": "Growth rate of total revenue.", - "default": "", - "optional": false + "description": "Cash Interest Received", + "default": null, + "optional": true }, { - "name": "growth_cost_of_revenue", + "name": "net_change_in_deposits", "type": "float", - "description": "Growth rate of cost of goods sold.", - "default": "", - "optional": false + "description": "Net Change in Deposits", + "default": null, + "optional": true }, { - "name": "growth_gross_profit", + "name": "net_increase_in_fed_funds_sold", "type": "float", - "description": "Growth rate of gross profit.", - "default": "", - "optional": false + "description": "Net Increase in Fed Funds Sold", + "default": null, + "optional": true }, { - "name": "growth_gross_profit_ratio", + "name": "net_cash_from_continuing_financing_activities", "type": "float", - "description": "Growth rate of gross profit as a percentage of revenue.", - "default": "", - "optional": false + "description": "Net Cash from Continuing Financing Activities", + "default": null, + "optional": true }, { - "name": "growth_research_and_development_expenses", + "name": "net_cash_from_discontinued_financing_activities", "type": "float", - "description": "Growth rate of expenses on research and development.", - "default": "", - "optional": false + "description": "Net Cash from Discontinued Financing Activities", + "default": null, + "optional": true }, { - "name": "growth_general_and_administrative_expenses", + "name": "net_cash_from_financing_activities", "type": "float", - "description": "Growth rate of general and administrative expenses.", - "default": "", - "optional": false + "description": "Net Cash from Financing Activities", + "default": null, + "optional": true }, { - "name": "growth_selling_and_marketing_expenses", + "name": "effect_of_exchange_rate_changes", "type": "float", - "description": "Growth rate of expenses on selling and marketing activities.", - "default": "", - "optional": false + "description": "Effect of Exchange Rate Changes", + "default": null, + "optional": true }, { - "name": "growth_other_expenses", + "name": "other_net_changes_in_cash", "type": "float", - "description": "Growth rate of other operating expenses.", - "default": "", - "optional": false + "description": "Other Net Changes in Cash", + "default": null, + "optional": true }, { - "name": "growth_operating_expenses", + "name": "net_change_in_cash_and_equivalents", "type": "float", - "description": "Growth rate of total operating expenses.", - "default": "", - "optional": false + "description": "Net Change in Cash and Equivalents", + "default": null, + "optional": true }, { - "name": "growth_cost_and_expenses", + "name": "cash_income_taxes_paid", "type": "float", - "description": "Growth rate of total costs and expenses.", - "default": "", - "optional": false + "description": "Cash Income Taxes Paid", + "default": null, + "optional": true }, { - "name": "growth_interest_expense", + "name": "cash_interest_paid", "type": "float", - "description": "Growth rate of interest expenses.", - "default": "", - "optional": false - }, + "description": "Cash Interest Paid", + "default": null, + "optional": true + } + ], + "polygon": [ { - "name": "growth_depreciation_and_amortization", - "type": "float", - "description": "Growth rate of depreciation and amortization expenses.", - "default": "", - "optional": false + "name": "net_cash_flow_from_operating_activities_continuing", + "type": "int", + "description": "Net cash flow from operating activities continuing.", + "default": null, + "optional": true }, { - "name": "growth_ebitda", - "type": "float", - "description": "Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization.", - "default": "", - "optional": false + "name": "net_cash_flow_from_operating_activities_discontinued", + "type": "int", + "description": "Net cash flow from operating activities discontinued.", + "default": null, + "optional": true }, { - "name": "growth_ebitda_ratio", - "type": "float", - "description": "Growth rate of EBITDA as a percentage of revenue.", - "default": "", - "optional": false + "name": "net_cash_flow_from_operating_activities", + "type": "int", + "description": "Net cash flow from operating activities.", + "default": null, + "optional": true }, { - "name": "growth_operating_income", - "type": "float", - "description": "Growth rate of operating income.", - "default": "", - "optional": false + "name": "net_cash_flow_from_investing_activities_continuing", + "type": "int", + "description": "Net cash flow from investing activities continuing.", + "default": null, + "optional": true }, { - "name": "growth_operating_income_ratio", - "type": "float", - "description": "Growth rate of operating income as a percentage of revenue.", - "default": "", - "optional": false + "name": "net_cash_flow_from_investing_activities_discontinued", + "type": "int", + "description": "Net cash flow from investing activities discontinued.", + "default": null, + "optional": true }, { - "name": "growth_total_other_income_expenses_net", - "type": "float", - "description": "Growth rate of net total other income and expenses.", - "default": "", - "optional": false + "name": "net_cash_flow_from_investing_activities", + "type": "int", + "description": "Net cash flow from investing activities.", + "default": null, + "optional": true }, { - "name": "growth_income_before_tax", - "type": "float", - "description": "Growth rate of income before taxes.", - "default": "", - "optional": false + "name": "net_cash_flow_from_financing_activities_continuing", + "type": "int", + "description": "Net cash flow from financing activities continuing.", + "default": null, + "optional": true }, { - "name": "growth_income_before_tax_ratio", - "type": "float", - "description": "Growth rate of income before taxes as a percentage of revenue.", - "default": "", - "optional": false + "name": "net_cash_flow_from_financing_activities_discontinued", + "type": "int", + "description": "Net cash flow from financing activities discontinued.", + "default": null, + "optional": true }, { - "name": "growth_income_tax_expense", - "type": "float", - "description": "Growth rate of income tax expenses.", - "default": "", - "optional": false + "name": "net_cash_flow_from_financing_activities", + "type": "int", + "description": "Net cash flow from financing activities.", + "default": null, + "optional": true }, { - "name": "growth_net_income", - "type": "float", - "description": "Growth rate of net income.", - "default": "", - "optional": false + "name": "net_cash_flow_continuing", + "type": "int", + "description": "Net cash flow continuing.", + "default": null, + "optional": true }, { - "name": "growth_net_income_ratio", - "type": "float", - "description": "Growth rate of net income as a percentage of revenue.", - "default": "", - "optional": false + "name": "net_cash_flow_discontinued", + "type": "int", + "description": "Net cash flow discontinued.", + "default": null, + "optional": true }, { - "name": "growth_eps", - "type": "float", - "description": "Growth rate of Earnings Per Share (EPS).", - "default": "", - "optional": false + "name": "exchange_gains_losses", + "type": "int", + "description": "Exchange gains losses.", + "default": null, + "optional": true }, { - "name": "growth_eps_diluted", - "type": "float", - "description": "Growth rate of diluted Earnings Per Share (EPS).", - "default": "", - "optional": false - }, - { - "name": "growth_weighted_average_shs_out", - "type": "float", - "description": "Growth rate of weighted average shares outstanding.", - "default": "", - "optional": false - }, - { - "name": "growth_weighted_average_shs_out_dil", - "type": "float", - "description": "Growth rate of diluted weighted average shares outstanding.", - "default": "", - "optional": false + "name": "net_cash_flow", + "type": "int", + "description": "Net cash flow.", + "default": null, + "optional": true } ], - "fmp": [] + "yfinance": [] }, - "model": "IncomeStatementGrowth" + "model": "CashFlowStatement" }, - "/equity/fundamental/metrics": { + "/equity/fundamental/reported_financials": { "deprecated": { "flag": null, "message": null }, - "description": "Get fundamental metrics for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.metrics(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.metrics(symbol='AAPL', period='annual', limit=100, provider='intrinio')\n```\n\n", + "description": "Get financial statements as reported by the company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.reported_financials(symbol='AAPL', provider='intrinio')\n# Get AAPL balance sheet with a limit of 10 items.\nobb.equity.fundamental.reported_financials(symbol='AAPL', period='annual', statement_type='balance', limit=10, provider='intrinio')\n# Get reported income statement\nobb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='income', provider='intrinio')\n# Get reported cash flow statement\nobb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='cash', provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", + "type": "str", + "description": "Symbol to get data for.", "default": "", "optional": false }, { "name": "period", - "type": "Literal['annual', 'quarter']", + "type": "str", "description": "Time period of the data to return.", "default": "annual", "optional": true }, + { + "name": "statement_type", + "type": "str", + "description": "The type of financial statement - i.e, balance, income, cash.", + "default": "balance", + "optional": true + }, { "name": "limit", "type": "int", - "description": "The number of data entries to return.", + "description": "The number of data entries to return. Although the response object contains multiple results, because of the variance in the fields, year-to-year and quarter-to-quarter, it is recommended to view results in small chunks.", "default": 100, "optional": true }, { "name": "provider", - "type": "Literal['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", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", "optional": true } ], - "fmp": [ + "intrinio": [ { - "name": "with_ttm", - "type": "bool", - "description": "Include trailing twelve months (TTM) data.", - "default": false, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true + }, + { + "name": "statement_type", + "type": "Literal['balance', 'income', 'cash']", + "description": "Cash flow statements are reported as YTD, Q4 is the same as FY.", + "default": "income", + "optional": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", + "default": null, "optional": true } - ], - "intrinio": [], - "yfinance": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[KeyMetrics]", + "type": "List[ReportedFinancials]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "type": "Optional[Literal['intrinio']]", "description": "Provider name." }, { @@ -13775,28 +13889,102 @@ "data": { "standard": [ { - "name": "symbol", + "name": "period_ending", + "type": "date", + "description": "The ending date of the reporting period.", + "default": "", + "optional": false + }, + { + "name": "fiscal_period", "type": "str", - "description": "Symbol representing the entity requested in the data.", + "description": "The fiscal period of the report (e.g. FY, Q1, etc.).", + "default": "", + "optional": false + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", "default": null, "optional": true + } + ], + "intrinio": [] + }, + "model": "ReportedFinancials" + }, + "/equity/fundamental/cash_growth": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the growth of a company's cash flow statement items over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.cash_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.cash_growth(symbol='AAPL', limit=10, provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "market_cap", - "type": "float", - "description": "Market capitalization", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10, "optional": true }, { - "name": "pe_ratio", - "type": "float", - "description": "Price-to-earnings ratio (P/E ratio)", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true } ], - "fmp": [ + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CashFlowStatementGrowth]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, { "name": "date", "type": "date", @@ -13807,944 +13995,1080 @@ { "name": "period", "type": "str", - "description": "Period of the data.", + "description": "Period the statement is returned for.", "default": "", "optional": false }, { - "name": "calendar_year", - "type": "int", - "description": "Calendar year.", - "default": null, - "optional": true - }, - { - "name": "revenue_per_share", + "name": "growth_net_income", "type": "float", - "description": "Revenue per share", - "default": null, - "optional": true + "description": "Growth rate of net income.", + "default": "", + "optional": false }, { - "name": "net_income_per_share", + "name": "growth_depreciation_and_amortization", "type": "float", - "description": "Net income per share", - "default": null, - "optional": true + "description": "Growth rate of depreciation and amortization.", + "default": "", + "optional": false }, { - "name": "operating_cash_flow_per_share", + "name": "growth_deferred_income_tax", "type": "float", - "description": "Operating cash flow per share", - "default": null, - "optional": true + "description": "Growth rate of deferred income tax.", + "default": "", + "optional": false }, { - "name": "free_cash_flow_per_share", + "name": "growth_stock_based_compensation", "type": "float", - "description": "Free cash flow per share", - "default": null, - "optional": true + "description": "Growth rate of stock-based compensation.", + "default": "", + "optional": false }, { - "name": "cash_per_share", + "name": "growth_change_in_working_capital", "type": "float", - "description": "Cash per share", - "default": null, - "optional": true + "description": "Growth rate of change in working capital.", + "default": "", + "optional": false }, { - "name": "book_value_per_share", + "name": "growth_accounts_receivables", "type": "float", - "description": "Book value per share", - "default": null, - "optional": true + "description": "Growth rate of accounts receivables.", + "default": "", + "optional": false }, { - "name": "tangible_book_value_per_share", + "name": "growth_inventory", "type": "float", - "description": "Tangible book value per share", - "default": null, - "optional": true + "description": "Growth rate of inventory.", + "default": "", + "optional": false }, { - "name": "shareholders_equity_per_share", + "name": "growth_accounts_payables", "type": "float", - "description": "Shareholders equity per share", - "default": null, - "optional": true + "description": "Growth rate of accounts payables.", + "default": "", + "optional": false }, { - "name": "interest_debt_per_share", + "name": "growth_other_working_capital", "type": "float", - "description": "Interest debt per share", - "default": null, - "optional": true + "description": "Growth rate of other working capital.", + "default": "", + "optional": false }, { - "name": "enterprise_value", + "name": "growth_other_non_cash_items", "type": "float", - "description": "Enterprise value", - "default": null, - "optional": true + "description": "Growth rate of other non-cash items.", + "default": "", + "optional": false }, { - "name": "price_to_sales_ratio", + "name": "growth_net_cash_provided_by_operating_activities", "type": "float", - "description": "Price-to-sales ratio", - "default": null, - "optional": true + "description": "Growth rate of net cash provided by operating activities.", + "default": "", + "optional": false }, { - "name": "pocf_ratio", + "name": "growth_investments_in_property_plant_and_equipment", "type": "float", - "description": "Price-to-operating cash flow ratio", - "default": null, - "optional": true + "description": "Growth rate of investments in property, plant, and equipment.", + "default": "", + "optional": false }, { - "name": "pfcf_ratio", + "name": "growth_acquisitions_net", "type": "float", - "description": "Price-to-free cash flow ratio", - "default": null, - "optional": true + "description": "Growth rate of net acquisitions.", + "default": "", + "optional": false }, { - "name": "pb_ratio", + "name": "growth_purchases_of_investments", "type": "float", - "description": "Price-to-book ratio", - "default": null, - "optional": true + "description": "Growth rate of purchases of investments.", + "default": "", + "optional": false }, { - "name": "ptb_ratio", + "name": "growth_sales_maturities_of_investments", "type": "float", - "description": "Price-to-tangible book ratio", - "default": null, - "optional": true + "description": "Growth rate of sales maturities of investments.", + "default": "", + "optional": false }, { - "name": "ev_to_sales", + "name": "growth_other_investing_activities", "type": "float", - "description": "Enterprise value-to-sales ratio", - "default": null, - "optional": true + "description": "Growth rate of other investing activities.", + "default": "", + "optional": false }, { - "name": "enterprise_value_over_ebitda", + "name": "growth_net_cash_used_for_investing_activities", "type": "float", - "description": "Enterprise value-to-EBITDA ratio", - "default": null, - "optional": true + "description": "Growth rate of net cash used for investing activities.", + "default": "", + "optional": false }, { - "name": "ev_to_operating_cash_flow", + "name": "growth_debt_repayment", "type": "float", - "description": "Enterprise value-to-operating cash flow ratio", - "default": null, - "optional": true + "description": "Growth rate of debt repayment.", + "default": "", + "optional": false }, { - "name": "ev_to_free_cash_flow", + "name": "growth_common_stock_issued", "type": "float", - "description": "Enterprise value-to-free cash flow ratio", - "default": null, - "optional": true + "description": "Growth rate of common stock issued.", + "default": "", + "optional": false }, { - "name": "earnings_yield", + "name": "growth_common_stock_repurchased", "type": "float", - "description": "Earnings yield", - "default": null, - "optional": true + "description": "Growth rate of common stock repurchased.", + "default": "", + "optional": false }, { - "name": "free_cash_flow_yield", + "name": "growth_dividends_paid", "type": "float", - "description": "Free cash flow yield", - "default": null, - "optional": true + "description": "Growth rate of dividends paid.", + "default": "", + "optional": false }, { - "name": "debt_to_equity", + "name": "growth_other_financing_activities", "type": "float", - "description": "Debt-to-equity ratio", - "default": null, - "optional": true + "description": "Growth rate of other financing activities.", + "default": "", + "optional": false }, { - "name": "debt_to_assets", + "name": "growth_net_cash_used_provided_by_financing_activities", "type": "float", - "description": "Debt-to-assets ratio", - "default": null, - "optional": true + "description": "Growth rate of net cash used/provided by financing activities.", + "default": "", + "optional": false }, { - "name": "net_debt_to_ebitda", + "name": "growth_effect_of_forex_changes_on_cash", "type": "float", - "description": "Net debt-to-EBITDA ratio", - "default": null, - "optional": true + "description": "Growth rate of the effect of foreign exchange changes on cash.", + "default": "", + "optional": false }, { - "name": "current_ratio", + "name": "growth_net_change_in_cash", "type": "float", - "description": "Current ratio", - "default": null, - "optional": true + "description": "Growth rate of net change in cash.", + "default": "", + "optional": false }, { - "name": "interest_coverage", + "name": "growth_cash_at_end_of_period", "type": "float", - "description": "Interest coverage", - "default": null, - "optional": true + "description": "Growth rate of cash at the end of the period.", + "default": "", + "optional": false }, { - "name": "income_quality", + "name": "growth_cash_at_beginning_of_period", "type": "float", - "description": "Income quality", - "default": null, - "optional": true + "description": "Growth rate of cash at the beginning of the period.", + "default": "", + "optional": false }, { - "name": "dividend_yield", + "name": "growth_operating_cash_flow", "type": "float", - "description": "Dividend yield, as a normalized percent.", - "default": null, - "optional": true + "description": "Growth rate of operating cash flow.", + "default": "", + "optional": false }, { - "name": "payout_ratio", + "name": "growth_capital_expenditure", "type": "float", - "description": "Payout ratio", - "default": null, - "optional": true + "description": "Growth rate of capital expenditure.", + "default": "", + "optional": false }, { - "name": "sales_general_and_administrative_to_revenue", + "name": "growth_free_cash_flow", "type": "float", - "description": "Sales general and administrative expenses-to-revenue ratio", - "default": null, - "optional": true - }, + "description": "Growth rate of free cash flow.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "CashFlowStatementGrowth" + }, + "/equity/fundamental/dividends": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical dividend data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.dividends(symbol='AAPL', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ { - "name": "research_and_development_to_revenue", - "type": "float", - "description": "Research and development expenses-to-revenue ratio", - "default": null, - "optional": true + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): nasdaq.", + "default": "", + "optional": false }, { - "name": "intangibles_to_total_assets", - "type": "float", - "description": "Intangibles-to-total assets ratio", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "capex_to_operating_cash_flow", - "type": "float", - "description": "Capital expenditures-to-operating cash flow ratio", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "capex_to_revenue", - "type": "float", - "description": "Capital expenditures-to-revenue ratio", - "default": null, + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'nasdaq', 'tmx', 'yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [], + "intrinio": [ { - "name": "capex_to_depreciation", - "type": "float", - "description": "Capital expenditures-to-depreciation ratio", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100, "optional": true - }, + } + ], + "nasdaq": [], + "tmx": [], + "yfinance": [] + }, + "returns": { + "OBBject": [ { - "name": "stock_based_compensation_to_revenue", - "type": "float", - "description": "Stock-based compensation-to-revenue ratio", - "default": null, - "optional": true + "name": "results", + "type": "List[HistoricalDividends]", + "description": "Serializable results." }, { - "name": "graham_number", - "type": "float", - "description": "Graham number", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'nasdaq', 'tmx', 'yfinance']]", + "description": "Provider name." }, { - "name": "roic", - "type": "float", - "description": "Return on invested capital", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "return_on_tangible_assets", + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "ex_dividend_date", + "type": "date", + "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", + "default": "", + "optional": false + }, + { + "name": "amount", "type": "float", - "description": "Return on tangible assets", - "default": null, - "optional": true + "description": "The dividend amount per share.", + "default": "", + "optional": false + } + ], + "fmp": [ + { + "name": "label", + "type": "str", + "description": "Label of the historical dividends.", + "default": "", + "optional": false }, { - "name": "graham_net_net", + "name": "adj_dividend", "type": "float", - "description": "Graham net-net working capital", + "description": "Adjusted dividend of the historical dividends.", + "default": "", + "optional": false + }, + { + "name": "record_date", + "type": "date", + "description": "Record date of the historical dividends.", "default": null, "optional": true }, { - "name": "working_capital", - "type": "float", - "description": "Working capital", + "name": "payment_date", + "type": "date", + "description": "Payment date of the historical dividends.", "default": null, "optional": true }, { - "name": "tangible_asset_value", - "type": "float", - "description": "Tangible asset value", + "name": "declaration_date", + "type": "date", + "description": "Declaration date of the historical dividends.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "net_current_asset_value", + "name": "factor", "type": "float", - "description": "Net current asset value", + "description": "factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.", "default": null, "optional": true }, { - "name": "invested_capital", - "type": "float", - "description": "Invested capital", + "name": "currency", + "type": "str", + "description": "The currency in which the dividend is paid.", "default": null, "optional": true }, { - "name": "average_receivables", + "name": "split_ratio", "type": "float", - "description": "Average receivables", + "description": "The ratio of the stock split, if a stock split occurred.", "default": null, "optional": true - }, + } + ], + "nasdaq": [ { - "name": "average_payables", - "type": "float", - "description": "Average payables", + "name": "dividend_type", + "type": "str", + "description": "The type of dividend - i.e., cash, stock.", "default": null, "optional": true }, { - "name": "average_inventory", - "type": "float", - "description": "Average inventory", + "name": "currency", + "type": "str", + "description": "The currency in which the dividend is paid.", "default": null, "optional": true }, { - "name": "days_sales_outstanding", - "type": "float", - "description": "Days sales outstanding", + "name": "record_date", + "type": "date", + "description": "The record date of ownership for eligibility.", "default": null, "optional": true }, { - "name": "days_payables_outstanding", - "type": "float", - "description": "Days payables outstanding", + "name": "payment_date", + "type": "date", + "description": "The payment date of the dividend.", "default": null, "optional": true }, { - "name": "days_of_inventory_on_hand", - "type": "float", - "description": "Days of inventory on hand", + "name": "declaration_date", + "type": "date", + "description": "Declaration date of the dividend.", "default": null, "optional": true - }, + } + ], + "tmx": [ { - "name": "receivables_turnover", - "type": "float", - "description": "Receivables turnover", + "name": "currency", + "type": "str", + "description": "The currency the dividend is paid in.", "default": null, "optional": true }, { - "name": "payables_turnover", - "type": "float", - "description": "Payables turnover", + "name": "decalaration_date", + "type": "date", + "description": "The date of the announcement.", "default": null, "optional": true }, { - "name": "inventory_turnover", - "type": "float", - "description": "Inventory turnover", + "name": "record_date", + "type": "date", + "description": "The record date of ownership for rights to the dividend.", "default": null, "optional": true }, { - "name": "roe", - "type": "float", - "description": "Return on equity", + "name": "payment_date", + "type": "date", + "description": "The date the dividend is paid.", "default": null, "optional": true + } + ], + "yfinance": [] + }, + "model": "HistoricalDividends" + }, + "/equity/fundamental/historical_eps": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical earnings per share data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_eps(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage.", + "default": "", + "optional": false }, { - "name": "capex_per_share", - "type": "float", - "description": "Capital expenditures per share", - "default": null, + "name": "provider", + "type": "Literal['alpha_vantage', 'fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default.", + "default": "alpha_vantage", "optional": true } ], - "intrinio": [ + "alpha_vantage": [ { - "name": "price_to_book", - "type": "float", - "description": "Price to book ratio.", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "Time period of the data to return.", + "default": "quarter", "optional": true }, { - "name": "price_to_tangible_book", - "type": "float", - "description": "Price to tangible book ratio.", + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "price_to_revenue", - "type": "float", - "description": "Price to revenue ratio.", + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", "default": null, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[HistoricalEps]", + "description": "Serializable results." }, { - "name": "quick_ratio", - "type": "float", - "description": "Quick ratio.", + "name": "provider", + "type": "Optional[Literal['alpha_vantage', 'fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", "default": null, "optional": true }, { - "name": "gross_margin", - "type": "float", - "description": "Gross margin, as a normalized percent.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "announce_time", + "type": "str", + "description": "Timing of the earnings announcement.", "default": null, "optional": true }, { - "name": "ebit_margin", + "name": "eps_actual", "type": "float", - "description": "EBIT margin, as a normalized percent.", + "description": "Actual EPS from the earnings date.", "default": null, "optional": true }, { - "name": "profit_margin", + "name": "eps_estimated", "type": "float", - "description": "Profit margin, as a normalized percent.", + "description": "Estimated EPS for the earnings date.", "default": null, "optional": true - }, + } + ], + "alpha_vantage": [ { - "name": "eps", + "name": "surprise", "type": "float", - "description": "Basic earnings per share.", + "description": "Surprise in EPS (Actual - Estimated).", "default": null, "optional": true }, { - "name": "eps_growth", - "type": "float", - "description": "EPS growth, as a normalized percent.", + "name": "surprise_percent", + "type": "Union[float, str]", + "description": "EPS surprise as a normalized percent.", "default": null, "optional": true }, { - "name": "revenue_growth", - "type": "float", - "description": "Revenue growth, as a normalized percent.", + "name": "reported_date", + "type": "date", + "description": "Date of the earnings report.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "ebitda_growth", + "name": "revenue_estimated", "type": "float", - "description": "EBITDA growth, as a normalized percent.", + "description": "Estimated consensus revenue for the reporting period.", "default": null, "optional": true }, { - "name": "ebit_growth", + "name": "revenue_actual", "type": "float", - "description": "EBIT growth, as a normalized percent.", + "description": "The actual reported revenue.", "default": null, "optional": true }, { - "name": "net_income_growth", - "type": "float", - "description": "Net income growth, as a normalized percent.", + "name": "reporting_time", + "type": "str", + "description": "The reporting time - e.g. after market close.", "default": null, "optional": true }, { - "name": "free_cash_flow_to_firm_growth", - "type": "float", - "description": "Free cash flow to firm growth, as a normalized percent.", + "name": "updated_at", + "type": "date", + "description": "The date when the data was last updated.", "default": null, "optional": true }, { - "name": "invested_capital_growth", - "type": "float", - "description": "Invested capital growth, as a normalized percent.", + "name": "period_ending", + "type": "date", + "description": "The fiscal period end date.", "default": null, "optional": true - }, + } + ] + }, + "model": "HistoricalEps" + }, + "/equity/fundamental/employee_count": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical employee count data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.employee_count(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "return_on_assets", - "type": "float", - "description": "Return on assets, as a normalized percent.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "return_on_equity", - "type": "float", - "description": "Return on equity, as a normalized percent.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ { - "name": "return_on_invested_capital", - "type": "float", - "description": "Return on invested capital, as a normalized percent.", - "default": null, - "optional": true + "name": "results", + "type": "List[HistoricalEmployees]", + "description": "Serializable results." }, { - "name": "ebitda", - "type": "int", - "description": "Earnings before interest, taxes, depreciation, and amortization.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "ebit", - "type": "int", - "description": "Earnings before interest and taxes.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "long_term_debt", - "type": "int", - "description": "Long-term debt.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "total_debt", - "type": "int", - "description": "Total debt.", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "total_capital", - "type": "int", - "description": "The sum of long-term debt and total shareholder equity.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "enterprise_value", + "name": "cik", "type": "int", - "description": "Enterprise value.", - "default": null, - "optional": true + "description": "Central Index Key (CIK) for the requested entity.", + "default": "", + "optional": false }, { - "name": "free_cash_flow_to_firm", - "type": "int", - "description": "Free cash flow to firm.", - "default": null, - "optional": true + "name": "acceptance_time", + "type": "datetime", + "description": "Time of acceptance of the company employee.", + "default": "", + "optional": false }, { - "name": "altman_z_score", - "type": "float", - "description": "Altman Z-score.", - "default": null, - "optional": true + "name": "period_of_report", + "type": "date", + "description": "Date of reporting of the company employee.", + "default": "", + "optional": false }, { - "name": "beta", - "type": "float", - "description": "Beta relative to the broad market (rolling three-year).", - "default": null, - "optional": true + "name": "company_name", + "type": "str", + "description": "Registered name of the company to retrieve the historical employees of.", + "default": "", + "optional": false }, { - "name": "dividend_yield", - "type": "float", - "description": "Dividend yield, as a normalized percent.", - "default": null, - "optional": true + "name": "form_type", + "type": "str", + "description": "Form type of the company employee.", + "default": "", + "optional": false }, { - "name": "earnings_yield", - "type": "float", - "description": "Earnings yield, as a normalized percent.", - "default": null, - "optional": true + "name": "filing_date", + "type": "date", + "description": "Filing date of the company employee", + "default": "", + "optional": false }, { - "name": "last_price", - "type": "float", - "description": "Last price of the stock.", - "default": null, - "optional": true + "name": "employee_count", + "type": "int", + "description": "Count of employees of the company.", + "default": "", + "optional": false }, { - "name": "year_high", - "type": "float", - "description": "52 week high", - "default": null, - "optional": true - }, + "name": "source", + "type": "str", + "description": "Source URL which retrieves this data for the company.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "HistoricalEmployees" + }, + "/equity/fundamental/search_attributes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search Intrinio data tags to search in latest or historical attributes.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.search_attributes(query='ebitda', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ { - "name": "year_low", - "type": "float", - "description": "52 week low", - "default": null, - "optional": true + "name": "query", + "type": "str", + "description": "Query to search for.", + "default": "", + "optional": false }, { - "name": "volume_avg", + "name": "limit", "type": "int", - "description": "Average daily volume.", - "default": null, + "description": "The number of data entries to return.", + "default": 1000, "optional": true }, { - "name": "short_interest", - "type": "int", - "description": "Number of shares reported as sold short.", - "default": null, + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", "optional": true - }, + } + ], + "intrinio": [] + }, + "returns": { + "OBBject": [ { - "name": "shares_outstanding", - "type": "int", - "description": "Weighted average shares outstanding (TTM).", - "default": null, - "optional": true + "name": "results", + "type": "List[SearchAttributes]", + "description": "Serializable results." }, { - "name": "days_to_cover", - "type": "float", - "description": "Days to cover short interest, based on average daily volume.", - "default": null, - "optional": true - } - ], - "yfinance": [ - { - "name": "forward_pe", - "type": "float", - "description": "Forward price-to-earnings ratio.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['intrinio']]", + "description": "Provider name." }, { - "name": "peg_ratio", - "type": "float", - "description": "PEG ratio (5-year expected).", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "peg_ratio_ttm", - "type": "float", - "description": "PEG ratio (TTM).", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "eps_ttm", - "type": "float", - "description": "Earnings per share (TTM).", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "eps_forward", - "type": "float", - "description": "Forward earnings per share.", - "default": null, - "optional": true + "name": "id", + "type": "str", + "description": "ID of the financial attribute.", + "default": "", + "optional": false }, { - "name": "enterprise_to_ebitda", - "type": "float", - "description": "Enterprise value to EBITDA ratio.", - "default": null, - "optional": true + "name": "name", + "type": "str", + "description": "Name of the financial attribute.", + "default": "", + "optional": false }, { - "name": "earnings_growth", - "type": "float", - "description": "Earnings growth (Year Over Year), as a normalized percent.", - "default": null, - "optional": true + "name": "tag", + "type": "str", + "description": "Tag of the financial attribute.", + "default": "", + "optional": false }, { - "name": "earnings_growth_quarterly", - "type": "float", - "description": "Quarterly earnings growth (Year Over Year), as a normalized percent.", - "default": null, - "optional": true + "name": "statement_code", + "type": "str", + "description": "Code of the financial statement.", + "default": "", + "optional": false }, { - "name": "revenue_per_share", - "type": "float", - "description": "Revenue per share (TTM).", + "name": "statement_type", + "type": "str", + "description": "Type of the financial statement.", "default": null, "optional": true }, { - "name": "revenue_growth", - "type": "float", - "description": "Revenue growth (Year Over Year), as a normalized percent.", + "name": "parent_name", + "type": "str", + "description": "Parent's name of the financial attribute.", "default": null, "optional": true }, { - "name": "enterprise_to_revenue", - "type": "float", - "description": "Enterprise value to revenue ratio.", + "name": "sequence", + "type": "int", + "description": "Sequence of the financial statement.", "default": null, "optional": true }, { - "name": "cash_per_share", - "type": "float", - "description": "Cash per share.", + "name": "factor", + "type": "str", + "description": "Unit of the financial attribute.", "default": null, "optional": true }, { - "name": "quick_ratio", - "type": "float", - "description": "Quick ratio.", + "name": "transaction", + "type": "str", + "description": "Transaction type (credit/debit) of the financial attribute.", "default": null, "optional": true }, { - "name": "current_ratio", - "type": "float", - "description": "Current ratio.", + "name": "type", + "type": "str", + "description": "Type of the financial attribute.", "default": null, "optional": true }, { - "name": "debt_to_equity", - "type": "float", - "description": "Debt-to-equity ratio.", + "name": "unit", + "type": "str", + "description": "Unit of the financial attribute.", "default": null, "optional": true - }, + } + ], + "intrinio": [] + }, + "model": "SearchAttributes" + }, + "/equity/fundamental/latest_attributes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the latest value of a data tag from Intrinio.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.latest_attributes(symbol='AAPL', tag='ceo', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ { - "name": "gross_margin", - "type": "float", - "description": "Gross margin, as a normalized percent.", - "default": null, - "optional": true + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", + "default": "", + "optional": false }, { - "name": "operating_margin", - "type": "float", - "description": "Operating margin, as a normalized percent.", - "default": null, - "optional": 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 }, { - "name": "ebitda_margin", - "type": "float", - "description": "EBITDA margin, as a normalized percent.", - "default": null, + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", "optional": true - }, + } + ], + "intrinio": [] + }, + "returns": { + "OBBject": [ { - "name": "profit_margin", - "type": "float", - "description": "Profit margin, as a normalized percent.", - "default": null, - "optional": true + "name": "results", + "type": "List[LatestAttributes]", + "description": "Serializable results." }, { - "name": "return_on_assets", - "type": "float", - "description": "Return on assets, as a normalized percent.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['intrinio']]", + "description": "Provider name." }, { - "name": "return_on_equity", - "type": "float", - "description": "Return on equity, as a normalized percent.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "dividend_yield", - "type": "float", - "description": "Dividend yield, as a normalized percent.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "dividend_yield_5y_avg", - "type": "float", - "description": "5-year average dividend yield, as a normalized percent.", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "payout_ratio", - "type": "float", - "description": "Payout ratio.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "book_value", - "type": "float", - "description": "Book value per share.", + "name": "tag", + "type": "str", + "description": "Tag name for the fetched data.", "default": null, "optional": true }, { - "name": "price_to_book", - "type": "float", - "description": "Price-to-book ratio.", + "name": "value", + "type": "Union[str, float]", + "description": "The value of the data.", "default": null, "optional": true - }, - { - "name": "enterprise_value", - "type": "int", - "description": "Enterprise value.", - "default": null, - "optional": true - }, + } + ], + "intrinio": [] + }, + "model": "LatestAttributes" + }, + "/equity/fundamental/historical_attributes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the historical values of a data tag from Intrinio.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_attributes(symbol='AAPL', tag='ebitda', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ { - "name": "overall_risk", - "type": "float", - "description": "Overall risk score.", - "default": null, - "optional": true + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", + "default": "", + "optional": false }, { - "name": "audit_risk", - "type": "float", - "description": "Audit risk score.", - "default": null, - "optional": 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 }, { - "name": "board_risk", - "type": "float", - "description": "Board risk score.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "compensation_risk", - "type": "float", - "description": "Compensation risk score.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "shareholder_rights_risk", - "type": "float", - "description": "Shareholder rights risk score.", - "default": null, + "name": "frequency", + "type": "Literal['daily', 'weekly', 'monthly', 'quarterly', 'yearly']", + "description": "The frequency of the data.", + "default": "yearly", "optional": true }, { - "name": "beta", - "type": "float", - "description": "Beta relative to the broad market (5-year monthly).", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 1000, "optional": true }, { - "name": "price_return_1y", - "type": "float", - "description": "One-year price return, as a normalized percent.", + "name": "tag_type", + "type": "str", + "description": "Filter by type, when applicable.", "default": null, "optional": true }, { - "name": "currency", - "type": "str", - "description": "Currency in which the data is presented.", - "default": null, + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order.", + "default": "desc", "optional": true - } - ] - }, - "model": "KeyMetrics" - }, - "/equity/fundamental/management": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get executive management team data for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.management(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { "name": "provider", - "type": "Literal['fmp', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", "optional": true } ], - "fmp": [], - "yfinance": [] + "intrinio": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[KeyExecutives]", + "type": "List[HistoricalAttributes]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'yfinance']]", + "type": "Optional[Literal['intrinio']]", "description": "Provider name." }, { @@ -14767,94 +15091,71 @@ "data": { "standard": [ { - "name": "title", - "type": "str", - "description": "Designation of the key executive.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "name", + "name": "symbol", "type": "str", - "description": "Name of the key executive.", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "pay", - "type": "int", - "description": "Pay of the key executive.", - "default": null, - "optional": true - }, - { - "name": "currency_pay", - "type": "str", - "description": "Currency of the pay.", - "default": null, - "optional": true - }, - { - "name": "gender", + "name": "tag", "type": "str", - "description": "Gender of the key executive.", - "default": null, - "optional": true - }, - { - "name": "year_born", - "type": "int", - "description": "Birth year of the key executive.", + "description": "Tag name for the fetched data.", "default": null, "optional": true }, { - "name": "title_since", - "type": "int", - "description": "Date the tile was held since.", + "name": "value", + "type": "float", + "description": "The value of the data.", "default": null, "optional": true } ], - "fmp": [], - "yfinance": [ - { - "name": "exercised_value", - "type": "int", - "description": "Value of shares exercised.", - "default": null, - "optional": true - }, - { - "name": "unexercised_value", - "type": "int", - "description": "Value of shares not exercised.", - "default": null, - "optional": true - } - ] + "intrinio": [] }, - "model": "KeyExecutives" + "model": "HistoricalAttributes" }, - "/equity/fundamental/management_compensation": { + "/equity/fundamental/income": { "deprecated": { "flag": null, "message": null }, - "description": "Get executive management team compensation for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.management_compensation(symbol='AAPL', provider='fmp')\n```\n\n", + "description": "Get 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": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "type": "str", + "description": "Symbol to get data for.", "default": "", "optional": false }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "limit", + "type": "Annotated[int, Ge(ge=0)]", + "description": "The number of data entries to return.", + "default": 5, + "optional": true + }, { "name": "provider", - "type": "Literal['fmp']", + "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 @@ -14862,192 +15163,149 @@ ], "fmp": [ { - "name": "year", + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true + } + ], + "intrinio": [ + { + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", + "description": "None", + "default": "annual", + "optional": true + }, + { + "name": "fiscal_year", "type": "int", - "description": "Year of the compensation.", + "description": "The specific fiscal year. Reports do not go beyond 2008.", "default": null, "optional": true } - ] - }, - "returns": { - "OBBject": [ + ], + "polygon": [ { - "name": "results", - "type": "List[ExecutiveCompensation]", - "description": "Serializable results." + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm']", + "description": "None", + "default": "annual", + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "filing_date", + "type": "date", + "description": "Filing date of the financial statement.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "filing_date_lt", + "type": "date", + "description": "Filing date less than the given date.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "cik", - "type": "str", - "description": "Central Index Key (CIK) for the requested entity.", + "name": "filing_date_lte", + "type": "date", + "description": "Filing date less than or equal to the given date.", "default": null, "optional": true }, { - "name": "company_name", - "type": "str", - "description": "The name of the company.", + "name": "filing_date_gt", + "type": "date", + "description": "Filing date greater than the given date.", "default": null, "optional": true }, { - "name": "industry", - "type": "str", - "description": "The industry of the company.", + "name": "filing_date_gte", + "type": "date", + "description": "Filing date greater than or equal to the given date.", "default": null, "optional": true }, { - "name": "year", - "type": "int", - "description": "Year of the compensation.", + "name": "period_of_report_date", + "type": "date", + "description": "Period of report date of the financial statement.", "default": null, "optional": true }, { - "name": "name_and_position", - "type": "str", - "description": "Name and position.", + "name": "period_of_report_date_lt", + "type": "date", + "description": "Period of report date less than the given date.", "default": null, "optional": true }, { - "name": "salary", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Salary.", + "name": "period_of_report_date_lte", + "type": "date", + "description": "Period of report date less than or equal to the given date.", "default": null, "optional": true }, { - "name": "bonus", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Bonus payments.", + "name": "period_of_report_date_gt", + "type": "date", + "description": "Period of report date greater than the given date.", "default": null, "optional": true }, { - "name": "stock_award", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Stock awards.", + "name": "period_of_report_date_gte", + "type": "date", + "description": "Period of report date greater than or equal to the given date.", "default": null, "optional": true }, { - "name": "incentive_plan_compensation", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Incentive plan compensation.", + "name": "include_sources", + "type": "bool", + "description": "Whether to include the sources of the financial statement.", "default": null, "optional": true }, { - "name": "all_other_compensation", - "type": "Annotated[float, Ge(ge=0)]", - "description": "All other compensation.", + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order of the financial statement.", "default": null, "optional": true }, { - "name": "total", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Total compensation.", + "name": "sort", + "type": "Literal['filing_date', 'period_of_report_date']", + "description": "Sort of the financial statement.", "default": null, "optional": true } ], - "fmp": [ - { - "name": "filing_date", - "type": "date", - "description": "Date of the filing.", - "default": null, - "optional": true - }, - { - "name": "accepted_date", - "type": "datetime", - "description": "Date the filing was accepted.", - "default": null, - "optional": true - }, + "yfinance": [ { - "name": "url", - "type": "str", - "description": "URL to the filing data.", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", "optional": true } ] }, - "model": "ExecutiveCompensation" - }, - "/equity/fundamental/overview": { - "deprecated": { - "flag": true, - "message": "This endpoint is deprecated; use `/equity/profile` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.3." - }, - "description": "Get company general business and stock data for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.overview(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [] - }, "returns": { "OBBject": [ { "name": "results", - "type": "List[CompanyOverview]", + "type": "List[IncomeStatement]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", "description": "Provider name." }, { @@ -15070,1411 +15328,1129 @@ "data": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", "default": "", "optional": false }, { - "name": "price", - "type": "float", - "description": "Price of the company.", - "default": null, - "optional": true - }, - { - "name": "beta", - "type": "float", - "description": "Beta of the company.", + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", "default": null, "optional": true }, { - "name": "vol_avg", + "name": "fiscal_year", "type": "int", - "description": "Volume average of the company.", + "description": "The fiscal year of the fiscal period.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "mkt_cap", - "type": "int", - "description": "Market capitalization of the company.", + "name": "filing_date", + "type": "date", + "description": "The date when the filing was made.", "default": null, "optional": true }, { - "name": "last_div", - "type": "float", - "description": "Last dividend of the company.", + "name": "accepted_date", + "type": "datetime", + "description": "The date and time when the filing was accepted.", "default": null, "optional": true }, { - "name": "range", + "name": "reported_currency", "type": "str", - "description": "Range of the company.", + "description": "The currency in which the balance sheet was reported.", "default": null, "optional": true }, { - "name": "changes", + "name": "revenue", "type": "float", - "description": "Changes of the company.", + "description": "Total revenue.", "default": null, "optional": true }, { - "name": "company_name", - "type": "str", - "description": "Company name of the company.", + "name": "cost_of_revenue", + "type": "float", + "description": "Cost of revenue.", "default": null, "optional": true }, { - "name": "currency", - "type": "str", - "description": "Currency of the company.", + "name": "gross_profit", + "type": "float", + "description": "Gross profit.", "default": null, "optional": true }, { - "name": "cik", - "type": "str", - "description": "Central Index Key (CIK) for the requested entity.", + "name": "gross_profit_margin", + "type": "float", + "description": "Gross profit margin.", "default": null, "optional": true }, { - "name": "isin", - "type": "str", - "description": "ISIN of the company.", + "name": "general_and_admin_expense", + "type": "float", + "description": "General and administrative expenses.", "default": null, "optional": true }, { - "name": "cusip", - "type": "str", - "description": "CUSIP of the company.", + "name": "research_and_development_expense", + "type": "float", + "description": "Research and development expenses.", "default": null, "optional": true }, { - "name": "exchange", - "type": "str", - "description": "Exchange of the company.", + "name": "selling_and_marketing_expense", + "type": "float", + "description": "Selling and marketing expenses.", "default": null, "optional": true }, { - "name": "exchange_short_name", - "type": "str", - "description": "Exchange short name of the company.", + "name": "selling_general_and_admin_expense", + "type": "float", + "description": "Selling, general and administrative expenses.", "default": null, "optional": true }, { - "name": "industry", - "type": "str", - "description": "Industry of the company.", + "name": "other_expenses", + "type": "float", + "description": "Other expenses.", "default": null, "optional": true }, { - "name": "website", - "type": "str", - "description": "Website of the company.", + "name": "total_operating_expenses", + "type": "float", + "description": "Total operating expenses.", "default": null, "optional": true }, { - "name": "description", - "type": "str", - "description": "Description of the company.", + "name": "cost_and_expenses", + "type": "float", + "description": "Cost and expenses.", "default": null, "optional": true }, { - "name": "ceo", - "type": "str", - "description": "CEO of the company.", + "name": "interest_income", + "type": "float", + "description": "Interest income.", "default": null, "optional": true }, { - "name": "sector", - "type": "str", - "description": "Sector of the company.", + "name": "total_interest_expense", + "type": "float", + "description": "Total interest expenses.", "default": null, "optional": true }, { - "name": "country", - "type": "str", - "description": "Country of the company.", + "name": "depreciation_and_amortization", + "type": "float", + "description": "Depreciation and amortization.", "default": null, "optional": true }, { - "name": "full_time_employees", - "type": "str", - "description": "Full time employees of the company.", + "name": "ebitda", + "type": "float", + "description": "EBITDA.", "default": null, "optional": true }, { - "name": "phone", - "type": "str", - "description": "Phone of the company.", + "name": "ebitda_margin", + "type": "float", + "description": "EBITDA margin.", "default": null, "optional": true }, { - "name": "address", - "type": "str", - "description": "Address of the company.", + "name": "total_operating_income", + "type": "float", + "description": "Total operating income.", "default": null, "optional": true }, { - "name": "city", - "type": "str", - "description": "City of the company.", + "name": "operating_income_margin", + "type": "float", + "description": "Operating income margin.", "default": null, "optional": true }, { - "name": "state", - "type": "str", - "description": "State of the company.", + "name": "total_other_income_expenses", + "type": "float", + "description": "Total other income and expenses.", "default": null, "optional": true }, { - "name": "zip", - "type": "str", - "description": "Zip of the company.", + "name": "total_pre_tax_income", + "type": "float", + "description": "Total pre-tax income.", "default": null, "optional": true }, { - "name": "dcf_diff", + "name": "pre_tax_income_margin", "type": "float", - "description": "Discounted cash flow difference of the company.", + "description": "Pre-tax income margin.", "default": null, "optional": true }, { - "name": "dcf", + "name": "income_tax_expense", "type": "float", - "description": "Discounted cash flow of the company.", + "description": "Income tax expense.", "default": null, "optional": true }, { - "name": "image", - "type": "str", - "description": "Image of the company.", + "name": "consolidated_net_income", + "type": "float", + "description": "Consolidated net income.", "default": null, "optional": true }, { - "name": "ipo_date", - "type": "date", - "description": "IPO date of the company.", + "name": "net_income_margin", + "type": "float", + "description": "Net income margin.", "default": null, "optional": true }, { - "name": "default_image", - "type": "bool", - "description": "If the image is the default image.", - "default": "", - "optional": false - }, - { - "name": "is_etf", - "type": "bool", - "description": "If the company is an ETF.", - "default": "", - "optional": false - }, - { - "name": "is_actively_trading", - "type": "bool", - "description": "If the company is actively trading.", - "default": "", - "optional": false - }, - { - "name": "is_adr", - "type": "bool", - "description": "If the company is an ADR.", - "default": "", - "optional": false - }, - { - "name": "is_fund", - "type": "bool", - "description": "If the company is a fund.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "CompanyOverview" - }, - "/equity/fundamental/ratios": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get an extensive set of financial and accounting ratios for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.ratios(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.ratios(symbol='AAPL', period='annual', limit=12, provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "period", - "type": "str", - "description": "Time period of the data to return.", - "default": "annual", + "name": "basic_earnings_per_share", + "type": "float", + "description": "Basic earnings per share.", + "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 12, + "name": "diluted_earnings_per_share", + "type": "float", + "description": "Diluted earnings per share.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "period", - "type": "Literal['annual', 'quarter', 'ttm']", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - } - ], - "intrinio": [ - { - "name": "period", - "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", - "description": "Time period of the data to return.", - "default": "annual", + "name": "weighted_average_basic_shares_outstanding", + "type": "float", + "description": "Weighted average basic shares outstanding.", + "default": null, "optional": true }, { - "name": "fiscal_year", - "type": "int", - "description": "The specific fiscal year. Reports do not go beyond 2008.", + "name": "weighted_average_diluted_shares_outstanding", + "type": "float", + "description": "Weighted average diluted shares outstanding.", "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[FinancialRatios]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "period_ending", + "name": "link", "type": "str", - "description": "The date of the data.", - "default": "", - "optional": false + "description": "Link to the filing.", + "default": null, + "optional": true }, { - "name": "fiscal_period", + "name": "final_link", "type": "str", - "description": "Period of the financial ratios.", - "default": "", - "optional": false - }, - { - "name": "fiscal_year", - "type": "int", - "description": "Fiscal year.", + "description": "Link to the filing document.", "default": null, "optional": true } ], - "fmp": [ + "intrinio": [ { - "name": "current_ratio", - "type": "float", - "description": "Current ratio.", + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet is reported.", "default": null, "optional": true }, { - "name": "quick_ratio", + "name": "revenue", "type": "float", - "description": "Quick ratio.", + "description": "Total revenue", "default": null, "optional": true }, { - "name": "cash_ratio", + "name": "operating_revenue", "type": "float", - "description": "Cash ratio.", + "description": "Total operating revenue", "default": null, "optional": true }, { - "name": "days_of_sales_outstanding", + "name": "cost_of_revenue", "type": "float", - "description": "Days of sales outstanding.", + "description": "Total cost of revenue", "default": null, "optional": true }, { - "name": "days_of_inventory_outstanding", + "name": "operating_cost_of_revenue", "type": "float", - "description": "Days of inventory outstanding.", + "description": "Total operating cost of revenue", "default": null, "optional": true }, { - "name": "operating_cycle", + "name": "gross_profit", "type": "float", - "description": "Operating cycle.", + "description": "Total gross profit", "default": null, "optional": true }, { - "name": "days_of_payables_outstanding", + "name": "gross_profit_margin", "type": "float", - "description": "Days of payables outstanding.", + "description": "Gross margin ratio.", "default": null, "optional": true }, { - "name": "cash_conversion_cycle", + "name": "provision_for_credit_losses", "type": "float", - "description": "Cash conversion cycle.", + "description": "Provision for credit losses", "default": null, "optional": true }, { - "name": "gross_profit_margin", + "name": "research_and_development_expense", "type": "float", - "description": "Gross profit margin.", + "description": "Research and development expense", "default": null, "optional": true }, { - "name": "operating_profit_margin", + "name": "selling_general_and_admin_expense", "type": "float", - "description": "Operating profit margin.", + "description": "Selling, general, and admin expense", "default": null, "optional": true }, { - "name": "pretax_profit_margin", + "name": "salaries_and_employee_benefits", "type": "float", - "description": "Pretax profit margin.", + "description": "Salaries and employee benefits", "default": null, "optional": true }, { - "name": "net_profit_margin", + "name": "marketing_expense", "type": "float", - "description": "Net profit margin.", + "description": "Marketing expense", "default": null, "optional": true }, { - "name": "effective_tax_rate", + "name": "net_occupancy_and_equipment_expense", "type": "float", - "description": "Effective tax rate.", + "description": "Net occupancy and equipment expense", "default": null, "optional": true }, { - "name": "return_on_assets", + "name": "other_operating_expenses", "type": "float", - "description": "Return on assets.", + "description": "Other operating expenses", "default": null, "optional": true }, { - "name": "return_on_equity", + "name": "depreciation_expense", "type": "float", - "description": "Return on equity.", + "description": "Depreciation expense", "default": null, "optional": true }, { - "name": "return_on_capital_employed", + "name": "amortization_expense", "type": "float", - "description": "Return on capital employed.", + "description": "Amortization expense", "default": null, "optional": true }, { - "name": "net_income_per_ebt", + "name": "amortization_of_deferred_policy_acquisition_costs", "type": "float", - "description": "Net income per EBT.", + "description": "Amortization of deferred policy acquisition costs", "default": null, "optional": true }, { - "name": "ebt_per_ebit", + "name": "exploration_expense", "type": "float", - "description": "EBT per EBIT.", + "description": "Exploration expense", "default": null, "optional": true }, { - "name": "ebit_per_revenue", + "name": "depletion_expense", "type": "float", - "description": "EBIT per revenue.", + "description": "Depletion expense", "default": null, "optional": true }, { - "name": "debt_ratio", + "name": "total_operating_expenses", "type": "float", - "description": "Debt ratio.", + "description": "Total operating expenses", "default": null, "optional": true }, { - "name": "debt_equity_ratio", + "name": "total_operating_income", "type": "float", - "description": "Debt equity ratio.", + "description": "Total operating income", "default": null, "optional": true }, { - "name": "long_term_debt_to_capitalization", + "name": "deposits_and_money_market_investments_interest_income", "type": "float", - "description": "Long term debt to capitalization.", + "description": "Deposits and money market investments interest income", "default": null, "optional": true }, { - "name": "total_debt_to_capitalization", + "name": "federal_funds_sold_and_securities_borrowed_interest_income", "type": "float", - "description": "Total debt to capitalization.", + "description": "Federal funds sold and securities borrowed interest income", "default": null, "optional": true }, { - "name": "interest_coverage", + "name": "investment_securities_interest_income", "type": "float", - "description": "Interest coverage.", + "description": "Investment securities interest income", "default": null, "optional": true }, { - "name": "cash_flow_to_debt_ratio", + "name": "loans_and_leases_interest_income", "type": "float", - "description": "Cash flow to debt ratio.", + "description": "Loans and leases interest income", "default": null, "optional": true }, { - "name": "company_equity_multiplier", + "name": "trading_account_interest_income", "type": "float", - "description": "Company equity multiplier.", + "description": "Trading account interest income", "default": null, "optional": true }, { - "name": "receivables_turnover", + "name": "other_interest_income", "type": "float", - "description": "Receivables turnover.", + "description": "Other interest income", "default": null, "optional": true }, { - "name": "payables_turnover", + "name": "total_non_interest_income", "type": "float", - "description": "Payables turnover.", + "description": "Total non-interest income", "default": null, "optional": true }, { - "name": "inventory_turnover", + "name": "interest_and_investment_income", "type": "float", - "description": "Inventory turnover.", + "description": "Interest and investment income", "default": null, "optional": true }, { - "name": "fixed_asset_turnover", + "name": "short_term_borrowings_interest_expense", "type": "float", - "description": "Fixed asset turnover.", + "description": "Short-term borrowings interest expense", "default": null, "optional": true }, { - "name": "asset_turnover", + "name": "long_term_debt_interest_expense", "type": "float", - "description": "Asset turnover.", + "description": "Long-term debt interest expense", "default": null, "optional": true }, { - "name": "operating_cash_flow_per_share", + "name": "capitalized_lease_obligations_interest_expense", "type": "float", - "description": "Operating cash flow per share.", + "description": "Capitalized lease obligations interest expense", "default": null, "optional": true }, { - "name": "free_cash_flow_per_share", + "name": "deposits_interest_expense", "type": "float", - "description": "Free cash flow per share.", + "description": "Deposits interest expense", "default": null, "optional": true }, { - "name": "cash_per_share", + "name": "federal_funds_purchased_and_securities_sold_interest_expense", "type": "float", - "description": "Cash per share.", + "description": "Federal funds purchased and securities sold interest expense", "default": null, "optional": true }, { - "name": "payout_ratio", + "name": "other_interest_expense", "type": "float", - "description": "Payout ratio.", + "description": "Other interest expense", "default": null, "optional": true }, { - "name": "operating_cash_flow_sales_ratio", + "name": "total_interest_expense", "type": "float", - "description": "Operating cash flow sales ratio.", + "description": "Total interest expense", "default": null, "optional": true }, { - "name": "free_cash_flow_operating_cash_flow_ratio", + "name": "net_interest_income", "type": "float", - "description": "Free cash flow operating cash flow ratio.", + "description": "Net interest income", "default": null, "optional": true }, { - "name": "cash_flow_coverage_ratios", + "name": "other_non_interest_income", "type": "float", - "description": "Cash flow coverage ratios.", + "description": "Other non-interest income", "default": null, "optional": true }, { - "name": "short_term_coverage_ratios", + "name": "investment_banking_income", "type": "float", - "description": "Short term coverage ratios.", + "description": "Investment banking income", "default": null, "optional": true }, { - "name": "capital_expenditure_coverage_ratio", + "name": "trust_fees_by_commissions", "type": "float", - "description": "Capital expenditure coverage ratio.", + "description": "Trust fees by commissions", "default": null, "optional": true }, { - "name": "dividend_paid_and_capex_coverage_ratio", + "name": "premiums_earned", "type": "float", - "description": "Dividend paid and capex coverage ratio.", + "description": "Premiums earned", "default": null, "optional": true }, { - "name": "dividend_payout_ratio", + "name": "insurance_policy_acquisition_costs", "type": "float", - "description": "Dividend payout ratio.", + "description": "Insurance policy acquisition costs", "default": null, "optional": true }, { - "name": "price_book_value_ratio", + "name": "current_and_future_benefits", "type": "float", - "description": "Price book value ratio.", + "description": "Current and future benefits", "default": null, "optional": true }, { - "name": "price_to_book_ratio", + "name": "property_and_liability_insurance_claims", "type": "float", - "description": "Price to book ratio.", + "description": "Property and liability insurance claims", "default": null, "optional": true }, { - "name": "price_to_sales_ratio", + "name": "total_non_interest_expense", "type": "float", - "description": "Price to sales ratio.", + "description": "Total non-interest expense", "default": null, "optional": true }, { - "name": "price_earnings_ratio", + "name": "net_realized_and_unrealized_capital_gains_on_investments", "type": "float", - "description": "Price earnings ratio.", + "description": "Net realized and unrealized capital gains on investments", "default": null, "optional": true }, { - "name": "price_to_free_cash_flows_ratio", + "name": "other_gains", "type": "float", - "description": "Price to free cash flows ratio.", + "description": "Other gains", "default": null, "optional": true }, { - "name": "price_to_operating_cash_flows_ratio", + "name": "non_operating_income", "type": "float", - "description": "Price to operating cash flows ratio.", + "description": "Non-operating income", "default": null, "optional": true }, { - "name": "price_cash_flow_ratio", + "name": "other_income", "type": "float", - "description": "Price cash flow ratio.", + "description": "Other income", "default": null, "optional": true }, { - "name": "price_earnings_to_growth_ratio", + "name": "other_revenue", "type": "float", - "description": "Price earnings to growth ratio.", + "description": "Other revenue", "default": null, "optional": true }, { - "name": "price_sales_ratio", + "name": "extraordinary_income", "type": "float", - "description": "Price sales ratio.", + "description": "Extraordinary income", "default": null, "optional": true }, { - "name": "dividend_yield", + "name": "total_other_income", "type": "float", - "description": "Dividend yield.", + "description": "Total other income", "default": null, "optional": true }, { - "name": "dividend_yield_percentage", + "name": "ebitda", "type": "float", - "description": "Dividend yield percentage.", + "description": "Earnings Before Interest, Taxes, Depreciation and Amortization.", "default": null, "optional": true }, { - "name": "dividend_per_share", + "name": "ebitda_margin", "type": "float", - "description": "Dividend per share.", + "description": "Margin on Earnings Before Interest, Taxes, Depreciation and Amortization.", "default": null, "optional": true }, { - "name": "enterprise_value_multiple", + "name": "total_pre_tax_income", "type": "float", - "description": "Enterprise value multiple.", + "description": "Total pre-tax income", "default": null, "optional": true }, { - "name": "price_fair_value", + "name": "ebit", "type": "float", - "description": "Price fair value.", + "description": "Earnings Before Interest and Taxes.", "default": null, "optional": true - } - ], - "intrinio": [] - }, - "model": "FinancialRatios" - }, - "/equity/fundamental/revenue_per_geography": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the revenue geographic breakdown for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.revenue_per_geography(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.revenue_per_geography(symbol='AAPL', period='annual', structure='flat', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "period", - "type": "Literal['quarter', 'annual']", - "description": "Time period of the data to return.", - "default": "annual", + "name": "pre_tax_income_margin", + "type": "float", + "description": "Pre-Tax Income Margin.", + "default": null, "optional": true }, { - "name": "structure", - "type": "Literal['hierarchical', 'flat']", - "description": "Structure of the returned data.", - "default": "flat", + "name": "income_tax_expense", + "type": "float", + "description": "Income tax expense", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "impairment_charge", + "type": "float", + "description": "Impairment charge", + "default": null, "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[RevenueGeographic]", - "description": "Serializable results." + "name": "restructuring_charge", + "type": "float", + "description": "Restructuring charge", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "period_ending", - "type": "date", - "description": "The end date of the reporting period.", - "default": "", - "optional": false + "name": "service_charges_on_deposit_accounts", + "type": "float", + "description": "Service charges on deposit accounts", + "default": null, + "optional": true }, { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the reporting period.", + "name": "other_service_charges", + "type": "float", + "description": "Other service charges", "default": null, "optional": true }, { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the reporting period.", + "name": "other_special_charges", + "type": "float", + "description": "Other special charges", "default": null, "optional": true }, { - "name": "filing_date", - "type": "date", - "description": "The filing date of the report.", + "name": "other_cost_of_revenue", + "type": "float", + "description": "Other cost of revenue", "default": null, "optional": true }, { - "name": "geographic_segment", - "type": "int", - "description": "Dictionary of the revenue by geographic segment.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "RevenueGeographic" - }, - "/equity/fundamental/revenue_per_segment": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the revenue breakdown by business segment for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.revenue_per_segment(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.revenue_per_segment(symbol='AAPL', period='annual', structure='flat', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false + "name": "net_income_continuing_operations", + "type": "float", + "description": "Net income (continuing operations)", + "default": null, + "optional": true }, { - "name": "period", - "type": "Literal['quarter', 'annual']", - "description": "Time period of the data to return.", - "default": "annual", + "name": "net_income_discontinued_operations", + "type": "float", + "description": "Net income (discontinued operations)", + "default": null, "optional": true }, { - "name": "structure", - "type": "Literal['hierarchical', 'flat']", - "description": "Structure of the returned data.", - "default": "flat", + "name": "consolidated_net_income", + "type": "float", + "description": "Consolidated net income", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "other_adjustments_to_consolidated_net_income", + "type": "float", + "description": "Other adjustments to consolidated net income", + "default": null, "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[RevenueBusinessLine]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "other_adjustment_to_net_income_attributable_to_common_shareholders", + "type": "float", + "description": "Other adjustment to net income attributable to common shareholders", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "net_income_attributable_to_noncontrolling_interest", + "type": "float", + "description": "Net income attributable to noncontrolling interest", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "net_income_attributable_to_common_shareholders", + "type": "float", + "description": "Net income attributable to common shareholders", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "period_ending", - "type": "date", - "description": "The end date of the reporting period.", - "default": "", - "optional": false + "name": "basic_earnings_per_share", + "type": "float", + "description": "Basic earnings per share", + "default": null, + "optional": true }, { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the reporting period.", + "name": "diluted_earnings_per_share", + "type": "float", + "description": "Diluted earnings per share", "default": null, "optional": true }, { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the reporting period.", + "name": "basic_and_diluted_earnings_per_share", + "type": "float", + "description": "Basic and diluted earnings per share", "default": null, "optional": true }, { - "name": "filing_date", - "type": "date", - "description": "The filing date of the report.", + "name": "cash_dividends_to_common_per_share", + "type": "float", + "description": "Cash dividends to common per share", "default": null, "optional": true }, { - "name": "business_line", - "type": "int", - "description": "Dictionary containing the revenue of the business line.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "RevenueBusinessLine" - }, - "/equity/fundamental/filings": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more. SEC\nfilings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114,\nForeign Investment Disclosures and others. The annual 10-K report is required to be\nfiled annually and includes the company's financial statements, management discussion and analysis,\nand audited financial statements.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.filings(provider='fmp')\nobb.equity.fundamental.filings(limit=100, provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "name": "preferred_stock_dividends_declared", + "type": "float", + "description": "Preferred stock dividends declared", "default": null, "optional": true }, { - "name": "form_type", - "type": "str", - "description": "Filter by form type. Check the data provider for available types.", + "name": "weighted_average_basic_shares_outstanding", + "type": "float", + "description": "Weighted average basic shares outstanding", "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 100, + "name": "weighted_average_diluted_shares_outstanding", + "type": "float", + "description": "Weighted average diluted shares outstanding", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "weighted_average_basic_and_diluted_shares_outstanding", + "type": "float", + "description": "Weighted average basic and diluted shares outstanding", + "default": null, "optional": true } ], - "fmp": [], - "intrinio": [ + "polygon": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "revenue", + "type": "float", + "description": "Total Revenue", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "cost_of_revenue_goods", + "type": "float", + "description": "Cost of Revenue - Goods", "default": null, "optional": true }, { - "name": "thea_enabled", - "type": "bool", - "description": "Return filings that have been read by Intrinio's Thea NLP.", + "name": "cost_of_revenue_services", + "type": "float", + "description": "Cost of Revenue - Services", "default": null, "optional": true - } - ], - "sec": [ + }, { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "name": "cost_of_revenue", + "type": "float", + "description": "Cost of Revenue", "default": null, "optional": true }, { - "name": "form_type", - "type": "Literal['1', '1-A', '1-A POS', '1-A-W', '1-E', '1-E AD', '1-K', '1-SA', '1-U', '1-Z', '1-Z-W', '10-12B', '10-12G', '10-D', '10-K', '10-KT', '10-Q', '10-QT', '11-K', '11-KT', '13F-HR', '13F-NT', '13FCONP', '144', '15-12B', '15-12G', '15-15D', '15F-12B', '15F-12G', '15F-15D', '18-12B', '18-K', '19B-4E', '2-A', '2-AF', '2-E', '20-F', '20FR12B', '20FR12G', '24F-2NT', '25', '25-NSE', '253G1', '253G2', '253G3', '253G4', '3', '305B2', '34-12H', '4', '40-17F1', '40-17F2', '40-17G', '40-17GCS', '40-202A', '40-203A', '40-206A', '40-24B2', '40-33', '40-6B', '40-8B25', '40-8F-2', '40-APP', '40-F', '40-OIP', '40FR12B', '40FR12G', '424A', '424B1', '424B2', '424B3', '424B4', '424B5', '424B7', '424B8', '424H', '425', '485APOS', '485BPOS', '485BXT', '486APOS', '486BPOS', '486BXT', '487', '497', '497AD', '497H2', '497J', '497K', '497VPI', '497VPU', '5', '6-K', '6B NTC', '6B ORDR', '8-A12B', '8-A12G', '8-K', '8-K12B', '8-K12G3', '8-K15D5', '8-M', '8F-2 NTC', '8F-2 ORDR', '9-M', 'ABS-15G', 'ABS-EE', 'ADN-MTL', 'ADV-E', 'ADV-H-C', 'ADV-H-T', 'ADV-NR', 'ANNLRPT', 'APP NTC', 'APP ORDR', 'APP WD', 'APP WDG', 'ARS', 'ATS-N', 'ATS-N-C', 'ATS-N/UA', 'AW', 'AW WD', 'C', 'C-AR', 'C-AR-W', 'C-TR', 'C-TR-W', 'C-U', 'C-U-W', 'C-W', 'CB', 'CERT', 'CERTARCA', 'CERTBATS', 'CERTCBO', 'CERTNAS', 'CERTNYS', 'CERTPAC', 'CFPORTAL', 'CFPORTAL-W', 'CORRESP', 'CT ORDER', 'D', 'DEF 14A', 'DEF 14C', 'DEFA14A', 'DEFA14C', 'DEFC14A', 'DEFC14C', 'DEFM14A', 'DEFM14C', 'DEFN14A', 'DEFR14A', 'DEFR14C', 'DEL AM', 'DFAN14A', 'DFRN14A', 'DOS', 'DOSLTR', 'DRS', 'DRSLTR', 'DSTRBRPT', 'EFFECT', 'F-1', 'F-10', 'F-10EF', 'F-10POS', 'F-1MEF', 'F-3', 'F-3ASR', 'F-3D', 'F-3DPOS', 'F-3MEF', 'F-4', 'F-4 POS', 'F-4MEF', 'F-6', 'F-6 POS', 'F-6EF', 'F-7', 'F-7 POS', 'F-8', 'F-8 POS', 'F-80', 'F-80POS', 'F-9', 'F-9 POS', 'F-N', 'F-X', 'FOCUSN', 'FWP', 'G-405', 'G-405N', 'G-FIN', 'G-FINW', 'IRANNOTICE', 'MA', 'MA-A', 'MA-I', 'MA-W', 'MSD', 'MSDCO', 'MSDW', 'N-1', 'N-14', 'N-14 8C', 'N-14MEF', 'N-18F1', 'N-1A', 'N-2', 'N-2 POSASR', 'N-23C-2', 'N-23C3A', 'N-23C3B', 'N-23C3C', 'N-2ASR', 'N-2MEF', 'N-30B-2', 'N-30D', 'N-4', 'N-5', 'N-54A', 'N-54C', 'N-6', 'N-6F', 'N-8A', 'N-8B-2', 'N-8F', 'N-8F NTC', 'N-8F ORDR', 'N-CEN', 'N-CR', 'N-CSR', 'N-CSRS', 'N-MFP', 'N-MFP1', 'N-MFP2', 'N-PX', 'N-Q', 'N-VP', 'N-VPFS', 'NO ACT', 'NPORT-EX', 'NPORT-NP', 'NPORT-P', 'NRSRO-CE', 'NRSRO-UPD', 'NSAR-A', 'NSAR-AT', 'NSAR-B', 'NSAR-BT', 'NSAR-U', 'NT 10-D', 'NT 10-K', 'NT 10-Q', 'NT 11-K', 'NT 20-F', 'NT N-CEN', 'NT N-MFP', 'NT N-MFP1', 'NT N-MFP2', 'NT NPORT-EX', 'NT NPORT-P', 'NT-NCEN', 'NT-NCSR', 'NT-NSAR', 'NTFNCEN', 'NTFNCSR', 'NTFNSAR', 'NTN 10D', 'NTN 10K', 'NTN 10Q', 'NTN 20F', 'OIP NTC', 'OIP ORDR', 'POS 8C', 'POS AM', 'POS AMI', 'POS EX', 'POS462B', 'POS462C', 'POSASR', 'PRE 14A', 'PRE 14C', 'PREC14A', 'PREC14C', 'PREM14A', 'PREM14C', 'PREN14A', 'PRER14A', 'PRER14C', 'PRRN14A', 'PX14A6G', 'PX14A6N', 'QRTLYRPT', 'QUALIF', 'REG-NR', 'REVOKED', 'RW', 'RW WD', 'S-1', 'S-11', 'S-11MEF', 'S-1MEF', 'S-20', 'S-3', 'S-3ASR', 'S-3D', 'S-3DPOS', 'S-3MEF', 'S-4', 'S-4 POS', 'S-4EF', 'S-4MEF', 'S-6', 'S-8', 'S-8 POS', 'S-B', 'S-BMEF', 'SBSE', 'SBSE-A', 'SBSE-BD', 'SBSE-C', 'SBSE-W', 'SC 13D', 'SC 13E1', 'SC 13E3', 'SC 13G', 'SC 14D9', 'SC 14F1', 'SC 14N', 'SC TO-C', 'SC TO-I', 'SC TO-T', 'SC13E4F', 'SC14D1F', 'SC14D9C', 'SC14D9F', 'SD', 'SDR', 'SE', 'SEC ACTION', 'SEC STAFF ACTION', 'SEC STAFF LETTER', 'SF-1', 'SF-3', 'SL', 'SP 15D2', 'STOP ORDER', 'SUPPL', 'T-3', 'TA-1', 'TA-2', 'TA-W', 'TACO', 'TH', 'TTW', 'UNDER', 'UPLOAD', 'WDL-REQ', 'X-17A-5']", - "description": "Type of the SEC filing form.", + "name": "gross_profit", + "type": "float", + "description": "Gross Profit", "default": null, "optional": true }, { - "name": "cik", - "type": "Union[int, str]", - "description": "Lookup filings by Central Index Key (CIK) instead of by symbol.", + "name": "provisions_for_loan_lease_and_other_losses", + "type": "float", + "description": "Provisions for loan lease and other losses", "default": null, "optional": true }, { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache. If True, cache will store for one day.", - "default": true, + "name": "depreciation_and_amortization", + "type": "float", + "description": "Depreciation and Amortization", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[CompanyFilings]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'sec']]", - "description": "Provider name." + "name": "income_tax_expense_benefit_current", + "type": "float", + "description": "Income tax expense benefit current", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "deferred_tax_benefit", + "type": "float", + "description": "Deferred tax benefit", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "benefits_costs_expenses", + "type": "float", + "description": "Benefits, costs and expenses", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "selling_general_and_administrative_expense", + "type": "float", + "description": "Selling, general and administrative expense", + "default": null, + "optional": true + }, { - "name": "filing_date", - "type": "date", - "description": "The date of the filing.", - "default": "", - "optional": false + "name": "research_and_development", + "type": "float", + "description": "Research and development", + "default": null, + "optional": true }, { - "name": "accepted_date", - "type": "datetime", - "description": "Accepted date of the filing.", + "name": "costs_and_expenses", + "type": "float", + "description": "Costs and expenses", "default": null, "optional": true }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "other_operating_expenses", + "type": "float", + "description": "Other Operating Expenses", "default": null, "optional": true }, { - "name": "cik", - "type": "str", - "description": "Central Index Key (CIK) for the requested entity.", + "name": "operating_expenses", + "type": "float", + "description": "Operating expenses", "default": null, "optional": true }, { - "name": "report_type", - "type": "str", - "description": "Type of filing.", + "name": "operating_income", + "type": "float", + "description": "Operating Income/Loss", "default": null, "optional": true }, { - "name": "filing_url", - "type": "str", - "description": "URL to the filing page.", + "name": "non_operating_income", + "type": "float", + "description": "Non Operating Income/Loss", "default": null, "optional": true }, { - "name": "report_url", - "type": "str", - "description": "URL to the actual report.", - "default": "", - "optional": false - } - ], - "fmp": [], - "intrinio": [ + "name": "interest_and_dividend_income", + "type": "float", + "description": "Interest and Dividend Income", + "default": null, + "optional": true + }, { - "name": "id", - "type": "str", - "description": "Intrinio ID of the filing.", - "default": "", - "optional": false + "name": "total_interest_expense", + "type": "float", + "description": "Interest Expense", + "default": null, + "optional": true }, { - "name": "period_end_date", - "type": "date", - "description": "Ending date of the fiscal period for the filing.", + "name": "interest_and_debt_expense", + "type": "float", + "description": "Interest and Debt Expense", "default": null, "optional": true }, { - "name": "sec_unique_id", - "type": "str", - "description": "SEC unique ID of the filing.", - "default": "", - "optional": false + "name": "net_interest_income", + "type": "float", + "description": "Interest Income Net", + "default": null, + "optional": true }, { - "name": "instance_url", - "type": "str", - "description": "URL for the XBRL filing for the report.", + "name": "interest_income_after_provision_for_losses", + "type": "float", + "description": "Interest Income After Provision for Losses", "default": null, "optional": true }, { - "name": "industry_group", - "type": "str", - "description": "Industry group of the company.", - "default": "", - "optional": false + "name": "non_interest_expense", + "type": "float", + "description": "Non-Interest Expense", + "default": null, + "optional": true }, { - "name": "industry_category", - "type": "str", - "description": "Industry category of the company.", - "default": "", - "optional": false - } - ], - "sec": [ + "name": "non_interest_income", + "type": "float", + "description": "Non-Interest Income", + "default": null, + "optional": true + }, { - "name": "report_date", - "type": "date", - "description": "The date of the filing.", + "name": "income_from_discontinued_operations_net_of_tax_on_disposal", + "type": "float", + "description": "Income From Discontinued Operations Net of Tax on Disposal", "default": null, "optional": true }, { - "name": "act", - "type": "Union[int, str]", - "description": "The SEC Act number.", + "name": "income_from_discontinued_operations_net_of_tax", + "type": "float", + "description": "Income From Discontinued Operations Net of Tax", "default": null, "optional": true }, { - "name": "items", - "type": "Union[str, float]", - "description": "The SEC Item numbers.", + "name": "income_before_equity_method_investments", + "type": "float", + "description": "Income Before Equity Method Investments", "default": null, "optional": true }, { - "name": "primary_doc_description", - "type": "str", - "description": "The description of the primary document.", + "name": "income_from_equity_method_investments", + "type": "float", + "description": "Income From Equity Method Investments", "default": null, "optional": true }, { - "name": "primary_doc", - "type": "str", - "description": "The filename of the primary document.", + "name": "total_pre_tax_income", + "type": "float", + "description": "Income Before Tax", "default": null, "optional": true }, { - "name": "accession_number", - "type": "Union[int, str]", - "description": "The accession number.", + "name": "income_tax_expense", + "type": "float", + "description": "Income Tax Expense", "default": null, "optional": true }, { - "name": "file_number", - "type": "Union[int, str]", - "description": "The file number.", + "name": "income_after_tax", + "type": "float", + "description": "Income After Tax", "default": null, "optional": true }, { - "name": "film_number", - "type": "Union[int, str]", - "description": "The film number.", + "name": "consolidated_net_income", + "type": "float", + "description": "Net Income/Loss", "default": null, "optional": true }, { - "name": "is_inline_xbrl", - "type": "Union[int, str]", - "description": "Whether the filing is an inline XBRL filing.", + "name": "net_income_attributable_noncontrolling_interest", + "type": "float", + "description": "Net income (loss) attributable to noncontrolling interest", "default": null, "optional": true }, { - "name": "is_xbrl", - "type": "Union[int, str]", - "description": "Whether the filing is an XBRL filing.", + "name": "net_income_attributable_to_parent", + "type": "float", + "description": "Net income (loss) attributable to parent", "default": null, "optional": true }, { - "name": "size", - "type": "Union[int, str]", - "description": "The size of the filing.", + "name": "net_income_attributable_to_common_shareholders", + "type": "float", + "description": "Net Income/Loss Available To Common Stockholders Basic", "default": null, "optional": true }, { - "name": "complete_submission_url", - "type": "str", - "description": "The URL to the complete filing submission.", + "name": "participating_securities_earnings", + "type": "float", + "description": "Participating Securities Distributed And Undistributed Earnings Loss Basic", "default": null, "optional": true }, { - "name": "filing_detail_url", - "type": "str", - "description": "The URL to the filing details.", + "name": "undistributed_earnings_allocated_to_participating_securities", + "type": "float", + "description": "Undistributed Earnings Allocated To Participating Securities", "default": null, "optional": true - } - ] - }, - "model": "CompanyFilings" - }, - "/equity/fundamental/historical_splits": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get historical stock splits for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_splits(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "common_stock_dividends", + "type": "float", + "description": "Common Stock Dividends", + "default": null, "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[HistoricalSplits]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "preferred_stock_dividends_and_other_adjustments", + "type": "float", + "description": "Preferred stock dividends and other adjustments", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "basic_earnings_per_share", + "type": "float", + "description": "Earnings Per Share", + "default": null, + "optional": true }, { - "name": "numerator", + "name": "diluted_earnings_per_share", "type": "float", - "description": "Numerator of the split.", + "description": "Diluted Earnings Per Share", "default": null, "optional": true }, { - "name": "denominator", + "name": "weighted_average_basic_shares_outstanding", "type": "float", - "description": "Denominator of the split.", + "description": "Basic Average Shares", "default": null, "optional": true }, { - "name": "split_ratio", - "type": "str", - "description": "Split ratio.", + "name": "weighted_average_diluted_shares_outstanding", + "type": "float", + "description": "Diluted Average Shares", "default": null, "optional": true } ], - "fmp": [] + "yfinance": [] }, - "model": "HistoricalSplits" + "model": "IncomeStatement" }, - "/equity/fundamental/transcript": { + "/equity/fundamental/income_growth": { "deprecated": { "flag": null, "message": null }, - "description": "Get earnings call transcripts for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.transcript(symbol='AAPL', year=2020, provider='fmp')\n```\n\n", + "description": "Get 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": [ { @@ -16485,11 +16461,18 @@ "optional": false }, { - "name": "year", + "name": "limit", "type": "int", - "description": "Year of the earnings call transcript.", - "default": "", - "optional": false + "description": "The number of data entries to return.", + "default": 10, + "optional": true + }, + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true }, { "name": "provider", @@ -16505,7 +16488,7 @@ "OBBject": [ { "name": "results", - "type": "List[EarningsCallTranscript]", + "type": "List[IncomeStatementGrowth]", "description": "Serializable results." }, { @@ -16536,175 +16519,271 @@ "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "quarter", - "type": "int", - "description": "Quarter of the earnings call transcript.", + "name": "period", + "type": "str", + "description": "Period the statement is returned for.", "default": "", "optional": false }, { - "name": "year", - "type": "int", - "description": "Year of the earnings call transcript.", + "name": "growth_revenue", + "type": "float", + "description": "Growth rate of total revenue.", "default": "", "optional": false }, { - "name": "date", - "type": "datetime", - "description": "The date of the data.", + "name": "growth_cost_of_revenue", + "type": "float", + "description": "Growth rate of cost of goods sold.", "default": "", "optional": false }, { - "name": "content", - "type": "str", - "description": "Content of the earnings call transcript.", + "name": "growth_gross_profit", + "type": "float", + "description": "Growth rate of gross profit.", "default": "", "optional": false - } - ], - "fmp": [] - }, - "model": "EarningsCallTranscript" - }, - "/equity/fundamental/trailing_dividend_yield": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the 1 year trailing dividend yield for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.trailing_dividend_yield(symbol='AAPL', provider='tiingo')\nobb.equity.fundamental.trailing_dividend_yield(symbol='AAPL', limit=252, provider='tiingo')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "name": "growth_gross_profit_ratio", + "type": "float", + "description": "Growth rate of gross profit as a percentage of revenue.", "default": "", "optional": false }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. Default is 252, the number of trading days in a year.", - "default": 252, - "optional": true + "name": "growth_research_and_development_expenses", + "type": "float", + "description": "Growth rate of expenses on research and development.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Literal['tiingo']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tiingo' if there is no default.", - "default": "tiingo", - "optional": true - } - ], - "tiingo": [] - }, - "returns": { - "OBBject": [ + "name": "growth_general_and_administrative_expenses", + "type": "float", + "description": "Growth rate of general and administrative expenses.", + "default": "", + "optional": false + }, { - "name": "results", - "type": "List[TrailingDividendYield]", - "description": "Serializable results." + "name": "growth_selling_and_marketing_expenses", + "type": "float", + "description": "Growth rate of expenses on selling and marketing activities.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Optional[Literal['tiingo']]", - "description": "Provider name." + "name": "growth_other_expenses", + "type": "float", + "description": "Growth rate of other operating expenses.", + "default": "", + "optional": false }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "growth_operating_expenses", + "type": "float", + "description": "Growth rate of total operating expenses.", + "default": "", + "optional": false }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "growth_cost_and_expenses", + "type": "float", + "description": "Growth rate of total costs and expenses.", + "default": "", + "optional": false }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "growth_interest_expense", + "type": "float", + "description": "Growth rate of interest expenses.", + "default": "", + "optional": false + }, { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "growth_depreciation_and_amortization", + "type": "float", + "description": "Growth rate of depreciation and amortization expenses.", "default": "", "optional": false }, { - "name": "trailing_dividend_yield", + "name": "growth_ebitda", "type": "float", - "description": "Trailing dividend yield.", + "description": "Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization.", "default": "", "optional": false - } - ], - "tiingo": [] - }, - "model": "TrailingDividendYield" - }, - "/equity/ownership/major_holders": { + }, + { + "name": "growth_ebitda_ratio", + "type": "float", + "description": "Growth rate of EBITDA as a percentage of revenue.", + "default": "", + "optional": false + }, + { + "name": "growth_operating_income", + "type": "float", + "description": "Growth rate of operating income.", + "default": "", + "optional": false + }, + { + "name": "growth_operating_income_ratio", + "type": "float", + "description": "Growth rate of operating income as a percentage of revenue.", + "default": "", + "optional": false + }, + { + "name": "growth_total_other_income_expenses_net", + "type": "float", + "description": "Growth rate of net total other income and expenses.", + "default": "", + "optional": false + }, + { + "name": "growth_income_before_tax", + "type": "float", + "description": "Growth rate of income before taxes.", + "default": "", + "optional": false + }, + { + "name": "growth_income_before_tax_ratio", + "type": "float", + "description": "Growth rate of income before taxes as a percentage of revenue.", + "default": "", + "optional": false + }, + { + "name": "growth_income_tax_expense", + "type": "float", + "description": "Growth rate of income tax expenses.", + "default": "", + "optional": false + }, + { + "name": "growth_net_income", + "type": "float", + "description": "Growth rate of net income.", + "default": "", + "optional": false + }, + { + "name": "growth_net_income_ratio", + "type": "float", + "description": "Growth rate of net income as a percentage of revenue.", + "default": "", + "optional": false + }, + { + "name": "growth_eps", + "type": "float", + "description": "Growth rate of Earnings Per Share (EPS).", + "default": "", + "optional": false + }, + { + "name": "growth_eps_diluted", + "type": "float", + "description": "Growth rate of diluted Earnings Per Share (EPS).", + "default": "", + "optional": false + }, + { + "name": "growth_weighted_average_shs_out", + "type": "float", + "description": "Growth rate of weighted average shares outstanding.", + "default": "", + "optional": false + }, + { + "name": "growth_weighted_average_shs_out_dil", + "type": "float", + "description": "Growth rate of diluted weighted average shares outstanding.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "IncomeStatementGrowth" + }, + "/equity/fundamental/metrics": { "deprecated": { "flag": null, "message": null }, - "description": "Get 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", + "description": "Get fundamental metrics for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.metrics(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.metrics(symbol='AAPL', period='annual', limit=100, provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, yfinance.", "default": "", "optional": false }, { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "Time period of the data to return.", + "default": "annual", "optional": true }, { - "name": "page", + "name": "limit", "type": "int", - "description": "Page number of the data to fetch.", - "default": 0, + "description": "The number of data entries to return.", + "default": 100, "optional": true }, { "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "type": "Literal['finviz', 'fmp', 'intrinio', 'yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default.", + "default": "finviz", "optional": true } ], - "fmp": [] + "finviz": [], + "fmp": [ + { + "name": "with_ttm", + "type": "bool", + "description": "Include trailing twelve months (TTM) data.", + "default": false, + "optional": true + } + ], + "intrinio": [], + "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EquityOwnership]", + "type": "List[KeyMetrics]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['finviz', 'fmp', 'intrinio', 'yfinance']]", "description": "Provider name." }, { @@ -16726,1788 +16805,11901 @@ }, "data": { "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "cik", - "type": "int", - "description": "Central Index Key (CIK) for the requested entity.", - "default": "", - "optional": false - }, - { - "name": "filing_date", - "type": "date", - "description": "Filing date of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "investor_name", - "type": "str", - "description": "Investor name of the stock ownership.", - "default": "", - "optional": false - }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "default": null, + "optional": true }, { - "name": "security_name", - "type": "str", - "description": "Security name of the stock ownership.", - "default": "", - "optional": false + "name": "market_cap", + "type": "float", + "description": "Market capitalization", + "default": null, + "optional": true }, { - "name": "type_of_security", - "type": "str", - "description": "Type of security of the stock ownership.", - "default": "", - "optional": false - }, + "name": "pe_ratio", + "type": "float", + "description": "Price-to-earnings ratio (P/E ratio)", + "default": null, + "optional": true + } + ], + "finviz": [ { - "name": "security_cusip", - "type": "str", - "description": "Security cusip of the stock ownership.", - "default": "", - "optional": false + "name": "foward_pe", + "type": "float", + "description": "Forward price-to-earnings ratio (forward P/E)", + "default": null, + "optional": true }, { - "name": "shares_type", - "type": "str", - "description": "Shares type of the stock ownership.", - "default": "", - "optional": false + "name": "eps", + "type": "float", + "description": "Earnings per share (EPS)", + "default": null, + "optional": true }, { - "name": "put_call_share", - "type": "str", - "description": "Put call share of the stock ownership.", - "default": "", - "optional": false + "name": "price_to_sales", + "type": "float", + "description": "Price-to-sales ratio (P/S)", + "default": null, + "optional": true }, { - "name": "investment_discretion", - "type": "str", - "description": "Investment discretion of the stock ownership.", - "default": "", - "optional": false + "name": "price_to_book", + "type": "float", + "description": "Price-to-book ratio (P/B)", + "default": null, + "optional": true }, { - "name": "industry_title", - "type": "str", - "description": "Industry title of the stock ownership.", - "default": "", - "optional": false + "name": "book_value_per_share", + "type": "float", + "description": "Book value per share (Book/sh)", + "default": null, + "optional": true }, { - "name": "weight", + "name": "price_to_cash", "type": "float", - "description": "Weight of the stock ownership.", - "default": "", - "optional": false + "description": "Price-to-cash ratio (P/C)", + "default": null, + "optional": true }, { - "name": "last_weight", + "name": "cash_per_share", "type": "float", - "description": "Last weight of the stock ownership.", - "default": "", - "optional": false + "description": "Cash per share (Cash/sh)", + "default": null, + "optional": true }, { - "name": "change_in_weight", + "name": "price_to_free_cash_flow", "type": "float", - "description": "Change in weight of the stock ownership.", - "default": "", - "optional": false + "description": "Price-to-free cash flow ratio (P/FCF)", + "default": null, + "optional": true }, { - "name": "change_in_weight_percentage", + "name": "debt_to_equity", "type": "float", - "description": "Change in weight percentage of the stock ownership.", - "default": "", - "optional": false + "description": "Debt-to-equity ratio (Debt/Eq)", + "default": null, + "optional": true }, { - "name": "market_value", - "type": "int", - "description": "Market value of the stock ownership.", - "default": "", - "optional": false + "name": "long_term_debt_to_equity", + "type": "float", + "description": "Long-term debt-to-equity ratio (LT Debt/Eq)", + "default": null, + "optional": true }, { - "name": "last_market_value", - "type": "int", - "description": "Last market value of the stock ownership.", - "default": "", - "optional": false + "name": "quick_ratio", + "type": "float", + "description": "Quick ratio", + "default": null, + "optional": true }, { - "name": "change_in_market_value", - "type": "int", - "description": "Change in market value of the stock ownership.", - "default": "", - "optional": false + "name": "current_ratio", + "type": "float", + "description": "Current ratio", + "default": null, + "optional": true }, { - "name": "change_in_market_value_percentage", + "name": "gross_margin", "type": "float", - "description": "Change in market value percentage of the stock ownership.", - "default": "", - "optional": false + "description": "Gross margin, as a normalized percent.", + "default": null, + "optional": true }, { - "name": "shares_number", - "type": "int", - "description": "Shares number of the stock ownership.", - "default": "", - "optional": false + "name": "profit_margin", + "type": "float", + "description": "Profit margin, as a normalized percent.", + "default": null, + "optional": true }, { - "name": "last_shares_number", - "type": "int", - "description": "Last shares number of the stock ownership.", - "default": "", - "optional": false + "name": "operating_margin", + "type": "float", + "description": "Operating margin, as a normalized percent.", + "default": null, + "optional": true }, { - "name": "change_in_shares_number", + "name": "return_on_assets", "type": "float", - "description": "Change in shares number of the stock ownership.", - "default": "", - "optional": false + "description": "Return on assets (ROA), as a normalized percent.", + "default": null, + "optional": true }, { - "name": "change_in_shares_number_percentage", + "name": "return_on_investment", "type": "float", - "description": "Change in shares number percentage of the stock ownership.", - "default": "", - "optional": false + "description": "Return on investment (ROI), as a normalized percent.", + "default": null, + "optional": true }, { - "name": "quarter_end_price", + "name": "return_on_equity", "type": "float", - "description": "Quarter end price of the stock ownership.", - "default": "", - "optional": false + "description": "Return on equity (ROE), as a normalized percent.", + "default": null, + "optional": true }, { - "name": "avg_price_paid", + "name": "payout_ratio", "type": "float", - "description": "Average price paid of the stock ownership.", - "default": "", - "optional": false + "description": "Payout ratio, as a normalized percent.", + "default": null, + "optional": true }, { - "name": "is_new", - "type": "bool", - "description": "Is the stock ownership new.", + "name": "dividend_yield", + "type": "float", + "description": "Dividend yield, as a normalized percent.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "is_sold_out", - "type": "bool", - "description": "Is the stock ownership sold out.", + "name": "period", + "type": "str", + "description": "Period of the data.", "default": "", "optional": false }, { - "name": "ownership", - "type": "float", - "description": "How much is the ownership.", - "default": "", - "optional": false + "name": "calendar_year", + "type": "int", + "description": "Calendar year.", + "default": null, + "optional": true }, { - "name": "last_ownership", + "name": "revenue_per_share", "type": "float", - "description": "Last ownership amount.", - "default": "", - "optional": false + "description": "Revenue per share", + "default": null, + "optional": true }, { - "name": "change_in_ownership", + "name": "net_income_per_share", "type": "float", - "description": "Change in ownership amount.", - "default": "", - "optional": false + "description": "Net income per share", + "default": null, + "optional": true }, { - "name": "change_in_ownership_percentage", + "name": "operating_cash_flow_per_share", "type": "float", - "description": "Change in ownership percentage.", - "default": "", - "optional": false + "description": "Operating cash flow per share", + "default": null, + "optional": true }, { - "name": "holding_period", - "type": "int", - "description": "Holding period of the stock ownership.", - "default": "", - "optional": false + "name": "free_cash_flow_per_share", + "type": "float", + "description": "Free cash flow per share", + "default": null, + "optional": true }, { - "name": "first_added", - "type": "date", - "description": "First added date of the stock ownership.", - "default": "", - "optional": false + "name": "cash_per_share", + "type": "float", + "description": "Cash per share", + "default": null, + "optional": true }, { - "name": "performance", + "name": "book_value_per_share", "type": "float", - "description": "Performance of the stock ownership.", - "default": "", - "optional": false + "description": "Book value per share", + "default": null, + "optional": true }, { - "name": "performance_percentage", + "name": "tangible_book_value_per_share", "type": "float", - "description": "Performance percentage of the stock ownership.", - "default": "", - "optional": false + "description": "Tangible book value per share", + "default": null, + "optional": true }, { - "name": "last_performance", + "name": "shareholders_equity_per_share", "type": "float", - "description": "Last performance of the stock ownership.", - "default": "", - "optional": false + "description": "Shareholders equity per share", + "default": null, + "optional": true }, { - "name": "change_in_performance", + "name": "interest_debt_per_share", "type": "float", - "description": "Change in performance of the stock ownership.", - "default": "", - "optional": false + "description": "Interest debt per share", + "default": null, + "optional": true }, { - "name": "is_counted_for_performance", - "type": "bool", - "description": "Is the stock ownership counted for performance.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "EquityOwnership" - }, - "/equity/ownership/institutional": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get data about institutional ownership for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.institutional(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false + "name": "enterprise_value", + "type": "float", + "description": "Enterprise value", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "price_to_sales_ratio", + "type": "float", + "description": "Price-to-sales ratio", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "include_current_quarter", - "type": "bool", - "description": "Include current quarter data.", - "default": false, + "name": "pocf_ratio", + "type": "float", + "description": "Price-to-operating cash flow ratio", + "default": null, "optional": true }, { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", + "name": "pfcf_ratio", + "type": "float", + "description": "Price-to-free cash flow ratio", "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[InstitutionalOwnership]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "pb_ratio", + "type": "float", + "description": "Price-to-book ratio", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "ptb_ratio", + "type": "float", + "description": "Price-to-tangible book ratio", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "ev_to_sales", + "type": "float", + "description": "Enterprise value-to-sales ratio", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "enterprise_value_over_ebitda", + "type": "float", + "description": "Enterprise value-to-EBITDA ratio", + "default": null, + "optional": true }, { - "name": "cik", - "type": "str", - "description": "Central Index Key (CIK) for the requested entity.", + "name": "ev_to_operating_cash_flow", + "type": "float", + "description": "Enterprise value-to-operating cash flow ratio", "default": null, "optional": true }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - } - ], - "fmp": [ + "name": "ev_to_free_cash_flow", + "type": "float", + "description": "Enterprise value-to-free cash flow ratio", + "default": null, + "optional": true + }, { - "name": "investors_holding", - "type": "int", - "description": "Number of investors holding the stock.", - "default": "", - "optional": false + "name": "earnings_yield", + "type": "float", + "description": "Earnings yield", + "default": null, + "optional": true }, { - "name": "last_investors_holding", - "type": "int", - "description": "Number of investors holding the stock in the last quarter.", - "default": "", - "optional": false + "name": "free_cash_flow_yield", + "type": "float", + "description": "Free cash flow yield", + "default": null, + "optional": true }, { - "name": "investors_holding_change", - "type": "int", - "description": "Change in the number of investors holding the stock.", - "default": "", - "optional": false + "name": "debt_to_equity", + "type": "float", + "description": "Debt-to-equity ratio", + "default": null, + "optional": true }, { - "name": "number_of_13f_shares", - "type": "int", - "description": "Number of 13F shares.", + "name": "debt_to_assets", + "type": "float", + "description": "Debt-to-assets ratio", "default": null, "optional": true }, { - "name": "last_number_of_13f_shares", - "type": "int", - "description": "Number of 13F shares in the last quarter.", + "name": "net_debt_to_ebitda", + "type": "float", + "description": "Net debt-to-EBITDA ratio", "default": null, "optional": true }, { - "name": "number_of_13f_shares_change", - "type": "int", - "description": "Change in the number of 13F shares.", + "name": "current_ratio", + "type": "float", + "description": "Current ratio", "default": null, "optional": true }, { - "name": "total_invested", + "name": "interest_coverage", "type": "float", - "description": "Total amount invested.", - "default": "", - "optional": false + "description": "Interest coverage", + "default": null, + "optional": true }, { - "name": "last_total_invested", + "name": "income_quality", "type": "float", - "description": "Total amount invested in the last quarter.", - "default": "", - "optional": false + "description": "Income quality", + "default": null, + "optional": true }, { - "name": "total_invested_change", + "name": "dividend_yield", "type": "float", - "description": "Change in the total amount invested.", - "default": "", - "optional": false + "description": "Dividend yield, as a normalized percent.", + "default": null, + "optional": true }, { - "name": "ownership_percent", + "name": "payout_ratio", "type": "float", - "description": "Ownership percent.", - "default": "", - "optional": false + "description": "Payout ratio", + "default": null, + "optional": true }, { - "name": "last_ownership_percent", + "name": "sales_general_and_administrative_to_revenue", "type": "float", - "description": "Ownership percent in the last quarter.", - "default": "", - "optional": false + "description": "Sales general and administrative expenses-to-revenue ratio", + "default": null, + "optional": true }, { - "name": "ownership_percent_change", + "name": "research_and_development_to_revenue", "type": "float", - "description": "Change in the ownership percent.", - "default": "", - "optional": false + "description": "Research and development expenses-to-revenue ratio", + "default": null, + "optional": true }, { - "name": "new_positions", - "type": "int", - "description": "Number of new positions.", - "default": "", - "optional": false + "name": "intangibles_to_total_assets", + "type": "float", + "description": "Intangibles-to-total assets ratio", + "default": null, + "optional": true }, { - "name": "last_new_positions", - "type": "int", - "description": "Number of new positions in the last quarter.", - "default": "", - "optional": false + "name": "capex_to_operating_cash_flow", + "type": "float", + "description": "Capital expenditures-to-operating cash flow ratio", + "default": null, + "optional": true }, { - "name": "new_positions_change", - "type": "int", - "description": "Change in the number of new positions.", - "default": "", - "optional": false + "name": "capex_to_revenue", + "type": "float", + "description": "Capital expenditures-to-revenue ratio", + "default": null, + "optional": true }, { - "name": "increased_positions", - "type": "int", - "description": "Number of increased positions.", - "default": "", - "optional": false + "name": "capex_to_depreciation", + "type": "float", + "description": "Capital expenditures-to-depreciation ratio", + "default": null, + "optional": true }, { - "name": "last_increased_positions", - "type": "int", - "description": "Number of increased positions in the last quarter.", - "default": "", - "optional": false + "name": "stock_based_compensation_to_revenue", + "type": "float", + "description": "Stock-based compensation-to-revenue ratio", + "default": null, + "optional": true }, { - "name": "increased_positions_change", - "type": "int", - "description": "Change in the number of increased positions.", - "default": "", - "optional": false + "name": "graham_number", + "type": "float", + "description": "Graham number", + "default": null, + "optional": true }, { - "name": "closed_positions", - "type": "int", - "description": "Number of closed positions.", - "default": "", - "optional": false + "name": "roic", + "type": "float", + "description": "Return on invested capital", + "default": null, + "optional": true }, { - "name": "last_closed_positions", - "type": "int", - "description": "Number of closed positions in the last quarter.", - "default": "", - "optional": false + "name": "return_on_tangible_assets", + "type": "float", + "description": "Return on tangible assets", + "default": null, + "optional": true }, { - "name": "closed_positions_change", - "type": "int", - "description": "Change in the number of closed positions.", - "default": "", - "optional": false + "name": "graham_net_net", + "type": "float", + "description": "Graham net-net working capital", + "default": null, + "optional": true }, { - "name": "reduced_positions", - "type": "int", - "description": "Number of reduced positions.", - "default": "", - "optional": false + "name": "working_capital", + "type": "float", + "description": "Working capital", + "default": null, + "optional": true }, { - "name": "last_reduced_positions", - "type": "int", - "description": "Number of reduced positions in the last quarter.", - "default": "", - "optional": false + "name": "tangible_asset_value", + "type": "float", + "description": "Tangible asset value", + "default": null, + "optional": true }, { - "name": "reduced_positions_change", - "type": "int", - "description": "Change in the number of reduced positions.", - "default": "", - "optional": false + "name": "net_current_asset_value", + "type": "float", + "description": "Net current asset value", + "default": null, + "optional": true }, { - "name": "total_calls", - "type": "int", - "description": "Total number of call options contracts traded for Apple Inc. on the specified date.", - "default": "", - "optional": false + "name": "invested_capital", + "type": "float", + "description": "Invested capital", + "default": null, + "optional": true }, { - "name": "last_total_calls", - "type": "int", - "description": "Total number of call options contracts traded for Apple Inc. on the previous reporting date.", - "default": "", - "optional": false + "name": "average_receivables", + "type": "float", + "description": "Average receivables", + "default": null, + "optional": true }, { - "name": "total_calls_change", - "type": "int", - "description": "Change in the total number of call options contracts traded between the current and previous reporting dates.", - "default": "", - "optional": false + "name": "average_payables", + "type": "float", + "description": "Average payables", + "default": null, + "optional": true }, { - "name": "total_puts", - "type": "int", - "description": "Total number of put options contracts traded for Apple Inc. on the specified date.", - "default": "", - "optional": false + "name": "average_inventory", + "type": "float", + "description": "Average inventory", + "default": null, + "optional": true }, { - "name": "last_total_puts", - "type": "int", - "description": "Total number of put options contracts traded for Apple Inc. on the previous reporting date.", - "default": "", - "optional": false + "name": "days_sales_outstanding", + "type": "float", + "description": "Days sales outstanding", + "default": null, + "optional": true }, { - "name": "total_puts_change", - "type": "int", - "description": "Change in the total number of put options contracts traded between the current and previous reporting dates.", - "default": "", - "optional": false + "name": "days_payables_outstanding", + "type": "float", + "description": "Days payables outstanding", + "default": null, + "optional": true }, { - "name": "put_call_ratio", + "name": "days_of_inventory_on_hand", "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 + "description": "Days of inventory on hand", + "default": null, + "optional": true }, { - "name": "last_put_call_ratio", + "name": "receivables_turnover", "type": "float", - "description": "Put-call ratio on the previous reporting date.", - "default": "", - "optional": false + "description": "Receivables turnover", + "default": null, + "optional": true }, { - "name": "put_call_ratio_change", + "name": "payables_turnover", "type": "float", - "description": "Change in the put-call ratio between the current and previous reporting dates.", - "default": "", - "optional": false + "description": "Payables turnover", + "default": null, + "optional": true + }, + { + "name": "inventory_turnover", + "type": "float", + "description": "Inventory turnover", + "default": null, + "optional": true + }, + { + "name": "roe", + "type": "float", + "description": "Return on equity", + "default": null, + "optional": true + }, + { + "name": "capex_per_share", + "type": "float", + "description": "Capital expenditures per share", + "default": null, + "optional": true } - ] - }, - "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": [ + ], + "intrinio": [ + { + "name": "price_to_book", + "type": "float", + "description": "Price to book ratio.", + "default": null, + "optional": true + }, + { + "name": "price_to_tangible_book", + "type": "float", + "description": "Price to tangible book ratio.", + "default": null, + "optional": true + }, + { + "name": "price_to_revenue", + "type": "float", + "description": "Price to revenue ratio.", + "default": null, + "optional": true + }, + { + "name": "quick_ratio", + "type": "float", + "description": "Quick ratio.", + "default": null, + "optional": true + }, + { + "name": "gross_margin", + "type": "float", + "description": "Gross margin, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "ebit_margin", + "type": "float", + "description": "EBIT margin, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "profit_margin", + "type": "float", + "description": "Profit margin, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "eps", + "type": "float", + "description": "Basic earnings per share.", + "default": null, + "optional": true + }, + { + "name": "eps_growth", + "type": "float", + "description": "EPS growth, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "revenue_growth", + "type": "float", + "description": "Revenue growth, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "ebitda_growth", + "type": "float", + "description": "EBITDA growth, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "ebit_growth", + "type": "float", + "description": "EBIT growth, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "net_income_growth", + "type": "float", + "description": "Net income growth, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "free_cash_flow_to_firm_growth", + "type": "float", + "description": "Free cash flow to firm growth, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "invested_capital_growth", + "type": "float", + "description": "Invested capital growth, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "return_on_assets", + "type": "float", + "description": "Return on assets, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "return_on_equity", + "type": "float", + "description": "Return on equity, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "return_on_invested_capital", + "type": "float", + "description": "Return on invested capital, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "ebitda", + "type": "int", + "description": "Earnings before interest, taxes, depreciation, and amortization.", + "default": null, + "optional": true + }, + { + "name": "ebit", + "type": "int", + "description": "Earnings before interest and taxes.", + "default": null, + "optional": true + }, + { + "name": "long_term_debt", + "type": "int", + "description": "Long-term debt.", + "default": null, + "optional": true + }, + { + "name": "total_debt", + "type": "int", + "description": "Total debt.", + "default": null, + "optional": true + }, + { + "name": "total_capital", + "type": "int", + "description": "The sum of long-term debt and total shareholder equity.", + "default": null, + "optional": true + }, + { + "name": "enterprise_value", + "type": "int", + "description": "Enterprise value.", + "default": null, + "optional": true + }, + { + "name": "free_cash_flow_to_firm", + "type": "int", + "description": "Free cash flow to firm.", + "default": null, + "optional": true + }, + { + "name": "altman_z_score", + "type": "float", + "description": "Altman Z-score.", + "default": null, + "optional": true + }, + { + "name": "beta", + "type": "float", + "description": "Beta relative to the broad market (rolling three-year).", + "default": null, + "optional": true + }, + { + "name": "dividend_yield", + "type": "float", + "description": "Dividend yield, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "earnings_yield", + "type": "float", + "description": "Earnings yield, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "last_price", + "type": "float", + "description": "Last price of the stock.", + "default": null, + "optional": true + }, + { + "name": "year_high", + "type": "float", + "description": "52 week high", + "default": null, + "optional": true + }, + { + "name": "year_low", + "type": "float", + "description": "52 week low", + "default": null, + "optional": true + }, + { + "name": "volume_avg", + "type": "int", + "description": "Average daily volume.", + "default": null, + "optional": true + }, + { + "name": "short_interest", + "type": "int", + "description": "Number of shares reported as sold short.", + "default": null, + "optional": true + }, + { + "name": "shares_outstanding", + "type": "int", + "description": "Weighted average shares outstanding (TTM).", + "default": null, + "optional": true + }, + { + "name": "days_to_cover", + "type": "float", + "description": "Days to cover short interest, based on average daily volume.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "forward_pe", + "type": "float", + "description": "Forward price-to-earnings ratio.", + "default": null, + "optional": true + }, + { + "name": "peg_ratio", + "type": "float", + "description": "PEG ratio (5-year expected).", + "default": null, + "optional": true + }, + { + "name": "peg_ratio_ttm", + "type": "float", + "description": "PEG ratio (TTM).", + "default": null, + "optional": true + }, + { + "name": "eps_ttm", + "type": "float", + "description": "Earnings per share (TTM).", + "default": null, + "optional": true + }, + { + "name": "eps_forward", + "type": "float", + "description": "Forward earnings per share.", + "default": null, + "optional": true + }, + { + "name": "enterprise_to_ebitda", + "type": "float", + "description": "Enterprise value to EBITDA ratio.", + "default": null, + "optional": true + }, + { + "name": "earnings_growth", + "type": "float", + "description": "Earnings growth (Year Over Year), as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "earnings_growth_quarterly", + "type": "float", + "description": "Quarterly earnings growth (Year Over Year), as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "revenue_per_share", + "type": "float", + "description": "Revenue per share (TTM).", + "default": null, + "optional": true + }, + { + "name": "revenue_growth", + "type": "float", + "description": "Revenue growth (Year Over Year), as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "enterprise_to_revenue", + "type": "float", + "description": "Enterprise value to revenue ratio.", + "default": null, + "optional": true + }, + { + "name": "cash_per_share", + "type": "float", + "description": "Cash per share.", + "default": null, + "optional": true + }, + { + "name": "quick_ratio", + "type": "float", + "description": "Quick ratio.", + "default": null, + "optional": true + }, + { + "name": "current_ratio", + "type": "float", + "description": "Current ratio.", + "default": null, + "optional": true + }, + { + "name": "debt_to_equity", + "type": "float", + "description": "Debt-to-equity ratio.", + "default": null, + "optional": true + }, + { + "name": "gross_margin", + "type": "float", + "description": "Gross margin, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "operating_margin", + "type": "float", + "description": "Operating margin, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "ebitda_margin", + "type": "float", + "description": "EBITDA margin, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "profit_margin", + "type": "float", + "description": "Profit margin, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "return_on_assets", + "type": "float", + "description": "Return on assets, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "return_on_equity", + "type": "float", + "description": "Return on equity, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "dividend_yield", + "type": "float", + "description": "Dividend yield, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "dividend_yield_5y_avg", + "type": "float", + "description": "5-year average dividend yield, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "payout_ratio", + "type": "float", + "description": "Payout ratio.", + "default": null, + "optional": true + }, + { + "name": "book_value", + "type": "float", + "description": "Book value per share.", + "default": null, + "optional": true + }, + { + "name": "price_to_book", + "type": "float", + "description": "Price-to-book ratio.", + "default": null, + "optional": true + }, + { + "name": "enterprise_value", + "type": "int", + "description": "Enterprise value.", + "default": null, + "optional": true + }, + { + "name": "overall_risk", + "type": "float", + "description": "Overall risk score.", + "default": null, + "optional": true + }, + { + "name": "audit_risk", + "type": "float", + "description": "Audit risk score.", + "default": null, + "optional": true + }, + { + "name": "board_risk", + "type": "float", + "description": "Board risk score.", + "default": null, + "optional": true + }, + { + "name": "compensation_risk", + "type": "float", + "description": "Compensation risk score.", + "default": null, + "optional": true + }, + { + "name": "shareholder_rights_risk", + "type": "float", + "description": "Shareholder rights risk score.", + "default": null, + "optional": true + }, + { + "name": "beta", + "type": "float", + "description": "Beta relative to the broad market (5-year monthly).", + "default": null, + "optional": true + }, + { + "name": "price_return_1y", + "type": "float", + "description": "One-year price return, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency in which the data is presented.", + "default": null, + "optional": true + } + ] + }, + "model": "KeyMetrics" + }, + "/equity/fundamental/management": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get executive management team data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.management(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp', 'yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[KeyExecutives]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "title", + "type": "str", + "description": "Designation of the key executive.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the key executive.", + "default": "", + "optional": false + }, + { + "name": "pay", + "type": "int", + "description": "Pay of the key executive.", + "default": null, + "optional": true + }, + { + "name": "currency_pay", + "type": "str", + "description": "Currency of the pay.", + "default": null, + "optional": true + }, + { + "name": "gender", + "type": "str", + "description": "Gender of the key executive.", + "default": null, + "optional": true + }, + { + "name": "year_born", + "type": "int", + "description": "Birth year of the key executive.", + "default": null, + "optional": true + }, + { + "name": "title_since", + "type": "int", + "description": "Date the tile was held since.", + "default": null, + "optional": true + } + ], + "fmp": [], + "yfinance": [ + { + "name": "exercised_value", + "type": "int", + "description": "Value of shares exercised.", + "default": null, + "optional": true + }, + { + "name": "unexercised_value", + "type": "int", + "description": "Value of shares not exercised.", + "default": null, + "optional": true + } + ] + }, + "model": "KeyExecutives" + }, + "/equity/fundamental/management_compensation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get executive management team compensation for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.management_compensation(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "year", + "type": "int", + "description": "Year of the compensation.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[ExecutiveCompensation]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true + }, + { + "name": "company_name", + "type": "str", + "description": "The name of the company.", + "default": null, + "optional": true + }, + { + "name": "industry", + "type": "str", + "description": "The industry of the company.", + "default": null, + "optional": true + }, + { + "name": "year", + "type": "int", + "description": "Year of the compensation.", + "default": null, + "optional": true + }, + { + "name": "name_and_position", + "type": "str", + "description": "Name and position.", + "default": null, + "optional": true + }, + { + "name": "salary", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Salary.", + "default": null, + "optional": true + }, + { + "name": "bonus", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Bonus payments.", + "default": null, + "optional": true + }, + { + "name": "stock_award", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Stock awards.", + "default": null, + "optional": true + }, + { + "name": "incentive_plan_compensation", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Incentive plan compensation.", + "default": null, + "optional": true + }, + { + "name": "all_other_compensation", + "type": "Annotated[float, Ge(ge=0)]", + "description": "All other compensation.", + "default": null, + "optional": true + }, + { + "name": "total", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Total compensation.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "filing_date", + "type": "date", + "description": "Date of the filing.", + "default": null, + "optional": true + }, + { + "name": "accepted_date", + "type": "datetime", + "description": "Date the filing was accepted.", + "default": null, + "optional": true + }, + { + "name": "url", + "type": "str", + "description": "URL to the filing data.", + "default": null, + "optional": true + } + ] + }, + "model": "ExecutiveCompensation" + }, + "/equity/fundamental/overview": { + "deprecated": { + "flag": true, + "message": "This endpoint is deprecated; use `/equity/profile` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.3." + }, + "description": "Get company general business and stock data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.overview(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CompanyOverview]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "price", + "type": "float", + "description": "Price of the company.", + "default": null, + "optional": true + }, + { + "name": "beta", + "type": "float", + "description": "Beta of the company.", + "default": null, + "optional": true + }, + { + "name": "vol_avg", + "type": "int", + "description": "Volume average of the company.", + "default": null, + "optional": true + }, + { + "name": "mkt_cap", + "type": "int", + "description": "Market capitalization of the company.", + "default": null, + "optional": true + }, + { + "name": "last_div", + "type": "float", + "description": "Last dividend of the company.", + "default": null, + "optional": true + }, + { + "name": "range", + "type": "str", + "description": "Range of the company.", + "default": null, + "optional": true + }, + { + "name": "changes", + "type": "float", + "description": "Changes of the company.", + "default": null, + "optional": true + }, + { + "name": "company_name", + "type": "str", + "description": "Company name of the company.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency of the company.", + "default": null, + "optional": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true + }, + { + "name": "isin", + "type": "str", + "description": "ISIN of the company.", + "default": null, + "optional": true + }, + { + "name": "cusip", + "type": "str", + "description": "CUSIP of the company.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "Exchange of the company.", + "default": null, + "optional": true + }, + { + "name": "exchange_short_name", + "type": "str", + "description": "Exchange short name of the company.", + "default": null, + "optional": true + }, + { + "name": "industry", + "type": "str", + "description": "Industry of the company.", + "default": null, + "optional": true + }, + { + "name": "website", + "type": "str", + "description": "Website of the company.", + "default": null, + "optional": true + }, + { + "name": "description", + "type": "str", + "description": "Description of the company.", + "default": null, + "optional": true + }, + { + "name": "ceo", + "type": "str", + "description": "CEO of the company.", + "default": null, + "optional": true + }, + { + "name": "sector", + "type": "str", + "description": "Sector of the company.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Country of the company.", + "default": null, + "optional": true + }, + { + "name": "full_time_employees", + "type": "str", + "description": "Full time employees of the company.", + "default": null, + "optional": true + }, + { + "name": "phone", + "type": "str", + "description": "Phone of the company.", + "default": null, + "optional": true + }, + { + "name": "address", + "type": "str", + "description": "Address of the company.", + "default": null, + "optional": true + }, + { + "name": "city", + "type": "str", + "description": "City of the company.", + "default": null, + "optional": true + }, + { + "name": "state", + "type": "str", + "description": "State of the company.", + "default": null, + "optional": true + }, + { + "name": "zip", + "type": "str", + "description": "Zip of the company.", + "default": null, + "optional": true + }, + { + "name": "dcf_diff", + "type": "float", + "description": "Discounted cash flow difference of the company.", + "default": null, + "optional": true + }, + { + "name": "dcf", + "type": "float", + "description": "Discounted cash flow of the company.", + "default": null, + "optional": true + }, + { + "name": "image", + "type": "str", + "description": "Image of the company.", + "default": null, + "optional": true + }, + { + "name": "ipo_date", + "type": "date", + "description": "IPO date of the company.", + "default": null, + "optional": true + }, + { + "name": "default_image", + "type": "bool", + "description": "If the image is the default image.", + "default": "", + "optional": false + }, + { + "name": "is_etf", + "type": "bool", + "description": "If the company is an ETF.", + "default": "", + "optional": false + }, + { + "name": "is_actively_trading", + "type": "bool", + "description": "If the company is actively trading.", + "default": "", + "optional": false + }, + { + "name": "is_adr", + "type": "bool", + "description": "If the company is an ADR.", + "default": "", + "optional": false + }, + { + "name": "is_fund", + "type": "bool", + "description": "If the company is a fund.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "CompanyOverview" + }, + "/equity/fundamental/ratios": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get an extensive set of financial and accounting ratios for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.ratios(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.ratios(symbol='AAPL', period='annual', limit=12, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 12, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + } + ], + "intrinio": [ + { + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[FinancialRatios]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "str", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "fiscal_period", + "type": "str", + "description": "Period of the financial ratios.", + "default": "", + "optional": false + }, + { + "name": "fiscal_year", + "type": "int", + "description": "Fiscal year.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "current_ratio", + "type": "float", + "description": "Current ratio.", + "default": null, + "optional": true + }, + { + "name": "quick_ratio", + "type": "float", + "description": "Quick ratio.", + "default": null, + "optional": true + }, + { + "name": "cash_ratio", + "type": "float", + "description": "Cash ratio.", + "default": null, + "optional": true + }, + { + "name": "days_of_sales_outstanding", + "type": "float", + "description": "Days of sales outstanding.", + "default": null, + "optional": true + }, + { + "name": "days_of_inventory_outstanding", + "type": "float", + "description": "Days of inventory outstanding.", + "default": null, + "optional": true + }, + { + "name": "operating_cycle", + "type": "float", + "description": "Operating cycle.", + "default": null, + "optional": true + }, + { + "name": "days_of_payables_outstanding", + "type": "float", + "description": "Days of payables outstanding.", + "default": null, + "optional": true + }, + { + "name": "cash_conversion_cycle", + "type": "float", + "description": "Cash conversion cycle.", + "default": null, + "optional": true + }, + { + "name": "gross_profit_margin", + "type": "float", + "description": "Gross profit margin.", + "default": null, + "optional": true + }, + { + "name": "operating_profit_margin", + "type": "float", + "description": "Operating profit margin.", + "default": null, + "optional": true + }, + { + "name": "pretax_profit_margin", + "type": "float", + "description": "Pretax profit margin.", + "default": null, + "optional": true + }, + { + "name": "net_profit_margin", + "type": "float", + "description": "Net profit margin.", + "default": null, + "optional": true + }, + { + "name": "effective_tax_rate", + "type": "float", + "description": "Effective tax rate.", + "default": null, + "optional": true + }, + { + "name": "return_on_assets", + "type": "float", + "description": "Return on assets.", + "default": null, + "optional": true + }, + { + "name": "return_on_equity", + "type": "float", + "description": "Return on equity.", + "default": null, + "optional": true + }, + { + "name": "return_on_capital_employed", + "type": "float", + "description": "Return on capital employed.", + "default": null, + "optional": true + }, + { + "name": "net_income_per_ebt", + "type": "float", + "description": "Net income per EBT.", + "default": null, + "optional": true + }, + { + "name": "ebt_per_ebit", + "type": "float", + "description": "EBT per EBIT.", + "default": null, + "optional": true + }, + { + "name": "ebit_per_revenue", + "type": "float", + "description": "EBIT per revenue.", + "default": null, + "optional": true + }, + { + "name": "debt_ratio", + "type": "float", + "description": "Debt ratio.", + "default": null, + "optional": true + }, + { + "name": "debt_equity_ratio", + "type": "float", + "description": "Debt equity ratio.", + "default": null, + "optional": true + }, + { + "name": "long_term_debt_to_capitalization", + "type": "float", + "description": "Long term debt to capitalization.", + "default": null, + "optional": true + }, + { + "name": "total_debt_to_capitalization", + "type": "float", + "description": "Total debt to capitalization.", + "default": null, + "optional": true + }, + { + "name": "interest_coverage", + "type": "float", + "description": "Interest coverage.", + "default": null, + "optional": true + }, + { + "name": "cash_flow_to_debt_ratio", + "type": "float", + "description": "Cash flow to debt ratio.", + "default": null, + "optional": true + }, + { + "name": "company_equity_multiplier", + "type": "float", + "description": "Company equity multiplier.", + "default": null, + "optional": true + }, + { + "name": "receivables_turnover", + "type": "float", + "description": "Receivables turnover.", + "default": null, + "optional": true + }, + { + "name": "payables_turnover", + "type": "float", + "description": "Payables turnover.", + "default": null, + "optional": true + }, + { + "name": "inventory_turnover", + "type": "float", + "description": "Inventory turnover.", + "default": null, + "optional": true + }, + { + "name": "fixed_asset_turnover", + "type": "float", + "description": "Fixed asset turnover.", + "default": null, + "optional": true + }, + { + "name": "asset_turnover", + "type": "float", + "description": "Asset turnover.", + "default": null, + "optional": true + }, + { + "name": "operating_cash_flow_per_share", + "type": "float", + "description": "Operating cash flow per share.", + "default": null, + "optional": true + }, + { + "name": "free_cash_flow_per_share", + "type": "float", + "description": "Free cash flow per share.", + "default": null, + "optional": true + }, + { + "name": "cash_per_share", + "type": "float", + "description": "Cash per share.", + "default": null, + "optional": true + }, + { + "name": "payout_ratio", + "type": "float", + "description": "Payout ratio.", + "default": null, + "optional": true + }, + { + "name": "operating_cash_flow_sales_ratio", + "type": "float", + "description": "Operating cash flow sales ratio.", + "default": null, + "optional": true + }, + { + "name": "free_cash_flow_operating_cash_flow_ratio", + "type": "float", + "description": "Free cash flow operating cash flow ratio.", + "default": null, + "optional": true + }, + { + "name": "cash_flow_coverage_ratios", + "type": "float", + "description": "Cash flow coverage ratios.", + "default": null, + "optional": true + }, + { + "name": "short_term_coverage_ratios", + "type": "float", + "description": "Short term coverage ratios.", + "default": null, + "optional": true + }, + { + "name": "capital_expenditure_coverage_ratio", + "type": "float", + "description": "Capital expenditure coverage ratio.", + "default": null, + "optional": true + }, + { + "name": "dividend_paid_and_capex_coverage_ratio", + "type": "float", + "description": "Dividend paid and capex coverage ratio.", + "default": null, + "optional": true + }, + { + "name": "dividend_payout_ratio", + "type": "float", + "description": "Dividend payout ratio.", + "default": null, + "optional": true + }, + { + "name": "price_book_value_ratio", + "type": "float", + "description": "Price book value ratio.", + "default": null, + "optional": true + }, + { + "name": "price_to_book_ratio", + "type": "float", + "description": "Price to book ratio.", + "default": null, + "optional": true + }, + { + "name": "price_to_sales_ratio", + "type": "float", + "description": "Price to sales ratio.", + "default": null, + "optional": true + }, + { + "name": "price_earnings_ratio", + "type": "float", + "description": "Price earnings ratio.", + "default": null, + "optional": true + }, + { + "name": "price_to_free_cash_flows_ratio", + "type": "float", + "description": "Price to free cash flows ratio.", + "default": null, + "optional": true + }, + { + "name": "price_to_operating_cash_flows_ratio", + "type": "float", + "description": "Price to operating cash flows ratio.", + "default": null, + "optional": true + }, + { + "name": "price_cash_flow_ratio", + "type": "float", + "description": "Price cash flow ratio.", + "default": null, + "optional": true + }, + { + "name": "price_earnings_to_growth_ratio", + "type": "float", + "description": "Price earnings to growth ratio.", + "default": null, + "optional": true + }, + { + "name": "price_sales_ratio", + "type": "float", + "description": "Price sales ratio.", + "default": null, + "optional": true + }, + { + "name": "dividend_yield", + "type": "float", + "description": "Dividend yield.", + "default": null, + "optional": true + }, + { + "name": "dividend_yield_percentage", + "type": "float", + "description": "Dividend yield percentage.", + "default": null, + "optional": true + }, + { + "name": "dividend_per_share", + "type": "float", + "description": "Dividend per share.", + "default": null, + "optional": true + }, + { + "name": "enterprise_value_multiple", + "type": "float", + "description": "Enterprise value multiple.", + "default": null, + "optional": true + }, + { + "name": "price_fair_value", + "type": "float", + "description": "Price fair value.", + "default": null, + "optional": true + } + ], + "intrinio": [] + }, + "model": "FinancialRatios" + }, + "/equity/fundamental/revenue_per_geography": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the revenue geographic breakdown for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.revenue_per_geography(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.revenue_per_geography(symbol='AAPL', period='annual', structure='flat', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "structure", + "type": "Literal['hierarchical', 'flat']", + "description": "Structure of the returned data.", + "default": "flat", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[RevenueGeographic]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the reporting period.", + "default": null, + "optional": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the reporting period.", + "default": null, + "optional": true + }, + { + "name": "filing_date", + "type": "date", + "description": "The filing date of the report.", + "default": null, + "optional": true + }, + { + "name": "geographic_segment", + "type": "int", + "description": "Dictionary of the revenue by geographic segment.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "RevenueGeographic" + }, + "/equity/fundamental/revenue_per_segment": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the revenue breakdown by business segment for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.revenue_per_segment(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.revenue_per_segment(symbol='AAPL', period='annual', structure='flat', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "structure", + "type": "Literal['hierarchical', 'flat']", + "description": "Structure of the returned data.", + "default": "flat", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[RevenueBusinessLine]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the reporting period.", + "default": null, + "optional": true + }, + { + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the reporting period.", + "default": null, + "optional": true + }, + { + "name": "filing_date", + "type": "date", + "description": "The filing date of the report.", + "default": null, + "optional": true + }, + { + "name": "business_line", + "type": "int", + "description": "Dictionary containing the revenue of the business line.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "RevenueBusinessLine" + }, + "/equity/fundamental/filings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more. SEC\nfilings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114,\nForeign Investment Disclosures and others. The annual 10-K report is required to be\nfiled annually and includes the company's financial statements, management discussion and analysis,\nand audited financial statements.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.filings(provider='fmp')\nobb.equity.fundamental.filings(limit=100, provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": true + }, + { + "name": "form_type", + "type": "str", + "description": "Filter by form type. Check the data provider for available types.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'sec', 'tmx']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [], + "intrinio": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "thea_enabled", + "type": "bool", + "description": "Return filings that have been read by Intrinio's Thea NLP.", + "default": null, + "optional": true + } + ], + "sec": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": true + }, + { + "name": "form_type", + "type": "Literal['1', '1-A', '1-A POS', '1-A-W', '1-E', '1-E AD', '1-K', '1-SA', '1-U', '1-Z', '1-Z-W', '10-12B', '10-12G', '10-D', '10-K', '10-KT', '10-Q', '10-QT', '11-K', '11-KT', '13F-HR', '13F-NT', '13FCONP', '144', '15-12B', '15-12G', '15-15D', '15F-12B', '15F-12G', '15F-15D', '18-12B', '18-K', '19B-4E', '2-A', '2-AF', '2-E', '20-F', '20FR12B', '20FR12G', '24F-2NT', '25', '25-NSE', '253G1', '253G2', '253G3', '253G4', '3', '305B2', '34-12H', '4', '40-17F1', '40-17F2', '40-17G', '40-17GCS', '40-202A', '40-203A', '40-206A', '40-24B2', '40-33', '40-6B', '40-8B25', '40-8F-2', '40-APP', '40-F', '40-OIP', '40FR12B', '40FR12G', '424A', '424B1', '424B2', '424B3', '424B4', '424B5', '424B7', '424B8', '424H', '425', '485APOS', '485BPOS', '485BXT', '486APOS', '486BPOS', '486BXT', '487', '497', '497AD', '497H2', '497J', '497K', '497VPI', '497VPU', '5', '6-K', '6B NTC', '6B ORDR', '8-A12B', '8-A12G', '8-K', '8-K12B', '8-K12G3', '8-K15D5', '8-M', '8F-2 NTC', '8F-2 ORDR', '9-M', 'ABS-15G', 'ABS-EE', 'ADN-MTL', 'ADV-E', 'ADV-H-C', 'ADV-H-T', 'ADV-NR', 'ANNLRPT', 'APP NTC', 'APP ORDR', 'APP WD', 'APP WDG', 'ARS', 'ATS-N', 'ATS-N-C', 'ATS-N/UA', 'AW', 'AW WD', 'C', 'C-AR', 'C-AR-W', 'C-TR', 'C-TR-W', 'C-U', 'C-U-W', 'C-W', 'CB', 'CERT', 'CERTARCA', 'CERTBATS', 'CERTCBO', 'CERTNAS', 'CERTNYS', 'CERTPAC', 'CFPORTAL', 'CFPORTAL-W', 'CORRESP', 'CT ORDER', 'D', 'DEF 14A', 'DEF 14C', 'DEFA14A', 'DEFA14C', 'DEFC14A', 'DEFC14C', 'DEFM14A', 'DEFM14C', 'DEFN14A', 'DEFR14A', 'DEFR14C', 'DEL AM', 'DFAN14A', 'DFRN14A', 'DOS', 'DOSLTR', 'DRS', 'DRSLTR', 'DSTRBRPT', 'EFFECT', 'F-1', 'F-10', 'F-10EF', 'F-10POS', 'F-1MEF', 'F-3', 'F-3ASR', 'F-3D', 'F-3DPOS', 'F-3MEF', 'F-4', 'F-4 POS', 'F-4MEF', 'F-6', 'F-6 POS', 'F-6EF', 'F-7', 'F-7 POS', 'F-8', 'F-8 POS', 'F-80', 'F-80POS', 'F-9', 'F-9 POS', 'F-N', 'F-X', 'FOCUSN', 'FWP', 'G-405', 'G-405N', 'G-FIN', 'G-FINW', 'IRANNOTICE', 'MA', 'MA-A', 'MA-I', 'MA-W', 'MSD', 'MSDCO', 'MSDW', 'N-1', 'N-14', 'N-14 8C', 'N-14MEF', 'N-18F1', 'N-1A', 'N-2', 'N-2 POSASR', 'N-23C-2', 'N-23C3A', 'N-23C3B', 'N-23C3C', 'N-2ASR', 'N-2MEF', 'N-30B-2', 'N-30D', 'N-4', 'N-5', 'N-54A', 'N-54C', 'N-6', 'N-6F', 'N-8A', 'N-8B-2', 'N-8F', 'N-8F NTC', 'N-8F ORDR', 'N-CEN', 'N-CR', 'N-CSR', 'N-CSRS', 'N-MFP', 'N-MFP1', 'N-MFP2', 'N-PX', 'N-Q', 'N-VP', 'N-VPFS', 'NO ACT', 'NPORT-EX', 'NPORT-NP', 'NPORT-P', 'NRSRO-CE', 'NRSRO-UPD', 'NSAR-A', 'NSAR-AT', 'NSAR-B', 'NSAR-BT', 'NSAR-U', 'NT 10-D', 'NT 10-K', 'NT 10-Q', 'NT 11-K', 'NT 20-F', 'NT N-CEN', 'NT N-MFP', 'NT N-MFP1', 'NT N-MFP2', 'NT NPORT-EX', 'NT NPORT-P', 'NT-NCEN', 'NT-NCSR', 'NT-NSAR', 'NTFNCEN', 'NTFNCSR', 'NTFNSAR', 'NTN 10D', 'NTN 10K', 'NTN 10Q', 'NTN 20F', 'OIP NTC', 'OIP ORDR', 'POS 8C', 'POS AM', 'POS AMI', 'POS EX', 'POS462B', 'POS462C', 'POSASR', 'PRE 14A', 'PRE 14C', 'PREC14A', 'PREC14C', 'PREM14A', 'PREM14C', 'PREN14A', 'PRER14A', 'PRER14C', 'PRRN14A', 'PX14A6G', 'PX14A6N', 'QRTLYRPT', 'QUALIF', 'REG-NR', 'REVOKED', 'RW', 'RW WD', 'S-1', 'S-11', 'S-11MEF', 'S-1MEF', 'S-20', 'S-3', 'S-3ASR', 'S-3D', 'S-3DPOS', 'S-3MEF', 'S-4', 'S-4 POS', 'S-4EF', 'S-4MEF', 'S-6', 'S-8', 'S-8 POS', 'S-B', 'S-BMEF', 'SBSE', 'SBSE-A', 'SBSE-BD', 'SBSE-C', 'SBSE-W', 'SC 13D', 'SC 13E1', 'SC 13E3', 'SC 13G', 'SC 14D9', 'SC 14F1', 'SC 14N', 'SC TO-C', 'SC TO-I', 'SC TO-T', 'SC13E4F', 'SC14D1F', 'SC14D9C', 'SC14D9F', 'SD', 'SDR', 'SE', 'SEC ACTION', 'SEC STAFF ACTION', 'SEC STAFF LETTER', 'SF-1', 'SF-3', 'SL', 'SP 15D2', 'STOP ORDER', 'SUPPL', 'T-3', 'TA-1', 'TA-2', 'TA-W', 'TACO', 'TH', 'TTW', 'UNDER', 'UPLOAD', 'WDL-REQ', 'X-17A-5']", + "description": "Type of the SEC filing form.", + "default": null, + "optional": true + }, + { + "name": "cik", + "type": "Union[int, str]", + "description": "Lookup filings by Central Index Key (CIK) instead of by symbol.", + "default": null, + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache. If True, cache will store for one day.", + "default": true, + "optional": true + } + ], + "tmx": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "The start date to fetch.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "The end date to fetch.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CompanyFilings]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'sec', 'tmx']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "filing_date", + "type": "date", + "description": "The date of the filing.", + "default": "", + "optional": false + }, + { + "name": "accepted_date", + "type": "datetime", + "description": "Accepted date of the filing.", + "default": null, + "optional": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true + }, + { + "name": "report_type", + "type": "str", + "description": "Type of filing.", + "default": null, + "optional": true + }, + { + "name": "filing_url", + "type": "str", + "description": "URL to the filing page.", + "default": null, + "optional": true + }, + { + "name": "report_url", + "type": "str", + "description": "URL to the actual report.", + "default": "", + "optional": false + } + ], + "fmp": [], + "intrinio": [ + { + "name": "id", + "type": "str", + "description": "Intrinio ID of the filing.", + "default": "", + "optional": false + }, + { + "name": "period_end_date", + "type": "date", + "description": "Ending date of the fiscal period for the filing.", + "default": null, + "optional": true + }, + { + "name": "sec_unique_id", + "type": "str", + "description": "SEC unique ID of the filing.", + "default": "", + "optional": false + }, + { + "name": "instance_url", + "type": "str", + "description": "URL for the XBRL filing for the report.", + "default": null, + "optional": true + }, + { + "name": "industry_group", + "type": "str", + "description": "Industry group of the company.", + "default": "", + "optional": false + }, + { + "name": "industry_category", + "type": "str", + "description": "Industry category of the company.", + "default": "", + "optional": false + } + ], + "sec": [ + { + "name": "report_date", + "type": "date", + "description": "The date of the filing.", + "default": null, + "optional": true + }, + { + "name": "act", + "type": "Union[int, str]", + "description": "The SEC Act number.", + "default": null, + "optional": true + }, + { + "name": "items", + "type": "Union[str, float]", + "description": "The SEC Item numbers.", + "default": null, + "optional": true + }, + { + "name": "primary_doc_description", + "type": "str", + "description": "The description of the primary document.", + "default": null, + "optional": true + }, + { + "name": "primary_doc", + "type": "str", + "description": "The filename of the primary document.", + "default": null, + "optional": true + }, + { + "name": "accession_number", + "type": "Union[int, str]", + "description": "The accession number.", + "default": null, + "optional": true + }, + { + "name": "file_number", + "type": "Union[int, str]", + "description": "The file number.", + "default": null, + "optional": true + }, + { + "name": "film_number", + "type": "Union[int, str]", + "description": "The film number.", + "default": null, + "optional": true + }, + { + "name": "is_inline_xbrl", + "type": "Union[int, str]", + "description": "Whether the filing is an inline XBRL filing.", + "default": null, + "optional": true + }, + { + "name": "is_xbrl", + "type": "Union[int, str]", + "description": "Whether the filing is an XBRL filing.", + "default": null, + "optional": true + }, + { + "name": "size", + "type": "Union[int, str]", + "description": "The size of the filing.", + "default": null, + "optional": true + }, + { + "name": "complete_submission_url", + "type": "str", + "description": "The URL to the complete filing submission.", + "default": null, + "optional": true + }, + { + "name": "filing_detail_url", + "type": "str", + "description": "The URL to the filing details.", + "default": null, + "optional": true + } + ], + "tmx": [ + { + "name": "description", + "type": "str", + "description": "The description of the filing.", + "default": "", + "optional": false + }, + { + "name": "size", + "type": "str", + "description": "The file size of the PDF document.", + "default": "", + "optional": 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 + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[HistoricalSplits]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "numerator", + "type": "float", + "description": "Numerator of the split.", + "default": null, + "optional": true + }, + { + "name": "denominator", + "type": "float", + "description": "Denominator of the split.", + "default": null, + "optional": true + }, + { + "name": "split_ratio", + "type": "str", + "description": "Split ratio.", + "default": null, + "optional": true + } + ], + "fmp": [] + }, + "model": "HistoricalSplits" + }, + "/equity/fundamental/transcript": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get earnings call transcripts for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.transcript(symbol='AAPL', year=2020, provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "year", + "type": "int", + "description": "Year of the earnings call transcript.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EarningsCallTranscript]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "quarter", + "type": "int", + "description": "Quarter of the earnings call transcript.", + "default": "", + "optional": false + }, + { + "name": "year", + "type": "int", + "description": "Year of the earnings call transcript.", + "default": "", + "optional": false + }, + { + "name": "date", + "type": "datetime", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "content", + "type": "str", + "description": "Content of the earnings call transcript.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "EarningsCallTranscript" + }, + "/equity/fundamental/trailing_dividend_yield": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the 1 year trailing dividend yield for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.trailing_dividend_yield(symbol='AAPL', provider='tiingo')\nobb.equity.fundamental.trailing_dividend_yield(symbol='AAPL', limit=252, provider='tiingo')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return. Default is 252, the number of trading days in a year.", + "default": 252, + "optional": true + }, + { + "name": "provider", + "type": "Literal['tiingo']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tiingo' if there is no default.", + "default": "tiingo", + "optional": true + } + ], + "tiingo": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[TrailingDividendYield]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['tiingo']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "trailing_dividend_yield", + "type": "float", + "description": "Trailing dividend yield.", + "default": "", + "optional": false + } + ], + "tiingo": [] + }, + "model": "TrailingDividendYield" + }, + "/equity/ownership/major_holders": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get data about major holders for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.major_holders(symbol='AAPL', provider='fmp')\nobb.equity.ownership.major_holders(symbol='AAPL', page=0, provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": null, + "optional": true + }, + { + "name": "page", + "type": "int", + "description": "Page number of the data to fetch.", + "default": 0, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityOwnership]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "cik", + "type": "int", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "", + "optional": false + }, + { + "name": "filing_date", + "type": "date", + "description": "Filing date of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "investor_name", + "type": "str", + "description": "Investor name of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "security_name", + "type": "str", + "description": "Security name of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "type_of_security", + "type": "str", + "description": "Type of security of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "security_cusip", + "type": "str", + "description": "Security cusip of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "shares_type", + "type": "str", + "description": "Shares type of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "put_call_share", + "type": "str", + "description": "Put call share of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "investment_discretion", + "type": "str", + "description": "Investment discretion of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "industry_title", + "type": "str", + "description": "Industry title of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "weight", + "type": "float", + "description": "Weight of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "last_weight", + "type": "float", + "description": "Last weight of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "change_in_weight", + "type": "float", + "description": "Change in weight of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "change_in_weight_percentage", + "type": "float", + "description": "Change in weight percentage of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "market_value", + "type": "int", + "description": "Market value of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "last_market_value", + "type": "int", + "description": "Last market value of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "change_in_market_value", + "type": "int", + "description": "Change in market value of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "change_in_market_value_percentage", + "type": "float", + "description": "Change in market value percentage of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "shares_number", + "type": "int", + "description": "Shares number of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "last_shares_number", + "type": "int", + "description": "Last shares number of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "change_in_shares_number", + "type": "float", + "description": "Change in shares number of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "change_in_shares_number_percentage", + "type": "float", + "description": "Change in shares number percentage of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "quarter_end_price", + "type": "float", + "description": "Quarter end price of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "avg_price_paid", + "type": "float", + "description": "Average price paid of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "is_new", + "type": "bool", + "description": "Is the stock ownership new.", + "default": "", + "optional": false + }, + { + "name": "is_sold_out", + "type": "bool", + "description": "Is the stock ownership sold out.", + "default": "", + "optional": false + }, + { + "name": "ownership", + "type": "float", + "description": "How much is the ownership.", + "default": "", + "optional": false + }, + { + "name": "last_ownership", + "type": "float", + "description": "Last ownership amount.", + "default": "", + "optional": false + }, + { + "name": "change_in_ownership", + "type": "float", + "description": "Change in ownership amount.", + "default": "", + "optional": false + }, + { + "name": "change_in_ownership_percentage", + "type": "float", + "description": "Change in ownership percentage.", + "default": "", + "optional": false + }, + { + "name": "holding_period", + "type": "int", + "description": "Holding period of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "first_added", + "type": "date", + "description": "First added date of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "performance", + "type": "float", + "description": "Performance of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "performance_percentage", + "type": "float", + "description": "Performance percentage of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "last_performance", + "type": "float", + "description": "Last performance of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "change_in_performance", + "type": "float", + "description": "Change in performance of the stock ownership.", + "default": "", + "optional": false + }, + { + "name": "is_counted_for_performance", + "type": "bool", + "description": "Is the stock ownership counted for performance.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "EquityOwnership" + }, + "/equity/ownership/institutional": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get data about institutional ownership for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.institutional(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "include_current_quarter", + "type": "bool", + "description": "Include current quarter data.", + "default": false, + "optional": true + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[InstitutionalOwnership]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + } + ], + "fmp": [ + { + "name": "investors_holding", + "type": "int", + "description": "Number of investors holding the stock.", + "default": "", + "optional": false + }, + { + "name": "last_investors_holding", + "type": "int", + "description": "Number of investors holding the stock in the last quarter.", + "default": "", + "optional": false + }, + { + "name": "investors_holding_change", + "type": "int", + "description": "Change in the number of investors holding the stock.", + "default": "", + "optional": false + }, + { + "name": "number_of_13f_shares", + "type": "int", + "description": "Number of 13F shares.", + "default": null, + "optional": true + }, + { + "name": "last_number_of_13f_shares", + "type": "int", + "description": "Number of 13F shares in the last quarter.", + "default": null, + "optional": true + }, + { + "name": "number_of_13f_shares_change", + "type": "int", + "description": "Change in the number of 13F shares.", + "default": null, + "optional": true + }, + { + "name": "total_invested", + "type": "float", + "description": "Total amount invested.", + "default": "", + "optional": false + }, + { + "name": "last_total_invested", + "type": "float", + "description": "Total amount invested in the last quarter.", + "default": "", + "optional": false + }, + { + "name": "total_invested_change", + "type": "float", + "description": "Change in the total amount invested.", + "default": "", + "optional": false + }, + { + "name": "ownership_percent", + "type": "float", + "description": "Ownership percent.", + "default": "", + "optional": false + }, + { + "name": "last_ownership_percent", + "type": "float", + "description": "Ownership percent in the last quarter.", + "default": "", + "optional": false + }, + { + "name": "ownership_percent_change", + "type": "float", + "description": "Change in the ownership percent.", + "default": "", + "optional": false + }, + { + "name": "new_positions", + "type": "int", + "description": "Number of new positions.", + "default": "", + "optional": false + }, + { + "name": "last_new_positions", + "type": "int", + "description": "Number of new positions in the last quarter.", + "default": "", + "optional": false + }, + { + "name": "new_positions_change", + "type": "int", + "description": "Change in the number of new positions.", + "default": "", + "optional": false + }, + { + "name": "increased_positions", + "type": "int", + "description": "Number of increased positions.", + "default": "", + "optional": false + }, + { + "name": "last_increased_positions", + "type": "int", + "description": "Number of increased positions in the last quarter.", + "default": "", + "optional": false + }, + { + "name": "increased_positions_change", + "type": "int", + "description": "Change in the number of increased positions.", + "default": "", + "optional": false + }, + { + "name": "closed_positions", + "type": "int", + "description": "Number of closed positions.", + "default": "", + "optional": false + }, + { + "name": "last_closed_positions", + "type": "int", + "description": "Number of closed positions in the last quarter.", + "default": "", + "optional": false + }, + { + "name": "closed_positions_change", + "type": "int", + "description": "Change in the number of closed positions.", + "default": "", + "optional": false + }, + { + "name": "reduced_positions", + "type": "int", + "description": "Number of reduced positions.", + "default": "", + "optional": false + }, + { + "name": "last_reduced_positions", + "type": "int", + "description": "Number of reduced positions in the last quarter.", + "default": "", + "optional": false + }, + { + "name": "reduced_positions_change", + "type": "int", + "description": "Change in the number of reduced positions.", + "default": "", + "optional": false + }, + { + "name": "total_calls", + "type": "int", + "description": "Total number of call options contracts traded for Apple Inc. on the specified date.", + "default": "", + "optional": false + }, + { + "name": "last_total_calls", + "type": "int", + "description": "Total number of call options contracts traded for Apple Inc. on the previous reporting date.", + "default": "", + "optional": false + }, + { + "name": "total_calls_change", + "type": "int", + "description": "Change in the total number of call options contracts traded between the current and previous reporting dates.", + "default": "", + "optional": false + }, + { + "name": "total_puts", + "type": "int", + "description": "Total number of put options contracts traded for Apple Inc. on the specified date.", + "default": "", + "optional": false + }, + { + "name": "last_total_puts", + "type": "int", + "description": "Total number of put options contracts traded for Apple Inc. on the previous reporting date.", + "default": "", + "optional": false + }, + { + "name": "total_puts_change", + "type": "int", + "description": "Change in the total number of put options contracts traded between the current and previous reporting dates.", + "default": "", + "optional": false + }, + { + "name": "put_call_ratio", + "type": "float", + "description": "Put-call ratio, which is the ratio of the total number of put options to call options traded on the specified date.", + "default": "", + "optional": false + }, + { + "name": "last_put_call_ratio", + "type": "float", + "description": "Put-call ratio on the previous reporting date.", + "default": "", + "optional": false + }, + { + "name": "put_call_ratio_change", + "type": "float", + "description": "Change in the put-call ratio between the current and previous reporting dates.", + "default": "", + "optional": false + } + ] + }, + "model": "InstitutionalOwnership" + }, + "/equity/ownership/insider_trading": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get data about trading by a company's management team and board of directors.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.insider_trading(symbol='AAPL', provider='fmp')\nobb.equity.ownership.insider_trading(symbol='AAPL', limit=500, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 500, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'tmx']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "transaction_type", + "type": "Literal[None, 'award', 'conversion', 'return', 'expire_short', 'in_kind', 'gift', 'expire_long', 'discretionary', 'other', 'small', 'exempt', 'otm', 'purchase', 'sale', 'tender', 'will', 'itm', 'trust']", + "description": "Type of the transaction.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "", + "optional": false + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "", + "optional": false + }, + { + "name": "ownership_type", + "type": "Literal['D', 'I']", + "description": "Type of ownership.", + "default": null, + "optional": true + }, + { + "name": "sort_by", + "type": "Literal['filing_date', 'updated_on']", + "description": "Field to sort by.", + "default": "updated_on", + "optional": true + } + ], + "tmx": [ + { + "name": "summary", + "type": "bool", + "description": "Return a summary of the insider activity instead of the individuals.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[InsiderTrading]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'tmx']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "company_cik", + "type": "Union[int, str]", + "description": "CIK number of the company.", + "default": null, + "optional": true + }, + { + "name": "filing_date", + "type": "Union[date, datetime]", + "description": "Filing date of the trade.", + "default": null, + "optional": true + }, + { + "name": "transaction_date", + "type": "date", + "description": "Date of the transaction.", + "default": null, + "optional": true + }, + { + "name": "owner_cik", + "type": "Union[int, str]", + "description": "Reporting individual's CIK.", + "default": null, + "optional": true + }, + { + "name": "owner_name", + "type": "str", + "description": "Name of the reporting individual.", + "default": null, + "optional": true + }, + { + "name": "owner_title", + "type": "str", + "description": "The title held by the reporting individual.", + "default": null, + "optional": true + }, + { + "name": "transaction_type", + "type": "str", + "description": "Type of transaction being reported.", + "default": null, + "optional": true + }, + { + "name": "acquisition_or_disposition", + "type": "str", + "description": "Acquisition or disposition of the shares.", + "default": null, + "optional": true + }, + { + "name": "security_type", + "type": "str", + "description": "The type of security transacted.", + "default": null, + "optional": true + }, + { + "name": "securities_owned", + "type": "float", + "description": "Number of securities owned by the reporting individual.", + "default": null, + "optional": true + }, + { + "name": "securities_transacted", + "type": "float", + "description": "Number of securities transacted by the reporting individual.", + "default": null, + "optional": true + }, + { + "name": "transaction_price", + "type": "float", + "description": "The price of the transaction.", + "default": null, + "optional": true + }, + { + "name": "filing_url", + "type": "str", + "description": "Link to the filing.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "form_type", + "type": "str", + "description": "Form type of the insider trading.", + "default": "", + "optional": false + } + ], + "intrinio": [ + { + "name": "filing_url", + "type": "str", + "description": "URL of the filing.", + "default": null, + "optional": true + }, + { + "name": "company_name", + "type": "str", + "description": "Name of the company.", + "default": "", + "optional": false + }, + { + "name": "conversion_exercise_price", + "type": "float", + "description": "Conversion/Exercise price of the shares.", + "default": null, + "optional": true + }, + { + "name": "deemed_execution_date", + "type": "date", + "description": "Deemed execution date of the trade.", + "default": null, + "optional": true + }, + { + "name": "exercise_date", + "type": "date", + "description": "Exercise date of the trade.", + "default": null, + "optional": true + }, + { + "name": "expiration_date", + "type": "date", + "description": "Expiration date of the derivative.", + "default": null, + "optional": true + }, + { + "name": "underlying_security_title", + "type": "str", + "description": "Name of the underlying non-derivative security related to this derivative transaction.", + "default": null, + "optional": true + }, + { + "name": "underlying_shares", + "type": "Union[int, float]", + "description": "Number of underlying shares related to this derivative transaction.", + "default": null, + "optional": true + }, + { + "name": "nature_of_ownership", + "type": "str", + "description": "Nature of ownership of the insider trading.", + "default": null, + "optional": true + }, + { + "name": "director", + "type": "bool", + "description": "Whether the owner is a director.", + "default": null, + "optional": true + }, + { + "name": "officer", + "type": "bool", + "description": "Whether the owner is an officer.", + "default": null, + "optional": true + }, + { + "name": "ten_percent_owner", + "type": "bool", + "description": "Whether the owner is a 10% owner.", + "default": null, + "optional": true + }, + { + "name": "other_relation", + "type": "bool", + "description": "Whether the owner is having another relation.", + "default": null, + "optional": true + }, + { + "name": "derivative_transaction", + "type": "bool", + "description": "Whether the owner is having a derivative transaction.", + "default": null, + "optional": true + }, + { + "name": "report_line_number", + "type": "int", + "description": "Report line number of the insider trading.", + "default": null, + "optional": true + } + ], + "tmx": [ + { + "name": "owner_name", + "type": "str", + "description": "The name of the insider.", + "default": null, + "optional": true + }, + { + "name": "securities_owned", + "type": "int", + "description": "The number of shares held by the insider.", + "default": null, + "optional": true + }, + { + "name": "securities_transacted", + "type": "int", + "description": "The total number of shares traded by the insider over the period.", + "default": null, + "optional": true + }, + { + "name": "period", + "type": "str", + "description": "The period of the activity. Bucketed by three, six, and twelve months.", + "default": "", + "optional": false + }, + { + "name": "acquisition_or_deposition", + "type": "str", + "description": "Whether the insider bought or sold the shares.", + "default": null, + "optional": true + }, + { + "name": "number_of_trades", + "type": "int", + "description": "The number of shares traded over the period.", + "default": null, + "optional": true + }, + { + "name": "trade_value", + "type": "float", + "description": "The value of the shares traded by the insider.", + "default": null, + "optional": true + }, + { + "name": "securities_bought", + "type": "int", + "description": "The total number of shares bought by all insiders over the period.", + "default": null, + "optional": true + }, + { + "name": "securities_sold", + "type": "int", + "description": "The total number of shares sold by all insiders over the period.", + "default": null, + "optional": true + }, + { + "name": "net_activity", + "type": "int", + "description": "The total net activity by all insiders over the period.", + "default": null, + "optional": true + } + ] + }, + "model": "InsiderTrading" + }, + "/equity/ownership/share_statistics": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get data about share float for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.share_statistics(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [], + "intrinio": [], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[ShareStatistics]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": null, + "optional": true + }, + { + "name": "free_float", + "type": "float", + "description": "Percentage of unrestricted shares of a publicly-traded company.", + "default": null, + "optional": true + }, + { + "name": "float_shares", + "type": "float", + "description": "Number of shares available for trading by the general public.", + "default": null, + "optional": true + }, + { + "name": "outstanding_shares", + "type": "float", + "description": "Total number of shares of a publicly-traded company.", + "default": null, + "optional": true + }, + { + "name": "source", + "type": "str", + "description": "Source of the received data.", + "default": null, + "optional": true + } + ], + "fmp": [], + "intrinio": [ + { + "name": "adjusted_outstanding_shares", + "type": "float", + "description": "Total number of shares of a publicly-traded company, adjusted for splits.", + "default": null, + "optional": true + }, + { + "name": "public_float", + "type": "float", + "description": "Aggregate market value of the shares of a publicly-traded company.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "implied_shares_outstanding", + "type": "int", + "description": "Implied Shares Outstanding of common equity, assuming the conversion of all convertible subsidiary equity into common.", + "default": null, + "optional": true + }, + { + "name": "short_interest", + "type": "int", + "description": "Number of shares that are reported short.", + "default": null, + "optional": true + }, + { + "name": "short_percent_of_float", + "type": "float", + "description": "Percentage of shares that are reported short, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "days_to_cover", + "type": "float", + "description": "Number of days to repurchase the shares as a ratio of average daily volume", + "default": null, + "optional": true + }, + { + "name": "short_interest_prev_month", + "type": "int", + "description": "Number of shares that were reported short in the previous month.", + "default": null, + "optional": true + }, + { + "name": "short_interest_prev_date", + "type": "date", + "description": "Date of the previous month's report.", + "default": null, + "optional": true + }, + { + "name": "insider_ownership", + "type": "float", + "description": "Percentage of shares held by insiders, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "institution_ownership", + "type": "float", + "description": "Percentage of shares held by institutions, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "institution_float_ownership", + "type": "float", + "description": "Percentage of float held by institutions, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "institutions_count", + "type": "int", + "description": "Number of institutions holding shares.", + "default": null, + "optional": true + } + ] + }, + "model": "ShareStatistics" + }, + "/equity/ownership/form_13f": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the form 13F.\n\nThe Securities and Exchange Commission's (SEC) Form 13F is a quarterly report\nthat is required to be filed by all institutional investment managers with at least\n$100 million in assets under management.\nManagers are required to file Form 13F within 45 days after the last day of the calendar quarter.\nMost funds wait until the end of this period in order to conceal\ntheir investment strategy from competitors and the public.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.form_13f(symbol='NVDA', provider='sec')\n# Enter a date (calendar quarter ending) for a specific report.\nobb.equity.ownership.form_13f(symbol='BRK-A', date='2016-09-30', provider='sec')\n# Example finding Michael Burry's filings.\ncik = obb.regulators.sec.institutions_search(\"Scion Asset Management\").results[0].cik\n# Use the `limit` parameter to return N number of reports from the most recent.\nobb.equity.ownership.form_13f(cik, limit=2).to_df()\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. A CIK or Symbol can be used.", + "default": "", + "optional": false + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter.", + "default": 1, + "optional": true + }, + { + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", + "optional": true + } + ], + "sec": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[Form13FHR]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['sec']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end-of-quarter date of the filing.", + "default": "", + "optional": false + }, + { + "name": "issuer", + "type": "str", + "description": "The name of the issuer.", + "default": "", + "optional": false + }, + { + "name": "cusip", + "type": "str", + "description": "The CUSIP of the security.", + "default": "", + "optional": false + }, + { + "name": "asset_class", + "type": "str", + "description": "The title of the asset class for the security.", + "default": "", + "optional": false + }, + { + "name": "security_type", + "type": "Literal['SH', 'PRN']", + "description": "The total number of shares of the class of security or the principal amount of such class. 'SH' for shares. 'PRN' for principal amount. Convertible debt securities are reported as 'PRN'.", + "default": null, + "optional": true + }, + { + "name": "option_type", + "type": "Literal['call', 'put']", + "description": "Defined when the holdings being reported are put or call options. Only long positions are reported.", + "default": null, + "optional": true + }, + { + "name": "voting_authority_sole", + "type": "int", + "description": "The number of shares for which the Manager exercises sole voting authority (none).", + "default": null, + "optional": true + }, + { + "name": "voting_authority_shared", + "type": "int", + "description": "The number of shares for which the Manager exercises a defined shared voting authority (none).", + "default": null, + "optional": true + }, + { + "name": "voting_authority_other", + "type": "int", + "description": "The number of shares for which the Manager exercises other shared voting authority (none).", + "default": null, + "optional": true + }, + { + "name": "principal_amount", + "type": "int", + "description": "The total number of shares of the class of security or the principal amount of such class. Only long positions are reported", + "default": "", + "optional": false + }, + { + "name": "value", + "type": "int", + "description": "The fair market value of the holding of the particular class of security. The value reported for options is the fair market value of the underlying security with respect to the number of shares controlled. Values are rounded to the nearest US dollar and use the closing price of the last trading day of the calendar year or quarter.", + "default": "", + "optional": false + } + ], + "sec": [ + { + "name": "weight", + "type": "float", + "description": "The weight of the security relative to the market value of all securities in the filing , as a normalized percent.", + "default": "", + "optional": false + } + ] + }, + "model": "Form13FHR" + }, + "/equity/price/quote": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the latest quote for a given stock. Quote includes price, volume, and other data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.quote(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, tmx, tradier, yfinance.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['cboe', 'fmp', 'intrinio', 'tmx', 'tradier', 'yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.", + "default": "cboe", + "optional": true + } + ], + "cboe": [ + { + "name": "use_cache", + "type": "bool", + "description": "When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass.", + "default": true, + "optional": true + } + ], + "fmp": [], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", + "default": "", + "optional": false + }, + { + "name": "source", + "type": "Literal['iex', 'bats', 'bats_delayed', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed', 'intrinio_mx', 'intrinio_mx_plus', 'delayed_sip']", + "description": "Source of the data.", + "default": "iex", + "optional": true + } + ], + "tmx": [], + "tradier": [], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityQuote]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['cboe', 'fmp', 'intrinio', 'tmx', 'tradier', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "asset_type", + "type": "str", + "description": "Type of asset - i.e, stock, ETF, etc.", + "default": null, + "optional": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the company or asset.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "The name or symbol of the venue where the data is from.", + "default": null, + "optional": true + }, + { + "name": "bid", + "type": "float", + "description": "Price of the top bid order.", + "default": null, + "optional": true + }, + { + "name": "bid_size", + "type": "int", + "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", + "default": null, + "optional": true + }, + { + "name": "bid_exchange", + "type": "str", + "description": "The specific trading venue where the purchase order was placed.", + "default": null, + "optional": true + }, + { + "name": "ask", + "type": "float", + "description": "Price of the top ask order.", + "default": null, + "optional": true + }, + { + "name": "ask_size", + "type": "int", + "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", + "default": null, + "optional": true + }, + { + "name": "ask_exchange", + "type": "str", + "description": "The specific trading venue where the sale order was placed.", + "default": null, + "optional": true + }, + { + "name": "quote_conditions", + "type": "Union[str, int, List[str], List[int]]", + "description": "Conditions or condition codes applicable to the quote.", + "default": null, + "optional": true + }, + { + "name": "quote_indicators", + "type": "Union[str, int, List[str], List[int]]", + "description": "Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO.", + "default": null, + "optional": true + }, + { + "name": "sales_conditions", + "type": "Union[str, int, List[str], List[int]]", + "description": "Conditions or condition codes applicable to the sale.", + "default": null, + "optional": true + }, + { + "name": "sequence_number", + "type": "int", + "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11).", + "default": null, + "optional": true + }, + { + "name": "market_center", + "type": "str", + "description": "The ID of the UTP participant that originated the message.", + "default": null, + "optional": true + }, + { + "name": "participant_timestamp", + "type": "datetime", + "description": "Timestamp for when the quote was generated by the exchange.", + "default": null, + "optional": true + }, + { + "name": "trf_timestamp", + "type": "datetime", + "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message.", + "default": null, + "optional": true + }, + { + "name": "sip_timestamp", + "type": "datetime", + "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange.", + "default": null, + "optional": true + }, + { + "name": "last_price", + "type": "float", + "description": "Price of the last trade.", + "default": null, + "optional": true + }, + { + "name": "last_tick", + "type": "str", + "description": "Whether the last sale was an up or down tick.", + "default": null, + "optional": true + }, + { + "name": "last_size", + "type": "int", + "description": "Size of the last trade.", + "default": null, + "optional": true + }, + { + "name": "last_timestamp", + "type": "datetime", + "description": "Date and Time when the last price was recorded.", + "default": null, + "optional": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": null, + "optional": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": null, + "optional": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": null, + "optional": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "Union[int, float]", + "description": "The trading volume.", + "default": null, + "optional": true + }, + { + "name": "exchange_volume", + "type": "Union[int, float]", + "description": "Volume of shares exchanged during the trading day on the specific exchange.", + "default": null, + "optional": true + }, + { + "name": "prev_close", + "type": "float", + "description": "The previous close price.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "Change in price from previous close.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in price as a normalized percentage.", + "default": null, + "optional": true + }, + { + "name": "year_high", + "type": "float", + "description": "The one year high (52W High).", + "default": null, + "optional": true + }, + { + "name": "year_low", + "type": "float", + "description": "The one year low (52W Low).", + "default": null, + "optional": true + } + ], + "cboe": [ + { + "name": "iv30", + "type": "float", + "description": "The 30-day implied volatility of the stock.", + "default": null, + "optional": true + }, + { + "name": "iv30_change", + "type": "float", + "description": "Change in 30-day implied volatility of the stock.", + "default": null, + "optional": true + }, + { + "name": "iv30_change_percent", + "type": "float", + "description": "Change in 30-day implied volatility of the stock as a normalized percentage value.", + "default": null, + "optional": true + }, + { + "name": "iv30_annual_high", + "type": "float", + "description": "The 1-year high of 30-day implied volatility.", + "default": null, + "optional": true + }, + { + "name": "hv30_annual_high", + "type": "float", + "description": "The 1-year high of 30-day realized volatility.", + "default": null, + "optional": true + }, + { + "name": "iv30_annual_low", + "type": "float", + "description": "The 1-year low of 30-day implied volatility.", + "default": null, + "optional": true + }, + { + "name": "hv30_annual_low", + "type": "float", + "description": "The 1-year low of 30-dayrealized volatility.", + "default": null, + "optional": true + }, + { + "name": "iv60_annual_high", + "type": "float", + "description": "The 1-year high of 60-day implied volatility.", + "default": null, + "optional": true + }, + { + "name": "hv60_annual_high", + "type": "float", + "description": "The 1-year high of 60-day realized volatility.", + "default": null, + "optional": true + }, + { + "name": "iv60_annual_low", + "type": "float", + "description": "The 1-year low of 60-day implied volatility.", + "default": null, + "optional": true + }, + { + "name": "hv60_annual_low", + "type": "float", + "description": "The 1-year low of 60-day realized volatility.", + "default": null, + "optional": true + }, + { + "name": "iv90_annual_high", + "type": "float", + "description": "The 1-year high of 90-day implied volatility.", + "default": null, + "optional": true + }, + { + "name": "hv90_annual_high", + "type": "float", + "description": "The 1-year high of 90-day realized volatility.", + "default": null, + "optional": true + }, + { + "name": "iv90_annual_low", + "type": "float", + "description": "The 1-year low of 90-day implied volatility.", + "default": null, + "optional": true + }, + { + "name": "hv90_annual_low", + "type": "float", + "description": "The 1-year low of 90-day realized volatility.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "price_avg50", + "type": "float", + "description": "50 day moving average price.", + "default": null, + "optional": true + }, + { + "name": "price_avg200", + "type": "float", + "description": "200 day moving average price.", + "default": null, + "optional": true + }, + { + "name": "avg_volume", + "type": "int", + "description": "Average volume over the last 10 trading days.", + "default": null, + "optional": true + }, + { + "name": "market_cap", + "type": "float", + "description": "Market cap of the company.", + "default": null, + "optional": true + }, + { + "name": "shares_outstanding", + "type": "int", + "description": "Number of shares outstanding.", + "default": null, + "optional": true + }, + { + "name": "eps", + "type": "float", + "description": "Earnings per share.", + "default": null, + "optional": true + }, + { + "name": "pe", + "type": "float", + "description": "Price earnings ratio.", + "default": null, + "optional": true + }, + { + "name": "earnings_announcement", + "type": "datetime", + "description": "Upcoming earnings announcement date.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "is_darkpool", + "type": "bool", + "description": "Whether or not the current trade is from a darkpool.", + "default": null, + "optional": true + }, + { + "name": "source", + "type": "str", + "description": "Source of the Intrinio data.", + "default": null, + "optional": true + }, + { + "name": "updated_on", + "type": "datetime", + "description": "Date and Time when the data was last updated.", + "default": "", + "optional": false + }, + { + "name": "security", + "type": "IntrinioSecurity", + "description": "Security details related to the quote.", + "default": null, + "optional": true + } + ], + "tmx": [ + { + "name": "name", + "type": "str", + "description": "The name of the asset.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "The listing exchange code.", + "default": null, + "optional": true + }, + { + "name": "last_price", + "type": "float", + "description": "The last price of the asset.", + "default": null, + "optional": true + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": null, + "optional": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": null, + "optional": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": null, + "optional": true + }, + { + "name": "close", + "type": "float", + "description": "None", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "int", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true + }, + { + "name": "prev_close", + "type": "float", + "description": "The previous close price.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "The change in price.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "The change in price as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "year_high", + "type": "float", + "description": "Fifty-two week high.", + "default": null, + "optional": true + }, + { + "name": "year_low", + "type": "float", + "description": "Fifty-two week low.", + "default": null, + "optional": true + }, + { + "name": "security_type", + "type": "str", + "description": "The issuance type of the asset.", + "default": null, + "optional": true + }, + { + "name": "sector", + "type": "str", + "description": "The sector of the asset.", + "default": null, + "optional": true + }, + { + "name": "industry_category", + "type": "str", + "description": "The industry category of the asset.", + "default": null, + "optional": true + }, + { + "name": "industry_group", + "type": "str", + "description": "The industry group of the asset.", + "default": null, + "optional": true + }, + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true + }, + { + "name": "ma_21", + "type": "float", + "description": "Twenty-one day moving average.", + "default": null, + "optional": true + }, + { + "name": "ma_50", + "type": "float", + "description": "Fifty day moving average.", + "default": null, + "optional": true + }, + { + "name": "ma_200", + "type": "float", + "description": "Two-hundred day moving average.", + "default": null, + "optional": true + }, + { + "name": "volume_avg_10d", + "type": "int", + "description": "Ten day average volume.", + "default": null, + "optional": true + }, + { + "name": "volume_avg_30d", + "type": "int", + "description": "Thirty day average volume.", + "default": null, + "optional": true + }, + { + "name": "volume_avg_50d", + "type": "int", + "description": "Fifty day average volume.", + "default": null, + "optional": true + }, + { + "name": "market_cap", + "type": "int", + "description": "Market capitalization.", + "default": null, + "optional": true + }, + { + "name": "market_cap_all_classes", + "type": "int", + "description": "Market capitalization of all share classes.", + "default": null, + "optional": true + }, + { + "name": "div_amount", + "type": "float", + "description": "The most recent dividend amount.", + "default": null, + "optional": true + }, + { + "name": "div_currency", + "type": "str", + "description": "The currency the dividend is paid in.", + "default": null, + "optional": true + }, + { + "name": "div_yield", + "type": "float", + "description": "The dividend yield as a normalized percentage.", + "default": null, + "optional": true + }, + { + "name": "div_freq", + "type": "str", + "description": "The frequency of dividend payments.", + "default": null, + "optional": true + }, + { + "name": "div_ex_date", + "type": "date", + "description": "The ex-dividend date.", + "default": null, + "optional": true + }, + { + "name": "div_pay_date", + "type": "date", + "description": "The next dividend ayment date.", + "default": null, + "optional": true + }, + { + "name": "div_growth_3y", + "type": "Union[str, float]", + "description": "The three year dividend growth as a normalized percentage.", + "default": null, + "optional": true + }, + { + "name": "div_growth_5y", + "type": "Union[str, float]", + "description": "The five year dividend growth as a normalized percentage.", + "default": null, + "optional": true + }, + { + "name": "pe", + "type": "Union[str, float]", + "description": "The price to earnings ratio.", + "default": null, + "optional": true + }, + { + "name": "eps", + "type": "Union[str, float]", + "description": "The earnings per share.", + "default": null, + "optional": true + }, + { + "name": "debt_to_equity", + "type": "Union[str, float]", + "description": "The debt to equity ratio.", + "default": null, + "optional": true + }, + { + "name": "price_to_book", + "type": "Union[str, float]", + "description": "The price to book ratio.", + "default": null, + "optional": true + }, + { + "name": "price_to_cf", + "type": "Union[str, float]", + "description": "The price to cash flow ratio.", + "default": null, + "optional": true + }, + { + "name": "return_on_equity", + "type": "Union[str, float]", + "description": "The return on equity, as a normalized percentage.", + "default": null, + "optional": true + }, + { + "name": "return_on_assets", + "type": "Union[str, float]", + "description": "The return on assets, as a normalized percentage.", + "default": null, + "optional": true + }, + { + "name": "beta", + "type": "Union[str, float]", + "description": "The beta relative to the TSX Composite.", + "default": null, + "optional": true + }, + { + "name": "alpha", + "type": "Union[str, float]", + "description": "The alpha relative to the TSX Composite.", + "default": null, + "optional": true + }, + { + "name": "shares_outstanding", + "type": "int", + "description": "The number of listed shares outstanding.", + "default": null, + "optional": true + }, + { + "name": "shares_escrow", + "type": "int", + "description": "The number of shares held in escrow.", + "default": null, + "optional": true + }, + { + "name": "shares_total", + "type": "int", + "description": "The total number of shares outstanding from all classes.", + "default": null, + "optional": true + } + ], + "tradier": [ + { + "name": "last_volume", + "type": "int", + "description": "The last trade volume.", + "default": null, + "optional": true + }, + { + "name": "volume_avg", + "type": "int", + "description": "The average daily trading volume.", + "default": null, + "optional": true + }, + { + "name": "bid_timestamp", + "type": "datetime", + "description": "Timestamp of the bid price.", + "default": null, + "optional": true + }, + { + "name": "ask_timestamp", + "type": "datetime", + "description": "Timestamp of the ask price.", + "default": null, + "optional": true + }, + { + "name": "greeks_timestamp", + "type": "datetime", + "description": "Timestamp of the greeks data.", + "default": null, + "optional": true + }, + { + "name": "underlying", + "type": "str", + "description": "The underlying symbol for the option.", + "default": null, + "optional": true + }, + { + "name": "root_symbol", + "type": "str", + "description": "The root symbol for the option.", + "default": null, + "optional": true + }, + { + "name": "option_type", + "type": "Literal['call', 'put']", + "description": "Type of option - call or put.", + "default": null, + "optional": true + }, + { + "name": "contract_size", + "type": "int", + "description": "The number of shares in a standard contract.", + "default": null, + "optional": true + }, + { + "name": "expiration_type", + "type": "str", + "description": "The expiration type of the option - i.e, standard, weekly, etc.", + "default": null, + "optional": true + }, + { + "name": "expiration_date", + "type": "date", + "description": "The expiration date of the option.", + "default": null, + "optional": true + }, + { + "name": "strike", + "type": "float", + "description": "The strike price of the option.", + "default": null, + "optional": true + }, + { + "name": "open_interest", + "type": "int", + "description": "The number of open contracts for the option.", + "default": null, + "optional": true + }, + { + "name": "bid_iv", + "type": "float", + "description": "Implied volatility of the bid price.", + "default": null, + "optional": true + }, + { + "name": "ask_iv", + "type": "float", + "description": "Implied volatility of the ask price.", + "default": null, + "optional": true + }, + { + "name": "mid_iv", + "type": "float", + "description": "Mid-point implied volatility of the option.", + "default": null, + "optional": true + }, + { + "name": "orats_final_iv", + "type": "float", + "description": "ORATS final implied volatility of the option.", + "default": null, + "optional": true + }, + { + "name": "delta", + "type": "float", + "description": "Delta of the option.", + "default": null, + "optional": true + }, + { + "name": "gamma", + "type": "float", + "description": "Gamma of the option.", + "default": null, + "optional": true + }, + { + "name": "theta", + "type": "float", + "description": "Theta of the option.", + "default": null, + "optional": true + }, + { + "name": "vega", + "type": "float", + "description": "Vega of the option.", + "default": null, + "optional": true + }, + { + "name": "rho", + "type": "float", + "description": "Rho of the option.", + "default": null, + "optional": true + }, + { + "name": "phi", + "type": "float", + "description": "Phi of the option.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "ma_50d", + "type": "float", + "description": "50-day moving average price.", + "default": null, + "optional": true + }, + { + "name": "ma_200d", + "type": "float", + "description": "200-day moving average price.", + "default": null, + "optional": true + }, + { + "name": "volume_average", + "type": "float", + "description": "Average daily trading volume.", + "default": null, + "optional": true + }, + { + "name": "volume_average_10d", + "type": "float", + "description": "Average daily trading volume in the last 10 days.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency of the price.", + "default": null, + "optional": true + } + ] + }, + "model": "EquityQuote" + }, + "/equity/price/nbbo": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the National Best Bid and Offer for a given stock.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.nbbo(symbol='AAPL', provider='polygon')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['polygon']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'polygon' if there is no default.", + "default": "polygon", + "optional": true + } + ], + "polygon": [ + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return. Up to ten million records will be returned. Pagination occurs in groups of 50,000. Remaining limit values will always return 50,000 more records unless it is the last page. High volume tickers will require multiple max requests for a single day's NBBO records. Expect stocks, like SPY, to approach 1GB in size, per day, as a raw CSV. Splitting large requests into chunks is recommended for full-day requests of high-volume symbols.", + "default": 50000, + "optional": true + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for. Use bracketed the timestamp parameters to specify exact time ranges.", + "default": null, + "optional": true + }, + { + "name": "timestamp_lt", + "type": "Union[datetime, str]", + "description": "Query by datetime, less than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", + "default": null, + "optional": true + }, + { + "name": "timestamp_gt", + "type": "Union[datetime, str]", + "description": "Query by datetime, greater than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", + "default": null, + "optional": true + }, + { + "name": "timestamp_lte", + "type": "Union[datetime, str]", + "description": "Query by datetime, less than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", + "default": null, + "optional": true + }, + { + "name": "timestamp_gte", + "type": "Union[datetime, str]", + "description": "Query by datetime, greater than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityNBBO]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['polygon']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "ask_exchange", + "type": "str", + "description": "The exchange ID for the ask.", + "default": "", + "optional": false + }, + { + "name": "ask", + "type": "float", + "description": "The last ask price.", + "default": "", + "optional": false + }, + { + "name": "ask_size", + "type": "int", + "description": "The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price.", + "default": "", + "optional": false + }, + { + "name": "bid_size", + "type": "int", + "description": "The bid size in round lots.", + "default": "", + "optional": false + }, + { + "name": "bid", + "type": "float", + "description": "The last bid price.", + "default": "", + "optional": false + }, + { + "name": "bid_exchange", + "type": "str", + "description": "The exchange ID for the bid.", + "default": "", + "optional": false + } + ], + "polygon": [ + { + "name": "tape", + "type": "str", + "description": "The exchange tape.", + "default": null, + "optional": true + }, + { + "name": "conditions", + "type": "Union[str, List[int], List[str]]", + "description": "A list of condition codes.", + "default": null, + "optional": true + }, + { + "name": "indicators", + "type": "List[int]", + "description": "A list of indicator codes.", + "default": null, + "optional": true + }, + { + "name": "sequence_num", + "type": "int", + "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11)", + "default": null, + "optional": true + }, + { + "name": "participant_timestamp", + "type": "datetime", + "description": "The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.", + "default": null, + "optional": true + }, + { + "name": "sip_timestamp", + "type": "datetime", + "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it.", + "default": null, + "optional": true + }, + { + "name": "trf_timestamp", + "type": "datetime", + "description": "The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this quote.", + "default": null, + "optional": true + } + ] + }, + "model": "EquityNBBO" + }, + "/equity/price/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical price data for a given stock. This includes open, high, low, close, and volume.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.historical(symbol='AAPL', provider='fmp')\nobb.equity.price.historical(symbol='AAPL', interval='1d', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance.", + "default": "", + "optional": false + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default.", + "default": "alpha_vantage", + "optional": true + } + ], + "alpha_vantage": [ + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '60m', '1d', '1W', '1M']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "adjustment", + "type": "Literal['splits_only', 'splits_and_dividends', 'unadjusted']", + "description": "The adjustment factor to apply. 'splits_only' is not supported for intraday data.", + "default": "splits_only", + "optional": true + }, + { + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": false, + "optional": true + }, + { + "name": "adjusted", + "type": "bool", + "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead.", + "default": false, + "optional": true + } + ], + "cboe": [ + { + "name": "interval", + "type": "Literal['1m', '1d']", + "description": "Time interval of the data to return. The most recent trading day is not including in daily historical data. Intraday data is only available for the most recent trading day at 1 minute intervals.", + "default": "1d", + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass.", + "default": true, + "optional": true + } + ], + "fmp": [ + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", + "default": "", + "optional": false + }, + { + "name": "interval", + "type": "Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "start_time", + "type": "datetime.time", + "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'.", + "default": null, + "optional": true + }, + { + "name": "end_time", + "type": "datetime.time", + "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'.", + "default": null, + "optional": true + }, + { + "name": "timezone", + "type": "str", + "description": "Timezone of the data, in the IANA format (Continent/City).", + "default": "America/New_York", + "optional": true + }, + { + "name": "source", + "type": "Literal['realtime', 'delayed', 'nasdaq_basic']", + "description": "The source of the data.", + "default": "realtime", + "optional": true + } + ], + "polygon": [ + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", + "default": "1d", + "optional": true + }, + { + "name": "adjustment", + "type": "Literal['splits_only', 'unadjusted']", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", + "optional": true + }, + { + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": false, + "optional": true + }, + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", + "default": "asc", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 49999, + "optional": true + } + ], + "tiingo": [ + { + "name": "interval", + "type": "Literal['1d', '1W', '1M', '1Y']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ], + "tmx": [ + { + "name": "interval", + "type": "Union[Literal['1m', '2m', '5m', '15m', '30m', '60m', '1h', '1d', '1W', '1M'], str, int]", + "description": "Time interval of the data to return. Or, any integer (entered as a string) representing the number of minutes. Default is daily data. There is no extended hours data, and intraday data is limited to after April 12 2022.", + "default": "day", + "optional": true + }, + { + "name": "adjustment", + "type": "Literal['splits_only', 'splits_and_dividends', 'unadjusted']", + "description": "The adjustment factor to apply. Only valid for daily data.", + "default": "splits_only", + "optional": true + } + ], + "tradier": [ + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '1d', '1W', '1M']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": false, + "optional": true + } + ], + "yfinance": [ + { + "name": "interval", + "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": false, + "optional": true + }, + { + "name": "include_actions", + "type": "bool", + "description": "Include dividends and stock splits in results.", + "default": true, + "optional": true + }, + { + "name": "adjustment", + "type": "Literal['splits_only', 'splits_and_dividends']", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", + "optional": true + }, + { + "name": "adjusted", + "type": "bool", + "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead.", + "default": false, + "optional": true + }, + { + "name": "prepost", + "type": "bool", + "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityHistorical]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "Union[float, int]", + "description": "The trading volume.", + "default": null, + "optional": true + }, + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true + } + ], + "alpha_vantage": [ + { + "name": "adj_close", + "type": "Annotated[float, Gt(gt=0)]", + "description": "The adjusted close price.", + "default": null, + "optional": true + }, + { + "name": "dividend", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Dividend amount, if a dividend was paid.", + "default": null, + "optional": true + }, + { + "name": "split_ratio", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Split coefficient, if a split occurred.", + "default": null, + "optional": true + } + ], + "cboe": [ + { + "name": "calls_volume", + "type": "int", + "description": "Number of calls traded during the most recent trading period. Only valid if interval is 1m.", + "default": null, + "optional": true + }, + { + "name": "puts_volume", + "type": "int", + "description": "Number of puts traded during the most recent trading period. Only valid if interval is 1m.", + "default": null, + "optional": true + }, + { + "name": "total_options_volume", + "type": "int", + "description": "Total number of options traded during the most recent trading period. Only valid if interval is 1m.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": null, + "optional": true + }, + { + "name": "unadjusted_volume", + "type": "float", + "description": "Unadjusted volume of the symbol.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "Change in the price from the previous close.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in the price from the previous close, as a normalized percent.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "average", + "type": "float", + "description": "Average trade price of an individual equity during the interval.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "Change in the price of the symbol from the previous day.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Percent change in the price of the symbol from the previous day.", + "default": null, + "optional": true + }, + { + "name": "adj_open", + "type": "float", + "description": "The adjusted open price.", + "default": null, + "optional": true + }, + { + "name": "adj_high", + "type": "float", + "description": "The adjusted high price.", + "default": null, + "optional": true + }, + { + "name": "adj_low", + "type": "float", + "description": "The adjusted low price.", + "default": null, + "optional": true + }, + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": null, + "optional": true + }, + { + "name": "adj_volume", + "type": "float", + "description": "The adjusted volume.", + "default": null, + "optional": true + }, + { + "name": "fifty_two_week_high", + "type": "float", + "description": "52 week high price for the symbol.", + "default": null, + "optional": true + }, + { + "name": "fifty_two_week_low", + "type": "float", + "description": "52 week low price for the symbol.", + "default": null, + "optional": true + }, + { + "name": "factor", + "type": "float", + "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices.", + "default": null, + "optional": true + }, + { + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", + "default": null, + "optional": true + }, + { + "name": "dividend", + "type": "float", + "description": "Dividend amount, if a dividend was paid.", + "default": null, + "optional": true + }, + { + "name": "close_time", + "type": "datetime", + "description": "The timestamp that represents the end of the interval span.", + "default": null, + "optional": true + }, + { + "name": "interval", + "type": "str", + "description": "The data time frequency.", + "default": null, + "optional": true + }, + { + "name": "intra_period", + "type": "bool", + "description": "If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "transactions", + "type": "Annotated[int, Gt(gt=0)]", + "description": "Number of transactions for the symbol in the time period.", + "default": null, + "optional": true + } + ], + "tiingo": [ + { + "name": "adj_open", + "type": "float", + "description": "The adjusted open price.", + "default": null, + "optional": true + }, + { + "name": "adj_high", + "type": "float", + "description": "The adjusted high price.", + "default": null, + "optional": true + }, + { + "name": "adj_low", + "type": "float", + "description": "The adjusted low price.", + "default": null, + "optional": true + }, + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": null, + "optional": true + }, + { + "name": "adj_volume", + "type": "float", + "description": "The adjusted volume.", + "default": null, + "optional": true + }, + { + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", + "default": null, + "optional": true + }, + { + "name": "dividend", + "type": "float", + "description": "Dividend amount, if a dividend was paid.", + "default": null, + "optional": true + } + ], + "tmx": [ + { + "name": "vwap", + "type": "float", + "description": "Volume weighted average price for the day.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "Change in price.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in price, as a normalized percentage.", + "default": null, + "optional": true + }, + { + "name": "transactions", + "type": "int", + "description": "Total number of transactions recorded.", + "default": null, + "optional": true + }, + { + "name": "transactions_value", + "type": "float", + "description": "Nominal value of recorded transactions.", + "default": null, + "optional": true + } + ], + "tradier": [ + { + "name": "last_price", + "type": "float", + "description": "The last price of the equity.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", + "default": null, + "optional": true + }, + { + "name": "dividend", + "type": "float", + "description": "Dividend amount (split-adjusted), if a dividend was paid.", + "default": null, + "optional": true + } + ] + }, + "model": "EquityHistorical" + }, + "/equity/price/performance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get price performance data for a given stock. This includes price changes for different time periods.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.performance(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['finviz', 'fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default.", + "default": "finviz", + "optional": true + } + ], + "finviz": [], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[PricePerformance]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['finviz', 'fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "one_day", + "type": "float", + "description": "One-day return.", + "default": null, + "optional": true + }, + { + "name": "wtd", + "type": "float", + "description": "Week to date return.", + "default": null, + "optional": true + }, + { + "name": "one_week", + "type": "float", + "description": "One-week return.", + "default": null, + "optional": true + }, + { + "name": "mtd", + "type": "float", + "description": "Month to date return.", + "default": null, + "optional": true + }, + { + "name": "one_month", + "type": "float", + "description": "One-month return.", + "default": null, + "optional": true + }, + { + "name": "qtd", + "type": "float", + "description": "Quarter to date return.", + "default": null, + "optional": true + }, + { + "name": "three_month", + "type": "float", + "description": "Three-month return.", + "default": null, + "optional": true + }, + { + "name": "six_month", + "type": "float", + "description": "Six-month return.", + "default": null, + "optional": true + }, + { + "name": "ytd", + "type": "float", + "description": "Year to date return.", + "default": null, + "optional": true + }, + { + "name": "one_year", + "type": "float", + "description": "One-year return.", + "default": null, + "optional": true + }, + { + "name": "two_year", + "type": "float", + "description": "Two-year return.", + "default": null, + "optional": true + }, + { + "name": "three_year", + "type": "float", + "description": "Three-year return.", + "default": null, + "optional": true + }, + { + "name": "four_year", + "type": "float", + "description": "Four-year", + "default": null, + "optional": true + }, + { + "name": "five_year", + "type": "float", + "description": "Five-year return.", + "default": null, + "optional": true + }, + { + "name": "ten_year", + "type": "float", + "description": "Ten-year return.", + "default": null, + "optional": true + }, + { + "name": "max", + "type": "float", + "description": "Return from the beginning of the time series.", + "default": null, + "optional": true + } + ], + "finviz": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": null, + "optional": true + }, + { + "name": "volatility_week", + "type": "float", + "description": "One-week realized volatility, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "volatility_month", + "type": "float", + "description": "One-month realized volatility, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "price", + "type": "float", + "description": "Last Price.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "float", + "description": "Current volume.", + "default": null, + "optional": true + }, + { + "name": "average_volume", + "type": "float", + "description": "Average daily volume.", + "default": null, + "optional": true + }, + { + "name": "relative_volume", + "type": "float", + "description": "Relative volume as a ratio of current volume to average volume.", + "default": null, + "optional": true + }, + { + "name": "analyst_recommendation", + "type": "float", + "description": "The analyst consensus, on a scale of 1-5 where 1 is a buy and 5 is a sell.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": "", + "optional": false + } + ] + }, + "model": "PricePerformance" + }, + "/equity/shorts/fails_to_deliver": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get reported Fail-to-deliver (FTD) data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.shorts.fails_to_deliver(symbol='AAPL', provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", + "optional": true + } + ], + "sec": [ + { + "name": "limit", + "type": "int", + "description": "Limit the number of reports to parse, from most recent. Approximately 24 reports per year, going back to 2009.", + "default": 24, + "optional": true + }, + { + "name": "skip_reports", + "type": "int", + "description": "Skip N number of reports from current. A value of 1 will skip the most recent report.", + "default": 0, + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache for the request, default is True. Each reporting period is a separate URL, new reports will be added to the cache.", + "default": true, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityFTD]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['sec']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "settlement_date", + "type": "date", + "description": "The settlement date of the fail.", + "default": null, + "optional": true + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "cusip", + "type": "str", + "description": "CUSIP of the Security.", + "default": null, + "optional": true + }, + { + "name": "quantity", + "type": "int", + "description": "The number of fails on that settlement date.", + "default": null, + "optional": true + }, + { + "name": "price", + "type": "float", + "description": "The price at the previous closing price from the settlement date.", + "default": null, + "optional": true + }, + { + "name": "description", + "type": "str", + "description": "The description of the Security.", + "default": null, + "optional": true + } + ], + "sec": [] + }, + "model": "EquityFTD" + }, + "/equity/shorts/short_volume": { + "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.short_volume(symbol='AAPL', provider='stockgrid')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['stockgrid']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'stockgrid' if there is no default.", + "default": "stockgrid", + "optional": true + } + ], + "stockgrid": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[ShortVolume]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['stockgrid']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": null, + "optional": true + }, + { + "name": "market", + "type": "str", + "description": "Reporting Facility ID. N=NYSE TRF, Q=NASDAQ TRF Carteret, B=NASDAQ TRY Chicago, D=FINRA ADF", + "default": null, + "optional": true + }, + { + "name": "short_volume", + "type": "int", + "description": "Aggregate reported share volume of executed short sale and short sale exempt trades during regular trading hours", + "default": null, + "optional": true + }, + { + "name": "short_exempt_volume", + "type": "int", + "description": "Aggregate reported share volume of executed short sale exempt trades during regular trading hours", + "default": null, + "optional": true + }, + { + "name": "total_volume", + "type": "int", + "description": "Aggregate reported share volume of executed trades during regular trading hours", + "default": null, + "optional": true + } + ], + "stockgrid": [ + { + "name": "close", + "type": "float", + "description": "Closing price of the stock on the date.", + "default": null, + "optional": true + }, + { + "name": "short_volume_percent", + "type": "float", + "description": "Percentage of the total volume that was short volume.", + "default": null, + "optional": true + } + ] + }, + "model": "ShortVolume" + }, + "/equity/shorts/short_interest": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get reported short volume and days to cover data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.shorts.short_interest(symbol='AAPL', provider='finra')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['finra']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finra' if there is no default.", + "default": "finra", + "optional": true + } + ], + "finra": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityShortInterest]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['finra']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "settlement_date", + "type": "date", + "description": "The mid-month short interest report is based on short positions held by members on the settlement date of the 15th of each month. If the 15th falls on a weekend or another non-settlement date, the designated settlement date will be the previous business day on which transactions settled. The end-of-month short interest report is based on short positions held on the last business day of the month on which transactions settle. Once the short position reports are received, the short interest data is compiled for each equity security and provided for publication on the 7th business day after the reporting settlement date.", + "default": "", + "optional": false + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "issue_name", + "type": "str", + "description": "Unique identifier of the issue.", + "default": "", + "optional": false + }, + { + "name": "market_class", + "type": "str", + "description": "Primary listing market.", + "default": "", + "optional": false + }, + { + "name": "current_short_position", + "type": "float", + "description": "The total number of shares in the issue that are reflected on the books and records of the reporting firms as short as defined by Rule 200 of Regulation SHO as of the current cycle\u2019s designated settlement date.", + "default": "", + "optional": false + }, + { + "name": "previous_short_position", + "type": "float", + "description": "The total number of shares in the issue that are reflected on the books and records of the reporting firms as short as defined by Rule 200 of Regulation SHO as of the previous cycle\u2019s designated settlement date.", + "default": "", + "optional": false + }, + { + "name": "avg_daily_volume", + "type": "float", + "description": "Total Volume or Adjusted Volume in case of splits / Total trade days between (previous settlement date + 1) to (current settlement date). The NULL values are translated as zero.", + "default": "", + "optional": false + }, + { + "name": "days_to_cover", + "type": "float", + "description": "The number of days of average share volume it would require to buy all of the shares that were sold short during the reporting cycle. Formula: Short Interest / Average Daily Share Volume, Rounded to Hundredths. 1.00 will be displayed for any values equal or less than 1 (i.e., Average Daily Share is equal to or greater than Short Interest). N/A will be displayed If the days to cover is Zero (i.e., Average Daily Share Volume is Zero).", + "default": "", + "optional": false + }, + { + "name": "change", + "type": "float", + "description": "Change in Shares Short from Previous Cycle: Difference in short interest between the current cycle and the previous cycle.", + "default": "", + "optional": false + }, + { + "name": "change_pct", + "type": "float", + "description": "Change in Shares Short from Previous Cycle as a percent.", + "default": "", + "optional": false + } + ], + "finra": [] + }, + "model": "EquityShortInterest" + }, + "/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')\nobb.equity.search(query='AAPL', is_symbol=False, use_cache=True, provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", + "optional": true + }, + { + "name": "is_symbol", + "type": "bool", + "description": "Whether to search by ticker symbol.", + "default": false, + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether to use the cache or not.", + "default": true, + "optional": true + }, + { + "name": "provider", + "type": "Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.", + "default": "cboe", + "optional": true + } + ], + "cboe": [], + "intrinio": [ + { + "name": "active", + "type": "bool", + "description": "When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded.", + "default": true, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10000, + "optional": true + } + ], + "nasdaq": [ + { + "name": "is_etf", + "type": "bool", + "description": "If True, returns ETFs.", + "default": null, + "optional": true + } + ], + "sec": [ + { + "name": "is_fund", + "type": "bool", + "description": "Whether to direct the search to the list of mutual funds and ETFs.", + "default": false, + "optional": true + } + ], + "tmx": [ + { + "name": "use_cache", + "type": "bool", + "description": "Whether to use a cached request. The list of companies is cached for two days.", + "default": true, + "optional": true + } + ], + "tradier": [ + { + "name": "is_symbol", + "type": "bool", + "description": "Whether the query is a symbol. Defaults to False.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquitySearch]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the company.", + "default": null, + "optional": true + } + ], + "cboe": [ + { + "name": "dpm_name", + "type": "str", + "description": "Name of the primary market maker.", + "default": null, + "optional": true + }, + { + "name": "post_station", + "type": "str", + "description": "Post and station location on the CBOE trading floor.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "cik", + "type": "str", + "description": "", + "default": "", + "optional": false + }, + { + "name": "lei", + "type": "str", + "description": "The Legal Entity Identifier (LEI) of the company.", + "default": "", + "optional": false + }, + { + "name": "intrinio_id", + "type": "str", + "description": "The Intrinio ID of the company.", + "default": "", + "optional": false + } + ], + "nasdaq": [ + { + "name": "nasdaq_traded", + "type": "str", + "description": "Is Nasdaq traded?", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "Primary Exchange", + "default": null, + "optional": true + }, + { + "name": "market_category", + "type": "str", + "description": "Market Category", + "default": null, + "optional": true + }, + { + "name": "etf", + "type": "str", + "description": "Is ETF?", + "default": null, + "optional": true + }, + { + "name": "round_lot_size", + "type": "float", + "description": "Round Lot Size", + "default": null, + "optional": true + }, + { + "name": "test_issue", + "type": "str", + "description": "Is test Issue?", + "default": null, + "optional": true + }, + { + "name": "financial_status", + "type": "str", + "description": "Financial Status", + "default": null, + "optional": true + }, + { + "name": "cqs_symbol", + "type": "str", + "description": "CQS Symbol", + "default": null, + "optional": true + }, + { + "name": "nasdaq_symbol", + "type": "str", + "description": "NASDAQ Symbol", + "default": null, + "optional": true + }, + { + "name": "next_shares", + "type": "str", + "description": "Is NextShares?", + "default": null, + "optional": true + } + ], + "sec": [ + { + "name": "cik", + "type": "str", + "description": "Central Index Key", + "default": "", + "optional": false + } + ], + "tmx": [], + "tradier": [ + { + "name": "exchange", + "type": "str", + "description": "Exchange where the security is listed.", + "default": "", + "optional": false + }, + { + "name": "security_type", + "type": "Literal['stock', 'option', 'etf', 'index', 'mutual_fund']", + "description": "Type of security.", + "default": "", + "optional": false + } + ] + }, + "model": "EquitySearch" + }, + "/equity/screener": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Screen for companies meeting various criteria.\n\nThese criteria include market cap, price, beta, volume, and dividend yield.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.screener(provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "mktcap_min", + "type": "int", + "description": "Filter by market cap greater than this value.", + "default": null, + "optional": true + }, + { + "name": "mktcap_max", + "type": "int", + "description": "Filter by market cap less than this value.", + "default": null, + "optional": true + }, + { + "name": "price_min", + "type": "float", + "description": "Filter by price greater than this value.", + "default": null, + "optional": true + }, + { + "name": "price_max", + "type": "float", + "description": "Filter by price less than this value.", + "default": null, + "optional": true + }, + { + "name": "beta_min", + "type": "float", + "description": "Filter by a beta greater than this value.", + "default": null, + "optional": true + }, + { + "name": "beta_max", + "type": "float", + "description": "Filter by a beta less than this value.", + "default": null, + "optional": true + }, + { + "name": "volume_min", + "type": "int", + "description": "Filter by volume greater than this value.", + "default": null, + "optional": true + }, + { + "name": "volume_max", + "type": "int", + "description": "Filter by volume less than this value.", + "default": null, + "optional": true + }, + { + "name": "dividend_min", + "type": "float", + "description": "Filter by dividend amount greater than this value.", + "default": null, + "optional": true + }, + { + "name": "dividend_max", + "type": "float", + "description": "Filter by dividend amount less than this value.", + "default": null, + "optional": true + }, + { + "name": "is_etf", + "type": "bool", + "description": "If true, returns only ETFs.", + "default": false, + "optional": true + }, + { + "name": "is_active", + "type": "bool", + "description": "If false, returns only inactive tickers.", + "default": true, + "optional": true + }, + { + "name": "sector", + "type": "Literal['Consumer Cyclical', 'Energy', 'Technology', 'Industrials', 'Financial Services', 'Basic Materials', 'Communication Services', 'Consumer Defensive', 'Healthcare', 'Real Estate', 'Utilities', 'Industrial Goods', 'Financial', 'Services', 'Conglomerates']", + "description": "Filter by sector.", + "default": null, + "optional": true + }, + { + "name": "industry", + "type": "str", + "description": "Filter by industry.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Filter by country, as a two-letter country code.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra']", + "description": "Filter by exchange.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "Limit the number of results to return.", + "default": 50000, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityScreener]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the company.", + "default": "", + "optional": false + } + ], + "fmp": [ + { + "name": "market_cap", + "type": "int", + "description": "The market cap of ticker.", + "default": null, + "optional": true + }, + { + "name": "sector", + "type": "str", + "description": "The sector the ticker belongs to.", + "default": null, + "optional": true + }, + { + "name": "industry", + "type": "str", + "description": "The industry ticker belongs to.", + "default": null, + "optional": true + }, + { + "name": "beta", + "type": "float", + "description": "The beta of the ETF.", + "default": null, + "optional": true + }, + { + "name": "price", + "type": "float", + "description": "The current price.", + "default": null, + "optional": true + }, + { + "name": "last_annual_dividend", + "type": "float", + "description": "The last annual amount dividend paid.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "int", + "description": "The current trading volume.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "The exchange code the asset trades on.", + "default": null, + "optional": true + }, + { + "name": "exchange_name", + "type": "str", + "description": "The full name of the primary exchange.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "The two-letter country abbreviation where the head office is located.", + "default": null, + "optional": true + }, + { + "name": "is_etf", + "type": "Literal[True, False]", + "description": "Whether the ticker is an ETF.", + "default": null, + "optional": true + }, + { + "name": "actively_trading", + "type": "Literal[True, False]", + "description": "Whether the ETF is actively trading.", + "default": null, + "optional": true + } + ] + }, + "model": "EquityScreener" + }, + "/equity/profile": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get general information about a company. This includes company name, industry, sector and price data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.profile(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, tmx, yfinance.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['finviz', 'fmp', 'intrinio', 'tmx', 'yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default.", + "default": "finviz", + "optional": true + } + ], + "finviz": [], + "fmp": [], + "intrinio": [], + "tmx": [], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityInfo]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['finviz', 'fmp', 'intrinio', 'tmx', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Common name of the company.", + "default": null, + "optional": true + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true + }, + { + "name": "cusip", + "type": "str", + "description": "CUSIP identifier for the company.", + "default": null, + "optional": true + }, + { + "name": "isin", + "type": "str", + "description": "International Securities Identification Number.", + "default": null, + "optional": true + }, + { + "name": "lei", + "type": "str", + "description": "Legal Entity Identifier assigned to the company.", + "default": null, + "optional": true + }, + { + "name": "legal_name", + "type": "str", + "description": "Official legal name of the company.", + "default": null, + "optional": true + }, + { + "name": "stock_exchange", + "type": "str", + "description": "Stock exchange where the company is traded.", + "default": null, + "optional": true + }, + { + "name": "sic", + "type": "int", + "description": "Standard Industrial Classification code for the company.", + "default": null, + "optional": true + }, + { + "name": "short_description", + "type": "str", + "description": "Short description of the company.", + "default": null, + "optional": true + }, + { + "name": "long_description", + "type": "str", + "description": "Long description of the company.", + "default": null, + "optional": true + }, + { + "name": "ceo", + "type": "str", + "description": "Chief Executive Officer of the company.", + "default": null, + "optional": true + }, + { + "name": "company_url", + "type": "str", + "description": "URL of the company's website.", + "default": null, + "optional": true + }, + { + "name": "business_address", + "type": "str", + "description": "Address of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "mailing_address", + "type": "str", + "description": "Mailing address of the company.", + "default": null, + "optional": true + }, + { + "name": "business_phone_no", + "type": "str", + "description": "Phone number of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "hq_address1", + "type": "str", + "description": "Address of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "hq_address2", + "type": "str", + "description": "Address of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "hq_address_city", + "type": "str", + "description": "City of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "hq_address_postal_code", + "type": "str", + "description": "Zip code of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "hq_state", + "type": "str", + "description": "State of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "hq_country", + "type": "str", + "description": "Country of the company's headquarters.", + "default": null, + "optional": true + }, + { + "name": "inc_state", + "type": "str", + "description": "State in which the company is incorporated.", + "default": null, + "optional": true + }, + { + "name": "inc_country", + "type": "str", + "description": "Country in which the company is incorporated.", + "default": null, + "optional": true + }, + { + "name": "employees", + "type": "int", + "description": "Number of employees working for the company.", + "default": null, + "optional": true + }, + { + "name": "entity_legal_form", + "type": "str", + "description": "Legal form of the company.", + "default": null, + "optional": true + }, + { + "name": "entity_status", + "type": "str", + "description": "Status of the company.", + "default": null, + "optional": true + }, + { + "name": "latest_filing_date", + "type": "date", + "description": "Date of the company's latest filing.", + "default": null, + "optional": true + }, + { + "name": "irs_number", + "type": "str", + "description": "IRS number assigned to the company.", + "default": null, + "optional": true + }, + { + "name": "sector", + "type": "str", + "description": "Sector in which the company operates.", + "default": null, + "optional": true + }, + { + "name": "industry_category", + "type": "str", + "description": "Category of industry in which the company operates.", + "default": null, + "optional": true + }, + { + "name": "industry_group", + "type": "str", + "description": "Group of industry in which the company operates.", + "default": null, + "optional": true + }, + { + "name": "template", + "type": "str", + "description": "Template used to standardize the company's financial statements.", + "default": null, + "optional": true + }, + { + "name": "standardized_active", + "type": "bool", + "description": "Whether the company is active or not.", + "default": null, + "optional": true + }, + { + "name": "first_fundamental_date", + "type": "date", + "description": "Date of the company's first fundamental.", + "default": null, + "optional": true + }, + { + "name": "last_fundamental_date", + "type": "date", + "description": "Date of the company's last fundamental.", + "default": null, + "optional": true + }, + { + "name": "first_stock_price_date", + "type": "date", + "description": "Date of the company's first stock price.", + "default": null, + "optional": true + }, + { + "name": "last_stock_price_date", + "type": "date", + "description": "Date of the company's last stock price.", + "default": null, + "optional": true + } + ], + "finviz": [ + { + "name": "index", + "type": "str", + "description": "Included in indices - i.e., Dow, Nasdaq, or S&P.", + "default": null, + "optional": true + }, + { + "name": "optionable", + "type": "str", + "description": "Whether options trade against the ticker.", + "default": null, + "optional": true + }, + { + "name": "shortable", + "type": "str", + "description": "If the asset is shortable.", + "default": null, + "optional": true + }, + { + "name": "shares_outstanding", + "type": "str", + "description": "The number of shares outstanding, as an abbreviated string.", + "default": null, + "optional": true + }, + { + "name": "shares_float", + "type": "str", + "description": "The number of shares in the public float, as an abbreviated string.", + "default": null, + "optional": true + }, + { + "name": "short_interest", + "type": "str", + "description": "The last reported number of shares sold short, as an abbreviated string.", + "default": null, + "optional": true + }, + { + "name": "institutional_ownership", + "type": "float", + "description": "The institutional ownership of the stock, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "market_cap", + "type": "str", + "description": "The market capitalization of the stock, as an abbreviated string.", + "default": null, + "optional": true + }, + { + "name": "dividend_yield", + "type": "float", + "description": "The dividend yield of the stock, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "earnings_date", + "type": "str", + "description": "The last, or next confirmed, earnings date and announcement time, as a string. The format is Nov 02 AMC - for after market close.", + "default": null, + "optional": true + }, + { + "name": "beta", + "type": "float", + "description": "The beta of the stock relative to the broad market.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "is_etf", + "type": "bool", + "description": "If the symbol is an ETF.", + "default": "", + "optional": false + }, + { + "name": "is_actively_trading", + "type": "bool", + "description": "If the company is actively trading.", + "default": "", + "optional": false + }, + { + "name": "is_adr", + "type": "bool", + "description": "If the stock is an ADR.", + "default": "", + "optional": false + }, + { + "name": "is_fund", + "type": "bool", + "description": "If the company is a fund.", + "default": "", + "optional": false + }, + { + "name": "image", + "type": "str", + "description": "Image of the company.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency in which the stock is traded.", + "default": null, + "optional": true + }, + { + "name": "market_cap", + "type": "int", + "description": "Market capitalization of the company.", + "default": null, + "optional": true + }, + { + "name": "last_price", + "type": "float", + "description": "The last traded price.", + "default": null, + "optional": true + }, + { + "name": "year_high", + "type": "float", + "description": "The one-year high of the price.", + "default": null, + "optional": true + }, + { + "name": "year_low", + "type": "float", + "description": "The one-year low of the price.", + "default": null, + "optional": true + }, + { + "name": "volume_avg", + "type": "int", + "description": "Average daily trading volume.", + "default": null, + "optional": true + }, + { + "name": "annualized_dividend_amount", + "type": "float", + "description": "The annualized dividend payment based on the most recent regular dividend payment.", + "default": null, + "optional": true + }, + { + "name": "beta", + "type": "float", + "description": "Beta of the stock relative to the market.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "id", + "type": "str", + "description": "Intrinio ID for the company.", + "default": null, + "optional": true + }, + { + "name": "thea_enabled", + "type": "bool", + "description": "Whether the company has been enabled for Thea.", + "default": null, + "optional": true + } + ], + "tmx": [ + { + "name": "email", + "type": "str", + "description": "The email of the company.", + "default": null, + "optional": true + }, + { + "name": "issue_type", + "type": "str", + "description": "The issuance type of the asset.", + "default": null, + "optional": true + }, + { + "name": "shares_outstanding", + "type": "int", + "description": "The number of listed shares outstanding.", + "default": null, + "optional": true + }, + { + "name": "shares_escrow", + "type": "int", + "description": "The number of shares held in escrow.", + "default": null, + "optional": true + }, + { + "name": "shares_total", + "type": "int", + "description": "The total number of shares outstanding from all classes.", + "default": null, + "optional": true + }, + { + "name": "dividend_frequency", + "type": "str", + "description": "The dividend frequency.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "exchange_timezone", + "type": "str", + "description": "The timezone of the exchange.", + "default": null, + "optional": true + }, + { + "name": "issue_type", + "type": "str", + "description": "The issuance type of the asset.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "The currency in which the asset is traded.", + "default": null, + "optional": true + }, + { + "name": "market_cap", + "type": "int", + "description": "The market capitalization of the asset.", + "default": null, + "optional": true + }, + { + "name": "shares_outstanding", + "type": "int", + "description": "The number of listed shares outstanding.", + "default": null, + "optional": true + }, + { + "name": "shares_float", + "type": "int", + "description": "The number of shares in the public float.", + "default": null, + "optional": true + }, + { + "name": "shares_implied_outstanding", + "type": "int", + "description": "Implied shares outstanding of common equityassuming the conversion of all convertible subsidiary equity into common.", + "default": null, + "optional": true + }, + { + "name": "shares_short", + "type": "int", + "description": "The reported number of shares short.", + "default": null, + "optional": true + }, + { + "name": "dividend_yield", + "type": "float", + "description": "The dividend yield of the asset, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "beta", + "type": "float", + "description": "The beta of the asset relative to the broad market.", + "default": null, + "optional": true + } + ] + }, + "model": "EquityInfo" + }, + "/equity/market_snapshots": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get an updated equity market snapshot. This includes price data for thousands of stocks.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.market_snapshots(provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "market", + "type": "Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra']", + "description": "The market to fetch data for.", + "default": "nasdaq", + "optional": true + } + ], + "intrinio": [ + { + "name": "date", + "type": "Union[Union[date, datetime, str], str]", + "description": "The date of the data. Can be a datetime or an ISO datetime string. Historical data appears to go back to mid-June 2022. Example: '2024-03-08T12:15:00+0400'", + "default": null, + "optional": true + } + ], + "polygon": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[MarketSnapshots]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": null, + "optional": true + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": null, + "optional": true + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": null, + "optional": true + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": null, + "optional": true + }, + { + "name": "prev_close", + "type": "float", + "description": "The previous close price.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "The change in price from the previous close.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "The change in price from the previous close, as a normalized percent.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "last_price", + "type": "float", + "description": "The last price of the stock.", + "default": null, + "optional": true + }, + { + "name": "last_price_timestamp", + "type": "Union[date, datetime]", + "description": "The timestamp of the last price.", + "default": null, + "optional": true + }, + { + "name": "ma50", + "type": "float", + "description": "The 50-day moving average.", + "default": null, + "optional": true + }, + { + "name": "ma200", + "type": "float", + "description": "The 200-day moving average.", + "default": null, + "optional": true + }, + { + "name": "year_high", + "type": "float", + "description": "The 52-week high.", + "default": null, + "optional": true + }, + { + "name": "year_low", + "type": "float", + "description": "The 52-week low.", + "default": null, + "optional": true + }, + { + "name": "volume_avg", + "type": "int", + "description": "Average daily trading volume.", + "default": null, + "optional": true + }, + { + "name": "market_cap", + "type": "int", + "description": "Market cap of the stock.", + "default": null, + "optional": true + }, + { + "name": "eps", + "type": "float", + "description": "Earnings per share.", + "default": null, + "optional": true + }, + { + "name": "pe", + "type": "float", + "description": "Price to earnings ratio.", + "default": null, + "optional": true + }, + { + "name": "shares_outstanding", + "type": "int", + "description": "Number of shares outstanding.", + "default": null, + "optional": true + }, + { + "name": "name", + "type": "str", + "description": "The company name associated with the symbol.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "The exchange of the stock.", + "default": null, + "optional": true + }, + { + "name": "earnings_date", + "type": "Union[date, datetime]", + "description": "The upcoming earnings announcement date.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "last_price", + "type": "float", + "description": "The last trade price.", + "default": null, + "optional": true + }, + { + "name": "last_size", + "type": "int", + "description": "The last trade size.", + "default": null, + "optional": true + }, + { + "name": "last_volume", + "type": "int", + "description": "The last trade volume.", + "default": null, + "optional": true + }, + { + "name": "last_trade_timestamp", + "type": "datetime", + "description": "The timestamp of the last trade.", + "default": null, + "optional": true + }, + { + "name": "bid_size", + "type": "int", + "description": "The size of the last bid price. Bid price and size is not always available.", + "default": null, + "optional": true + }, + { + "name": "bid_price", + "type": "float", + "description": "The last bid price. Bid price and size is not always available.", + "default": null, + "optional": true + }, + { + "name": "ask_price", + "type": "float", + "description": "The last ask price. Ask price and size is not always available.", + "default": null, + "optional": true + }, + { + "name": "ask_size", + "type": "int", + "description": "The size of the last ask price. Ask price and size is not always available.", + "default": null, + "optional": true + }, + { + "name": "last_bid_timestamp", + "type": "datetime", + "description": "The timestamp of the last bid price. Bid price and size is not always available.", + "default": null, + "optional": true + }, + { + "name": "last_ask_timestamp", + "type": "datetime", + "description": "The timestamp of the last ask price. Ask price and size is not always available.", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "vwap", + "type": "float", + "description": "The volume weighted average price of the stock on the current trading day.", + "default": null, + "optional": true + }, + { + "name": "prev_open", + "type": "float", + "description": "The previous trading session opening price.", + "default": null, + "optional": true + }, + { + "name": "prev_high", + "type": "float", + "description": "The previous trading session high price.", + "default": null, + "optional": true + }, + { + "name": "prev_low", + "type": "float", + "description": "The previous trading session low price.", + "default": null, + "optional": true + }, + { + "name": "prev_volume", + "type": "float", + "description": "The previous trading session volume.", + "default": null, + "optional": true + }, + { + "name": "prev_vwap", + "type": "float", + "description": "The previous trading session VWAP.", + "default": null, + "optional": true + }, + { + "name": "last_updated", + "type": "datetime", + "description": "The last time the data was updated.", + "default": "", + "optional": false + }, + { + "name": "bid", + "type": "float", + "description": "The current bid price.", + "default": null, + "optional": true + }, + { + "name": "bid_size", + "type": "int", + "description": "The current bid size.", + "default": null, + "optional": true + }, + { + "name": "ask_size", + "type": "int", + "description": "The current ask size.", + "default": null, + "optional": true + }, + { + "name": "ask", + "type": "float", + "description": "The current ask price.", + "default": null, + "optional": true + }, + { + "name": "quote_timestamp", + "type": "datetime", + "description": "The timestamp of the last quote.", + "default": null, + "optional": true + }, + { + "name": "last_trade_price", + "type": "float", + "description": "The last trade price.", + "default": null, + "optional": true + }, + { + "name": "last_trade_size", + "type": "int", + "description": "The last trade size.", + "default": null, + "optional": true + }, + { + "name": "last_trade_conditions", + "type": "List[int]", + "description": "The last trade condition codes.", + "default": null, + "optional": true + }, + { + "name": "last_trade_exchange", + "type": "int", + "description": "The last trade exchange ID code.", + "default": null, + "optional": true + }, + { + "name": "last_trade_timestamp", + "type": "datetime", + "description": "The last trade timestamp.", + "default": null, + "optional": true + } + ] + }, + "model": "MarketSnapshots" + }, + "/etf/discovery/gainers": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the top ETF gainers.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the top ETF gainers.\nobb.etf.discovery.gainers(provider='wsj')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10, + "optional": true + }, + { + "name": "provider", + "type": "Literal['wsj']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'wsj' if there is no default.", + "default": "wsj", + "optional": true + } + ], + "wsj": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[ETFGainers]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['wsj']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false + }, + { + "name": "last_price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false + }, + { + "name": "net_change", + "type": "float", + "description": "Net change.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + } + ], + "wsj": [ + { + "name": "bluegrass_channel", + "type": "str", + "description": "Bluegrass channel.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Country of the entity.", + "default": "", + "optional": false + }, + { + "name": "mantissa", + "type": "int", + "description": "Mantissa.", + "default": "", + "optional": false + }, + { + "name": "type", + "type": "str", + "description": "Type of the entity.", + "default": "", + "optional": false + }, + { + "name": "formatted_price", + "type": "str", + "description": "Formatted price.", + "default": "", + "optional": false + }, + { + "name": "formatted_volume", + "type": "str", + "description": "Formatted volume.", + "default": "", + "optional": false + }, + { + "name": "formatted_price_change", + "type": "str", + "description": "Formatted price change.", + "default": "", + "optional": false + }, + { + "name": "formatted_percent_change", + "type": "str", + "description": "Formatted percent change.", + "default": "", + "optional": false + }, + { + "name": "url", + "type": "str", + "description": "The source url.", + "default": "", + "optional": false + } + ] + }, + "model": "ETFGainers" + }, + "/etf/discovery/losers": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the top ETF losers.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the top ETF losers.\nobb.etf.discovery.losers(provider='wsj')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10, + "optional": true + }, + { + "name": "provider", + "type": "Literal['wsj']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'wsj' if there is no default.", + "default": "wsj", + "optional": true + } + ], + "wsj": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[ETFLosers]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['wsj']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false + }, + { + "name": "last_price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false + }, + { + "name": "net_change", + "type": "float", + "description": "Net change.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + } + ], + "wsj": [ + { + "name": "bluegrass_channel", + "type": "str", + "description": "Bluegrass channel.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Country of the entity.", + "default": "", + "optional": false + }, + { + "name": "mantissa", + "type": "int", + "description": "Mantissa.", + "default": "", + "optional": false + }, + { + "name": "type", + "type": "str", + "description": "Type of the entity.", + "default": "", + "optional": false + }, + { + "name": "formatted_price", + "type": "str", + "description": "Formatted price.", + "default": "", + "optional": false + }, + { + "name": "formatted_volume", + "type": "str", + "description": "Formatted volume.", + "default": "", + "optional": false + }, + { + "name": "formatted_price_change", + "type": "str", + "description": "Formatted price change.", + "default": "", + "optional": false + }, + { + "name": "formatted_percent_change", + "type": "str", + "description": "Formatted percent change.", + "default": "", + "optional": false + }, + { + "name": "url", + "type": "str", + "description": "The source url.", + "default": "", + "optional": false + } + ] + }, + "model": "ETFLosers" + }, + "/etf/discovery/active": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the most active ETFs.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the most active ETFs.\nobb.etf.discovery.active(provider='wsj')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10, + "optional": true + }, + { + "name": "provider", + "type": "Literal['wsj']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'wsj' if there is no default.", + "default": "wsj", + "optional": true + } + ], + "wsj": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[ETFActive]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['wsj']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false + }, + { + "name": "last_price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false + }, + { + "name": "net_change", + "type": "float", + "description": "Net change.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + } + ], + "wsj": [ + { + "name": "country", + "type": "str", + "description": "Country of the entity.", + "default": "", + "optional": false + }, + { + "name": "mantissa", + "type": "int", + "description": "Mantissa.", + "default": "", + "optional": false + }, + { + "name": "type", + "type": "str", + "description": "Type of the entity.", + "default": "", + "optional": false + }, + { + "name": "formatted_price", + "type": "str", + "description": "Formatted price.", + "default": "", + "optional": false + }, + { + "name": "formatted_volume", + "type": "str", + "description": "Formatted volume.", + "default": "", + "optional": false + }, + { + "name": "formatted_price_change", + "type": "str", + "description": "Formatted price change.", + "default": "", + "optional": false + }, + { + "name": "formatted_percent_change", + "type": "str", + "description": "Formatted percent change.", + "default": "", + "optional": false + }, + { + "name": "url", + "type": "str", + "description": "The source url.", + "default": "", + "optional": false + } + ] + }, + "model": "ETFActive" + }, + "/etf/search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search for ETFs.\n\nAn empty query returns the full list of ETFs from the provider.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# An empty query returns the full list of ETFs from the provider.\nobb.etf.search(provider='fmp')\n# The query will return results from text-based fields containing the term.\nobb.etf.search(query='commercial real estate', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'tmx']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "exchange", + "type": "Literal['AMEX', 'NYSE', 'NASDAQ', 'ETF', 'TSX', 'EURONEXT']", + "description": "The exchange code the ETF trades on.", + "default": null, + "optional": true + }, + { + "name": "is_active", + "type": "Literal[True, False]", + "description": "Whether the ETF is actively trading.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "exchange", + "type": "Literal['xnas', 'arcx', 'bats', 'xnys', 'bvmf', 'xshg', 'xshe', 'xhkg', 'xbom', 'xnse', 'xidx', 'tase', 'xkrx', 'xkls', 'xmex', 'xses', 'roco', 'xtai', 'xbkk', 'xist']", + "description": "Target a specific exchange by providing the MIC code.", + "default": null, + "optional": true + } + ], + "tmx": [ + { + "name": "div_freq", + "type": "Literal['monthly', 'annually', 'quarterly']", + "description": "The dividend payment frequency.", + "default": null, + "optional": true + }, + { + "name": "sort_by", + "type": "Literal['nav', 'return_1m', 'return_3m', 'return_6m', 'return_1y', 'return_3y', 'return_ytd', 'beta_1y', 'volume_avg_daily', 'management_fee', 'distribution_yield', 'pb_ratio', 'pe_ratio']", + "description": "The column to sort by.", + "default": null, + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours.", + "default": true, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfSearch]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'tmx']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.(ETF)", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the ETF.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "market_cap", + "type": "float", + "description": "The market cap of the ETF.", + "default": null, + "optional": true + }, + { + "name": "sector", + "type": "str", + "description": "The sector of the ETF.", + "default": null, + "optional": true + }, + { + "name": "industry", + "type": "str", + "description": "The industry of the ETF.", + "default": null, + "optional": true + }, + { + "name": "beta", + "type": "float", + "description": "The beta of the ETF.", + "default": null, + "optional": true + }, + { + "name": "price", + "type": "float", + "description": "The current price of the ETF.", + "default": null, + "optional": true + }, + { + "name": "last_annual_dividend", + "type": "float", + "description": "The last annual dividend paid.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "float", + "description": "The current trading volume of the ETF.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "The exchange code the ETF trades on.", + "default": null, + "optional": true + }, + { + "name": "exchange_name", + "type": "str", + "description": "The full name of the exchange the ETF trades on.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "The country the ETF is registered in.", + "default": null, + "optional": true + }, + { + "name": "actively_trading", + "type": "Literal[True, False]", + "description": "Whether the ETF is actively trading.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "exchange", + "type": "str", + "description": "The exchange MIC code.", + "default": null, + "optional": true + }, + { + "name": "figi_ticker", + "type": "str", + "description": "The OpenFIGI ticker.", + "default": null, + "optional": true + }, + { + "name": "ric", + "type": "str", + "description": "The Reuters Instrument Code.", + "default": null, + "optional": true + }, + { + "name": "isin", + "type": "str", + "description": "The International Securities Identification Number.", + "default": null, + "optional": true + }, + { + "name": "sedol", + "type": "str", + "description": "The Stock Exchange Daily Official List.", + "default": null, + "optional": true + }, + { + "name": "intrinio_id", + "type": "str", + "description": "The unique Intrinio ID for the security.", + "default": null, + "optional": true + } + ], + "tmx": [ + { + "name": "short_name", + "type": "str", + "description": "The short name of the ETF.", + "default": null, + "optional": true + }, + { + "name": "inception_date", + "type": "str", + "description": "The inception date of the ETF.", + "default": null, + "optional": true + }, + { + "name": "issuer", + "type": "str", + "description": "The issuer of the ETF.", + "default": null, + "optional": true + }, + { + "name": "investment_style", + "type": "str", + "description": "The investment style of the ETF.", + "default": null, + "optional": true + }, + { + "name": "esg", + "type": "bool", + "description": "Whether the ETF qualifies as an ESG fund.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "The currency of the ETF.", + "default": "", + "optional": false + }, + { + "name": "unit_price", + "type": "float", + "description": "The unit price of the ETF.", + "default": null, + "optional": true + }, + { + "name": "close", + "type": "float", + "description": "The closing price of the ETF.", + "default": "", + "optional": false + }, + { + "name": "prev_close", + "type": "float", + "description": "The previous closing price of the ETF.", + "default": null, + "optional": true + }, + { + "name": "return_1m", + "type": "float", + "description": "The one-month return of the ETF, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "return_3m", + "type": "float", + "description": "The three-month return of the ETF, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "return_6m", + "type": "float", + "description": "The six-month return of the ETF, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "return_ytd", + "type": "float", + "description": "The year-to-date return of the ETF, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "return_1y", + "type": "float", + "description": "The one-year return of the ETF, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "beta_1y", + "type": "float", + "description": "The one-year beta of the ETF, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "return_3y", + "type": "float", + "description": "The three-year return of the ETF, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "beta_3y", + "type": "float", + "description": "The three-year beta of the ETF, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "return_5y", + "type": "float", + "description": "The five-year return of the ETF, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "beta_5y", + "type": "float", + "description": "The five-year beta of the ETF, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "return_10y", + "type": "float", + "description": "The ten-year return of the ETF, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "beta_10y", + "type": "float", + "description": "The ten-year beta of the ETF.", + "default": null, + "optional": true + }, + { + "name": "beta_15y", + "type": "float", + "description": "The fifteen-year beta of the ETF.", + "default": null, + "optional": true + }, + { + "name": "return_from_inception", + "type": "float", + "description": "The return from inception of the ETF, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "avg_volume", + "type": "int", + "description": "The average daily volume of the ETF.", + "default": null, + "optional": true + }, + { + "name": "avg_volume_30d", + "type": "int", + "description": "The 30-day average volume of the ETF.", + "default": null, + "optional": true + }, + { + "name": "aum", + "type": "float", + "description": "The AUM of the ETF.", + "default": null, + "optional": true + }, + { + "name": "pe_ratio", + "type": "float", + "description": "The price-to-earnings ratio of the ETF.", + "default": null, + "optional": true + }, + { + "name": "pb_ratio", + "type": "float", + "description": "The price-to-book ratio of the ETF.", + "default": null, + "optional": true + }, + { + "name": "management_fee", + "type": "float", + "description": "The management fee of the ETF, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "mer", + "type": "float", + "description": "The management expense ratio of the ETF, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "distribution_yield", + "type": "float", + "description": "The distribution yield of the ETF, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "dividend_frequency", + "type": "str", + "description": "The dividend payment frequency of the ETF.", + "default": null, + "optional": true + } + ] + }, + "model": "EtfSearch" + }, + "/etf/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "ETF Historical Market Price.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.historical(symbol='SPY', provider='fmp')\nobb.etf.historical(symbol='SPY', provider='yfinance')\n# This function accepts multiple tickers.\nobb.etf.historical(symbol='SPY,IWM,QQQ,DJIA', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance.", + "default": "", + "optional": false + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default.", + "default": "alpha_vantage", + "optional": true + } + ], + "alpha_vantage": [ + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '60m', '1d', '1W', '1M']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "adjustment", + "type": "Literal['splits_only', 'splits_and_dividends', 'unadjusted']", + "description": "The adjustment factor to apply. 'splits_only' is not supported for intraday data.", + "default": "splits_only", + "optional": true + }, + { + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": false, + "optional": true + }, + { + "name": "adjusted", + "type": "bool", + "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead.", + "default": false, + "optional": true + } + ], + "cboe": [ + { + "name": "interval", + "type": "Literal['1m', '1d']", + "description": "Time interval of the data to return. The most recent trading day is not including in daily historical data. Intraday data is only available for the most recent trading day at 1 minute intervals.", + "default": "1d", + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass.", + "default": true, + "optional": true + } + ], + "fmp": [ + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", + "default": "", + "optional": false + }, + { + "name": "interval", + "type": "Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "start_time", + "type": "datetime.time", + "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'.", + "default": null, + "optional": true + }, + { + "name": "end_time", + "type": "datetime.time", + "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'.", + "default": null, + "optional": true + }, + { + "name": "timezone", + "type": "str", + "description": "Timezone of the data, in the IANA format (Continent/City).", + "default": "America/New_York", + "optional": true + }, + { + "name": "source", + "type": "Literal['realtime', 'delayed', 'nasdaq_basic']", + "description": "The source of the data.", + "default": "realtime", + "optional": true + } + ], + "polygon": [ + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", + "default": "1d", + "optional": true + }, + { + "name": "adjustment", + "type": "Literal['splits_only', 'unadjusted']", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", + "optional": true + }, + { + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": false, + "optional": true + }, + { + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", + "default": "asc", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 49999, + "optional": true + } + ], + "tiingo": [ + { + "name": "interval", + "type": "Literal['1d', '1W', '1M', '1Y']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + } + ], + "tmx": [ + { + "name": "interval", + "type": "Union[Literal['1m', '2m', '5m', '15m', '30m', '60m', '1h', '1d', '1W', '1M'], str, int]", + "description": "Time interval of the data to return. Or, any integer (entered as a string) representing the number of minutes. Default is daily data. There is no extended hours data, and intraday data is limited to after April 12 2022.", + "default": "day", + "optional": true + }, + { + "name": "adjustment", + "type": "Literal['splits_only', 'splits_and_dividends', 'unadjusted']", + "description": "The adjustment factor to apply. Only valid for daily data.", + "default": "splits_only", + "optional": true + } + ], + "tradier": [ + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '1d', '1W', '1M']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": false, + "optional": true + } + ], + "yfinance": [ + { + "name": "interval", + "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": false, + "optional": true + }, + { + "name": "include_actions", + "type": "bool", + "description": "Include dividends and stock splits in results.", + "default": true, + "optional": true + }, + { + "name": "adjustment", + "type": "Literal['splits_only', 'splits_and_dividends']", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", + "optional": true + }, + { + "name": "adjusted", + "type": "bool", + "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead.", + "default": false, + "optional": true + }, + { + "name": "prepost", + "type": "bool", + "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfHistorical]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": "", + "optional": false + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": "", + "optional": false + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "Union[float, int]", + "description": "The trading volume.", + "default": null, + "optional": true + }, + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true + } + ], + "alpha_vantage": [ + { + "name": "adj_close", + "type": "Annotated[float, Gt(gt=0)]", + "description": "The adjusted close price.", + "default": null, + "optional": true + }, + { + "name": "dividend", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Dividend amount, if a dividend was paid.", + "default": null, + "optional": true + }, + { + "name": "split_ratio", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Split coefficient, if a split occurred.", + "default": null, + "optional": true + } + ], + "cboe": [ + { + "name": "calls_volume", + "type": "int", + "description": "Number of calls traded during the most recent trading period. Only valid if interval is 1m.", + "default": null, + "optional": true + }, + { + "name": "puts_volume", + "type": "int", + "description": "Number of puts traded during the most recent trading period. Only valid if interval is 1m.", + "default": null, + "optional": true + }, + { + "name": "total_options_volume", + "type": "int", + "description": "Total number of options traded during the most recent trading period. Only valid if interval is 1m.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": null, + "optional": true + }, + { + "name": "unadjusted_volume", + "type": "float", + "description": "Unadjusted volume of the symbol.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "Change in the price from the previous close.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in the price from the previous close, as a normalized percent.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "average", + "type": "float", + "description": "Average trade price of an individual equity during the interval.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "Change in the price of the symbol from the previous day.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Percent change in the price of the symbol from the previous day.", + "default": null, + "optional": true + }, + { + "name": "adj_open", + "type": "float", + "description": "The adjusted open price.", + "default": null, + "optional": true + }, + { + "name": "adj_high", + "type": "float", + "description": "The adjusted high price.", + "default": null, + "optional": true + }, + { + "name": "adj_low", + "type": "float", + "description": "The adjusted low price.", + "default": null, + "optional": true + }, + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": null, + "optional": true + }, + { + "name": "adj_volume", + "type": "float", + "description": "The adjusted volume.", + "default": null, + "optional": true + }, + { + "name": "fifty_two_week_high", + "type": "float", + "description": "52 week high price for the symbol.", + "default": null, + "optional": true + }, + { + "name": "fifty_two_week_low", + "type": "float", + "description": "52 week low price for the symbol.", + "default": null, + "optional": true + }, + { + "name": "factor", + "type": "float", + "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices.", + "default": null, + "optional": true + }, + { + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", + "default": null, + "optional": true + }, + { + "name": "dividend", + "type": "float", + "description": "Dividend amount, if a dividend was paid.", + "default": null, + "optional": true + }, + { + "name": "close_time", + "type": "datetime", + "description": "The timestamp that represents the end of the interval span.", + "default": null, + "optional": true + }, + { + "name": "interval", + "type": "str", + "description": "The data time frequency.", + "default": null, + "optional": true + }, + { + "name": "intra_period", + "type": "bool", + "description": "If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "transactions", + "type": "Annotated[int, Gt(gt=0)]", + "description": "Number of transactions for the symbol in the time period.", + "default": null, + "optional": true + } + ], + "tiingo": [ + { + "name": "adj_open", + "type": "float", + "description": "The adjusted open price.", + "default": null, + "optional": true + }, + { + "name": "adj_high", + "type": "float", + "description": "The adjusted high price.", + "default": null, + "optional": true + }, + { + "name": "adj_low", + "type": "float", + "description": "The adjusted low price.", + "default": null, + "optional": true + }, + { + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": null, + "optional": true + }, + { + "name": "adj_volume", + "type": "float", + "description": "The adjusted volume.", + "default": null, + "optional": true + }, + { + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", + "default": null, + "optional": true + }, + { + "name": "dividend", + "type": "float", + "description": "Dividend amount, if a dividend was paid.", + "default": null, + "optional": true + } + ], + "tmx": [ + { + "name": "vwap", + "type": "float", + "description": "Volume weighted average price for the day.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "Change in price.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Change in price, as a normalized percentage.", + "default": null, + "optional": true + }, + { + "name": "transactions", + "type": "int", + "description": "Total number of transactions recorded.", + "default": null, + "optional": true + }, + { + "name": "transactions_value", + "type": "float", + "description": "Nominal value of recorded transactions.", + "default": null, + "optional": true + } + ], + "tradier": [ + { + "name": "last_price", + "type": "float", + "description": "The last price of the equity.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", + "default": null, + "optional": true + }, + { + "name": "dividend", + "type": "float", + "description": "Dividend amount (split-adjusted), if a dividend was paid.", + "default": null, + "optional": true + } + ] + }, + "model": "EtfHistorical" + }, + "/etf/info": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "ETF Information Overview.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.info(symbol='SPY', provider='fmp')\n# This function accepts multiple tickers.\nobb.etf.info(symbol='SPY,IWM,QQQ,DJIA', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, intrinio, tmx, yfinance.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'tmx', 'yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [], + "intrinio": [], + "tmx": [ + { + "name": "use_cache", + "type": "bool", + "description": "Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours.", + "default": true, + "optional": true + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfInfo]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'tmx', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. (ETF)", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the ETF.", + "default": "", + "optional": false + }, + { + "name": "description", + "type": "str", + "description": "Description of the fund.", + "default": null, + "optional": true + }, + { + "name": "inception_date", + "type": "str", + "description": "Inception date of the ETF.", + "default": "", + "optional": false + } + ], + "fmp": [ + { + "name": "issuer", + "type": "str", + "description": "Company of the ETF.", + "default": null, + "optional": true + }, + { + "name": "cusip", + "type": "str", + "description": "CUSIP of the ETF.", + "default": null, + "optional": true + }, + { + "name": "isin", + "type": "str", + "description": "ISIN of the ETF.", + "default": null, + "optional": true + }, + { + "name": "domicile", + "type": "str", + "description": "Domicile of the ETF.", + "default": null, + "optional": true + }, + { + "name": "asset_class", + "type": "str", + "description": "Asset class of the ETF.", + "default": null, + "optional": true + }, + { + "name": "aum", + "type": "float", + "description": "Assets under management.", + "default": null, + "optional": true + }, + { + "name": "nav", + "type": "float", + "description": "Net asset value of the ETF.", + "default": null, + "optional": true + }, + { + "name": "nav_currency", + "type": "str", + "description": "Currency of the ETF's net asset value.", + "default": null, + "optional": true + }, + { + "name": "expense_ratio", + "type": "float", + "description": "The expense ratio, as a normalized percent.", + "default": null, + "optional": true + }, + { + "name": "holdings_count", + "type": "int", + "description": "Number of holdings.", + "default": null, + "optional": true + }, + { + "name": "avg_volume", + "type": "float", + "description": "Average daily trading volume.", + "default": null, + "optional": true + }, + { + "name": "website", + "type": "str", + "description": "Website of the issuer.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "fund_listing_date", + "type": "date", + "description": "The date on which the Exchange Traded Product (ETP) or share class of the ETP is listed on a specific exchange.", + "default": null, + "optional": true + }, + { + "name": "data_change_date", + "type": "date", + "description": "The last date on which there was a change in a classifications data field for this ETF.", + "default": null, + "optional": true + }, + { + "name": "etn_maturity_date", + "type": "date", + "description": "If the product is an ETN, this field identifies the maturity date for the ETN.", + "default": null, + "optional": true + }, + { + "name": "is_listed", + "type": "bool", + "description": "If true, the ETF is still listed on an exchange.", + "default": null, + "optional": true + }, + { + "name": "close_date", + "type": "date", + "description": "The date on which the ETF was de-listed if it is no longer listed.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "The exchange Market Identifier Code (MIC).", + "default": null, + "optional": true + }, + { + "name": "isin", + "type": "str", + "description": "International Securities Identification Number (ISIN).", + "default": null, + "optional": true + }, + { + "name": "ric", + "type": "str", + "description": "Reuters Instrument Code (RIC).", + "default": null, + "optional": true + }, + { + "name": "sedol", + "type": "str", + "description": "Stock Exchange Daily Official List (SEDOL).", + "default": null, + "optional": true + }, + { + "name": "figi_symbol", + "type": "str", + "description": "Financial Instrument Global Identifier (FIGI) symbol.", + "default": null, + "optional": true + }, + { + "name": "share_class_figi", + "type": "str", + "description": "Financial Instrument Global Identifier (FIGI).", + "default": null, + "optional": true + }, + { + "name": "firstbridge_id", + "type": "str", + "description": "The FirstBridge unique identifier for the Exchange Traded Fund (ETF).", + "default": null, + "optional": true + }, + { + "name": "firstbridge_parent_id", + "type": "str", + "description": "The FirstBridge unique identifier for the parent Exchange Traded Fund (ETF), if applicable.", + "default": null, + "optional": true + }, + { + "name": "intrinio_id", + "type": "str", + "description": "Intrinio unique identifier for the security.", + "default": null, + "optional": true + }, + { + "name": "intraday_nav_symbol", + "type": "str", + "description": "Intraday Net Asset Value (NAV) symbol.", + "default": null, + "optional": true + }, + { + "name": "primary_symbol", + "type": "str", + "description": "The primary ticker field is used for Exchange Traded Products (ETPs) that have multiple listings and share classes. If an ETP has multiple listings or share classes, the same primary ticker is assigned to all the listings and share classes.", + "default": null, + "optional": true + }, + { + "name": "etp_structure_type", + "type": "str", + "description": "Classifies Exchange Traded Products (ETPs) into very broad categories based on its legal structure.", + "default": null, + "optional": true + }, + { + "name": "legal_structure", + "type": "str", + "description": "Legal structure of the fund.", + "default": null, + "optional": true + }, + { + "name": "issuer", + "type": "str", + "description": "Issuer of the ETF.", + "default": null, + "optional": true + }, + { + "name": "etn_issuing_bank", + "type": "str", + "description": "If the product is an Exchange Traded Note (ETN), this field identifies the issuing bank.", + "default": null, + "optional": true + }, + { + "name": "fund_family", + "type": "str", + "description": "This field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor.", + "default": null, + "optional": true + }, + { + "name": "investment_style", + "type": "str", + "description": "Investment style of the ETF.", + "default": null, + "optional": true + }, + { + "name": "derivatives_based", + "type": "str", + "description": "This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio.", + "default": null, + "optional": true + }, + { + "name": "income_category", + "type": "str", + "description": "Identifies if an Exchange Traded Fund (ETF) falls into a category that is specifically designed to provide a high yield or income", + "default": null, + "optional": true + }, + { + "name": "asset_class", + "type": "str", + "description": "Captures the underlying nature of the securities in the Exchanged Traded Product (ETP).", + "default": null, + "optional": true + }, + { + "name": "other_asset_types", + "type": "str", + "description": "If 'asset_class' field is classified as 'Other Asset Types' this field captures the specific category of the underlying assets.", + "default": null, + "optional": true + }, + { + "name": "single_category_designation", + "type": "str", + "description": "This categorization is created for those users who want every ETF to be 'forced' into a single bucket, so that the assets for all categories will always sum to the total market.", + "default": null, + "optional": true + }, + { + "name": "beta_type", + "type": "str", + "description": "This field identifies whether an ETF provides 'Traditional' beta exposure or 'Smart' beta exposure. ETFs that are active (i.e. non-indexed), leveraged / inverse or have a proprietary quant model (i.e. that don't provide indexed exposure to a targeted factor) are classified separately.", + "default": null, + "optional": true + }, + { + "name": "beta_details", + "type": "str", + "description": "This field provides further detail within the traditional and smart beta categories.", + "default": null, + "optional": true + }, + { + "name": "market_cap_range", + "type": "str", + "description": "Equity ETFs are classified as falling into categories based on the description of their investment strategy in the prospectus. Examples ('Mega Cap', 'Large Cap', 'Mid Cap', etc.)", + "default": null, + "optional": true + }, + { + "name": "market_cap_weighting_type", + "type": "str", + "description": "For ETFs that take the value 'Market Cap Weighted' in the 'index_weighting_scheme' field, this field provides detail on the market cap weighting type.", + "default": null, + "optional": true + }, + { + "name": "index_weighting_scheme", + "type": "str", + "description": "For ETFs that track an underlying index, this field provides detail on the index weighting type.", + "default": null, + "optional": true + }, + { + "name": "index_linked", + "type": "str", + "description": "This field identifies whether an ETF is index linked or active.", + "default": null, + "optional": true + }, + { + "name": "index_name", + "type": "str", + "description": "This field identifies the name of the underlying index tracked by the ETF, if applicable.", + "default": null, + "optional": true + }, + { + "name": "index_symbol", + "type": "str", + "description": "This field identifies the OpenFIGI ticker for the Index underlying the ETF.", + "default": null, + "optional": true + }, + { + "name": "parent_index", + "type": "str", + "description": "This field identifies the name of the parent index, which represents the broader universe from which the index underlying the ETF is created, if applicable.", + "default": null, + "optional": true + }, + { + "name": "index_family", + "type": "str", + "description": "This field identifies the index family to which the index underlying the ETF belongs. The index family is represented as categorized by the index provider.", + "default": null, + "optional": true + }, + { + "name": "broader_index_family", + "type": "str", + "description": "This field identifies the broader index family to which the index underlying the ETF belongs. The broader index family is represented as categorized by the index provider.", + "default": null, + "optional": true + }, + { + "name": "index_provider", + "type": "str", + "description": "This field identifies the Index provider for the index underlying the ETF, if applicable.", + "default": null, + "optional": true + }, + { + "name": "index_provider_code", + "type": "str", + "description": "This field provides the First Bridge code for each Index provider, corresponding to the index underlying the ETF if applicable.", + "default": null, + "optional": true + }, + { + "name": "replication_structure", + "type": "str", + "description": "The replication structure of the Exchange Traded Product (ETP).", + "default": null, + "optional": true + }, + { + "name": "growth_value_tilt", + "type": "str", + "description": "Classifies equity ETFs as either 'Growth' or Value' based on the stated style tilt in the ETF prospectus. Equity ETFs that do not have a stated style tilt are classified as 'Core / Blend'.", + "default": null, + "optional": true + }, + { + "name": "growth_type", + "type": "str", + "description": "For ETFs that are classified as 'Growth' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their growth (style factor) scores.", + "default": null, + "optional": true + }, + { + "name": "value_type", + "type": "str", + "description": "For ETFs that are classified as 'Value' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their value (style factor) scores.", + "default": null, + "optional": true + }, + { + "name": "sector", + "type": "str", + "description": "For equity ETFs that aim to provide targeted exposure to a sector or industry, this field identifies the Sector that it provides the exposure to.", + "default": null, + "optional": true + }, { - "name": "symbol", + "name": "industry", "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false + "description": "For equity ETFs that aim to provide targeted exposure to an industry, this field identifies the Industry that it provides the exposure to.", + "default": null, + "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 500, + "name": "industry_group", + "type": "str", + "description": "For equity ETFs that aim to provide targeted exposure to a sub-industry, this field identifies the sub-Industry that it provides the exposure to.", + "default": null, "optional": true }, { - "name": "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", + "name": "cross_sector_theme", + "type": "str", + "description": "For equity ETFs that aim to provide targeted exposure to a specific investment theme that cuts across GICS sectors, this field identifies the specific cross-sector theme. Examples ('Agri-business', 'Natural Resources', 'Green Investing', etc.)", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "transaction_type", - "type": "Literal[None, 'award', 'conversion', 'return', 'expire_short', 'in_kind', 'gift', 'expire_long', 'discretionary', 'other', 'small', 'exempt', 'otm', 'purchase', 'sale', 'tender', 'will', 'itm', 'trust']", - "description": "Type of the transaction.", + "name": "natural_resources_type", + "type": "str", + "description": "For ETFs that are classified as 'Natural Resources' in the 'cross_sector_theme' field, this field provides further detail on the type of Natural Resources exposure.", "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": "", - "optional": false + "name": "us_or_excludes_us", + "type": "str", + "description": "Takes the value of 'Domestic' for US exposure, 'International' for non-US exposure and 'Global' for exposure that includes all regions including the US.", + "default": null, + "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": "", - "optional": false + "name": "developed_emerging", + "type": "str", + "description": "This field identifies the stage of development of the markets that the ETF provides exposure to.", + "default": null, + "optional": true }, { - "name": "ownership_type", - "type": "Literal['D', 'I']", - "description": "Type of ownership.", + "name": "specialized_region", + "type": "str", + "description": "This field is populated if the ETF provides targeted exposure to a specific type of geography-based grouping that does not fall into a specific country or continent grouping. Examples ('BRIC', 'Chindia', etc.)", "default": null, "optional": true }, { - "name": "sort_by", - "type": "Literal['filing_date', 'updated_on']", - "description": "Field to sort by.", - "default": "updated_on", + "name": "continent", + "type": "str", + "description": "This field is populated if the ETF provides targeted exposure to a specific continent or country within that Continent.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[InsiderTrading]", - "description": "Serializable results." + "name": "latin_america_sub_group", + "type": "str", + "description": "For ETFs that are classified as 'Latin America' in the 'continent' field, this field provides further detail on the type of regional exposure.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio']]", - "description": "Provider name." + "name": "europe_sub_group", + "type": "str", + "description": "For ETFs that are classified as 'Europe' in the 'continent' field, this field provides further detail on the type of regional exposure.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "asia_sub_group", + "type": "str", + "description": "For ETFs that are classified as 'Asia' in the 'continent' field, this field provides further detail on the type of regional exposure.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "specific_country", + "type": "str", + "description": "This field is populated if the ETF provides targeted exposure to a specific country.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "china_listing_location", + "type": "str", + "description": "For ETFs that are classified as 'China' in the 'country' field, this field provides further detail on the type of exposure in the underlying securities.", + "default": null, + "optional": true + }, { - "name": "symbol", + "name": "us_state", "type": "str", - "description": "Symbol representing the entity requested in the data.", + "description": "Takes the value of a US state if the ETF provides targeted exposure to the municipal bonds or equities of companies.", "default": null, "optional": true }, { - "name": "company_cik", - "type": "Union[int, str]", - "description": "CIK number of the company.", + "name": "real_estate", + "type": "str", + "description": "For ETFs that provide targeted real estate exposure, this field is populated if the ETF provides targeted exposure to a specific segment of the real estate market.", "default": null, "optional": true }, { - "name": "filing_date", - "type": "Union[date, datetime]", - "description": "Filing date of the trade.", + "name": "fundamental_weighting_type", + "type": "str", + "description": "For ETFs that take the value 'Fundamental Weighted' in the 'index_weighting_scheme' field, this field provides detail on the fundamental weighting methodology.", "default": null, "optional": true }, { - "name": "transaction_date", - "type": "date", - "description": "Date of the transaction.", + "name": "dividend_weighting_type", + "type": "str", + "description": "For ETFs that take the value 'Dividend Weighted' in the 'index_weighting_scheme' field, this field provides detail on the dividend weighting methodology.", "default": null, "optional": true }, { - "name": "owner_cik", - "type": "Union[int, str]", - "description": "Reporting individual's CIK.", + "name": "bond_type", + "type": "str", + "description": "For ETFs where 'asset_class_type' is 'Bonds', this field provides detail on the type of bonds held in the ETF.", "default": null, "optional": true }, { - "name": "owner_name", + "name": "government_bond_types", "type": "str", - "description": "Name of the reporting individual.", + "description": "For bond ETFs that take the value 'Treasury & Government' in 'bond_type', this field provides detail on the exposure.", "default": null, "optional": true }, { - "name": "owner_title", + "name": "municipal_bond_region", "type": "str", - "description": "The title held by the reporting individual.", + "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field provides additional detail on the geographic exposure.", "default": null, "optional": true }, { - "name": "transaction_type", + "name": "municipal_vrdo", + "type": "bool", + "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field identifies those ETFs that specifically provide exposure to Variable Rate Demand Obligations.", + "default": null, + "optional": true + }, + { + "name": "mortgage_bond_types", "type": "str", - "description": "Type of transaction being reported.", + "description": "For bond ETFs that take the value 'Mortgage' in 'bond_type', this field provides additional detail on the type of underlying securities.", "default": null, "optional": true }, { - "name": "acquisition_or_disposition", + "name": "bond_tax_status", "type": "str", - "description": "Acquisition or disposition of the shares.", + "description": "For all US bond ETFs, this field provides additional detail on the tax treatment of the underlying securities.", "default": null, "optional": true }, { - "name": "security_type", + "name": "credit_quality", "type": "str", - "description": "The type of security transacted.", + "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific credit quality range.", "default": null, "optional": true }, { - "name": "securities_owned", - "type": "float", - "description": "Number of securities owned by the reporting individual.", + "name": "average_maturity", + "type": "str", + "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific maturity range.", "default": null, "optional": true }, { - "name": "securities_transacted", - "type": "float", - "description": "Number of securities transacted by the reporting individual.", + "name": "specific_maturity_year", + "type": "int", + "description": "For all bond ETFs that take the value 'Specific Maturity Year' in the 'average_maturity' field, this field specifies the calendar year.", "default": null, "optional": true }, { - "name": "transaction_price", - "type": "float", - "description": "The price of the transaction.", + "name": "commodity_types", + "type": "str", + "description": "For ETFs where 'asset_class_type' is 'Commodities', this field provides detail on the type of commodities held in the ETF.", "default": null, "optional": true }, { - "name": "filing_url", + "name": "energy_type", "type": "str", - "description": "Link to the filing.", + "description": "For ETFs where 'commodity_type' is 'Energy', this field provides detail on the type of energy exposure provided by the ETF.", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "form_type", + "name": "agricultural_type", "type": "str", - "description": "Form type of the insider trading.", - "default": "", - "optional": false - } - ], - "intrinio": [ + "description": "For ETFs where 'commodity_type' is 'Agricultural', this field provides detail on the type of agricultural exposure provided by the ETF.", + "default": null, + "optional": true + }, { - "name": "filing_url", + "name": "livestock_type", "type": "str", - "description": "URL of the filing.", + "description": "For ETFs where 'commodity_type' is 'Livestock', this field provides detail on the type of livestock exposure provided by the ETF.", "default": null, "optional": true }, { - "name": "company_name", + "name": "metal_type", "type": "str", - "description": "Name of the company.", - "default": "", - "optional": false + "description": "For ETFs where 'commodity_type' is 'Gold & Metals', this field provides detail on the type of exposure provided by the ETF.", + "default": null, + "optional": true }, { - "name": "conversion_exercise_price", - "type": "float", - "description": "Conversion/Exercise price of the shares.", + "name": "inverse_leveraged", + "type": "str", + "description": "This field is populated if the ETF provides inverse or leveraged exposure.", "default": null, "optional": true }, { - "name": "deemed_execution_date", - "type": "date", - "description": "Deemed execution date of the trade.", + "name": "target_date_multi_asset_type", + "type": "str", + "description": "For ETFs where 'asset_class_type' is 'Target Date / MultiAsset', this field provides detail on the type of commodities held in the ETF.", "default": null, "optional": true }, { - "name": "exercise_date", - "type": "date", - "description": "Exercise date of the trade.", + "name": "currency_pair", + "type": "str", + "description": "This field is populated if the ETF's strategy involves providing exposure to the movements of a currency or involves hedging currency exposure.", "default": null, "optional": true }, { - "name": "expiration_date", - "type": "date", - "description": "Expiration date of the derivative.", + "name": "social_environmental_type", + "type": "str", + "description": "This field is populated if the ETF's strategy involves providing exposure to a specific social or environmental theme.", "default": null, "optional": true }, { - "name": "underlying_security_title", + "name": "clean_energy_type", "type": "str", - "description": "Name of the underlying non-derivative security related to this derivative transaction.", + "description": "This field is populated if the ETF has a value of 'Clean Energy' in the 'social_environmental_type' field.", "default": null, "optional": true }, { - "name": "underlying_shares", - "type": "Union[int, float]", - "description": "Number of underlying shares related to this derivative transaction.", + "name": "dividend_type", + "type": "str", + "description": "This field is populated if the ETF has an intended investment objective of holding dividend-oriented stocks as stated in the prospectus.", "default": null, "optional": true }, { - "name": "nature_of_ownership", + "name": "regular_dividend_payor_type", "type": "str", - "description": "Nature of ownership of the insider trading.", + "description": "This field is populated if the ETF has a value of'Dividend - Regular Payors' in the 'dividend_type' field.", "default": null, "optional": true }, { - "name": "director", - "type": "bool", - "description": "Whether the owner is a director.", + "name": "quant_strategies_type", + "type": "str", + "description": "This field is populated if the ETF has either an index-linked or active strategy that is based on a proprietary quantitative strategy.", "default": null, "optional": true }, { - "name": "officer", - "type": "bool", - "description": "Whether the owner is an officer.", + "name": "other_quant_models", + "type": "str", + "description": "For ETFs where 'quant_strategies_type' is 'Other Quant Model', this field provides the name of the specific proprietary quant model used as the underlying strategy for the ETF.", "default": null, "optional": true }, { - "name": "ten_percent_owner", - "type": "bool", - "description": "Whether the owner is a 10% owner.", + "name": "hedge_fund_type", + "type": "str", + "description": "For ETFs where 'other_asset_types' is 'Hedge Fund Replication', this field provides detail on the type of hedge fund replication strategy.", "default": null, "optional": true }, { - "name": "other_relation", + "name": "excludes_financials", "type": "bool", - "description": "Whether the owner is having another relation.", + "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold financials stocks, based on the funds intended objective.", "default": null, "optional": true }, { - "name": "derivative_transaction", + "name": "excludes_technology", "type": "bool", - "description": "Whether the owner is having a derivative transaction.", + "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold technology stocks, based on the funds intended objective.", "default": null, "optional": true }, { - "name": "report_line_number", - "type": "int", - "description": "Report line number of the insider trading.", + "name": "holds_only_nyse_stocks", + "type": "bool", + "description": "If true, the ETF is an equity ETF and holds only stocks listed on NYSE.", "default": null, "optional": true - } - ] - }, - "model": "InsiderTrading" - }, - "/equity/ownership/share_statistics": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get data about share float for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.share_statistics(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", - "default": "", - "optional": false }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "holds_only_nasdaq_stocks", + "type": "bool", + "description": "If true, the ETF is an equity ETF and holds only stocks listed on Nasdaq.", + "default": null, "optional": true - } - ], - "fmp": [], - "intrinio": [], - "yfinance": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[ShareStatistics]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false }, { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "holds_mlp", + "type": "bool", + "description": "If true, the ETF's investment objective explicitly specifies that it holds MLPs as an intended part of its investment strategy.", "default": null, "optional": true }, { - "name": "free_float", - "type": "float", - "description": "Percentage of unrestricted shares of a publicly-traded company.", + "name": "holds_preferred_stock", + "type": "bool", + "description": "If true, the ETF's investment objective explicitly specifies that it holds preferred stock as an intended part of its investment strategy.", "default": null, "optional": true }, { - "name": "float_shares", - "type": "float", - "description": "Number of shares available for trading by the general public.", + "name": "holds_closed_end_funds", + "type": "bool", + "description": "If true, the ETF's investment objective explicitly specifies that it holds closed end funds as an intended part of its investment strategy.", "default": null, "optional": true }, { - "name": "outstanding_shares", - "type": "float", - "description": "Total number of shares of a publicly-traded company.", + "name": "holds_adr", + "type": "bool", + "description": "If true, he ETF's investment objective explicitly specifies that it holds American Depositary Receipts (ADRs) as an intended part of its investment strategy.", "default": null, "optional": true }, { - "name": "source", - "type": "str", - "description": "Source of the received data.", + "name": "laddered", + "type": "bool", + "description": "For bond ETFs, this field identifies those ETFs that specifically hold bonds in a laddered structure, where the bonds are scheduled to mature in an annual, sequential structure.", "default": null, "optional": true - } - ], - "fmp": [], - "intrinio": [ + }, { - "name": "adjusted_outstanding_shares", - "type": "float", - "description": "Total number of shares of a publicly-traded company, adjusted for splits.", + "name": "zero_coupon", + "type": "bool", + "description": "For bond ETFs, this field identifies those ETFs that specifically hold zero coupon Treasury Bills.", "default": null, "optional": true }, { - "name": "public_float", - "type": "float", - "description": "Aggregate market value of the shares of a publicly-traded company.", + "name": "floating_rate", + "type": "bool", + "description": "For bond ETFs, this field identifies those ETFs that specifically hold floating rate bonds.", "default": null, "optional": true - } - ], - "yfinance": [ + }, { - "name": "implied_shares_outstanding", - "type": "int", - "description": "Implied Shares Outstanding of common equity, assuming the conversion of all convertible subsidiary equity into common.", + "name": "build_america_bonds", + "type": "bool", + "description": "For municipal bond ETFs, this field identifies those ETFs that specifically hold Build America Bonds.", "default": null, "optional": true }, { - "name": "short_interest", - "type": "int", - "description": "Number of shares that are reported short.", + "name": "dynamic_futures_roll", + "type": "bool", + "description": "If the product holds futures contracts, this field identifies those products where the roll strategy is dynamic (rather than entirely rules based), so as to minimize roll costs.", "default": null, "optional": true }, { - "name": "short_percent_of_float", - "type": "float", - "description": "Percentage of shares that are reported short, as a normalized percent.", + "name": "currency_hedged", + "type": "bool", + "description": "This field is populated if the ETF's strategy involves hedging currency exposure.", "default": null, "optional": true }, { - "name": "days_to_cover", - "type": "float", - "description": "Number of days to repurchase the shares as a ratio of average daily volume", + "name": "includes_short_exposure", + "type": "bool", + "description": "This field is populated if the ETF has short exposure in any of its holdings e.g. in a long/short or inverse ETF.", "default": null, "optional": true }, { - "name": "short_interest_prev_month", - "type": "int", - "description": "Number of shares that were reported short in the previous month.", + "name": "ucits", + "type": "bool", + "description": "If true, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant", "default": null, "optional": true }, { - "name": "short_interest_prev_date", - "type": "date", - "description": "Date of the previous month's report.", + "name": "registered_countries", + "type": "str", + "description": "The list of countries where the ETF is legally registered for sale. This may differ from where the ETF is domiciled or traded, particularly in Europe.", "default": null, "optional": true }, { - "name": "insider_ownership", - "type": "float", - "description": "Percentage of shares held by insiders, as a normalized percent.", + "name": "issuer_country", + "type": "str", + "description": "2 letter ISO country code for the country where the issuer is located.", "default": null, "optional": true }, { - "name": "institution_ownership", - "type": "float", - "description": "Percentage of shares held by institutions, as a normalized percent.", + "name": "domicile", + "type": "str", + "description": "2 letter ISO country code for the country where the ETP is domiciled.", "default": null, "optional": true }, { - "name": "institution_float_ownership", - "type": "float", - "description": "Percentage of float held by institutions, as a normalized percent.", + "name": "listing_country", + "type": "str", + "description": "2 letter ISO country code for the country of the primary listing.", "default": null, "optional": true }, { - "name": "institutions_count", - "type": "int", - "description": "Number of institutions holding shares.", + "name": "listing_region", + "type": "str", + "description": "Geographic region in the country of the primary listing falls.", "default": null, "optional": true - } - ] - }, - "model": "ShareStatistics" - }, - "/equity/ownership/form_13f": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the form 13F.\n\nThe Securities and Exchange Commission's (SEC) Form 13F is a quarterly report\nthat is required to be filed by all institutional investment managers with at least\n$100 million in assets under management.\nManagers are required to file Form 13F within 45 days after the last day of the calendar quarter.\nMost funds wait until the end of this period in order to conceal\ntheir investment strategy from competitors and the public.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.form_13f(symbol='NVDA', provider='sec')\n# Enter a date (calendar quarter ending) for a specific report.\nobb.equity.ownership.form_13f(symbol='BRK-A', date='2016-09-30', provider='sec')\n# Example finding Michael Burry's filings.\ncik = obb.regulators.sec.institutions_search(\"Scion Asset Management\").results[0].cik\n# Use the `limit` parameter to return N number of reports from the most recent.\nobb.equity.ownership.form_13f(cik, limit=2).to_df()\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for. A CIK or Symbol can be used.", - "default": "", - "optional": false }, { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported.", + "name": "bond_currency_denomination", + "type": "str", + "description": "For all bond ETFs, this field provides additional detail on the currency denomination of the underlying securities.", "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter.", - "default": 1, + "name": "base_currency", + "type": "str", + "description": "Base currency in which NAV is reported.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", - "default": "sec", + "name": "listing_currency", + "type": "str", + "description": "Listing currency of the Exchange Traded Product (ETP) in which it is traded. Reported using the 3-digit ISO currency code.", + "default": null, "optional": true - } - ], - "sec": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[Form13FHR]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['sec']]", - "description": "Provider name." + "name": "number_of_holdings", + "type": "int", + "description": "The number of holdings in the ETF.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "month_end_assets", + "type": "float", + "description": "Net assets in millions of dollars as of the most recent month end.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "net_expense_ratio", + "type": "float", + "description": "Gross expense net of Fee Waivers, as a percentage of net assets as published by the ETF issuer.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "etf_portfolio_turnover", + "type": "float", + "description": "The percentage of positions turned over in the last 12 months.", + "default": null, + "optional": true } - ] - }, - "data": { - "standard": [ + ], + "tmx": [ { - "name": "period_ending", - "type": "date", - "description": "The end-of-quarter date of the filing.", - "default": "", - "optional": false + "name": "description", + "type": "str", + "description": "The description of the ETF.", + "default": null, + "optional": true }, { "name": "issuer", "type": "str", - "description": "The name of the issuer.", - "default": "", - "optional": false + "description": "The issuer of the ETF.", + "default": null, + "optional": true }, { - "name": "cusip", + "name": "investment_style", "type": "str", - "description": "The CUSIP of the security.", - "default": "", - "optional": false + "description": "The investment style of the ETF.", + "default": null, + "optional": true }, { - "name": "asset_class", + "name": "esg", + "type": "bool", + "description": "Whether the ETF qualifies as an ESG fund.", + "default": null, + "optional": true + }, + { + "name": "currency", "type": "str", - "description": "The title of the asset class for the security.", + "description": "The currency of the ETF.", "default": "", "optional": false }, { - "name": "security_type", - "type": "Literal['SH', 'PRN']", - "description": "The total number of shares of the class of security or the principal amount of such class. 'SH' for shares. 'PRN' for principal amount. Convertible debt securities are reported as 'PRN'.", + "name": "unit_price", + "type": "float", + "description": "The unit price of the ETF.", "default": null, "optional": true }, { - "name": "option_type", - "type": "Literal['call', 'put']", - "description": "Defined when the holdings being reported are put or call options. Only long positions are reported.", - "default": null, - "optional": true + "name": "close", + "type": "float", + "description": "The closing price of the ETF.", + "default": "", + "optional": false }, { - "name": "voting_authority_sole", - "type": "int", - "description": "The number of shares for which the Manager exercises sole voting authority (none).", + "name": "prev_close", + "type": "float", + "description": "The previous closing price of the ETF.", "default": null, "optional": true }, { - "name": "voting_authority_shared", - "type": "int", - "description": "The number of shares for which the Manager exercises a defined shared voting authority (none).", + "name": "return_1m", + "type": "float", + "description": "The one-month return of the ETF, as a normalized percent", "default": null, "optional": true }, { - "name": "voting_authority_other", - "type": "int", - "description": "The number of shares for which the Manager exercises other shared voting authority (none).", + "name": "return_3m", + "type": "float", + "description": "The three-month return of the ETF, as a normalized percent.", "default": null, "optional": true }, { - "name": "principal_amount", - "type": "int", - "description": "The total number of shares of the class of security or the principal amount of such class. Only long positions are reported", - "default": "", - "optional": false + "name": "return_6m", + "type": "float", + "description": "The six-month return of the ETF, as a normalized percent.", + "default": null, + "optional": 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 - } - ], - "sec": [ - { - "name": "weight", + "name": "return_ytd", "type": "float", - "description": "The weight of the security relative to the market value of all securities in the filing , as a normalized percent.", - "default": "", - "optional": false - } - ] - }, - "model": "Form13FHR" - }, - "/equity/price/quote": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the latest quote for a given stock. Quote includes price, volume, and other data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.quote(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", - "default": "", - "optional": false + "description": "The year-to-date return of the ETF, as a normalized percent.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "return_1y", + "type": "float", + "description": "The one-year return of the ETF, as a normalized percent.", + "default": null, "optional": true - } - ], - "fmp": [], - "intrinio": [ - { - "name": "symbol", - "type": "str", - "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", - "default": "", - "optional": false }, { - "name": "source", - "type": "Literal['iex', 'bats', 'bats_delayed', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed', 'intrinio_mx', 'intrinio_mx_plus', 'delayed_sip']", - "description": "Source of the data.", - "default": "iex", + "name": "return_3y", + "type": "float", + "description": "The three-year return of the ETF, as a normalized percent.", + "default": null, "optional": true - } - ], - "yfinance": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EquityQuote]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", - "description": "Provider name." + "name": "return_5y", + "type": "float", + "description": "The five-year return of the ETF, as a normalized percent.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "return_10y", + "type": "float", + "description": "The ten-year return of the ETF, as a normalized percent.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "return_from_inception", + "type": "float", + "description": "The return from inception of the ETF, as a normalized percent.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "avg_volume", + "type": "int", + "description": "The average daily volume of the ETF.", + "default": null, + "optional": true }, { - "name": "asset_type", - "type": "str", - "description": "Type of asset - i.e, stock, ETF, etc.", + "name": "avg_volume_30d", + "type": "int", + "description": "The 30-day average volume of the ETF.", "default": null, "optional": true }, { - "name": "name", - "type": "str", - "description": "Name of the company or asset.", + "name": "aum", + "type": "float", + "description": "The AUM of the ETF.", "default": null, "optional": true }, { - "name": "exchange", - "type": "str", - "description": "The name or symbol of the venue where the data is from.", + "name": "pe_ratio", + "type": "float", + "description": "The price-to-earnings ratio of the ETF.", "default": null, "optional": true }, { - "name": "bid", + "name": "pb_ratio", "type": "float", - "description": "Price of the top bid order.", + "description": "The price-to-book ratio of the ETF.", "default": null, "optional": true }, { - "name": "bid_size", - "type": "int", - "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", + "name": "management_fee", + "type": "float", + "description": "The management fee of the ETF, as a normalized percent.", "default": null, "optional": true }, { - "name": "bid_exchange", - "type": "str", - "description": "The specific trading venue where the purchase order was placed.", + "name": "mer", + "type": "float", + "description": "The management expense ratio of the ETF, as a normalized percent.", "default": null, "optional": true }, { - "name": "ask", + "name": "distribution_yield", "type": "float", - "description": "Price of the top ask order.", + "description": "The distribution yield of the ETF, as a normalized percent.", "default": null, "optional": true }, { - "name": "ask_size", - "type": "int", - "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", + "name": "dividend_frequency", + "type": "str", + "description": "The dividend payment frequency of the ETF.", "default": null, "optional": true }, { - "name": "ask_exchange", + "name": "website", "type": "str", - "description": "The specific trading venue where the sale order was placed.", + "description": "The website of the ETF.", "default": null, "optional": true - }, + } + ], + "yfinance": [ { - "name": "quote_conditions", - "type": "Union[str, int, List[str], List[int]]", - "description": "Conditions or condition codes applicable to the quote.", + "name": "fund_type", + "type": "str", + "description": "The legal type of fund.", "default": null, "optional": true }, { - "name": "quote_indicators", - "type": "Union[str, int, List[str], List[int]]", - "description": "Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO.", + "name": "fund_family", + "type": "str", + "description": "The fund family.", "default": null, "optional": true }, { - "name": "sales_conditions", - "type": "Union[str, int, List[str], List[int]]", - "description": "Conditions or condition codes applicable to the sale.", + "name": "category", + "type": "str", + "description": "The fund category.", "default": null, "optional": true }, { - "name": "sequence_number", - "type": "int", - "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11).", + "name": "exchange", + "type": "str", + "description": "The exchange the fund is listed on.", "default": null, "optional": true }, { - "name": "market_center", + "name": "exchange_timezone", "type": "str", - "description": "The ID of the UTP participant that originated the message.", + "description": "The timezone of the exchange.", "default": null, "optional": true }, { - "name": "participant_timestamp", - "type": "datetime", - "description": "Timestamp for when the quote was generated by the exchange.", + "name": "currency", + "type": "str", + "description": "The currency in which the fund is listed.", "default": null, "optional": true }, { - "name": "trf_timestamp", - "type": "datetime", - "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message.", + "name": "nav_price", + "type": "float", + "description": "The net asset value per unit of the fund.", "default": null, "optional": true }, { - "name": "sip_timestamp", - "type": "datetime", - "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange.", + "name": "total_assets", + "type": "int", + "description": "The total value of assets held by the fund.", "default": null, "optional": true }, { - "name": "last_price", + "name": "trailing_pe", "type": "float", - "description": "Price of the last trade.", + "description": "The trailing twelve month P/E ratio of the fund's assets.", "default": null, "optional": true }, { - "name": "last_tick", - "type": "str", - "description": "Whether the last sale was an up or down tick.", + "name": "dividend_yield", + "type": "float", + "description": "The dividend yield of the fund, as a normalized percent.", "default": null, "optional": true }, { - "name": "last_size", - "type": "int", - "description": "Size of the last trade.", + "name": "dividend_rate_ttm", + "type": "float", + "description": "The trailing twelve month annual dividend rate of the fund, in currency units.", "default": null, "optional": true }, { - "name": "last_timestamp", - "type": "datetime", - "description": "Date and Time when the last price was recorded.", + "name": "dividend_yield_ttm", + "type": "float", + "description": "The trailing twelve month annual dividend yield of the fund, as a normalized percent.", "default": null, "optional": true }, { - "name": "open", + "name": "year_high", "type": "float", - "description": "The open price.", + "description": "The fifty-two week high price.", "default": null, "optional": true }, { - "name": "high", + "name": "year_low", "type": "float", - "description": "The high price.", + "description": "The fifty-two week low price.", "default": null, "optional": true }, { - "name": "low", + "name": "ma_50d", "type": "float", - "description": "The low price.", + "description": "50-day moving average price.", "default": null, "optional": true }, { - "name": "close", + "name": "ma_200d", "type": "float", - "description": "The close price.", + "description": "200-day moving average price.", "default": null, "optional": true }, { - "name": "volume", - "type": "Union[int, float]", - "description": "The trading volume.", + "name": "return_ytd", + "type": "float", + "description": "The year-to-date return of the fund, as a normalized percent.", "default": null, "optional": true }, { - "name": "exchange_volume", - "type": "Union[int, float]", - "description": "Volume of shares exchanged during the trading day on the specific exchange.", + "name": "return_3y_avg", + "type": "float", + "description": "The three year average return of the fund, as a normalized percent.", "default": null, "optional": true }, { - "name": "prev_close", + "name": "return_5y_avg", "type": "float", - "description": "The previous close price.", + "description": "The five year average return of the fund, as a normalized percent.", "default": null, "optional": true }, { - "name": "change", + "name": "beta_3y_avg", "type": "float", - "description": "Change in price from previous close.", + "description": "The three year average beta of the fund.", "default": null, "optional": true }, { - "name": "change_percent", + "name": "volume_avg", "type": "float", - "description": "Change in price as a normalized percentage.", + "description": "The average daily trading volume of the fund.", "default": null, "optional": true }, { - "name": "year_high", + "name": "volume_avg_10d", "type": "float", - "description": "The one year high (52W High).", + "description": "The average daily trading volume of the fund over the past ten days.", "default": null, "optional": true }, { - "name": "year_low", + "name": "bid", "type": "float", - "description": "The one year low (52W Low).", + "description": "The current bid price.", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "price_avg50", + "name": "bid_size", "type": "float", - "description": "50 day moving average price.", + "description": "The current bid size.", "default": null, "optional": true }, { - "name": "price_avg200", + "name": "ask", "type": "float", - "description": "200 day moving average price.", + "description": "The current ask price.", "default": null, "optional": true }, { - "name": "avg_volume", - "type": "int", - "description": "Average volume over the last 10 trading days.", + "name": "ask_size", + "type": "float", + "description": "The current ask size.", "default": null, "optional": true }, { - "name": "market_cap", + "name": "open", "type": "float", - "description": "Market cap of the company.", + "description": "The open price of the most recent trading session.", "default": null, "optional": true }, { - "name": "shares_outstanding", - "type": "int", - "description": "Number of shares outstanding.", + "name": "high", + "type": "float", + "description": "The highest price of the most recent trading session.", "default": null, "optional": true }, { - "name": "eps", + "name": "low", "type": "float", - "description": "Earnings per share.", + "description": "The lowest price of the most recent trading session.", "default": null, "optional": true }, { - "name": "pe", - "type": "float", - "description": "Price earnings ratio.", + "name": "volume", + "type": "int", + "description": "The trading volume of the most recent trading session.", "default": null, "optional": true }, { - "name": "earnings_announcement", - "type": "datetime", - "description": "Upcoming earnings announcement date.", + "name": "prev_close", + "type": "float", + "description": "The previous closing price.", "default": null, "optional": true } + ] + }, + "model": "EtfInfo" + }, + "/etf/sectors": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "ETF Sector weighting.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.sectors(symbol='SPY', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp', 'tmx']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } ], - "intrinio": [ + "fmp": [], + "tmx": [ { - "name": "is_darkpool", + "name": "use_cache", "type": "bool", - "description": "Whether or not the current trade is from a darkpool.", - "default": null, + "description": "Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours.", + "default": true, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfSectors]", + "description": "Serializable results." }, { - "name": "source", + "name": "provider", + "type": "Optional[Literal['fmp', 'tmx']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "sector", "type": "str", - "description": "Source of the Intrinio data.", - "default": null, - "optional": true + "description": "Sector of exposure.", + "default": "", + "optional": false }, { - "name": "updated_on", - "type": "datetime", - "description": "Date and Time when the data was last updated.", + "name": "weight", + "type": "float", + "description": "Exposure of the ETF to the sector in normalized percentage points.", + "default": "", + "optional": false + } + ], + "fmp": [], + "tmx": [] + }, + "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, tmx.", "default": "", "optional": false }, { - "name": "security", - "type": "IntrinioSecurity", - "description": "Security details related to the quote.", - "default": null, + "name": "provider", + "type": "Literal['fmp', 'tmx']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true } ], - "yfinance": [ + "fmp": [], + "tmx": [ { - "name": "ma_50d", - "type": "float", - "description": "50-day moving average price.", - "default": null, + "name": "use_cache", + "type": "bool", + "description": "Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours.", + "default": true, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfCountries]", + "description": "Serializable results." }, { - "name": "ma_200d", - "type": "float", - "description": "200-day moving average price.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp', 'tmx']]", + "description": "Provider name." }, { - "name": "volume_average", - "type": "float", - "description": "Average daily trading volume.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "volume_average_10d", - "type": "float", - "description": "Average daily trading volume in the last 10 days.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "currency", - "type": "str", - "description": "Currency of the price.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } ] }, - "model": "EquityQuote" + "data": { + "standard": [ + { + "name": "country", + "type": "str", + "description": "The country of the exposure. Corresponding values are normalized percentage points.", + "default": "", + "optional": false + } + ], + "fmp": [], + "tmx": [] + }, + "model": "EtfCountries" }, - "/equity/price/nbbo": { + "/etf/price_performance": { "deprecated": { "flag": null, "message": null }, - "description": "Get the National Best Bid and Offer for a given stock.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.nbbo(symbol='AAPL', provider='polygon')\n```\n\n", + "description": "Price performance as a return, over different periods.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.price_performance(symbol='QQQ', provider='fmp')\nobb.etf.price_performance(symbol='SPY,QQQ,IWM,DJIA', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio.", "default": "", "optional": false }, { "name": "provider", - "type": "Literal['polygon']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'polygon' if there is no default.", - "default": "polygon", + "type": "Literal['finviz', 'fmp', 'intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default.", + "default": "finviz", "optional": true } ], - "polygon": [ - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. Up to ten million records will be returned. Pagination occurs in groups of 50,000. Remaining limit values will always return 50,000 more records unless it is the last page. High volume tickers will require multiple max requests for a single day's NBBO records. Expect stocks, like SPY, to approach 1GB in size, per day, as a raw CSV. Splitting large requests into chunks is recommended for full-day requests of high-volume symbols.", - "default": 50000, - "optional": true - }, - { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for. Use bracketed the timestamp parameters to specify exact time ranges.", - "default": null, - "optional": true - }, - { - "name": "timestamp_lt", - "type": "Union[datetime, str]", - "description": "Query by datetime, less than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", - "default": null, - "optional": true - }, - { - "name": "timestamp_gt", - "type": "Union[datetime, str]", - "description": "Query by datetime, greater than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", - "default": null, - "optional": true - }, + "finviz": [], + "fmp": [], + "intrinio": [ { - "name": "timestamp_lte", - "type": "Union[datetime, str]", - "description": "Query by datetime, less than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", - "default": null, + "name": "return_type", + "type": "Literal['trailing', 'calendar']", + "description": "The type of returns to return, a trailing or calendar window.", + "default": "trailing", "optional": true }, { - "name": "timestamp_gte", - "type": "Union[datetime, str]", - "description": "Query by datetime, greater than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", - "default": null, + "name": "adjustment", + "type": "Literal['splits_only', 'splits_and_dividends']", + "description": "The adjustment factor, 'splits_only' will return pure price performance.", + "default": "splits_and_dividends", "optional": true } ] @@ -18516,12 +28708,12 @@ "OBBject": [ { "name": "results", - "type": "List[EquityNBBO]", + "type": "List[EtfPricePerformance]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['polygon']]", + "type": "Optional[Literal['finviz', 'fmp', 'intrinio']]", "description": "Provider name." }, { @@ -18544,287 +28736,373 @@ "data": { "standard": [ { - "name": "ask_exchange", + "name": "symbol", "type": "str", - "description": "The exchange ID for the ask.", - "default": "", - "optional": false + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true }, { - "name": "ask", + "name": "one_day", "type": "float", - "description": "The last ask price.", - "default": "", - "optional": false + "description": "One-day return.", + "default": null, + "optional": true }, { - "name": "ask_size", - "type": "int", - "description": "The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price.", - "default": "", - "optional": false + "name": "wtd", + "type": "float", + "description": "Week to date return.", + "default": null, + "optional": true }, { - "name": "bid_size", - "type": "int", - "description": "The bid size in round lots.", - "default": "", - "optional": false + "name": "one_week", + "type": "float", + "description": "One-week return.", + "default": null, + "optional": true + }, + { + "name": "mtd", + "type": "float", + "description": "Month to date return.", + "default": null, + "optional": true + }, + { + "name": "one_month", + "type": "float", + "description": "One-month return.", + "default": null, + "optional": true + }, + { + "name": "qtd", + "type": "float", + "description": "Quarter to date return.", + "default": null, + "optional": true + }, + { + "name": "three_month", + "type": "float", + "description": "Three-month return.", + "default": null, + "optional": true + }, + { + "name": "six_month", + "type": "float", + "description": "Six-month return.", + "default": null, + "optional": true + }, + { + "name": "ytd", + "type": "float", + "description": "Year to date return.", + "default": null, + "optional": true + }, + { + "name": "one_year", + "type": "float", + "description": "One-year return.", + "default": null, + "optional": true + }, + { + "name": "two_year", + "type": "float", + "description": "Two-year return.", + "default": null, + "optional": true + }, + { + "name": "three_year", + "type": "float", + "description": "Three-year return.", + "default": null, + "optional": true + }, + { + "name": "four_year", + "type": "float", + "description": "Four-year", + "default": null, + "optional": true + }, + { + "name": "five_year", + "type": "float", + "description": "Five-year return.", + "default": null, + "optional": true }, { - "name": "bid", + "name": "ten_year", "type": "float", - "description": "The last bid price.", - "default": "", - "optional": false + "description": "Ten-year return.", + "default": null, + "optional": true }, { - "name": "bid_exchange", - "type": "str", - "description": "The exchange ID for the bid.", - "default": "", - "optional": false + "name": "max", + "type": "float", + "description": "Return from the beginning of the time series.", + "default": null, + "optional": true } ], - "polygon": [ + "finviz": [ { - "name": "tape", + "name": "symbol", "type": "str", - "description": "The exchange tape.", + "description": "The ticker symbol.", "default": null, "optional": true }, { - "name": "conditions", - "type": "Union[str, List[int], List[str]]", - "description": "A list of condition codes.", + "name": "volatility_week", + "type": "float", + "description": "One-week realized volatility, as a normalized percent.", "default": null, "optional": true }, { - "name": "indicators", - "type": "List[int]", - "description": "A list of indicator codes.", + "name": "volatility_month", + "type": "float", + "description": "One-month realized volatility, as a normalized percent.", "default": null, "optional": true }, { - "name": "sequence_num", - "type": "int", - "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11)", + "name": "price", + "type": "float", + "description": "Last Price.", "default": null, "optional": true }, { - "name": "participant_timestamp", - "type": "datetime", - "description": "The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.", + "name": "volume", + "type": "float", + "description": "Current volume.", "default": null, "optional": true }, { - "name": "sip_timestamp", - "type": "datetime", - "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it.", + "name": "average_volume", + "type": "float", + "description": "Average daily volume.", "default": null, "optional": true }, { - "name": "trf_timestamp", - "type": "datetime", - "description": "The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this quote.", + "name": "relative_volume", + "type": "float", + "description": "Relative volume as a ratio of current volume to average volume.", + "default": null, + "optional": true + }, + { + "name": "analyst_recommendation", + "type": "float", + "description": "The analyst consensus, on a scale of 1-5 where 1 is a buy and 5 is a sell.", "default": null, "optional": true } - ] - }, - "model": "EquityNBBO" - }, - "/equity/price/historical": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get historical price data for a given stock. This includes open, high, low, close, and volume.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.historical(symbol='AAPL', provider='fmp')\nobb.equity.price.historical(symbol='AAPL', interval='1d', provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ + ], + "fmp": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", + "type": "str", + "description": "The ticker symbol.", "default": "", "optional": false - }, + } + ], + "intrinio": [ { - "name": "interval", - "type": "str", - "description": "Time interval of the data to return.", - "default": "1d", + "name": "max_annualized", + "type": "float", + "description": "Annualized rate of return from inception.", + "default": null, "optional": true }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "volatility_one_year", + "type": "float", + "description": "Trailing one-year annualized volatility.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "volatility_three_year", + "type": "float", + "description": "Trailing three-year annualized volatility.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "volatility_five_year", + "type": "float", + "description": "Trailing five-year annualized volatility.", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "interval", - "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", - "description": "Time interval of the data to return.", - "default": "1d", + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": null, "optional": true - } - ], - "intrinio": [ - { - "name": "symbol", - "type": "str", - "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", - "default": "", - "optional": false }, { - "name": "interval", - "type": "Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y']", - "description": "Time interval of the data to return.", - "default": "1d", + "name": "volume_avg_30", + "type": "float", + "description": "The one-month average daily volume.", + "default": null, "optional": true }, { - "name": "start_time", - "type": "datetime.time", - "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'.", + "name": "volume_avg_90", + "type": "float", + "description": "The three-month average daily volume.", "default": null, "optional": true }, { - "name": "end_time", - "type": "datetime.time", - "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'.", + "name": "volume_avg_180", + "type": "float", + "description": "The six-month average daily volume.", "default": null, "optional": true }, { - "name": "timezone", - "type": "str", - "description": "Timezone of the data, in the IANA format (Continent/City).", - "default": "America/New_York", + "name": "beta", + "type": "float", + "description": "Beta compared to the S&P 500.", + "default": null, "optional": true }, { - "name": "source", - "type": "Literal['realtime', 'delayed', 'nasdaq_basic']", - "description": "The source of the data.", - "default": "realtime", + "name": "nav", + "type": "float", + "description": "Net asset value per share.", + "default": null, "optional": true - } - ], - "polygon": [ + }, { - "name": "interval", - "type": "str", - "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", - "default": "1d", + "name": "year_high", + "type": "float", + "description": "The 52-week high price.", + "default": null, "optional": true }, { - "name": "adjustment", - "type": "Literal['splits_only', 'unadjusted']", - "description": "The adjustment factor to apply. Default is splits only.", - "default": "splits_only", + "name": "year_low", + "type": "float", + "description": "The 52-week low price.", + "default": null, "optional": true }, { - "name": "extended_hours", - "type": "bool", - "description": "Include Pre and Post market data.", - "default": false, + "name": "market_cap", + "type": "float", + "description": "The market capitalization.", + "default": null, "optional": true }, { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", - "default": "asc", + "name": "shares_outstanding", + "type": "int", + "description": "The number of shares outstanding.", + "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 49999, + "name": "updated", + "type": "date", + "description": "The date of the data.", + "default": null, "optional": true } - ], - "tiingo": [ + ] + }, + "model": "EtfPricePerformance" + }, + "/etf/holdings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the holdings for an individual ETF.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings(symbol='XLK', provider='fmp')\n# Including a date (FMP, SEC) will return the holdings as per NPORT-P filings.\nobb.etf.holdings(symbol='XLK', date=2022-03-31, provider='fmp')\n# The same data can be returned from the SEC directly.\nobb.etf.holdings(symbol='XLK', date=2022-03-31, provider='sec')\n```\n\n", + "parameters": { + "standard": [ { - "name": "interval", - "type": "Literal['1d', '1W', '1M', '1Y']", - "description": "Time interval of the data to return.", - "default": "1d", + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'sec', 'tmx']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true } ], - "yfinance": [ + "fmp": [ { - "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", + "name": "date", + "type": "Union[Union[str, date], str]", + "description": "A specific date to get data for. Entering a date will attempt to return the NPORT-P filing for the entered date. This needs to be _exactly_ the date of the filing. Use the holdings_date command/endpoint to find available filing dates for the ETF.", + "default": null, "optional": true }, { - "name": "extended_hours", - "type": "bool", - "description": "Include Pre and Post market data.", - "default": false, + "name": "cik", + "type": "str", + "description": "The CIK of the filing entity. Overrides symbol.", + "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "include_actions", - "type": "bool", - "description": "Include dividends and stock splits in results.", - "default": true, + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": null, "optional": true - }, + } + ], + "sec": [ { - "name": "adjustment", - "type": "Literal['splits_only', 'splits_and_dividends']", - "description": "The adjustment factor to apply. Default is splits only.", - "default": "splits_only", + "name": "date", + "type": "Union[Union[str, date], str]", + "description": "A specific date to get data for. The date represents the period ending. The date entered will return the closest filing.", + "default": null, "optional": true }, { - "name": "adjusted", + "name": "use_cache", "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, + "description": "Whether or not to use cache for the request.", + "default": true, "optional": true - }, + } + ], + "tmx": [ { - "name": "prepost", + "name": "use_cache", "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, + "description": "Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours.", + "default": true, "optional": true } ] @@ -18833,12 +29111,12 @@ "OBBject": [ { "name": "results", - "type": "List[EquityHistorical]", + "type": "List[EtfHoldings]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']]", + "type": "Optional[Literal['fmp', 'intrinio', 'sec', 'tmx']]", "description": "Provider name." }, { @@ -18861,1050 +29139,943 @@ "data": { "standard": [ { - "name": "date", - "type": "Union[date, datetime]", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "open", - "type": "float", - "description": "The open price.", - "default": "", - "optional": false - }, - { - "name": "high", - "type": "float", - "description": "The high price.", - "default": "", - "optional": false - }, - { - "name": "low", - "type": "float", - "description": "The low price.", - "default": "", - "optional": false - }, - { - "name": "close", - "type": "float", - "description": "The close price.", - "default": "", - "optional": false - }, - { - "name": "volume", - "type": "Union[int, float]", - "description": "The trading volume.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. (ETF)", "default": null, "optional": true }, { - "name": "vwap", - "type": "float", - "description": "Volume Weighted Average Price over the period.", + "name": "name", + "type": "str", + "description": "Name of the ETF holding.", "default": null, "optional": true } ], "fmp": [ { - "name": "adj_close", - "type": "float", - "description": "The adjusted close price.", + "name": "lei", + "type": "str", + "description": "The LEI of the holding.", "default": null, "optional": true }, { - "name": "unadjusted_volume", - "type": "float", - "description": "Unadjusted volume of the symbol.", + "name": "title", + "type": "str", + "description": "The title of the holding.", "default": null, "optional": true }, { - "name": "change", - "type": "float", - "description": "Change in the price from the previous close.", + "name": "cusip", + "type": "str", + "description": "The CUSIP of the holding.", "default": null, "optional": true }, { - "name": "change_percent", - "type": "float", - "description": "Change in the price from the previous close, as a normalized percent.", + "name": "isin", + "type": "str", + "description": "The ISIN of the holding.", "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "average", - "type": "float", - "description": "Average trade price of an individual equity during the interval.", + "name": "balance", + "type": "int", + "description": "The balance of the holding, in shares or units.", "default": null, "optional": true }, { - "name": "change", - "type": "float", - "description": "Change in the price of the symbol from the previous day.", + "name": "units", + "type": "Union[str, float]", + "description": "The type of units.", "default": null, "optional": true }, { - "name": "change_percent", - "type": "float", - "description": "Percent change in the price of the symbol from the previous day.", + "name": "currency", + "type": "str", + "description": "The currency of the holding.", "default": null, "optional": true }, { - "name": "adj_open", + "name": "value", "type": "float", - "description": "The adjusted open price.", + "description": "The value of the holding, in dollars.", "default": null, "optional": true }, { - "name": "adj_high", + "name": "weight", "type": "float", - "description": "The adjusted high price.", + "description": "The weight of the holding, as a normalized percent.", "default": null, "optional": true }, { - "name": "adj_low", - "type": "float", - "description": "The adjusted low price.", + "name": "payoff_profile", + "type": "str", + "description": "The payoff profile of the holding.", "default": null, "optional": true }, { - "name": "adj_close", - "type": "float", - "description": "The adjusted close price.", + "name": "asset_category", + "type": "str", + "description": "The asset category of the holding.", "default": null, "optional": true }, { - "name": "adj_volume", - "type": "float", - "description": "The adjusted volume.", + "name": "issuer_category", + "type": "str", + "description": "The issuer category of the holding.", "default": null, "optional": true }, { - "name": "fifty_two_week_high", - "type": "float", - "description": "52 week high price for the symbol.", + "name": "country", + "type": "str", + "description": "The country of the holding.", "default": null, "optional": true }, { - "name": "fifty_two_week_low", - "type": "float", - "description": "52 week low price for the symbol.", + "name": "is_restricted", + "type": "str", + "description": "Whether the holding is restricted.", "default": null, "optional": true }, { - "name": "factor", - "type": "float", - "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices.", + "name": "fair_value_level", + "type": "int", + "description": "The fair value level of the holding.", "default": null, "optional": true }, { - "name": "split_ratio", - "type": "float", - "description": "Ratio of the equity split, if a split occurred.", + "name": "is_cash_collateral", + "type": "str", + "description": "Whether the holding is cash collateral.", "default": null, "optional": true }, { - "name": "dividend", - "type": "float", - "description": "Dividend amount, if a dividend was paid.", + "name": "is_non_cash_collateral", + "type": "str", + "description": "Whether the holding is non-cash collateral.", "default": null, "optional": true }, { - "name": "close_time", - "type": "datetime", - "description": "The timestamp that represents the end of the interval span.", + "name": "is_loan_by_fund", + "type": "str", + "description": "Whether the holding is loan by fund.", "default": null, "optional": true }, { - "name": "interval", + "name": "cik", "type": "str", - "description": "The data time frequency.", + "description": "The CIK of the filing.", "default": null, "optional": true }, { - "name": "intra_period", - "type": "bool", - "description": "If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period", + "name": "acceptance_datetime", + "type": "str", + "description": "The acceptance datetime of the filing.", "default": null, "optional": true - } - ], - "polygon": [ + }, { - "name": "transactions", - "type": "Annotated[int, Gt(gt=0)]", - "description": "Number of transactions for the symbol in the time period.", + "name": "updated", + "type": "Union[date, datetime]", + "description": "The date the data was updated.", "default": null, "optional": true } ], - "tiingo": [ + "intrinio": [ { - "name": "adj_open", - "type": "float", - "description": "The adjusted open price.", + "name": "name", + "type": "str", + "description": "The common name for the holding.", "default": null, "optional": true }, { - "name": "adj_high", - "type": "float", - "description": "The adjusted high price.", + "name": "security_type", + "type": "str", + "description": "The type of instrument for this holding. Examples(Bond='BOND', Equity='EQUI')", "default": null, "optional": true }, { - "name": "adj_low", - "type": "float", - "description": "The adjusted low price.", + "name": "isin", + "type": "str", + "description": "The International Securities Identification Number.", "default": null, "optional": true }, { - "name": "adj_close", - "type": "float", - "description": "The adjusted close price.", + "name": "ric", + "type": "str", + "description": "The Reuters Instrument Code.", "default": null, "optional": true }, { - "name": "adj_volume", - "type": "float", - "description": "The adjusted volume.", + "name": "sedol", + "type": "str", + "description": "The Stock Exchange Daily Official List.", "default": null, "optional": true }, { - "name": "split_ratio", - "type": "float", - "description": "Ratio of the equity split, if a split occurred.", + "name": "share_class_figi", + "type": "str", + "description": "The OpenFIGI symbol for the holding.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "The country or region of the holding.", "default": null, "optional": true }, { - "name": "dividend", - "type": "float", - "description": "Dividend amount, if a dividend was paid.", + "name": "maturity_date", + "type": "date", + "description": "The maturity date for the debt security, if available.", "default": null, "optional": true - } - ], - "yfinance": [ + }, { - "name": "split_ratio", - "type": "float", - "description": "Ratio of the equity split, if a split occurred.", + "name": "contract_expiry_date", + "type": "date", + "description": "Expiry date for the futures contract held, if available.", "default": null, "optional": true }, { - "name": "dividend", + "name": "coupon", "type": "float", - "description": "Dividend amount (split-adjusted), if a dividend was paid.", + "description": "The coupon rate of the debt security, if available.", "default": null, "optional": true - } - ] - }, - "model": "EquityHistorical" - }, - "/equity/price/performance": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get price performance data for a given stock. This includes price changes for different time periods.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.performance(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", - "default": "", - "optional": false }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "balance", + "type": "Union[int, float]", + "description": "The number of units of the security held, if available.", + "default": null, "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[PricePerformance]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", + "name": "unit", "type": "str", - "description": "Symbol representing the entity requested in the data.", + "description": "The units of the 'balance' field.", "default": null, "optional": true }, { - "name": "one_day", + "name": "units_per_share", "type": "float", - "description": "One-day return.", + "description": "Number of units of the security held per share outstanding of the ETF, if available.", "default": null, "optional": true }, { - "name": "wtd", + "name": "face_value", "type": "float", - "description": "Week to date return.", + "description": "The face value of the debt security, if available.", "default": null, "optional": true }, { - "name": "one_week", + "name": "derivatives_value", "type": "float", - "description": "One-week return.", + "description": "The notional value of derivatives contracts held.", "default": null, "optional": true }, { - "name": "mtd", + "name": "value", "type": "float", - "description": "Month to date return.", + "description": "The market value of the holding, on the 'as_of' date.", "default": null, "optional": true }, { - "name": "one_month", + "name": "weight", "type": "float", - "description": "One-month return.", + "description": "The weight of the holding, as a normalized percent.", "default": null, "optional": true }, { - "name": "qtd", - "type": "float", - "description": "Quarter to date return.", + "name": "updated", + "type": "date", + "description": "The 'as_of' date for the holding.", "default": null, "optional": true - }, + } + ], + "sec": [ { - "name": "three_month", - "type": "float", - "description": "Three-month return.", + "name": "lei", + "type": "str", + "description": "The LEI of the holding.", "default": null, "optional": true }, { - "name": "six_month", - "type": "float", - "description": "Six-month return.", + "name": "cusip", + "type": "str", + "description": "The CUSIP of the holding.", "default": null, "optional": true }, { - "name": "ytd", - "type": "float", - "description": "Year to date return.", + "name": "isin", + "type": "str", + "description": "The ISIN of the holding.", "default": null, "optional": true }, { - "name": "one_year", - "type": "float", - "description": "One-year return.", + "name": "other_id", + "type": "str", + "description": "Internal identifier for the holding.", "default": null, "optional": true }, { - "name": "two_year", + "name": "balance", "type": "float", - "description": "Two-year return.", + "description": "The balance of the holding.", "default": null, "optional": true }, { - "name": "three_year", + "name": "weight", "type": "float", - "description": "Three-year return.", + "description": "The weight of the holding in ETF in %.", "default": null, "optional": true }, { - "name": "four_year", + "name": "value", "type": "float", - "description": "Four-year", + "description": "The value of the holding in USD.", "default": null, "optional": true }, { - "name": "five_year", - "type": "float", - "description": "Five-year return.", + "name": "payoff_profile", + "type": "str", + "description": "The payoff profile of the holding.", "default": null, "optional": true }, { - "name": "ten_year", - "type": "float", - "description": "Ten-year return.", + "name": "units", + "type": "Union[str, float]", + "description": "The units of the holding.", "default": null, "optional": true }, { - "name": "max", - "type": "float", - "description": "Return from the beginning of the time series.", + "name": "currency", + "type": "str", + "description": "The currency of the holding.", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "symbol", + "name": "asset_category", "type": "str", - "description": "The ticker symbol.", - "default": "", - "optional": false - } - ] - }, - "model": "PricePerformance" - }, - "/equity/shorts/fails_to_deliver": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get reported Fail-to-deliver (FTD) data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.shorts.fails_to_deliver(symbol='AAPL', provider='sec')\n```\n\n", - "parameters": { - "standard": [ + "description": "The asset category of the holding.", + "default": null, + "optional": true + }, { - "name": "symbol", + "name": "issuer_category", "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false + "description": "The issuer category of the holding.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Literal['sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", - "default": "sec", + "name": "country", + "type": "str", + "description": "The country of the holding.", + "default": null, "optional": true - } - ], - "sec": [ + }, { - "name": "limit", - "type": "int", - "description": "Limit the number of reports to parse, from most recent. Approximately 24 reports per year, going back to 2009.", - "default": 24, + "name": "is_restricted", + "type": "str", + "description": "Whether the holding is restricted.", + "default": null, "optional": true }, { - "name": "skip_reports", + "name": "fair_value_level", "type": "int", - "description": "Skip N number of reports from current. A value of 1 will skip the most recent report.", - "default": 0, + "description": "The fair value level of the holding.", + "default": null, "optional": true }, { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache for the request, default is True. Each reporting period is a separate URL, new reports will be added to the cache.", - "default": true, + "name": "is_cash_collateral", + "type": "str", + "description": "Whether the holding is cash collateral.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[EquityFTD]", - "description": "Serializable results." + "name": "is_non_cash_collateral", + "type": "str", + "description": "Whether the holding is non-cash collateral.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['sec']]", - "description": "Provider name." + "name": "is_loan_by_fund", + "type": "str", + "description": "Whether the holding is loan by fund.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "loan_value", + "type": "float", + "description": "The loan value of the holding.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "issuer_conditional", + "type": "str", + "description": "The issuer conditions of the holding.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "asset_conditional", + "type": "str", + "description": "The asset conditions of the holding.", + "default": null, + "optional": true + }, { - "name": "settlement_date", + "name": "maturity_date", "type": "date", - "description": "The settlement date of the fail.", + "description": "The maturity date of the debt security.", "default": null, "optional": true }, { - "name": "symbol", + "name": "coupon_kind", "type": "str", - "description": "Symbol representing the entity requested in the data.", + "description": "The type of coupon for the debt security.", "default": null, "optional": true }, { - "name": "cusip", + "name": "rate_type", "type": "str", - "description": "CUSIP of the Security.", + "description": "The type of rate for the debt security, floating or fixed.", "default": null, "optional": true }, { - "name": "quantity", - "type": "int", - "description": "The number of fails on that settlement date.", + "name": "annualized_return", + "type": "float", + "description": "The annualized return on the debt security.", "default": null, "optional": true }, { - "name": "price", - "type": "float", - "description": "The price at the previous closing price from the settlement date.", + "name": "is_default", + "type": "str", + "description": "If the debt security is defaulted.", "default": null, "optional": true }, { - "name": "description", + "name": "in_arrears", "type": "str", - "description": "The description of the Security.", + "description": "If the debt security is in arrears.", "default": null, "optional": true - } - ], - "sec": [] - }, - "model": "EquityFTD" - }, - "/equity/search": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Search for stock symbol, CIK, LEI, or company name.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.search(provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "query", + "name": "is_paid_kind", "type": "str", - "description": "Search query.", - "default": "", + "description": "If the debt security payments are paid in kind.", + "default": null, "optional": true }, { - "name": "is_symbol", - "type": "bool", - "description": "Whether to search by ticker symbol.", - "default": false, + "name": "derivative_category", + "type": "str", + "description": "The derivative category of the holding.", + "default": null, "optional": true }, { - "name": "use_cache", - "type": "bool", - "description": "Whether to use the cache or not.", - "default": true, + "name": "counterparty", + "type": "str", + "description": "The counterparty of the derivative.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['intrinio', 'sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", + "name": "underlying_name", + "type": "str", + "description": "The name of the underlying asset associated with the derivative.", + "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "active", - "type": "bool", - "description": "When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded.", - "default": true, + "name": "option_type", + "type": "str", + "description": "The type of option.", + "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 10000, + "name": "derivative_payoff", + "type": "str", + "description": "The payoff profile of the derivative.", + "default": null, "optional": true - } - ], - "sec": [ + }, { - "name": "is_fund", - "type": "bool", - "description": "Whether to direct the search to the list of mutual funds and ETFs.", - "default": false, + "name": "expiry_date", + "type": "date", + "description": "The expiry or termination date of the derivative.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EquitySearch]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['intrinio', 'sec']]", - "description": "Provider name." + "name": "exercise_price", + "type": "float", + "description": "The exercise price of the option.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "exercise_currency", + "type": "str", + "description": "The currency of the option exercise price.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "shares_per_contract", + "type": "float", + "description": "The number of shares per contract.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "delta", + "type": "Union[str, float]", + "description": "The delta of the option.", "default": null, "optional": true }, { - "name": "name", + "name": "rate_type_rec", "type": "str", - "description": "Name of the company.", + "description": "The type of rate for receivable portion of the swap.", "default": null, "optional": true - } - ], - "intrinio": [ - { - "name": "cik", - "type": "str", - "description": "", - "default": "", - "optional": false }, { - "name": "lei", + "name": "receive_currency", "type": "str", - "description": "The Legal Entity Identifier (LEI) of the company.", - "default": "", - "optional": false + "description": "The receive currency of the swap.", + "default": null, + "optional": true }, { - "name": "intrinio_id", - "type": "str", - "description": "The Intrinio ID of the company.", - "default": "", - "optional": false - } - ], - "sec": [ + "name": "upfront_receive", + "type": "float", + "description": "The upfront amount received of the swap.", + "default": null, + "optional": true + }, { - "name": "cik", + "name": "floating_rate_index_rec", "type": "str", - "description": "Central Index Key", - "default": "", - "optional": false - } - ] - }, - "model": "EquitySearch" - }, - "/equity/screener": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Screen for companies meeting various criteria.\n\nThese criteria include market cap, price, beta, volume, and dividend yield.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.screener(provider='fmp')\n```\n\n", - "parameters": { - "standard": [ + "description": "The floating rate index for receivable portion of the swap.", + "default": null, + "optional": true + }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "floating_rate_spread_rec", + "type": "float", + "description": "The floating rate spread for reveivable portion of the swap.", + "default": null, + "optional": true + }, + { + "name": "rate_tenor_rec", + "type": "str", + "description": "The rate tenor for receivable portion of the swap.", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "mktcap_min", - "type": "int", - "description": "Filter by market cap greater than this value.", + "name": "rate_tenor_unit_rec", + "type": "Union[int, str]", + "description": "The rate tenor unit for receivable portion of the swap.", "default": null, "optional": true }, { - "name": "mktcap_max", - "type": "int", - "description": "Filter by market cap less than this value.", + "name": "reset_date_rec", + "type": "str", + "description": "The reset date for receivable portion of the swap.", "default": null, "optional": true }, { - "name": "price_min", - "type": "float", - "description": "Filter by price greater than this value.", + "name": "reset_date_unit_rec", + "type": "Union[int, str]", + "description": "The reset date unit for receivable portion of the swap.", "default": null, "optional": true }, { - "name": "price_max", - "type": "float", - "description": "Filter by price less than this value.", + "name": "rate_type_pmnt", + "type": "str", + "description": "The type of rate for payment portion of the swap.", "default": null, "optional": true }, { - "name": "beta_min", - "type": "float", - "description": "Filter by a beta greater than this value.", + "name": "payment_currency", + "type": "str", + "description": "The payment currency of the swap.", "default": null, "optional": true }, { - "name": "beta_max", + "name": "upfront_payment", "type": "float", - "description": "Filter by a beta less than this value.", + "description": "The upfront amount received of the swap.", "default": null, "optional": true }, { - "name": "volume_min", - "type": "int", - "description": "Filter by volume greater than this value.", + "name": "floating_rate_index_pmnt", + "type": "str", + "description": "The floating rate index for payment portion of the swap.", "default": null, "optional": true }, { - "name": "volume_max", - "type": "int", - "description": "Filter by volume less than this value.", + "name": "floating_rate_spread_pmnt", + "type": "float", + "description": "The floating rate spread for payment portion of the swap.", "default": null, "optional": true }, { - "name": "dividend_min", - "type": "float", - "description": "Filter by dividend amount greater than this value.", + "name": "rate_tenor_pmnt", + "type": "str", + "description": "The rate tenor for payment portion of the swap.", "default": null, "optional": true }, { - "name": "dividend_max", - "type": "float", - "description": "Filter by dividend amount less than this value.", + "name": "rate_tenor_unit_pmnt", + "type": "Union[int, str]", + "description": "The rate tenor unit for payment portion of the swap.", "default": null, "optional": true }, { - "name": "is_etf", - "type": "bool", - "description": "If true, returns only ETFs.", - "default": false, + "name": "reset_date_pmnt", + "type": "str", + "description": "The reset date for payment portion of the swap.", + "default": null, "optional": true }, { - "name": "is_active", - "type": "bool", - "description": "If false, returns only inactive tickers.", - "default": true, + "name": "reset_date_unit_pmnt", + "type": "Union[int, str]", + "description": "The reset date unit for payment portion of the swap.", + "default": null, "optional": true }, { - "name": "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.", + "name": "repo_type", + "type": "str", + "description": "The type of repo.", "default": null, "optional": true }, { - "name": "industry", + "name": "is_cleared", "type": "str", - "description": "Filter by industry.", + "description": "If the repo is cleared.", "default": null, "optional": true }, { - "name": "country", + "name": "is_tri_party", "type": "str", - "description": "Filter by country, as a two-letter country code.", + "description": "If the repo is tri party.", "default": null, "optional": true }, { - "name": "exchange", - "type": "Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra']", - "description": "Filter by exchange.", + "name": "principal_amount", + "type": "float", + "description": "The principal amount of the repo.", "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "Limit the number of results to return.", - "default": 50000, + "name": "principal_currency", + "type": "str", + "description": "The currency of the principal amount.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[EquityScreener]", - "description": "Serializable results." + "name": "collateral_type", + "type": "str", + "description": "The collateral type of the repo.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "collateral_amount", + "type": "float", + "description": "The collateral amount of the repo.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "collateral_currency", + "type": "str", + "description": "The currency of the collateral amount.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "exchange_currency", + "type": "str", + "description": "The currency of the exchange rate.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "exchange_rate", + "type": "float", + "description": "The exchange rate.", + "default": null, + "optional": true + }, { - "name": "symbol", + "name": "currency_sold", "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "description": "The currency sold in a Forward Derivative.", + "default": null, + "optional": true }, { - "name": "name", + "name": "currency_amount_sold", + "type": "float", + "description": "The amount of currency sold in a Forward Derivative.", + "default": null, + "optional": true + }, + { + "name": "currency_bought", "type": "str", - "description": "Name of the company.", - "default": "", - "optional": false - } - ], - "fmp": [ + "description": "The currency bought in a Forward Derivative.", + "default": null, + "optional": true + }, { - "name": "market_cap", - "type": "int", - "description": "The market cap of ticker.", + "name": "currency_amount_bought", + "type": "float", + "description": "The amount of currency bought in a Forward Derivative.", "default": null, "optional": true }, { - "name": "sector", - "type": "str", - "description": "The sector the ticker belongs to.", + "name": "notional_amount", + "type": "float", + "description": "The notional amount of the derivative.", "default": null, "optional": true }, { - "name": "industry", + "name": "notional_currency", "type": "str", - "description": "The industry ticker belongs to.", + "description": "The currency of the derivative's notional amount.", "default": null, "optional": true }, { - "name": "beta", + "name": "unrealized_gain", "type": "float", - "description": "The beta of the ETF.", + "description": "The unrealized gain or loss on the derivative.", + "default": null, + "optional": true + } + ], + "tmx": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol of the asset.", "default": null, "optional": true }, { - "name": "price", - "type": "float", - "description": "The current price.", + "name": "name", + "type": "str", + "description": "The name of the asset.", "default": null, "optional": true }, { - "name": "last_annual_dividend", + "name": "weight", "type": "float", - "description": "The last annual amount dividend paid.", + "description": "The weight of the asset in the portfolio, as a normalized percentage.", "default": null, "optional": true }, { - "name": "volume", - "type": "int", - "description": "The current trading volume.", + "name": "shares", + "type": "Union[int, str]", + "description": "The value of the assets under management.", "default": null, "optional": true }, { - "name": "exchange", - "type": "str", - "description": "The exchange code the asset trades on.", + "name": "market_value", + "type": "Union[str, float]", + "description": "The market value of the holding.", "default": null, "optional": true }, { - "name": "exchange_name", + "name": "currency", "type": "str", - "description": "The full name of the primary exchange.", + "description": "The currency of the holding.", + "default": "", + "optional": false + }, + { + "name": "share_percentage", + "type": "float", + "description": "The share percentage of the holding, as a normalized percentage.", + "default": null, + "optional": true + }, + { + "name": "share_change", + "type": "Union[str, float]", + "description": "The change in shares of the holding.", "default": null, "optional": true }, { "name": "country", "type": "str", - "description": "The two-letter country abbreviation where the head office is located.", + "description": "The country of the holding.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "The exchange code of the holding.", "default": null, "optional": true }, { - "name": "is_etf", - "type": "Literal[True, False]", - "description": "Whether the ticker is an ETF.", + "name": "type_id", + "type": "str", + "description": "The holding type ID of the asset.", "default": null, "optional": true }, { - "name": "actively_trading", - "type": "Literal[True, False]", - "description": "Whether the ETF is actively trading.", + "name": "fund_id", + "type": "str", + "description": "The fund ID of the asset.", "default": null, "optional": true } ] }, - "model": "EquityScreener" + "model": "EtfHoldings" }, - "/equity/profile": { + "/etf/holdings_date": { "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", + "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": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", + "type": "str", + "description": "Symbol to get data for. (ETF)", "default": "", "optional": false }, { "name": "provider", - "type": "Literal['fmp', 'intrinio', 'yfinance']", + "type": "Literal['fmp']", "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", "default": "fmp", "optional": true } ], - "fmp": [], - "intrinio": [], - "yfinance": [] + "fmp": [ + { + "name": "cik", + "type": "str", + "description": "The CIK of the filing entity. Overrides symbol.", + "default": null, + "optional": true + } + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EquityInfo]", + "type": "List[EtfHoldingsDate]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -19925,505 +30096,700 @@ ] }, "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "EtfHoldingsDate" + }, + "/etf/holdings_performance": { + "deprecated": { + "flag": true, + "message": "This endpoint is deprecated; pass a list of holdings symbols directly to `/equity/price/performance` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.2." + }, + "description": "Get the recent price performance of each ticker held in the ETF.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings_performance(symbol='XLK', provider='fmp')\n```\n\n", + "parameters": { "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": "", "optional": false }, { - "name": "name", - "type": "str", - "description": "Common name of the company.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfHoldingsPerformance]", + "description": "Serializable results." }, { - "name": "cik", + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", "type": "str", - "description": "Central Index Key (CIK) for the requested entity.", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "cusip", - "type": "str", - "description": "CUSIP identifier for the company.", + "name": "one_day", + "type": "float", + "description": "One-day return.", "default": null, "optional": true }, { - "name": "isin", - "type": "str", - "description": "International Securities Identification Number.", + "name": "wtd", + "type": "float", + "description": "Week to date return.", "default": null, "optional": true }, { - "name": "lei", - "type": "str", - "description": "Legal Entity Identifier assigned to the company.", + "name": "one_week", + "type": "float", + "description": "One-week return.", "default": null, "optional": true }, { - "name": "legal_name", - "type": "str", - "description": "Official legal name of the company.", + "name": "mtd", + "type": "float", + "description": "Month to date return.", "default": null, "optional": true }, { - "name": "stock_exchange", - "type": "str", - "description": "Stock exchange where the company is traded.", + "name": "one_month", + "type": "float", + "description": "One-month return.", "default": null, "optional": true }, { - "name": "sic", - "type": "int", - "description": "Standard Industrial Classification code for the company.", + "name": "qtd", + "type": "float", + "description": "Quarter to date return.", "default": null, "optional": true }, { - "name": "short_description", - "type": "str", - "description": "Short description of the company.", + "name": "three_month", + "type": "float", + "description": "Three-month return.", "default": null, "optional": true }, { - "name": "long_description", - "type": "str", - "description": "Long description of the company.", + "name": "six_month", + "type": "float", + "description": "Six-month return.", "default": null, "optional": true }, { - "name": "ceo", - "type": "str", - "description": "Chief Executive Officer of the company.", + "name": "ytd", + "type": "float", + "description": "Year to date return.", "default": null, "optional": true }, { - "name": "company_url", - "type": "str", - "description": "URL of the company's website.", + "name": "one_year", + "type": "float", + "description": "One-year return.", "default": null, "optional": true }, { - "name": "business_address", - "type": "str", - "description": "Address of the company's headquarters.", + "name": "two_year", + "type": "float", + "description": "Two-year return.", "default": null, "optional": true }, { - "name": "mailing_address", - "type": "str", - "description": "Mailing address of the company.", + "name": "three_year", + "type": "float", + "description": "Three-year return.", "default": null, "optional": true }, { - "name": "business_phone_no", - "type": "str", - "description": "Phone number of the company's headquarters.", + "name": "four_year", + "type": "float", + "description": "Four-year", "default": null, "optional": true }, { - "name": "hq_address1", - "type": "str", - "description": "Address of the company's headquarters.", + "name": "five_year", + "type": "float", + "description": "Five-year return.", "default": null, "optional": true }, { - "name": "hq_address2", - "type": "str", - "description": "Address of the company's headquarters.", + "name": "ten_year", + "type": "float", + "description": "Ten-year return.", "default": null, "optional": true }, { - "name": "hq_address_city", - "type": "str", - "description": "City of the company's headquarters.", + "name": "max", + "type": "float", + "description": "Return from the beginning of the time series.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "hq_address_postal_code", + "name": "symbol", "type": "str", - "description": "Zip code of the company's headquarters.", - "default": null, + "description": "The ticker symbol.", + "default": "", + "optional": false + } + ] + }, + "model": "EtfHoldingsPerformance" + }, + "/etf/equity_exposure": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the exposure to ETFs for a specific stock.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.equity_exposure(symbol='MSFT', provider='fmp')\n# This function accepts multiple tickers.\nobb.etf.equity_exposure(symbol='MSFT,AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EtfEquityExposure]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "hq_state", - "type": "str", - "description": "State of the company's headquarters.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "hq_country", - "type": "str", - "description": "Country of the company's headquarters.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "inc_state", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "equity_symbol", "type": "str", - "description": "State in which the company is incorporated.", - "default": null, - "optional": true + "description": "The symbol of the equity requested.", + "default": "", + "optional": false }, { - "name": "inc_country", + "name": "etf_symbol", "type": "str", - "description": "Country in which the company is incorporated.", - "default": null, - "optional": true + "description": "The symbol of the ETF with exposure to the requested equity.", + "default": "", + "optional": false }, { - "name": "employees", - "type": "int", - "description": "Number of employees working for the company.", + "name": "shares", + "type": "float", + "description": "The number of shares held in the ETF.", "default": null, "optional": true }, { - "name": "entity_legal_form", - "type": "str", - "description": "Legal form of the company.", + "name": "weight", + "type": "float", + "description": "The weight of the equity in the ETF, as a normalized percent.", "default": null, "optional": true }, { - "name": "entity_status", - "type": "str", - "description": "Status of the company.", + "name": "market_value", + "type": "Union[int, float]", + "description": "The market value of the equity position in the ETF.", "default": null, "optional": true - }, + } + ], + "fmp": [] + }, + "model": "EtfEquityExposure" + }, + "/fixedincome/rate/ameribor": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Ameribor.\n\nAmeribor (short for the American interbank offered rate) is a benchmark interest rate that reflects the true cost of\nshort-term interbank borrowing. This rate is based on transactions in overnight unsecured loans conducted on the\nAmerican Financial Exchange (AFX).", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.ameribor(provider='fred')\nobb.fixedincome.rate.ameribor(parameter=30_day_ma, provider='fred')\n```\n\n", + "parameters": { + "standard": [ { - "name": "latest_filing_date", - "type": "date", - "description": "Date of the company's latest filing.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "irs_number", - "type": "str", - "description": "IRS number assigned to the company.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "sector", - "type": "str", - "description": "Sector in which the company operates.", - "default": null, + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", "optional": true - }, + } + ], + "fred": [ { - "name": "industry_category", - "type": "str", - "description": "Category of industry in which the company operates.", - "default": null, + "name": "parameter", + "type": "Literal['overnight', 'term_30', 'term_90', '1_week_term_structure', '1_month_term_structure', '3_month_term_structure', '6_month_term_structure', '1_year_term_structure', '2_year_term_structure', '30_day_ma', '90_day_ma']", + "description": "Period of AMERIBOR rate.", + "default": "overnight", "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[AMERIBOR]", + "description": "Serializable results." }, { - "name": "industry_group", - "type": "str", - "description": "Group of industry in which the company operates.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "template", - "type": "str", - "description": "Template used to standardize the company's financial statements.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "standardized_active", - "type": "bool", - "description": "Whether the company is active or not.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "first_fundamental_date", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", "type": "date", - "description": "Date of the company's first fundamental.", - "default": null, - "optional": true + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "last_fundamental_date", - "type": "date", - "description": "Date of the company's last fundamental.", + "name": "rate", + "type": "float", + "description": "AMERIBOR rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "AMERIBOR" + }, + "/fixedincome/rate/sonia": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Sterling Overnight Index Average.\n\nSONIA (Sterling Overnight Index Average) is an important interest rate benchmark. SONIA is based on actual\ntransactions and reflects the average of the interest rates that banks pay to borrow sterling overnight from other\nfinancial institutions and other institutional investors.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.sonia(provider='fred')\nobb.fixedincome.rate.sonia(parameter=total_nominal_value, provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "first_stock_price_date", - "type": "date", - "description": "Date of the company's first stock price.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "last_stock_price_date", - "type": "date", - "description": "Date of the company's last stock price.", - "default": null, + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", "optional": true } ], - "fmp": [ + "fred": [ { - "name": "is_etf", - "type": "bool", - "description": "If the symbol is an ETF.", - "default": "", - "optional": false + "name": "parameter", + "type": "Literal['rate', 'index', '10th_percentile', '25th_percentile', '75th_percentile', '90th_percentile', 'total_nominal_value']", + "description": "Period of SONIA rate.", + "default": "rate", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[SONIA]", + "description": "Serializable results." }, { - "name": "is_actively_trading", - "type": "bool", - "description": "If the company is actively trading.", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "is_adr", - "type": "bool", - "description": "If the stock is an ADR.", - "default": "", - "optional": false + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "is_fund", - "type": "bool", - "description": "If the company is a fund.", + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "image", - "type": "str", - "description": "Image of the company.", - "default": null, - "optional": true - }, + "name": "rate", + "type": "float", + "description": "SONIA rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "SONIA" + }, + "/fixedincome/rate/iorb": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Interest on Reserve Balances.\n\nGet Interest Rate on Reserve Balances data A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.iorb(provider='fred')\n```\n\n", + "parameters": { + "standard": [ { - "name": "currency", - "type": "str", - "description": "Currency in which the stock is traded.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "market_cap", - "type": "int", - "description": "Market capitalization of the company.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "last_price", - "type": "float", - "description": "The last traded price.", - "default": null, + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", "optional": true - }, + } + ], + "fred": [] + }, + "returns": { + "OBBject": [ { - "name": "year_high", - "type": "float", - "description": "The one-year high of the price.", - "default": null, - "optional": true + "name": "results", + "type": "List[IORB]", + "description": "Serializable results." }, { - "name": "year_low", - "type": "float", - "description": "The one-year low of the price.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "volume_avg", - "type": "int", - "description": "Average daily trading volume.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "annualized_dividend_amount", - "type": "float", - "description": "The annualized dividend payment based on the most recent regular dividend payment.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "beta", - "type": "float", - "description": "Beta of the stock relative to the market.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } - ], - "intrinio": [ + ] + }, + "data": { + "standard": [ { - "name": "id", - "type": "str", - "description": "Intrinio ID for the company.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "thea_enabled", - "type": "bool", - "description": "Whether the company has been enabled for Thea.", - "default": null, - "optional": true + "name": "rate", + "type": "float", + "description": "IORB rate.", + "default": "", + "optional": false } ], - "yfinance": [ + "fred": [] + }, + "model": "IORB" + }, + "/fixedincome/rate/effr": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fed Funds Rate.\n\nGet Effective Federal Funds Rate data. A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.effr(provider='fred')\nobb.fixedincome.rate.effr(parameter=daily, provider='fred')\n```\n\n", + "parameters": { + "standard": [ { - "name": "exchange_timezone", - "type": "str", - "description": "The timezone of the exchange.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "issue_type", - "type": "str", - "description": "The issuance type of the asset.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "currency", - "type": "str", - "description": "The currency in which the asset is traded.", - "default": null, + "name": "provider", + "type": "Literal['federal_reserve', 'fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default.", + "default": "federal_reserve", "optional": true - }, + } + ], + "federal_reserve": [], + "fred": [ { - "name": "market_cap", - "type": "int", - "description": "The market capitalization of the asset.", - "default": null, + "name": "parameter", + "type": "Literal['monthly', 'daily', 'weekly', 'daily_excl_weekend', 'annual', 'biweekly', 'volume']", + "description": "Period of FED rate.", + "default": "weekly", "optional": true - }, + } + ] + }, + "returns": { + "OBBject": [ { - "name": "shares_outstanding", - "type": "int", - "description": "The number of listed shares outstanding.", - "default": null, - "optional": true + "name": "results", + "type": "List[FEDFUNDS]", + "description": "Serializable results." }, { - "name": "shares_float", - "type": "int", - "description": "The number of shares in the public float.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['federal_reserve', 'fred']]", + "description": "Provider name." }, { - "name": "shares_implied_outstanding", - "type": "int", - "description": "Implied shares outstanding of common equityassuming the conversion of all convertible subsidiary equity into common.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "shares_short", - "type": "int", - "description": "The reported number of shares short.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "dividend_yield", - "type": "float", - "description": "The dividend yield of the asset, as a normalized percent.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "beta", + "name": "rate", "type": "float", - "description": "The beta of the asset relative to the broad market.", - "default": null, - "optional": true + "description": "FED rate.", + "default": "", + "optional": false } - ] + ], + "federal_reserve": [], + "fred": [] }, - "model": "EquityInfo" + "model": "FEDFUNDS" }, - "/equity/market_snapshots": { + "/fixedincome/rate/effr_forecast": { "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", + "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['fmp', 'intrinio', 'polygon']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "market", - "type": "Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra']", - "description": "The market to fetch data for.", - "default": "nasdaq", + "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 } ], - "intrinio": [ + "fred": [ { - "name": "date", - "type": "Union[Union[date, datetime, str], str]", - "description": "The date of the data. Can be a datetime or an ISO datetime string. Historical data appears to go back to mid-June 2022. Example: '2024-03-08T12:15:00+0400'", - "default": null, + "name": "long_run", + "type": "bool", + "description": "Flag to show long run projections", + "default": false, "optional": true } - ], - "polygon": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[MarketSnapshots]", + "type": "List[PROJECTIONS]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon']]", + "type": "Optional[Literal['fred']]", "description": "Provider name." }, { @@ -20446,425 +30812,388 @@ "data": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "open", + "name": "range_high", "type": "float", - "description": "The open price.", - "default": null, - "optional": true + "description": "High projection of rates.", + "default": "", + "optional": false }, { - "name": "high", + "name": "central_tendency_high", "type": "float", - "description": "The high price.", - "default": null, - "optional": true + "description": "Central tendency of high projection of rates.", + "default": "", + "optional": false }, { - "name": "low", + "name": "median", "type": "float", - "description": "The low price.", - "default": null, - "optional": true + "description": "Median projection of rates.", + "default": "", + "optional": false }, { - "name": "close", + "name": "range_midpoint", "type": "float", - "description": "The close price.", - "default": null, - "optional": true - }, - { - "name": "volume", - "type": "int", - "description": "The trading volume.", - "default": null, - "optional": true + "description": "Midpoint projection of rates.", + "default": "", + "optional": false }, { - "name": "prev_close", + "name": "central_tendency_midpoint", "type": "float", - "description": "The previous close price.", - "default": null, - "optional": true + "description": "Central tendency of midpoint projection of rates.", + "default": "", + "optional": false }, { - "name": "change", + "name": "range_low", "type": "float", - "description": "The change in price from the previous close.", - "default": null, - "optional": true + "description": "Low projection of rates.", + "default": "", + "optional": false }, { - "name": "change_percent", + "name": "central_tendency_low", "type": "float", - "description": "The change in price from the previous close, as a normalized percent.", - "default": null, - "optional": true + "description": "Central tendency of low projection of rates.", + "default": "", + "optional": false } ], - "fmp": [ - { - "name": "last_price", - "type": "float", - "description": "The last price of the stock.", - "default": null, - "optional": true - }, - { - "name": "last_price_timestamp", - "type": "Union[date, datetime]", - "description": "The timestamp of the last price.", - "default": null, - "optional": true - }, - { - "name": "ma50", - "type": "float", - "description": "The 50-day moving average.", - "default": null, - "optional": true - }, - { - "name": "ma200", - "type": "float", - "description": "The 200-day moving average.", - "default": null, - "optional": true - }, - { - "name": "year_high", - "type": "float", - "description": "The 52-week high.", - "default": null, - "optional": true - }, + "fred": [] + }, + "model": "PROJECTIONS" + }, + "/fixedincome/rate/estr": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Euro Short-Term Rate.\n\nThe euro short-term rate (\u20acSTR) reflects the wholesale euro unsecured overnight borrowing costs of banks located in\nthe euro area. The \u20acSTR is published on each TARGET2 business day based on transactions conducted and settled on\nthe previous TARGET2 business day (the reporting date \u201cT\u201d) with a maturity date of T+1 which are deemed to have been\nexecuted at arm\u2019s length and thus reflect market rates in an unbiased way.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.estr(provider='fred')\nobb.fixedincome.rate.estr(parameter=number_of_active_banks, provider='fred')\n```\n\n", + "parameters": { + "standard": [ { - "name": "year_low", - "type": "float", - "description": "The 52-week low.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "volume_avg", - "type": "int", - "description": "Average daily trading volume.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "market_cap", - "type": "int", - "description": "Market cap of the stock.", - "default": null, + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", "optional": true - }, + } + ], + "fred": [ { - "name": "eps", - "type": "float", - "description": "Earnings per share.", - "default": null, + "name": "parameter", + "type": "Literal['volume_weighted_trimmed_mean_rate', 'number_of_transactions', 'number_of_active_banks', 'total_volume', 'share_of_volume_of_the_5_largest_active_banks', 'rate_at_75th_percentile_of_volume', 'rate_at_25th_percentile_of_volume']", + "description": "Period of ESTR rate.", + "default": "volume_weighted_trimmed_mean_rate", "optional": true - }, + } + ] + }, + "returns": { + "OBBject": [ { - "name": "pe", - "type": "float", - "description": "Price to earnings ratio.", - "default": null, - "optional": true + "name": "results", + "type": "List[ESTR]", + "description": "Serializable results." }, { - "name": "shares_outstanding", - "type": "int", - "description": "Number of shares outstanding.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "name", - "type": "str", - "description": "The company name associated with the symbol.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "exchange", - "type": "str", - "description": "The exchange of the stock.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "earnings_date", - "type": "Union[date, datetime]", - "description": "The upcoming earnings announcement date.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } - ], - "intrinio": [ - { - "name": "last_price", - "type": "float", - "description": "The last trade price.", - "default": null, - "optional": true - }, - { - "name": "last_size", - "type": "int", - "description": "The last trade size.", - "default": null, - "optional": true - }, - { - "name": "last_volume", - "type": "int", - "description": "The last trade volume.", - "default": null, - "optional": true - }, - { - "name": "last_trade_timestamp", - "type": "datetime", - "description": "The timestamp of the last trade.", - "default": null, - "optional": true - }, + ] + }, + "data": { + "standard": [ { - "name": "bid_size", - "type": "int", - "description": "The size of the last bid price. Bid price and size is not always available.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "bid_price", + "name": "rate", "type": "float", - "description": "The last bid price. Bid price and size is not always available.", - "default": null, - "optional": true - }, + "description": "ESTR rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "ESTR" + }, + "/fixedincome/rate/ecb": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "European Central Bank Interest Rates.\n\nThe Governing Council of the ECB sets the key interest rates for the euro area:\n\n- The interest rate on the main refinancing operations (MRO), which provide\nthe bulk of liquidity to the banking system.\n- The rate on the deposit facility, which banks may use to make overnight deposits with the Eurosystem.\n- The rate on the marginal lending facility, which offers overnight credit to banks from the Eurosystem.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.ecb(provider='fred')\nobb.fixedincome.rate.ecb(interest_rate_type='refinancing', provider='fred')\n```\n\n", + "parameters": { + "standard": [ { - "name": "ask_price", - "type": "float", - "description": "The last ask price. Ask price and size is not always available.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "ask_size", - "type": "int", - "description": "The size of the last ask price. Ask price and size is not always available.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "last_bid_timestamp", - "type": "datetime", - "description": "The timestamp of the last bid price. Bid price and size is not always available.", - "default": null, + "name": "interest_rate_type", + "type": "Literal['deposit', 'lending', 'refinancing']", + "description": "The type of interest rate.", + "default": "lending", "optional": true }, { - "name": "last_ask_timestamp", - "type": "datetime", - "description": "The timestamp of the last ask price. Ask price and size is not always available.", - "default": null, + "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 } ], - "polygon": [ - { - "name": "vwap", - "type": "float", - "description": "The volume weighted average price of the stock on the current trading day.", - "default": null, - "optional": true - }, + "fred": [] + }, + "returns": { + "OBBject": [ { - "name": "prev_open", - "type": "float", - "description": "The previous trading session opening price.", - "default": null, - "optional": true + "name": "results", + "type": "List[EuropeanCentralBankInterestRates]", + "description": "Serializable results." }, { - "name": "prev_high", - "type": "float", - "description": "The previous trading session high price.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "prev_low", - "type": "float", - "description": "The previous trading session low price.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "prev_volume", - "type": "float", - "description": "The previous trading session volume.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "prev_vwap", - "type": "float", - "description": "The previous trading session VWAP.", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "last_updated", - "type": "datetime", - "description": "The last time the data was updated.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "bid", + "name": "rate", "type": "float", - "description": "The current bid price.", - "default": null, - "optional": true - }, + "description": "European Central Bank Interest Rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "EuropeanCentralBankInterestRates" + }, + "/fixedincome/rate/dpcredit": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Discount Window Primary Credit Rate.\n\nA bank rate is the interest rate a nation's central bank charges to its domestic banks to borrow money.\nThe rates central banks charge are set to stabilize the economy.\nIn the United States, the Federal Reserve System's Board of Governors set the bank rate,\nalso known as the discount rate.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.dpcredit(provider='fred')\nobb.fixedincome.rate.dpcredit(start_date='2023-02-01', end_date='2023-05-01', provider='fred')\n```\n\n", + "parameters": { + "standard": [ { - "name": "bid_size", - "type": "int", - "description": "The current bid size.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "ask_size", - "type": "int", - "description": "The current ask size.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "ask", - "type": "float", - "description": "The current ask price.", - "default": null, + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", "optional": true - }, + } + ], + "fred": [ { - "name": "quote_timestamp", - "type": "datetime", - "description": "The timestamp of the last quote.", - "default": null, + "name": "parameter", + "type": "Literal['daily_excl_weekend', 'monthly', 'weekly', 'daily', 'annual']", + "description": "FRED series ID of DWPCR data.", + "default": "daily_excl_weekend", "optional": true - }, + } + ] + }, + "returns": { + "OBBject": [ { - "name": "last_trade_price", - "type": "float", - "description": "The last trade price.", - "default": null, - "optional": true + "name": "results", + "type": "List[DiscountWindowPrimaryCreditRate]", + "description": "Serializable results." }, { - "name": "last_trade_size", - "type": "int", - "description": "The last trade size.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "last_trade_conditions", - "type": "List[int]", - "description": "The last trade condition codes.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "last_trade_exchange", - "type": "int", - "description": "The last trade exchange ID code.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "last_trade_timestamp", - "type": "datetime", - "description": "The last trade timestamp.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } ] }, - "model": "MarketSnapshots" + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "Discount Window Primary Credit Rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "DiscountWindowPrimaryCreditRate" }, - "/etf/search": { + "/fixedincome/spreads/tcm": { "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 - }, + "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": "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", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "exchange", - "type": "Literal['AMEX', 'NYSE', 'NASDAQ', 'ETF', 'TSX', 'EURONEXT']", - "description": "The exchange code the ETF trades on.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "is_active", - "type": "Literal[True, False]", - "description": "Whether the ETF is actively trading.", - "default": null, + "name": "maturity", + "type": "Literal['3m', '2y']", + "description": "The maturity", + "default": "3m", "optional": true - } - ], - "intrinio": [ + }, { - "name": "exchange", - "type": "Literal['xnas', 'arcx', 'bats', 'xnys', 'bvmf', 'xshg', 'xshe', 'xhkg', 'xbom', 'xnse', 'xidx', 'tase', 'xkrx', 'xkls', 'xmex', 'xses', 'roco', 'xtai', 'xbkk', 'xist']", - "description": "Target a specific exchange by providing the MIC code.", - "default": null, + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", "optional": true } - ] + ], + "fred": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EtfSearch]", + "type": "List[TreasuryConstantMaturity]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio']]", + "type": "Optional[Literal['fred']]", "description": "Provider name." }, { @@ -20887,345 +31216,422 @@ "data": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.(ETF)", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "name", - "type": "str", - "description": "Name of the ETF.", - "default": null, - "optional": true + "name": "rate", + "type": "float", + "description": "TreasuryConstantMaturity Rate.", + "default": "", + "optional": false } ], - "fmp": [ + "fred": [] + }, + "model": "TreasuryConstantMaturity" + }, + "/fixedincome/spreads/tcm_effr": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Select Treasury Constant Maturity.\n\nGet data for Selected Treasury Constant Maturity Minus Federal Funds Rate\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S.\nTreasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.tcm_effr(provider='fred')\nobb.fixedincome.spreads.tcm_effr(maturity='10y', provider='fred')\n```\n\n", + "parameters": { + "standard": [ { - "name": "market_cap", - "type": "float", - "description": "The market cap of the ETF.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "sector", - "type": "str", - "description": "The sector of the ETF.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "industry", - "type": "str", - "description": "The industry of the ETF.", - "default": null, + "name": "maturity", + "type": "Literal['10y', '5y', '1y', '6m', '3m']", + "description": "The maturity", + "default": "10y", "optional": true }, { - "name": "beta", - "type": "float", - "description": "The beta of the ETF.", - "default": null, + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", "optional": true + } + ], + "fred": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[SelectedTreasuryConstantMaturity]", + "description": "Serializable results." }, { - "name": "price", - "type": "float", - "description": "The current price of the ETF.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "last_annual_dividend", - "type": "float", - "description": "The last annual dividend paid.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "volume", - "type": "float", - "description": "The current trading volume of the ETF.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "exchange", - "type": "str", - "description": "The exchange code the ETF trades on.", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "Selected Treasury Constant Maturity Rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "SelectedTreasuryConstantMaturity" + }, + "/fixedincome/spreads/treasury_effr": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Select Treasury Bill.\n\nGet Selected Treasury Bill Minus Federal Funds Rate.\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of\nauctioned U.S. Treasuries.\nThe value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.treasury_effr(provider='fred')\nobb.fixedincome.spreads.treasury_effr(maturity='6m', provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "exchange_name", - "type": "str", - "description": "The full name of the exchange the ETF trades on.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "country", - "type": "str", - "description": "The country the ETF is registered in.", - "default": null, + "name": "maturity", + "type": "Literal['3m', '6m']", + "description": "The maturity", + "default": "3m", "optional": true }, { - "name": "actively_trading", - "type": "Literal[True, False]", - "description": "Whether the ETF is actively trading.", - "default": null, + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", "optional": true } ], - "intrinio": [ + "fred": [] + }, + "returns": { + "OBBject": [ { - "name": "exchange", - "type": "str", - "description": "The exchange MIC code.", - "default": null, - "optional": true + "name": "results", + "type": "List[SelectedTreasuryBill]", + "description": "Serializable results." }, { - "name": "figi_ticker", - "type": "str", - "description": "The OpenFIGI ticker.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "ric", - "type": "str", - "description": "The Reuters Instrument Code.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "isin", - "type": "str", - "description": "The International Securities Identification Number.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "sedol", - "type": "str", - "description": "The Stock Exchange Daily Official List.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "intrinio_id", - "type": "str", - "description": "The unique Intrinio ID for the security.", - "default": null, - "optional": true + "name": "rate", + "type": "float", + "description": "SelectedTreasuryBill Rate.", + "default": "", + "optional": false } - ] + ], + "fred": [] }, - "model": "EtfSearch" + "model": "SelectedTreasuryBill" }, - "/etf/historical": { + "/fixedincome/government/us_yield_curve": { "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", + "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": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", - "default": "", - "optional": false - }, - { - "name": "interval", - "type": "str", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - }, - { - "name": "start_date", + "name": "date", "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "description": "A specific date to get data for. Defaults to the most recent FRED entry.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, + "name": "inflation_adjusted", + "type": "bool", + "description": "Get inflation adjusted rates.", + "default": false, "optional": true }, { "name": "provider", - "type": "Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", "optional": true } ], - "fmp": [ + "fred": [] + }, + "returns": { + "OBBject": [ { - "name": "interval", - "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - } - ], - "intrinio": [ + "name": "results", + "type": "List[USYieldCurve]", + "description": "Serializable results." + }, { - "name": "symbol", - "type": "str", - "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "interval", - "type": "Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y']", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "start_time", - "type": "datetime.time", - "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "end_time", - "type": "datetime.time", - "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "maturity", + "type": "float", + "description": "Maturity of the treasury rate in years.", + "default": "", + "optional": false }, { - "name": "timezone", - "type": "str", - "description": "Timezone of the data, in the IANA format (Continent/City).", - "default": "America/New_York", + "name": "rate", + "type": "float", + "description": "Associated rate given in decimal form (0.05 is 5%)", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "USYieldCurve" + }, + "/fixedincome/government/eu_yield_curve": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Euro Area Yield Curve.\n\nGets euro area yield curve data from ECB.\n\nThe graphic depiction of the relationship between the yield on bonds of the same credit quality but different\nmaturities is known as the yield curve. In the past, most market participants have constructed yield curves from\nthe observations of prices and yields in the Treasury market. Two reasons account for this tendency. First,\nTreasury securities are viewed as free of default risk, and differences in creditworthiness do not affect yield\nestimates. Second, as the most active bond market, the Treasury market offers the fewest problems of illiquidity\nor infrequent trading. The key function of the Treasury yield curve is to serve as a benchmark for pricing bonds\nand setting yields in other sectors of the debt market.\n\nIt is clear that the market\u2019s expectations of future rate changes are one important determinant of the\nyield-curve shape. For example, a steeply upward-sloping curve may indicate market expectations of near-term Fed\ntightening or of rising inflation. However, it may be too restrictive to assume that the yield differences across\nbonds with different maturities only reflect the market\u2019s rate expectations. The well-known pure expectations\nhypothesis has such an extreme implication. The pure expectations hypothesis asserts that all government bonds\nhave the same near-term expected return (as the nominally riskless short-term bond) because the return-seeking\nactivity of risk-neutral traders removes all expected return differentials across bonds.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.eu_yield_curve(provider='ecb')\nobb.fixedincome.government.eu_yield_curve(yield_curve_type=spot_rate, provider='ecb')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": null, "optional": true }, { - "name": "source", - "type": "Literal['realtime', 'delayed', 'nasdaq_basic']", - "description": "The source of the data.", - "default": "realtime", + "name": "provider", + "type": "Literal['ecb']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'ecb' if there is no default.", + "default": "ecb", "optional": true } ], - "polygon": [ + "ecb": [ { - "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", + "name": "rating", + "type": "Literal['aaa', 'all_ratings']", + "description": "The rating type, either 'aaa' or 'all_ratings'.", + "default": "aaa", "optional": true }, { - "name": "adjustment", - "type": "Literal['splits_only', 'unadjusted']", - "description": "The adjustment factor to apply. Default is splits only.", - "default": "splits_only", + "name": "yield_curve_type", + "type": "Literal['spot_rate', 'instantaneous_forward', 'par_yield']", + "description": "The yield curve type.", + "default": "spot_rate", "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EUYieldCurve]", + "description": "Serializable results." }, { - "name": "extended_hours", - "type": "bool", - "description": "Include Pre and Post market data.", - "default": false, - "optional": true + "name": "provider", + "type": "Optional[Literal['ecb']]", + "description": "Provider name." }, { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", - "default": "asc", - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 49999, - "optional": true - } - ], - "tiingo": [ + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, { - "name": "interval", - "type": "Literal['1d', '1W', '1M', '1Y']", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } - ], - "yfinance": [ - { - "name": "interval", - "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - }, + ] + }, + "data": { + "standard": [ { - "name": "extended_hours", - "type": "bool", - "description": "Include Pre and Post market data.", - "default": false, + "name": "maturity", + "type": "float", + "description": "Maturity, in years.", + "default": null, "optional": true }, { - "name": "include_actions", - "type": "bool", - "description": "Include dividends and stock splits in results.", - "default": true, + "name": "rate", + "type": "float", + "description": "Yield curve rate, as a normalized percent.", + "default": null, "optional": true - }, + } + ], + "ecb": [] + }, + "model": "EUYieldCurve" + }, + "/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": "adjustment", - "type": "Literal['splits_only', 'splits_and_dividends']", - "description": "The adjustment factor to apply. Default is splits only.", - "default": "splits_only", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, "optional": true }, { - "name": "adjusted", - "type": "bool", - "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead.", - "default": false, + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, "optional": true }, { - "name": "prepost", - "type": "bool", - "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead.", - "default": false, + "name": "provider", + "type": "Literal['federal_reserve', 'fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default.", + "default": "federal_reserve", "optional": true } - ] + ], + "federal_reserve": [], + "fmp": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EtfHistorical]", + "type": "List[TreasuryRates]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']]", + "type": "Optional[Literal['federal_reserve', 'fmp']]", "description": "Provider name." }, { @@ -21249,315 +31655,179 @@ "standard": [ { "name": "date", - "type": "Union[date, datetime]", + "type": "date", "description": "The date of the data.", "default": "", "optional": false }, { - "name": "open", - "type": "float", - "description": "The open price.", - "default": "", - "optional": false - }, - { - "name": "high", - "type": "float", - "description": "The high price.", - "default": "", - "optional": false - }, - { - "name": "low", - "type": "float", - "description": "The low price.", - "default": "", - "optional": false - }, - { - "name": "close", - "type": "float", - "description": "The close price.", - "default": "", - "optional": false - }, - { - "name": "volume", - "type": "Union[int, float]", - "description": "The trading volume.", - "default": null, - "optional": true - }, - { - "name": "vwap", - "type": "float", - "description": "Volume Weighted Average Price over the period.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "adj_close", - "type": "float", - "description": "The adjusted close price.", - "default": null, - "optional": true - }, - { - "name": "unadjusted_volume", - "type": "float", - "description": "Unadjusted volume of the symbol.", - "default": null, - "optional": true - }, - { - "name": "change", - "type": "float", - "description": "Change in the price from the previous close.", - "default": null, - "optional": true - }, - { - "name": "change_percent", - "type": "float", - "description": "Change in the price from the previous close, as a normalized percent.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "average", + "name": "week_4", "type": "float", - "description": "Average trade price of an individual equity during the interval.", + "description": "4 week Treasury bills rate (secondary market).", "default": null, "optional": true }, { - "name": "change", + "name": "month_1", "type": "float", - "description": "Change in the price of the symbol from the previous day.", + "description": "1 month Treasury rate.", "default": null, "optional": true }, { - "name": "change_percent", + "name": "month_2", "type": "float", - "description": "Percent change in the price of the symbol from the previous day.", + "description": "2 month Treasury rate.", "default": null, "optional": true }, { - "name": "adj_open", + "name": "month_3", "type": "float", - "description": "The adjusted open price.", + "description": "3 month Treasury rate.", "default": null, "optional": true }, { - "name": "adj_high", + "name": "month_6", "type": "float", - "description": "The adjusted high price.", + "description": "6 month Treasury rate.", "default": null, "optional": true }, { - "name": "adj_low", + "name": "year_1", "type": "float", - "description": "The adjusted low price.", + "description": "1 year Treasury rate.", "default": null, "optional": true }, { - "name": "adj_close", + "name": "year_2", "type": "float", - "description": "The adjusted close price.", + "description": "2 year Treasury rate.", "default": null, "optional": true }, { - "name": "adj_volume", + "name": "year_3", "type": "float", - "description": "The adjusted volume.", + "description": "3 year Treasury rate.", "default": null, "optional": true }, { - "name": "fifty_two_week_high", + "name": "year_5", "type": "float", - "description": "52 week high price for the symbol.", + "description": "5 year Treasury rate.", "default": null, "optional": true }, { - "name": "fifty_two_week_low", + "name": "year_7", "type": "float", - "description": "52 week low price for the symbol.", + "description": "7 year Treasury rate.", "default": null, "optional": true }, { - "name": "factor", + "name": "year_10", "type": "float", - "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices.", + "description": "10 year Treasury rate.", "default": null, "optional": true }, { - "name": "split_ratio", + "name": "year_20", "type": "float", - "description": "Ratio of the equity split, if a split occurred.", + "description": "20 year Treasury rate.", "default": null, "optional": true }, { - "name": "dividend", + "name": "year_30", "type": "float", - "description": "Dividend amount, if a dividend was paid.", - "default": null, - "optional": true - }, - { - "name": "close_time", - "type": "datetime", - "description": "The timestamp that represents the end of the interval span.", - "default": null, - "optional": true - }, - { - "name": "interval", - "type": "str", - "description": "The data time frequency.", - "default": null, - "optional": true - }, - { - "name": "intra_period", - "type": "bool", - "description": "If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period", - "default": null, - "optional": true - } - ], - "polygon": [ - { - "name": "transactions", - "type": "Annotated[int, Gt(gt=0)]", - "description": "Number of transactions for the symbol in the time period.", + "description": "30 year Treasury rate.", "default": null, "optional": true } ], - "tiingo": [ - { - "name": "adj_open", - "type": "float", - "description": "The adjusted open price.", - "default": null, - "optional": true - }, - { - "name": "adj_high", - "type": "float", - "description": "The adjusted high price.", - "default": null, - "optional": true - }, - { - "name": "adj_low", - "type": "float", - "description": "The adjusted low price.", - "default": null, - "optional": true - }, + "federal_reserve": [], + "fmp": [] + }, + "model": "TreasuryRates" + }, + "/fixedincome/government/treasury_auctions": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Government Treasury Auctions.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.treasury_auctions(provider='government_us')\nobb.fixedincome.government.treasury_auctions(security_type='Bill', start_date='2022-01-01', end_date='2023-01-01', provider='government_us')\n```\n\n", + "parameters": { + "standard": [ { - "name": "adj_close", - "type": "float", - "description": "The adjusted close price.", + "name": "security_type", + "type": "Literal['Bill', 'Note', 'Bond', 'CMB', 'TIPS', 'FRN']", + "description": "Used to only return securities of a particular type.", "default": null, "optional": true }, { - "name": "adj_volume", - "type": "float", - "description": "The adjusted volume.", + "name": "cusip", + "type": "str", + "description": "Filter securities by CUSIP.", "default": null, "optional": true }, { - "name": "split_ratio", - "type": "float", - "description": "Ratio of the equity split, if a split occurred.", + "name": "page_size", + "type": "int", + "description": "Maximum number of results to return; you must also include pagenum when using pagesize.", "default": null, "optional": true }, { - "name": "dividend", - "type": "float", - "description": "Dividend amount, if a dividend was paid.", - "default": null, - "optional": true - } - ], - "yfinance": [ - { - "name": "split_ratio", - "type": "float", - "description": "Ratio of the equity split, if a split occurred.", + "name": "page_num", + "type": "int", + "description": "The first page number to display results for; used in combination with page size.", "default": null, "optional": true }, { - "name": "dividend", - "type": "float", - "description": "Dividend amount (split-adjusted), if a dividend was paid.", - "default": null, - "optional": true - } - ] - }, - "model": "EtfHistorical" - }, - "/etf/info": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "ETF Information Overview.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.info(symbol='SPY', provider='fmp')\n# This function accepts multiple tickers.\nobb.etf.info(symbol='SPY,IWM,QQQ,DJIA', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, intrinio, yfinance.", - "default": "", - "optional": false + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format. The default is 90 days ago.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format. The default is today.", + "default": null, + "optional": true }, { "name": "provider", - "type": "Literal['fmp', 'intrinio', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "type": "Literal['government_us']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'government_us' if there is no default.", + "default": "government_us", "optional": true } ], - "fmp": [], - "intrinio": [], - "yfinance": [] + "government_us": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EtfInfo]", + "type": "List[TreasuryAuctions]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "type": "Optional[Literal['government_us']]", "description": "Provider name." }, { @@ -21580,1178 +31850,1477 @@ "data": { "standard": [ { - "name": "symbol", + "name": "cusip", "type": "str", - "description": "Symbol representing the entity requested in the data. (ETF)", + "description": "CUSIP of the Security.", "default": "", "optional": false }, { - "name": "name", - "type": "str", - "description": "Name of the ETF.", + "name": "issue_date", + "type": "date", + "description": "The issue date of the security.", "default": "", "optional": false }, { - "name": "description", - "type": "str", - "description": "Description of the fund.", - "default": null, - "optional": true + "name": "security_type", + "type": "Literal['Bill', 'Note', 'Bond', 'CMB', 'TIPS', 'FRN']", + "description": "The type of security.", + "default": "", + "optional": false }, { - "name": "inception_date", + "name": "security_term", "type": "str", - "description": "Inception date of the ETF.", + "description": "The term of the security.", "default": "", "optional": false - } - ], - "fmp": [ + }, { - "name": "issuer", - "type": "str", - "description": "Company of the ETF.", + "name": "maturity_date", + "type": "date", + "description": "The maturity date of the security.", + "default": "", + "optional": false + }, + { + "name": "interest_rate", + "type": "float", + "description": "The interest rate of the security.", "default": null, "optional": true }, { - "name": "cusip", - "type": "str", - "description": "CUSIP of the ETF.", + "name": "cpi_on_issue_date", + "type": "float", + "description": "Reference CPI rate on the issue date of the security.", "default": null, "optional": true }, { - "name": "isin", - "type": "str", - "description": "ISIN of the ETF.", + "name": "cpi_on_dated_date", + "type": "float", + "description": "Reference CPI rate on the dated date of the security.", "default": null, "optional": true }, { - "name": "domicile", - "type": "str", - "description": "Domicile of the ETF.", + "name": "announcement_date", + "type": "date", + "description": "The announcement date of the security.", "default": null, "optional": true }, { - "name": "asset_class", - "type": "str", - "description": "Asset class of the ETF.", + "name": "auction_date", + "type": "date", + "description": "The auction date of the security.", "default": null, "optional": true }, { - "name": "aum", + "name": "auction_date_year", + "type": "int", + "description": "The auction date year of the security.", + "default": null, + "optional": true + }, + { + "name": "dated_date", + "type": "date", + "description": "The dated date of the security.", + "default": null, + "optional": true + }, + { + "name": "first_payment_date", + "type": "date", + "description": "The first payment date of the security.", + "default": null, + "optional": true + }, + { + "name": "accrued_interest_per_100", "type": "float", - "description": "Assets under management.", + "description": "Accrued interest per $100.", "default": null, "optional": true }, { - "name": "nav", + "name": "accrued_interest_per_1000", "type": "float", - "description": "Net asset value of the ETF.", + "description": "Accrued interest per $1000.", "default": null, "optional": true }, { - "name": "nav_currency", - "type": "str", - "description": "Currency of the ETF's net asset value.", + "name": "adjusted_accrued_interest_per_100", + "type": "float", + "description": "Adjusted accrued interest per $100.", "default": null, "optional": true }, { - "name": "expense_ratio", + "name": "adjusted_accrued_interest_per_1000", "type": "float", - "description": "The expense ratio, as a normalized percent.", + "description": "Adjusted accrued interest per $1000.", "default": null, "optional": true }, { - "name": "holdings_count", - "type": "int", - "description": "Number of holdings.", + "name": "adjusted_price", + "type": "float", + "description": "Adjusted price.", "default": null, "optional": true }, { - "name": "avg_volume", + "name": "allocation_percentage", "type": "float", - "description": "Average daily trading volume.", + "description": "Allocation percentage, as normalized percentage points.", "default": null, "optional": true }, { - "name": "website", + "name": "allocation_percentage_decimals", + "type": "float", + "description": "The number of decimals in the Allocation percentage.", + "default": null, + "optional": true + }, + { + "name": "announced_cusip", "type": "str", - "description": "Website of the issuer.", + "description": "The announced CUSIP of the security.", "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "fund_listing_date", - "type": "date", - "description": "The date on which the Exchange Traded Product (ETP) or share class of the ETP is listed on a specific exchange.", + "name": "auction_format", + "type": "str", + "description": "The auction format of the security.", "default": null, "optional": true }, { - "name": "data_change_date", - "type": "date", - "description": "The last date on which there was a change in a classifications data field for this ETF.", + "name": "avg_median_discount_rate", + "type": "float", + "description": "The average median discount rate of the security.", "default": null, "optional": true }, { - "name": "etn_maturity_date", + "name": "avg_median_investment_rate", + "type": "float", + "description": "The average median investment rate of the security.", + "default": null, + "optional": true + }, + { + "name": "avg_median_price", + "type": "float", + "description": "The average median price paid for the security.", + "default": null, + "optional": true + }, + { + "name": "avg_median_discount_margin", + "type": "float", + "description": "The average median discount margin of the security.", + "default": null, + "optional": true + }, + { + "name": "avg_median_yield", + "type": "float", + "description": "The average median yield of the security.", + "default": null, + "optional": true + }, + { + "name": "back_dated", + "type": "Literal['Yes', 'No']", + "description": "Whether the security is back dated.", + "default": null, + "optional": true + }, + { + "name": "back_dated_date", "type": "date", - "description": "If the product is an ETN, this field identifies the maturity date for the ETN.", + "description": "The back dated date of the security.", "default": null, "optional": true }, { - "name": "is_listed", - "type": "bool", - "description": "If true, the ETF is still listed on an exchange.", + "name": "bid_to_cover_ratio", + "type": "float", + "description": "The bid to cover ratio of the security.", "default": null, "optional": true }, { - "name": "close_date", + "name": "call_date", "type": "date", - "description": "The date on which the ETF was de-listed if it is no longer listed.", + "description": "The call date of the security.", "default": null, "optional": true }, { - "name": "exchange", - "type": "str", - "description": "The exchange Market Identifier Code (MIC).", + "name": "callable", + "type": "Literal['Yes', 'No']", + "description": "Whether the security is callable.", "default": null, "optional": true }, { - "name": "isin", - "type": "str", - "description": "International Securities Identification Number (ISIN).", + "name": "called_date", + "type": "date", + "description": "The called date of the security.", "default": null, "optional": true }, { - "name": "ric", - "type": "str", - "description": "Reuters Instrument Code (RIC).", + "name": "cash_management_bill", + "type": "Literal['Yes', 'No']", + "description": "Whether the security is a cash management bill.", "default": null, "optional": true }, { - "name": "sedol", + "name": "closing_time_competitive", "type": "str", - "description": "Stock Exchange Daily Official List (SEDOL).", + "description": "The closing time for competitive bids on the security.", "default": null, "optional": true }, { - "name": "figi_symbol", + "name": "closing_time_non_competitive", "type": "str", - "description": "Financial Instrument Global Identifier (FIGI) symbol.", + "description": "The closing time for non-competitive bids on the security.", "default": null, "optional": true }, { - "name": "share_class_figi", - "type": "str", - "description": "Financial Instrument Global Identifier (FIGI).", + "name": "competitive_accepted", + "type": "int", + "description": "The accepted value for competitive bids on the security.", "default": null, "optional": true }, { - "name": "firstbridge_id", - "type": "str", - "description": "The FirstBridge unique identifier for the Exchange Traded Fund (ETF).", + "name": "competitive_accepted_decimals", + "type": "int", + "description": "The number of decimals in the Competitive Accepted.", "default": null, "optional": true }, { - "name": "firstbridge_parent_id", - "type": "str", - "description": "The FirstBridge unique identifier for the parent Exchange Traded Fund (ETF), if applicable.", + "name": "competitive_tendered", + "type": "int", + "description": "The tendered value for competitive bids on the security.", "default": null, "optional": true }, { - "name": "intrinio_id", - "type": "str", - "description": "Intrinio unique identifier for the security.", + "name": "competitive_tenders_accepted", + "type": "Literal['Yes', 'No']", + "description": "Whether competitive tenders are accepted on the security.", "default": null, "optional": true }, { - "name": "intraday_nav_symbol", + "name": "corp_us_cusip", "type": "str", - "description": "Intraday Net Asset Value (NAV) symbol.", + "description": "The CUSIP of the security.", "default": null, "optional": true }, { - "name": "primary_symbol", + "name": "cpi_base_reference_period", "type": "str", - "description": "The primary ticker field is used for Exchange Traded Products (ETPs) that have multiple listings and share classes. If an ETP has multiple listings or share classes, the same primary ticker is assigned to all the listings and share classes.", + "description": "The CPI base reference period of the security.", "default": null, "optional": true }, { - "name": "etp_structure_type", - "type": "str", - "description": "Classifies Exchange Traded Products (ETPs) into very broad categories based on its legal structure.", + "name": "currently_outstanding", + "type": "int", + "description": "The currently outstanding value on the security.", "default": null, "optional": true }, { - "name": "legal_structure", - "type": "str", - "description": "Legal structure of the fund.", + "name": "direct_bidder_accepted", + "type": "int", + "description": "The accepted value from direct bidders on the security.", "default": null, "optional": true }, { - "name": "issuer", - "type": "str", - "description": "Issuer of the ETF.", + "name": "direct_bidder_tendered", + "type": "int", + "description": "The tendered value from direct bidders on the security.", "default": null, "optional": true }, { - "name": "etn_issuing_bank", - "type": "str", - "description": "If the product is an Exchange Traded Note (ETN), this field identifies the issuing bank.", + "name": "est_amount_of_publicly_held_maturing_security", + "type": "int", + "description": "The estimated amount of publicly held maturing securities on the security.", "default": null, "optional": true }, { - "name": "fund_family", - "type": "str", - "description": "This field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor.", + "name": "fima_included", + "type": "Literal['Yes', 'No']", + "description": "Whether the security is included in the FIMA (Foreign and International Money Authorities).", "default": null, "optional": true }, { - "name": "investment_style", - "type": "str", - "description": "Investment style of the ETF.", + "name": "fima_non_competitive_accepted", + "type": "int", + "description": "The non-competitive accepted value on the security from FIMAs.", "default": null, "optional": true }, { - "name": "derivatives_based", - "type": "str", - "description": "This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio.", + "name": "fima_non_competitive_tendered", + "type": "int", + "description": "The non-competitive tendered value on the security from FIMAs.", "default": null, "optional": true }, { - "name": "income_category", + "name": "first_interest_period", "type": "str", - "description": "Identifies if an Exchange Traded Fund (ETF) falls into a category that is specifically designed to provide a high yield or income", + "description": "The first interest period of the security.", "default": null, "optional": true }, { - "name": "asset_class", - "type": "str", - "description": "Captures the underlying nature of the securities in the Exchanged Traded Product (ETP).", + "name": "first_interest_payment_date", + "type": "date", + "description": "The first interest payment date of the security.", "default": null, "optional": true }, { - "name": "other_asset_types", - "type": "str", - "description": "If 'asset_class' field is classified as 'Other Asset Types' this field captures the specific category of the underlying assets.", + "name": "floating_rate", + "type": "Literal['Yes', 'No']", + "description": "Whether the security is a floating rate.", "default": null, "optional": true }, { - "name": "single_category_designation", - "type": "str", - "description": "This categorization is created for those users who want every ETF to be 'forced' into a single bucket, so that the assets for all categories will always sum to the total market.", + "name": "frn_index_determination_date", + "type": "date", + "description": "The FRN index determination date of the security.", "default": null, "optional": true }, { - "name": "beta_type", - "type": "str", - "description": "This field identifies whether an ETF provides 'Traditional' beta exposure or 'Smart' beta exposure. ETFs that are active (i.e. non-indexed), leveraged / inverse or have a proprietary quant model (i.e. that don't provide indexed exposure to a targeted factor) are classified separately.", + "name": "frn_index_determination_rate", + "type": "float", + "description": "The FRN index determination rate of the security.", "default": null, "optional": true }, { - "name": "beta_details", - "type": "str", - "description": "This field provides further detail within the traditional and smart beta categories.", + "name": "high_discount_rate", + "type": "float", + "description": "The high discount rate of the security.", "default": null, "optional": true }, { - "name": "market_cap_range", - "type": "str", - "description": "Equity ETFs are classified as falling into categories based on the description of their investment strategy in the prospectus. Examples ('Mega Cap', 'Large Cap', 'Mid Cap', etc.)", + "name": "high_investment_rate", + "type": "float", + "description": "The high investment rate of the security.", "default": null, "optional": true }, { - "name": "market_cap_weighting_type", - "type": "str", - "description": "For ETFs that take the value 'Market Cap Weighted' in the 'index_weighting_scheme' field, this field provides detail on the market cap weighting type.", + "name": "high_price", + "type": "float", + "description": "The high price of the security at auction.", "default": null, "optional": true }, { - "name": "index_weighting_scheme", - "type": "str", - "description": "For ETFs that track an underlying index, this field provides detail on the index weighting type.", + "name": "high_discount_margin", + "type": "float", + "description": "The high discount margin of the security.", "default": null, "optional": true }, { - "name": "index_linked", - "type": "str", - "description": "This field identifies whether an ETF is index linked or active.", + "name": "high_yield", + "type": "float", + "description": "The high yield of the security at auction.", + "default": null, + "optional": true + }, + { + "name": "index_ratio_on_issue_date", + "type": "float", + "description": "The index ratio on the issue date of the security.", "default": null, "optional": true }, { - "name": "index_name", - "type": "str", - "description": "This field identifies the name of the underlying index tracked by the ETF, if applicable.", + "name": "indirect_bidder_accepted", + "type": "int", + "description": "The accepted value from indirect bidders on the security.", "default": null, "optional": true }, { - "name": "index_symbol", - "type": "str", - "description": "This field identifies the OpenFIGI ticker for the Index underlying the ETF.", + "name": "indirect_bidder_tendered", + "type": "int", + "description": "The tendered value from indirect bidders on the security.", "default": null, "optional": true }, { - "name": "parent_index", + "name": "interest_payment_frequency", "type": "str", - "description": "This field identifies the name of the parent index, which represents the broader universe from which the index underlying the ETF is created, if applicable.", + "description": "The interest payment frequency of the security.", "default": null, "optional": true }, { - "name": "index_family", - "type": "str", - "description": "This field identifies the index family to which the index underlying the ETF belongs. The index family is represented as categorized by the index provider.", + "name": "low_discount_rate", + "type": "float", + "description": "The low discount rate of the security.", "default": null, "optional": true }, { - "name": "broader_index_family", - "type": "str", - "description": "This field identifies the broader index family to which the index underlying the ETF belongs. The broader index family is represented as categorized by the index provider.", + "name": "low_investment_rate", + "type": "float", + "description": "The low investment rate of the security.", "default": null, "optional": true }, { - "name": "index_provider", - "type": "str", - "description": "This field identifies the Index provider for the index underlying the ETF, if applicable.", + "name": "low_price", + "type": "float", + "description": "The low price of the security at auction.", "default": null, "optional": true }, { - "name": "index_provider_code", - "type": "str", - "description": "This field provides the First Bridge code for each Index provider, corresponding to the index underlying the ETF if applicable.", + "name": "low_discount_margin", + "type": "float", + "description": "The low discount margin of the security.", "default": null, "optional": true }, { - "name": "replication_structure", - "type": "str", - "description": "The replication structure of the Exchange Traded Product (ETP).", + "name": "low_yield", + "type": "float", + "description": "The low yield of the security at auction.", "default": null, "optional": true }, { - "name": "growth_value_tilt", - "type": "str", - "description": "Classifies equity ETFs as either 'Growth' or Value' based on the stated style tilt in the ETF prospectus. Equity ETFs that do not have a stated style tilt are classified as 'Core / Blend'.", + "name": "maturing_date", + "type": "date", + "description": "The maturing date of the security.", "default": null, "optional": true }, { - "name": "growth_type", - "type": "str", - "description": "For ETFs that are classified as 'Growth' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their growth (style factor) scores.", + "name": "max_competitive_award", + "type": "int", + "description": "The maximum competitive award at auction.", "default": null, "optional": true }, { - "name": "value_type", - "type": "str", - "description": "For ETFs that are classified as 'Value' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their value (style factor) scores.", + "name": "max_non_competitive_award", + "type": "int", + "description": "The maximum non-competitive award at auction.", "default": null, "optional": true }, { - "name": "sector", - "type": "str", - "description": "For equity ETFs that aim to provide targeted exposure to a sector or industry, this field identifies the Sector that it provides the exposure to.", + "name": "max_single_bid", + "type": "int", + "description": "The maximum single bid at auction.", "default": null, "optional": true }, { - "name": "industry", - "type": "str", - "description": "For equity ETFs that aim to provide targeted exposure to an industry, this field identifies the Industry that it provides the exposure to.", + "name": "min_bid_amount", + "type": "int", + "description": "The minimum bid amount at auction.", "default": null, "optional": true }, { - "name": "industry_group", - "type": "str", - "description": "For equity ETFs that aim to provide targeted exposure to a sub-industry, this field identifies the sub-Industry that it provides the exposure to.", + "name": "min_strip_amount", + "type": "int", + "description": "The minimum strip amount at auction.", "default": null, "optional": true }, { - "name": "cross_sector_theme", - "type": "str", - "description": "For equity ETFs that aim to provide targeted exposure to a specific investment theme that cuts across GICS sectors, this field identifies the specific cross-sector theme. Examples ('Agri-business', 'Natural Resources', 'Green Investing', etc.)", + "name": "min_to_issue", + "type": "int", + "description": "The minimum to issue at auction.", "default": null, "optional": true }, { - "name": "natural_resources_type", - "type": "str", - "description": "For ETFs that are classified as 'Natural Resources' in the 'cross_sector_theme' field, this field provides further detail on the type of Natural Resources exposure.", + "name": "multiples_to_bid", + "type": "int", + "description": "The multiples to bid at auction.", "default": null, "optional": true }, { - "name": "us_or_excludes_us", - "type": "str", - "description": "Takes the value of 'Domestic' for US exposure, 'International' for non-US exposure and 'Global' for exposure that includes all regions including the US.", + "name": "multiples_to_issue", + "type": "int", + "description": "The multiples to issue at auction.", "default": null, "optional": true }, { - "name": "developed_emerging", - "type": "str", - "description": "This field identifies the stage of development of the markets that the ETF provides exposure to.", + "name": "nlp_exclusion_amount", + "type": "int", + "description": "The NLP exclusion amount at auction.", "default": null, "optional": true }, { - "name": "specialized_region", - "type": "str", - "description": "This field is populated if the ETF provides targeted exposure to a specific type of geography-based grouping that does not fall into a specific country or continent grouping. Examples ('BRIC', 'Chindia', etc.)", + "name": "nlp_reporting_threshold", + "type": "int", + "description": "The NLP reporting threshold at auction.", "default": null, "optional": true }, { - "name": "continent", - "type": "str", - "description": "This field is populated if the ETF provides targeted exposure to a specific continent or country within that Continent.", + "name": "non_competitive_accepted", + "type": "int", + "description": "The accepted value from non-competitive bidders on the security.", "default": null, "optional": true }, { - "name": "latin_america_sub_group", - "type": "str", - "description": "For ETFs that are classified as 'Latin America' in the 'continent' field, this field provides further detail on the type of regional exposure.", + "name": "non_competitive_tenders_accepted", + "type": "Literal['Yes', 'No']", + "description": "Whether or not the auction accepted non-competitive tenders.", "default": null, "optional": true }, { - "name": "europe_sub_group", - "type": "str", - "description": "For ETFs that are classified as 'Europe' in the 'continent' field, this field provides further detail on the type of regional exposure.", + "name": "offering_amount", + "type": "int", + "description": "The offering amount at auction.", "default": null, "optional": true }, { - "name": "asia_sub_group", + "name": "original_cusip", "type": "str", - "description": "For ETFs that are classified as 'Asia' in the 'continent' field, this field provides further detail on the type of regional exposure.", + "description": "The original CUSIP of the security.", "default": null, "optional": true }, { - "name": "specific_country", - "type": "str", - "description": "This field is populated if the ETF provides targeted exposure to a specific country.", + "name": "original_dated_date", + "type": "date", + "description": "The original dated date of the security.", "default": null, "optional": true }, { - "name": "china_listing_location", - "type": "str", - "description": "For ETFs that are classified as 'China' in the 'country' field, this field provides further detail on the type of exposure in the underlying securities.", + "name": "original_issue_date", + "type": "date", + "description": "The original issue date of the security.", "default": null, "optional": true }, { - "name": "us_state", + "name": "original_security_term", "type": "str", - "description": "Takes the value of a US state if the ETF provides targeted exposure to the municipal bonds or equities of companies.", + "description": "The original term of the security.", "default": null, "optional": true }, { - "name": "real_estate", + "name": "pdf_announcement", "type": "str", - "description": "For ETFs that provide targeted real estate exposure, this field is populated if the ETF provides targeted exposure to a specific segment of the real estate market.", + "description": "The PDF filename for the announcement of the security.", "default": null, "optional": true }, { - "name": "fundamental_weighting_type", + "name": "pdf_competitive_results", "type": "str", - "description": "For ETFs that take the value 'Fundamental Weighted' in the 'index_weighting_scheme' field, this field provides detail on the fundamental weighting methodology.", + "description": "The PDF filename for the competitive results of the security.", "default": null, "optional": true }, { - "name": "dividend_weighting_type", + "name": "pdf_non_competitive_results", "type": "str", - "description": "For ETFs that take the value 'Dividend Weighted' in the 'index_weighting_scheme' field, this field provides detail on the dividend weighting methodology.", + "description": "The PDF filename for the non-competitive results of the security.", "default": null, "optional": true }, { - "name": "bond_type", + "name": "pdf_special_announcement", "type": "str", - "description": "For ETFs where 'asset_class_type' is 'Bonds', this field provides detail on the type of bonds held in the ETF.", + "description": "The PDF filename for the special announcements.", "default": null, "optional": true }, { - "name": "government_bond_types", - "type": "str", - "description": "For bond ETFs that take the value 'Treasury & Government' in 'bond_type', this field provides detail on the exposure.", + "name": "price_per_100", + "type": "float", + "description": "The price per 100 of the security.", "default": null, "optional": true }, { - "name": "municipal_bond_region", - "type": "str", - "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field provides additional detail on the geographic exposure.", + "name": "primary_dealer_accepted", + "type": "int", + "description": "The primary dealer accepted value on the security.", "default": null, "optional": true }, { - "name": "municipal_vrdo", - "type": "bool", - "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field identifies those ETFs that specifically provide exposure to Variable Rate Demand Obligations.", + "name": "primary_dealer_tendered", + "type": "int", + "description": "The primary dealer tendered value on the security.", "default": null, "optional": true }, { - "name": "mortgage_bond_types", - "type": "str", - "description": "For bond ETFs that take the value 'Mortgage' in 'bond_type', this field provides additional detail on the type of underlying securities.", + "name": "reopening", + "type": "Literal['Yes', 'No']", + "description": "Whether or not the auction was reopened.", "default": null, "optional": true }, { - "name": "bond_tax_status", + "name": "security_term_day_month", "type": "str", - "description": "For all US bond ETFs, this field provides additional detail on the tax treatment of the underlying securities.", + "description": "The security term in days or months.", "default": null, "optional": true }, { - "name": "credit_quality", + "name": "security_term_week_year", "type": "str", - "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific credit quality range.", + "description": "The security term in weeks or years.", "default": null, "optional": true }, { - "name": "average_maturity", + "name": "series", "type": "str", - "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific maturity range.", + "description": "The series name of the security.", "default": null, "optional": true }, { - "name": "specific_maturity_year", + "name": "soma_accepted", "type": "int", - "description": "For all bond ETFs that take the value 'Specific Maturity Year' in the 'average_maturity' field, this field specifies the calendar year.", + "description": "The SOMA accepted value on the security.", "default": null, "optional": true }, { - "name": "commodity_types", - "type": "str", - "description": "For ETFs where 'asset_class_type' is 'Commodities', this field provides detail on the type of commodities held in the ETF.", + "name": "soma_holdings", + "type": "int", + "description": "The SOMA holdings on the security.", "default": null, "optional": true }, { - "name": "energy_type", - "type": "str", - "description": "For ETFs where 'commodity_type' is 'Energy', this field provides detail on the type of energy exposure provided by the ETF.", + "name": "soma_included", + "type": "Literal['Yes', 'No']", + "description": "Whether or not the SOMA (System Open Market Account) was included on the security.", "default": null, "optional": true }, { - "name": "agricultural_type", - "type": "str", - "description": "For ETFs where 'commodity_type' is 'Agricultural', this field provides detail on the type of agricultural exposure provided by the ETF.", + "name": "soma_tendered", + "type": "int", + "description": "The SOMA tendered value on the security.", "default": null, "optional": true }, { - "name": "livestock_type", - "type": "str", - "description": "For ETFs where 'commodity_type' is 'Livestock', this field provides detail on the type of livestock exposure provided by the ETF.", + "name": "spread", + "type": "float", + "description": "The spread on the security.", "default": null, "optional": true }, { - "name": "metal_type", - "type": "str", - "description": "For ETFs where 'commodity_type' is 'Gold & Metals', this field provides detail on the type of exposure provided by the ETF.", + "name": "standard_payment_per_1000", + "type": "float", + "description": "The standard payment per 1000 of the security.", "default": null, "optional": true }, { - "name": "inverse_leveraged", - "type": "str", - "description": "This field is populated if the ETF provides inverse or leveraged exposure.", + "name": "strippable", + "type": "Literal['Yes', 'No']", + "description": "Whether or not the security is strippable.", "default": null, "optional": true }, { - "name": "target_date_multi_asset_type", + "name": "term", "type": "str", - "description": "For ETFs where 'asset_class_type' is 'Target Date / MultiAsset', this field provides detail on the type of commodities held in the ETF.", + "description": "The term of the security.", "default": null, "optional": true }, { - "name": "currency_pair", - "type": "str", - "description": "This field is populated if the ETF's strategy involves providing exposure to the movements of a currency or involves hedging currency exposure.", + "name": "tiin_conversion_factor_per_1000", + "type": "float", + "description": "The TIIN conversion factor per 1000 of the security.", "default": null, "optional": true }, { - "name": "social_environmental_type", - "type": "str", - "description": "This field is populated if the ETF's strategy involves providing exposure to a specific social or environmental theme.", + "name": "tips", + "type": "Literal['Yes', 'No']", + "description": "Whether or not the security is TIPS.", "default": null, "optional": true }, { - "name": "clean_energy_type", - "type": "str", - "description": "This field is populated if the ETF has a value of 'Clean Energy' in the 'social_environmental_type' field.", + "name": "total_accepted", + "type": "int", + "description": "The total accepted value at auction.", "default": null, "optional": true }, { - "name": "dividend_type", - "type": "str", - "description": "This field is populated if the ETF has an intended investment objective of holding dividend-oriented stocks as stated in the prospectus.", + "name": "total_tendered", + "type": "int", + "description": "The total tendered value at auction.", "default": null, "optional": true }, { - "name": "regular_dividend_payor_type", - "type": "str", - "description": "This field is populated if the ETF has a value of'Dividend - Regular Payors' in the 'dividend_type' field.", + "name": "treasury_retail_accepted", + "type": "int", + "description": "The accepted value on the security from retail.", "default": null, "optional": true }, { - "name": "quant_strategies_type", - "type": "str", - "description": "This field is populated if the ETF has either an index-linked or active strategy that is based on a proprietary quantitative strategy.", + "name": "treasury_retail_tenders_accepted", + "type": "Literal['Yes', 'No']", + "description": "Whether or not the tender offers from retail are accepted", "default": null, "optional": true }, { - "name": "other_quant_models", + "name": "type", "type": "str", - "description": "For ETFs where 'quant_strategies_type' is 'Other Quant Model', this field provides the name of the specific proprietary quant model used as the underlying strategy for the ETF.", + "description": "The type of issuance. This might be different than the security type.", "default": null, "optional": true }, { - "name": "hedge_fund_type", - "type": "str", - "description": "For ETFs where 'other_asset_types' is 'Hedge Fund Replication', this field provides detail on the type of hedge fund replication strategy.", + "name": "unadjusted_accrued_interest_per_1000", + "type": "float", + "description": "The unadjusted accrued interest per 1000 of the security.", "default": null, "optional": true }, { - "name": "excludes_financials", - "type": "bool", - "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold financials stocks, based on the funds intended objective.", + "name": "unadjusted_price", + "type": "float", + "description": "The unadjusted price of the security.", "default": null, "optional": true }, { - "name": "excludes_technology", - "type": "bool", - "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold technology stocks, based on the funds intended objective.", + "name": "updated_timestamp", + "type": "datetime", + "description": "The updated timestamp of the security.", "default": null, "optional": true }, { - "name": "holds_only_nyse_stocks", - "type": "bool", - "description": "If true, the ETF is an equity ETF and holds only stocks listed on NYSE.", + "name": "xml_announcement", + "type": "str", + "description": "The XML filename for the announcement of the security.", "default": null, "optional": true }, { - "name": "holds_only_nasdaq_stocks", - "type": "bool", - "description": "If true, the ETF is an equity ETF and holds only stocks listed on Nasdaq.", + "name": "xml_competitive_results", + "type": "str", + "description": "The XML filename for the competitive results of the security.", "default": null, "optional": true }, { - "name": "holds_mlp", - "type": "bool", - "description": "If true, the ETF's investment objective explicitly specifies that it holds MLPs as an intended part of its investment strategy.", + "name": "xml_special_announcement", + "type": "str", + "description": "The XML filename for special announcements.", "default": null, "optional": true }, { - "name": "holds_preferred_stock", - "type": "bool", - "description": "If true, the ETF's investment objective explicitly specifies that it holds preferred stock as an intended part of its investment strategy.", + "name": "tint_cusip1", + "type": "str", + "description": "Tint CUSIP 1.", "default": null, "optional": true }, { - "name": "holds_closed_end_funds", - "type": "bool", - "description": "If true, the ETF's investment objective explicitly specifies that it holds closed end funds as an intended part of its investment strategy.", + "name": "tint_cusip2", + "type": "str", + "description": "Tint CUSIP 2.", "default": null, "optional": true - }, + } + ], + "government_us": [] + }, + "model": "TreasuryAuctions" + }, + "/fixedincome/government/treasury_prices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Government Treasury Prices by date.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.treasury_prices(provider='government_us')\nobb.fixedincome.government.treasury_prices(date='2019-02-05', provider='government_us')\n```\n\n", + "parameters": { + "standard": [ { - "name": "holds_adr", - "type": "bool", - "description": "If true, he ETF's investment objective explicitly specifies that it holds American Depositary Receipts (ADRs) as an intended part of its investment strategy.", + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for. Defaults to the last business day.", "default": null, "optional": true }, { - "name": "laddered", - "type": "bool", - "description": "For bond ETFs, this field identifies those ETFs that specifically hold bonds in a laddered structure, where the bonds are scheduled to mature in an annual, sequential structure.", + "name": "provider", + "type": "Literal['government_us', 'tmx']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'government_us' if there is no default.", + "default": "government_us", + "optional": true + } + ], + "government_us": [ + { + "name": "cusip", + "type": "str", + "description": "Filter by CUSIP.", "default": null, "optional": true }, { - "name": "zero_coupon", - "type": "bool", - "description": "For bond ETFs, this field identifies those ETFs that specifically hold zero coupon Treasury Bills.", + "name": "security_type", + "type": "Literal['bill', 'note', 'bond', 'tips', 'frn']", + "description": "Filter by security type.", "default": null, "optional": true + } + ], + "tmx": [ + { + "name": "govt_type", + "type": "Literal['federal', 'provincial', 'municipal']", + "description": "The level of government issuer.", + "default": "federal", + "optional": true }, { - "name": "floating_rate", - "type": "bool", - "description": "For bond ETFs, this field identifies those ETFs that specifically hold floating rate bonds.", + "name": "issue_date_min", + "type": "date", + "description": "Filter by the minimum original issue date.", "default": null, "optional": true }, { - "name": "build_america_bonds", - "type": "bool", - "description": "For municipal bond ETFs, this field identifies those ETFs that specifically hold Build America Bonds.", + "name": "issue_date_max", + "type": "date", + "description": "Filter by the maximum original issue date.", "default": null, "optional": true }, { - "name": "dynamic_futures_roll", - "type": "bool", - "description": "If the product holds futures contracts, this field identifies those products where the roll strategy is dynamic (rather than entirely rules based), so as to minimize roll costs.", + "name": "last_traded_min", + "type": "date", + "description": "Filter by the minimum last trade date.", "default": null, "optional": true }, { - "name": "currency_hedged", - "type": "bool", - "description": "This field is populated if the ETF's strategy involves hedging currency exposure.", + "name": "maturity_date_min", + "type": "date", + "description": "Filter by the minimum maturity date.", "default": null, "optional": true }, { - "name": "includes_short_exposure", - "type": "bool", - "description": "This field is populated if the ETF has short exposure in any of its holdings e.g. in a long/short or inverse ETF.", + "name": "maturity_date_max", + "type": "date", + "description": "Filter by the maximum maturity date.", "default": null, "optional": true }, { - "name": "ucits", + "name": "use_cache", "type": "bool", - "description": "If true, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant", - "default": null, + "description": "All bond data is sourced from a single JSON file that is updated daily. The file is cached for one day to eliminate downloading more than once. Caching will significantly speed up subsequent queries. To bypass, set to False.", + "default": true, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[TreasuryPrices]", + "description": "Serializable results." }, { - "name": "registered_countries", - "type": "str", - "description": "The list of countries where the ETF is legally registered for sale. This may differ from where the ETF is domiciled or traded, particularly in Europe.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['government_us', 'tmx']]", + "description": "Provider name." }, { - "name": "issuer_country", - "type": "str", - "description": "2 letter ISO country code for the country where the issuer is located.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "domicile", + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "issuer_name", "type": "str", - "description": "2 letter ISO country code for the country where the ETP is domiciled.", + "description": "Name of the issuing entity.", "default": null, "optional": true }, { - "name": "listing_country", + "name": "cusip", "type": "str", - "description": "2 letter ISO country code for the country of the primary listing.", + "description": "CUSIP of the security.", "default": null, "optional": true }, { - "name": "listing_region", + "name": "isin", "type": "str", - "description": "Geographic region in the country of the primary listing falls.", + "description": "ISIN of the security.", "default": null, "optional": true }, { - "name": "bond_currency_denomination", + "name": "security_type", "type": "str", - "description": "For all bond ETFs, this field provides additional detail on the currency denomination of the underlying securities.", + "description": "The type of Treasury security - i.e., Bill, Note, Bond, TIPS, FRN.", "default": null, "optional": true }, { - "name": "base_currency", - "type": "str", - "description": "Base currency in which NAV is reported.", + "name": "issue_date", + "type": "date", + "description": "The original issue date of the security.", "default": null, "optional": true }, { - "name": "listing_currency", - "type": "str", - "description": "Listing currency of the Exchange Traded Product (ETP) in which it is traded. Reported using the 3-digit ISO currency code.", + "name": "maturity_date", + "type": "date", + "description": "The maturity date of the security.", "default": null, "optional": true }, { - "name": "number_of_holdings", - "type": "int", - "description": "The number of holdings in the ETF.", + "name": "call_date", + "type": "date", + "description": "The call date of the security.", "default": null, "optional": true }, { - "name": "month_end_assets", + "name": "bid", "type": "float", - "description": "Net assets in millions of dollars as of the most recent month end.", + "description": "The bid price of the security.", "default": null, "optional": true }, { - "name": "net_expense_ratio", + "name": "offer", "type": "float", - "description": "Gross expense net of Fee Waivers, as a percentage of net assets as published by the ETF issuer.", + "description": "The offer price of the security.", "default": null, "optional": true }, { - "name": "etf_portfolio_turnover", + "name": "eod_price", "type": "float", - "description": "The percentage of positions turned over in the last 12 months.", + "description": "The end-of-day price of the security.", "default": null, "optional": true - } - ], - "yfinance": [ + }, { - "name": "fund_type", - "type": "str", - "description": "The legal type of fund.", + "name": "last_traded_date", + "type": "date", + "description": "The last trade date of the security.", "default": null, "optional": true }, { - "name": "fund_family", - "type": "str", - "description": "The fund family.", + "name": "total_trades", + "type": "int", + "description": "Total number of trades on the last traded date.", "default": null, "optional": true }, { - "name": "category", - "type": "str", - "description": "The fund category.", + "name": "last_price", + "type": "float", + "description": "The last price of the security.", "default": null, "optional": true }, { - "name": "exchange", - "type": "str", - "description": "The exchange the fund is listed on.", + "name": "highest_price", + "type": "float", + "description": "The highest price for the bond on the last traded date.", "default": null, "optional": true }, { - "name": "exchange_timezone", - "type": "str", - "description": "The timezone of the exchange.", + "name": "lowest_price", + "type": "float", + "description": "The lowest price for the bond on the last traded date.", "default": null, "optional": true }, { - "name": "currency", - "type": "str", - "description": "The currency in which the fund is listed.", + "name": "rate", + "type": "float", + "description": "The annualized interest rate or coupon of the security.", "default": null, "optional": true }, { - "name": "nav_price", + "name": "ytm", "type": "float", - "description": "The net asset value per unit of the fund.", + "description": "Yield to maturity (YTM) is the rate of return anticipated on a bond if it is held until the maturity date. It takes into account the current market price, par value, coupon rate and time to maturity. It is assumed that all coupons are reinvested at the same rate.", "default": null, "optional": true - }, + } + ], + "government_us": [], + "tmx": [] + }, + "model": "TreasuryPrices" + }, + "/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": "total_assets", - "type": "int", - "description": "The total value of assets held by the fund.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "trailing_pe", - "type": "float", - "description": "The trailing twelve month P/E ratio of the fund's assets.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "dividend_yield", - "type": "float", - "description": "The dividend yield of the fund, as a normalized percent.", - "default": null, + "name": "index_type", + "type": "Literal['yield', 'yield_to_worst', 'total_return', 'spread']", + "description": "The type of series.", + "default": "yield", "optional": true }, { - "name": "dividend_rate_ttm", - "type": "float", - "description": "The trailing twelve month annual dividend rate of the fund, in currency units.", - "default": null, + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", "optional": true - }, + } + ], + "fred": [ { - "name": "dividend_yield_ttm", - "type": "float", - "description": "The trailing twelve month annual dividend yield of the fund, as a normalized percent.", - "default": null, + "name": "category", + "type": "Literal['all', 'duration', 'eur', 'usd']", + "description": "The type of category.", + "default": "all", "optional": true }, { - "name": "year_high", - "type": "float", - "description": "The fifty-two week high price.", - "default": null, + "name": "area", + "type": "Literal['asia', 'emea', 'eu', 'ex_g10', 'latin_america', 'us']", + "description": "The type of area.", + "default": "us", "optional": true }, { - "name": "year_low", - "type": "float", - "description": "The fifty-two week low price.", - "default": null, + "name": "grade", + "type": "Literal['a', 'aa', 'aaa', 'b', 'bb', 'bbb', 'ccc', 'crossover', 'high_grade', 'high_yield', 'non_financial', 'non_sovereign', 'private_sector', 'public_sector']", + "description": "The type of grade.", + "default": "non_sovereign", "optional": true }, { - "name": "ma_50d", - "type": "float", - "description": "50-day moving average price.", - "default": null, + "name": "options", + "type": "bool", + "description": "Whether to include options in the results.", + "default": false, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[ICEBofA]", + "description": "Serializable results." }, { - "name": "ma_200d", + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", "type": "float", - "description": "200-day moving average price.", + "description": "ICE BofA US Corporate Bond Indices Rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "ICEBofA" + }, + "/fixedincome/corporate/moody": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Moody Corporate Bond Index.\n\nMoody's Aaa and Baa are investment bonds that acts as an index of\nthe performance of all bonds given an Aaa or Baa rating by Moody's Investors Service respectively.\nThese corporate bonds often are used in macroeconomics as an alternative to the federal ten-year\nTreasury Bill as an indicator of the interest rate.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.corporate.moody(provider='fred')\nobb.fixedincome.corporate.moody(index_type='baa', provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "return_ytd", - "type": "float", - "description": "The year-to-date return of the fund, as a normalized percent.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "return_3y_avg", - "type": "float", - "description": "The three year average return of the fund, as a normalized percent.", - "default": null, + "name": "index_type", + "type": "Literal['aaa', 'baa']", + "description": "The type of series.", + "default": "aaa", "optional": true }, { - "name": "return_5y_avg", - "type": "float", - "description": "The five year average return of the fund, as a normalized percent.", - "default": null, + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", "optional": true - }, + } + ], + "fred": [ { - "name": "beta_3y_avg", - "type": "float", - "description": "The three year average beta of the fund.", + "name": "spread", + "type": "Literal['treasury', 'fed_funds']", + "description": "The type of spread.", "default": null, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[MoodyCorporateBondIndex]", + "description": "Serializable results." }, { - "name": "volume_avg", - "type": "float", - "description": "The average daily trading volume of the fund.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "volume_avg_10d", - "type": "float", - "description": "The average daily trading volume of the fund over the past ten days.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "bid", - "type": "float", - "description": "The current bid price.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "bid_size", - "type": "float", - "description": "The current bid size.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "ask", + "name": "rate", "type": "float", - "description": "The current ask price.", + "description": "Moody Corporate Bond Index Rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "MoodyCorporateBondIndex" + }, + "/fixedincome/corporate/hqm": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "High Quality Market Corporate Bond.\n\nThe HQM yield curve represents the high quality corporate bond market, i.e.,\ncorporate bonds rated AAA, AA, or A. The HQM curve contains two regression terms.\nThese terms are adjustment factors that blend AAA, AA, and A bonds into a single HQM yield curve\nthat is the market-weighted average (MWA) quality of high quality bonds.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.corporate.hqm(provider='fred')\nobb.fixedincome.corporate.hqm(yield_curve='par', provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", "default": null, "optional": true }, { - "name": "ask_size", - "type": "float", - "description": "The current ask size.", - "default": null, + "name": "yield_curve", + "type": "Literal['spot', 'par']", + "description": "The yield curve type.", + "default": "spot", "optional": true }, { - "name": "open", - "type": "float", - "description": "The open price of the most recent trading session.", - "default": null, + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", "optional": true + } + ], + "fred": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[HighQualityMarketCorporateBond]", + "description": "Serializable results." }, { - "name": "high", - "type": "float", - "description": "The highest price of the most recent trading session.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "low", - "type": "float", - "description": "The lowest price of the most recent trading session.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "volume", - "type": "int", - "description": "The trading volume of the most recent trading session.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "prev_close", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", "type": "float", - "description": "The previous closing price.", - "default": null, - "optional": true + "description": "HighQualityMarketCorporateBond Rate.", + "default": "", + "optional": false + }, + { + "name": "maturity", + "type": "str", + "description": "Maturity.", + "default": "", + "optional": false + }, + { + "name": "yield_curve", + "type": "Literal['spot', 'par']", + "description": "The yield curve type.", + "default": "", + "optional": false + } + ], + "fred": [ + { + "name": "series_id", + "type": "str", + "description": "FRED series id.", + "default": "", + "optional": false } ] }, - "model": "EtfInfo" + "model": "HighQualityMarketCorporateBond" }, - "/etf/sectors": { + "/fixedincome/corporate/spot_rates": { "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", + "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": "symbol", - "type": "str", - "description": "Symbol to get data for. (ETF)", - "default": "", - "optional": false + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "maturity", + "type": "Union[Union[float, str], List[Union[float, str]]]", + "description": "Maturities in years. Multiple items allowed for provider(s): fred.", + "default": 10.0, + "optional": true + }, + { + "name": "category", + "type": "Union[str, List[str]]", + "description": "Rate category. Options: spot_rate, par_yield. Multiple items allowed for provider(s): fred.", + "default": "spot_rate", + "optional": true }, { "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", "optional": true } ], - "fmp": [] + "fred": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EtfSectors]", + "type": "List[SpotRate]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['fred']]", "description": "Provider name." }, { @@ -22774,60 +33343,88 @@ "data": { "standard": [ { - "name": "sector", - "type": "str", - "description": "Sector of exposure.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "weight", + "name": "rate", "type": "float", - "description": "Exposure of the ETF to the sector in normalized percentage points.", + "description": "Spot Rate.", "default": "", "optional": false } ], - "fmp": [] + "fred": [] }, - "model": "EtfSectors" + "model": "SpotRate" }, - "/etf/countries": { + "/fixedincome/corporate/commercial_paper": { "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", + "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": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp.", - "default": "", - "optional": false + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "maturity", + "type": "Literal['overnight', '7d', '15d', '30d', '60d', '90d']", + "description": "The maturity.", + "default": "30d", + "optional": true + }, + { + "name": "category", + "type": "Literal['asset_backed', 'financial', 'nonfinancial']", + "description": "The category.", + "default": "financial", + "optional": true + }, + { + "name": "grade", + "type": "Literal['aa', 'a2_p2']", + "description": "The grade.", + "default": "aa", + "optional": true }, { "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", "optional": true } ], - "fmp": [] + "fred": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EtfCountries]", + "type": "List[CommercialPaper]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['fred']]", "description": "Provider name." }, { @@ -22850,391 +33447,483 @@ "data": { "standard": [ { - "name": "country", - "type": "str", - "description": "The country of the exposure. Corresponding values are normalized percentage points.", + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "Commercial Paper Rate.", "default": "", "optional": false } ], - "fmp": [] + "fred": [] }, - "model": "EtfCountries" + "model": "CommercialPaper" }, - "/etf/price_performance": { + "/fixedincome/corporate/bond_prices": { "deprecated": { "flag": null, "message": null }, - "description": "Price performance as a return, over different periods.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.price_performance(symbol='QQQ', provider='fmp')\nobb.etf.price_performance(symbol='SPY,QQQ,IWM,DJIA', provider='fmp')\n```\n\n", + "description": "Corporate Bond Prices.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.corporate.bond_prices(provider='tmx')\n```\n\n", "parameters": { "standard": [ { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['fmp', 'intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [], - "intrinio": [ - { - "name": "return_type", - "type": "Literal['trailing', 'calendar']", - "description": "The type of returns to return, a trailing or calendar window.", - "default": "trailing", + "name": "country", + "type": "str", + "description": "The country to get data. Matches partial name.", + "default": null, "optional": true }, { - "name": "adjustment", - "type": "Literal['splits_only', 'splits_and_dividends']", - "description": "The adjustment factor, 'splits_only' will return pure price performance.", - "default": "splits_and_dividends", + "name": "issuer_name", + "type": "str", + "description": "Name of the issuer. Returns partial matches and is case insensitive.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EtfPricePerformance]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "isin", + "type": "Union[List, str]", + "description": "International Securities Identification Number(s) of the bond(s).", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", + "name": "lei", "type": "str", - "description": "Symbol representing the entity requested in the data.", + "description": "Legal Entity Identifier of the issuing entity.", "default": null, "optional": true }, { - "name": "one_day", - "type": "float", - "description": "One-day return.", + "name": "currency", + "type": "Union[List, str]", + "description": "Currency of the bond. Formatted as the 3-letter ISO 4217 code (e.g. GBP, EUR, USD).", "default": null, "optional": true }, { - "name": "wtd", + "name": "coupon_min", "type": "float", - "description": "Week to date return.", + "description": "Minimum coupon rate of the bond.", "default": null, "optional": true }, { - "name": "one_week", + "name": "coupon_max", "type": "float", - "description": "One-week return.", + "description": "Maximum coupon rate of the bond.", "default": null, "optional": true }, { - "name": "mtd", - "type": "float", - "description": "Month to date return.", + "name": "issued_amount_min", + "type": "int", + "description": "Minimum issued amount of the bond.", "default": null, "optional": true }, { - "name": "one_month", - "type": "float", - "description": "One-month return.", + "name": "issued_amount_max", + "type": "str", + "description": "Maximum issued amount of the bond.", "default": null, "optional": true }, { - "name": "qtd", - "type": "float", - "description": "Quarter to date return.", + "name": "maturity_date_min", + "type": "date", + "description": "Minimum maturity date of the bond.", "default": null, "optional": true }, { - "name": "three_month", - "type": "float", - "description": "Three-month return.", + "name": "maturity_date_max", + "type": "date", + "description": "Maximum maturity date of the bond.", "default": null, "optional": true }, { - "name": "six_month", - "type": "float", - "description": "Six-month return.", + "name": "provider", + "type": "Literal['tmx']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default.", + "default": "tmx", + "optional": true + } + ], + "tmx": [ + { + "name": "issue_date_min", + "type": "date", + "description": "Filter by the minimum original issue date.", "default": null, "optional": true }, { - "name": "ytd", - "type": "float", - "description": "Year to date return.", + "name": "issue_date_max", + "type": "date", + "description": "Filter by the maximum original issue date.", "default": null, "optional": true }, { - "name": "one_year", - "type": "float", - "description": "One-year return.", + "name": "last_traded_min", + "type": "date", + "description": "Filter by the minimum last trade date.", "default": null, "optional": true }, { - "name": "two_year", - "type": "float", - "description": "Two-year return.", - "default": null, + "name": "use_cache", + "type": "bool", + "description": "All bond data is sourced from a single JSON file that is updated daily. The file is cached for one day to eliminate downloading more than once. Caching will significantly speed up subsequent queries. To bypass, set to False.", + "default": true, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[BondPrices]", + "description": "Serializable results." }, { - "name": "three_year", - "type": "float", - "description": "Three-year return.", + "name": "provider", + "type": "Optional[Literal['tmx']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "isin", + "type": "str", + "description": "International Securities Identification Number of the bond.", "default": null, "optional": true }, { - "name": "four_year", - "type": "float", - "description": "Four-year", + "name": "lei", + "type": "str", + "description": "Legal Entity Identifier of the issuing entity.", "default": null, "optional": true }, { - "name": "five_year", - "type": "float", - "description": "Five-year return.", + "name": "figi", + "type": "str", + "description": "FIGI of the bond.", "default": null, "optional": true }, { - "name": "ten_year", - "type": "float", - "description": "Ten-year return.", + "name": "cusip", + "type": "str", + "description": "CUSIP of the bond.", "default": null, "optional": true }, { - "name": "max", + "name": "coupon_rate", "type": "float", - "description": "Return from the beginning of the time series.", + "description": "Coupon rate of the bond.", "default": null, "optional": true } ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "The ticker symbol.", - "default": "", - "optional": false - } - ], - "intrinio": [ + "tmx": [ { - "name": "max_annualized", + "name": "ytm", "type": "float", - "description": "Annualized rate of return from inception.", + "description": "Yield to maturity (YTM) is the rate of return anticipated on a bond if it is held until the maturity date. It takes into account the current market price, par value, coupon rate and time to maturity. It is assumed that all coupons are reinvested at the same rate. Values are returned as a normalized percent.", "default": null, "optional": true }, { - "name": "volatility_one_year", + "name": "price", "type": "float", - "description": "Trailing one-year annualized volatility.", + "description": "The last price for the bond.", "default": null, "optional": true }, { - "name": "volatility_three_year", + "name": "highest_price", "type": "float", - "description": "Trailing three-year annualized volatility.", + "description": "The highest price for the bond on the last traded date.", "default": null, "optional": true }, { - "name": "volatility_five_year", + "name": "lowest_price", "type": "float", - "description": "Trailing five-year annualized volatility.", + "description": "The lowest price for the bond on the last traded date.", "default": null, "optional": true }, { - "name": "volume", + "name": "total_trades", "type": "int", - "description": "The trading volume.", + "description": "Total number of trades on the last traded date.", "default": null, "optional": true }, { - "name": "volume_avg_30", - "type": "float", - "description": "The one-month average daily volume.", + "name": "last_traded_date", + "type": "date", + "description": "Last traded date of the bond.", "default": null, "optional": true }, { - "name": "volume_avg_90", - "type": "float", - "description": "The three-month average daily volume.", + "name": "maturity_date", + "type": "date", + "description": "Maturity date of the bond.", "default": null, "optional": true }, { - "name": "volume_avg_180", - "type": "float", - "description": "The six-month average daily volume.", + "name": "issue_date", + "type": "date", + "description": "Issue date of the bond. This is the date when the bond first accrues interest.", "default": null, "optional": true }, { - "name": "beta", - "type": "float", - "description": "Beta compared to the S&P 500.", + "name": "issuer_name", + "type": "str", + "description": "Name of the issuing entity.", "default": null, "optional": true - }, + } + ] + }, + "model": "BondPrices" + }, + "/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": "nav", - "type": "float", - "description": "Net asset value per share.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "year_high", - "type": "float", - "description": "The 52-week high price.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "year_low", - "type": "float", - "description": "The 52-week low price.", - "default": null, + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", "optional": true - }, + } + ], + "fred": [ { - "name": "market_cap", - "type": "float", - "description": "The market capitalization.", - "default": null, + "name": "period", + "type": "Literal['overnight', '30_day', '90_day', '180_day', 'index']", + "description": "Period of SOFR rate.", + "default": "overnight", "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[SOFR]", + "description": "Serializable results." }, { - "name": "shares_outstanding", - "type": "int", - "description": "The number of shares outstanding.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "updated", + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", "type": "date", "description": "The date of the data.", - "default": null, - "optional": true + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "SOFR rate.", + "default": "", + "optional": false } - ] + ], + "fred": [] }, - "model": "EtfPricePerformance" + "model": "SOFR" }, - "/etf/holdings": { + "/index/price/historical": { "deprecated": { "flag": null, "message": null }, - "description": "Get the holdings for an individual ETF.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings(symbol='XLK', provider='fmp')\n# Including a date (FMP, SEC) will return the holdings as per NPORT-P filings.\nobb.etf.holdings(symbol='XLK', date=2022-03-31, provider='fmp')\n# The same data can be returned from the SEC directly.\nobb.etf.holdings(symbol='XLK', date=2022-03-31, provider='sec')\n```\n\n", + "description": "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": "str", - "description": "Symbol to get data for. (ETF)", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance.", "default": "", "optional": false }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, { "name": "provider", - "type": "Literal['fmp', 'intrinio', '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", + "type": "Literal['cboe', '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 'cboe' if there is no default.", + "default": "cboe", "optional": true } ], - "fmp": [ + "cboe": [ { - "name": "date", - "type": "Union[Union[str, date], str]", - "description": "A specific date to get data for. Entering a date will attempt to return the NPORT-P filing for the entered date. This needs to be _exactly_ the date of the filing. Use the holdings_date command/endpoint to find available filing dates for the ETF.", - "default": null, + "name": "interval", + "type": "Literal['1m', '1d']", + "description": "Time interval of the data to return. The most recent trading day is not including in daily historical data. Intraday data is only available for the most recent trading day at 1 minute intervals.", + "default": "1d", "optional": true }, { - "name": "cik", - "type": "str", - "description": "The CIK of the filing entity. Overrides symbol.", - "default": null, + "name": "use_cache", + "type": "bool", + "description": "When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass.", + "default": true, + "optional": true + } + ], + "fmp": [ + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", "optional": true } ], "intrinio": [ { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10000, "optional": true } ], - "sec": [ + "polygon": [ { - "name": "date", - "type": "Union[Union[str, date], str]", - "description": "A specific date to get data for. The date represents the period ending. The date entered will return the closest filing.", - "default": null, + "name": "interval", + "type": "str", + "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", + "default": "1d", "optional": true }, { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache for the request.", - "default": true, + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", + "default": "asc", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 49999, + "optional": true + } + ], + "yfinance": [ + { + "name": "interval", + "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", + "description": "Time interval of the data to return.", + "default": "1d", "optional": true } ] @@ -23243,12 +33932,12 @@ "OBBject": [ { "name": "results", - "type": "List[EtfHoldings]", + "type": "List[IndexHistorical]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'sec']]", + "type": "Optional[Literal['cboe', 'fmp', 'intrinio', 'polygon', 'yfinance']]", "description": "Provider name." }, { @@ -23266,931 +33955,1009 @@ "type": "Dict[str, Any]", "description": "Extra info." } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data. (ETF)", - "default": null, - "optional": true - }, - { - "name": "name", - "type": "str", - "description": "Name of the ETF holding.", - "default": null, - "optional": true - } - ], - "fmp": [ + ] + }, + "data": { + "standard": [ { - "name": "lei", - "type": "str", - "description": "The LEI of the holding.", - "default": null, - "optional": true + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "title", - "type": "str", - "description": "The title of the holding.", + "name": "open", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The open price.", "default": null, "optional": true }, { - "name": "cusip", - "type": "str", - "description": "The CUSIP of the holding.", + "name": "high", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The high price.", "default": null, "optional": true }, { - "name": "isin", - "type": "str", - "description": "The ISIN of the holding.", + "name": "low", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The low price.", "default": null, "optional": true }, { - "name": "balance", - "type": "int", - "description": "The balance of the holding, in shares or units.", + "name": "close", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The close price.", "default": null, "optional": true }, { - "name": "units", - "type": "Union[str, float]", - "description": "The type of units.", + "name": "volume", + "type": "int", + "description": "The trading volume.", "default": null, "optional": true - }, + } + ], + "cboe": [ { - "name": "currency", - "type": "str", - "description": "The currency of the holding.", + "name": "calls_volume", + "type": "float", + "description": "Number of calls traded during the most recent trading period. Only valid if interval is 1m.", "default": null, "optional": true }, { - "name": "value", + "name": "puts_volume", "type": "float", - "description": "The value of the holding, in dollars.", + "description": "Number of puts traded during the most recent trading period. Only valid if interval is 1m.", "default": null, "optional": true }, { - "name": "weight", + "name": "total_options_volume", "type": "float", - "description": "The weight of the holding, as a normalized percent.", + "description": "Total number of options traded during the most recent trading period. Only valid if interval is 1m.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "payoff_profile", - "type": "str", - "description": "The payoff profile of the holding.", + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", "default": null, "optional": true }, { - "name": "asset_category", - "type": "str", - "description": "The asset category of the holding.", + "name": "change", + "type": "float", + "description": "Change in the price from the previous close.", "default": null, "optional": true }, { - "name": "issuer_category", - "type": "str", - "description": "The issuer category of the holding.", + "name": "change_percent", + "type": "float", + "description": "Change in the price from the previous close, as a normalized percent.", "default": null, "optional": true - }, + } + ], + "intrinio": [], + "polygon": [ { - "name": "country", - "type": "str", - "description": "The country of the holding.", + "name": "transactions", + "type": "Annotated[int, Gt(gt=0)]", + "description": "Number of transactions for the symbol in the time period.", "default": null, "optional": true - }, + } + ], + "yfinance": [] + }, + "model": "IndexHistorical" + }, + "/index/market": { + "deprecated": { + "flag": true, + "message": "This endpoint is deprecated; use `/index/price/historical` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.3." + }, + "description": "Get Historical Market Indices.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.market(symbol='^IBEX', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "is_restricted", - "type": "str", - "description": "Whether the holding is restricted.", - "default": null, - "optional": true + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance.", + "default": "", + "optional": false }, { - "name": "fair_value_level", - "type": "int", - "description": "The fair value level of the holding.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "is_cash_collateral", - "type": "str", - "description": "Whether the holding is cash collateral.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "is_non_cash_collateral", + "name": "interval", "type": "str", - "description": "Whether the holding is non-cash collateral.", - "default": null, + "description": "Time interval of the data to return.", + "default": "1d", "optional": true }, { - "name": "is_loan_by_fund", - "type": "str", - "description": "Whether the holding is loan by fund.", - "default": null, + "name": "provider", + "type": "Literal['cboe', '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 'cboe' if there is no default.", + "default": "cboe", "optional": true - }, + } + ], + "cboe": [ { - "name": "cik", - "type": "str", - "description": "The CIK of the filing.", - "default": null, + "name": "interval", + "type": "Literal['1m', '1d']", + "description": "Time interval of the data to return. The most recent trading day is not including in daily historical data. Intraday data is only available for the most recent trading day at 1 minute intervals.", + "default": "1d", "optional": true }, { - "name": "acceptance_datetime", - "type": "str", - "description": "The acceptance datetime of the filing.", - "default": null, + "name": "use_cache", + "type": "bool", + "description": "When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass.", + "default": true, "optional": true - }, + } + ], + "fmp": [ { - "name": "updated", - "type": "Union[date, datetime]", - "description": "The date the data was updated.", - "default": null, + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", "optional": true } ], "intrinio": [ { - "name": "name", - "type": "str", - "description": "The common name for the holding.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10000, "optional": true - }, + } + ], + "polygon": [ { - "name": "security_type", + "name": "interval", "type": "str", - "description": "The type of instrument for this holding. Examples(Bond='BOND', Equity='EQUI')", - "default": null, + "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", + "default": "1d", "optional": true }, { - "name": "isin", - "type": "str", - "description": "The International Securities Identification Number.", - "default": null, + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", + "default": "asc", "optional": true }, { - "name": "ric", - "type": "str", - "description": "The Reuters Instrument Code.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 49999, "optional": true - }, + } + ], + "yfinance": [ { - "name": "sedol", - "type": "str", - "description": "The Stock Exchange Daily Official List.", - "default": null, + "name": "interval", + "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", + "description": "Time interval of the data to return.", + "default": "1d", "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[MarketIndices]", + "description": "Serializable results." }, { - "name": "share_class_figi", - "type": "str", - "description": "The OpenFIGI symbol for the holding.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['cboe', 'fmp', 'intrinio', 'polygon', 'yfinance']]", + "description": "Provider name." }, { - "name": "country", - "type": "str", - "description": "The country or region of the holding.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "maturity_date", - "type": "date", - "description": "The maturity date for the debt security, if available.", + "name": "open", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The open price.", "default": null, "optional": true }, { - "name": "contract_expiry_date", - "type": "date", - "description": "Expiry date for the futures contract held, if available.", + "name": "high", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The high price.", "default": null, "optional": true }, { - "name": "coupon", - "type": "float", - "description": "The coupon rate of the debt security, if available.", + "name": "low", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The low price.", "default": null, "optional": true }, { - "name": "balance", - "type": "Union[int, float]", - "description": "The number of units of the security held, if available.", + "name": "close", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The close price.", "default": null, "optional": true }, { - "name": "unit", - "type": "str", - "description": "The units of the 'balance' field.", + "name": "volume", + "type": "int", + "description": "The trading volume.", "default": null, "optional": true - }, + } + ], + "cboe": [ { - "name": "units_per_share", + "name": "calls_volume", "type": "float", - "description": "Number of units of the security held per share outstanding of the ETF, if available.", + "description": "Number of calls traded during the most recent trading period. Only valid if interval is 1m.", "default": null, "optional": true }, { - "name": "face_value", + "name": "puts_volume", "type": "float", - "description": "The face value of the debt security, if available.", + "description": "Number of puts traded during the most recent trading period. Only valid if interval is 1m.", "default": null, "optional": true }, { - "name": "derivatives_value", + "name": "total_options_volume", "type": "float", - "description": "The notional value of derivatives contracts held.", + "description": "Total number of options traded during the most recent trading period. Only valid if interval is 1m.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "value", + "name": "vwap", "type": "float", - "description": "The market value of the holding, on the 'as_of' date.", + "description": "Volume Weighted Average Price over the period.", "default": null, "optional": true }, { - "name": "weight", + "name": "change", "type": "float", - "description": "The weight of the holding, as a normalized percent.", + "description": "Change in the price from the previous close.", "default": null, "optional": true }, { - "name": "updated", - "type": "date", - "description": "The 'as_of' date for the holding.", + "name": "change_percent", + "type": "float", + "description": "Change in the price from the previous close, as a normalized percent.", "default": null, "optional": true } ], - "sec": [ - { - "name": "lei", - "type": "str", - "description": "The LEI of the holding.", - "default": null, - "optional": true - }, + "intrinio": [], + "polygon": [ { - "name": "cusip", - "type": "str", - "description": "The CUSIP of the holding.", + "name": "transactions", + "type": "Annotated[int, Gt(gt=0)]", + "description": "Number of transactions for the symbol in the time period.", "default": null, "optional": true - }, + } + ], + "yfinance": [] + }, + "model": "MarketIndices" + }, + "/index/constituents": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Index Constituents.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.constituents(symbol='dowjones', provider='fmp')\n# Providers other than FMP will use the ticker symbol.\nobb.index.constituents(symbol='BEP50P', provider='cboe')\n```\n\n", + "parameters": { + "standard": [ { - "name": "isin", + "name": "symbol", "type": "str", - "description": "The ISIN of the holding.", - "default": null, - "optional": true + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "other_id", - "type": "str", - "description": "Internal identifier for the holding.", - "default": null, + "name": "provider", + "type": "Literal['cboe', 'fmp', 'tmx']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.", + "default": "cboe", "optional": true - }, + } + ], + "cboe": [ { - "name": "balance", - "type": "float", - "description": "The balance of the holding.", - "default": null, + "name": "symbol", + "type": "Literal['BAT20P', 'BBE20P', 'BCH20P', 'BCHM30P', 'BDE40P', 'BDEM50P', 'BDES50P', 'BDK25P', 'BEP50P', 'BEPACP', 'BEPBUS', 'BEPCNC', 'BEPCONC', 'BEPCONS', 'BEPENGY', 'BEPFIN', 'BEPHLTH', 'BEPIND', 'BEPNEM', 'BEPTEC', 'BEPTEL', 'BEPUTL', 'BEPXUKP', 'BES35P', 'BEZ50P', 'BEZACP', 'BFI25P', 'BFR40P', 'BFRM20P', 'BIE20P', 'BIT40P', 'BNL25P', 'BNLM25P', 'BNO25G', 'BNORD40P', 'BPT20P', 'BSE30P', 'BUK100P', 'BUK250P', 'BUK350P', 'BUKAC', 'BUKBISP', 'BUKBUS', 'BUKCNC', 'BUKCONC', 'BUKCONS', 'BUKENGY', 'BUKFIN', 'BUKHI50P', 'BUKHLTH', 'BUKIND', 'BUKLO50P', 'BUKMINP', 'BUKNEM', 'BUKSC', 'BUKTEC', 'BUKTEL', 'BUKUTL']", + "description": "None", + "default": "BUK100P", "optional": true - }, + } + ], + "fmp": [ { - "name": "weight", - "type": "float", - "description": "The weight of the holding in ETF in %.", - "default": null, + "name": "symbol", + "type": "Literal['dowjones', 'sp500', 'nasdaq']", + "description": "None", + "default": "dowjones", "optional": true - }, + } + ], + "tmx": [ { - "name": "value", - "type": "float", - "description": "The value of the holding in USD.", - "default": null, + "name": "use_cache", + "type": "bool", + "description": "Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False.", + "default": true, "optional": true - }, + } + ] + }, + "returns": { + "OBBject": [ { - "name": "payoff_profile", - "type": "str", - "description": "The payoff profile of the holding.", - "default": null, - "optional": true + "name": "results", + "type": "List[IndexConstituents]", + "description": "Serializable results." }, { - "name": "units", - "type": "Union[str, float]", - "description": "The units of the holding.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['cboe', 'fmp', 'tmx']]", + "description": "Provider name." }, { - "name": "currency", - "type": "str", - "description": "The currency of the holding.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "asset_category", - "type": "str", - "description": "The asset category of the holding.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "issuer_category", - "type": "str", - "description": "The issuer category of the holding.", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "country", + "name": "symbol", "type": "str", - "description": "The country of the holding.", - "default": null, - "optional": true + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "is_restricted", + "name": "name", "type": "str", - "description": "Whether the holding is restricted.", - "default": null, - "optional": true - }, - { - "name": "fair_value_level", - "type": "int", - "description": "The fair value level of the holding.", + "description": "Name of the constituent company in the index.", "default": null, "optional": true - }, + } + ], + "cboe": [ { - "name": "is_cash_collateral", + "name": "security_type", "type": "str", - "description": "Whether the holding is cash collateral.", + "description": "The type of security represented.", "default": null, "optional": true }, { - "name": "is_non_cash_collateral", - "type": "str", - "description": "Whether the holding is non-cash collateral.", + "name": "last_price", + "type": "float", + "description": "Last price for the symbol.", "default": null, "optional": true }, { - "name": "is_loan_by_fund", - "type": "str", - "description": "Whether the holding is loan by fund.", + "name": "open", + "type": "float", + "description": "The open price.", "default": null, "optional": true }, { - "name": "loan_value", + "name": "high", "type": "float", - "description": "The loan value of the holding.", + "description": "The high price.", "default": null, "optional": true }, { - "name": "issuer_conditional", - "type": "str", - "description": "The issuer conditions of the holding.", + "name": "low", + "type": "float", + "description": "The low price.", "default": null, "optional": true }, { - "name": "asset_conditional", - "type": "str", - "description": "The asset conditions of the holding.", + "name": "close", + "type": "float", + "description": "The close price.", "default": null, "optional": true }, { - "name": "maturity_date", - "type": "date", - "description": "The maturity date of the debt security.", + "name": "volume", + "type": "int", + "description": "The trading volume.", "default": null, "optional": true }, { - "name": "coupon_kind", - "type": "str", - "description": "The type of coupon for the debt security.", + "name": "prev_close", + "type": "float", + "description": "The previous close price.", "default": null, "optional": true }, { - "name": "rate_type", - "type": "str", - "description": "The type of rate for the debt security, floating or fixed.", + "name": "change", + "type": "float", + "description": "Change in price.", "default": null, "optional": true }, { - "name": "annualized_return", + "name": "change_percent", "type": "float", - "description": "The annualized return on the debt security.", + "description": "Change in price as a normalized percentage.", "default": null, "optional": true }, { - "name": "is_default", + "name": "tick", "type": "str", - "description": "If the debt security is defaulted.", + "description": "Whether the last sale was an up or down tick.", "default": null, "optional": true }, { - "name": "in_arrears", - "type": "str", - "description": "If the debt security is in arrears.", + "name": "last_trade_time", + "type": "datetime", + "description": "Last trade timestamp for the symbol.", "default": null, "optional": true }, { - "name": "is_paid_kind", + "name": "asset_type", "type": "str", - "description": "If the debt security payments are paid in kind.", + "description": "Type of asset.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "derivative_category", + "name": "sector", "type": "str", - "description": "The derivative category of the holding.", - "default": null, - "optional": true + "description": "Sector the constituent company in the index belongs to.", + "default": "", + "optional": false }, { - "name": "counterparty", + "name": "sub_sector", "type": "str", - "description": "The counterparty of the derivative.", + "description": "Sub-sector the constituent company in the index belongs to.", "default": null, "optional": true }, { - "name": "underlying_name", + "name": "headquarter", "type": "str", - "description": "The name of the underlying asset associated with the derivative.", + "description": "Location of the headquarter of the constituent company in the index.", "default": null, "optional": true }, { - "name": "option_type", - "type": "str", - "description": "The type of option.", + "name": "date_first_added", + "type": "Union[str, date]", + "description": "Date the constituent company was added to the index.", "default": null, "optional": true }, { - "name": "derivative_payoff", - "type": "str", - "description": "The payoff profile of the derivative.", + "name": "cik", + "type": "int", + "description": "Central Index Key (CIK) for the requested entity.", "default": null, "optional": true }, { - "name": "expiry_date", - "type": "date", - "description": "The expiry or termination date of the derivative.", + "name": "founded", + "type": "Union[str, date]", + "description": "Founding year of the constituent company in the index.", "default": null, "optional": true - }, + } + ], + "tmx": [ { - "name": "exercise_price", + "name": "market_value", "type": "float", - "description": "The exercise price of the option.", + "description": "The quoted market value of the asset.", "default": null, "optional": true - }, + } + ] + }, + "model": "IndexConstituents" + }, + "/index/snapshots": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Index Snapshots. Current levels for all indices from a provider, grouped by `region`.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.snapshots(provider='tmx')\nobb.index.snapshots(region='us', provider='cboe')\n```\n\n", + "parameters": { + "standard": [ { - "name": "exercise_currency", + "name": "region", "type": "str", - "description": "The currency of the option exercise price.", - "default": null, + "description": "The region of focus for the data - i.e., us, eu.", + "default": "us", "optional": true }, { - "name": "shares_per_contract", - "type": "float", - "description": "The number of shares per contract.", - "default": null, + "name": "provider", + "type": "Literal['cboe', 'tmx']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.", + "default": "cboe", + "optional": true + } + ], + "cboe": [ + { + "name": "region", + "type": "Literal['us', 'eu']", + "description": "None", + "default": "us", + "optional": true + } + ], + "tmx": [ + { + "name": "region", + "type": "Literal['ca', 'us']", + "description": "None", + "default": "ca", "optional": true }, { - "name": "delta", - "type": "Union[str, float]", - "description": "The delta of the option.", - "default": null, + "name": "use_cache", + "type": "bool", + "description": "Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False.", + "default": true, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[IndexSnapshots]", + "description": "Serializable results." }, { - "name": "rate_type_rec", + "name": "provider", + "type": "Optional[Literal['cboe', 'tmx']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", "type": "str", - "description": "The type of rate for receivable portion of the swap.", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the index.", "default": null, "optional": true }, { - "name": "receive_currency", + "name": "currency", "type": "str", - "description": "The receive currency of the swap.", + "description": "Currency of the index.", "default": null, "optional": true }, { - "name": "upfront_receive", + "name": "price", "type": "float", - "description": "The upfront amount received of the swap.", + "description": "Current price of the index.", "default": null, "optional": true }, { - "name": "floating_rate_index_rec", - "type": "str", - "description": "The floating rate index for receivable portion of the swap.", + "name": "open", + "type": "float", + "description": "The open price.", "default": null, "optional": true }, { - "name": "floating_rate_spread_rec", + "name": "high", "type": "float", - "description": "The floating rate spread for reveivable portion of the swap.", + "description": "The high price.", "default": null, "optional": true }, { - "name": "rate_tenor_rec", - "type": "str", - "description": "The rate tenor for receivable portion of the swap.", + "name": "low", + "type": "float", + "description": "The low price.", "default": null, "optional": true }, { - "name": "rate_tenor_unit_rec", - "type": "Union[int, str]", - "description": "The rate tenor unit for receivable portion of the swap.", + "name": "close", + "type": "float", + "description": "The close price.", "default": null, "optional": true }, { - "name": "reset_date_rec", - "type": "str", - "description": "The reset date for receivable portion of the swap.", + "name": "volume", + "type": "int", + "description": "The trading volume.", "default": null, "optional": true }, { - "name": "reset_date_unit_rec", - "type": "Union[int, str]", - "description": "The reset date unit for receivable portion of the swap.", + "name": "prev_close", + "type": "float", + "description": "The previous close price.", "default": null, "optional": true }, { - "name": "rate_type_pmnt", - "type": "str", - "description": "The type of rate for payment portion of the swap.", + "name": "change", + "type": "float", + "description": "Change in value of the index.", "default": null, "optional": true }, { - "name": "payment_currency", - "type": "str", - "description": "The payment currency of the swap.", + "name": "change_percent", + "type": "float", + "description": "Change, in normalized percentage points, of the index.", + "default": null, + "optional": true + } + ], + "cboe": [ + { + "name": "open", + "type": "float", + "description": "The open price.", "default": null, "optional": true }, { - "name": "upfront_payment", + "name": "high", "type": "float", - "description": "The upfront amount received of the swap.", + "description": "The high price.", "default": null, "optional": true }, { - "name": "floating_rate_index_pmnt", - "type": "str", - "description": "The floating rate index for payment portion of the swap.", + "name": "low", + "type": "float", + "description": "The low price.", "default": null, "optional": true }, { - "name": "floating_rate_spread_pmnt", + "name": "close", "type": "float", - "description": "The floating rate spread for payment portion of the swap.", + "description": "The close price.", "default": null, "optional": true }, { - "name": "rate_tenor_pmnt", - "type": "str", - "description": "The rate tenor for payment portion of the swap.", + "name": "volume", + "type": "int", + "description": "The trading volume.", "default": null, "optional": true }, { - "name": "rate_tenor_unit_pmnt", - "type": "Union[int, str]", - "description": "The rate tenor unit for payment portion of the swap.", + "name": "prev_close", + "type": "float", + "description": "The previous close price.", "default": null, "optional": true }, { - "name": "reset_date_pmnt", - "type": "str", - "description": "The reset date for payment portion of the swap.", + "name": "change", + "type": "float", + "description": "Change in price.", "default": null, "optional": true }, { - "name": "reset_date_unit_pmnt", - "type": "Union[int, str]", - "description": "The reset date unit for payment portion of the swap.", + "name": "change_percent", + "type": "float", + "description": "Change in price as a normalized percentage.", "default": null, "optional": true }, { - "name": "repo_type", - "type": "str", - "description": "The type of repo.", + "name": "bid", + "type": "float", + "description": "Current bid price.", "default": null, "optional": true }, { - "name": "is_cleared", - "type": "str", - "description": "If the repo is cleared.", + "name": "ask", + "type": "float", + "description": "Current ask price.", "default": null, "optional": true }, { - "name": "is_tri_party", - "type": "str", - "description": "If the repo is tri party.", + "name": "last_trade_time", + "type": "datetime", + "description": "Last trade timestamp for the symbol.", "default": null, "optional": true }, { - "name": "principal_amount", + "name": "status", + "type": "str", + "description": "Status of the market, open or closed.", + "default": null, + "optional": true + } + ], + "tmx": [ + { + "name": "year_high", "type": "float", - "description": "The principal amount of the repo.", + "description": "The 52-week high of the index.", "default": null, "optional": true }, { - "name": "principal_currency", - "type": "str", - "description": "The currency of the principal amount.", + "name": "year_low", + "type": "float", + "description": "The 52-week low of the index.", "default": null, "optional": true }, { - "name": "collateral_type", - "type": "str", - "description": "The collateral type of the repo.", + "name": "return_mtd", + "type": "float", + "description": "The month-to-date return of the index, as a normalized percent.", "default": null, "optional": true }, { - "name": "collateral_amount", + "name": "return_qtd", "type": "float", - "description": "The collateral amount of the repo.", + "description": "The quarter-to-date return of the index, as a normalized percent.", "default": null, "optional": true }, { - "name": "collateral_currency", - "type": "str", - "description": "The currency of the collateral amount.", + "name": "return_ytd", + "type": "float", + "description": "The year-to-date return of the index, as a normalized percent.", "default": null, "optional": true }, { - "name": "exchange_currency", - "type": "str", - "description": "The currency of the exchange rate.", + "name": "total_market_value", + "type": "float", + "description": "The total quoted market value of the index.", "default": null, "optional": true }, { - "name": "exchange_rate", - "type": "float", - "description": "The exchange rate.", + "name": "number_of_constituents", + "type": "int", + "description": "The number of constituents in the index.", "default": null, "optional": true }, { - "name": "currency_sold", - "type": "str", - "description": "The currency sold in a Forward Derivative.", + "name": "constituent_average_market_value", + "type": "float", + "description": "The average quoted market value of the index constituents.", "default": null, "optional": true }, { - "name": "currency_amount_sold", + "name": "constituent_median_market_value", "type": "float", - "description": "The amount of currency sold in a Forward Derivative.", + "description": "The median quoted market value of the index constituents.", "default": null, "optional": true }, { - "name": "currency_bought", - "type": "str", - "description": "The currency bought in a Forward Derivative.", + "name": "constituent_top10_market_value", + "type": "float", + "description": "The sum of the top 10 quoted market values of the index constituents.", "default": null, "optional": true }, { - "name": "currency_amount_bought", + "name": "constituent_largest_market_value", "type": "float", - "description": "The amount of currency bought in a Forward Derivative.", + "description": "The largest quoted market value of the index constituents.", "default": null, "optional": true }, { - "name": "notional_amount", + "name": "constituent_largest_weight", "type": "float", - "description": "The notional amount of the derivative.", + "description": "The largest weight of the index constituents, as a normalized percent.", "default": null, "optional": true }, { - "name": "notional_currency", - "type": "str", - "description": "The currency of the derivative's notional amount.", + "name": "constituent_smallest_market_value", + "type": "float", + "description": "The smallest quoted market value of the index constituents.", "default": null, "optional": true }, { - "name": "unrealized_gain", + "name": "constituent_smallest_weight", "type": "float", - "description": "The unrealized gain or loss on the derivative.", + "description": "The smallest weight of the index constituents, as a normalized percent.", "default": null, "optional": true } ] }, - "model": "EtfHoldings" + "model": "IndexSnapshots" }, - "/etf/holdings_date": { + "/index/available": { "deprecated": { "flag": null, "message": null }, - "description": "Use this function to get the holdings dates, if available.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings_date(symbol='XLK', provider='fmp')\n```\n\n", + "description": "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": "symbol", - "type": "str", - "description": "Symbol to get data for. (ETF)", - "default": "", - "optional": false - }, { "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "type": "Literal['cboe', 'fmp', 'tmx', 'yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.", + "default": "cboe", "optional": true } ], - "fmp": [ + "cboe": [ { - "name": "cik", - "type": "str", - "description": "The CIK of the filing entity. Overrides symbol.", - "default": null, + "name": "use_cache", + "type": "bool", + "description": "When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass.", + "default": true, "optional": true } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EtfHoldingsDate]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - } ], - "fmp": [] - }, - "model": "EtfHoldingsDate" - }, - "/etf/holdings_performance": { - "deprecated": { - "flag": true, - "message": "This endpoint is deprecated; pass a list of holdings symbols directly to `/equity/price/performance` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.2." - }, - "description": "Get the recent price performance of each ticker held in the ETF.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings_performance(symbol='XLK', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", - "default": "", - "optional": false - }, + "fmp": [], + "tmx": [ { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "use_cache", + "type": "bool", + "description": "Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False.", + "default": true, "optional": true } ], - "fmp": [] + "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EtfHoldingsPerformance]", + "type": "List[AvailableIndices]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['cboe', 'fmp', 'tmx', 'yfinance']]", "description": "Provider name." }, { @@ -24213,173 +34980,180 @@ "data": { "standard": [ { - "name": "symbol", + "name": "name", "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": null, - "optional": true - }, - { - "name": "one_day", - "type": "float", - "description": "One-day return.", - "default": null, - "optional": true - }, - { - "name": "wtd", - "type": "float", - "description": "Week to date return.", - "default": null, - "optional": true - }, - { - "name": "one_week", - "type": "float", - "description": "One-week return.", - "default": null, - "optional": true - }, - { - "name": "mtd", - "type": "float", - "description": "Month to date return.", + "description": "Name of the index.", "default": null, "optional": true }, { - "name": "one_month", - "type": "float", - "description": "One-month return.", + "name": "currency", + "type": "str", + "description": "Currency the index is traded in.", "default": null, "optional": true - }, + } + ], + "cboe": [ { - "name": "qtd", - "type": "float", - "description": "Quarter to date return.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol for the index.", + "default": "", + "optional": false }, { - "name": "three_month", - "type": "float", - "description": "Three-month return.", + "name": "description", + "type": "str", + "description": "Description for the index. Valid only for US indices.", "default": null, "optional": true }, { - "name": "six_month", - "type": "float", - "description": "Six-month return.", + "name": "data_delay", + "type": "int", + "description": "Data delay for the index. Valid only for US indices.", "default": null, "optional": true }, { - "name": "ytd", - "type": "float", - "description": "Year to date return.", + "name": "open_time", + "type": "datetime.time", + "description": "Opening time for the index. Valid only for US indices.", "default": null, "optional": true }, { - "name": "one_year", - "type": "float", - "description": "One-year return.", + "name": "close_time", + "type": "datetime.time", + "description": "Closing time for the index. Valid only for US indices.", "default": null, "optional": true }, { - "name": "two_year", - "type": "float", - "description": "Two-year return.", + "name": "time_zone", + "type": "str", + "description": "Time zone for the index. Valid only for US indices.", "default": null, "optional": true }, { - "name": "three_year", - "type": "float", - "description": "Three-year return.", + "name": "tick_days", + "type": "str", + "description": "The trading days for the index. Valid only for US indices.", "default": null, "optional": true }, { - "name": "four_year", - "type": "float", - "description": "Four-year", + "name": "tick_frequency", + "type": "str", + "description": "The frequency of the index ticks. Valid only for US indices.", "default": null, "optional": true }, { - "name": "five_year", - "type": "float", - "description": "Five-year return.", + "name": "tick_period", + "type": "str", + "description": "The period of the index ticks. Valid only for US indices.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "ten_year", - "type": "float", - "description": "Ten-year return.", - "default": null, - "optional": true + "name": "stock_exchange", + "type": "str", + "description": "Stock exchange where the index is listed.", + "default": "", + "optional": false }, { - "name": "max", - "type": "float", - "description": "Return from the beginning of the time series.", - "default": null, - "optional": true + "name": "exchange_short_name", + "type": "str", + "description": "Short name of the stock exchange where the index is listed.", + "default": "", + "optional": false + } + ], + "tmx": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol of the index.", + "default": "", + "optional": false } ], - "fmp": [ + "yfinance": [ + { + "name": "code", + "type": "str", + "description": "ID code for keying the index in the OpenBB Terminal.", + "default": "", + "optional": false + }, { "name": "symbol", "type": "str", - "description": "The ticker symbol.", + "description": "Symbol for the index.", "default": "", "optional": false } ] }, - "model": "EtfHoldingsPerformance" + "model": "AvailableIndices" }, - "/etf/equity_exposure": { + "/index/search": { "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", + "description": "Filter indices for rows containing the query.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.search(provider='cboe')\nobb.index.search(query='SPX', provider='cboe')\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.", + "name": "query", + "type": "str", + "description": "Search query.", "default": "", - "optional": false + "optional": true + }, + { + "name": "is_symbol", + "type": "bool", + "description": "Whether to search by ticker symbol.", + "default": false, + "optional": true }, { "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "type": "Literal['cboe']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.", + "default": "cboe", "optional": true } ], - "fmp": [] + "cboe": [ + { + "name": "use_cache", + "type": "bool", + "description": "When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass.", + "default": true, + "optional": true + } + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EtfEquityExposure]", + "type": "List[IndexSearch]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['cboe']]", "description": "Provider name." }, { @@ -24402,145 +35176,104 @@ "data": { "standard": [ { - "name": "equity_symbol", + "name": "symbol", "type": "str", - "description": "The symbol of the equity requested.", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "etf_symbol", + "name": "name", "type": "str", - "description": "The symbol of the ETF with exposure to the requested equity.", + "description": "Name of the index.", "default": "", "optional": false - }, + } + ], + "cboe": [ { - "name": "shares", - "type": "float", - "description": "The number of shares held in the ETF.", + "name": "description", + "type": "str", + "description": "Description for the index.", "default": null, "optional": true }, { - "name": "weight", - "type": "float", - "description": "The weight of the equity in the ETF, as a normalized percent.", + "name": "data_delay", + "type": "int", + "description": "Data delay for the index. Valid only for US indices.", "default": null, "optional": true }, { - "name": "market_value", - "type": "Union[int, float]", - "description": "The market value of the equity position in the ETF.", + "name": "currency", + "type": "str", + "description": "Currency for the index.", "default": null, "optional": true - } - ], - "fmp": [] - }, - "model": "EtfEquityExposure" - }, - "/fixedincome/rate/ameribor": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Ameribor.\n\nAmeribor (short for the American interbank offered rate) is a benchmark interest rate that reflects the true cost of\nshort-term interbank borrowing. This rate is based on transactions in overnight unsecured loans conducted on the\nAmerican Financial Exchange (AFX).", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.ameribor(provider='fred')\nobb.fixedincome.rate.ameribor(parameter=30_day_ma, provider='fred')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "time_zone", + "type": "str", + "description": "Time zone for the index. Valid only for US indices.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "open_time", + "type": "datetime.time", + "description": "Opening time for the index. Valid only for US indices.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", - "optional": true - } - ], - "fred": [ - { - "name": "parameter", - "type": "Literal['overnight', 'term_30', 'term_90', '1_week_term_structure', '1_month_term_structure', '3_month_term_structure', '6_month_term_structure', '1_year_term_structure', '2_year_term_structure', '30_day_ma', '90_day_ma']", - "description": "Period of AMERIBOR rate.", - "default": "overnight", + "name": "close_time", + "type": "datetime.time", + "description": "Closing time for the index. Valid only for US indices.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[AMERIBOR]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "tick_days", + "type": "str", + "description": "The trading days for the index. Valid only for US indices.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "tick_frequency", + "type": "str", + "description": "Tick frequency for the index. Valid only for US indices.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "tick_period", + "type": "str", + "description": "Tick period for the index. Valid only for US indices.", + "default": null, + "optional": true } ] }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "rate", - "type": "float", - "description": "AMERIBOR rate.", - "default": "", - "optional": false - } - ], - "fred": [] - }, - "model": "AMERIBOR" + "model": "IndexSearch" }, - "/fixedincome/rate/sonia": { + "/index/sp500_multiples": { "deprecated": { "flag": null, "message": null }, - "description": "Sterling Overnight Index Average.\n\nSONIA (Sterling Overnight Index Average) is an important interest rate benchmark. SONIA is based on actual\ntransactions and reflects the average of the interest rates that banks pay to borrow sterling overnight from other\nfinancial institutions and other institutional investors.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.sonia(provider='fred')\nobb.fixedincome.rate.sonia(parameter=total_nominal_value, provider='fred')\n```\n\n", + "description": "Get historical S&P 500 multiples and Shiller PE ratios.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.sp500_multiples(provider='nasdaq')\nobb.index.sp500_multiples(series_name='shiller_pe_year', provider='nasdaq')\n```\n\n", "parameters": { "standard": [ + { + "name": "series_name", + "type": "Literal['shiller_pe_month', 'shiller_pe_year', 'pe_year', 'pe_month', 'dividend_year', 'dividend_month', 'dividend_growth_quarter', 'dividend_growth_year', 'dividend_yield_year', 'dividend_yield_month', 'earnings_year', 'earnings_month', 'earnings_growth_year', 'earnings_growth_quarter', 'real_earnings_growth_year', 'real_earnings_growth_quarter', 'earnings_yield_year', 'earnings_yield_month', 'real_price_year', 'real_price_month', 'inflation_adjusted_price_year', 'inflation_adjusted_price_month', 'sales_year', 'sales_quarter', 'sales_growth_year', 'sales_growth_quarter', 'real_sales_year', 'real_sales_quarter', 'real_sales_growth_year', 'real_sales_growth_quarter', 'price_to_sales_year', 'price_to_sales_quarter', 'price_to_book_value_year', 'price_to_book_value_quarter', 'book_value_year', 'book_value_quarter']", + "description": "The name of the series. Defaults to 'pe_month'.", + "default": "pe_month", + "optional": true + }, { "name": "start_date", "type": "Union[date, str]", @@ -24557,81 +35290,13 @@ }, { "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", - "optional": true - } - ], - "fred": [ - { - "name": "parameter", - "type": "Literal['rate', 'index', '10th_percentile', '25th_percentile', '75th_percentile', '90th_percentile', 'total_nominal_value']", - "description": "Period of SONIA rate.", - "default": "rate", + "type": "Literal['nasdaq']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default.", + "default": "nasdaq", "optional": true } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[SONIA]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "rate", - "type": "float", - "description": "SONIA rate.", - "default": "", - "optional": false - } ], - "fred": [] - }, - "model": "SONIA" - }, - "/fixedincome/rate/iorb": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Interest on Reserve Balances.\n\nGet Interest Rate on Reserve Balances data A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.iorb(provider='fred')\n```\n\n", - "parameters": { - "standard": [ + "nasdaq": [ { "name": "start_date", "type": "Union[date, str]", @@ -24642,30 +35307,36 @@ { "name": "end_date", "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "name": "transform", + "type": "Literal['diff', 'rdiff', 'cumul', 'normalize']", + "description": "Transform the data as difference, percent change, cumulative, or normalize.", + "default": null, + "optional": true + }, + { + "name": "collapse", + "type": "Literal['daily', 'weekly', 'monthly', 'quarterly', 'annual']", + "description": "Collapse the frequency of the time series.", + "default": null, "optional": true } - ], - "fred": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[IORB]", + "type": "List[SP500Multiples]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fred']]", + "type": "Optional[Literal['nasdaq']]", "description": "Provider name." }, { @@ -24693,57 +35364,42 @@ "description": "The date of the data.", "default": "", "optional": false - }, - { - "name": "rate", - "type": "float", - "description": "IORB rate.", - "default": "", - "optional": false } ], - "fred": [] + "nasdaq": [] }, - "model": "IORB" + "model": "SP500Multiples" }, - "/fixedincome/rate/effr": { + "/index/sectors": { "deprecated": { "flag": null, "message": null }, - "description": "Fed Funds Rate.\n\nGet Effective Federal Funds Rate data. A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.effr(provider='fred')\nobb.fixedincome.rate.effr(parameter=daily, provider='fred')\n```\n\n", + "description": "Get Index Sectors. Sector weighting of an index.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.sectors(symbol='^TX60', provider='tmx')\n```\n\n", "parameters": { "standard": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { "name": "provider", - "type": "Literal['federal_reserve', 'fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default.", - "default": "federal_reserve", + "type": "Literal['tmx']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default.", + "default": "tmx", "optional": true } ], - "federal_reserve": [], - "fred": [ + "tmx": [ { - "name": "parameter", - "type": "Literal['monthly', 'daily', 'weekly', 'daily_excl_weekend', 'annual', 'biweekly', 'volume']", - "description": "Period of FED rate.", - "default": "weekly", + "name": "use_cache", + "type": "bool", + "description": "Whether to use a cached request. All Index data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 1 day.", + "default": true, "optional": true } ] @@ -24752,12 +35408,12 @@ "OBBject": [ { "name": "results", - "type": "List[FEDFUNDS]", + "type": "List[IndexSectors]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['federal_reserve', 'fred']]", + "type": "Optional[Literal['tmx']]", "description": "Provider name." }, { @@ -24780,48 +35436,257 @@ "data": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "sector", + "type": "str", + "description": "The sector name.", "default": "", "optional": false }, { - "name": "rate", + "name": "weight", "type": "float", - "description": "FED rate.", + "description": "The weight of the sector in the index.", "default": "", "optional": false } ], - "federal_reserve": [], - "fred": [] + "tmx": [] }, - "model": "FEDFUNDS" + "model": "IndexSectors" }, - "/fixedincome/rate/effr_forecast": { + "/news/world": { "deprecated": { "flag": null, "message": null }, - "description": "Fed Funds Rate Projections.\n\nThe projections for the federal funds rate are the value of the midpoint of the\nprojected appropriate target range for the federal funds rate or the projected\nappropriate target level for the federal funds rate at the end of the specified\ncalendar year or over the longer run.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.effr_forecast(provider='fred')\nobb.fixedincome.rate.effr_forecast(long_run=True, provider='fred')\n```\n\n", + "description": "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# Filter aticles by term using 'biztoc' as provider.\nobb.news.world(provider='biztoc', term=apple)\n```\n\n", "parameters": { "standard": [ + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return. The number of articles to return.", + "default": 2500, + "optional": true + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, { "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "type": "Literal['benzinga', 'biztoc', 'fmp', 'intrinio', 'tiingo']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default.", + "default": "benzinga", + "optional": true + } + ], + "benzinga": [ + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": null, + "optional": true + }, + { + "name": "display", + "type": "Literal['headline', 'abstract', 'full']", + "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full).", + "default": "full", + "optional": true + }, + { + "name": "updated_since", + "type": "int", + "description": "Number of seconds since the news was updated.", + "default": null, + "optional": true + }, + { + "name": "published_since", + "type": "int", + "description": "Number of seconds since the news was published.", + "default": null, + "optional": true + }, + { + "name": "sort", + "type": "Literal['id', 'created', 'updated']", + "description": "Key to sort the news by.", + "default": "created", + "optional": true + }, + { + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order to sort the news by.", + "default": "desc", + "optional": true + }, + { + "name": "isin", + "type": "str", + "description": "The ISIN of the news to retrieve.", + "default": null, + "optional": true + }, + { + "name": "cusip", + "type": "str", + "description": "The CUSIP of the news to retrieve.", + "default": null, + "optional": true + }, + { + "name": "channels", + "type": "str", + "description": "Channels of the news to retrieve.", + "default": null, + "optional": true + }, + { + "name": "topics", + "type": "str", + "description": "Topics of the news to retrieve.", + "default": null, + "optional": true + }, + { + "name": "authors", + "type": "str", + "description": "Authors of the news to retrieve.", + "default": null, + "optional": true + }, + { + "name": "content_types", + "type": "str", + "description": "Content types of the news to retrieve.", + "default": null, + "optional": true + } + ], + "biztoc": [ + { + "name": "filter", + "type": "Literal['crypto', 'hot', 'latest', 'main', 'media', 'source', 'tag']", + "description": "Filter by type of news.", + "default": "latest", + "optional": true + }, + { + "name": "source", + "type": "str", + "description": "Filter by a specific publisher. Only valid when filter is set to source.", + "default": "bloomberg", + "optional": true + }, + { + "name": "tag", + "type": "str", + "description": "Tag, topic, to filter articles by. Only valid when filter is set to tag.", + "default": null, + "optional": true + }, + { + "name": "term", + "type": "str", + "description": "Search term to filter articles by. This overrides all other filters.", + "default": null, + "optional": true + } + ], + "fmp": [], + "intrinio": [ + { + "name": "source", + "type": "Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases']", + "description": "The source of the news article.", + "default": null, + "optional": true + }, + { + "name": "sentiment", + "type": "Literal['positive', 'neutral', 'negative']", + "description": "Return news only from this source.", + "default": null, + "optional": true + }, + { + "name": "language", + "type": "str", + "description": "Filter by language. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "topic", + "type": "str", + "description": "Filter by topic. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "word_count_greater_than", + "type": "int", + "description": "News stories will have a word count greater than this value. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "word_count_less_than", + "type": "int", + "description": "News stories will have a word count less than this value. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "is_spam", + "type": "bool", + "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "business_relevance_greater_than", + "type": "float", + "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source.", + "default": null, + "optional": true + }, + { + "name": "business_relevance_less_than", + "type": "float", + "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source.", + "default": null, "optional": true } ], - "fred": [ + "tiingo": [ { - "name": "long_run", - "type": "bool", - "description": "Flag to show long run projections", - "default": false, + "name": "offset", + "type": "int", + "description": "Page offset, used in conjunction with limit.", + "default": 0, + "optional": true + }, + { + "name": "source", + "type": "str", + "description": "A comma-separated list of the domains requested.", + "default": null, "optional": true } ] @@ -24830,12 +35695,12 @@ "OBBject": [ { "name": "results", - "type": "List[PROJECTIONS]", + "type": "List[WorldNews]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fred']]", + "type": "Optional[Literal['benzinga', 'biztoc', 'fmp', 'intrinio', 'tiingo']]", "description": "Provider name." }, { @@ -24859,74 +35724,286 @@ "standard": [ { "name": "date", - "type": "date", - "description": "The date of the data.", + "type": "datetime", + "description": "The date of the data. The published date of the article.", "default": "", "optional": false }, { - "name": "range_high", - "type": "float", - "description": "High projection of rates.", + "name": "title", + "type": "str", + "description": "Title of the article.", "default": "", "optional": false }, { - "name": "central_tendency_high", - "type": "float", - "description": "Central tendency of high projection of rates.", + "name": "images", + "type": "List[Dict[str, str]]", + "description": "Images associated with the article.", + "default": null, + "optional": true + }, + { + "name": "text", + "type": "str", + "description": "Text/body of the article.", + "default": null, + "optional": true + }, + { + "name": "url", + "type": "str", + "description": "URL to the article.", + "default": null, + "optional": true + } + ], + "benzinga": [ + { + "name": "id", + "type": "str", + "description": "Article ID.", "default": "", "optional": false }, { - "name": "median", + "name": "author", + "type": "str", + "description": "Author of the news.", + "default": null, + "optional": true + }, + { + "name": "teaser", + "type": "str", + "description": "Teaser of the news.", + "default": null, + "optional": true + }, + { + "name": "channels", + "type": "str", + "description": "Channels associated with the news.", + "default": null, + "optional": true + }, + { + "name": "stocks", + "type": "str", + "description": "Stocks associated with the news.", + "default": null, + "optional": true + }, + { + "name": "tags", + "type": "str", + "description": "Tags associated with the news.", + "default": null, + "optional": true + }, + { + "name": "updated", + "type": "datetime", + "description": "Updated date of the news.", + "default": null, + "optional": true + } + ], + "biztoc": [ + { + "name": "images", + "type": "Dict[str, str]", + "description": "Images for the article.", + "default": null, + "optional": true + }, + { + "name": "favicon", + "type": "str", + "description": "Icon image for the source of the article.", + "default": null, + "optional": true + }, + { + "name": "tags", + "type": "List[str]", + "description": "Tags for the article.", + "default": null, + "optional": true + }, + { + "name": "id", + "type": "str", + "description": "Unique Article ID.", + "default": null, + "optional": true + }, + { + "name": "score", "type": "float", - "description": "Median projection of rates.", + "description": "Search relevance score for the article.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "site", + "type": "str", + "description": "News source.", "default": "", "optional": false + } + ], + "intrinio": [ + { + "name": "source", + "type": "str", + "description": "The source of the news article.", + "default": null, + "optional": true }, { - "name": "range_midpoint", + "name": "summary", + "type": "str", + "description": "The summary of the news article.", + "default": null, + "optional": true + }, + { + "name": "topics", + "type": "str", + "description": "The topics related to the news article.", + "default": null, + "optional": true + }, + { + "name": "word_count", + "type": "int", + "description": "The word count of the news article.", + "default": null, + "optional": true + }, + { + "name": "business_relevance", "type": "float", - "description": "Midpoint projection of rates.", + "description": "How strongly correlated the news article is to the business", + "default": null, + "optional": true + }, + { + "name": "sentiment", + "type": "str", + "description": "The sentiment of the news article - i.e, negative, positive.", + "default": null, + "optional": true + }, + { + "name": "sentiment_confidence", + "type": "float", + "description": "The confidence score of the sentiment rating.", + "default": null, + "optional": true + }, + { + "name": "language", + "type": "str", + "description": "The language of the news article.", + "default": null, + "optional": true + }, + { + "name": "spam", + "type": "bool", + "description": "Whether the news article is spam.", + "default": null, + "optional": true + }, + { + "name": "copyright", + "type": "str", + "description": "The copyright notice of the news article.", + "default": null, + "optional": true + }, + { + "name": "id", + "type": "str", + "description": "Article ID.", "default": "", "optional": false }, { - "name": "central_tendency_midpoint", - "type": "float", - "description": "Central tendency of midpoint projection of rates.", + "name": "company", + "type": "IntrinioCompany", + "description": "The Intrinio Company object. Contains details company reference data.", + "default": null, + "optional": true + }, + { + "name": "security", + "type": "IntrinioSecurity", + "description": "The Intrinio Security object. Contains the security details related to the news article.", + "default": null, + "optional": true + } + ], + "tiingo": [ + { + "name": "symbols", + "type": "str", + "description": "Ticker tagged in the fetched news.", + "default": null, + "optional": true + }, + { + "name": "article_id", + "type": "int", + "description": "Unique ID of the news article.", "default": "", "optional": false }, { - "name": "range_low", - "type": "float", - "description": "Low projection of rates.", + "name": "site", + "type": "str", + "description": "News source.", "default": "", "optional": false }, { - "name": "central_tendency_low", - "type": "float", - "description": "Central tendency of low projection of rates.", + "name": "tags", + "type": "str", + "description": "Tags associated with the news article.", + "default": null, + "optional": true + }, + { + "name": "crawl_date", + "type": "datetime", + "description": "Date the news article was crawled.", "default": "", "optional": false } - ], - "fred": [] + ] }, - "model": "PROJECTIONS" + "model": "WorldNews" }, - "/fixedincome/rate/estr": { + "/news/company": { "deprecated": { "flag": null, "message": null }, - "description": "Euro Short-Term Rate.\n\nThe euro short-term rate (\u20acSTR) reflects the wholesale euro unsecured overnight borrowing costs of banks located in\nthe euro area. The \u20acSTR is published on each TARGET2 business day based on transactions conducted and settled on\nthe previous TARGET2 business day (the reporting date \u201cT\u201d) with a maturity date of T+1 which are deemed to have been\nexecuted at arm\u2019s length and thus reflect market rates in an unbiased way.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.estr(provider='fred')\nobb.fixedincome.rate.estr(parameter=number_of_active_banks, provider='fred')\n```\n\n", + "description": "Company News. Get news for one or more companies.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.news.company(provider='benzinga')\nobb.news.company(limit=100, provider='benzinga')\n# Get news on the specified dates.\nobb.news.company(symbol='AAPL', start_date='2024-02-01', end_date='2024-02-07', provider='intrinio')\n# Display the headlines of the news.\nobb.news.company(symbol='AAPL', display=headline, provider='benzinga')\n# Get news for multiple symbols.\nobb.news.company(symbol='aapl,tsla', provider='fmp')\n# Get news company's ISIN.\nobb.news.company(symbol='NVDA', isin=US0378331005, provider='benzinga')\n```\n\n", "parameters": { "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance.", + "default": null, + "optional": true + }, { "name": "start_date", "type": "Union[date, str]", @@ -24941,215 +36018,227 @@ "default": null, "optional": true }, + { + "name": "limit", + "type": "Annotated[int, Ge(ge=0)]", + "description": "The number of data entries to return.", + "default": 2500, + "optional": true + }, { "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "type": "Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', '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 } ], - "fred": [ + "benzinga": [ { - "name": "parameter", - "type": "Literal['volume_weighted_trimmed_mean_rate', 'number_of_transactions', 'number_of_active_banks', 'total_volume', 'share_of_volume_of_the_5_largest_active_banks', 'rate_at_75th_percentile_of_volume', 'rate_at_25th_percentile_of_volume']", - "description": "Period of ESTR rate.", - "default": "volume_weighted_trimmed_mean_rate", + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[ESTR]", - "description": "Serializable results." + "name": "display", + "type": "Literal['headline', 'abstract', 'full']", + "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full).", + "default": "full", + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." + "name": "updated_since", + "type": "int", + "description": "Number of seconds since the news was updated.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "published_since", + "type": "int", + "description": "Number of seconds since the news was published.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "sort", + "type": "Literal['id', 'created', 'updated']", + "description": "Key to sort the news by.", + "default": "created", + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order to sort the news by.", + "default": "desc", + "optional": true + }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "isin", + "type": "str", + "description": "The company's ISIN.", + "default": null, + "optional": true }, { - "name": "rate", - "type": "float", - "description": "ESTR rate.", - "default": "", - "optional": false - } - ], - "fred": [] - }, - "model": "ESTR" - }, - "/fixedincome/rate/ecb": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "European Central Bank Interest Rates.\n\nThe Governing Council of the ECB sets the key interest rates for the euro area:\n\n- The interest rate on the main refinancing operations (MRO), which provide\nthe bulk of liquidity to the banking system.\n- The rate on the deposit facility, which banks may use to make overnight deposits with the Eurosystem.\n- The rate on the marginal lending facility, which offers overnight credit to banks from the Eurosystem.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.ecb(provider='fred')\nobb.fixedincome.rate.ecb(interest_rate_type='refinancing', provider='fred')\n```\n\n", - "parameters": { - "standard": [ + "name": "cusip", + "type": "str", + "description": "The company's CUSIP.", + "default": null, + "optional": true + }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "channels", + "type": "str", + "description": "Channels of the news to retrieve.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "topics", + "type": "str", + "description": "Topics of the news to retrieve.", "default": null, "optional": true }, { - "name": "interest_rate_type", - "type": "Literal['deposit', 'lending', 'refinancing']", - "description": "The type of interest rate.", - "default": "lending", + "name": "authors", + "type": "str", + "description": "Authors of the news to retrieve.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "name": "content_types", + "type": "str", + "description": "Content types of the news to retrieve.", + "default": null, "optional": true } ], - "fred": [] - }, - "returns": { - "OBBject": [ + "fmp": [ { - "name": "results", - "type": "List[EuropeanCentralBankInterestRates]", - "description": "Serializable results." + "name": "page", + "type": "int", + "description": "Page number of the results. Use in combination with limit.", + "default": 0, + "optional": true + } + ], + "intrinio": [ + { + "name": "source", + "type": "Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases']", + "description": "The source of the news article.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." + "name": "sentiment", + "type": "Literal['positive', 'neutral', 'negative']", + "description": "Return news only from this source.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "language", + "type": "str", + "description": "Filter by language. Unsupported for yahoo source.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "topic", + "type": "str", + "description": "Filter by topic. Unsupported for yahoo source.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "word_count_greater_than", + "type": "int", + "description": "News stories will have a word count greater than this value. Unsupported for yahoo source.", + "default": null, + "optional": true + }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "word_count_less_than", + "type": "int", + "description": "News stories will have a word count less than this value. Unsupported for yahoo source.", + "default": null, + "optional": true }, { - "name": "rate", - "type": "float", - "description": "European Central Bank Interest Rate.", - "default": "", - "optional": false - } - ], - "fred": [] - }, - "model": "EuropeanCentralBankInterestRates" - }, - "/fixedincome/rate/dpcredit": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Discount Window Primary Credit Rate.\n\nA bank rate is the interest rate a nation's central bank charges to its domestic banks to borrow money.\nThe rates central banks charge are set to stabilize the economy.\nIn the United States, the Federal Reserve System's Board of Governors set the bank rate,\nalso known as the discount rate.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.dpcredit(provider='fred')\nobb.fixedincome.rate.dpcredit(start_date='2023-02-01', end_date='2023-05-01', provider='fred')\n```\n\n", - "parameters": { - "standard": [ + "name": "is_spam", + "type": "bool", + "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source.", + "default": null, + "optional": true + }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "business_relevance_greater_than", + "type": "float", + "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "business_relevance_less_than", + "type": "float", + "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source.", "default": null, "optional": true + } + ], + "polygon": [ + { + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Sort order of the articles.", + "default": "desc", + "optional": true + } + ], + "tiingo": [ + { + "name": "offset", + "type": "int", + "description": "Page offset, used in conjunction with limit.", + "default": 0, + "optional": true }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "name": "source", + "type": "str", + "description": "A comma-separated list of the domains requested.", + "default": null, "optional": true } ], - "fred": [ + "tmx": [ { - "name": "parameter", - "type": "Literal['daily_excl_weekend', 'monthly', 'weekly', 'daily', 'annual']", - "description": "FRED series ID of DWPCR data.", - "default": "daily_excl_weekend", + "name": "page", + "type": "int", + "description": "The page number to start from. Use with limit.", + "default": 1, "optional": true } - ] + ], + "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[DiscountWindowPrimaryCreditRate]", + "type": "List[CompanyNews]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fred']]", + "type": "Optional[Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'yfinance']]", "description": "Provider name." }, { @@ -25173,611 +36262,586 @@ "standard": [ { "name": "date", - "type": "date", - "description": "The date of the data.", + "type": "datetime", + "description": "The date of the data. Here it is the published date of the article.", "default": "", "optional": false }, { - "name": "rate", - "type": "float", - "description": "Discount Window Primary Credit Rate.", + "name": "title", + "type": "str", + "description": "Title of the article.", "default": "", "optional": false - } - ], - "fred": [] - }, - "model": "DiscountWindowPrimaryCreditRate" - }, - "/fixedincome/spreads/tcm": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Treasury Constant Maturity.\n\nGet data for 10-Year Treasury Constant Maturity Minus Selected Treasury Constant Maturity.\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S.\nTreasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.tcm(provider='fred')\nobb.fixedincome.spreads.tcm(maturity='2y', provider='fred')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "text", + "type": "str", + "description": "Text/body of the article.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "images", + "type": "List[Dict[str, str]]", + "description": "Images associated with the article.", "default": null, "optional": true }, { - "name": "maturity", - "type": "Literal['3m', '2y']", - "description": "The maturity", - "default": "3m", - "optional": true + "name": "url", + "type": "str", + "description": "URL to the article.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "name": "symbols", + "type": "str", + "description": "Symbols associated with the article.", + "default": null, "optional": true } ], - "fred": [] - }, - "returns": { - "OBBject": [ + "benzinga": [ { - "name": "results", - "type": "List[TreasuryConstantMaturity]", - "description": "Serializable results." + "name": "images", + "type": "List[Dict[str, str]]", + "description": "URL to the images of the news.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." + "name": "id", + "type": "str", + "description": "Article ID.", + "default": "", + "optional": false }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "author", + "type": "str", + "description": "Author of the article.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "teaser", + "type": "str", + "description": "Teaser of the news.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "channels", + "type": "str", + "description": "Channels associated with the news.", + "default": null, + "optional": true + }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "stocks", + "type": "str", + "description": "Stocks associated with the news.", + "default": null, + "optional": true }, { - "name": "rate", - "type": "float", - "description": "TreasuryConstantMaturity Rate.", + "name": "tags", + "type": "str", + "description": "Tags associated with the news.", + "default": null, + "optional": true + }, + { + "name": "updated", + "type": "datetime", + "description": "Updated date of the news.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "source", + "type": "str", + "description": "Name of the news source.", "default": "", "optional": false } ], - "fred": [] - }, - "model": "TreasuryConstantMaturity" - }, - "/fixedincome/spreads/tcm_effr": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Select Treasury Constant Maturity.\n\nGet data for Selected Treasury Constant Maturity Minus Federal Funds Rate\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S.\nTreasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.tcm_effr(provider='fred')\nobb.fixedincome.spreads.tcm_effr(maturity='10y', provider='fred')\n```\n\n", - "parameters": { - "standard": [ + "intrinio": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "source", + "type": "str", + "description": "The source of the news article.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "summary", + "type": "str", + "description": "The summary of the news article.", "default": null, "optional": true }, { - "name": "maturity", - "type": "Literal['10y', '5y', '1y', '6m', '3m']", - "description": "The maturity", - "default": "10y", + "name": "topics", + "type": "str", + "description": "The topics related to the news article.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "name": "word_count", + "type": "int", + "description": "The word count of the news article.", + "default": null, "optional": true - } - ], - "fred": [] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[SelectedTreasuryConstantMaturity]", - "description": "Serializable results." + "name": "business_relevance", + "type": "float", + "description": "How strongly correlated the news article is to the business", + "default": null, + "optional": true + }, + { + "name": "sentiment", + "type": "str", + "description": "The sentiment of the news article - i.e, negative, positive.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." + "name": "sentiment_confidence", + "type": "float", + "description": "The confidence score of the sentiment rating.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "language", + "type": "str", + "description": "The language of the news article.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "spam", + "type": "bool", + "description": "Whether the news article is spam.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "copyright", + "type": "str", + "description": "The copyright notice of the news article.", + "default": null, + "optional": true + }, { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "id", + "type": "str", + "description": "Article ID.", "default": "", "optional": false }, { - "name": "rate", - "type": "float", - "description": "Selected Treasury Constant Maturity Rate.", - "default": "", - "optional": false + "name": "security", + "type": "IntrinioSecurity", + "description": "The Intrinio Security object. Contains the security details related to the news article.", + "default": null, + "optional": true } ], - "fred": [] - }, - "model": "SelectedTreasuryConstantMaturity" - }, - "/fixedincome/spreads/treasury_effr": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Select Treasury Bill.\n\nGet Selected Treasury Bill Minus Federal Funds Rate.\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of\nauctioned U.S. Treasuries.\nThe value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.treasury_effr(provider='fred')\nobb.fixedincome.spreads.treasury_effr(maturity='6m', provider='fred')\n```\n\n", - "parameters": { - "standard": [ + "polygon": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "source", + "type": "str", + "description": "Source of the article.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "tags", + "type": "str", + "description": "Keywords/tags in the article", "default": null, "optional": true }, { - "name": "maturity", - "type": "Literal['3m', '6m']", - "description": "The maturity", - "default": "3m", - "optional": true + "name": "id", + "type": "str", + "description": "Article ID.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "name": "amp_url", + "type": "str", + "description": "AMP URL.", + "default": null, "optional": true - } - ], - "fred": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[SelectedTreasuryBill]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." - }, + "name": "publisher", + "type": "PolygonPublisher", + "description": "Publisher of the article.", + "default": "", + "optional": false + } + ], + "tiingo": [ { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "tags", + "type": "str", + "description": "Tags associated with the news article.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "article_id", + "type": "int", + "description": "Unique ID of the news article.", + "default": "", + "optional": false }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "source", + "type": "str", + "description": "News source.", "default": "", "optional": false }, { - "name": "rate", - "type": "float", - "description": "SelectedTreasuryBill Rate.", + "name": "crawl_date", + "type": "datetime", + "description": "Date the news article was crawled.", "default": "", "optional": false } ], - "fred": [] + "tmx": [ + { + "name": "source", + "type": "str", + "description": "Source of the news.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "source", + "type": "str", + "description": "Source of the news article", + "default": "", + "optional": false + } + ] }, - "model": "SelectedTreasuryBill" + "model": "CompanyNews" }, - "/fixedincome/government/us_yield_curve": { + "/quantitative/rolling/skew": { "deprecated": { "flag": null, "message": null }, - "description": "US Yield Curve. Get United States yield curve.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.us_yield_curve(provider='fred')\nobb.fixedincome.government.us_yield_curve(inflation_adjusted=True, provider='fred')\n```\n\n", + "description": "Get Rolling Skew.\n\n Skew is a statistical measure that reveals the degree of asymmetry of a distribution around its mean.\n Positive skewness indicates a distribution with an extended tail to the right, while negative skewness shows a tail\n that stretches left. Understanding skewness can provide insights into potential biases in data and help anticipate\n the nature of future data points. It's particularly useful for identifying the likelihood of extreme outcomes in\n financial returns, enabling more informed decision-making based on the distribution's shape over a specified period.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Rolling Mean.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.rolling.skew(data=returns, target=\"close\")\nobb.quantitative.rolling.skew(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", "parameters": { "standard": [ { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for. Defaults to the most recent FRED entry.", - "default": null, - "optional": true + "name": "data", + "type": "List[Data]", + "description": "Time series data.", + "default": "", + "optional": false }, { - "name": "inflation_adjusted", - "type": "bool", - "description": "Get inflation adjusted rates.", - "default": false, - "optional": true + "name": "target", + "type": "str", + "description": "Target column name.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", - "optional": true + "name": "window", + "type": "PositiveInt", + "description": "Window size.", + "default": "", + "optional": false + }, + { + "name": "index", + "type": "str, optional", + "description": "Index column name, by default \"date\"", + "default": "", + "optional": false } - ], - "fred": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[USYieldCurve]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "type": "List[Data]", + "description": "Rolling skew." } ] }, - "data": { + "data": {}, + "model": "" + }, + "/quantitative/rolling/variance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the rolling variance of a target column within a given window size.\n\n Variance measures the dispersion of a set of data points around their mean. It is a key metric for\n assessing the volatility and stability of financial returns or other time series data over a specified rolling window.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Rolling Variance.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.rolling.variance(data=returns, target=\"close\", window=252)\nobb.quantitative.rolling.variance(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", + "parameters": { "standard": [ { - "name": "maturity", - "type": "float", - "description": "Maturity of the treasury rate in years.", + "name": "data", + "type": "List[Data]", + "description": "The time series data as a list of data points.", "default": "", "optional": false }, { - "name": "rate", - "type": "float", - "description": "Associated rate given in decimal form (0.05 is 5%)", + "name": "target", + "type": "str", + "description": "The name of the column for which to calculate variance.", + "default": "", + "optional": false + }, + { + "name": "window", + "type": "PositiveInt", + "description": "The number of observations used for calculating the rolling measure.", + "default": "", + "optional": false + }, + { + "name": "index", + "type": "str, optional", + "description": "The name of the index column, default is \"date\".", "default": "", "optional": false } - ], - "fred": [] + ] }, - "model": "USYieldCurve" + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[Data]", + "description": "An object containing the rolling variance values." + } + ] + }, + "data": {}, + "model": "" }, - "/fixedincome/government/treasury_rates": { + "/quantitative/rolling/stdev": { "deprecated": { "flag": null, "message": null }, - "description": "Government Treasury Rates.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.treasury_rates(provider='fmp')\n```\n\n", + "description": "Calculate the rolling standard deviation of a target column within a given window size.\n\n Standard deviation is a measure of the amount of variation or dispersion of a set of values.\n It is widely used to assess the risk and volatility of financial returns or other time series data\n over a specified rolling window. It is the square root of the variance.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Rolling Standard Deviation.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.rolling.stdev(data=returns, target=\"close\", window=252)\nobb.quantitative.rolling.stdev(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", "parameters": { "standard": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true + "name": "data", + "type": "List[Data]", + "description": "The time series data as a list of data points.", + "default": "", + "optional": false }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true + "name": "target", + "type": "str", + "description": "The name of the column for which to calculate standard deviation.", + "default": "", + "optional": false }, { - "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 + "name": "window", + "type": "PositiveInt", + "description": "The number of observations used for calculating the rolling measure.", + "default": "", + "optional": false + }, + { + "name": "index", + "type": "str, optional", + "description": "The name of the index column, default is \"date\".", + "default": "", + "optional": false } - ], - "federal_reserve": [], - "fmp": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[TreasuryRates]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['federal_reserve', 'fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "type": "List[Data]", + "description": "An object containing the rolling standard deviation values." } ] }, - "data": { + "data": {}, + "model": "" + }, + "/quantitative/rolling/kurtosis": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the rolling kurtosis of a target column within a given window size.\n\n Kurtosis measures the \"tailedness\" of the probability distribution of a real-valued random variable.\n High kurtosis indicates a distribution with heavy tails (outliers), suggesting a higher risk of extreme outcomes.\n Low kurtosis indicates a distribution with lighter tails (less outliers), suggesting less risk of extreme outcomes.\n This function helps in assessing the risk of outliers in financial returns or other time series data over a specified\n rolling window.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Rolling Kurtosis.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.rolling.kurtosis(data=returns, target=\"close\", window=252)\nobb.quantitative.rolling.kurtosis(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", + "parameters": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "data", + "type": "List[Data]", + "description": "The time series data as a list of data points.", "default": "", "optional": false }, { - "name": "week_4", - "type": "float", - "description": "4 week Treasury bills rate (secondary market).", - "default": null, - "optional": true - }, - { - "name": "month_1", - "type": "float", - "description": "1 month Treasury rate.", - "default": null, - "optional": true - }, - { - "name": "month_2", - "type": "float", - "description": "2 month Treasury rate.", - "default": null, - "optional": true - }, - { - "name": "month_3", - "type": "float", - "description": "3 month Treasury rate.", - "default": null, - "optional": true + "name": "target", + "type": "str", + "description": "The name of the column for which to calculate kurtosis.", + "default": "", + "optional": false }, { - "name": "month_6", - "type": "float", - "description": "6 month Treasury rate.", - "default": null, - "optional": true + "name": "window", + "type": "PositiveInt", + "description": "The number of observations used for calculating the rolling measure.", + "default": "", + "optional": false }, { - "name": "year_1", - "type": "float", - "description": "1 year Treasury rate.", - "default": null, - "optional": true - }, + "name": "index", + "type": "str, optional", + "description": "The name of the index column, default is \"date\".", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ { - "name": "year_2", - "type": "float", - "description": "2 year Treasury rate.", - "default": null, - "optional": true - }, + "name": "results", + "type": "List[Data]", + "description": "An object containing the rolling kurtosis values." + } + ] + }, + "data": {}, + "model": "" + }, + "/quantitative/rolling/quantile": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the rolling quantile of a target column within a given window size at a specified quantile percentage.\n\n Quantiles are points dividing the range of a probability distribution into intervals with equal probabilities,\n or dividing the sample in the same way. This function is useful for understanding the distribution of data\n within a specified window, allowing for analysis of trends, identification of outliers, and assessment of risk.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Rolling Quantile.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.rolling.quantile(data=returns, target=\"close\", window=252, quantile_pct=0.25)\nobb.quantitative.rolling.quantile(data=returns, target=\"close\", window=252, quantile_pct=0.75)\nobb.quantitative.rolling.quantile(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", + "parameters": { + "standard": [ { - "name": "year_3", - "type": "float", - "description": "3 year Treasury rate.", - "default": null, - "optional": true + "name": "data", + "type": "List[Data]", + "description": "The time series data as a list of data points.", + "default": "", + "optional": false }, { - "name": "year_5", - "type": "float", - "description": "5 year Treasury rate.", - "default": null, - "optional": true + "name": "target", + "type": "str", + "description": "The name of the column for which to calculate the quantile.", + "default": "", + "optional": false }, { - "name": "year_7", - "type": "float", - "description": "7 year Treasury rate.", - "default": null, - "optional": true + "name": "window", + "type": "PositiveInt", + "description": "The number of observations used for calculating the rolling measure.", + "default": "", + "optional": false }, { - "name": "year_10", - "type": "float", - "description": "10 year Treasury rate.", - "default": null, - "optional": true + "name": "quantile_pct", + "type": "NonNegativeFloat, optional", + "description": "The quantile percentage to calculate (e.g., 0.5 for median), default is 0.5.", + "default": "", + "optional": false }, { - "name": "year_20", - "type": "float", - "description": "20 year Treasury rate.", - "default": null, - "optional": true - }, + "name": "index", + "type": "str, optional", + "description": "The name of the index column, default is \"date\".", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ { - "name": "year_30", - "type": "float", - "description": "30 year Treasury rate.", - "default": null, - "optional": true + "name": "results", + "type": "List[Data]", + "description": "An object containing the rolling quantile values with the median." } - ], - "federal_reserve": [], - "fmp": [] + ] }, - "model": "TreasuryRates" + "data": {}, + "model": "" }, - "/fixedincome/corporate/ice_bofa": { + "/quantitative/rolling/mean": { "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", + "description": "Calculate the rolling average of a target column within a given window size.\n\n The rolling mean is a simple moving average that calculates the average of a target variable over a specified window.\n This function is widely used in financial analysis to smooth short-term fluctuations and highlight longer-term trends\n or cycles in time series data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Rolling Mean.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.rolling.mean(data=returns, target=\"close\", window=252)\nobb.quantitative.rolling.mean(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", "parameters": { "standard": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "index_type", - "type": "Literal['yield', 'yield_to_worst', 'total_return', 'spread']", - "description": "The type of series.", - "default": "yield", - "optional": true - }, - { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", - "optional": true - } - ], - "fred": [ - { - "name": "category", - "type": "Literal['all', 'duration', 'eur', 'usd']", - "description": "The type of category.", - "default": "all", - "optional": true + "name": "data", + "type": "List[Data]", + "description": "The time series data as a list of data points.", + "default": "", + "optional": false }, { - "name": "area", - "type": "Literal['asia', 'emea', 'eu', 'ex_g10', 'latin_america', 'us']", - "description": "The type of area.", - "default": "us", - "optional": true + "name": "target", + "type": "str", + "description": "The name of the column for which to calculate the mean.", + "default": "", + "optional": 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 + "name": "window", + "type": "PositiveInt", + "description": "The number of observations used for calculating the rolling measure.", + "default": "", + "optional": false }, - { - "name": "options", - "type": "bool", - "description": "Whether to include options in the results.", - "default": false, - "optional": true + { + "name": "index", + "type": "str, optional", + "description": "The name of the index column, default is \"date\".", + "default": "", + "optional": false } ] }, @@ -25785,97 +36849,73 @@ "OBBject": [ { "name": "results", - "type": "List[ICEBofA]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "type": "List[Data]", + "description": "An object containing the rolling mean values." } ] }, - "data": { + "data": {}, + "model": "" + }, + "/quantitative/stats/skew": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the skew of the data set.\n\n Skew is a statistical measure that reveals the degree of asymmetry of a distribution around its mean.\n Positive skewness indicates a distribution with an extended tail to the right, while negative skewness shows a tail\n that stretches left. Understanding skewness can provide insights into potential biases in data and help anticipate\n the nature of future data points. It's particularly useful for identifying the likelihood of extreme outcomes in\n financial returns, enabling more informed decision-making based on the distribution's shape over a specified period.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Skewness.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.stats.skew(data=returns, target=\"close\")\nobb.quantitative.stats.skew(target='close', data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", + "parameters": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "data", + "type": "List[Data]", + "description": "Time series data.", "default": "", "optional": false }, { - "name": "rate", - "type": "float", - "description": "ICE BofA US Corporate Bond Indices Rate.", + "name": "target", + "type": "str", + "description": "Target column name.", "default": "", "optional": false } - ], - "fred": [] + ] }, - "model": "ICEBofA" + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[Data]", + "description": "Rolling skew." + } + ] + }, + "data": {}, + "model": "" }, - "/fixedincome/corporate/moody": { + "/quantitative/stats/variance": { "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", + "description": "Calculate the variance of a target column.\n\n Variance measures the dispersion of a set of data points around their mean. It is a key metric for\n assessing the volatility and stability of financial returns or other time series data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Variance.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.stats.variance(data=returns, target=\"close\")\nobb.quantitative.stats.variance(target='close', data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", "parameters": { "standard": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "index_type", - "type": "Literal['aaa', 'baa']", - "description": "The type of series.", - "default": "aaa", - "optional": true + "name": "data", + "type": "List[Data]", + "description": "The time series data as a list of data points.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", - "optional": true - } - ], - "fred": [ - { - "name": "spread", - "type": "Literal['treasury', 'fed_funds']", - "description": "The type of spread.", - "default": null, - "optional": true + "name": "target", + "type": "str", + "description": "The name of the column for which to calculate variance.", + "default": "", + "optional": false } ] }, @@ -25883,396 +36923,460 @@ "OBBject": [ { "name": "results", - "type": "List[MoodyCorporateBondIndex]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." - }, + "type": "List[Data]", + "description": "An object containing the rolling variance values." + } + ] + }, + "data": {}, + "model": "" + }, + "/quantitative/stats/stdev": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the rolling standard deviation of a target column.\n\n Standard deviation is a measure of the amount of variation or dispersion of a set of values.\n It is widely used to assess the risk and volatility of financial returns or other time series data\n It is the square root of the variance.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Standard Deviation.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.stats.stdev(data=returns, target=\"close\")\nobb.quantitative.stats.stdev(target='close', data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", + "parameters": { + "standard": [ { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "data", + "type": "List[Data]", + "description": "The time series data as a list of data points.", + "default": "", + "optional": false }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, + "name": "target", + "type": "str", + "description": "The name of the column for which to calculate standard deviation.", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "results", + "type": "List[Data]", + "description": "An object containing the rolling standard deviation values." } ] }, - "data": { + "data": {}, + "model": "" + }, + "/quantitative/stats/kurtosis": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the rolling kurtosis of a target column.\n\n Kurtosis measures the \"tailedness\" of the probability distribution of a real-valued random variable.\n High kurtosis indicates a distribution with heavy tails (outliers), suggesting a higher risk of extreme outcomes.\n Low kurtosis indicates a distribution with lighter tails (less outliers), suggesting less risk of extreme outcomes.\n This function helps in assessing the risk of outliers in financial returns or other time series data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Kurtosis.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.stats.kurtosis(data=returns, target=\"close\")\nobb.quantitative.stats.kurtosis(target='close', data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", + "parameters": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "data", + "type": "List[Data]", + "description": "The time series data as a list of data points.", "default": "", "optional": false }, { - "name": "rate", - "type": "float", - "description": "Moody Corporate Bond Index Rate.", + "name": "target", + "type": "str", + "description": "The name of the column for which to calculate kurtosis.", "default": "", "optional": false } - ], - "fred": [] + ] }, - "model": "MoodyCorporateBondIndex" + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[Data]", + "description": "An object containing the kurtosis value" + } + ] + }, + "data": {}, + "model": "" }, - "/fixedincome/corporate/hqm": { + "/quantitative/stats/quantile": { "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", + "description": "Calculate the quantile of a target column at a specified quantile percentage.\n\n Quantiles are points dividing the range of a probability distribution into intervals with equal probabilities,\n or dividing the sample in the same way.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Quantile.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.stats.quantile(data=returns, target=\"close\", quantile_pct=0.75)\nobb.quantitative.stats.quantile(target='close', data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", "parameters": { "standard": [ { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", - "default": null, - "optional": true + "name": "data", + "type": "List[Data]", + "description": "The time series data as a list of data points.", + "default": "", + "optional": false }, { - "name": "yield_curve", - "type": "Literal['spot', 'par']", - "description": "The yield curve type.", - "default": "spot", - "optional": true + "name": "target", + "type": "str", + "description": "The name of the column for which to calculate the quantile.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", - "optional": true + "name": "quantile_pct", + "type": "NonNegativeFloat, optional", + "description": "The quantile percentage to calculate (e.g., 0.5 for median), default is 0.5.", + "default": "", + "optional": false } - ], - "fred": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[HighQualityMarketCorporateBond]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." - }, + "type": "List[Data]", + "description": "An object containing the rolling quantile values with the median." + } + ] + }, + "data": {}, + "model": "" + }, + "/quantitative/stats/mean": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the average of a target column.\n\n The rolling mean is a simple moving average that calculates the average of a target variable.\n This function is widely used in financial analysis to smooth short-term fluctuations and highlight longer-term trends\n or cycles in time series data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Mean.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.stats.mean(data=returns, target=\"close\")\nobb.quantitative.stats.mean(target='close', data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", + "parameters": { + "standard": [ { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "data", + "type": "List[Data]", + "description": "The time series data as a list of data points.", + "default": "", + "optional": false }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, + "name": "target", + "type": "str", + "description": "The name of the column for which to calculate the mean.", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "results", + "type": "List[Data]", + "description": "An object containing the mean value." } ] }, - "data": { + "data": {}, + "model": "" + }, + "/quantitative/performance/omega_ratio": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Omega Ratio.\n\n The Omega Ratio is a sophisticated metric that goes beyond traditional performance measures by considering the\n probability of achieving returns above a given threshold. It offers a more nuanced view of risk and reward,\n focusing on the likelihood of success rather than just average outcomes.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Omega Ratio.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.performance.omega_ratio(data=returns, target=\"close\")\nobb.quantitative.performance.omega_ratio(target='close', data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", + "parameters": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "data", + "type": "List[Data]", + "description": "Time series data.", "default": "", "optional": false }, { - "name": "rate", - "type": "float", - "description": "HighQualityMarketCorporateBond Rate.", + "name": "target", + "type": "str", + "description": "Target column name.", "default": "", "optional": false }, { - "name": "maturity", - "type": "str", - "description": "Maturity.", + "name": "threshold_start", + "type": "float, optional", + "description": "Start threshold, by default 0.0", "default": "", "optional": false }, { - "name": "yield_curve", - "type": "Literal['spot', 'par']", - "description": "The yield curve type.", + "name": "threshold_end", + "type": "float, optional", + "description": "End threshold, by default 1.5", "default": "", "optional": false } - ], - "fred": [ + ] + }, + "returns": { + "OBBject": [ { - "name": "series_id", - "type": "str", - "description": "FRED series id.", - "default": "", - "optional": false + "name": "results", + "type": "List[OmegaModel]", + "description": "Omega ratios." } ] }, - "model": "HighQualityMarketCorporateBond" + "data": {}, + "model": "" }, - "/fixedincome/corporate/spot_rates": { + "/quantitative/performance/sharpe_ratio": { "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", + "description": "Get Rolling Sharpe Ratio.\n\n This function calculates the Sharpe Ratio, a metric used to assess the return of an investment compared to its risk.\n By factoring in the risk-free rate, it helps you understand how much extra return you're getting for the extra\n volatility that you endure by holding a riskier asset. The Sharpe Ratio is essential for investors looking to\n compare the efficiency of different investments, providing a clear picture of potential rewards in relation to their\n risks over a specified period. Ideal for gauging the effectiveness of investment strategies, it offers insights into\n optimizing your portfolio for maximum return on risk.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Rolling Sharpe Ratio.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.performance.sharpe_ratio(data=returns, target=\"close\")\nobb.quantitative.performance.sharpe_ratio(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", "parameters": { "standard": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true + "name": "data", + "type": "List[Data]", + "description": "Time series data.", + "default": "", + "optional": false }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true + "name": "target", + "type": "str", + "description": "Target column name.", + "default": "", + "optional": false }, { - "name": "maturity", - "type": "Union[Union[float, str], List[Union[float, str]]]", - "description": "Maturities in years. Multiple items allowed for provider(s): fred.", - "default": 10.0, - "optional": true + "name": "rfr", + "type": "float, optional", + "description": "Risk-free rate, by default 0.0", + "default": "", + "optional": false }, { - "name": "category", - "type": "Union[str, List[str]]", - "description": "Rate category. Options: spot_rate, par_yield. Multiple items allowed for provider(s): fred.", - "default": "spot_rate", - "optional": true + "name": "window", + "type": "PositiveInt, optional", + "description": "Window size, by default 252", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", - "optional": true + "name": "index", + "type": "str, optional", + "description": "Returns", + "default": "", + "optional": false } - ], - "fred": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[SpotRate]", - "description": "Serializable results." + "type": "List[Data]", + "description": "Sharpe ratio." + } + ] + }, + "data": {}, + "model": "" + }, + "/quantitative/performance/sortino_ratio": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get rolling Sortino Ratio.\n\n The Sortino Ratio enhances the evaluation of investment returns by distinguishing harmful volatility\n from total volatility. Unlike other metrics that treat all volatility as risk, this command specifically assesses\n the volatility of negative returns relative to a target or desired return.\n It's particularly useful for investors who are more concerned with downside risk than with overall volatility.\n By calculating the Sortino Ratio, investors can better understand the risk-adjusted return of their investments,\n focusing on the likelihood and impact of negative returns.\n This approach offers a more nuanced tool for portfolio optimization, especially in strategies aiming\n to minimize the downside.\n\n For method & terminology see:\n http://www.redrockcapital.com/Sortino__A__Sharper__Ratio_Red_Rock_Capital.pdf", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Rolling Sortino Ratio.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.performance.sortino_ratio(data=stock_data, target=\"close\")\nobb.quantitative.performance.sortino_ratio(data=stock_data, target=\"close\", target_return=0.01, window=126, adjusted=True)\nobb.quantitative.performance.sortino_ratio(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "http", + "type": "//www.redrockcapital.com/Sortino__A__Sharper__Ratio_Red_Rock_Capital.pdf", + "description": "Parameters", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." + "name": "data", + "type": "List[Data]", + "description": "Time series data.", + "default": "", + "optional": false }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "target", + "type": "str", + "description": "Target column name.", + "default": "", + "optional": false }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "target_return", + "type": "float, optional", + "description": "Target return, by default 0.0", + "default": "", + "optional": false }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "window", + "type": "PositiveInt, optional", + "description": "Window size, by default 252", + "default": "", + "optional": false + }, { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "adjusted", + "type": "bool, optional", + "description": "Adjust sortino ratio to compare it to sharpe ratio, by default False", "default": "", "optional": false }, { - "name": "rate", - "type": "float", - "description": "Spot Rate.", + "name": "index", + "type": "str", + "description": "Index column for input data", "default": "", "optional": false } - ], - "fred": [] + ] }, - "model": "SpotRate" + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[Data]", + "description": "Sortino ratio." + } + ] + }, + "data": {}, + "model": "" }, - "/fixedincome/corporate/commercial_paper": { + "/quantitative/normality": { "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", + "description": "Get Normality Statistics.\n\n - **Kurtosis**: whether the kurtosis of a sample differs from the normal distribution.\n - **Skewness**: whether the skewness of a sample differs from the normal distribution.\n - **Jarque-Bera**: whether the sample data has the skewness and kurtosis matching a normal distribution.\n - **Shapiro-Wilk**: whether a random sample comes from a normal distribution.\n - **Kolmogorov-Smirnov**: whether two underlying one-dimensional probability distributions differ.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Normality Statistics.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.quantitative.normality(data=stock_data, target='close')\nobb.quantitative.normality(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}, {'date': '2023-01-07', 'open': 128.33, 'high': 140.0, 'low': 116.67, 'close': 134.17, 'volume': 11666.67}, {'date': '2023-01-08', 'open': 125.71, 'high': 137.14, 'low': 114.29, 'close': 131.43, 'volume': 11428.57}, {'date': '2023-01-09', 'open': 123.75, 'high': 135.0, 'low': 112.5, 'close': 129.38, 'volume': 11250.0}])\n```\n\n", "parameters": { "standard": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "maturity", - "type": "Literal['overnight', '7d', '15d', '30d', '60d', '90d']", - "description": "The maturity.", - "default": "30d", - "optional": true - }, - { - "name": "category", - "type": "Literal['asset_backed', 'financial', 'nonfinancial']", - "description": "The category.", - "default": "financial", - "optional": true - }, - { - "name": "grade", - "type": "Literal['aa', 'a2_p2']", - "description": "The grade.", - "default": "aa", - "optional": true + "name": "data", + "type": "List[Data]", + "description": "Time series data.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", - "optional": true + "name": "target", + "type": "str", + "description": "Target column name.", + "default": "", + "optional": false } - ], - "fred": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[CommercialPaper]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "type": "NormalityModel", + "description": "Normality tests summary. See qa_models.NormalityModel for details." } ] }, - "data": { + "data": {}, + "model": "" + }, + "/quantitative/capm": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Capital Asset Pricing Model (CAPM).\n\n CAPM offers a streamlined way to assess the expected return on an investment while accounting for its risk relative\n to the market. It's a cornerstone of modern financial theory that helps investors understand the trade-off between\n risk and return, guiding more informed investment choices.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Capital Asset Pricing Model (CAPM).\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.quantitative.capm(data=stock_data, target='close')\nobb.quantitative.capm(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}, {'date': '2023-01-07', 'open': 128.33, 'high': 140.0, 'low': 116.67, 'close': 134.17, 'volume': 11666.67}, {'date': '2023-01-08', 'open': 125.71, 'high': 137.14, 'low': 114.29, 'close': 131.43, 'volume': 11428.57}, {'date': '2023-01-09', 'open': 123.75, 'high': 135.0, 'low': 112.5, 'close': 129.38, 'volume': 11250.0}, {'date': '2023-01-10', 'open': 122.22, 'high': 133.33, 'low': 111.11, 'close': 127.78, 'volume': 11111.11}, {'date': '2023-01-11', 'open': 121.0, 'high': 132.0, 'low': 110.0, 'close': 126.5, 'volume': 11000.0}, {'date': '2023-01-12', 'open': 120.0, 'high': 130.91, 'low': 109.09, 'close': 125.45, 'volume': 10909.09}, {'date': '2023-01-13', 'open': 119.17, 'high': 130.0, 'low': 108.33, 'close': 124.58, 'volume': 10833.33}, {'date': '2023-01-14', 'open': 118.46, 'high': 129.23, 'low': 107.69, 'close': 123.85, 'volume': 10769.23}, {'date': '2023-01-15', 'open': 117.86, 'high': 128.57, 'low': 107.14, 'close': 123.21, 'volume': 10714.29}, {'date': '2023-01-16', 'open': 117.33, 'high': 128.0, 'low': 106.67, 'close': 122.67, 'volume': 10666.67}, {'date': '2023-01-17', 'open': 116.88, 'high': 127.5, 'low': 106.25, 'close': 122.19, 'volume': 10625.0}, {'date': '2023-01-18', 'open': 116.47, 'high': 127.06, 'low': 105.88, 'close': 121.76, 'volume': 10588.24}, {'date': '2023-01-19', 'open': 116.11, 'high': 126.67, 'low': 105.56, 'close': 121.39, 'volume': 10555.56}, {'date': '2023-01-20', 'open': 115.79, 'high': 126.32, 'low': 105.26, 'close': 121.05, 'volume': 10526.32}, {'date': '2023-01-21', 'open': 115.5, 'high': 126.0, 'low': 105.0, 'close': 120.75, 'volume': 10500.0}, {'date': '2023-01-22', 'open': 115.24, 'high': 125.71, 'low': 104.76, 'close': 120.48, 'volume': 10476.19}, {'date': '2023-01-23', 'open': 115.0, 'high': 125.45, 'low': 104.55, 'close': 120.23, 'volume': 10454.55}, {'date': '2023-01-24', 'open': 114.78, 'high': 125.22, 'low': 104.35, 'close': 120.0, 'volume': 10434.78}, {'date': '2023-01-25', 'open': 114.58, 'high': 125.0, 'low': 104.17, 'close': 119.79, 'volume': 10416.67}, {'date': '2023-01-26', 'open': 114.4, 'high': 124.8, 'low': 104.0, 'close': 119.6, 'volume': 10400.0}, {'date': '2023-01-27', 'open': 114.23, 'high': 124.62, 'low': 103.85, 'close': 119.42, 'volume': 10384.62}, {'date': '2023-01-28', 'open': 114.07, 'high': 124.44, 'low': 103.7, 'close': 119.26, 'volume': 10370.37}, {'date': '2023-01-29', 'open': 113.93, 'high': 124.29, 'low': 103.57, 'close': 119.11, 'volume': 10357.14}, {'date': '2023-01-30', 'open': 113.79, 'high': 124.14, 'low': 103.45, 'close': 118.97, 'volume': 10344.83}, {'date': '2023-01-31', 'open': 113.67, 'high': 124.0, 'low': 103.33, 'close': 118.83, 'volume': 10333.33}, {'date': '2023-02-01', 'open': 113.55, 'high': 123.87, 'low': 103.23, 'close': 118.71, 'volume': 10322.58}])\n```\n\n", + "parameters": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "data", + "type": "List[Data]", + "description": "Time series data.", "default": "", "optional": false }, { - "name": "rate", - "type": "float", - "description": "Commercial Paper Rate.", + "name": "target", + "type": "str", + "description": "Target column name.", "default": "", "optional": false } - ], - "fred": [] + ] }, - "model": "CommercialPaper" + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CAPMModel", + "description": "CAPM model summary." + } + ] + }, + "data": {}, + "model": "" }, - "/fixedincome/sofr": { + "/quantitative/unitroot_test": { "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", + "description": "Get Unit Root Test.\n\n This function applies two renowned tests to assess whether your data series is stationary or if it contains a unit\n root, indicating it may be influenced by time-based trends or seasonality. The Augmented Dickey-Fuller (ADF) test\n helps identify the presence of a unit root, suggesting that the series could be non-stationary and potentially\n unpredictable over time. On the other hand, the Kwiatkowski-Phillips-Schmidt-Shin (KPSS) test checks for the\n stationarity of the series, where failing to reject the null hypothesis indicates a stable, stationary series.\n Together, these tests provide a comprehensive view of your data's time series properties, essential for\n accurate modeling and forecasting.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Unit Root Test.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.quantitative.unitroot_test(data=stock_data, target='close')\nobb.quantitative.unitroot_test(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", "parameters": { "standard": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true + "name": "data", + "type": "List[Data]", + "description": "Time series data.", + "default": "", + "optional": false }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true + "name": "target", + "type": "str", + "description": "Target column name.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", - "optional": true - } - ], - "fred": [ + "name": "fuller_reg", + "type": "Literal[\"c\", \"ct\", \"ctt\", \"nc\", \"c\"]", + "description": "Regression type for ADF test.", + "default": "", + "optional": false + }, { - "name": "period", - "type": "Literal['overnight', '30_day', '90_day', '180_day', 'index']", - "description": "Period of SOFR rate.", - "default": "overnight", - "optional": true + "name": "kpss_reg", + "type": "Literal[\"c\", \"ct\"]", + "description": "Regression type for KPSS test.", + "default": "", + "optional": false } ] }, @@ -26280,144 +37384,81 @@ "OBBject": [ { "name": "results", - "type": "List[SOFR]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "type": "UnitRootModel", + "description": "Unit root tests summary." } ] }, - "data": { + "data": {}, + "model": "" + }, + "/quantitative/summary": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Summary Statistics.\n\n The summary that offers a snapshot of its central tendencies, variability, and distribution.\n This command calculates essential statistics, including mean, standard deviation, variance,\n and specific percentiles, to provide a detailed profile of your target column. B\n y examining these metrics, you gain insights into the data's overall behavior, helping to identify patterns,\n outliers, or anomalies. The summary table is an invaluable tool for initial data exploration,\n ensuring you have a solid foundation for further analysis or reporting.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Summary Statistics.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.quantitative.summary(data=stock_data, target='close')\nobb.quantitative.summary(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "data", + "type": "List[Data]", + "description": "Time series data.", "default": "", "optional": false }, { - "name": "rate", - "type": "float", - "description": "SOFR rate.", + "name": "target", + "type": "str", + "description": "Target column name.", "default": "", "optional": false } - ], - "fred": [] + ] }, - "model": "SOFR" + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SummaryModel", + "description": "Summary table." + } + ] + }, + "data": {}, + "model": "" }, - "/index/price/historical": { + "/regulators/sec/cik_map": { "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", + "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": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, polygon, yfinance.", + "type": "str", + "description": "Symbol to get data for.", "default": "", "optional": false }, - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "interval", - "type": "str", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - }, { "name": "provider", - "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "interval", - "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - } - ], - "intrinio": [ - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 10000, - "optional": true - } - ], - "polygon": [ - { - "name": "interval", - "type": "str", - "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", - "default": "1d", - "optional": true - }, - { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", - "default": "asc", - "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 49999, + "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 } ], - "yfinance": [ + "sec": [ { - "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", + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache for the request, default is True.", + "default": true, "optional": true } ] @@ -26426,12 +37467,12 @@ "OBBject": [ { "name": "results", - "type": "List[IndexHistorical]", + "type": "List[CikMap]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", + "type": "Optional[Literal['sec']]", "description": "Provider name." }, { @@ -26454,191 +37495,60 @@ "data": { "standard": [ { - "name": "date", - "type": "Union[date, datetime]", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "open", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The open price.", - "default": null, - "optional": true - }, - { - "name": "high", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The high price.", - "default": null, - "optional": true - }, - { - "name": "low", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The low price.", - "default": null, - "optional": true - }, - { - "name": "close", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The close price.", - "default": null, - "optional": true - }, - { - "name": "volume", - "type": "int", - "description": "The trading volume.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "vwap", - "type": "float", - "description": "Volume Weighted Average Price over the period.", - "default": null, - "optional": true - }, - { - "name": "change", - "type": "float", - "description": "Change in the price from the previous close.", - "default": null, - "optional": true - }, - { - "name": "change_percent", - "type": "float", - "description": "Change in the price from the previous close, as a normalized percent.", - "default": null, - "optional": true - } - ], - "intrinio": [], - "polygon": [ - { - "name": "transactions", - "type": "Annotated[int, Gt(gt=0)]", - "description": "Number of transactions for the symbol in the time period.", - "default": null, - "optional": true - } - ], - "yfinance": [] - }, - "model": "IndexHistorical" - }, - "/index/market": { - "deprecated": { - "flag": true, - "message": "This endpoint is deprecated; use `/index/price/historical` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.3." - }, - "description": "Get Historical Market Indices.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.market(symbol='^IBEX', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, polygon, yfinance.", - "default": "", - "optional": false - }, - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "interval", - "type": "str", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "interval", - "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - } - ], - "intrinio": [ - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 10000, + "name": "cik", + "type": "Union[int, str]", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, "optional": true } ], - "polygon": [ + "sec": [] + }, + "model": "CikMap" + }, + "/regulators/sec/institutions_search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search SEC-regulated institutions by name and return a list of results with CIK numbers.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.institutions_search(provider='sec')\nobb.regulators.sec.institutions_search(query='blackstone real estate', provider='sec')\n```\n\n", + "parameters": { + "standard": [ { - "name": "interval", + "name": "query", "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", + "description": "Search query.", + "default": "", "optional": true }, { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", - "default": "asc", + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache.", + "default": true, "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 49999, + "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 } ], - "yfinance": [ - { - "name": "interval", - "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - } - ] + "sec": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[MarketIndices]", + "type": "List[InstitutionsSearch]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", + "type": "Optional[Literal['sec']]", "description": "Provider name." }, { @@ -26659,131 +37569,215 @@ ] }, "data": { - "standard": [ - { - "name": "date", - "type": "Union[date, datetime]", - "description": "The date of the data.", - "default": "", - "optional": false - }, + "standard": [], + "sec": [ { - "name": "open", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The open price.", + "name": "name", + "type": "str", + "description": "The name of the institution.", "default": null, "optional": true }, { - "name": "high", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The high price.", + "name": "cik", + "type": "Union[int, str]", + "description": "Central Index Key (CIK)", "default": null, "optional": true - }, + } + ] + }, + "model": "InstitutionsSearch" + }, + "/regulators/sec/schema_files": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Use tool for navigating the directory of SEC XML schema files by year.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.schema_files(provider='sec')\n# Get a list of schema files.\ndata = obb.regulators.sec.schema_files().results\ndata.files[0]\n'https://xbrl.fasb.org/us-gaap/'\n# The directory structure can be navigated by constructing a URL from the 'results' list.\nurl = data.files[0]+data.files[-1]\n# The URL base will always be the 0 position in the list, feed the URL back in as a parameter.\nobb.regulators.sec.schema_files(url=url).results.files\n['https://xbrl.fasb.org/us-gaap/2024/'\n'USGAAP2024FileList.xml'\n'dis/'\n'dqcrules/'\n'ebp/'\n'elts/'\n'entire/'\n'meta/'\n'stm/'\n'us-gaap-2024.zip']\n```\n\n", + "parameters": { + "standard": [ { - "name": "low", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The low price.", - "default": null, + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", "optional": true }, { - "name": "close", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The close price.", - "default": null, + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache.", + "default": true, "optional": true }, { - "name": "volume", - "type": "int", - "description": "The trading volume.", - "default": null, + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", "optional": true } ], - "fmp": [ + "sec": [ { - "name": "vwap", - "type": "float", - "description": "Volume Weighted Average Price over the period.", + "name": "url", + "type": "str", + "description": "Enter an optional URL path to fetch the next level.", "default": null, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[SchemaFiles]", + "description": "Serializable results." }, { - "name": "change", - "type": "float", - "description": "Change in the price from the previous close.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['sec']]", + "description": "Provider name." }, { - "name": "change_percent", - "type": "float", - "description": "Change in the price from the previous close, as a normalized percent.", - "default": null, - "optional": true + "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." } - ], - "intrinio": [], - "polygon": [ + ] + }, + "data": { + "standard": [], + "sec": [ { - "name": "transactions", - "type": "Annotated[int, Gt(gt=0)]", - "description": "Number of transactions for the symbol in the time period.", - "default": null, - "optional": true + "name": "files", + "type": "List[str]", + "description": "Dictionary of URLs to SEC Schema Files", + "default": "", + "optional": false } - ], - "yfinance": [] + ] }, - "model": "MarketIndices" + "model": "SchemaFiles" }, - "/index/constituents": { + "/regulators/sec/symbol_map": { "deprecated": { "flag": null, "message": null }, - "description": "Get Index Constituents.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.constituents(symbol='dowjones', provider='fmp')\n```\n\n", + "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": "symbol", + "name": "query", "type": "str", - "description": "Symbol to get data for.", + "description": "Search query.", "default": "", "optional": false }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache. If True, cache will store for seven days.", + "default": true, + "optional": true + }, { "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "type": "Literal['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 } ], - "fmp": [ + "sec": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[SymbolMap]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['sec']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ { "name": "symbol", - "type": "Literal['dowjones', 'sp500', 'nasdaq']", - "description": "None", - "default": "dowjones", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + } + ] + }, + "model": "SymbolMap" + }, + "/regulators/sec/rss_litigation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the RSS feed that provides links to litigation releases concerning civil lawsuits brought by the Commission in federal court.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.rss_litigation(provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", "optional": true } - ] + ], + "sec": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[IndexConstituents]", + "type": "List[RssLitigation]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['sec']]", "description": "Provider name." }, { @@ -26804,99 +37798,90 @@ ] }, "data": { - "standard": [ + "standard": [], + "sec": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "published", + "type": "datetime", + "description": "The date of publication.", "default": "", "optional": false }, { - "name": "name", - "type": "str", - "description": "Name of the constituent company in the index.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "sector", + "name": "title", "type": "str", - "description": "Sector the constituent company in the index belongs to.", + "description": "The title of the release.", "default": "", "optional": false }, { - "name": "sub_sector", + "name": "summary", "type": "str", - "description": "Sub-sector the constituent company in the index belongs to.", - "default": null, - "optional": true + "description": "Short summary of the release.", + "default": "", + "optional": false }, { - "name": "headquarter", + "name": "id", "type": "str", - "description": "Location of the headquarter of the constituent company in the index.", - "default": null, - "optional": true - }, - { - "name": "date_first_added", - "type": "Union[str, date]", - "description": "Date the constituent company was added to the index.", - "default": null, - "optional": true - }, - { - "name": "cik", - "type": "int", - "description": "Central Index Key (CIK) for the requested entity.", - "default": null, - "optional": true + "description": "The identifier associated with the release.", + "default": "", + "optional": false }, { - "name": "founded", - "type": "Union[str, date]", - "description": "Founding year of the constituent company in the index.", - "default": null, - "optional": true + "name": "link", + "type": "str", + "description": "URL to the release.", + "default": "", + "optional": false } ] }, - "model": "IndexConstituents" + "model": "RssLitigation" }, - "/index/available": { + "/regulators/sec/sic_search": { "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", + "description": "Search for Industry Titles, Reporting Office, and SIC Codes. An empty query string returns all results.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.sic_search(provider='sec')\nobb.regulators.sec.sic_search(query='real estate investment trusts', provider='sec')\n```\n\n", "parameters": { "standard": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache.", + "default": true, + "optional": true + }, { "name": "provider", - "type": "Literal['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", + "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 } ], - "fmp": [], - "yfinance": [] + "sec": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[AvailableIndices]", + "type": "List[SicSearch]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'yfinance']]", + "type": "Optional[Literal['sec']]", "description": "Provider name." }, { @@ -26917,259 +37902,229 @@ ] }, "data": { - "standard": [ - { - "name": "name", - "type": "str", - "description": "Name of the index.", - "default": null, - "optional": true - }, - { - "name": "currency", - "type": "str", - "description": "Currency the index is traded in.", - "default": null, - "optional": true - } - ], - "fmp": [ + "standard": [], + "sec": [ { - "name": "stock_exchange", - "type": "str", - "description": "Stock exchange where the index is listed.", + "name": "sic", + "type": "int", + "description": "Sector Industrial Code (SIC)", "default": "", "optional": false }, { - "name": "exchange_short_name", - "type": "str", - "description": "Short name of the stock exchange where the index is listed.", - "default": "", - "optional": false - } - ], - "yfinance": [ - { - "name": "code", + "name": "industry", "type": "str", - "description": "ID code for keying the index in the OpenBB Terminal.", + "description": "Industry title.", "default": "", "optional": false }, { - "name": "symbol", + "name": "office", "type": "str", - "description": "Symbol for the index.", + "description": "Reporting office within the Corporate Finance Office", "default": "", "optional": false } ] }, - "model": "AvailableIndices" + "model": "SicSearch" }, - "/news/world": { + "/regulators/cftc/cot_search": { "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", + "description": "Curated Commitment of Traders Reports.\n\nSearch a list of curated Commitment of Traders Reports series information.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.cftc.cot_search(provider='nasdaq')\nobb.regulators.cftc.cot_search(query='gold', provider='nasdaq')\n```\n\n", "parameters": { "standard": [ { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. The number of articles to return.", - "default": 2500, - "optional": true - }, - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache.", + "default": true, "optional": true }, { "name": "provider", - "type": "Literal['benzinga', 'fmp', 'intrinio', 'tiingo']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default.", - "default": "benzinga", + "type": "Literal['nasdaq']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default.", + "default": "nasdaq", "optional": true } ], - "benzinga": [ - { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", - "default": null, - "optional": true - }, + "nasdaq": [] + }, + "returns": { + "OBBject": [ { - "name": "display", - "type": "Literal['headline', 'abstract', 'full']", - "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full).", - "default": "full", - "optional": true + "name": "results", + "type": "List[COTSearch]", + "description": "Serializable results." }, { - "name": "updated_since", - "type": "int", - "description": "Number of seconds since the news was updated.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['nasdaq']]", + "description": "Provider name." }, { - "name": "published_since", - "type": "int", - "description": "Number of seconds since the news was published.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "sort", - "type": "Literal['id', 'created', 'updated']", - "description": "Key to sort the news by.", - "default": "created", - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "order", - "type": "Literal['asc', 'desc']", - "description": "Order to sort the news by.", - "default": "desc", - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "isin", + "name": "code", "type": "str", - "description": "The ISIN of the news to retrieve.", - "default": null, - "optional": true + "description": "CFTC Code of the report.", + "default": "", + "optional": false }, { - "name": "cusip", + "name": "name", "type": "str", - "description": "The CUSIP of the news to retrieve.", - "default": null, - "optional": true + "description": "Name of the underlying asset.", + "default": "", + "optional": false }, { - "name": "channels", + "name": "category", "type": "str", - "description": "Channels of the news to retrieve.", + "description": "Category of the underlying asset.", "default": null, "optional": true }, { - "name": "topics", + "name": "subcategory", "type": "str", - "description": "Topics of the news to retrieve.", + "description": "Subcategory of the underlying asset.", "default": null, "optional": true }, { - "name": "authors", + "name": "units", "type": "str", - "description": "Authors of the news to retrieve.", + "description": "The units for one contract.", "default": null, "optional": true }, { - "name": "content_types", + "name": "symbol", "type": "str", - "description": "Content types of the news to retrieve.", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true } ], - "fmp": [], - "intrinio": [ + "nasdaq": [] + }, + "model": "COTSearch" + }, + "/regulators/cftc/cot": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Commitment of Traders Reports.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.cftc.cot(provider='nasdaq')\n# Get the Commitment of Traders Report for Gold.\nobb.regulators.cftc.cot(id='GC=F', provider='nasdaq')\n# Enter the report ID by the Nasdaq Data Link Code.\nobb.regulators.cftc.cot(id='088691', provider='nasdaq')\n# Get the report for futures only.\nobb.regulators.cftc.cot(id='088691', data_type=F, provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ { - "name": "source", - "type": "Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases']", - "description": "The source of the news article.", - "default": null, + "name": "id", + "type": "str", + "description": "The series ID string for the report. Default report is Two-Year Treasury Note Futures.", + "default": "042601", "optional": true }, { - "name": "sentiment", - "type": "Literal['positive', 'neutral', 'negative']", - "description": "Return news only from this source.", - "default": null, + "name": "provider", + "type": "Literal['nasdaq']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default.", + "default": "nasdaq", "optional": true - }, + } + ], + "nasdaq": [ { - "name": "language", + "name": "id", "type": "str", - "description": "Filter by language. Unsupported for yahoo source.", - "default": null, + "description": "CFTC series ID. Use search_cot() to find the ID. IDs not listed in the curated list, but are published on the Nasdaq Data Link website, are valid. Certain symbols, such as 'ES=F', or exact names are also valid. Default report is Two-Year Treasury Note Futures.", + "default": "042601", "optional": true }, { - "name": "topic", - "type": "str", - "description": "Filter by topic. Unsupported for yahoo source.", - "default": null, + "name": "data_type", + "type": "Literal['F', 'FO', 'CITS']", + "description": "The type of data to reuturn. Default is 'FO'. F = Futures only FO = Futures and Options CITS = Commodity Index Trader Supplemental. Only valid for commodities.", + "default": "FO", "optional": true }, { - "name": "word_count_greater_than", - "type": "int", - "description": "News stories will have a word count greater than this value. Unsupported for yahoo source.", - "default": null, + "name": "legacy_format", + "type": "bool", + "description": "Returns the legacy format of report. Default is False.", + "default": false, "optional": true }, { - "name": "word_count_less_than", - "type": "int", - "description": "News stories will have a word count less than this value. Unsupported for yahoo source.", - "default": null, + "name": "report_type", + "type": "Literal['ALL', 'CHG', 'OLD', 'OTR']", + "description": "The type of report to return. Default is 'ALL'. ALL = All CHG = Change in Positions OLD = Old Crop Years OTR = Other Crop Years", + "default": "ALL", "optional": true }, { - "name": "is_spam", - "type": "bool", - "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source.", + "name": "measure", + "type": "Literal['CR', 'NT', 'OI', 'CHG']", + "description": "The measure to return. Default is None. CR = Concentration Ratios NT = Number of Traders OI = Percent of Open Interest CHG = Change in Positions. Only valid when data_type is 'CITS'.", "default": null, "optional": true }, { - "name": "business_relevance_greater_than", - "type": "float", - "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "business_relevance_less_than", - "type": "float", - "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source.", + "name": "end_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true - } - ], - "tiingo": [ + }, { - "name": "offset", - "type": "int", - "description": "Page offset, used in conjunction with limit.", - "default": 0, + "name": "transform", + "type": "Literal['diff', 'rdiff', 'cumul', 'normalize']", + "description": "Transform the data as difference, percent change, cumulative, or normalize.", + "default": null, "optional": true }, { - "name": "source", - "type": "str", - "description": "A comma-separated list of the domains requested.", + "name": "collapse", + "type": "Literal['daily', 'weekly', 'monthly', 'quarterly', 'annual']", + "description": "Collapse the frequency of the time series.", "default": null, "optional": true } @@ -27179,12 +38134,12 @@ "OBBject": [ { "name": "results", - "type": "List[WorldNews]", + "type": "List[COT]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['benzinga', 'fmp', 'intrinio', 'tiingo']]", + "type": "Optional[Literal['nasdaq']]", "description": "Provider name." }, { @@ -27208,802 +38163,1113 @@ "standard": [ { "name": "date", - "type": "datetime", - "description": "The date of the data. The published date of the article.", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + } + ], + "nasdaq": [] + }, + "model": "COT" + }, + "/technical/relative_rotation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Relative Strength Ratio and Relative Strength Momentum for a group of symbols against a benchmark.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Calculate the Relative Strength Ratio and Relative Strength Momentum for a group of symbols against a benchmark.\nstock_data = obb.equity.price.historical(symbol='AAPL,MSFT,GOOGL,META,AMZN,TSLA,SPY', start_date='2022-01-01', provider='yfinance')\nrr_data = obb.technical.relative_rotation(data=stock_data.results, benchmark='SPY')\nrs_ratios = rr_data.results.rs_ratios\nrs_momentum = rr_data.results.rs_momentum\n# When the assets are not traded 252 days per year,adjust the momentum and volatility periods accordingly.\ncrypto_data = obb.crypto.price.historical( symbol='BTCUSD,ETHUSD,SOLUSD', start_date='2021-01-01', provider='yfinance')\nrr_data = obb.technical.relative_rotation(data=crypto_data.results, benchmark='BTCUSD', long_period=365, short_period=30, window=30, trading_periods=365)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "list[Data]", + "description": "The data to be used for the relative rotation calculations.", "default": "", "optional": false }, { - "name": "title", + "name": "benchmark", "type": "str", - "description": "Title of the article.", + "description": "The symbol to be used as the benchmark.", "default": "", "optional": false }, { - "name": "images", - "type": "List[Dict[str, str]]", - "description": "Images associated with the article.", - "default": null, - "optional": true + "name": "study", + "type": "Literal[price, volume, volatility]", + "description": "The data point for the calculations. If 'price', the closing price will be used.", + "default": "", + "optional": false }, { - "name": "text", - "type": "str", - "description": "Text/body of the article.", - "default": null, - "optional": true + "name": "long_period", + "type": "int, optional", + "description": "The length of the long period for momentum calculation, by default 252.", + "default": "", + "optional": false }, { - "name": "url", - "type": "str", - "description": "URL to the article.", - "default": null, - "optional": true - } - ], - "benzinga": [ + "name": "short_period", + "type": "int, optional", + "description": "The length of the short period for momentum calculation, by default 21.", + "default": "", + "optional": false + }, { - "name": "id", - "type": "str", - "description": "Article ID.", + "name": "window", + "type": "int, optional", + "description": "The length of window for the standard deviation calculation, by default 21.", "default": "", "optional": false }, { - "name": "author", - "type": "str", - "description": "Author of the news.", - "default": null, - "optional": true + "name": "trading_periods", + "type": "int, optional", + "description": "The number of trading periods per year, for the standard deviation calculation, by default 252.", + "default": "", + "optional": false }, { - "name": "teaser", - "type": "str", - "description": "Teaser of the news.", - "default": null, - "optional": true + "name": "chart_params", + "type": "dict[str, Any], optional", + "description": "Additional parameters to pass when `chart=True` and the `openbb-charting` extension is installed.", + "default": "", + "optional": false }, { - "name": "channels", - "type": "str", - "description": "Channels associated with the news.", - "default": null, - "optional": true + "name": "date", + "type": "str, optional", + "description": "A target end date within the data to use for the chart, by default is the last date in the data.", + "default": "", + "optional": false }, { - "name": "stocks", - "type": "str", - "description": "Stocks associated with the news.", - "default": null, - "optional": true + "name": "show_tails", + "type": "bool", + "description": "Show the tails on the chart, by default True.", + "default": "", + "optional": false }, { - "name": "tags", - "type": "str", - "description": "Tags associated with the news.", - "default": null, - "optional": true + "name": "tail_periods", + "type": "int", + "description": "Number of periods to show in the tails, by default 16.", + "default": "", + "optional": false }, { - "name": "updated", - "type": "datetime", - "description": "Updated date of the news.", - "default": null, - "optional": true - } - ], - "fmp": [ + "name": "tail_interval", + "type": "Literal[day, week, month]", + "description": "Interval to show the tails, by default 'week'.", + "default": "", + "optional": false + }, { - "name": "site", - "type": "str", - "description": "News source.", + "name": "title", + "type": "str, optional", + "description": "Title of the chart.", "default": "", "optional": false - } - ], - "intrinio": [ + }, { - "name": "source", - "type": "str", - "description": "The source of the news article.", - "default": null, - "optional": true + "name": "results", + "type": "RelativeRotationData", + "description": "symbols : list[str]:", + "default": "", + "optional": false }, { - "name": "summary", + "name": "benchmark", "type": "str", - "description": "The summary of the news article.", - "default": null, - "optional": true + "description": "The benchmark symbol.", + "default": "", + "optional": false }, { - "name": "topics", - "type": "str", - "description": "The topics related to the news article.", - "default": null, - "optional": true + "name": "study", + "type": "Literal[price, volume, volatility]", + "description": "The data point for the selected.", + "default": "", + "optional": false }, { - "name": "word_count", + "name": "long_period", "type": "int", - "description": "The word count of the news article.", - "default": null, - "optional": true + "description": "The length of the long period for momentum calculation, as entered by the user.", + "default": "", + "optional": false }, { - "name": "business_relevance", - "type": "float", - "description": "How strongly correlated the news article is to the business", - "default": null, - "optional": true + "name": "short_period", + "type": "int", + "description": "The length of the short period for momentum calculation, as entered by the user.", + "default": "", + "optional": false }, { - "name": "sentiment", - "type": "str", - "description": "The sentiment of the news article - i.e, negative, positive.", - "default": null, - "optional": true + "name": "window", + "type": "int", + "description": "The length of window for the standard deviation calculation.", + "default": "", + "optional": false }, { - "name": "sentiment_confidence", - "type": "float", - "description": "The confidence score of the sentiment rating.", - "default": null, - "optional": true + "name": "trading_periods", + "type": "int", + "description": "The number of trading periods per year, for the standard deviation calculation.", + "default": "", + "optional": false }, { - "name": "language", + "name": "start_date", "type": "str", - "description": "The language of the news article.", - "default": null, - "optional": true - }, - { - "name": "spam", - "type": "bool", - "description": "Whether the news article is spam.", - "default": null, - "optional": true + "description": "The start date of the data after adjusting the length of the data for the calculations.", + "default": "", + "optional": false }, { - "name": "copyright", + "name": "end_date", "type": "str", - "description": "The copyright notice of the news article.", - "default": null, - "optional": true + "description": "The end date of the data.", + "default": "", + "optional": false }, { - "name": "id", - "type": "str", - "description": "Article ID.", + "name": "symbols_data", + "type": "list[Data]", + "description": "The data representing the selected 'study' for each symbol.", "default": "", "optional": false }, { - "name": "company", - "type": "IntrinioCompany", - "description": "The Intrinio Company object. Contains details company reference data.", - "default": null, - "optional": true + "name": "benchmark_data", + "type": "list[Data]", + "description": "The data representing the selected 'study' for the benchmark.", + "default": "", + "optional": false }, { - "name": "security", - "type": "IntrinioSecurity", - "description": "The Intrinio Security object. Contains the security details related to the news article.", - "default": null, - "optional": true + "name": "rs_ratios", + "type": "list[Data]", + "description": "The normalized relative strength ratios data.", + "default": "", + "optional": false + }, + { + "name": "rs_momentum", + "type": "list[Data]", + "description": "The normalized relative strength momentum data.", + "default": "", + "optional": false } - ], - "tiingo": [ + ] + }, + "returns": { + "OBBject": [ { - "name": "symbols", - "type": "str", - "description": "Ticker tagged in the fetched news.", - "default": null, - "optional": true + "name": "results", + "type": "RelativeRotationData", + "description": "results : RelativeRotationData" + } + ] + }, + "data": {}, + "model": "" + }, + "/technical/atr": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Average True Range.\n\n Used to measure volatility, especially volatility caused by gaps or limit moves.\n The ATR metric helps understand how much the values in your data change on average,\n giving insights into the stability or unpredictability during a certain period.\n It's particularly useful for spotting trends of increase or decrease in variations,\n without getting into technical trading details.\n The method considers not just the day-to-day changes but also accounts for any\n sudden jumps or drops, ensuring you get a comprehensive view of movement.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Average True Range.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\natr_data = obb.technical.atr(data=stock_data.results)\nobb.technical.atr(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "List[Data]", + "description": "List of data to apply the indicator to.", + "default": "", + "optional": false }, { - "name": "article_id", - "type": "int", - "description": "Unique ID of the news article.", + "name": "index", + "type": "str, optional", + "description": "Index column name, by default \"date\"", "default": "", "optional": false }, { - "name": "site", - "type": "str", - "description": "News source.", + "name": "length", + "type": "PositiveInt, optional", + "description": "It's period, by default 14", "default": "", "optional": false }, { - "name": "tags", - "type": "str", - "description": "Tags associated with the news article.", - "default": null, - "optional": true + "name": "mamode", + "type": "Literal[\"rma\", \"ema\", \"sma\", \"wma\"], optional", + "description": "Moving average mode, by default \"rma\"", + "default": "", + "optional": false }, { - "name": "crawl_date", - "type": "datetime", - "description": "Date the news article was crawled.", + "name": "drift", + "type": "NonNegativeInt, optional", + "description": "The difference period, by default 1", + "default": "", + "optional": false + }, + { + "name": "offset", + "type": "int, optional", + "description": "How many periods to offset the result, by default 0", "default": "", "optional": false } ] }, - "model": "WorldNews" + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[Data]", + "description": "List of data with the indicator applied." + } + ] + }, + "data": {}, + "model": "" }, - "/news/company": { + "/technical/fib": { "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", + "description": "Create Fibonacci Retracement Levels.\n\n This method draws from a classic technique to pinpoint significant price levels\n that often indicate where the market might find support or resistance.\n It's a tool used to gauge potential turning points in the data by applying a\n mathematical approach rooted in nature's patterns. Is used to get insights into\n where prices could head next, based on historical movements.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Bollinger Band Width.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nfib_data = obb.technical.fib(data=stock_data.results, period=120)\nobb.technical.fib(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", "parameters": { "standard": [ { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, yfinance.", - "default": null, - "optional": true + "name": "data", + "type": "List[Data]", + "description": "List of data to apply the indicator to.", + "default": "", + "optional": false }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true + "name": "index", + "type": "str, optional", + "description": "Index column name, by default \"date\"", + "default": "", + "optional": false }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true + "name": "period", + "type": "PositiveInt, optional", + "description": "Period to calculate the indicator, by default 120", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[Data]", + "description": "List of data with the indicator applied." + } + ] + }, + "data": {}, + "model": "" + }, + "/technical/obv": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the On Balance Volume (OBV).\n\n Is a cumulative total of the up and down volume. When the close is higher than the\n previous close, the volume is added to the running total, and when the close is\n lower than the previous close, the volume is subtracted from the running total.\n\n To interpret the OBV, look for the OBV to move with the price or precede price moves.\n If the price moves before the OBV, then it is a non-confirmed move. A series of rising peaks,\n or falling troughs, in the OBV indicates a strong trend. If the OBV is flat, then the market\n is not trending.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the On Balance Volume (OBV).\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nobv_data = obb.technical.obv(data=stock_data.results, offset=0)\nobb.technical.obv(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "List[Data]", + "description": "List of data to apply the indicator to.", + "default": "", + "optional": false }, { - "name": "limit", - "type": "Annotated[int, Ge(ge=0)]", - "description": "The number of data entries to return.", - "default": 2500, - "optional": true + "name": "index", + "type": "str, optional", + "description": "Index column name, by default \"date\"", + "default": "", + "optional": false }, { - "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 + "name": "offset", + "type": "int, optional", + "description": "How many periods to offset the result, by default 0.", + "default": "", + "optional": false } - ], - "benzinga": [ + ] + }, + "returns": { + "OBBject": [ { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", - "default": null, - "optional": true - }, + "name": "results", + "type": "List[Data]", + "description": "List of data with the indicator applied." + } + ] + }, + "data": {}, + "model": "" + }, + "/technical/fisher": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Perform the Fisher Transform.\n\n A technical indicator created by John F. Ehlers that converts prices into a Gaussian\n normal distribution. The indicator highlights when prices have moved to an extreme,\n based on recent prices.\n This may help in spotting turning points in the price of an asset. It also helps\n show the trend and isolate the price waves within a trend.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Perform the Fisher Transform.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nfisher_data = obb.technical.fisher(data=stock_data.results, length=14, signal=1)\nobb.technical.fisher(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ { - "name": "display", - "type": "Literal['headline', 'abstract', 'full']", - "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full).", - "default": "full", - "optional": true + "name": "data", + "type": "List[Data]", + "description": "List of data to apply the indicator to.", + "default": "", + "optional": false }, { - "name": "updated_since", - "type": "int", - "description": "Number of seconds since the news was updated.", - "default": null, - "optional": true + "name": "index", + "type": "str, optional", + "description": "Index column name, by default \"date\"", + "default": "", + "optional": false }, { - "name": "published_since", - "type": "int", - "description": "Number of seconds since the news was published.", - "default": null, - "optional": true + "name": "length", + "type": "PositiveInt, optional", + "description": "Fisher period, by default 14", + "default": "", + "optional": false }, { - "name": "sort", - "type": "Literal['id', 'created', 'updated']", - "description": "Key to sort the news by.", - "default": "created", - "optional": true - }, + "name": "signal", + "type": "PositiveInt, optional", + "description": "Fisher Signal period, by default 1", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ { - "name": "order", - "type": "Literal['asc', 'desc']", - "description": "Order to sort the news by.", - "default": "desc", - "optional": true - }, + "name": "results", + "type": "List[Data]", + "description": "List of data with the indicator applied." + } + ] + }, + "data": {}, + "model": "" + }, + "/technical/adosc": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Accumulation/Distribution Oscillator.\n\n Also known as the Chaikin Oscillator.\n\n Essentially a momentum indicator, but of the Accumulation-Distribution line\n rather than merely price. It looks at both the strength of price moves and the\n underlying buying and selling pressure during a given time period. The oscillator\n reading above zero indicates net buying pressure, while one below zero registers\n net selling pressure. Divergence between the indicator and pure price moves are\n the most common signals from the indicator, and often flag market turning points.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Accumulation/Distribution Oscillator.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nadosc_data = obb.technical.adosc(data=stock_data.results, fast=3, slow=10, offset=0)\nobb.technical.adosc(fast=2, slow=4, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ { - "name": "isin", - "type": "str", - "description": "The company's ISIN.", - "default": null, - "optional": true + "name": "data", + "type": "List[Data]", + "description": "List of data to be used for the calculation.", + "default": "", + "optional": false }, { - "name": "cusip", - "type": "str", - "description": "The company's CUSIP.", - "default": null, - "optional": true + "name": "fast", + "type": "PositiveInt, optional", + "description": "Number of periods to be used for the fast calculation, by default 3.", + "default": "", + "optional": false }, { - "name": "channels", - "type": "str", - "description": "Channels of the news to retrieve.", - "default": null, - "optional": true + "name": "slow", + "type": "PositiveInt, optional", + "description": "Number of periods to be used for the slow calculation, by default 10.", + "default": "", + "optional": false }, { - "name": "topics", - "type": "str", - "description": "Topics of the news to retrieve.", - "default": null, - "optional": true + "name": "offset", + "type": "int, optional", + "description": "Offset to be used for the calculation, by default 0.", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[Data]", + "description": "The calculated data." + } + ] + }, + "data": {}, + "model": "" + }, + "/technical/bbands": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Bollinger Bands.\n\n Consist of three lines. The middle band is a simple moving average (generally 20\n periods) of the typical price (TP). The upper and lower bands are F standard\n deviations (generally 2) above and below the middle band.\n The bands widen and narrow when the volatility of the price is higher or lower,\n respectively.\n\n Bollinger Bands do not, in themselves, generate buy or sell signals;\n they are an indicator of overbought or oversold conditions. When the price is near the\n upper or lower band it indicates that a reversal may be imminent. The middle band\n becomes a support or resistance level. The upper and lower bands can also be\n interpreted as price targets. When the price bounces off of the lower band and crosses\n the middle band, then the upper band becomes the price target.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Chande Momentum Oscillator.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nbbands_data = obb.technical.bbands(data=stock_data.results, target='close', length=50, std=2, mamode='sma')\nobb.technical.bbands(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "List[Data]", + "description": "List of data to be used for the calculation.", + "default": "", + "optional": false }, { - "name": "authors", + "name": "target", "type": "str", - "description": "Authors of the news to retrieve.", - "default": null, - "optional": true + "description": "Target column name.", + "default": "", + "optional": false }, { - "name": "content_types", - "type": "str", - "description": "Content types of the news to retrieve.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "page", - "type": "int", - "description": "Page number of the results. Use in combination with limit.", - "default": 0, - "optional": true - } - ], - "intrinio": [ - { - "name": "source", - "type": "Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases']", - "description": "The source of the news article.", - "default": null, - "optional": true + "name": "index", + "type": "str, optional", + "description": "Index column name to use with `data`, by default \"date\".", + "default": "", + "optional": false }, { - "name": "sentiment", - "type": "Literal['positive', 'neutral', 'negative']", - "description": "Return news only from this source.", - "default": null, - "optional": true + "name": "length", + "type": "int, optional", + "description": "Number of periods to be used for the calculation, by default 50.", + "default": "", + "optional": false }, { - "name": "language", - "type": "str", - "description": "Filter by language. Unsupported for yahoo source.", - "default": null, - "optional": true + "name": "std", + "type": "NonNegativeFloat, optional", + "description": "Standard deviation to be used for the calculation, by default 2.", + "default": "", + "optional": false }, { - "name": "topic", - "type": "str", - "description": "Filter by topic. Unsupported for yahoo source.", - "default": null, - "optional": true + "name": "mamode", + "type": "Literal[\"sma\", \"ema\", \"wma\", \"rma\"], optional", + "description": "Moving average mode to be used for the calculation, by default \"sma\".", + "default": "", + "optional": false }, { - "name": "word_count_greater_than", - "type": "int", - "description": "News stories will have a word count greater than this value. Unsupported for yahoo source.", - "default": null, - "optional": true + "name": "offset", + "type": "int, optional", + "description": "Offset to be used for the calculation, by default 0.", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[Data]", + "description": "The calculated data." + } + ] + }, + "data": {}, + "model": "" + }, + "/technical/zlma": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the zero lag exponential moving average (ZLEMA).\n\n Created by John Ehlers and Ric Way. The idea is do a\n regular exponential moving average (EMA) calculation but\n on a de-lagged data instead of doing it on the regular data.\n Data is de-lagged by removing the data from \"lag\" days ago\n thus removing (or attempting to) the cumulative effect of\n the moving average.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Chande Momentum Oscillator.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nzlma_data = obb.technical.zlma(data=stock_data.results, target='close', length=50, offset=0)\nobb.technical.zlma(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "List[Data]", + "description": "List of data to be used for the calculation.", + "default": "", + "optional": false }, { - "name": "word_count_less_than", - "type": "int", - "description": "News stories will have a word count less than this value. Unsupported for yahoo source.", - "default": null, - "optional": true + "name": "target", + "type": "str", + "description": "Target column name.", + "default": "", + "optional": false }, { - "name": "is_spam", - "type": "bool", - "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source.", - "default": null, - "optional": true + "name": "index", + "type": "str, optional", + "description": "Index column name to use with `data`, by default \"date\".", + "default": "", + "optional": false }, { - "name": "business_relevance_greater_than", - "type": "float", - "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source.", - "default": null, - "optional": true + "name": "length", + "type": "int, optional", + "description": "Number of periods to be used for the calculation, by default 50.", + "default": "", + "optional": false }, { - "name": "business_relevance_less_than", - "type": "float", - "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source.", - "default": null, - "optional": true + "name": "offset", + "type": "int, optional", + "description": "Offset to be used for the calculation, by default 0.", + "default": "", + "optional": false } - ], - "polygon": [ + ] + }, + "returns": { + "OBBject": [ { - "name": "order", - "type": "Literal['asc', 'desc']", - "description": "Sort order of the articles.", - "default": "desc", - "optional": true + "name": "results", + "type": "List[Data]", + "description": "The calculated data." } - ], - "tiingo": [ + ] + }, + "data": {}, + "model": "" + }, + "/technical/aroon": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Aroon Indicator.\n\n The word aroon is Sanskrit for \"dawn's early light.\" The Aroon\n indicator attempts to show when a new trend is dawning. The indicator consists\n of two lines (Up and Down) that measure how long it has been since the highest\n high/lowest low has occurred within an n period range.\n\n When the Aroon Up is staying between 70 and 100 then it indicates an upward trend.\n When the Aroon Down is staying between 70 and 100 then it indicates an downward trend.\n A strong upward trend is indicated when the Aroon Up is above 70 while the Aroon Down is below 30.\n Likewise, a strong downward trend is indicated when the Aroon Down is above 70 while\n the Aroon Up is below 30. Also look for crossovers. When the Aroon Down crosses above\n the Aroon Up, it indicates a weakening of the upward trend (and vice versa).", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Chande Momentum Oscillator.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\naaron_data = obb.technical.aroon(data=stock_data.results, length=25, scalar=100)\nobb.technical.aroon(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ { - "name": "offset", - "type": "int", - "description": "Page offset, used in conjunction with limit.", - "default": 0, - "optional": true + "name": "data", + "type": "List[Data]", + "description": "List of data to be used for the calculation.", + "default": "", + "optional": false }, { - "name": "source", - "type": "str", - "description": "A comma-separated list of the domains requested.", - "default": null, - "optional": true + "name": "index", + "type": "str, optional", + "description": "Index column name to use with `data`, by default \"date\".", + "default": "", + "optional": false + }, + { + "name": "length", + "type": "int, optional", + "description": "Number of periods to be used for the calculation, by default 25.", + "default": "", + "optional": false + }, + { + "name": "scalar", + "type": "float, optional", + "description": "Scalar to be used for the calculation, by default 100.", + "default": "", + "optional": false } - ], - "yfinance": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[CompanyNews]", - "description": "Serializable results." + "type": "List[Data]", + "description": "The calculated data." + } + ] + }, + "data": {}, + "model": "" + }, + "/technical/sma": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Simple Moving Average (SMA).\n\n Moving Averages are used to smooth the data in an array to\n help eliminate noise and identify trends. The Simple Moving Average is literally\n the simplest form of a moving average. Each output value is the average of the\n previous n values. In a Simple Moving Average, each value in the time period carries\n equal weight, and values outside of the time period are not included in the average.\n This makes it less responsive to recent changes in the data, which can be useful for\n filtering out those changes.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Chande Momentum Oscillator.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nsma_data = obb.technical.sma(data=stock_data.results, target='close', length=50, offset=0)\nobb.technical.sma(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "List[Data]", + "description": "List of data to be used for the calculation.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Optional[Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']]", - "description": "Provider name." + "name": "target", + "type": "str", + "description": "Target column name.", + "default": "", + "optional": false }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "index", + "type": "str, optional", + "description": "Index column name to use with `data`, by default \"date\".", + "default": "", + "optional": false }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "length", + "type": "int, optional", + "description": "Number of periods to be used for the calculation, by default 50.", + "default": "", + "optional": false }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "offset", + "type": "int, optional", + "description": "Offset from the current period, by default 0.", + "default": "", + "optional": false } ] }, - "data": { + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[Data]", + "description": "The calculated data." + } + ] + }, + "data": {}, + "model": "" + }, + "/technical/demark": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Demark sequential indicator.\n\n This indicator offers a strategic way to spot potential reversals in market trends.\n It's designed to highlight moments when the current trend may be running out of steam,\n suggesting a possible shift in direction. By focusing on specific patterns in price movements, it provides\n valuable insights for making informed decisions on future changes and identifies trend exhaustion points\n with precision.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Demark Sequential Indicator.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\ndemark_data = obb.technical.demark(data=stock_data.results, offset=0)\nobb.technical.demark(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { "standard": [ { - "name": "date", - "type": "datetime", - "description": "The date of the data. Here it is the published date of the article.", + "name": "data", + "type": "List[Data]", + "description": "List of data to be used for the calculation.", "default": "", "optional": false }, { - "name": "title", - "type": "str", - "description": "Title of the article.", + "name": "index", + "type": "str, optional", + "description": "Index column name to use with `data`, by default \"date\".", "default": "", "optional": false }, { - "name": "text", - "type": "str", - "description": "Text/body of the article.", - "default": null, - "optional": true + "name": "target", + "type": "str, optional", + "description": "Target column name, by default \"close\".", + "default": "", + "optional": false }, { - "name": "images", - "type": "List[Dict[str, str]]", - "description": "Images associated with the article.", - "default": null, - "optional": true + "name": "show_all", + "type": "bool, optional", + "description": "Show 1 - 13. If set to False, show 6 - 9", + "default": "", + "optional": false }, { - "name": "url", - "type": "str", - "description": "URL to the article.", + "name": "asint", + "type": "bool, optional", + "description": "If True, fill NAs with 0 and change type to int, by default True.", + "default": "", + "optional": false + }, + { + "name": "offset", + "type": "int, optional", + "description": "How many periods to offset the result", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[Data]", + "description": "The calculated data." + } + ] + }, + "data": {}, + "model": "" + }, + "/technical/vwap": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Volume Weighted Average Price (VWAP).\n\n Measures the average typical price by volume.\n It is typically used with intraday charts to identify general direction.\n It helps to understand the true average price factoring in the volume of transactions,\n and serves as a benchmark for assessing the market's direction over short periods, such as a single trading day.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Volume Weighted Average Price (VWAP).\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nvwap_data = obb.technical.vwap(data=stock_data.results, anchor='D', offset=0)\nobb.technical.vwap(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "List[Data]", + "description": "List of data to be used for the calculation.", "default": "", "optional": false }, { - "name": "symbols", - "type": "str", - "description": "Symbols associated with the article.", - "default": null, - "optional": true - } - ], - "benzinga": [ - { - "name": "images", - "type": "List[Dict[str, str]]", - "description": "URL to the images of the news.", - "default": null, - "optional": true + "name": "index", + "type": "str, optional", + "description": "Index column name to use with `data`, by default \"date\".", + "default": "", + "optional": false }, { - "name": "id", - "type": "str", - "description": "Article ID.", + "name": "anchor", + "type": "str, optional", + "description": "Anchor period to use for the calculation, by default \"D\".", "default": "", "optional": false }, { - "name": "author", - "type": "str", - "description": "Author of the article.", - "default": null, - "optional": true - }, + "name": "https", + "type": "//pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#timeseries-offset-aliases", + "description": "offset : int, optional", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ { - "name": "teaser", - "type": "str", - "description": "Teaser of the news.", - "default": null, - "optional": true - }, + "name": "results", + "type": "List[Data]", + "description": "The calculated data." + } + ] + }, + "data": {}, + "model": "" + }, + "/technical/macd": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Moving Average Convergence Divergence (MACD).\n\n Difference between two Exponential Moving Averages. The Signal line is an\n Exponential Moving Average of the MACD.\n\n The MACD signals trend changes and indicates the start of new trend direction.\n High values indicate overbought conditions, low values indicate oversold conditions.\n Divergence with the price indicates an end to the current trend, especially if the\n MACD is at extreme high or low values. When the MACD line crosses above the\n signal line a buy signal is generated. When the MACD crosses below the signal line a\n sell signal is generated. To confirm the signal, the MACD should be above zero for a buy,\n and below zero for a sell.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Moving Average Convergence Divergence (MACD).\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nmacd_data = obb.technical.macd(data=stock_data.results, target='close', fast=12, slow=26, signal=9)\n# Example with mock data.\nobb.technical.macd(fast=2, slow=3, signal=1, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ { - "name": "channels", - "type": "str", - "description": "Channels associated with the news.", - "default": null, - "optional": true + "name": "data", + "type": "List[Data]", + "description": "List of data to be used for the calculation.", + "default": "", + "optional": false }, { - "name": "stocks", + "name": "target", "type": "str", - "description": "Stocks associated with the news.", - "default": null, - "optional": true + "description": "Target column name.", + "default": "", + "optional": false }, { - "name": "tags", - "type": "str", - "description": "Tags associated with the news.", - "default": null, - "optional": true + "name": "fast", + "type": "int, optional", + "description": "Number of periods for the fast EMA, by default 12.", + "default": "", + "optional": false }, { - "name": "updated", - "type": "datetime", - "description": "Updated date of the news.", - "default": null, - "optional": true - } - ], - "fmp": [ + "name": "slow", + "type": "int, optional", + "description": "Number of periods for the slow EMA, by default 26.", + "default": "", + "optional": false + }, { - "name": "source", - "type": "str", - "description": "Name of the news source.", + "name": "signal", + "type": "int, optional", + "description": "Number of periods for the signal EMA, by default 9.", "default": "", "optional": false } - ], - "intrinio": [ + ] + }, + "returns": { + "OBBject": [ { - "name": "source", - "type": "str", - "description": "The source of the news article.", - "default": null, - "optional": true - }, + "name": "results", + "type": "List[Data]", + "description": "The calculated data." + } + ] + }, + "data": {}, + "model": "" + }, + "/technical/hma": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Hull Moving Average (HMA).\n\n Solves the age old dilemma of making a moving average more responsive to current\n price activity whilst maintaining curve smoothness.\n In fact the HMA almost eliminates lag altogether and manages to improve smoothing\n at the same time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Calculate HMA with historical stock data.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nhma_data = obb.technical.hma(data=stock_data.results, target='close', length=50, offset=0)\n```\n\n", + "parameters": { + "standard": [ { - "name": "summary", - "type": "str", - "description": "The summary of the news article.", - "default": null, - "optional": true + "name": "data", + "type": "List[Data]", + "description": "List of data to be used for the calculation.", + "default": "", + "optional": false }, { - "name": "topics", + "name": "target", "type": "str", - "description": "The topics related to the news article.", - "default": null, - "optional": true + "description": "Target column name.", + "default": "", + "optional": false }, { - "name": "word_count", - "type": "int", - "description": "The word count of the news article.", - "default": null, - "optional": true + "name": "index", + "type": "str, optional", + "description": "Index column name to use with `data`, by default \"date\".", + "default": "", + "optional": false }, { - "name": "business_relevance", - "type": "float", - "description": "How strongly correlated the news article is to the business", - "default": null, - "optional": true + "name": "length", + "type": "int, optional", + "description": "Number of periods for the HMA, by default 50.", + "default": "", + "optional": false }, { - "name": "sentiment", - "type": "str", - "description": "The sentiment of the news article - i.e, negative, positive.", - "default": null, - "optional": true - }, + "name": "offset", + "type": "int, optional", + "description": "Offset of the HMA, by default 0.", + "default": "", + "optional": false + } + ] + }, + "returns": { + "OBBject": [ { - "name": "sentiment_confidence", - "type": "float", - "description": "The confidence score of the sentiment rating.", - "default": null, - "optional": true - }, + "name": "results", + "type": "List[Data]", + "description": "The calculated data." + } + ] + }, + "data": {}, + "model": "" + }, + "/technical/donchian": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Donchian Channels.\n\n Three lines generated by moving average calculations that comprise an indicator\n formed by upper and lower bands around a midrange or median band. The upper band\n marks the highest price of a security over N periods while the lower band\n marks the lowest price of a security over N periods. The area\n between the upper and lower bands represents the Donchian Channel.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Donchian Channels.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\ndonchian_data = obb.technical.donchian(data=stock_data.results, lower_length=20, upper_length=20, offset=0)\nobb.technical.donchian(lower_length=1, upper_length=3, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ { - "name": "language", - "type": "str", - "description": "The language of the news article.", - "default": null, - "optional": true + "name": "data", + "type": "List[Data]", + "description": "List of data to be used for the calculation.", + "default": "", + "optional": false }, { - "name": "spam", - "type": "bool", - "description": "Whether the news article is spam.", - "default": null, - "optional": true + "name": "index", + "type": "str, optional", + "description": "Index column name to use with `data`, by default \"date\".", + "default": "", + "optional": false }, { - "name": "copyright", - "type": "str", - "description": "The copyright notice of the news article.", - "default": null, - "optional": true + "name": "lower_length", + "type": "PositiveInt, optional", + "description": "Number of periods for the lower band, by default 20.", + "default": "", + "optional": false }, { - "name": "id", - "type": "str", - "description": "Article ID.", + "name": "upper_length", + "type": "PositiveInt, optional", + "description": "Number of periods for the upper band, by default 20.", "default": "", "optional": false }, { - "name": "security", - "type": "IntrinioSecurity", - "description": "The Intrinio Security object. Contains the security details related to the news article.", - "default": null, - "optional": true + "name": "offset", + "type": "int, optional", + "description": "Offset of the Donchian Channel, by default 0.", + "default": "", + "optional": false } - ], - "polygon": [ + ] + }, + "returns": { + "OBBject": [ { - "name": "source", - "type": "str", - "description": "Source of the article.", - "default": null, - "optional": true - }, + "name": "results", + "type": "List[Data]", + "description": "The calculated data." + } + ] + }, + "data": {}, + "model": "" + }, + "/technical/ichimoku": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Ichimoku Cloud.\n\n Also known as Ichimoku Kinko Hyo, is a versatile indicator that defines support and\n resistance, identifies trend direction, gauges momentum and provides trading\n signals. Ichimoku Kinko Hyo translates into \"one look equilibrium chart\". With\n one look, chartists can identify the trend and look for potential signals within\n that trend.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Ichimoku Cloud.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nichimoku_data = obb.technical.ichimoku(data=stock_data.results, conversion=9, base=26, lookahead=False)\n```\n\n", + "parameters": { + "standard": [ { - "name": "tags", - "type": "str", - "description": "Keywords/tags in the article", - "default": null, - "optional": true + "name": "data", + "type": "List[Data]", + "description": "List of data to be used for the calculation.", + "default": "", + "optional": false }, { - "name": "id", - "type": "str", - "description": "Article ID.", + "name": "index", + "type": "str, optional", + "description": "Index column name to use with `data`, by default \"date\".", "default": "", "optional": false }, { - "name": "amp_url", - "type": "str", - "description": "AMP URL.", - "default": null, - "optional": true + "name": "conversion", + "type": "PositiveInt, optional", + "description": "Number of periods for the conversion line, by default 9.", + "default": "", + "optional": false }, { - "name": "publisher", - "type": "PolygonPublisher", - "description": "Publisher of the article.", + "name": "base", + "type": "PositiveInt, optional", + "description": "Number of periods for the base line, by default 26.", "default": "", "optional": false - } - ], - "tiingo": [ - { - "name": "tags", - "type": "str", - "description": "Tags associated with the news article.", - "default": null, - "optional": true }, { - "name": "article_id", - "type": "int", - "description": "Unique ID of the news article.", + "name": "lagging", + "type": "PositiveInt, optional", + "description": "Number of periods for the lagging span, by default 52.", "default": "", "optional": false }, - { - "name": "source", - "type": "str", - "description": "News source.", + { + "name": "offset", + "type": "PositiveInt, optional", + "description": "Number of periods for the offset, by default 26.", "default": "", "optional": false }, { - "name": "crawl_date", - "type": "datetime", - "description": "Date the news article was crawled.", + "name": "lookahead", + "type": "bool, optional", + "description": "drops the Chikou Span Column to prevent potential data leak", "default": "", "optional": false } - ], - "yfinance": [ + ] + }, + "returns": { + "OBBject": [ { - "name": "source", - "type": "str", - "description": "Source of the news article", - "default": "", - "optional": false + "name": "results", + "type": "List[Data]", + "description": "The calculated data." } ] }, - "model": "CompanyNews" + "data": {}, + "model": "" }, - "/regulators/sec/cik_map": { + "/technical/clenow": { "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", + "description": "Calculate the Clenow Volatility Adjusted Momentum.\n\n The Clenow Volatility Adjusted Momentum is a sophisticated approach to understanding market momentum with a twist.\n It adjusts for volatility, offering a clearer picture of true momentum by considering how price movements are\n influenced by their volatility over a set period. It helps in identifying stronger, more reliable trends.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Clenow Volatility Adjusted Momentum.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nclenow_data = obb.technical.clenow(data=stock_data.results, period=90)\nobb.technical.clenow(period=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", "parameters": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "name": "data", + "type": "List[Data]", + "description": "List of data to be used for the calculation.", "default": "", "optional": false }, { - "name": "provider", - "type": "Literal['sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", - "default": "sec", - "optional": true - } - ], - "sec": [ + "name": "index", + "type": "str, optional", + "description": "Index column name to use with `data`, by default \"date\".", + "default": "", + "optional": false + }, { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache for the request, default is True.", - "default": true, - "optional": true + "name": "target", + "type": "str, optional", + "description": "Target column name, by default \"close\".", + "default": "", + "optional": false + }, + { + "name": "period", + "type": "PositiveInt, optional", + "description": "Number of periods for the momentum, by default 90.", + "default": "", + "optional": false } ] }, @@ -28011,470 +39277,592 @@ "OBBject": [ { "name": "results", - "type": "List[CikMap]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['sec']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "type": "List[Data]", + "description": "The calculated data." } ] }, - "data": { - "standard": [ - { - "name": "cik", - "type": "Union[int, str]", - "description": "Central Index Key (CIK) for the requested entity.", - "default": null, - "optional": true - } - ], - "sec": [] - }, - "model": "CikMap" + "data": {}, + "model": "" }, - "/regulators/sec/institutions_search": { + "/technical/ad": { "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", + "description": "Calculate the Accumulation/Distribution Line.\n\n Similar to the On Balance Volume (OBV).\n Sums the volume times +1/-1 based on whether the close is higher than the previous\n close. The Accumulation/Distribution indicator, however multiplies the volume by the\n close location value (CLV). The CLV is based on the movement of the issue within a\n single bar and can be +1, -1 or zero.\n\n\n The Accumulation/Distribution Line is interpreted by looking for a divergence in\n the direction of the indicator relative to price. If the Accumulation/Distribution\n Line is trending upward it indicates that the price may follow. Also, if the\n Accumulation/Distribution Line becomes flat while the price is still rising (or falling)\n then it signals an impending flattening of the price.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Accumulation/Distribution Line.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nad_data = obb.technical.ad(data=stock_data.results, offset=0)\nobb.technical.ad(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", "parameters": { "standard": [ { - "name": "query", - "type": "str", - "description": "Search query.", + "name": "data", + "type": "List[Data]", + "description": "List of data to be used for the calculation.", "default": "", - "optional": true + "optional": false }, { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache.", - "default": true, - "optional": true + "name": "index", + "type": "str, optional", + "description": "Index column name to use with `data`, by default \"date\".", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Literal['sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", - "default": "sec", - "optional": true + "name": "offset", + "type": "int, optional", + "description": "Offset of the AD, by default 0.", + "default": "", + "optional": false } - ], - "sec": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[InstitutionsSearch]", - "description": "Serializable results." + "type": "List[Data]", + "description": "The calculated data." + } + ] + }, + "data": {}, + "model": "" + }, + "/technical/adx": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Average Directional Index (ADX).\n\n The ADX is a Welles Wilder style moving average of the Directional Movement Index (DX).\n The values range from 0 to 100, but rarely get above 60. To interpret the ADX, consider\n a high number to be a strong trend, and a low number, a weak trend.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Average Directional Index (ADX).\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nadx_data = obb.technical.adx(data=stock_data.results, length=50, scalar=100.0, drift=1)\nobb.technical.adx(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "List[Data]", + "description": "List of data to be used for the calculation.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Optional[Literal['sec']]", - "description": "Provider name." + "name": "index", + "type": "str, optional", + "description": "Index column name to use with `data`, by default \"date\".", + "default": "", + "optional": false }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "length", + "type": "int, optional", + "description": "Number of periods for the ADX, by default 50.", + "default": "", + "optional": false }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "scalar", + "type": "float, optional", + "description": "Scalar value for the ADX, by default 100.0.", + "default": "", + "optional": false }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "drift", + "type": "int, optional", + "description": "Drift value for the ADX, by default 1.", + "default": "", + "optional": false } ] }, - "data": { - "standard": [], - "sec": [ - { - "name": "name", - "type": "str", - "description": "The name of the institution.", - "default": null, - "optional": true - }, + "returns": { + "OBBject": [ { - "name": "cik", - "type": "Union[int, str]", - "description": "Central Index Key (CIK)", - "default": null, - "optional": true + "name": "results", + "type": "List[Data]", + "description": "The calculated data." } ] }, - "model": "InstitutionsSearch" + "data": {}, + "model": "" }, - "/regulators/sec/schema_files": { + "/technical/wma": { "deprecated": { "flag": null, "message": null }, - "description": "Use tool for navigating the directory of SEC XML schema files by year.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.schema_files(provider='sec')\n# Get a list of schema files.\ndata = obb.regulators.sec.schema_files().results\ndata.files[0]\n'https://xbrl.fasb.org/us-gaap/'\n# The directory structure can be navigated by constructing a URL from the 'results' list.\nurl = data.files[0]+data.files[-1]\n# The URL base will always be the 0 position in the list, feed the URL back in as a parameter.\nobb.regulators.sec.schema_files(url=url).results.files\n['https://xbrl.fasb.org/us-gaap/2024/'\n'USGAAP2024FileList.xml'\n'dis/'\n'dqcrules/'\n'ebp/'\n'elts/'\n'entire/'\n'meta/'\n'stm/'\n'us-gaap-2024.zip']\n```\n\n", + "description": "Calculate the Weighted Moving Average (WMA).\n\n A Weighted Moving Average puts more weight on recent data and less on past data.\n This is done by multiplying each bar's price by a weighting factor. Because of its\n unique calculation, WMA will follow prices more closely than a corresponding Simple\n Moving Average.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Average True Range (ATR).\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nwma_data = obb.technical.wma(data=stock_data.results, target='close', length=50, offset=0)\nobb.technical.wma(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", "parameters": { "standard": [ { - "name": "query", - "type": "str", - "description": "Search query.", + "name": "data", + "type": "List[Data]", + "description": "The data to use for the calculation.", "default": "", - "optional": true - }, - { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache.", - "default": true, - "optional": true + "optional": false }, { - "name": "provider", - "type": "Literal['sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", - "default": "sec", - "optional": true - } - ], - "sec": [ - { - "name": "url", + "name": "target", "type": "str", - "description": "Enter an optional URL path to fetch the next level.", - "default": null, - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[SchemaFiles]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['sec']]", - "description": "Provider name." + "description": "Target column name.", + "default": "", + "optional": false }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "index", + "type": "str, optional", + "description": "Index column name to use with `data`, by default \"date\".", + "default": "", + "optional": false }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "length", + "type": "int, optional", + "description": "The length of the WMA, by default 50.", + "default": "", + "optional": false }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "offset", + "type": "int, optional", + "description": "The offset of the WMA, by default 0.", + "default": "", + "optional": false } ] }, - "data": { - "standard": [], - "sec": [ + "returns": { + "OBBject": [ { - "name": "files", - "type": "List[str]", - "description": "Dictionary of URLs to SEC Schema Files", - "default": "", - "optional": false + "name": "results", + "type": "List[Data]", + "description": "The WMA data." } ] }, - "model": "SchemaFiles" + "data": {}, + "model": "" }, - "/regulators/sec/symbol_map": { + "/technical/cci": { "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", + "description": "Calculate the Commodity Channel Index (CCI).\n\n The CCI is designed to detect beginning and ending market trends.\n The range of 100 to -100 is the normal trading range. CCI values outside of this\n range indicate overbought or oversold conditions. You can also look for price\n divergence in the CCI. If the price is making new highs, and the CCI is not,\n then a price correction is likely.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Commodity Channel Index (CCI).\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\ncci_data = obb.technical.cci(data=stock_data.results, length=14, scalar=0.015)\nobb.technical.cci(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", "parameters": { "standard": [ { - "name": "query", - "type": "str", - "description": "Search query.", + "name": "data", + "type": "List[Data]", + "description": "The data to use for the CCI calculation.", "default": "", "optional": false }, { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache. If True, cache will store for seven days.", - "default": true, - "optional": true + "name": "index", + "type": "str, optional", + "description": "Index column name to use with `data`, by default \"date\".", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Literal['sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", - "default": "sec", - "optional": true + "name": "length", + "type": "PositiveInt, optional", + "description": "The length of the CCI, by default 14.", + "default": "", + "optional": false + }, + { + "name": "scalar", + "type": "PositiveFloat, optional", + "description": "The scalar of the CCI, by default 0.015.", + "default": "", + "optional": false } - ], - "sec": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[SymbolMap]", - "description": "Serializable results." + "type": "List[Data]", + "description": "The CCI data." + } + ] + }, + "data": {}, + "model": "" + }, + "/technical/rsi": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Relative Strength Index (RSI).\n\n RSI calculates a ratio of the recent upward price movements to the absolute price\n movement. The RSI ranges from 0 to 100.\n The RSI is interpreted as an overbought/oversold indicator when\n the value is over 70/below 30. You can also look for divergence with price. If\n the price is making new highs/lows, and the RSI is not, it indicates a reversal.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Relative Strength Index (RSI).\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nrsi_data = obb.technical.rsi(data=stock_data.results, target='close', length=14, scalar=100.0, drift=1)\nobb.technical.rsi(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "List[Data]", + "description": "The data to use for the RSI calculation.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Optional[Literal['sec']]", - "description": "Provider name." + "name": "target", + "type": "str", + "description": "Target column name.", + "default": "", + "optional": false }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "index", + "type": "str, optional", + "description": "Index column name to use with `data`, by default \"date\"", + "default": "", + "optional": false }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "length", + "type": "int, optional", + "description": "The length of the RSI, by default 14", + "default": "", + "optional": false }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "scalar", + "type": "float, optional", + "description": "The scalar to use for the RSI, by default 100.0", + "default": "", + "optional": false + }, + { + "name": "drift", + "type": "int, optional", + "description": "The drift to use for the RSI, by default 1", + "default": "", + "optional": false } ] }, - "data": { - "standard": [], - "sec": [ + "returns": { + "OBBject": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "results", + "type": "List[Data]", + "description": "The RSI data." } ] }, - "model": "SymbolMap" + "data": {}, + "model": "" }, - "/regulators/sec/rss_litigation": { + "/technical/stoch": { "deprecated": { "flag": null, "message": null }, - "description": "Get the RSS feed that provides links to litigation releases concerning civil lawsuits brought by the Commission in federal court.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.rss_litigation(provider='sec')\n```\n\n", + "description": "Calculate the Stochastic Oscillator.\n\n The Stochastic Oscillator measures where the close is in relation\n to the recent trading range. The values range from zero to 100. %D values over 75\n indicate an overbought condition; values under 25 indicate an oversold condition.\n When the Fast %D crosses above the Slow %D, it is a buy signal; when it crosses\n below, it is a sell signal. The Raw %K is generally considered too erratic to use\n for crossover signals.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Stochastic Oscillator.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nstoch_data = obb.technical.stoch(data=stock_data.results, fast_k_period=14, slow_d_period=3, slow_k_period=3)\n```\n\n", "parameters": { "standard": [ { - "name": "provider", - "type": "Literal['sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", - "default": "sec", - "optional": true - } - ], - "sec": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[RssLitigation]", - "description": "Serializable results." + "name": "data", + "type": "List[Data]", + "description": "The data to use for the Stochastic Oscillator calculation.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Optional[Literal['sec']]", - "description": "Provider name." + "name": "index", + "type": "str, optional", + "description": "Index column name to use with `data`, by default \"date\".", + "default": "", + "optional": false }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "fast_k_period", + "type": "NonNegativeInt, optional", + "description": "The fast %K period, by default 14.", + "default": "", + "optional": false }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "slow_d_period", + "type": "NonNegativeInt, optional", + "description": "The slow %D period, by default 3.", + "default": "", + "optional": false }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "slow_k_period", + "type": "NonNegativeInt, optional", + "description": "The slow %K period, by default 3.", + "default": "", + "optional": false } ] }, - "data": { - "standard": [], - "sec": [ + "returns": { + "OBBject": [ { - "name": "published", - "type": "datetime", - "description": "The date of publication.", + "name": "results", + "type": "List[Data]", + "description": "The Stochastic Oscillator data." + } + ] + }, + "data": {}, + "model": "" + }, + "/technical/kc": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Keltner Channels.\n\n Keltner Channels are volatility-based bands that are placed\n on either side of an asset's price and can aid in determining\n the direction of a trend.The Keltner channel uses the average\n true range (ATR) or volatility, with breaks above or below the top\n and bottom barriers signaling a continuation.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Keltner Channels.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nkc_data = obb.technical.kc(data=stock_data.results, length=20, scalar=20, mamode='ema', offset=0)\nobb.technical.kc(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "List[Data]", + "description": "The data to use for the Keltner Channels calculation.", "default": "", "optional": false }, { - "name": "title", - "type": "str", - "description": "The title of the release.", + "name": "index", + "type": "str, optional", + "description": "Index column name to use with `data`, by default \"date\"", "default": "", "optional": false }, { - "name": "summary", - "type": "str", - "description": "Short summary of the release.", + "name": "length", + "type": "PositiveInt, optional", + "description": "The length of the Keltner Channels, by default 20", "default": "", "optional": false }, { - "name": "id", - "type": "str", - "description": "The identifier associated with the release.", + "name": "scalar", + "type": "PositiveFloat, optional", + "description": "The scalar to use for the Keltner Channels, by default 20", "default": "", "optional": false }, { - "name": "link", - "type": "str", - "description": "URL to the release.", + "name": "mamode", + "type": "Literal[\"ema\", \"sma\", \"wma\", \"hma\", \"zlma\"], optional", + "description": "The moving average mode to use for the Keltner Channels, by default \"ema\"", + "default": "", + "optional": false + }, + { + "name": "offset", + "type": "NonNegativeInt, optional", + "description": "The offset to use for the Keltner Channels, by default 0", "default": "", "optional": false } ] }, - "model": "RssLitigation" + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[Data]", + "description": "The Keltner Channels data." + } + ] + }, + "data": {}, + "model": "" }, - "/regulators/sec/sic_search": { + "/technical/cg": { "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", + "description": "Calculate the Center of Gravity.\n\n The Center of Gravity indicator, in short, is used to anticipate future price movements\n and to trade on price reversals as soon as they happen. However, just like other oscillators,\n the COG indicator returns the best results in range-bound markets and should be avoided when\n the price is trending. Traders who use it will be able to closely speculate the upcoming\n price change of the asset.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Center of Gravity (CG).\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\ncg_data = obb.technical.cg(data=stock_data.results, length=14)\nobb.technical.cg(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", "parameters": { "standard": [ { - "name": "query", - "type": "str", - "description": "Search query.", + "name": "data", + "type": "List[Data]", + "description": "The data to use for the COG calculation.", "default": "", - "optional": true + "optional": false }, { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache.", - "default": true, - "optional": true + "name": "index", + "type": "str, optional", + "description": "Index column name to use with `data`, by default \"date\"", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Literal['sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", - "default": "sec", - "optional": true + "name": "length", + "type": "PositiveInt, optional", + "description": "The length of the COG, by default 14", + "default": "", + "optional": false } - ], - "sec": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[SicSearch]", - "description": "Serializable results." + "type": "List[Data]", + "description": "The COG data." + } + ] + }, + "data": {}, + "model": "" + }, + "/technical/cones": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the realized volatility quantiles over rolling windows of time.\n\n The cones indicator is designed to map out the ebb and flow of price movements through a detailed analysis of\n volatility quantiles. By examining the range of volatility within specific time frames, it offers a nuanced view of\n market behavior, highlighting periods of stability and turbulence.\n\n The model for calculating volatility is selectable and can be one of the following:\n - Standard deviation\n - Parkinson\n - Garman-Klass\n - Hodges-Tompkins\n - Rogers-Satchell\n - Yang-Zhang\n\n Read more about it in the model parameter description.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Realized Volatility Cones.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='yfinance')\ncones_data = obb.technical.cones(data=stock_data.results, lower_q=0.25, upper_q=0.75, model='std')\nobb.technical.cones(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "List[Data]", + "description": "The data to use for the calculation.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Optional[Literal['sec']]", - "description": "Provider name." + "name": "index", + "type": "str, optional", + "description": "Index column name to use with `data`, by default \"date\"", + "default": "", + "optional": false }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "lower_q", + "type": "float, optional", + "description": "The lower quantile value for calculations", + "default": "", + "optional": false }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "upper_q", + "type": "float, optional", + "description": "The upper quantile value for calculations", + "default": "", + "optional": false }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "model", + "type": "Literal[\"std\", \"parkinson\", \"garman_klass\", \"hodges_tompkins\", \"rogers_satchell\", \"yang_zhang\"], optional", + "description": "The model used to calculate realized volatility", + "default": "", + "optional": false + }, + { + "name": "is_crypto", + "type": "bool, optional", + "description": "Whether the data is crypto or not. If True, volatility is calculated for 365 days instead of 252", + "default": "", + "optional": false + }, + { + "name": "trading_periods", + "type": "Optional[int] [default: 252]", + "description": "Number of trading periods in a year.", + "default": "", + "optional": true } ] }, - "data": { - "standard": [], - "sec": [ + "returns": { + "OBBject": [ { - "name": "sic", - "type": "int", - "description": "Sector Industrial Code (SIC)", + "name": "results", + "type": "List[Data]", + "description": "The cones data." + } + ] + }, + "data": {}, + "model": "" + }, + "/technical/ema": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Exponential Moving Average (EMA).\n\n EMA is a cumulative calculation, including all data. Past values have\n a diminishing contribution to the average, while more recent values have a greater\n contribution. This method allows the moving average to be more responsive to changes\n in the data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Exponential Moving Average (EMA).\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nema_data = obb.technical.ema(data=stock_data.results, target='close', length=50, offset=0)\nobb.technical.ema(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "List[Data]", + "description": "The data to use for the calculation.", "default": "", "optional": false }, { - "name": "industry", + "name": "target", "type": "str", - "description": "Industry title.", + "description": "Target column name.", "default": "", "optional": false }, { - "name": "office", - "type": "str", - "description": "Reporting office within the Corporate Finance Office", + "name": "index", + "type": "str, optional", + "description": "Index column name to use with `data`, by default \"date\"", + "default": "", + "optional": false + }, + { + "name": "length", + "type": "int, optional", + "description": "The length of the calculation, by default 50.", + "default": "", + "optional": false + }, + { + "name": "offset", + "type": "int, optional", + "description": "The offset of the calculation, by default 0.", "default": "", "optional": false } ] }, - "model": "SicSearch" + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[Data]", + "description": "The calculated data." + } + ] + }, + "data": {}, + "model": "" } }, "routers": { + "/commodity": { + "description": "Commodity market data." + }, "/crypto": { "description": "Cryptocurrency market data." }, @@ -28484,6 +39872,9 @@ "/derivatives": { "description": "Derivatives market data." }, + "/econometrics": { + "description": "Econometrics analysis tools." + }, "/economy": { "description": "Economic data." }, @@ -28502,8 +39893,14 @@ "/news": { "description": "Financial market news data." }, + "/quantitative": { + "description": "Quantitative analysis tools." + }, "/regulators": { "description": "Financial market regulators data." + }, + "/technical": { + "description": "Technical Analysis tools." } } } \ No newline at end of file diff --git a/openbb_platform/openbb/package/__extensions__.py b/openbb_platform/openbb/package/__extensions__.py index 2003677632f4..ccb109554be4 100644 --- a/openbb_platform/openbb/package/__extensions__.py +++ b/openbb_platform/openbb/package/__extensions__.py @@ -8,47 +8,74 @@ class Extensions(Container): # fmt: off """ Routers: + /commodity /crypto /currency /derivatives + /econometrics /economy /equity /etf /fixedincome /index /news + /quantitative /regulators + /technical Extensions: - commodity@1.0.4 - crypto@1.1.5 - currency@1.1.5 - derivatives@1.1.5 + - econometrics@1.1.5 - economy@1.1.5 - equity@1.1.5 - etf@1.1.5 - fixedincome@1.1.5 - index@1.1.5 - news@1.1.5 + - quantitative@1.1.5 - regulators@1.1.5 + - technical@1.1.6 + - alpha_vantage@1.1.5 - benzinga@1.1.5 + - biztoc@1.1.5 + - cboe@1.1.5 + - ecb@1.1.5 - econdb@1.0.0 - federal_reserve@1.1.5 + - finra@1.1.5 + - finviz@1.0.4 - fmp@1.1.5 - fred@1.1.5 + - government_us@1.1.5 - intrinio@1.1.5 + - nasdaq@1.1.6 - oecd@1.1.5 - polygon@1.1.5 - sec@1.1.5 + - seeking_alpha@1.1.5 + - stockgrid@1.1.5 - tiingo@1.1.5 + - tmx@1.0.2 + - tradier@1.0.2 - tradingeconomics@1.1.5 + - wsj@1.1.5 - yfinance@1.1.5 """ # fmt: on def __repr__(self) -> str: return self.__doc__ or "" + @property + def commodity(self): + # pylint: disable=import-outside-toplevel + from . import commodity + + return commodity.ROUTER_commodity(command_runner=self._command_runner) + @property def crypto(self): # pylint: disable=import-outside-toplevel @@ -70,6 +97,13 @@ def derivatives(self): return derivatives.ROUTER_derivatives(command_runner=self._command_runner) + @property + def econometrics(self): + # pylint: disable=import-outside-toplevel + from . import econometrics + + return econometrics.ROUTER_econometrics(command_runner=self._command_runner) + @property def economy(self): # pylint: disable=import-outside-toplevel @@ -112,9 +146,23 @@ def news(self): return news.ROUTER_news(command_runner=self._command_runner) + @property + def quantitative(self): + # pylint: disable=import-outside-toplevel + from . import quantitative + + return quantitative.ROUTER_quantitative(command_runner=self._command_runner) + @property def regulators(self): # pylint: disable=import-outside-toplevel from . import regulators return regulators.ROUTER_regulators(command_runner=self._command_runner) + + @property + def technical(self): + # pylint: disable=import-outside-toplevel + from . import technical + + return technical.ROUTER_technical(command_runner=self._command_runner) diff --git a/openbb_platform/openbb/package/crypto_price.py b/openbb_platform/openbb/package/crypto_price.py index bbd332f8d18b..9fa196fd3f8f 100644 --- a/openbb_platform/openbb/package/crypto_price.py +++ b/openbb_platform/openbb/package/crypto_price.py @@ -37,6 +37,12 @@ def historical( Union[datetime.date, None, str], OpenBBField(description="End date of the data, in YYYY-MM-DD format."), ] = None, + chart: Annotated[ + bool, + OpenBBField( + description="Whether to create a chart or not, by default False." + ), + ] = False, provider: Annotated[ Optional[Literal["fmp", "polygon", "tiingo", "yfinance"]], OpenBBField( @@ -55,6 +61,8 @@ def historical( Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] End date of the data, in YYYY-MM-DD format. + chart : bool + Whether to create a chart or not, by default False. provider : Optional[Literal['fmp', 'polygon', 'tiingo', 'yfinance']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is @@ -135,6 +143,7 @@ def historical( "end_date": end_date, }, extra_params=kwargs, + chart=chart, info={ "symbol": { "fmp": {"multiple_items_allowed": True}, diff --git a/openbb_platform/openbb/package/currency.py b/openbb_platform/openbb/package/currency.py index ba7d31d21cb9..fa8d1e8e9030 100644 --- a/openbb_platform/openbb/package/currency.py +++ b/openbb_platform/openbb/package/currency.py @@ -13,6 +13,7 @@ class ROUTER_currency(Container): """/currency /price + reference_rates search snapshots """ @@ -27,6 +28,138 @@ def price(self): return currency_price.ROUTER_currency_price(command_runner=self._command_runner) + @exception_handler + @validate + def reference_rates( + self, + provider: Annotated[ + Optional[Literal["ecb"]], + OpenBBField( + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'ecb' if there is\n no default." + ), + ] = None, + **kwargs + ) -> OBBject: + """Get current, official, currency reference rates. + + Foreign exchange reference rates are the exchange rates set by a major financial institution or regulatory body, + serving as a benchmark for the value of currencies around the world. + These rates are used as a standard to facilitate international trade and financial transactions, + ensuring consistency and reliability in currency conversion. + They are typically updated on a daily basis and reflect the market conditions at a specific time. + Central banks and financial institutions often use these rates to guide their own exchange rates, + impacting global trade, loans, and investments. + + + Parameters + ---------- + provider : Optional[Literal['ecb']] + The provider to use for the query, by default None. + If None, the provider specified in defaults is selected or 'ecb' if there is + no default. + + Returns + ------- + OBBject + results : CurrencyReferenceRates + Serializable results. + provider : Optional[Literal['ecb']] + Provider name. + warnings : Optional[List[Warning_]] + List of warnings. + chart : Optional[Chart] + Chart object. + extra : Dict[str, Any] + Extra info. + + CurrencyReferenceRates + ---------------------- + date : date + The date of the data. + EUR : Optional[float] + Euro. + USD : Optional[float] + US Dollar. + JPY : Optional[float] + Japanese Yen. + BGN : Optional[float] + Bulgarian Lev. + CZK : Optional[float] + Czech Koruna. + DKK : Optional[float] + Danish Krone. + GBP : Optional[float] + Pound Sterling. + HUF : Optional[float] + Hungarian Forint. + PLN : Optional[float] + Polish Zloty. + RON : Optional[float] + Romanian Leu. + SEK : Optional[float] + Swedish Krona. + CHF : Optional[float] + Swiss Franc. + ISK : Optional[float] + Icelandic Krona. + NOK : Optional[float] + Norwegian Krone. + TRY : Optional[float] + Turkish Lira. + AUD : Optional[float] + Australian Dollar. + BRL : Optional[float] + Brazilian Real. + CAD : Optional[float] + Canadian Dollar. + CNY : Optional[float] + Chinese Yuan. + HKD : Optional[float] + Hong Kong Dollar. + IDR : Optional[float] + Indonesian Rupiah. + ILS : Optional[float] + Israeli Shekel. + INR : Optional[float] + Indian Rupee. + KRW : Optional[float] + South Korean Won. + MXN : Optional[float] + Mexican Peso. + MYR : Optional[float] + Malaysian Ringgit. + NZD : Optional[float] + New Zealand Dollar. + PHP : Optional[float] + Philippine Peso. + SGD : Optional[float] + Singapore Dollar. + THB : Optional[float] + Thai Baht. + ZAR : Optional[float] + South African Rand. + + Examples + -------- + >>> from openbb import obb + >>> obb.currency.reference_rates(provider='ecb') + """ # noqa: E501 + + return self._run( + "/currency/reference_rates", + **filter_inputs( + provider_choices={ + "provider": self._get_provider( + provider, + "/currency/reference_rates", + ("ecb",), + ) + }, + standard_params={}, + extra_params=kwargs, + ) + ) + @exception_handler @validate def search( @@ -152,7 +285,7 @@ def snapshots( ), ] = "indirect", counter_currencies: Annotated[ - Union[List[str], str, None], + Union[str, List[str], None], OpenBBField( description="An optional list of counter currency symbols to filter for. None returns all." ), @@ -173,7 +306,7 @@ def snapshots( The base currency symbol. Multiple comma separated items allowed for provider(s): fmp, polygon. quote_type : Literal['direct', 'indirect'] 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. - counter_currencies : Union[List[str], str, None] + counter_currencies : Union[str, List[str], None] An optional list of counter currency symbols to filter for. None returns all. provider : Optional[Literal['fmp', 'polygon']] The provider to use for the query, by default None. diff --git a/openbb_platform/openbb/package/currency_price.py b/openbb_platform/openbb/package/currency_price.py index 251e422f05d8..2cea262c7c56 100644 --- a/openbb_platform/openbb/package/currency_price.py +++ b/openbb_platform/openbb/package/currency_price.py @@ -37,6 +37,12 @@ def historical( Union[datetime.date, None, str], OpenBBField(description="End date of the data, in YYYY-MM-DD format."), ] = None, + chart: Annotated[ + bool, + OpenBBField( + description="Whether to create a chart or not, by default False." + ), + ] = False, provider: Annotated[ Optional[Literal["fmp", "polygon", "tiingo", "yfinance"]], OpenBBField( @@ -62,6 +68,8 @@ def historical( Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] End date of the data, in YYYY-MM-DD format. + chart : bool + Whether to create a chart or not, by default False. provider : Optional[Literal['fmp', 'polygon', 'tiingo', 'yfinance']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is @@ -138,6 +146,7 @@ def historical( "end_date": end_date, }, extra_params=kwargs, + chart=chart, info={ "symbol": { "fmp": {"multiple_items_allowed": True}, diff --git a/openbb_platform/openbb/package/derivatives_options.py b/openbb_platform/openbb/package/derivatives_options.py index 4490181503de..ec17a1bcac45 100644 --- a/openbb_platform/openbb/package/derivatives_options.py +++ b/openbb_platform/openbb/package/derivatives_options.py @@ -25,9 +25,9 @@ def chains( self, symbol: Annotated[str, OpenBBField(description="Symbol to get data for.")], provider: Annotated[ - Optional[Literal["intrinio"]], + Optional[Literal["cboe", "intrinio", "tmx", "tradier"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'intrinio' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'cboe' if there is\n no default." ), ] = None, **kwargs @@ -38,19 +38,23 @@ def chains( ---------- symbol : str Symbol to get data for. - provider : Optional[Literal['intrinio']] + provider : Optional[Literal['cboe', 'intrinio', 'tmx', 'tradier']] The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'intrinio' if there is + If None, the provider specified in defaults is selected or 'cboe' if there is no default. + use_cache : bool + When True, the company directories will be cached for24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. (provider: cboe); + Caching is used to validate the supplied ticker symbol, or if a historical EOD chain is requested. To bypass, set to False. (provider: tmx) date : Optional[datetime.date] - The end-of-day date for options chains data. (provider: intrinio) + The end-of-day date for options chains data. (provider: intrinio); + A specific date to get data for. (provider: tmx) Returns ------- OBBject results : List[OptionsChains] Serializable results. - provider : Optional[Literal['intrinio']] + provider : Optional[Literal['cboe', 'intrinio', 'tmx', 'tradier']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -147,8 +151,48 @@ def chains( Vega of the option. rho : Optional[float] Rho of the option. + last_trade_timestamp : Optional[datetime] + Last trade timestamp of the option. (provider: cboe); + Timestamp of the last trade. (provider: tradier) + dte : Optional[int] + Days to expiration for the option. (provider: cboe, tmx); + Days to expiration. (provider: tradier) exercise_style : Optional[str] The exercise style of the option, American or European. (provider: intrinio) + transactions : Optional[int] + Number of transactions for the contract. (provider: tmx) + total_value : Optional[float] + Total value of the transactions. (provider: tmx) + settlement_price : Optional[float] + Settlement price on that date. (provider: tmx) + underlying_price : Optional[float] + Price of the underlying stock on that date. (provider: tmx) + phi : Optional[float] + Phi of the option. The sensitivity of the option relative to dividend yield. (provider: tradier) + bid_iv : Optional[float] + Implied volatility of the bid price. (provider: tradier) + ask_iv : Optional[float] + Implied volatility of the ask price. (provider: tradier) + orats_final_iv : Optional[float] + ORATS final implied volatility of the option, updated once per hour. (provider: tradier) + year_high : Optional[float] + 52-week high price of the option. (provider: tradier) + year_low : Optional[float] + 52-week low price of the option. (provider: tradier) + last_trade_volume : Optional[int] + Volume of the last trade. (provider: tradier) + contract_size : Optional[int] + Size of the contract. (provider: tradier) + bid_exchange : Optional[str] + Exchange of the bid price. (provider: tradier) + bid_timestamp : Optional[datetime] + Timestamp of the bid price. (provider: tradier) + ask_exchange : Optional[str] + Exchange of the ask price. (provider: tradier) + ask_timestamp : Optional[datetime] + Timestamp of the ask price. (provider: tradier) + greeks_timestamp : Optional[datetime] + Timestamp of the last greeks update. Greeks/IV data is updated once per hour. (provider: tradier) Examples -------- @@ -165,7 +209,7 @@ def chains( "provider": self._get_provider( provider, "/derivatives/options/chains", - ("intrinio",), + ("cboe", "intrinio", "tmx", "tradier"), ) }, standard_params={ diff --git a/openbb_platform/openbb/package/economy.py b/openbb_platform/openbb/package/economy.py index dca7a2a489c4..b7417f1be26c 100644 --- a/openbb_platform/openbb/package/economy.py +++ b/openbb_platform/openbb/package/economy.py @@ -14,6 +14,7 @@ class ROUTER_economy(Container): """/economy available_indicators + balance_of_payments calendar composite_leading_indicator country_profile @@ -122,6 +123,290 @@ def available_indicators( ) ) + @exception_handler + @validate + def balance_of_payments( + self, + provider: Annotated[ + Optional[Literal["ecb"]], + OpenBBField( + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'ecb' if there is\n no default." + ), + ] = None, + **kwargs + ) -> OBBject: + """Balance of Payments Reports. + + Parameters + ---------- + provider : Optional[Literal['ecb']] + The provider to use for the query, by default None. + If None, the provider specified in defaults is selected or 'ecb' if there is + no default. + report_type : Literal['main', 'summary', 'services', 'investment_income', 'direct_investment', 'portfolio_investment', 'other_investment'] + The report type, the level of detail in the data. (provider: ecb) + frequency : Literal['monthly', 'quarterly'] + The frequency of the data. Monthly is valid only for ['main', 'summary']. (provider: ecb) + country : Literal['brazil', 'canada', 'china', 'eu_ex_euro_area', 'eu_institutions', 'india', 'japan', 'russia', 'switzerland', 'united_kingdom', 'united_states', 'total', None] + The country/region of the data. This parameter will override the 'report_type' parameter. (provider: ecb) + + Returns + ------- + OBBject + results : List[BalanceOfPayments] + Serializable results. + provider : Optional[Literal['ecb']] + Provider name. + warnings : Optional[List[Warning_]] + List of warnings. + chart : Optional[Chart] + Chart object. + extra : Dict[str, Any] + Extra info. + + BalanceOfPayments + ----------------- + period : Optional[date] + The date representing the beginning of the reporting period. + current_account : Optional[float] + Current Account Balance (Billions of EUR) + goods : Optional[float] + Goods Balance (Billions of EUR) + services : Optional[float] + Services Balance (Billions of EUR) + primary_income : Optional[float] + Primary Income Balance (Billions of EUR) + secondary_income : Optional[float] + Secondary Income Balance (Billions of EUR) + capital_account : Optional[float] + Capital Account Balance (Billions of EUR) + net_lending_to_rest_of_world : Optional[float] + Balance of net lending to the rest of the world (Billions of EUR) + financial_account : Optional[float] + Financial Account Balance (Billions of EUR) + direct_investment : Optional[float] + Direct Investment Balance (Billions of EUR) + portfolio_investment : Optional[float] + Portfolio Investment Balance (Billions of EUR) + financial_derivatives : Optional[float] + Financial Derivatives Balance (Billions of EUR) + other_investment : Optional[float] + Other Investment Balance (Billions of EUR) + reserve_assets : Optional[float] + Reserve Assets Balance (Billions of EUR) + errors_and_ommissions : Optional[float] + Errors and Omissions (Billions of EUR) + current_account_credit : Optional[float] + Current Account Credits (Billions of EUR) + current_account_debit : Optional[float] + Current Account Debits (Billions of EUR) + current_account_balance : Optional[float] + Current Account Balance (Billions of EUR) + goods_credit : Optional[float] + Goods Credits (Billions of EUR) + goods_debit : Optional[float] + Goods Debits (Billions of EUR) + services_credit : Optional[float] + Services Credits (Billions of EUR) + services_debit : Optional[float] + Services Debits (Billions of EUR) + primary_income_credit : Optional[float] + Primary Income Credits (Billions of EUR) + primary_income_employee_compensation_credit : Optional[float] + Primary Income Employee Compensation Credit (Billions of EUR) + primary_income_debit : Optional[float] + Primary Income Debits (Billions of EUR) + primary_income_employee_compensation_debit : Optional[float] + Primary Income Employee Compensation Debit (Billions of EUR) + secondary_income_credit : Optional[float] + Secondary Income Credits (Billions of EUR) + secondary_income_debit : Optional[float] + Secondary Income Debits (Billions of EUR) + capital_account_credit : Optional[float] + Capital Account Credits (Billions of EUR) + capital_account_debit : Optional[float] + Capital Account Debits (Billions of EUR) + services_total_credit : Optional[float] + Services Total Credit (Billions of EUR) + services_total_debit : Optional[float] + Services Total Debit (Billions of EUR) + transport_credit : Optional[float] + Transport Credit (Billions of EUR) + transport_debit : Optional[float] + Transport Debit (Billions of EUR) + travel_credit : Optional[float] + Travel Credit (Billions of EUR) + travel_debit : Optional[float] + Travel Debit (Billions of EUR) + financial_services_credit : Optional[float] + Financial Services Credit (Billions of EUR) + financial_services_debit : Optional[float] + Financial Services Debit (Billions of EUR) + communications_credit : Optional[float] + Communications Credit (Billions of EUR) + communications_debit : Optional[float] + Communications Debit (Billions of EUR) + other_business_services_credit : Optional[float] + Other Business Services Credit (Billions of EUR) + other_business_services_debit : Optional[float] + Other Business Services Debit (Billions of EUR) + other_services_credit : Optional[float] + Other Services Credit (Billions of EUR) + other_services_debit : Optional[float] + Other Services Debit (Billions of EUR) + investment_total_credit : Optional[float] + Investment Total Credit (Billions of EUR) + investment_total_debit : Optional[float] + Investment Total Debit (Billions of EUR) + equity_credit : Optional[float] + Equity Credit (Billions of EUR) + equity_reinvested_earnings_credit : Optional[float] + Equity Reinvested Earnings Credit (Billions of EUR) + equity_debit : Optional[float] + Equity Debit (Billions of EUR) + equity_reinvested_earnings_debit : Optional[float] + Equity Reinvested Earnings Debit (Billions of EUR) + debt_instruments_credit : Optional[float] + Debt Instruments Credit (Billions of EUR) + debt_instruments_debit : Optional[float] + Debt Instruments Debit (Billions of EUR) + portfolio_investment_equity_credit : Optional[float] + Portfolio Investment Equity Credit (Billions of EUR) + portfolio_investment_equity_debit : Optional[float] + Portfolio Investment Equity Debit (Billions of EUR) + portfolio_investment_debt_instruments_credit : Optional[float] + Portfolio Investment Debt Instruments Credit (Billions of EUR) + portofolio_investment_debt_instruments_debit : Optional[float] + Portfolio Investment Debt Instruments Debit (Billions of EUR) + other_investment_credit : Optional[float] + Other Investment Credit (Billions of EUR) + other_investment_debit : Optional[float] + Other Investment Debit (Billions of EUR) + reserve_assets_credit : Optional[float] + Reserve Assets Credit (Billions of EUR) + assets_total : Optional[float] + Assets Total (Billions of EUR) + assets_equity : Optional[float] + Assets Equity (Billions of EUR) + assets_debt_instruments : Optional[float] + Assets Debt Instruments (Billions of EUR) + assets_mfi : Optional[float] + Assets MFIs (Billions of EUR) + assets_non_mfi : Optional[float] + Assets Non MFIs (Billions of EUR) + assets_direct_investment_abroad : Optional[float] + Assets Direct Investment Abroad (Billions of EUR) + liabilities_total : Optional[float] + Liabilities Total (Billions of EUR) + liabilities_equity : Optional[float] + Liabilities Equity (Billions of EUR) + liabilities_debt_instruments : Optional[float] + Liabilities Debt Instruments (Billions of EUR) + liabilities_mfi : Optional[float] + Liabilities MFIs (Billions of EUR) + liabilities_non_mfi : Optional[float] + Liabilities Non MFIs (Billions of EUR) + liabilities_direct_investment_euro_area : Optional[float] + Liabilities Direct Investment in Euro Area (Billions of EUR) + assets_equity_and_fund_shares : Optional[float] + Assets Equity and Investment Fund Shares (Billions of EUR) + assets_equity_shares : Optional[float] + Assets Equity Shares (Billions of EUR) + assets_investment_fund_shares : Optional[float] + Assets Investment Fund Shares (Billions of EUR) + assets_debt_short_term : Optional[float] + Assets Debt Short Term (Billions of EUR) + assets_debt_long_term : Optional[float] + Assets Debt Long Term (Billions of EUR) + assets_resident_sector_eurosystem : Optional[float] + Assets Resident Sector Eurosystem (Billions of EUR) + assets_resident_sector_mfi_ex_eurosystem : Optional[float] + Assets Resident Sector MFIs outside Eurosystem (Billions of EUR) + assets_resident_sector_government : Optional[float] + Assets Resident Sector Government (Billions of EUR) + assets_resident_sector_other : Optional[float] + Assets Resident Sector Other (Billions of EUR) + liabilities_equity_and_fund_shares : Optional[float] + Liabilities Equity and Investment Fund Shares (Billions of EUR) + liabilities_investment_fund_shares : Optional[float] + Liabilities Investment Fund Shares (Billions of EUR) + liabilities_debt_short_term : Optional[float] + Liabilities Debt Short Term (Billions of EUR) + liabilities_debt_long_term : Optional[float] + Liabilities Debt Long Term (Billions of EUR) + liabilities_resident_sector_government : Optional[float] + Liabilities Resident Sector Government (Billions of EUR) + liabilities_resident_sector_other : Optional[float] + Liabilities Resident Sector Other (Billions of EUR) + assets_currency_and_deposits : Optional[float] + Assets Currency and Deposits (Billions of EUR) + assets_loans : Optional[float] + Assets Loans (Billions of EUR) + assets_trade_credit_and_advances : Optional[float] + Assets Trade Credits and Advances (Billions of EUR) + assets_eurosystem : Optional[float] + Assets Eurosystem (Billions of EUR) + assets_other_mfi_ex_eurosystem : Optional[float] + Assets Other MFIs outside Eurosystem (Billions of EUR) + assets_government : Optional[float] + Assets Government (Billions of EUR) + assets_other_sectors : Optional[float] + Assets Other Sectors (Billions of EUR) + liabilities_currency_and_deposits : Optional[float] + Liabilities Currency and Deposits (Billions of EUR) + liabilities_loans : Optional[float] + Liabilities Loans (Billions of EUR) + liabilities_trade_credit_and_advances : Optional[float] + Liabilities Trade Credits and Advances (Billions of EUR) + liabilities_eurosystem : Optional[float] + Liabilities Eurosystem (Billions of EUR) + liabilities_other_mfi_ex_eurosystem : Optional[float] + Liabilities Other MFIs outside Eurosystem (Billions of EUR) + liabilities_government : Optional[float] + Liabilities Government (Billions of EUR) + liabilities_other_sectors : Optional[float] + Liabilities Other Sectors (Billions of EUR) + goods_balance : Optional[float] + Goods Balance (Billions of EUR) + services_balance : Optional[float] + Services Balance (Billions of EUR) + primary_income_balance : Optional[float] + Primary Income Balance (Billions of EUR) + investment_income_balance : Optional[float] + Investment Income Balance (Billions of EUR) + investment_income_credit : Optional[float] + Investment Income Credits (Billions of EUR) + investment_income_debit : Optional[float] + Investment Income Debits (Billions of EUR) + secondary_income_balance : Optional[float] + Secondary Income Balance (Billions of EUR) + capital_account_balance : Optional[float] + Capital Account Balance (Billions of EUR) + + Examples + -------- + >>> from openbb import obb + >>> obb.economy.balance_of_payments(provider='ecb') + >>> obb.economy.balance_of_payments(report_type='summary', provider='ecb') + >>> # The `country` parameter will override the `report_type`. + >>> obb.economy.balance_of_payments(country='united_states', provider='ecb') + """ # noqa: E501 + + return self._run( + "/economy/balance_of_payments", + **filter_inputs( + provider_choices={ + "provider": self._get_provider( + provider, + "/economy/balance_of_payments", + ("ecb",), + ) + }, + standard_params={}, + extra_params=kwargs, + ) + ) + @exception_handler @validate def calendar( @@ -135,7 +420,7 @@ def calendar( OpenBBField(description="End date of the data, in YYYY-MM-DD format."), ] = None, provider: Annotated[ - Optional[Literal["fmp", "tradingeconomics"]], + Optional[Literal["fmp", "nasdaq", "tradingeconomics"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -150,12 +435,12 @@ def calendar( Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fmp', 'tradingeconomics']] + provider : Optional[Literal['fmp', 'nasdaq', 'tradingeconomics']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. country : Optional[str] - Country of the event. Multiple comma separated items allowed. (provider: tradingeconomics) + Country of the event Multiple comma separated items allowed. (provider: nasdaq, tradingeconomics) importance : Optional[Literal['Low', 'Medium', 'High']] Importance of the event. (provider: tradingeconomics) group : Optional[Literal['interest rate', 'inflation', 'bonds', 'consumer', 'gdp', 'government', 'housing', 'labour', 'markets', 'money', 'prices', 'trade', 'business']] @@ -166,7 +451,7 @@ def calendar( OBBject results : List[EconomicCalendar] Serializable results. - provider : Optional[Literal['fmp', 'tradingeconomics']] + provider : Optional[Literal['fmp', 'nasdaq', 'tradingeconomics']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -213,6 +498,8 @@ def calendar( Last updated timestamp. (provider: fmp) created_at : Optional[datetime] Created at timestamp. (provider: fmp) + description : Optional[str] + Event description. (provider: nasdaq) Examples -------- @@ -220,6 +507,8 @@ def calendar( >>> # By default, the calendar will be forward-looking. >>> obb.economy.calendar(provider='fmp') >>> obb.economy.calendar(provider='fmp', start_date='2020-03-01', end_date='2020-03-31') + >>> # By default, the calendar will be forward-looking. + >>> obb.economy.calendar(provider='nasdaq') """ # noqa: E501 return self._run( @@ -229,7 +518,7 @@ def calendar( "provider": self._get_provider( provider, "/economy/calendar", - ("fmp", "tradingeconomics"), + ("fmp", "nasdaq", "tradingeconomics"), ) }, standard_params={ @@ -238,7 +527,10 @@ def calendar( }, extra_params=kwargs, info={ - "country": {"tradingeconomics": {"multiple_items_allowed": True}} + "country": { + "nasdaq": {"multiple_items_allowed": True}, + "tradingeconomics": {"multiple_items_allowed": True}, + } }, ) ) @@ -909,6 +1201,12 @@ def fred_series( Optional[int], OpenBBField(description="The number of data entries to return."), ] = 100000, + chart: Annotated[ + bool, + OpenBBField( + description="Whether to create a chart or not, by default False." + ), + ] = False, provider: Annotated[ Optional[Literal["fred", "intrinio"]], OpenBBField( @@ -929,6 +1227,8 @@ def fred_series( End date of the data, in YYYY-MM-DD format. limit : Optional[int] The number of data entries to return. + chart : bool + Whether to create a chart or not, by default False. provider : Optional[Literal['fred', 'intrinio']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is @@ -1026,6 +1326,7 @@ def fred_series( "limit": limit, }, extra_params=kwargs, + chart=chart, info={"symbol": {"fred": {"multiple_items_allowed": True}}}, ) ) diff --git a/openbb_platform/openbb/package/equity.py b/openbb_platform/openbb/package/equity.py index c67112ac8a1c..2e9c2cbb5fc3 100644 --- a/openbb_platform/openbb/package/equity.py +++ b/openbb_platform/openbb/package/equity.py @@ -14,6 +14,7 @@ class ROUTER_equity(Container): """/equity /calendar /compare + /darkpool /discovery /estimates /fundamental @@ -45,6 +46,15 @@ def compare(self): return equity_compare.ROUTER_equity_compare(command_runner=self._command_runner) + @property + def darkpool(self): + # pylint: disable=import-outside-toplevel + from . import equity_darkpool + + return equity_darkpool.ROUTER_equity_darkpool( + command_runner=self._command_runner + ) + @property def discovery(self): # pylint: disable=import-outside-toplevel @@ -254,13 +264,13 @@ def profile( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): finviz, fmp, intrinio, tmx, yfinance." ), ], provider: Annotated[ - Optional[Literal["fmp", "intrinio", "yfinance"]], + Optional[Literal["finviz", "fmp", "intrinio", "tmx", "yfinance"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'finviz' if there is\n no default." ), ] = None, **kwargs @@ -270,10 +280,10 @@ def profile( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + Symbol to get data for. Multiple comma separated items allowed for provider(s): finviz, fmp, intrinio, tmx, yfinance. + provider : Optional[Literal['finviz', 'fmp', 'intrinio', 'tmx', 'yfinance']] The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'fmp' if there is + If None, the provider specified in defaults is selected or 'finviz' if there is no default. Returns @@ -281,7 +291,7 @@ def profile( OBBject results : List[EquityInfo] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + provider : Optional[Literal['finviz', 'fmp', 'intrinio', 'tmx', 'yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -368,6 +378,33 @@ def profile( Date of the company's first stock price. last_stock_price_date : Optional[date] Date of the company's last stock price. + index : Optional[str] + Included in indices - i.e., Dow, Nasdaq, or S&P. (provider: finviz) + optionable : Optional[str] + Whether options trade against the ticker. (provider: finviz) + shortable : Optional[str] + If the asset is shortable. (provider: finviz) + shares_outstanding : Optional[Union[str, int]] + The number of shares outstanding, as an abbreviated string. (provider: finviz); + The number of listed shares outstanding. (provider: tmx); + The number of listed shares outstanding. (provider: yfinance) + shares_float : Optional[Union[str, int]] + The number of shares in the public float, as an abbreviated string. (provider: finviz); + The number of shares in the public float. (provider: yfinance) + short_interest : Optional[str] + The last reported number of shares sold short, as an abbreviated string. (provider: finviz) + institutional_ownership : Optional[float] + The institutional ownership of the stock, as a normalized percent. (provider: finviz) + market_cap : Optional[int] + The market capitalization of the stock, as an abbreviated string. (provider: finviz); + Market capitalization of the company. (provider: fmp); + The market capitalization of the asset. (provider: yfinance) + dividend_yield : Optional[float] + The dividend yield of the stock, as a normalized percent. (provider: finviz, yfinance) + earnings_date : Optional[str] + The last, or next confirmed, earnings date and announcement time, as a string. The format is Nov 02 AMC - for after market close. (provider: finviz) + beta : Optional[float] + The beta of the stock relative to the broad market. (provider: finviz, fmp, yfinance) is_etf : Optional[bool] If the symbol is an ETF. (provider: fmp) is_actively_trading : Optional[bool] @@ -380,9 +417,6 @@ def profile( Image of the company. (provider: fmp) currency : Optional[str] Currency in which the stock is traded. (provider: fmp, yfinance) - market_cap : Optional[int] - Market capitalization of the company. (provider: fmp); - The market capitalization of the asset. (provider: yfinance) last_price : Optional[float] The last traded price. (provider: fmp) year_high : Optional[float] @@ -393,26 +427,26 @@ def profile( Average daily trading volume. (provider: fmp) annualized_dividend_amount : Optional[float] The annualized dividend payment based on the most recent regular dividend payment. (provider: fmp) - beta : Optional[float] - Beta of the stock relative to the market. (provider: fmp, yfinance) id : Optional[str] Intrinio ID for the company. (provider: intrinio) thea_enabled : Optional[bool] Whether the company has been enabled for Thea. (provider: intrinio) + email : Optional[str] + The email of the company. (provider: tmx) + issue_type : Optional[str] + The issuance type of the asset. (provider: tmx, yfinance) + shares_escrow : Optional[int] + The number of shares held in escrow. (provider: tmx) + shares_total : Optional[int] + The total number of shares outstanding from all classes. (provider: tmx) + dividend_frequency : Optional[str] + The dividend frequency. (provider: tmx) exchange_timezone : Optional[str] The timezone of the exchange. (provider: yfinance) - issue_type : Optional[str] - The issuance type of the asset. (provider: yfinance) - shares_outstanding : Optional[int] - The number of listed shares outstanding. (provider: yfinance) - shares_float : Optional[int] - The number of shares in the public float. (provider: yfinance) shares_implied_outstanding : Optional[int] Implied shares outstanding of common equityassuming the conversion of all convertible subsidiary equity into common. (provider: yfinance) shares_short : Optional[int] The reported number of shares short. (provider: yfinance) - dividend_yield : Optional[float] - The dividend yield of the asset, as a normalized percent. (provider: yfinance) Examples -------- @@ -427,7 +461,7 @@ def profile( "provider": self._get_provider( provider, "/equity/profile", - ("fmp", "intrinio", "yfinance"), + ("finviz", "fmp", "intrinio", "tmx", "yfinance"), ) }, standard_params={ @@ -436,8 +470,10 @@ def profile( extra_params=kwargs, info={ "symbol": { + "finviz": {"multiple_items_allowed": True}, "fmp": {"multiple_items_allowed": True}, "intrinio": {"multiple_items_allowed": True}, + "tmx": {"multiple_items_allowed": True}, "yfinance": {"multiple_items_allowed": True}, } }, @@ -580,9 +616,9 @@ def search( Optional[bool], OpenBBField(description="Whether to use the cache or not.") ] = True, provider: Annotated[ - Optional[Literal["intrinio", "sec"]], + Optional[Literal["cboe", "intrinio", "nasdaq", "sec", "tmx", "tradier"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'intrinio' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'cboe' if there is\n no default." ), ] = None, **kwargs @@ -597,14 +633,16 @@ def search( Whether to search by ticker symbol. use_cache : Optional[bool] Whether to use the cache or not. - provider : Optional[Literal['intrinio', 'sec']] + provider : Optional[Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tra... The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'intrinio' if there is + If None, the provider specified in defaults is selected or 'cboe' if there is no default. active : Optional[bool] 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. (provider: intrinio) limit : Optional[int] The number of data entries to return. (provider: intrinio) + is_etf : Optional[bool] + If True, returns ETFs. (provider: nasdaq) is_fund : bool Whether to direct the search to the list of mutual funds and ETFs. (provider: sec) @@ -613,7 +651,7 @@ def search( OBBject results : List[EquitySearch] Serializable results. - provider : Optional[Literal['intrinio', 'sec']] + provider : Optional[Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -628,6 +666,10 @@ def search( Symbol representing the entity requested in the data. name : Optional[str] Name of the company. + dpm_name : Optional[str] + Name of the primary market maker. (provider: cboe) + post_station : Optional[str] + Post and station location on the CBOE trading floor. (provider: cboe) cik : Optional[str] ; Central Index Key (provider: sec) @@ -635,11 +677,35 @@ def search( The Legal Entity Identifier (LEI) of the company. (provider: intrinio) intrinio_id : Optional[str] The Intrinio ID of the company. (provider: intrinio) + nasdaq_traded : Optional[str] + Is Nasdaq traded? (provider: nasdaq) + exchange : Optional[str] + Primary Exchange (provider: nasdaq); + Exchange where the security is listed. (provider: tradier) + market_category : Optional[str] + Market Category (provider: nasdaq) + etf : Optional[str] + Is ETF? (provider: nasdaq) + round_lot_size : Optional[float] + Round Lot Size (provider: nasdaq) + test_issue : Optional[str] + Is test Issue? (provider: nasdaq) + financial_status : Optional[str] + Financial Status (provider: nasdaq) + cqs_symbol : Optional[str] + CQS Symbol (provider: nasdaq) + nasdaq_symbol : Optional[str] + NASDAQ Symbol (provider: nasdaq) + next_shares : Optional[str] + Is NextShares? (provider: nasdaq) + security_type : Optional[Literal['stock', 'option', 'etf', 'index', 'mutual_fund']] + Type of security. (provider: tradier) Examples -------- >>> from openbb import obb >>> obb.equity.search(provider='intrinio') + >>> obb.equity.search(query='AAPL', is_symbol=False, use_cache=True, provider='nasdaq') """ # noqa: E501 return self._run( @@ -649,7 +715,7 @@ def search( "provider": self._get_provider( provider, "/equity/search", - ("intrinio", "sec"), + ("cboe", "intrinio", "nasdaq", "sec", "tmx", "tradier"), ) }, standard_params={ diff --git a/openbb_platform/openbb/package/equity_calendar.py b/openbb_platform/openbb/package/equity_calendar.py index 891ac9995f0a..dac5cc6ea73e 100644 --- a/openbb_platform/openbb/package/equity_calendar.py +++ b/openbb_platform/openbb/package/equity_calendar.py @@ -35,7 +35,7 @@ def dividend( OpenBBField(description="End date of the data, in YYYY-MM-DD format."), ] = None, provider: Annotated[ - Optional[Literal["fmp"]], + Optional[Literal["fmp", "nasdaq"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -50,7 +50,7 @@ def dividend( Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fmp']] + provider : Optional[Literal['fmp', 'nasdaq']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. @@ -60,7 +60,7 @@ def dividend( OBBject results : List[CalendarDividend] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[Literal['fmp', 'nasdaq']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -89,11 +89,15 @@ def dividend( The adjusted-dividend amount. (provider: fmp) label : Optional[str] Ex-dividend date formatted for display. (provider: fmp) + annualized_amount : Optional[float] + The indicated annualized dividend amount. (provider: nasdaq) Examples -------- >>> from openbb import obb >>> obb.equity.calendar.dividend(provider='fmp') + >>> # Get dividend calendar for specific dates. + >>> obb.equity.calendar.dividend(start_date='2024-02-01', end_date='2024-02-07', provider='nasdaq') """ # noqa: E501 return self._run( @@ -103,7 +107,7 @@ def dividend( "provider": self._get_provider( provider, "/equity/calendar/dividend", - ("fmp",), + ("fmp", "nasdaq"), ) }, standard_params={ @@ -127,7 +131,7 @@ def earnings( OpenBBField(description="End date of the data, in YYYY-MM-DD format."), ] = None, provider: Annotated[ - Optional[Literal["fmp"]], + Optional[Literal["fmp", "nasdaq", "tmx"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -142,7 +146,7 @@ def earnings( Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fmp']] + provider : Optional[Literal['fmp', 'nasdaq', 'tmx']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. @@ -152,7 +156,7 @@ def earnings( OBBject results : List[CalendarEarnings] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[Literal['fmp', 'nasdaq', 'tmx']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -174,17 +178,30 @@ def earnings( eps_consensus : Optional[float] The analyst conesus earnings-per-share estimate. eps_actual : Optional[float] - The actual earnings per share announced. (provider: fmp) + The actual earnings per share announced. (provider: fmp, nasdaq); + The actual EPS in dollars. (provider: tmx) revenue_actual : Optional[float] The actual reported revenue. (provider: fmp) revenue_consensus : Optional[float] The revenue forecast consensus. (provider: fmp) - period_ending : Optional[date] - The fiscal period end date. (provider: fmp) + period_ending : Optional[Union[date, str]] + The fiscal period end date. (provider: fmp, nasdaq) reporting_time : Optional[str] - The reporting time - e.g. after market close. (provider: fmp) + The reporting time - e.g. after market close. (provider: fmp, nasdaq); + The time of the report - i.e., before or after market. (provider: tmx) updated_date : Optional[date] The date the data was updated last. (provider: fmp) + surprise_percent : Optional[float] + The earnings surprise as normalized percentage points. (provider: nasdaq); + The EPS surprise as a normalized percent. (provider: tmx) + num_estimates : Optional[int] + The number of analysts providing estimates for the consensus. (provider: nasdaq) + previous_report_date : Optional[date] + The previous report date for the same period last year. (provider: nasdaq) + market_cap : Optional[int] + The market cap (USD) of the reporting entity. (provider: nasdaq) + eps_surprise : Optional[float] + The EPS surprise in dollars. (provider: tmx) Examples -------- @@ -201,7 +218,7 @@ def earnings( "provider": self._get_provider( provider, "/equity/calendar/earnings", - ("fmp",), + ("fmp", "nasdaq", "tmx"), ) }, standard_params={ @@ -232,7 +249,7 @@ def ipo( OpenBBField(description="The number of data entries to return."), ] = 100, provider: Annotated[ - Optional[Literal["intrinio"]], + Optional[Literal["intrinio", "nasdaq"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'intrinio' if there is\n no default." ), @@ -251,23 +268,26 @@ def ipo( End date of the data, in YYYY-MM-DD format. limit : Optional[int] The number of data entries to return. - provider : Optional[Literal['intrinio']] + provider : Optional[Literal['intrinio', 'nasdaq']] 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. - status : Optional[Literal['upcoming', 'priced', 'withdrawn']] - Status of the IPO. [upcoming, priced, or withdrawn] (provider: intrinio) + status : Optional[Union[Literal['upcoming', 'priced', 'withdrawn'], Literal['upcoming', 'priced', 'filed', 'withdrawn']]] + Status of the IPO. [upcoming, priced, or withdrawn] (provider: intrinio); + The status of the IPO. (provider: nasdaq) min_value : Optional[int] Return IPOs with an offer dollar amount greater than the given amount. (provider: intrinio) max_value : Optional[int] Return IPOs with an offer dollar amount less than the given amount. (provider: intrinio) + is_spo : bool + If True, returns data for secondary public offerings (SPOs). (provider: nasdaq) Returns ------- OBBject results : List[CalendarIpo] Serializable results. - provider : Optional[Literal['intrinio']] + provider : Optional[Literal['intrinio', 'nasdaq']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -287,7 +307,8 @@ def ipo( exchange : Optional[str] The acronym of the stock exchange that the company is going to trade publicly on. Typically NYSE or NASDAQ. (provider: intrinio) offer_amount : Optional[float] - The total dollar amount of shares offered in the IPO. Typically this is share price * share count (provider: intrinio) + The total dollar amount of shares offered in the IPO. Typically this is share price * share count (provider: intrinio); + The dollar value of the shares offered. (provider: nasdaq) share_price : Optional[float] The price per share at which the IPO was offered. (provider: intrinio) share_price_lowest : Optional[float] @@ -295,7 +316,7 @@ def ipo( share_price_highest : Optional[float] 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). (provider: intrinio) share_count : Optional[int] - The number of shares offered in the IPO. (provider: intrinio) + The number of shares offered in the IPO. (provider: intrinio, nasdaq) share_count_lowest : Optional[int] 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). (provider: intrinio) share_count_highest : Optional[int] @@ -322,13 +343,26 @@ def ipo( The company that is going public via the IPO. (provider: intrinio) security : Optional[IntrinioSecurity] The primary Security for the Company that is going public via the IPO (provider: intrinio) + name : Optional[str] + The name of the company. (provider: nasdaq) + expected_price_date : Optional[date] + The date the pricing is expected. (provider: nasdaq) + filed_date : Optional[date] + The date the IPO was filed. (provider: nasdaq) + withdraw_date : Optional[date] + The date the IPO was withdrawn. (provider: nasdaq) + deal_status : Optional[str] + The status of the deal. (provider: nasdaq) Examples -------- >>> from openbb import obb >>> obb.equity.calendar.ipo(provider='intrinio') + >>> obb.equity.calendar.ipo(limit=100, provider='nasdaq') >>> # Get all IPOs available. >>> obb.equity.calendar.ipo(provider='intrinio') + >>> # Get IPOs for specific dates. + >>> obb.equity.calendar.ipo(start_date='2024-02-01', end_date='2024-02-07', provider='nasdaq') """ # noqa: E501 return self._run( @@ -338,7 +372,7 @@ def ipo( "provider": self._get_provider( provider, "/equity/calendar/ipo", - ("intrinio",), + ("intrinio", "nasdaq"), ) }, standard_params={ diff --git a/openbb_platform/openbb/package/equity_compare.py b/openbb_platform/openbb/package/equity_compare.py index 6daed76b8562..dbdaed5e6e53 100644 --- a/openbb_platform/openbb/package/equity_compare.py +++ b/openbb_platform/openbb/package/equity_compare.py @@ -12,12 +12,145 @@ class ROUTER_equity_compare(Container): """/equity/compare + groups peers """ def __repr__(self) -> str: return self.__doc__ or "" + @exception_handler + @validate + def groups( + self, + group: Annotated[ + Optional[str], + OpenBBField( + description="The group to compare - i.e., 'sector', 'industry', 'country'. Choices vary by provider." + ), + ] = None, + metric: Annotated[ + Optional[str], + OpenBBField( + description="The type of metrics to compare - i.e, 'valuation', 'performance'. Choices vary by provider." + ), + ] = None, + provider: Annotated[ + Optional[Literal["finviz"]], + OpenBBField( + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'finviz' if there is\n no default." + ), + ] = None, + **kwargs + ) -> OBBject: + """Get company data grouped by sector, industry or country and display either performance or valuation metrics. + + Valuation metrics include price to earnings, price to book, price to sales ratios and price to cash flow. + Performance metrics include the stock price change for different time periods. + + + Parameters + ---------- + group : Optional[str] + The group to compare - i.e., 'sector', 'industry', 'country'. Choices vary by provider. + metric : Optional[str] + The type of metrics to compare - i.e, 'valuation', 'performance'. Choices vary by provider. + provider : Optional[Literal['finviz']] + The provider to use for the query, by default None. + If None, the provider specified in defaults is selected or 'finviz' if there is + no default. + + Returns + ------- + OBBject + results : List[CompareGroups] + Serializable results. + provider : Optional[Literal['finviz']] + Provider name. + warnings : Optional[List[Warning_]] + List of warnings. + chart : Optional[Chart] + Chart object. + extra : Dict[str, Any] + Extra info. + + CompareGroups + ------------- + name : str + Name or label of the group. + stocks : Optional[int] + The number of stocks in the group. (provider: finviz) + market_cap : Optional[int] + The market cap of the group. (provider: finviz) + performance_1_d : Optional[float] + The performance in the last day, as a normalized percent. (provider: finviz) + performance_1_w : Optional[float] + The performance in the last week, as a normalized percent. (provider: finviz) + performance_1_m : Optional[float] + The performance in the last month, as a normalized percent. (provider: finviz) + performance_3_m : Optional[float] + The performance in the last quarter, as a normalized percent. (provider: finviz) + performance_6_m : Optional[float] + The performance in the last half year, as a normalized percent. (provider: finviz) + performance_1_y : Optional[float] + The performance in the last year, as a normalized percent. (provider: finviz) + performance_ytd : Optional[float] + The performance in the year to date, as a normalized percent. (provider: finviz) + dividend_yield : Optional[float] + The dividend yield of the group, as a normalized percent. (provider: finviz) + pe : Optional[float] + The P/E ratio of the group. (provider: finviz) + forward_pe : Optional[float] + The forward P/E ratio of the group. (provider: finviz) + peg : Optional[float] + The PEG ratio of the group. (provider: finviz) + eps_growth_past_5_years : Optional[float] + The EPS growth of the group for the past 5 years, as a normalized percent. (provider: finviz) + eps_growth_next_5_years : Optional[float] + The estimated EPS growth of the groupo for the next 5 years, as a normalized percent. (provider: finviz) + sales_growth_past_5_years : Optional[float] + The sales growth of the group for the past 5 years, as a normalized percent. (provider: finviz) + float_short : Optional[float] + The percent of the float shorted for the group, as a normalized value. (provider: finviz) + analyst_recommendation : Optional[float] + The analyst consensus, on a scale of 1-5 where 1 is a buy and 5 is a sell. (provider: finviz) + volume : Optional[int] + The trading volume. (provider: finviz) + volume_average : Optional[int] + The 3-month average volume of the group. (provider: finviz) + volume_relative : Optional[float] + The relative volume compared to the 3-month average volume. (provider: finviz) + + Examples + -------- + >>> from openbb import obb + >>> obb.equity.compare.groups(provider='finviz') + >>> # Group by sector and analyze valuation. + >>> obb.equity.compare.groups(group='sector', metric='valuation', provider='finviz') + >>> # Group by industry and analyze performance. + >>> obb.equity.compare.groups(group='industry', metric='performance', provider='finviz') + >>> # Group by country and analyze valuation. + >>> obb.equity.compare.groups(group='country', metric='valuation', provider='finviz') + """ # noqa: E501 + + return self._run( + "/equity/compare/groups", + **filter_inputs( + provider_choices={ + "provider": self._get_provider( + provider, + "/equity/compare/groups", + ("finviz",), + ) + }, + standard_params={ + "group": group, + "metric": metric, + }, + extra_params=kwargs, + ) + ) + @exception_handler @validate def peers( diff --git a/openbb_platform/openbb/package/equity_discovery.py b/openbb_platform/openbb/package/equity_discovery.py index 770a2ce6daea..b5e20c44b697 100644 --- a/openbb_platform/openbb/package/equity_discovery.py +++ b/openbb_platform/openbb/package/equity_discovery.py @@ -19,8 +19,10 @@ class ROUTER_equity_discovery(Container): gainers growth_tech losers + top_retail undervalued_growth undervalued_large_caps + upcoming_release_days """ def __repr__(self) -> str: @@ -324,9 +326,9 @@ def gainers( ), ] = "desc", provider: Annotated[ - Optional[Literal["yfinance"]], + Optional[Literal["tmx", "yfinance"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'yfinance' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'tmx' if there is\n no default." ), ] = None, **kwargs @@ -337,17 +339,19 @@ def gainers( ---------- sort : Literal['asc', 'desc'] Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. - provider : Optional[Literal['yfinance']] + provider : Optional[Literal['tmx', 'yfinance']] The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'yfinance' if there is + If None, the provider specified in defaults is selected or 'tmx' if there is no default. + category : Literal['dividend', 'energy', 'healthcare', 'industrials', 'price_performer', 'rising_stars', 'real_estate', 'tech', 'utilities', '52w_high', 'volume'] + The category of list to retrieve. Defaults to `price_performer`. (provider: tmx) Returns ------- OBBject results : List[EquityGainers] Serializable results. - provider : Optional[Literal['yfinance']] + provider : Optional[Literal['tmx', 'yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -370,6 +374,8 @@ def gainers( Percent change. volume : float The trading volume. + rank : Optional[int] + The rank of the stock in the list. (provider: tmx) market_cap : Optional[float] Market Cap. (provider: yfinance) avg_volume_3_months : Optional[float] @@ -391,7 +397,7 @@ def gainers( "provider": self._get_provider( provider, "/equity/discovery/gainers", - ("yfinance",), + ("tmx", "yfinance"), ) }, standard_params={ @@ -577,6 +583,84 @@ def losers( ) ) + @exception_handler + @validate + def top_retail( + self, + limit: Annotated[ + int, OpenBBField(description="The number of data entries to return.") + ] = 5, + provider: Annotated[ + Optional[Literal["nasdaq"]], + OpenBBField( + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'nasdaq' if there is\n no default." + ), + ] = None, + **kwargs + ) -> OBBject: + """Track over $30B USD/day of individual investors trades. + + It gives a daily view into retail activity and sentiment for over 9,500 US traded stocks, + ADRs, and ETPs. + + + Parameters + ---------- + limit : int + The number of data entries to return. + provider : Optional[Literal['nasdaq']] + The provider to use for the query, by default None. + If None, the provider specified in defaults is selected or 'nasdaq' if there is + no default. + + Returns + ------- + OBBject + results : List[TopRetail] + Serializable results. + provider : Optional[Literal['nasdaq']] + Provider name. + warnings : Optional[List[Warning_]] + List of warnings. + chart : Optional[Chart] + Chart object. + extra : Dict[str, Any] + Extra info. + + TopRetail + --------- + date : date + The date of the data. + symbol : str + Symbol representing the entity requested in the data. + activity : float + Activity of the symbol. + sentiment : float + Sentiment of the symbol. 1 is bullish, -1 is bearish. + + Examples + -------- + >>> from openbb import obb + >>> obb.equity.discovery.top_retail(provider='nasdaq') + """ # noqa: E501 + + return self._run( + "/equity/discovery/top_retail", + **filter_inputs( + provider_choices={ + "provider": self._get_provider( + provider, + "/equity/discovery/top_retail", + ("nasdaq",), + ) + }, + standard_params={ + "limit": limit, + }, + extra_params=kwargs, + ) + ) + @exception_handler @validate def undervalued_growth( @@ -752,3 +836,76 @@ def undervalued_large_caps( extra_params=kwargs, ) ) + + @exception_handler + @validate + def upcoming_release_days( + self, + provider: Annotated[ + Optional[Literal["seeking_alpha"]], + OpenBBField( + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'seeking_alpha' if there is\n no default." + ), + ] = None, + **kwargs + ) -> OBBject: + """Get upcoming earnings release dates. + + Parameters + ---------- + provider : Optional[Literal['seeking_alpha']] + The provider to use for the query, by default None. + If None, the provider specified in defaults is selected or 'seeking_alpha' if there is + no default. + limit : int + The number of data entries to return.In this case, the number of lookahead days. (provider: seeking_alpha) + + Returns + ------- + OBBject + results : List[UpcomingReleaseDays] + Serializable results. + provider : Optional[Literal['seeking_alpha']] + Provider name. + warnings : Optional[List[Warning_]] + List of warnings. + chart : Optional[Chart] + Chart object. + extra : Dict[str, Any] + Extra info. + + UpcomingReleaseDays + ------------------- + symbol : str + Symbol representing the entity requested in the data. + name : str + The full name of the asset. + exchange : str + The exchange the asset is traded on. + release_time_type : str + The type of release time. + release_date : date + The date of the release. + sector_id : Optional[int] + The sector ID of the asset. (provider: seeking_alpha) + + Examples + -------- + >>> from openbb import obb + >>> obb.equity.discovery.upcoming_release_days(provider='seeking_alpha') + """ # noqa: E501 + + return self._run( + "/equity/discovery/upcoming_release_days", + **filter_inputs( + provider_choices={ + "provider": self._get_provider( + provider, + "/equity/discovery/upcoming_release_days", + ("seeking_alpha",), + ) + }, + standard_params={}, + extra_params=kwargs, + ) + ) diff --git a/openbb_platform/openbb/package/equity_estimates.py b/openbb_platform/openbb/package/equity_estimates.py index 01b95add7a5d..6d499634e996 100644 --- a/openbb_platform/openbb/package/equity_estimates.py +++ b/openbb_platform/openbb/package/equity_estimates.py @@ -238,11 +238,11 @@ def consensus( symbol: Annotated[ Union[str, None, List[Optional[str]]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, tmx, yfinance." ), ] = None, provider: Annotated[ - Optional[Literal["fmp", "intrinio", "yfinance"]], + Optional[Literal["fmp", "intrinio", "tmx", "yfinance"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -254,8 +254,8 @@ def consensus( Parameters ---------- symbol : Union[str, None, List[Optional[str]]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, tmx, yfinance. + provider : Optional[Literal['fmp', 'intrinio', 'tmx', 'yfinance']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. @@ -267,7 +267,7 @@ def consensus( OBBject results : List[PriceTargetConsensus] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + provider : Optional[Literal['fmp', 'intrinio', 'tmx', 'yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -302,6 +302,18 @@ def consensus( The date of the most recent estimate. (provider: intrinio) industry_group_number : Optional[int] The Zacks industry group number. (provider: intrinio) + target_upside : Optional[float] + Percent of upside, as a normalized percent. (provider: tmx) + total_analysts : Optional[int] + Total number of analyst. (provider: tmx) + buy_ratings : Optional[int] + Number of buy ratings. (provider: tmx) + sell_ratings : Optional[int] + Number of sell ratings. (provider: tmx) + hold_ratings : Optional[int] + Number of hold ratings. (provider: tmx) + consensus_action : Optional[str] + Consensus action. (provider: tmx) recommendation : Optional[str] Recommendation - buy, sell, etc. (provider: yfinance) recommendation_mean : Optional[float] @@ -327,7 +339,7 @@ def consensus( "provider": self._get_provider( provider, "/equity/estimates/consensus", - ("fmp", "intrinio", "yfinance"), + ("fmp", "intrinio", "tmx", "yfinance"), ) }, standard_params={ @@ -338,6 +350,7 @@ def consensus( "symbol": { "fmp": {"multiple_items_allowed": True}, "intrinio": {"multiple_items_allowed": True}, + "tmx": {"multiple_items_allowed": True}, "yfinance": {"multiple_items_allowed": True}, } }, @@ -716,14 +729,14 @@ def price_target( symbol: Annotated[ Union[str, None, List[Optional[str]]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, finviz, fmp." ), ] = None, limit: Annotated[ int, OpenBBField(description="The number of data entries to return.") ] = 200, provider: Annotated[ - Optional[Literal["benzinga", "fmp"]], + Optional[Literal["benzinga", "finviz", "fmp"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'benzinga' if there is\n no default." ), @@ -735,10 +748,10 @@ def price_target( Parameters ---------- symbol : Union[str, None, List[Optional[str]]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp. + Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, finviz, fmp. limit : int The number of data entries to return. - provider : Optional[Literal['benzinga', 'fmp']] + provider : Optional[Literal['benzinga', 'finviz', 'fmp']] 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. @@ -770,7 +783,7 @@ def price_target( OBBject results : List[PriceTarget] Serializable results. - provider : Optional[Literal['benzinga', 'fmp']] + provider : Optional[Literal['benzinga', 'finviz', 'fmp']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -829,6 +842,10 @@ def price_target( Unique ID of this entry. (provider: benzinga) last_updated : Optional[datetime] Last updated timestamp, UTC. (provider: benzinga) + status : Optional[str] + The action taken by the firm. This could be 'Upgrade', 'Downgrade', 'Reiterated', etc. (provider: finviz) + rating_change : Optional[str] + The rating given by the analyst. This could be 'Buy', 'Sell', 'Underweight', etc. If the rating is a revision, the change is indicated by '->' (provider: finviz) news_url : Optional[str] News URL of the price target. (provider: fmp) news_title : Optional[str] @@ -853,7 +870,7 @@ def price_target( "provider": self._get_provider( provider, "/equity/estimates/price_target", - ("benzinga", "fmp"), + ("benzinga", "finviz", "fmp"), ) }, standard_params={ @@ -864,6 +881,7 @@ def price_target( info={ "symbol": { "benzinga": {"multiple_items_allowed": True}, + "finviz": {"multiple_items_allowed": True}, "fmp": {"multiple_items_allowed": True}, } }, diff --git a/openbb_platform/openbb/package/equity_fundamental.py b/openbb_platform/openbb/package/equity_fundamental.py index cc734d0f02ac..f9a62be1a85e 100644 --- a/openbb_platform/openbb/package/equity_fundamental.py +++ b/openbb_platform/openbb/package/equity_fundamental.py @@ -970,7 +970,12 @@ def cash_growth( @validate def dividends( self, - symbol: Annotated[str, OpenBBField(description="Symbol to get data for.")], + symbol: Annotated[ + Union[str, List[str]], + OpenBBField( + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): nasdaq." + ), + ], start_date: Annotated[ Union[datetime.date, None, str], OpenBBField(description="Start date of the data, in YYYY-MM-DD format."), @@ -980,7 +985,7 @@ def dividends( OpenBBField(description="End date of the data, in YYYY-MM-DD format."), ] = None, provider: Annotated[ - Optional[Literal["fmp", "intrinio", "yfinance"]], + Optional[Literal["fmp", "intrinio", "nasdaq", "tmx", "yfinance"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -991,13 +996,13 @@ def dividends( Parameters ---------- - symbol : str - Symbol to get data for. + symbol : Union[str, List[str]] + Symbol to get data for. Multiple comma separated items allowed for provider(s): nasdaq. start_date : Union[datetime.date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + provider : Optional[Literal['fmp', 'intrinio', 'nasdaq', 'tmx', 'yfinance']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. @@ -1009,7 +1014,7 @@ def dividends( OBBject results : List[HistoricalDividends] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + provider : Optional[Literal['fmp', 'intrinio', 'nasdaq', 'tmx', 'yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -1029,17 +1034,25 @@ def dividends( adj_dividend : Optional[float] Adjusted dividend of the historical dividends. (provider: fmp) record_date : Optional[date] - Record date of the historical dividends. (provider: fmp) + Record date of the historical dividends. (provider: fmp); + The record date of ownership for eligibility. (provider: nasdaq); + The record date of ownership for rights to the dividend. (provider: tmx) payment_date : Optional[date] - Payment date of the historical dividends. (provider: fmp) + Payment date of the historical dividends. (provider: fmp); + The payment date of the dividend. (provider: nasdaq); + The date the dividend is paid. (provider: tmx) declaration_date : Optional[date] - Declaration date of the historical dividends. (provider: fmp) + Declaration date of the historical dividends. (provider: fmp, nasdaq) factor : Optional[float] factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices. (provider: intrinio) currency : Optional[str] - The currency in which the dividend is paid. (provider: intrinio) + The currency in which the dividend is paid. (provider: intrinio, nasdaq, tmx) split_ratio : Optional[float] The ratio of the stock split, if a stock split occurred. (provider: intrinio) + dividend_type : Optional[str] + The type of dividend - i.e., cash, stock. (provider: nasdaq) + decalaration_date : Optional[date] + The date of the announcement. (provider: tmx) Examples -------- @@ -1054,7 +1067,7 @@ def dividends( "provider": self._get_provider( provider, "/equity/fundamental/dividends", - ("fmp", "intrinio", "yfinance"), + ("fmp", "intrinio", "nasdaq", "tmx", "yfinance"), ) }, standard_params={ @@ -1063,6 +1076,7 @@ def dividends( "end_date": end_date, }, extra_params=kwargs, + info={"symbol": {"nasdaq": {"multiple_items_allowed": True}}}, ) ) @@ -1165,7 +1179,7 @@ def filings( int, OpenBBField(description="The number of data entries to return.") ] = 100, provider: Annotated[ - Optional[Literal["fmp", "intrinio", "sec"]], + Optional[Literal["fmp", "intrinio", "sec", "tmx"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -1187,14 +1201,16 @@ def filings( Filter by form type. Check the data provider for available types. limit : int The number of data entries to return. - provider : Optional[Literal['fmp', 'intrinio', 'sec']] + provider : Optional[Literal['fmp', 'intrinio', 'sec', 'tmx']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. start_date : Optional[datetime.date] - Start date of the data, in YYYY-MM-DD format. (provider: intrinio) + Start date of the data, in YYYY-MM-DD format. (provider: intrinio); + The start date to fetch. (provider: tmx) end_date : Optional[datetime.date] - End date of the data, in YYYY-MM-DD format. (provider: intrinio) + End date of the data, in YYYY-MM-DD format. (provider: intrinio); + The end date to fetch. (provider: tmx) thea_enabled : Optional[bool] Return filings that have been read by Intrinio's Thea NLP. (provider: intrinio) cik : Optional[Union[int, str]] @@ -1207,7 +1223,7 @@ def filings( OBBject results : List[CompanyFilings] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'sec']] + provider : Optional[Literal['fmp', 'intrinio', 'sec', 'tmx']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -1265,11 +1281,14 @@ def filings( is_xbrl : Optional[Union[int, str]] Whether the filing is an XBRL filing. (provider: sec) size : Optional[Union[int, str]] - The size of the filing. (provider: sec) + The size of the filing. (provider: sec); + The file size of the PDF document. (provider: tmx) complete_submission_url : Optional[str] The URL to the complete filing submission. (provider: sec) filing_detail_url : Optional[str] The URL to the filing details. (provider: sec) + description : Optional[str] + The description of the filing. (provider: tmx) Examples -------- @@ -1285,7 +1304,7 @@ def filings( "provider": self._get_provider( provider, "/equity/fundamental/filings", - ("fmp", "intrinio", "sec"), + ("fmp", "intrinio", "sec", "tmx"), ) }, standard_params={ @@ -1431,11 +1450,16 @@ def historical_attributes( @validate def historical_eps( self, - symbol: Annotated[str, OpenBBField(description="Symbol to get data for.")], + symbol: Annotated[ + Union[str, List[str]], + OpenBBField( + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): alpha_vantage." + ), + ], provider: Annotated[ - Optional[Literal["fmp"]], + Optional[Literal["alpha_vantage", "fmp"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'alpha_vantage' if there is\n no default." ), ] = None, **kwargs @@ -1444,21 +1468,23 @@ def historical_eps( Parameters ---------- - symbol : str - Symbol to get data for. - provider : Optional[Literal['fmp']] + symbol : Union[str, List[str]] + Symbol to get data for. Multiple comma separated items allowed for provider(s): alpha_vantage. + provider : Optional[Literal['alpha_vantage', 'fmp']] The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'fmp' if there is + If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. + period : Literal['annual', 'quarter'] + Time period of the data to return. (provider: alpha_vantage) limit : Optional[int] - The number of data entries to return. (provider: fmp) + The number of data entries to return. (provider: alpha_vantage, fmp) Returns ------- OBBject results : List[HistoricalEps] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[Literal['alpha_vantage', 'fmp']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -1479,6 +1505,12 @@ def historical_eps( Actual EPS from the earnings date. eps_estimated : Optional[float] Estimated EPS for the earnings date. + surprise : Optional[float] + Surprise in EPS (Actual - Estimated). (provider: alpha_vantage) + surprise_percent : Optional[Union[float, str]] + EPS surprise as a normalized percent. (provider: alpha_vantage) + reported_date : Optional[date] + Date of the earnings report. (provider: alpha_vantage) revenue_estimated : Optional[float] Estimated consensus revenue for the reporting period. (provider: fmp) revenue_actual : Optional[float] @@ -1503,13 +1535,14 @@ def historical_eps( "provider": self._get_provider( provider, "/equity/fundamental/historical_eps", - ("fmp",), + ("alpha_vantage", "fmp"), ) }, standard_params={ "symbol": symbol, }, extra_params=kwargs, + info={"symbol": {"alpha_vantage": {"multiple_items_allowed": True}}}, ) ) @@ -2362,7 +2395,7 @@ def metrics( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): finviz, fmp, intrinio, yfinance." ), ], period: Annotated[ @@ -2374,9 +2407,9 @@ def metrics( OpenBBField(description="The number of data entries to return."), ] = 100, provider: Annotated[ - Optional[Literal["fmp", "intrinio", "yfinance"]], + Optional[Literal["finviz", "fmp", "intrinio", "yfinance"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'finviz' if there is\n no default." ), ] = None, **kwargs @@ -2386,14 +2419,14 @@ def metrics( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance. + Symbol to get data for. Multiple comma separated items allowed for provider(s): finviz, fmp, intrinio, yfinance. period : Optional[Literal['annual', 'quarter']] Time period of the data to return. limit : Optional[int] The number of data entries to return. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + provider : Optional[Literal['finviz', 'fmp', 'intrinio', 'yfinance']] The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'fmp' if there is + If None, the provider specified in defaults is selected or 'finviz' if there is no default. with_ttm : Optional[bool] Include trailing twelve months (TTM) data. (provider: fmp) @@ -2403,7 +2436,7 @@ def metrics( OBBject results : List[KeyMetrics] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + provider : Optional[Literal['finviz', 'fmp', 'intrinio', 'yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -2420,6 +2453,54 @@ def metrics( Market capitalization pe_ratio : Optional[float] Price-to-earnings ratio (P/E ratio) + foward_pe : Optional[float] + Forward price-to-earnings ratio (forward P/E) (provider: finviz) + eps : Optional[float] + Earnings per share (EPS) (provider: finviz); + Basic earnings per share. (provider: intrinio) + price_to_sales : Optional[float] + Price-to-sales ratio (P/S) (provider: finviz) + price_to_book : Optional[float] + Price-to-book ratio (P/B) (provider: finviz, intrinio, yfinance) + book_value_per_share : Optional[float] + Book value per share (Book/sh) (provider: finviz); + Book value per share (provider: fmp) + price_to_cash : Optional[float] + Price-to-cash ratio (P/C) (provider: finviz) + cash_per_share : Optional[float] + Cash per share (Cash/sh) (provider: finviz); + Cash per share (provider: fmp); + Cash per share. (provider: yfinance) + price_to_free_cash_flow : Optional[float] + Price-to-free cash flow ratio (P/FCF) (provider: finviz) + debt_to_equity : Optional[float] + Debt-to-equity ratio (Debt/Eq) (provider: finviz); + Debt-to-equity ratio (provider: fmp); + Debt-to-equity ratio. (provider: yfinance) + long_term_debt_to_equity : Optional[float] + Long-term debt-to-equity ratio (LT Debt/Eq) (provider: finviz) + quick_ratio : Optional[float] + Quick ratio (provider: finviz, intrinio, yfinance) + current_ratio : Optional[float] + Current ratio (provider: finviz, fmp, yfinance) + gross_margin : Optional[float] + Gross margin, as a normalized percent. (provider: finviz, intrinio, yfinance) + profit_margin : Optional[float] + Profit margin, as a normalized percent. (provider: finviz, intrinio, yfinance) + operating_margin : Optional[float] + Operating margin, as a normalized percent. (provider: finviz, yfinance) + return_on_assets : Optional[float] + Return on assets (ROA), as a normalized percent. (provider: finviz, intrinio, yfinance) + return_on_investment : Optional[float] + Return on investment (ROI), as a normalized percent. (provider: finviz) + return_on_equity : Optional[float] + Return on equity (ROE), as a normalized percent. (provider: finviz, intrinio, yfinance) + payout_ratio : Optional[float] + Payout ratio, as a normalized percent. (provider: finviz); + Payout ratio (provider: fmp); + Payout ratio. (provider: yfinance) + dividend_yield : Optional[float] + Dividend yield, as a normalized percent. (provider: finviz, fmp, intrinio, yfinance) date : Optional[date] The date of the data. (provider: fmp) period : Optional[str] @@ -2434,10 +2515,6 @@ def metrics( Operating cash flow per share (provider: fmp) free_cash_flow_per_share : Optional[float] Free cash flow per share (provider: fmp) - cash_per_share : Optional[float] - Cash per share (provider: fmp, yfinance) - book_value_per_share : Optional[float] - Book value per share (provider: fmp) tangible_book_value_per_share : Optional[float] Tangible book value per share (provider: fmp) shareholders_equity_per_share : Optional[float] @@ -2469,22 +2546,14 @@ def metrics( Earnings yield, as a normalized percent. (provider: intrinio) free_cash_flow_yield : Optional[float] Free cash flow yield (provider: fmp) - debt_to_equity : Optional[float] - Debt-to-equity ratio (provider: fmp, yfinance) debt_to_assets : Optional[float] Debt-to-assets ratio (provider: fmp) net_debt_to_ebitda : Optional[float] Net debt-to-EBITDA ratio (provider: fmp) - current_ratio : Optional[float] - Current ratio (provider: fmp, yfinance) interest_coverage : Optional[float] Interest coverage (provider: fmp) income_quality : Optional[float] Income quality (provider: fmp) - dividend_yield : Optional[float] - Dividend yield, as a normalized percent. (provider: fmp, intrinio, yfinance) - payout_ratio : Optional[float] - Payout ratio (provider: fmp, yfinance) sales_general_and_administrative_to_revenue : Optional[float] Sales general and administrative expenses-to-revenue ratio (provider: fmp) research_and_development_to_revenue : Optional[float] @@ -2537,22 +2606,12 @@ def metrics( Return on equity (provider: fmp) capex_per_share : Optional[float] Capital expenditures per share (provider: fmp) - price_to_book : Optional[float] - Price to book ratio. (provider: intrinio, yfinance) price_to_tangible_book : Optional[float] Price to tangible book ratio. (provider: intrinio) price_to_revenue : Optional[float] Price to revenue ratio. (provider: intrinio) - quick_ratio : Optional[float] - Quick ratio. (provider: intrinio, yfinance) - gross_margin : Optional[float] - Gross margin, as a normalized percent. (provider: intrinio, yfinance) ebit_margin : Optional[float] EBIT margin, as a normalized percent. (provider: intrinio) - profit_margin : Optional[float] - Profit margin, as a normalized percent. (provider: intrinio, yfinance) - eps : Optional[float] - Basic earnings per share. (provider: intrinio) eps_growth : Optional[float] EPS growth, as a normalized percent. (provider: intrinio) revenue_growth : Optional[float] @@ -2567,10 +2626,6 @@ def metrics( Free cash flow to firm growth, as a normalized percent. (provider: intrinio) invested_capital_growth : Optional[float] Invested capital growth, as a normalized percent. (provider: intrinio) - return_on_assets : Optional[float] - Return on assets, as a normalized percent. (provider: intrinio, yfinance) - return_on_equity : Optional[float] - Return on equity, as a normalized percent. (provider: intrinio, yfinance) return_on_invested_capital : Optional[float] Return on invested capital, as a normalized percent. (provider: intrinio) ebitda : Optional[int] @@ -2622,8 +2677,6 @@ def metrics( Quarterly earnings growth (Year Over Year), as a normalized percent. (provider: yfinance) enterprise_to_revenue : Optional[float] Enterprise value to revenue ratio. (provider: yfinance) - operating_margin : Optional[float] - Operating margin, as a normalized percent. (provider: yfinance) ebitda_margin : Optional[float] EBITDA margin, as a normalized percent. (provider: yfinance) dividend_yield_5y_avg : Optional[float] @@ -2659,7 +2712,7 @@ def metrics( "provider": self._get_provider( provider, "/equity/fundamental/metrics", - ("fmp", "intrinio", "yfinance"), + ("finviz", "fmp", "intrinio", "yfinance"), ) }, standard_params={ @@ -2670,6 +2723,7 @@ def metrics( extra_params=kwargs, info={ "symbol": { + "finviz": {"multiple_items_allowed": True}, "fmp": {"multiple_items_allowed": True}, "intrinio": {"multiple_items_allowed": True}, "yfinance": {"multiple_items_allowed": True}, diff --git a/openbb_platform/openbb/package/equity_ownership.py b/openbb_platform/openbb/package/equity_ownership.py index c9806627f8e5..9a31c21aa1bd 100644 --- a/openbb_platform/openbb/package/equity_ownership.py +++ b/openbb_platform/openbb/package/equity_ownership.py @@ -157,7 +157,7 @@ def insider_trading( int, OpenBBField(description="The number of data entries to return.") ] = 500, provider: Annotated[ - Optional[Literal["fmp", "intrinio"]], + Optional[Literal["fmp", "intrinio", "tmx"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -172,7 +172,7 @@ def insider_trading( Symbol to get data for. limit : int The number of data entries to return. - provider : Optional[Literal['fmp', 'intrinio']] + provider : Optional[Literal['fmp', 'intrinio', 'tmx']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. @@ -186,13 +186,15 @@ def insider_trading( Type of ownership. (provider: intrinio) sort_by : Optional[Literal['filing_date', 'updated_on']] Field to sort by. (provider: intrinio) + summary : bool + Return a summary of the insider activity instead of the individuals. (provider: tmx) Returns ------- OBBject results : List[InsiderTrading] Serializable results. - provider : Optional[Literal['fmp', 'intrinio']] + provider : Optional[Literal['fmp', 'intrinio', 'tmx']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -261,6 +263,20 @@ def insider_trading( Whether the owner is having a derivative transaction. (provider: intrinio) report_line_number : Optional[int] Report line number of the insider trading. (provider: intrinio) + period : Optional[str] + The period of the activity. Bucketed by three, six, and twelve months. (provider: tmx) + acquisition_or_deposition : Optional[str] + Whether the insider bought or sold the shares. (provider: tmx) + number_of_trades : Optional[int] + The number of shares traded over the period. (provider: tmx) + trade_value : Optional[float] + The value of the shares traded by the insider. (provider: tmx) + securities_bought : Optional[int] + The total number of shares bought by all insiders over the period. (provider: tmx) + securities_sold : Optional[int] + The total number of shares sold by all insiders over the period. (provider: tmx) + net_activity : Optional[int] + The total net activity by all insiders over the period. (provider: tmx) Examples -------- @@ -276,7 +292,7 @@ def insider_trading( "provider": self._get_provider( provider, "/equity/ownership/insider_trading", - ("fmp", "intrinio"), + ("fmp", "intrinio", "tmx"), ) }, standard_params={ diff --git a/openbb_platform/openbb/package/equity_price.py b/openbb_platform/openbb/package/equity_price.py index a4327717d3d1..32d7c742db0a 100644 --- a/openbb_platform/openbb/package/equity_price.py +++ b/openbb_platform/openbb/package/equity_price.py @@ -29,7 +29,7 @@ def historical( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon, tiingo, yfinance." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance." ), ], interval: Annotated[ @@ -44,10 +44,28 @@ def historical( Union[datetime.date, None, str], OpenBBField(description="End date of the data, in YYYY-MM-DD format."), ] = None, + chart: Annotated[ + bool, + OpenBBField( + description="Whether to create a chart or not, by default False." + ), + ] = False, provider: Annotated[ - Optional[Literal["fmp", "intrinio", "polygon", "tiingo", "yfinance"]], + Optional[ + Literal[ + "alpha_vantage", + "cboe", + "fmp", + "intrinio", + "polygon", + "tiingo", + "tmx", + "tradier", + "yfinance", + ] + ], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'alpha_vantage' if there is\n no default." ), ] = None, **kwargs @@ -57,17 +75,30 @@ def historical( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon, tiingo, yfinance. + Symbol to get data for. Multiple comma separated items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. interval : Optional[str] Time interval of the data to return. start_date : Union[datetime.date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinanc... + chart : bool + Whether to create a chart or not, by default False. + provider : Optional[Literal['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'pol... The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'fmp' if there is + If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. + adjustment : Union[Literal['splits_only', 'splits_and_dividends', 'unadjusted'], Literal['splits_only', 'unadjusted'], Literal['splits_only', 'splits_and_dividends']] + The adjustment factor to apply. 'splits_only' is not supported for intraday data. (provider: alpha_vantage); + The adjustment factor to apply. Default is splits only. (provider: polygon); + The adjustment factor to apply. Only valid for daily data. (provider: tmx); + The adjustment factor to apply. Default is splits only. (provider: yfinance) + extended_hours : Optional[bool] + Include Pre and Post market data. (provider: alpha_vantage, polygon, tradier, yfinance) + adjusted : bool + This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead. (provider: alpha_vantage, yfinance) + use_cache : bool + When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. (provider: cboe) start_time : Optional[datetime.time] Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. (provider: intrinio) end_time : Optional[datetime.time] @@ -76,18 +107,12 @@ def historical( Timezone of the data, in the IANA format (Continent/City). (provider: intrinio) source : Literal['realtime', 'delayed', 'nasdaq_basic'] The source of the data. (provider: intrinio) - adjustment : Union[Literal['splits_only', 'unadjusted'], Literal['splits_only', 'splits_and_dividends']] - The adjustment factor to apply. Default is splits only. (provider: polygon, yfinance) - extended_hours : bool - Include Pre and Post market data. (provider: polygon, yfinance) sort : Literal['asc', 'desc'] 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. (provider: polygon) limit : int The number of data entries to return. (provider: polygon) include_actions : bool Include dividends and stock splits in results. (provider: yfinance) - adjusted : bool - This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead. (provider: yfinance) prepost : bool This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead. (provider: yfinance) @@ -96,7 +121,7 @@ def historical( OBBject results : List[EquityHistorical] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']] + provider : Optional[Literal['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -117,20 +142,35 @@ def historical( The low price. close : float The close price. - volume : Optional[Union[int, float]] + volume : Optional[Union[float, int]] The trading volume. vwap : Optional[float] Volume Weighted Average Price over the period. - adj_close : Optional[float] - The adjusted close price. (provider: fmp, intrinio, tiingo) + adj_close : Optional[Union[Annotated[float, Gt(gt=0)], float]] + The adjusted close price. (provider: alpha_vantage, fmp, intrinio, tiingo) + dividend : Optional[Union[Annotated[float, Ge(ge=0)], float]] + Dividend amount, if a dividend was paid. (provider: alpha_vantage, intrinio, tiingo, yfinance) + split_ratio : Optional[Union[Annotated[float, Ge(ge=0)], float]] + Split coefficient, if a split occurred. (provider: alpha_vantage); + Ratio of the equity split, if a split occurred. (provider: intrinio); + Ratio of the equity split, if a split occurred. (provider: tiingo); + Ratio of the equity split, if a split occurred. (provider: yfinance) + calls_volume : Optional[int] + Number of calls traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) + puts_volume : Optional[int] + Number of puts traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) + total_options_volume : Optional[int] + Total number of options traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) unadjusted_volume : Optional[float] Unadjusted volume of the symbol. (provider: fmp) change : Optional[float] Change in the price from the previous close. (provider: fmp); - Change in the price of the symbol from the previous day. (provider: intrinio) + Change in the price of the symbol from the previous day. (provider: intrinio); + Change in price. (provider: tmx) change_percent : Optional[float] Change in the price from the previous close, as a normalized percent. (provider: fmp); - Percent change in the price of the symbol from the previous day. (provider: intrinio) + Percent change in the price of the symbol from the previous day. (provider: intrinio); + Change in price, as a normalized percentage. (provider: tmx) average : Optional[float] Average trade price of an individual equity during the interval. (provider: intrinio) adj_open : Optional[float] @@ -147,18 +187,19 @@ def historical( 52 week low price for the symbol. (provider: intrinio) factor : Optional[float] factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices. (provider: intrinio) - split_ratio : Optional[float] - Ratio of the equity split, if a split occurred. (provider: intrinio, tiingo, yfinance) - dividend : Optional[float] - Dividend amount, if a dividend was paid. (provider: intrinio, tiingo, yfinance) close_time : Optional[datetime] The timestamp that represents the end of the interval span. (provider: intrinio) interval : Optional[str] The data time frequency. (provider: intrinio) intra_period : Optional[bool] 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 (provider: intrinio) - transactions : Optional[Annotated[int, Gt(gt=0)]] - Number of transactions for the symbol in the time period. (provider: polygon) + transactions : Optional[Union[Annotated[int, Gt(gt=0)], int]] + Number of transactions for the symbol in the time period. (provider: polygon); + Total number of transactions recorded. (provider: tmx) + transactions_value : Optional[float] + Nominal value of recorded transactions. (provider: tmx) + last_price : Optional[float] + The last price of the equity. (provider: tradier) Examples -------- @@ -174,7 +215,17 @@ def historical( "provider": self._get_provider( provider, "/equity/price/historical", - ("fmp", "intrinio", "polygon", "tiingo", "yfinance"), + ( + "alpha_vantage", + "cboe", + "fmp", + "intrinio", + "polygon", + "tiingo", + "tmx", + "tradier", + "yfinance", + ), ) }, standard_params={ @@ -184,11 +235,16 @@ def historical( "end_date": end_date, }, extra_params=kwargs, + chart=chart, info={ "symbol": { + "alpha_vantage": {"multiple_items_allowed": True}, + "cboe": {"multiple_items_allowed": True}, "fmp": {"multiple_items_allowed": True}, "polygon": {"multiple_items_allowed": True}, "tiingo": {"multiple_items_allowed": True}, + "tmx": {"multiple_items_allowed": True}, + "tradier": {"multiple_items_allowed": True}, "yfinance": {"multiple_items_allowed": True}, }, "adjusted": {"deprecated": True}, @@ -310,13 +366,19 @@ def performance( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): finviz, fmp." ), ], + chart: Annotated[ + bool, + OpenBBField( + description="Whether to create a chart or not, by default False." + ), + ] = False, provider: Annotated[ - Optional[Literal["fmp"]], + Optional[Literal["finviz", "fmp"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'finviz' if there is\n no default." ), ] = None, **kwargs @@ -326,10 +388,12 @@ def performance( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. - provider : Optional[Literal['fmp']] + Symbol to get data for. Multiple comma separated items allowed for provider(s): finviz, fmp. + chart : bool + Whether to create a chart or not, by default False. + provider : Optional[Literal['finviz', 'fmp']] The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'fmp' if there is + If None, the provider specified in defaults is selected or 'finviz' if there is no default. Returns @@ -337,7 +401,7 @@ def performance( OBBject results : List[PricePerformance] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[Literal['finviz', 'fmp']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -382,6 +446,20 @@ def performance( Ten-year return. max : Optional[float] Return from the beginning of the time series. + volatility_week : Optional[float] + One-week realized volatility, as a normalized percent. (provider: finviz) + volatility_month : Optional[float] + One-month realized volatility, as a normalized percent. (provider: finviz) + price : Optional[float] + Last Price. (provider: finviz) + volume : Optional[float] + Current volume. (provider: finviz) + average_volume : Optional[float] + Average daily volume. (provider: finviz) + relative_volume : Optional[float] + Relative volume as a ratio of current volume to average volume. (provider: finviz) + analyst_recommendation : Optional[float] + The analyst consensus, on a scale of 1-5 where 1 is a buy and 5 is a sell. (provider: finviz) Examples -------- @@ -396,14 +474,20 @@ def performance( "provider": self._get_provider( provider, "/equity/price/performance", - ("fmp",), + ("finviz", "fmp"), ) }, standard_params={ "symbol": symbol, }, extra_params=kwargs, - info={"symbol": {"fmp": {"multiple_items_allowed": True}}}, + chart=chart, + info={ + "symbol": { + "finviz": {"multiple_items_allowed": True}, + "fmp": {"multiple_items_allowed": True}, + } + }, ) ) @@ -414,13 +498,13 @@ def quote( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): cboe, fmp, intrinio, tmx, tradier, yfinance." ), ], provider: Annotated[ - Optional[Literal["fmp", "intrinio", "yfinance"]], + Optional[Literal["cboe", "fmp", "intrinio", "tmx", "tradier", "yfinance"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'cboe' if there is\n no default." ), ] = None, **kwargs @@ -430,11 +514,13 @@ def quote( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + Symbol to get data for. Multiple comma separated items allowed for provider(s): cboe, fmp, intrinio, tmx, tradier, yfinance. + provider : Optional[Literal['cboe', 'fmp', 'intrinio', 'tmx', 'tradier', 'yf... The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'fmp' if there is + If None, the provider specified in defaults is selected or 'cboe' if there is no default. + use_cache : bool + When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. (provider: cboe) source : Literal['iex', 'bats', 'bats_delayed', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed', 'intrinio_mx', 'intrinio_mx_plus', 'delayed_sip'] Source of the data. (provider: intrinio) @@ -443,7 +529,7 @@ def quote( OBBject results : List[EquityQuote] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + provider : Optional[Literal['cboe', 'fmp', 'intrinio', 'tmx', 'tradier', 'yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -520,20 +606,51 @@ def quote( The one year high (52W High). year_low : Optional[float] The one year low (52W Low). + iv30 : Optional[float] + The 30-day implied volatility of the stock. (provider: cboe) + iv30_change : Optional[float] + Change in 30-day implied volatility of the stock. (provider: cboe) + iv30_change_percent : Optional[float] + Change in 30-day implied volatility of the stock as a normalized percentage value. (provider: cboe) + iv30_annual_high : Optional[float] + The 1-year high of 30-day implied volatility. (provider: cboe) + hv30_annual_high : Optional[float] + The 1-year high of 30-day realized volatility. (provider: cboe) + iv30_annual_low : Optional[float] + The 1-year low of 30-day implied volatility. (provider: cboe) + hv30_annual_low : Optional[float] + The 1-year low of 30-dayrealized volatility. (provider: cboe) + iv60_annual_high : Optional[float] + The 1-year high of 60-day implied volatility. (provider: cboe) + hv60_annual_high : Optional[float] + The 1-year high of 60-day realized volatility. (provider: cboe) + iv60_annual_low : Optional[float] + The 1-year low of 60-day implied volatility. (provider: cboe) + hv60_annual_low : Optional[float] + The 1-year low of 60-day realized volatility. (provider: cboe) + iv90_annual_high : Optional[float] + The 1-year high of 90-day implied volatility. (provider: cboe) + hv90_annual_high : Optional[float] + The 1-year high of 90-day realized volatility. (provider: cboe) + iv90_annual_low : Optional[float] + The 1-year low of 90-day implied volatility. (provider: cboe) + hv90_annual_low : Optional[float] + The 1-year low of 90-day realized volatility. (provider: cboe) price_avg50 : Optional[float] 50 day moving average price. (provider: fmp) price_avg200 : Optional[float] 200 day moving average price. (provider: fmp) avg_volume : Optional[int] Average volume over the last 10 trading days. (provider: fmp) - market_cap : Optional[float] - Market cap of the company. (provider: fmp) + market_cap : Optional[Union[float, int]] + Market cap of the company. (provider: fmp); + Market capitalization. (provider: tmx) shares_outstanding : Optional[int] - Number of shares outstanding. (provider: fmp) - eps : Optional[float] - Earnings per share. (provider: fmp) - pe : Optional[float] - Price earnings ratio. (provider: fmp) + Number of shares outstanding. (provider: fmp, tmx) + eps : Optional[Union[float, str]] + Earnings per share. (provider: fmp, tmx) + pe : Optional[Union[float, str]] + Price earnings ratio. (provider: fmp, tmx) earnings_announcement : Optional[datetime] Upcoming earnings announcement date. (provider: fmp) is_darkpool : Optional[bool] @@ -544,6 +661,110 @@ def quote( Date and Time when the data was last updated. (provider: intrinio) security : Optional[IntrinioSecurity] Security details related to the quote. (provider: intrinio) + security_type : Optional[str] + The issuance type of the asset. (provider: tmx) + sector : Optional[str] + The sector of the asset. (provider: tmx) + industry_category : Optional[str] + The industry category of the asset. (provider: tmx) + industry_group : Optional[str] + The industry group of the asset. (provider: tmx) + vwap : Optional[float] + Volume Weighted Average Price over the period. (provider: tmx) + ma_21 : Optional[float] + Twenty-one day moving average. (provider: tmx) + ma_50 : Optional[float] + Fifty day moving average. (provider: tmx) + ma_200 : Optional[float] + Two-hundred day moving average. (provider: tmx) + volume_avg_10d : Optional[int] + Ten day average volume. (provider: tmx) + volume_avg_30d : Optional[int] + Thirty day average volume. (provider: tmx) + volume_avg_50d : Optional[int] + Fifty day average volume. (provider: tmx) + market_cap_all_classes : Optional[int] + Market capitalization of all share classes. (provider: tmx) + div_amount : Optional[float] + The most recent dividend amount. (provider: tmx) + div_currency : Optional[str] + The currency the dividend is paid in. (provider: tmx) + div_yield : Optional[float] + The dividend yield as a normalized percentage. (provider: tmx) + div_freq : Optional[str] + The frequency of dividend payments. (provider: tmx) + div_ex_date : Optional[date] + The ex-dividend date. (provider: tmx) + div_pay_date : Optional[date] + The next dividend ayment date. (provider: tmx) + div_growth_3y : Optional[Union[str, float]] + The three year dividend growth as a normalized percentage. (provider: tmx) + div_growth_5y : Optional[Union[str, float]] + The five year dividend growth as a normalized percentage. (provider: tmx) + debt_to_equity : Optional[Union[str, float]] + The debt to equity ratio. (provider: tmx) + price_to_book : Optional[Union[str, float]] + The price to book ratio. (provider: tmx) + price_to_cf : Optional[Union[str, float]] + The price to cash flow ratio. (provider: tmx) + return_on_equity : Optional[Union[str, float]] + The return on equity, as a normalized percentage. (provider: tmx) + return_on_assets : Optional[Union[str, float]] + The return on assets, as a normalized percentage. (provider: tmx) + beta : Optional[Union[str, float]] + The beta relative to the TSX Composite. (provider: tmx) + alpha : Optional[Union[str, float]] + The alpha relative to the TSX Composite. (provider: tmx) + shares_escrow : Optional[int] + The number of shares held in escrow. (provider: tmx) + shares_total : Optional[int] + The total number of shares outstanding from all classes. (provider: tmx) + last_volume : Optional[int] + The last trade volume. (provider: tradier) + volume_avg : Optional[int] + The average daily trading volume. (provider: tradier) + bid_timestamp : Optional[datetime] + Timestamp of the bid price. (provider: tradier) + ask_timestamp : Optional[datetime] + Timestamp of the ask price. (provider: tradier) + greeks_timestamp : Optional[datetime] + Timestamp of the greeks data. (provider: tradier) + underlying : Optional[str] + The underlying symbol for the option. (provider: tradier) + root_symbol : Optional[str] + The root symbol for the option. (provider: tradier) + option_type : Optional[Literal['call', 'put']] + Type of option - call or put. (provider: tradier) + contract_size : Optional[int] + The number of shares in a standard contract. (provider: tradier) + expiration_type : Optional[str] + The expiration type of the option - i.e, standard, weekly, etc. (provider: tradier) + expiration_date : Optional[date] + The expiration date of the option. (provider: tradier) + strike : Optional[float] + The strike price of the option. (provider: tradier) + open_interest : Optional[int] + The number of open contracts for the option. (provider: tradier) + bid_iv : Optional[float] + Implied volatility of the bid price. (provider: tradier) + ask_iv : Optional[float] + Implied volatility of the ask price. (provider: tradier) + mid_iv : Optional[float] + Mid-point implied volatility of the option. (provider: tradier) + orats_final_iv : Optional[float] + ORATS final implied volatility of the option. (provider: tradier) + delta : Optional[float] + Delta of the option. (provider: tradier) + gamma : Optional[float] + Gamma of the option. (provider: tradier) + theta : Optional[float] + Theta of the option. (provider: tradier) + vega : Optional[float] + Vega of the option. (provider: tradier) + rho : Optional[float] + Rho of the option. (provider: tradier) + phi : Optional[float] + Phi of the option. (provider: tradier) ma_50d : Optional[float] 50-day moving average price. (provider: yfinance) ma_200d : Optional[float] @@ -568,7 +789,7 @@ def quote( "provider": self._get_provider( provider, "/equity/price/quote", - ("fmp", "intrinio", "yfinance"), + ("cboe", "fmp", "intrinio", "tmx", "tradier", "yfinance"), ) }, standard_params={ @@ -577,8 +798,11 @@ def quote( extra_params=kwargs, info={ "symbol": { + "cboe": {"multiple_items_allowed": True}, "fmp": {"multiple_items_allowed": True}, "intrinio": {"multiple_items_allowed": True}, + "tmx": {"multiple_items_allowed": True}, + "tradier": {"multiple_items_allowed": True}, "yfinance": {"multiple_items_allowed": True}, } }, diff --git a/openbb_platform/openbb/package/equity_shorts.py b/openbb_platform/openbb/package/equity_shorts.py index 8cb08479541f..30b88ed44cda 100644 --- a/openbb_platform/openbb/package/equity_shorts.py +++ b/openbb_platform/openbb/package/equity_shorts.py @@ -13,6 +13,8 @@ class ROUTER_equity_shorts(Container): """/equity/shorts fails_to_deliver + short_interest + short_volume """ def __repr__(self) -> str: @@ -104,3 +106,165 @@ def fails_to_deliver( extra_params=kwargs, ) ) + + @exception_handler + @validate + def short_interest( + self, + symbol: Annotated[str, OpenBBField(description="Symbol to get data for.")], + provider: Annotated[ + Optional[Literal["finra"]], + OpenBBField( + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'finra' if there is\n no default." + ), + ] = None, + **kwargs + ) -> OBBject: + """Get reported short volume and days to cover data. + + Parameters + ---------- + symbol : str + Symbol to get data for. + provider : Optional[Literal['finra']] + The provider to use for the query, by default None. + If None, the provider specified in defaults is selected or 'finra' if there is + no default. + + Returns + ------- + OBBject + results : List[EquityShortInterest] + Serializable results. + provider : Optional[Literal['finra']] + Provider name. + warnings : Optional[List[Warning_]] + List of warnings. + chart : Optional[Chart] + Chart object. + extra : Dict[str, Any] + Extra info. + + EquityShortInterest + ------------------- + settlement_date : date + The mid-month short interest report is based on short positions held by members on the settlement date of the 15th of each month. If the 15th falls on a weekend or another non-settlement date, the designated settlement date will be the previous business day on which transactions settled. The end-of-month short interest report is based on short positions held on the last business day of the month on which transactions settle. Once the short position reports are received, the short interest data is compiled for each equity security and provided for publication on the 7th business day after the reporting settlement date. + symbol : str + Symbol representing the entity requested in the data. + issue_name : str + Unique identifier of the issue. + market_class : str + Primary listing market. + current_short_position : float + The total number of shares in the issue that are reflected on the books and records of the reporting firms as short as defined by Rule 200 of Regulation SHO as of the current cycle’s designated settlement date. + previous_short_position : float + The total number of shares in the issue that are reflected on the books and records of the reporting firms as short as defined by Rule 200 of Regulation SHO as of the previous cycle’s designated settlement date. + avg_daily_volume : float + Total Volume or Adjusted Volume in case of splits / Total trade days between (previous settlement date + 1) to (current settlement date). The NULL values are translated as zero. + days_to_cover : float + The number of days of average share volume it would require to buy all of the shares that were sold short during the reporting cycle. Formula: Short Interest / Average Daily Share Volume, Rounded to Hundredths. 1.00 will be displayed for any values equal or less than 1 (i.e., Average Daily Share is equal to or greater than Short Interest). N/A will be displayed If the days to cover is Zero (i.e., Average Daily Share Volume is Zero). + change : float + Change in Shares Short from Previous Cycle: Difference in short interest between the current cycle and the previous cycle. + change_pct : float + Change in Shares Short from Previous Cycle as a percent. + + Examples + -------- + >>> from openbb import obb + >>> obb.equity.shorts.short_interest(symbol='AAPL', provider='finra') + """ # noqa: E501 + + return self._run( + "/equity/shorts/short_interest", + **filter_inputs( + provider_choices={ + "provider": self._get_provider( + provider, + "/equity/shorts/short_interest", + ("finra",), + ) + }, + standard_params={ + "symbol": symbol, + }, + extra_params=kwargs, + ) + ) + + @exception_handler + @validate + def short_volume( + self, + symbol: Annotated[str, OpenBBField(description="Symbol to get data for.")], + provider: Annotated[ + Optional[Literal["stockgrid"]], + OpenBBField( + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'stockgrid' if there is\n no default." + ), + ] = None, + **kwargs + ) -> OBBject: + """Get reported Fail-to-deliver (FTD) data. + + Parameters + ---------- + symbol : str + Symbol to get data for. + provider : Optional[Literal['stockgrid']] + The provider to use for the query, by default None. + If None, the provider specified in defaults is selected or 'stockgrid' if there is + no default. + + Returns + ------- + OBBject + results : List[ShortVolume] + Serializable results. + provider : Optional[Literal['stockgrid']] + Provider name. + warnings : Optional[List[Warning_]] + List of warnings. + chart : Optional[Chart] + Chart object. + extra : Dict[str, Any] + Extra info. + + ShortVolume + ----------- + date : Optional[date] + The date of the data. + market : Optional[str] + Reporting Facility ID. N=NYSE TRF, Q=NASDAQ TRF Carteret, B=NASDAQ TRY Chicago, D=FINRA ADF + short_volume : Optional[int] + Aggregate reported share volume of executed short sale and short sale exempt trades during regular trading hours + short_exempt_volume : Optional[int] + Aggregate reported share volume of executed short sale exempt trades during regular trading hours + total_volume : Optional[int] + Aggregate reported share volume of executed trades during regular trading hours + close : Optional[float] + Closing price of the stock on the date. (provider: stockgrid) + short_volume_percent : Optional[float] + Percentage of the total volume that was short volume. (provider: stockgrid) + + Examples + -------- + >>> from openbb import obb + >>> obb.equity.shorts.short_volume(symbol='AAPL', provider='stockgrid') + """ # noqa: E501 + + return self._run( + "/equity/shorts/short_volume", + **filter_inputs( + provider_choices={ + "provider": self._get_provider( + provider, + "/equity/shorts/short_volume", + ("stockgrid",), + ) + }, + standard_params={ + "symbol": symbol, + }, + extra_params=kwargs, + ) + ) diff --git a/openbb_platform/openbb/package/etf.py b/openbb_platform/openbb/package/etf.py index 5609ba550160..8be3dab6a5f3 100644 --- a/openbb_platform/openbb/package/etf.py +++ b/openbb_platform/openbb/package/etf.py @@ -16,6 +16,7 @@ class ROUTER_etf(Container): """/etf countries + /discovery equity_exposure historical holdings @@ -37,11 +38,11 @@ def countries( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp." + description="Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, tmx." ), ], provider: Annotated[ - Optional[Literal["fmp"]], + Optional[Literal["fmp", "tmx"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -53,18 +54,20 @@ def countries( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp. - provider : Optional[Literal['fmp']] + Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, tmx. + provider : Optional[Literal['fmp', 'tmx']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. + use_cache : bool + Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. (provider: tmx) Returns ------- OBBject results : List[EtfCountries] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[Literal['fmp', 'tmx']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -91,17 +94,29 @@ def countries( "provider": self._get_provider( provider, "/etf/countries", - ("fmp",), + ("fmp", "tmx"), ) }, standard_params={ "symbol": symbol, }, extra_params=kwargs, - info={"symbol": {"fmp": {"multiple_items_allowed": True}}}, + info={ + "symbol": { + "fmp": {"multiple_items_allowed": True}, + "tmx": {"multiple_items_allowed": True}, + } + }, ) ) + @property + def discovery(self): + # pylint: disable=import-outside-toplevel + from . import etf_discovery + + return etf_discovery.ROUTER_etf_discovery(command_runner=self._command_runner) + @exception_handler @validate def equity_exposure( @@ -191,7 +206,7 @@ def historical( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon, tiingo, yfinance." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance." ), ], interval: Annotated[ @@ -206,10 +221,28 @@ def historical( Union[datetime.date, None, str], OpenBBField(description="End date of the data, in YYYY-MM-DD format."), ] = None, + chart: Annotated[ + bool, + OpenBBField( + description="Whether to create a chart or not, by default False." + ), + ] = False, provider: Annotated[ - Optional[Literal["fmp", "intrinio", "polygon", "tiingo", "yfinance"]], + Optional[ + Literal[ + "alpha_vantage", + "cboe", + "fmp", + "intrinio", + "polygon", + "tiingo", + "tmx", + "tradier", + "yfinance", + ] + ], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'alpha_vantage' if there is\n no default." ), ] = None, **kwargs @@ -219,17 +252,30 @@ def historical( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon, tiingo, yfinance. + Symbol to get data for. Multiple comma separated items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. interval : Optional[str] Time interval of the data to return. start_date : Union[datetime.date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinanc... + chart : bool + Whether to create a chart or not, by default False. + provider : Optional[Literal['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'pol... The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'fmp' if there is + If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. + adjustment : Union[Literal['splits_only', 'splits_and_dividends', 'unadjusted'], Literal['splits_only', 'unadjusted'], Literal['splits_only', 'splits_and_dividends']] + The adjustment factor to apply. 'splits_only' is not supported for intraday data. (provider: alpha_vantage); + The adjustment factor to apply. Default is splits only. (provider: polygon); + The adjustment factor to apply. Only valid for daily data. (provider: tmx); + The adjustment factor to apply. Default is splits only. (provider: yfinance) + extended_hours : Optional[bool] + Include Pre and Post market data. (provider: alpha_vantage, polygon, tradier, yfinance) + adjusted : bool + This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead. (provider: alpha_vantage, yfinance) + use_cache : bool + When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. (provider: cboe) start_time : Optional[datetime.time] Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. (provider: intrinio) end_time : Optional[datetime.time] @@ -238,18 +284,12 @@ def historical( Timezone of the data, in the IANA format (Continent/City). (provider: intrinio) source : Literal['realtime', 'delayed', 'nasdaq_basic'] The source of the data. (provider: intrinio) - adjustment : Union[Literal['splits_only', 'unadjusted'], Literal['splits_only', 'splits_and_dividends']] - The adjustment factor to apply. Default is splits only. (provider: polygon, yfinance) - extended_hours : bool - Include Pre and Post market data. (provider: polygon, yfinance) sort : Literal['asc', 'desc'] 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. (provider: polygon) limit : int The number of data entries to return. (provider: polygon) include_actions : bool Include dividends and stock splits in results. (provider: yfinance) - adjusted : bool - This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead. (provider: yfinance) prepost : bool This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead. (provider: yfinance) @@ -258,7 +298,7 @@ def historical( OBBject results : List[EtfHistorical] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']] + provider : Optional[Literal['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -279,20 +319,35 @@ def historical( The low price. close : float The close price. - volume : Optional[Union[int, float]] + volume : Optional[Union[float, int]] The trading volume. vwap : Optional[float] Volume Weighted Average Price over the period. - adj_close : Optional[float] - The adjusted close price. (provider: fmp, intrinio, tiingo) + adj_close : Optional[Union[Annotated[float, Gt(gt=0)], float]] + The adjusted close price. (provider: alpha_vantage, fmp, intrinio, tiingo) + dividend : Optional[Union[Annotated[float, Ge(ge=0)], float]] + Dividend amount, if a dividend was paid. (provider: alpha_vantage, intrinio, tiingo, yfinance) + split_ratio : Optional[Union[Annotated[float, Ge(ge=0)], float]] + Split coefficient, if a split occurred. (provider: alpha_vantage); + Ratio of the equity split, if a split occurred. (provider: intrinio); + Ratio of the equity split, if a split occurred. (provider: tiingo); + Ratio of the equity split, if a split occurred. (provider: yfinance) + calls_volume : Optional[int] + Number of calls traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) + puts_volume : Optional[int] + Number of puts traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) + total_options_volume : Optional[int] + Total number of options traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) unadjusted_volume : Optional[float] Unadjusted volume of the symbol. (provider: fmp) change : Optional[float] Change in the price from the previous close. (provider: fmp); - Change in the price of the symbol from the previous day. (provider: intrinio) + Change in the price of the symbol from the previous day. (provider: intrinio); + Change in price. (provider: tmx) change_percent : Optional[float] Change in the price from the previous close, as a normalized percent. (provider: fmp); - Percent change in the price of the symbol from the previous day. (provider: intrinio) + Percent change in the price of the symbol from the previous day. (provider: intrinio); + Change in price, as a normalized percentage. (provider: tmx) average : Optional[float] Average trade price of an individual equity during the interval. (provider: intrinio) adj_open : Optional[float] @@ -309,18 +364,19 @@ def historical( 52 week low price for the symbol. (provider: intrinio) factor : Optional[float] factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices. (provider: intrinio) - split_ratio : Optional[float] - Ratio of the equity split, if a split occurred. (provider: intrinio, tiingo, yfinance) - dividend : Optional[float] - Dividend amount, if a dividend was paid. (provider: intrinio, tiingo, yfinance) close_time : Optional[datetime] The timestamp that represents the end of the interval span. (provider: intrinio) interval : Optional[str] The data time frequency. (provider: intrinio) intra_period : Optional[bool] 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 (provider: intrinio) - transactions : Optional[Annotated[int, Gt(gt=0)]] - Number of transactions for the symbol in the time period. (provider: polygon) + transactions : Optional[Union[Annotated[int, Gt(gt=0)], int]] + Number of transactions for the symbol in the time period. (provider: polygon); + Total number of transactions recorded. (provider: tmx) + transactions_value : Optional[float] + Nominal value of recorded transactions. (provider: tmx) + last_price : Optional[float] + The last price of the equity. (provider: tradier) Examples -------- @@ -338,7 +394,17 @@ def historical( "provider": self._get_provider( provider, "/etf/historical", - ("fmp", "intrinio", "polygon", "tiingo", "yfinance"), + ( + "alpha_vantage", + "cboe", + "fmp", + "intrinio", + "polygon", + "tiingo", + "tmx", + "tradier", + "yfinance", + ), ) }, standard_params={ @@ -348,11 +414,16 @@ def historical( "end_date": end_date, }, extra_params=kwargs, + chart=chart, info={ "symbol": { + "alpha_vantage": {"multiple_items_allowed": True}, + "cboe": {"multiple_items_allowed": True}, "fmp": {"multiple_items_allowed": True}, "polygon": {"multiple_items_allowed": True}, "tiingo": {"multiple_items_allowed": True}, + "tmx": {"multiple_items_allowed": True}, + "tradier": {"multiple_items_allowed": True}, "yfinance": {"multiple_items_allowed": True}, }, "adjusted": {"deprecated": True}, @@ -368,8 +439,14 @@ def holdings( symbol: Annotated[ str, OpenBBField(description="Symbol to get data for. (ETF)") ], + chart: Annotated[ + bool, + OpenBBField( + description="Whether to create a chart or not, by default False." + ), + ] = False, provider: Annotated[ - Optional[Literal["fmp", "intrinio", "sec"]], + Optional[Literal["fmp", "intrinio", "sec", "tmx"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -382,7 +459,9 @@ def holdings( ---------- symbol : str Symbol to get data for. (ETF) - provider : Optional[Literal['fmp', 'intrinio', 'sec']] + chart : bool + Whether to create a chart or not, by default False. + provider : Optional[Literal['fmp', 'intrinio', 'sec', 'tmx']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. @@ -393,14 +472,15 @@ def holdings( cik : Optional[str] The CIK of the filing entity. Overrides symbol. (provider: fmp) use_cache : bool - Whether or not to use cache for the request. (provider: sec) + Whether or not to use cache for the request. (provider: sec); + Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. (provider: tmx) Returns ------- OBBject results : List[EtfHoldings] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'sec']] + provider : Optional[Literal['fmp', 'intrinio', 'sec', 'tmx']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -431,12 +511,13 @@ def holdings( The type of units. (provider: fmp); The units of the holding. (provider: sec) currency : Optional[str] - The currency of the holding. (provider: fmp, sec) + The currency of the holding. (provider: fmp, sec, tmx) value : Optional[float] The value of the holding, in dollars. (provider: fmp, intrinio, sec) weight : Optional[float] The weight of the holding, as a normalized percent. (provider: fmp, intrinio); - The weight of the holding in ETF in %. (provider: sec) + The weight of the holding in ETF in %. (provider: sec); + The weight of the asset in the portfolio, as a normalized percentage. (provider: tmx) payoff_profile : Optional[str] The payoff profile of the holding. (provider: fmp, sec) asset_category : Optional[str] @@ -444,7 +525,7 @@ def holdings( issuer_category : Optional[str] The issuer category of the holding. (provider: fmp, sec) country : Optional[str] - The country of the holding. (provider: fmp, intrinio, sec) + The country of the holding. (provider: fmp, intrinio, sec, tmx) is_restricted : Optional[str] Whether the holding is restricted. (provider: fmp, sec) fair_value_level : Optional[int] @@ -594,6 +675,20 @@ def holdings( The currency of the derivative's notional amount. (provider: sec) unrealized_gain : Optional[float] The unrealized gain or loss on the derivative. (provider: sec) + shares : Optional[Union[int, str]] + The value of the assets under management. (provider: tmx) + market_value : Optional[Union[str, float]] + The market value of the holding. (provider: tmx) + share_percentage : Optional[float] + The share percentage of the holding, as a normalized percentage. (provider: tmx) + share_change : Optional[Union[str, float]] + The change in shares of the holding. (provider: tmx) + exchange : Optional[str] + The exchange code of the holding. (provider: tmx) + type_id : Optional[str] + The holding type ID of the asset. (provider: tmx) + fund_id : Optional[str] + The fund ID of the asset. (provider: tmx) Examples -------- @@ -612,13 +707,14 @@ def holdings( "provider": self._get_provider( provider, "/etf/holdings", - ("fmp", "intrinio", "sec"), + ("fmp", "intrinio", "sec", "tmx"), ) }, standard_params={ "symbol": symbol, }, extra_params=kwargs, + chart=chart, ) ) @@ -814,11 +910,11 @@ def info( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance." + description="Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, intrinio, tmx, yfinance." ), ], provider: Annotated[ - Optional[Literal["fmp", "intrinio", "yfinance"]], + Optional[Literal["fmp", "intrinio", "tmx", "yfinance"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -830,18 +926,20 @@ def info( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, intrinio, tmx, yfinance. + provider : Optional[Literal['fmp', 'intrinio', 'tmx', 'yfinance']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. + use_cache : bool + Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. (provider: tmx) Returns ------- OBBject results : List[EtfInfo] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + provider : Optional[Literal['fmp', 'intrinio', 'tmx', 'yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -862,7 +960,8 @@ def info( Inception date of the ETF. issuer : Optional[str] Company of the ETF. (provider: fmp); - Issuer of the ETF. (provider: intrinio) + Issuer of the ETF. (provider: intrinio); + The issuer of the ETF. (provider: tmx) cusip : Optional[str] CUSIP of the ETF. (provider: fmp) isin : Optional[str] @@ -875,7 +974,8 @@ def info( Asset class of the ETF. (provider: fmp); Captures the underlying nature of the securities in the Exchanged Traded Product (ETP). (provider: intrinio) aum : Optional[float] - Assets under management. (provider: fmp) + Assets under management. (provider: fmp); + The AUM of the ETF. (provider: tmx) nav : Optional[float] Net asset value of the ETF. (provider: fmp) nav_currency : Optional[str] @@ -884,10 +984,12 @@ def info( The expense ratio, as a normalized percent. (provider: fmp) holdings_count : Optional[int] Number of holdings. (provider: fmp) - avg_volume : Optional[float] - Average daily trading volume. (provider: fmp) + avg_volume : Optional[Union[float, int]] + Average daily trading volume. (provider: fmp); + The average daily volume of the ETF. (provider: tmx) website : Optional[str] - Website of the issuer. (provider: fmp) + Website of the issuer. (provider: fmp); + The website of the ETF. (provider: tmx) fund_listing_date : Optional[date] The date on which the Exchange Traded Product (ETP) or share class of the ETP is listed on a specific exchange. (provider: intrinio) data_change_date : Optional[date] @@ -929,7 +1031,7 @@ def info( This field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor. (provider: intrinio); The fund family. (provider: yfinance) investment_style : Optional[str] - Investment style of the ETF. (provider: intrinio) + Investment style of the ETF. (provider: intrinio, tmx) derivatives_based : Optional[str] This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio. (provider: intrinio) income_category : Optional[str] @@ -1110,14 +1212,55 @@ def info( Gross expense net of Fee Waivers, as a percentage of net assets as published by the ETF issuer. (provider: intrinio) etf_portfolio_turnover : Optional[float] The percentage of positions turned over in the last 12 months. (provider: intrinio) + esg : Optional[bool] + Whether the ETF qualifies as an ESG fund. (provider: tmx) + currency : Optional[str] + The currency of the ETF. (provider: tmx); + The currency in which the fund is listed. (provider: yfinance) + unit_price : Optional[float] + The unit price of the ETF. (provider: tmx) + close : Optional[float] + The closing price of the ETF. (provider: tmx) + prev_close : Optional[float] + The previous closing price of the ETF. (provider: tmx, yfinance) + return_1m : Optional[float] + The one-month return of the ETF, as a normalized percent (provider: tmx) + return_3m : Optional[float] + The three-month return of the ETF, as a normalized percent. (provider: tmx) + return_6m : Optional[float] + The six-month return of the ETF, as a normalized percent. (provider: tmx) + return_ytd : Optional[float] + The year-to-date return of the ETF, as a normalized percent. (provider: tmx, yfinance) + return_1y : Optional[float] + The one-year return of the ETF, as a normalized percent. (provider: tmx) + return_3y : Optional[float] + The three-year return of the ETF, as a normalized percent. (provider: tmx) + return_5y : Optional[float] + The five-year return of the ETF, as a normalized percent. (provider: tmx) + return_10y : Optional[float] + The ten-year return of the ETF, as a normalized percent. (provider: tmx) + return_from_inception : Optional[float] + The return from inception of the ETF, as a normalized percent. (provider: tmx) + avg_volume_30d : Optional[int] + The 30-day average volume of the ETF. (provider: tmx) + pe_ratio : Optional[float] + The price-to-earnings ratio of the ETF. (provider: tmx) + pb_ratio : Optional[float] + The price-to-book ratio of the ETF. (provider: tmx) + management_fee : Optional[float] + The management fee of the ETF, as a normalized percent. (provider: tmx) + mer : Optional[float] + The management expense ratio of the ETF, as a normalized percent. (provider: tmx) + distribution_yield : Optional[float] + The distribution yield of the ETF, as a normalized percent. (provider: tmx) + dividend_frequency : Optional[str] + The dividend payment frequency of the ETF. (provider: tmx) fund_type : Optional[str] The legal type of fund. (provider: yfinance) category : Optional[str] The fund category. (provider: yfinance) exchange_timezone : Optional[str] The timezone of the exchange. (provider: yfinance) - currency : Optional[str] - The currency in which the fund is listed. (provider: yfinance) nav_price : Optional[float] The net asset value per unit of the fund. (provider: yfinance) total_assets : Optional[int] @@ -1138,8 +1281,6 @@ def info( 50-day moving average price. (provider: yfinance) ma_200d : Optional[float] 200-day moving average price. (provider: yfinance) - return_ytd : Optional[float] - The year-to-date return of the fund, as a normalized percent. (provider: yfinance) return_3y_avg : Optional[float] The three year average return of the fund, as a normalized percent. (provider: yfinance) return_5y_avg : Optional[float] @@ -1166,8 +1307,6 @@ def info( The lowest price of the most recent trading session. (provider: yfinance) volume : Optional[int] The trading volume of the most recent trading session. (provider: yfinance) - prev_close : Optional[float] - The previous closing price. (provider: yfinance) Examples -------- @@ -1184,7 +1323,7 @@ def info( "provider": self._get_provider( provider, "/etf/info", - ("fmp", "intrinio", "yfinance"), + ("fmp", "intrinio", "tmx", "yfinance"), ) }, standard_params={ @@ -1195,6 +1334,7 @@ def info( "symbol": { "fmp": {"multiple_items_allowed": True}, "intrinio": {"multiple_items_allowed": True}, + "tmx": {"multiple_items_allowed": True}, "yfinance": {"multiple_items_allowed": True}, } }, @@ -1208,13 +1348,19 @@ def price_performance( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): finviz, fmp, intrinio." ), ], + chart: Annotated[ + bool, + OpenBBField( + description="Whether to create a chart or not, by default False." + ), + ] = False, provider: Annotated[ - Optional[Literal["fmp", "intrinio"]], + Optional[Literal["finviz", "fmp", "intrinio"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'finviz' if there is\n no default." ), ] = None, **kwargs @@ -1224,10 +1370,12 @@ def price_performance( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio. - provider : Optional[Literal['fmp', 'intrinio']] + Symbol to get data for. Multiple comma separated items allowed for provider(s): finviz, fmp, intrinio. + chart : bool + Whether to create a chart or not, by default False. + provider : Optional[Literal['finviz', 'fmp', 'intrinio']] The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'fmp' if there is + If None, the provider specified in defaults is selected or 'finviz' if there is no default. return_type : Literal['trailing', 'calendar'] The type of returns to return, a trailing or calendar window. (provider: intrinio) @@ -1239,7 +1387,7 @@ def price_performance( OBBject results : List[EtfPricePerformance] Serializable results. - provider : Optional[Literal['fmp', 'intrinio']] + provider : Optional[Literal['finviz', 'fmp', 'intrinio']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -1284,6 +1432,21 @@ def price_performance( Ten-year return. max : Optional[float] Return from the beginning of the time series. + volatility_week : Optional[float] + One-week realized volatility, as a normalized percent. (provider: finviz) + volatility_month : Optional[float] + One-month realized volatility, as a normalized percent. (provider: finviz) + price : Optional[float] + Last Price. (provider: finviz) + volume : Optional[Union[float, int]] + Current volume. (provider: finviz); + The trading volume. (provider: intrinio) + average_volume : Optional[float] + Average daily volume. (provider: finviz) + relative_volume : Optional[float] + Relative volume as a ratio of current volume to average volume. (provider: finviz) + analyst_recommendation : Optional[float] + The analyst consensus, on a scale of 1-5 where 1 is a buy and 5 is a sell. (provider: finviz) max_annualized : Optional[float] Annualized rate of return from inception. (provider: intrinio) volatility_one_year : Optional[float] @@ -1292,8 +1455,6 @@ def price_performance( Trailing three-year annualized volatility. (provider: intrinio) volatility_five_year : Optional[float] Trailing five-year annualized volatility. (provider: intrinio) - volume : Optional[int] - The trading volume. (provider: intrinio) volume_avg_30 : Optional[float] The one-month average daily volume. (provider: intrinio) volume_avg_90 : Optional[float] @@ -1329,15 +1490,17 @@ def price_performance( "provider": self._get_provider( provider, "/etf/price_performance", - ("fmp", "intrinio"), + ("finviz", "fmp", "intrinio"), ) }, standard_params={ "symbol": symbol, }, extra_params=kwargs, + chart=chart, info={ "symbol": { + "finviz": {"multiple_items_allowed": True}, "fmp": {"multiple_items_allowed": True}, "intrinio": {"multiple_items_allowed": True}, } @@ -1351,7 +1514,7 @@ def search( self, query: Annotated[Optional[str], OpenBBField(description="Search query.")] = "", provider: Annotated[ - Optional[Literal["fmp", "intrinio"]], + Optional[Literal["fmp", "intrinio", "tmx"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -1367,7 +1530,7 @@ def search( ---------- query : Optional[str] Search query. - provider : Optional[Literal['fmp', 'intrinio']] + provider : Optional[Literal['fmp', 'intrinio', 'tmx']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. @@ -1376,13 +1539,19 @@ def search( Target a specific exchange by providing the MIC code. (provider: intrinio) is_active : Optional[Literal[True, False]] Whether the ETF is actively trading. (provider: fmp) + div_freq : Optional[Literal['monthly', 'annually', 'quarterly']] + The dividend payment frequency. (provider: tmx) + sort_by : Optional[Literal['nav', 'return_1m', 'return_3m', 'return_6m', 'return_1y', 'return_3y', 'return_ytd', 'beta_1y', 'volume_avg_daily', 'management_fee', 'distribution_yield', 'pb_ratio', 'pe_ratio']] + The column to sort by. (provider: tmx) + use_cache : bool + Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. (provider: tmx) Returns ------- OBBject results : List[EtfSearch] Serializable results. - provider : Optional[Literal['fmp', 'intrinio']] + provider : Optional[Literal['fmp', 'intrinio', 'tmx']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -1430,6 +1599,70 @@ def search( The Stock Exchange Daily Official List. (provider: intrinio) intrinio_id : Optional[str] The unique Intrinio ID for the security. (provider: intrinio) + short_name : Optional[str] + The short name of the ETF. (provider: tmx) + inception_date : Optional[str] + The inception date of the ETF. (provider: tmx) + issuer : Optional[str] + The issuer of the ETF. (provider: tmx) + investment_style : Optional[str] + The investment style of the ETF. (provider: tmx) + esg : Optional[bool] + Whether the ETF qualifies as an ESG fund. (provider: tmx) + currency : Optional[str] + The currency of the ETF. (provider: tmx) + unit_price : Optional[float] + The unit price of the ETF. (provider: tmx) + close : Optional[float] + The closing price of the ETF. (provider: tmx) + prev_close : Optional[float] + The previous closing price of the ETF. (provider: tmx) + return_1m : Optional[float] + The one-month return of the ETF, as a normalized percent. (provider: tmx) + return_3m : Optional[float] + The three-month return of the ETF, as a normalized percent. (provider: tmx) + return_6m : Optional[float] + The six-month return of the ETF, as a normalized percent. (provider: tmx) + return_ytd : Optional[float] + The year-to-date return of the ETF, as a normalized percent. (provider: tmx) + return_1y : Optional[float] + The one-year return of the ETF, as a normalized percent. (provider: tmx) + beta_1y : Optional[float] + The one-year beta of the ETF, as a normalized percent. (provider: tmx) + return_3y : Optional[float] + The three-year return of the ETF, as a normalized percent. (provider: tmx) + beta_3y : Optional[float] + The three-year beta of the ETF, as a normalized percent. (provider: tmx) + return_5y : Optional[float] + The five-year return of the ETF, as a normalized percent. (provider: tmx) + beta_5y : Optional[float] + The five-year beta of the ETF, as a normalized percent. (provider: tmx) + return_10y : Optional[float] + The ten-year return of the ETF, as a normalized percent. (provider: tmx) + beta_10y : Optional[float] + The ten-year beta of the ETF. (provider: tmx) + beta_15y : Optional[float] + The fifteen-year beta of the ETF. (provider: tmx) + return_from_inception : Optional[float] + The return from inception of the ETF, as a normalized percent. (provider: tmx) + avg_volume : Optional[int] + The average daily volume of the ETF. (provider: tmx) + avg_volume_30d : Optional[int] + The 30-day average volume of the ETF. (provider: tmx) + aum : Optional[float] + The AUM of the ETF. (provider: tmx) + pe_ratio : Optional[float] + The price-to-earnings ratio of the ETF. (provider: tmx) + pb_ratio : Optional[float] + The price-to-book ratio of the ETF. (provider: tmx) + management_fee : Optional[float] + The management fee of the ETF, as a normalized percent. (provider: tmx) + mer : Optional[float] + The management expense ratio of the ETF, as a normalized percent. (provider: tmx) + distribution_yield : Optional[float] + The distribution yield of the ETF, as a normalized percent. (provider: tmx) + dividend_frequency : Optional[str] + The dividend payment frequency of the ETF. (provider: tmx) Examples -------- @@ -1447,7 +1680,7 @@ def search( "provider": self._get_provider( provider, "/etf/search", - ("fmp", "intrinio"), + ("fmp", "intrinio", "tmx"), ) }, standard_params={ @@ -1465,7 +1698,7 @@ def sectors( str, OpenBBField(description="Symbol to get data for. (ETF)") ], provider: Annotated[ - Optional[Literal["fmp"]], + Optional[Literal["fmp", "tmx"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -1478,17 +1711,19 @@ def sectors( ---------- symbol : str Symbol to get data for. (ETF) - provider : Optional[Literal['fmp']] + provider : Optional[Literal['fmp', 'tmx']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. + use_cache : bool + Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. (provider: tmx) Returns ------- OBBject results : List[EtfSectors] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[Literal['fmp', 'tmx']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -1517,7 +1752,7 @@ def sectors( "provider": self._get_provider( provider, "/etf/sectors", - ("fmp",), + ("fmp", "tmx"), ) }, standard_params={ diff --git a/openbb_platform/openbb/package/fixedincome_corporate.py b/openbb_platform/openbb/package/fixedincome_corporate.py index 47da6e18862e..182a82fd6cef 100644 --- a/openbb_platform/openbb/package/fixedincome_corporate.py +++ b/openbb_platform/openbb/package/fixedincome_corporate.py @@ -13,6 +13,7 @@ class ROUTER_fixedincome_corporate(Container): """/fixedincome/corporate + bond_prices commercial_paper hqm ice_bofa @@ -23,6 +24,181 @@ class ROUTER_fixedincome_corporate(Container): def __repr__(self) -> str: return self.__doc__ or "" + @exception_handler + @validate + def bond_prices( + self, + country: Annotated[ + Optional[str], + OpenBBField(description="The country to get data. Matches partial name."), + ] = None, + issuer_name: Annotated[ + Optional[str], + OpenBBField( + description="Name of the issuer. Returns partial matches and is case insensitive." + ), + ] = None, + isin: Annotated[ + Union[List, str, None], + OpenBBField( + description="International Securities Identification Number(s) of the bond(s)." + ), + ] = None, + lei: Annotated[ + Optional[str], + OpenBBField(description="Legal Entity Identifier of the issuing entity."), + ] = None, + currency: Annotated[ + Union[List, str, None], + OpenBBField( + description="Currency of the bond. Formatted as the 3-letter ISO 4217 code (e.g. GBP, EUR, USD)." + ), + ] = None, + coupon_min: Annotated[ + Optional[float], OpenBBField(description="Minimum coupon rate of the bond.") + ] = None, + coupon_max: Annotated[ + Optional[float], OpenBBField(description="Maximum coupon rate of the bond.") + ] = None, + issued_amount_min: Annotated[ + Optional[int], OpenBBField(description="Minimum issued amount of the bond.") + ] = None, + issued_amount_max: Annotated[ + Optional[str], OpenBBField(description="Maximum issued amount of the bond.") + ] = None, + maturity_date_min: Annotated[ + Optional[datetime.date], + OpenBBField(description="Minimum maturity date of the bond."), + ] = None, + maturity_date_max: Annotated[ + Optional[datetime.date], + OpenBBField(description="Maximum maturity date of the bond."), + ] = None, + provider: Annotated[ + Optional[Literal["tmx"]], + OpenBBField( + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'tmx' if there is\n no default." + ), + ] = None, + **kwargs + ) -> OBBject: + """Corporate Bond Prices. + + Parameters + ---------- + country : Optional[str] + The country to get data. Matches partial name. + issuer_name : Optional[str] + Name of the issuer. Returns partial matches and is case insensitive. + isin : Union[List, str, None] + International Securities Identification Number(s) of the bond(s). + lei : Optional[str] + Legal Entity Identifier of the issuing entity. + currency : Union[List, str, None] + Currency of the bond. Formatted as the 3-letter ISO 4217 code (e.g. GBP, EUR, USD). + coupon_min : Optional[float] + Minimum coupon rate of the bond. + coupon_max : Optional[float] + Maximum coupon rate of the bond. + issued_amount_min : Optional[int] + Minimum issued amount of the bond. + issued_amount_max : Optional[str] + Maximum issued amount of the bond. + maturity_date_min : Optional[datetime.date] + Minimum maturity date of the bond. + maturity_date_max : Optional[datetime.date] + Maximum maturity date of the bond. + provider : Optional[Literal['tmx']] + The provider to use for the query, by default None. + If None, the provider specified in defaults is selected or 'tmx' if there is + no default. + issue_date_min : Optional[datetime.date] + Filter by the minimum original issue date. (provider: tmx) + issue_date_max : Optional[datetime.date] + Filter by the maximum original issue date. (provider: tmx) + last_traded_min : Optional[datetime.date] + Filter by the minimum last trade date. (provider: tmx) + use_cache : bool + All bond data is sourced from a single JSON file that is updated daily. The file is cached for one day to eliminate downloading more than once. Caching will significantly speed up subsequent queries. To bypass, set to False. (provider: tmx) + + Returns + ------- + OBBject + results : List[BondPrices] + Serializable results. + provider : Optional[Literal['tmx']] + Provider name. + warnings : Optional[List[Warning_]] + List of warnings. + chart : Optional[Chart] + Chart object. + extra : Dict[str, Any] + Extra info. + + BondPrices + ---------- + isin : Optional[str] + International Securities Identification Number of the bond. + lei : Optional[str] + Legal Entity Identifier of the issuing entity. + figi : Optional[str] + FIGI of the bond. + cusip : Optional[str] + CUSIP of the bond. + coupon_rate : Optional[float] + Coupon rate of the bond. + ytm : Optional[float] + Yield to maturity (YTM) is the rate of return anticipated on a bond if it is held until the maturity date. It takes into account the current market price, par value, coupon rate and time to maturity. It is assumed that all coupons are reinvested at the same rate. Values are returned as a normalized percent. (provider: tmx) + price : Optional[float] + The last price for the bond. (provider: tmx) + highest_price : Optional[float] + The highest price for the bond on the last traded date. (provider: tmx) + lowest_price : Optional[float] + The lowest price for the bond on the last traded date. (provider: tmx) + total_trades : Optional[int] + Total number of trades on the last traded date. (provider: tmx) + last_traded_date : Optional[date] + Last traded date of the bond. (provider: tmx) + maturity_date : Optional[date] + Maturity date of the bond. (provider: tmx) + issue_date : Optional[date] + Issue date of the bond. This is the date when the bond first accrues interest. (provider: tmx) + issuer_name : Optional[str] + Name of the issuing entity. (provider: tmx) + + Examples + -------- + >>> from openbb import obb + >>> obb.fixedincome.corporate.bond_prices(provider='tmx') + """ # noqa: E501 + + return self._run( + "/fixedincome/corporate/bond_prices", + **filter_inputs( + provider_choices={ + "provider": self._get_provider( + provider, + "/fixedincome/corporate/bond_prices", + ("tmx",), + ) + }, + standard_params={ + "country": country, + "issuer_name": issuer_name, + "isin": isin, + "lei": lei, + "currency": currency, + "coupon_min": coupon_min, + "coupon_max": coupon_max, + "issued_amount_min": issued_amount_min, + "issued_amount_max": issued_amount_max, + "maturity_date_min": maturity_date_min, + "maturity_date_max": maturity_date_max, + }, + extra_params=kwargs, + ) + ) + @exception_handler @validate def commercial_paper( diff --git a/openbb_platform/openbb/package/fixedincome_government.py b/openbb_platform/openbb/package/fixedincome_government.py index 7bf4e522c836..4a32701af147 100644 --- a/openbb_platform/openbb/package/fixedincome_government.py +++ b/openbb_platform/openbb/package/fixedincome_government.py @@ -13,6 +13,9 @@ class ROUTER_fixedincome_government(Container): """/fixedincome/government + eu_yield_curve + treasury_auctions + treasury_prices treasury_rates us_yield_curve """ @@ -20,6 +23,575 @@ class ROUTER_fixedincome_government(Container): def __repr__(self) -> str: return self.__doc__ or "" + @exception_handler + @validate + def eu_yield_curve( + self, + date: Annotated[ + Union[datetime.date, None, str], + OpenBBField(description="A specific date to get data for."), + ] = None, + provider: Annotated[ + Optional[Literal["ecb"]], + OpenBBField( + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'ecb' if there is\n no default." + ), + ] = None, + **kwargs + ) -> OBBject: + """Euro Area Yield Curve. + + Gets euro area yield curve data from ECB. + + The graphic depiction of the relationship between the yield on bonds of the same credit quality but different + maturities is known as the yield curve. In the past, most market participants have constructed yield curves from + the observations of prices and yields in the Treasury market. Two reasons account for this tendency. First, + Treasury securities are viewed as free of default risk, and differences in creditworthiness do not affect yield + estimates. Second, as the most active bond market, the Treasury market offers the fewest problems of illiquidity + or infrequent trading. The key function of the Treasury yield curve is to serve as a benchmark for pricing bonds + and setting yields in other sectors of the debt market. + + It is clear that the market’s expectations of future rate changes are one important determinant of the + yield-curve shape. For example, a steeply upward-sloping curve may indicate market expectations of near-term Fed + tightening or of rising inflation. However, it may be too restrictive to assume that the yield differences across + bonds with different maturities only reflect the market’s rate expectations. The well-known pure expectations + hypothesis has such an extreme implication. The pure expectations hypothesis asserts that all government bonds + have the same near-term expected return (as the nominally riskless short-term bond) because the return-seeking + activity of risk-neutral traders removes all expected return differentials across bonds. + + + Parameters + ---------- + date : Union[datetime.date, None, str] + A specific date to get data for. + provider : Optional[Literal['ecb']] + The provider to use for the query, by default None. + If None, the provider specified in defaults is selected or 'ecb' if there is + no default. + rating : Literal['aaa', 'all_ratings'] + The rating type, either 'aaa' or 'all_ratings'. (provider: ecb) + yield_curve_type : Literal['spot_rate', 'instantaneous_forward', 'par_yield'] + The yield curve type. (provider: ecb) + + Returns + ------- + OBBject + results : List[EUYieldCurve] + Serializable results. + provider : Optional[Literal['ecb']] + Provider name. + warnings : Optional[List[Warning_]] + List of warnings. + chart : Optional[Chart] + Chart object. + extra : Dict[str, Any] + Extra info. + + EUYieldCurve + ------------ + maturity : Optional[float] + Maturity, in years. + rate : Optional[float] + Yield curve rate, as a normalized percent. + + Examples + -------- + >>> from openbb import obb + >>> obb.fixedincome.government.eu_yield_curve(provider='ecb') + >>> obb.fixedincome.government.eu_yield_curve(yield_curve_type='spot_rate', provider='ecb') + """ # noqa: E501 + + return self._run( + "/fixedincome/government/eu_yield_curve", + **filter_inputs( + provider_choices={ + "provider": self._get_provider( + provider, + "/fixedincome/government/eu_yield_curve", + ("ecb",), + ) + }, + standard_params={ + "date": date, + }, + extra_params=kwargs, + ) + ) + + @exception_handler + @validate + def treasury_auctions( + self, + security_type: Annotated[ + Literal["Bill", "Note", "Bond", "CMB", "TIPS", "FRN", None], + OpenBBField( + description="Used to only return securities of a particular type." + ), + ] = None, + cusip: Annotated[ + Optional[str], OpenBBField(description="Filter securities by CUSIP.") + ] = None, + page_size: Annotated[ + Optional[int], + OpenBBField( + description="Maximum number of results to return; you must also include pagenum when using pagesize." + ), + ] = None, + page_num: Annotated[ + Optional[int], + OpenBBField( + description="The first page number to display results for; used in combination with page size." + ), + ] = None, + start_date: Annotated[ + Union[datetime.date, None, str], + OpenBBField( + description="Start date of the data, in YYYY-MM-DD format. The default is 90 days ago." + ), + ] = None, + end_date: Annotated[ + Union[datetime.date, None, str], + OpenBBField( + description="End date of the data, in YYYY-MM-DD format. The default is today." + ), + ] = None, + provider: Annotated[ + Optional[Literal["government_us"]], + OpenBBField( + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'government_us' if there is\n no default." + ), + ] = None, + **kwargs + ) -> OBBject: + """Government Treasury Auctions. + + Parameters + ---------- + security_type : Literal['Bill', 'Note', 'Bond', 'CMB', 'TIPS', 'FRN', None] + Used to only return securities of a particular type. + cusip : Optional[str] + Filter securities by CUSIP. + page_size : Optional[int] + Maximum number of results to return; you must also include pagenum when using pagesize. + page_num : Optional[int] + The first page number to display results for; used in combination with page size. + start_date : Union[datetime.date, None, str] + Start date of the data, in YYYY-MM-DD format. The default is 90 days ago. + end_date : Union[datetime.date, None, str] + End date of the data, in YYYY-MM-DD format. The default is today. + provider : Optional[Literal['government_us']] + The provider to use for the query, by default None. + If None, the provider specified in defaults is selected or 'government_us' if there is + no default. + + Returns + ------- + OBBject + results : List[TreasuryAuctions] + Serializable results. + provider : Optional[Literal['government_us']] + Provider name. + warnings : Optional[List[Warning_]] + List of warnings. + chart : Optional[Chart] + Chart object. + extra : Dict[str, Any] + Extra info. + + TreasuryAuctions + ---------------- + cusip : str + CUSIP of the Security. + issue_date : date + The issue date of the security. + security_type : Literal['Bill', 'Note', 'Bond', 'CMB', 'TIPS', 'FRN'] + The type of security. + security_term : str + The term of the security. + maturity_date : date + The maturity date of the security. + interest_rate : Optional[float] + The interest rate of the security. + cpi_on_issue_date : Optional[float] + Reference CPI rate on the issue date of the security. + cpi_on_dated_date : Optional[float] + Reference CPI rate on the dated date of the security. + announcement_date : Optional[date] + The announcement date of the security. + auction_date : Optional[date] + The auction date of the security. + auction_date_year : Optional[int] + The auction date year of the security. + dated_date : Optional[date] + The dated date of the security. + first_payment_date : Optional[date] + The first payment date of the security. + accrued_interest_per_100 : Optional[float] + Accrued interest per $100. + accrued_interest_per_1000 : Optional[float] + Accrued interest per $1000. + adjusted_accrued_interest_per_100 : Optional[float] + Adjusted accrued interest per $100. + adjusted_accrued_interest_per_1000 : Optional[float] + Adjusted accrued interest per $1000. + adjusted_price : Optional[float] + Adjusted price. + allocation_percentage : Optional[float] + Allocation percentage, as normalized percentage points. + allocation_percentage_decimals : Optional[float] + The number of decimals in the Allocation percentage. + announced_cusip : Optional[str] + The announced CUSIP of the security. + auction_format : Optional[str] + The auction format of the security. + avg_median_discount_rate : Optional[float] + The average median discount rate of the security. + avg_median_investment_rate : Optional[float] + The average median investment rate of the security. + avg_median_price : Optional[float] + The average median price paid for the security. + avg_median_discount_margin : Optional[float] + The average median discount margin of the security. + avg_median_yield : Optional[float] + The average median yield of the security. + back_dated : Optional[Literal['Yes', 'No']] + Whether the security is back dated. + back_dated_date : Optional[date] + The back dated date of the security. + bid_to_cover_ratio : Optional[float] + The bid to cover ratio of the security. + call_date : Optional[date] + The call date of the security. + callable : Optional[Literal['Yes', 'No']] + Whether the security is callable. + called_date : Optional[date] + The called date of the security. + cash_management_bill : Optional[Literal['Yes', 'No']] + Whether the security is a cash management bill. + closing_time_competitive : Optional[str] + The closing time for competitive bids on the security. + closing_time_non_competitive : Optional[str] + The closing time for non-competitive bids on the security. + competitive_accepted : Optional[int] + The accepted value for competitive bids on the security. + competitive_accepted_decimals : Optional[int] + The number of decimals in the Competitive Accepted. + competitive_tendered : Optional[int] + The tendered value for competitive bids on the security. + competitive_tenders_accepted : Optional[Literal['Yes', 'No']] + Whether competitive tenders are accepted on the security. + corp_us_cusip : Optional[str] + The CUSIP of the security. + cpi_base_reference_period : Optional[str] + The CPI base reference period of the security. + currently_outstanding : Optional[int] + The currently outstanding value on the security. + direct_bidder_accepted : Optional[int] + The accepted value from direct bidders on the security. + direct_bidder_tendered : Optional[int] + The tendered value from direct bidders on the security. + est_amount_of_publicly_held_maturing_security : Optional[int] + The estimated amount of publicly held maturing securities on the security. + fima_included : Optional[Literal['Yes', 'No']] + Whether the security is included in the FIMA (Foreign and International Money Authorities). + fima_non_competitive_accepted : Optional[int] + The non-competitive accepted value on the security from FIMAs. + fima_non_competitive_tendered : Optional[int] + The non-competitive tendered value on the security from FIMAs. + first_interest_period : Optional[str] + The first interest period of the security. + first_interest_payment_date : Optional[date] + The first interest payment date of the security. + floating_rate : Optional[Literal['Yes', 'No']] + Whether the security is a floating rate. + frn_index_determination_date : Optional[date] + The FRN index determination date of the security. + frn_index_determination_rate : Optional[float] + The FRN index determination rate of the security. + high_discount_rate : Optional[float] + The high discount rate of the security. + high_investment_rate : Optional[float] + The high investment rate of the security. + high_price : Optional[float] + The high price of the security at auction. + high_discount_margin : Optional[float] + The high discount margin of the security. + high_yield : Optional[float] + The high yield of the security at auction. + index_ratio_on_issue_date : Optional[float] + The index ratio on the issue date of the security. + indirect_bidder_accepted : Optional[int] + The accepted value from indirect bidders on the security. + indirect_bidder_tendered : Optional[int] + The tendered value from indirect bidders on the security. + interest_payment_frequency : Optional[str] + The interest payment frequency of the security. + low_discount_rate : Optional[float] + The low discount rate of the security. + low_investment_rate : Optional[float] + The low investment rate of the security. + low_price : Optional[float] + The low price of the security at auction. + low_discount_margin : Optional[float] + The low discount margin of the security. + low_yield : Optional[float] + The low yield of the security at auction. + maturing_date : Optional[date] + The maturing date of the security. + max_competitive_award : Optional[int] + The maximum competitive award at auction. + max_non_competitive_award : Optional[int] + The maximum non-competitive award at auction. + max_single_bid : Optional[int] + The maximum single bid at auction. + min_bid_amount : Optional[int] + The minimum bid amount at auction. + min_strip_amount : Optional[int] + The minimum strip amount at auction. + min_to_issue : Optional[int] + The minimum to issue at auction. + multiples_to_bid : Optional[int] + The multiples to bid at auction. + multiples_to_issue : Optional[int] + The multiples to issue at auction. + nlp_exclusion_amount : Optional[int] + The NLP exclusion amount at auction. + nlp_reporting_threshold : Optional[int] + The NLP reporting threshold at auction. + non_competitive_accepted : Optional[int] + The accepted value from non-competitive bidders on the security. + non_competitive_tenders_accepted : Optional[Literal['Yes', 'No']] + Whether or not the auction accepted non-competitive tenders. + offering_amount : Optional[int] + The offering amount at auction. + original_cusip : Optional[str] + The original CUSIP of the security. + original_dated_date : Optional[date] + The original dated date of the security. + original_issue_date : Optional[date] + The original issue date of the security. + original_security_term : Optional[str] + The original term of the security. + pdf_announcement : Optional[str] + The PDF filename for the announcement of the security. + pdf_competitive_results : Optional[str] + The PDF filename for the competitive results of the security. + pdf_non_competitive_results : Optional[str] + The PDF filename for the non-competitive results of the security. + pdf_special_announcement : Optional[str] + The PDF filename for the special announcements. + price_per_100 : Optional[float] + The price per 100 of the security. + primary_dealer_accepted : Optional[int] + The primary dealer accepted value on the security. + primary_dealer_tendered : Optional[int] + The primary dealer tendered value on the security. + reopening : Optional[Literal['Yes', 'No']] + Whether or not the auction was reopened. + security_term_day_month : Optional[str] + The security term in days or months. + security_term_week_year : Optional[str] + The security term in weeks or years. + series : Optional[str] + The series name of the security. + soma_accepted : Optional[int] + The SOMA accepted value on the security. + soma_holdings : Optional[int] + The SOMA holdings on the security. + soma_included : Optional[Literal['Yes', 'No']] + Whether or not the SOMA (System Open Market Account) was included on the security. + soma_tendered : Optional[int] + The SOMA tendered value on the security. + spread : Optional[float] + The spread on the security. + standard_payment_per_1000 : Optional[float] + The standard payment per 1000 of the security. + strippable : Optional[Literal['Yes', 'No']] + Whether or not the security is strippable. + term : Optional[str] + The term of the security. + tiin_conversion_factor_per_1000 : Optional[float] + The TIIN conversion factor per 1000 of the security. + tips : Optional[Literal['Yes', 'No']] + Whether or not the security is TIPS. + total_accepted : Optional[int] + The total accepted value at auction. + total_tendered : Optional[int] + The total tendered value at auction. + treasury_retail_accepted : Optional[int] + The accepted value on the security from retail. + treasury_retail_tenders_accepted : Optional[Literal['Yes', 'No']] + Whether or not the tender offers from retail are accepted + type : Optional[str] + The type of issuance. This might be different than the security type. + unadjusted_accrued_interest_per_1000 : Optional[float] + The unadjusted accrued interest per 1000 of the security. + unadjusted_price : Optional[float] + The unadjusted price of the security. + updated_timestamp : Optional[datetime] + The updated timestamp of the security. + xml_announcement : Optional[str] + The XML filename for the announcement of the security. + xml_competitive_results : Optional[str] + The XML filename for the competitive results of the security. + xml_special_announcement : Optional[str] + The XML filename for special announcements. + tint_cusip1 : Optional[str] + Tint CUSIP 1. + tint_cusip2 : Optional[str] + Tint CUSIP 2. + + Examples + -------- + >>> from openbb import obb + >>> obb.fixedincome.government.treasury_auctions(provider='government_us') + >>> obb.fixedincome.government.treasury_auctions(security_type='Bill', start_date='2022-01-01', end_date='2023-01-01', provider='government_us') + """ # noqa: E501 + + return self._run( + "/fixedincome/government/treasury_auctions", + **filter_inputs( + provider_choices={ + "provider": self._get_provider( + provider, + "/fixedincome/government/treasury_auctions", + ("government_us",), + ) + }, + standard_params={ + "security_type": security_type, + "cusip": cusip, + "page_size": page_size, + "page_num": page_num, + "start_date": start_date, + "end_date": end_date, + }, + extra_params=kwargs, + ) + ) + + @exception_handler + @validate + def treasury_prices( + self, + date: Annotated[ + Union[datetime.date, None, str], + OpenBBField( + description="A specific date to get data for. Defaults to the last business day." + ), + ] = None, + provider: Annotated[ + Optional[Literal["government_us", "tmx"]], + OpenBBField( + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'government_us' if there is\n no default." + ), + ] = None, + **kwargs + ) -> OBBject: + """Government Treasury Prices by date. + + Parameters + ---------- + date : Union[datetime.date, None, str] + A specific date to get data for. Defaults to the last business day. + provider : Optional[Literal['government_us', 'tmx']] + The provider to use for the query, by default None. + If None, the provider specified in defaults is selected or 'government_us' if there is + no default. + cusip : Optional[str] + Filter by CUSIP. (provider: government_us) + security_type : Optional[Literal['bill', 'note', 'bond', 'tips', 'frn']] + Filter by security type. (provider: government_us) + govt_type : Literal['federal', 'provincial', 'municipal'] + The level of government issuer. (provider: tmx) + issue_date_min : Optional[datetime.date] + Filter by the minimum original issue date. (provider: tmx) + issue_date_max : Optional[datetime.date] + Filter by the maximum original issue date. (provider: tmx) + last_traded_min : Optional[datetime.date] + Filter by the minimum last trade date. (provider: tmx) + maturity_date_min : Optional[datetime.date] + Filter by the minimum maturity date. (provider: tmx) + maturity_date_max : Optional[datetime.date] + Filter by the maximum maturity date. (provider: tmx) + use_cache : bool + All bond data is sourced from a single JSON file that is updated daily. The file is cached for one day to eliminate downloading more than once. Caching will significantly speed up subsequent queries. To bypass, set to False. (provider: tmx) + + Returns + ------- + OBBject + results : List[TreasuryPrices] + Serializable results. + provider : Optional[Literal['government_us', 'tmx']] + Provider name. + warnings : Optional[List[Warning_]] + List of warnings. + chart : Optional[Chart] + Chart object. + extra : Dict[str, Any] + Extra info. + + TreasuryPrices + -------------- + issuer_name : Optional[str] + Name of the issuing entity. + cusip : Optional[str] + CUSIP of the security. + isin : Optional[str] + ISIN of the security. + security_type : Optional[str] + The type of Treasury security - i.e., Bill, Note, Bond, TIPS, FRN. + issue_date : Optional[date] + The original issue date of the security. + maturity_date : Optional[date] + The maturity date of the security. + call_date : Optional[date] + The call date of the security. + bid : Optional[float] + The bid price of the security. + offer : Optional[float] + The offer price of the security. + eod_price : Optional[float] + The end-of-day price of the security. + last_traded_date : Optional[date] + The last trade date of the security. + total_trades : Optional[int] + Total number of trades on the last traded date. + last_price : Optional[float] + The last price of the security. + highest_price : Optional[float] + The highest price for the bond on the last traded date. + lowest_price : Optional[float] + The lowest price for the bond on the last traded date. + rate : Optional[float] + The annualized interest rate or coupon of the security. + ytm : Optional[float] + Yield to maturity (YTM) is the rate of return anticipated on a bond if it is held until the maturity date. It takes into account the current market price, par value, coupon rate and time to maturity. It is assumed that all coupons are reinvested at the same rate. + + Examples + -------- + >>> from openbb import obb + >>> obb.fixedincome.government.treasury_prices(provider='government_us') + >>> obb.fixedincome.government.treasury_prices(date='2019-02-05', provider='government_us') + """ # noqa: E501 + + return self._run( + "/fixedincome/government/treasury_prices", + **filter_inputs( + provider_choices={ + "provider": self._get_provider( + provider, + "/fixedincome/government/treasury_prices", + ("government_us", "tmx"), + ) + }, + standard_params={ + "date": date, + }, + extra_params=kwargs, + ) + ) + @exception_handler @validate def treasury_rates( diff --git a/openbb_platform/openbb/package/index.py b/openbb_platform/openbb/package/index.py index 46f5881f8b4c..bc55bbd52408 100644 --- a/openbb_platform/openbb/package/index.py +++ b/openbb_platform/openbb/package/index.py @@ -19,6 +19,10 @@ class ROUTER_index(Container): constituents market /price + search + sectors + snapshots + sp500_multiples """ def __repr__(self) -> str: @@ -29,9 +33,9 @@ def __repr__(self) -> str: def available( self, provider: Annotated[ - Optional[Literal["fmp", "yfinance"]], + Optional[Literal["cboe", "fmp", "tmx", "yfinance"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'cboe' if there is\n no default." ), ] = None, **kwargs @@ -40,17 +44,20 @@ def available( Parameters ---------- - provider : Optional[Literal['fmp', 'yfinance']] + provider : Optional[Literal['cboe', 'fmp', 'tmx', 'yfinance']] The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'fmp' if there is + If None, the provider specified in defaults is selected or 'cboe' if there is no default. + use_cache : bool + When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass. (provider: cboe); + Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False. (provider: tmx) Returns ------- OBBject results : List[AvailableIndices] Serializable results. - provider : Optional[Literal['fmp', 'yfinance']] + provider : Optional[Literal['cboe', 'fmp', 'tmx', 'yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -65,14 +72,30 @@ def available( Name of the index. currency : Optional[str] Currency the index is traded in. + symbol : Optional[str] + Symbol for the index. (provider: cboe, tmx, yfinance) + description : Optional[str] + Description for the index. Valid only for US indices. (provider: cboe) + data_delay : Optional[int] + Data delay for the index. Valid only for US indices. (provider: cboe) + open_time : Optional[datetime.time] + Opening time for the index. Valid only for US indices. (provider: cboe) + close_time : Optional[datetime.time] + Closing time for the index. Valid only for US indices. (provider: cboe) + time_zone : Optional[str] + Time zone for the index. Valid only for US indices. (provider: cboe) + tick_days : Optional[str] + The trading days for the index. Valid only for US indices. (provider: cboe) + tick_frequency : Optional[str] + The frequency of the index ticks. Valid only for US indices. (provider: cboe) + tick_period : Optional[str] + The period of the index ticks. Valid only for US indices. (provider: cboe) stock_exchange : Optional[str] Stock exchange where the index is listed. (provider: fmp) exchange_short_name : Optional[str] Short name of the stock exchange where the index is listed. (provider: fmp) code : Optional[str] ID code for keying the index in the OpenBB Terminal. (provider: yfinance) - symbol : Optional[str] - Symbol for the index. (provider: yfinance) Examples -------- @@ -88,7 +111,7 @@ def available( "provider": self._get_provider( provider, "/index/available", - ("fmp", "yfinance"), + ("cboe", "fmp", "tmx", "yfinance"), ) }, standard_params={}, @@ -102,9 +125,9 @@ def constituents( self, symbol: Annotated[str, OpenBBField(description="Symbol to get data for.")], provider: Annotated[ - Optional[Literal["fmp"]], + Optional[Literal["cboe", "fmp", "tmx"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'cboe' if there is\n no default." ), ] = None, **kwargs @@ -115,17 +138,19 @@ def constituents( ---------- symbol : str Symbol to get data for. - provider : Optional[Literal['fmp']] + provider : Optional[Literal['cboe', 'fmp', 'tmx']] The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'fmp' if there is + If None, the provider specified in defaults is selected or 'cboe' if there is no default. + use_cache : bool + Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False. (provider: tmx) Returns ------- OBBject results : List[IndexConstituents] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[Literal['cboe', 'fmp', 'tmx']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -140,6 +165,32 @@ def constituents( Symbol representing the entity requested in the data. name : Optional[str] Name of the constituent company in the index. + security_type : Optional[str] + The type of security represented. (provider: cboe) + last_price : Optional[float] + Last price for the symbol. (provider: cboe) + open : Optional[float] + The open price. (provider: cboe) + high : Optional[float] + The high price. (provider: cboe) + low : Optional[float] + The low price. (provider: cboe) + close : Optional[float] + The close price. (provider: cboe) + volume : Optional[int] + The trading volume. (provider: cboe) + prev_close : Optional[float] + The previous close price. (provider: cboe) + change : Optional[float] + Change in price. (provider: cboe) + change_percent : Optional[float] + Change in price as a normalized percentage. (provider: cboe) + tick : Optional[str] + Whether the last sale was an up or down tick. (provider: cboe) + last_trade_time : Optional[datetime] + Last trade timestamp for the symbol. (provider: cboe) + asset_type : Optional[str] + Type of asset. (provider: cboe) sector : Optional[str] Sector the constituent company in the index belongs to. (provider: fmp) sub_sector : Optional[str] @@ -152,11 +203,15 @@ def constituents( Central Index Key (CIK) for the requested entity. (provider: fmp) founded : Optional[Union[str, date]] Founding year of the constituent company in the index. (provider: fmp) + market_value : Optional[float] + The quoted market value of the asset. (provider: tmx) Examples -------- >>> from openbb import obb >>> obb.index.constituents(symbol='dowjones', provider='fmp') + >>> # Providers other than FMP will use the ticker symbol. + >>> obb.index.constituents(symbol='BEP50P', provider='cboe') """ # noqa: E501 return self._run( @@ -166,7 +221,7 @@ def constituents( "provider": self._get_provider( provider, "/index/constituents", - ("fmp",), + ("cboe", "fmp", "tmx"), ) }, standard_params={ @@ -187,7 +242,7 @@ def market( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, polygon, yfinance." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance." ), ], start_date: Annotated[ @@ -203,9 +258,9 @@ def market( OpenBBField(description="Time interval of the data to return."), ] = "1d", provider: Annotated[ - Optional[Literal["fmp", "intrinio", "polygon", "yfinance"]], + Optional[Literal["cboe", "fmp", "intrinio", "polygon", "yfinance"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'cboe' if there is\n no default." ), ] = None, **kwargs @@ -215,17 +270,19 @@ def market( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, polygon, yfinance. + Symbol to get data for. Multiple comma separated items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. start_date : Union[datetime.date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] End date of the data, in YYYY-MM-DD format. interval : Optional[str] Time interval of the data to return. - provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']] + provider : Optional[Literal['cboe', 'fmp', 'intrinio', 'polygon', 'yfinance'... The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'fmp' if there is + If None, the provider specified in defaults is selected or 'cboe' if there is no default. + use_cache : bool + When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. (provider: cboe) limit : Optional[int] The number of data entries to return. (provider: intrinio, polygon) sort : Literal['asc', 'desc'] @@ -236,7 +293,7 @@ def market( OBBject results : List[MarketIndices] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']] + provider : Optional[Literal['cboe', 'fmp', 'intrinio', 'polygon', 'yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -259,6 +316,12 @@ def market( The close price. volume : Optional[int] The trading volume. + calls_volume : Optional[float] + Number of calls traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) + puts_volume : Optional[float] + Number of puts traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) + total_options_volume : Optional[float] + Total number of options traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) vwap : Optional[float] Volume Weighted Average Price over the period. (provider: fmp) change : Optional[float] @@ -288,7 +351,7 @@ def market( "provider": self._get_provider( provider, "/index/market", - ("fmp", "intrinio", "polygon", "yfinance"), + ("cboe", "fmp", "intrinio", "polygon", "yfinance"), ) }, standard_params={ @@ -300,6 +363,7 @@ def market( extra_params=kwargs, info={ "symbol": { + "cboe": {"multiple_items_allowed": True}, "fmp": {"multiple_items_allowed": True}, "intrinio": {"multiple_items_allowed": True}, "polygon": {"multiple_items_allowed": True}, @@ -315,3 +379,423 @@ def price(self): from . import index_price return index_price.ROUTER_index_price(command_runner=self._command_runner) + + @exception_handler + @validate + def search( + self, + query: Annotated[str, OpenBBField(description="Search query.")] = "", + is_symbol: Annotated[ + bool, OpenBBField(description="Whether to search by ticker symbol.") + ] = False, + provider: Annotated[ + Optional[Literal["cboe"]], + OpenBBField( + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'cboe' if there is\n no default." + ), + ] = None, + **kwargs + ) -> OBBject: + """Filter indices for rows containing the query. + + Parameters + ---------- + query : str + Search query. + is_symbol : bool + Whether to search by ticker symbol. + provider : Optional[Literal['cboe']] + The provider to use for the query, by default None. + If None, the provider specified in defaults is selected or 'cboe' if there is + no default. + use_cache : bool + When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass. (provider: cboe) + + Returns + ------- + OBBject + results : List[IndexSearch] + Serializable results. + provider : Optional[Literal['cboe']] + Provider name. + warnings : Optional[List[Warning_]] + List of warnings. + chart : Optional[Chart] + Chart object. + extra : Dict[str, Any] + Extra info. + + IndexSearch + ----------- + symbol : str + Symbol representing the entity requested in the data. + name : str + Name of the index. + description : Optional[str] + Description for the index. (provider: cboe) + data_delay : Optional[int] + Data delay for the index. Valid only for US indices. (provider: cboe) + currency : Optional[str] + Currency for the index. (provider: cboe) + time_zone : Optional[str] + Time zone for the index. Valid only for US indices. (provider: cboe) + open_time : Optional[datetime.time] + Opening time for the index. Valid only for US indices. (provider: cboe) + close_time : Optional[datetime.time] + Closing time for the index. Valid only for US indices. (provider: cboe) + tick_days : Optional[str] + The trading days for the index. Valid only for US indices. (provider: cboe) + tick_frequency : Optional[str] + Tick frequency for the index. Valid only for US indices. (provider: cboe) + tick_period : Optional[str] + Tick period for the index. Valid only for US indices. (provider: cboe) + + Examples + -------- + >>> from openbb import obb + >>> obb.index.search(provider='cboe') + >>> obb.index.search(query='SPX', provider='cboe') + """ # noqa: E501 + + return self._run( + "/index/search", + **filter_inputs( + provider_choices={ + "provider": self._get_provider( + provider, + "/index/search", + ("cboe",), + ) + }, + standard_params={ + "query": query, + "is_symbol": is_symbol, + }, + extra_params=kwargs, + ) + ) + + @exception_handler + @validate + def sectors( + self, + symbol: Annotated[str, OpenBBField(description="Symbol to get data for.")], + provider: Annotated[ + Optional[Literal["tmx"]], + OpenBBField( + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'tmx' if there is\n no default." + ), + ] = None, + **kwargs + ) -> OBBject: + """Get Index Sectors. Sector weighting of an index. + + Parameters + ---------- + symbol : str + Symbol to get data for. + provider : Optional[Literal['tmx']] + The provider to use for the query, by default None. + If None, the provider specified in defaults is selected or 'tmx' if there is + no default. + use_cache : bool + Whether to use a cached request. All Index data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 1 day. (provider: tmx) + + Returns + ------- + OBBject + results : List[IndexSectors] + Serializable results. + provider : Optional[Literal['tmx']] + Provider name. + warnings : Optional[List[Warning_]] + List of warnings. + chart : Optional[Chart] + Chart object. + extra : Dict[str, Any] + Extra info. + + IndexSectors + ------------ + sector : str + The sector name. + weight : float + The weight of the sector in the index. + + Examples + -------- + >>> from openbb import obb + >>> obb.index.sectors(symbol='^TX60', provider='tmx') + """ # noqa: E501 + + return self._run( + "/index/sectors", + **filter_inputs( + provider_choices={ + "provider": self._get_provider( + provider, + "/index/sectors", + ("tmx",), + ) + }, + standard_params={ + "symbol": symbol, + }, + extra_params=kwargs, + ) + ) + + @exception_handler + @validate + def snapshots( + self, + region: Annotated[ + str, + OpenBBField(description="The region of focus for the data - i.e., us, eu."), + ] = "us", + provider: Annotated[ + Optional[Literal["cboe", "tmx"]], + OpenBBField( + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'cboe' if there is\n no default." + ), + ] = None, + **kwargs + ) -> OBBject: + """Index Snapshots. Current levels for all indices from a provider, grouped by `region`. + + Parameters + ---------- + region : str + The region of focus for the data - i.e., us, eu. + provider : Optional[Literal['cboe', 'tmx']] + The provider to use for the query, by default None. + If None, the provider specified in defaults is selected or 'cboe' if there is + no default. + use_cache : bool + Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False. (provider: tmx) + + Returns + ------- + OBBject + results : List[IndexSnapshots] + Serializable results. + provider : Optional[Literal['cboe', 'tmx']] + Provider name. + warnings : Optional[List[Warning_]] + List of warnings. + chart : Optional[Chart] + Chart object. + extra : Dict[str, Any] + Extra info. + + IndexSnapshots + -------------- + symbol : str + Symbol representing the entity requested in the data. + name : Optional[str] + Name of the index. + currency : Optional[str] + Currency of the index. + price : Optional[float] + Current price of the index. + open : Optional[float] + The open price. + high : Optional[float] + The high price. + low : Optional[float] + The low price. + close : Optional[float] + The close price. + volume : Optional[int] + The trading volume. + prev_close : Optional[float] + The previous close price. + change : Optional[float] + Change in value of the index. + change_percent : Optional[float] + Change, in normalized percentage points, of the index. + bid : Optional[float] + Current bid price. (provider: cboe) + ask : Optional[float] + Current ask price. (provider: cboe) + last_trade_time : Optional[datetime] + Last trade timestamp for the symbol. (provider: cboe) + status : Optional[str] + Status of the market, open or closed. (provider: cboe) + year_high : Optional[float] + The 52-week high of the index. (provider: tmx) + year_low : Optional[float] + The 52-week low of the index. (provider: tmx) + return_mtd : Optional[float] + The month-to-date return of the index, as a normalized percent. (provider: tmx) + return_qtd : Optional[float] + The quarter-to-date return of the index, as a normalized percent. (provider: tmx) + return_ytd : Optional[float] + The year-to-date return of the index, as a normalized percent. (provider: tmx) + total_market_value : Optional[float] + The total quoted market value of the index. (provider: tmx) + number_of_constituents : Optional[int] + The number of constituents in the index. (provider: tmx) + constituent_average_market_value : Optional[float] + The average quoted market value of the index constituents. (provider: tmx) + constituent_median_market_value : Optional[float] + The median quoted market value of the index constituents. (provider: tmx) + constituent_top10_market_value : Optional[float] + The sum of the top 10 quoted market values of the index constituents. (provider: tmx) + constituent_largest_market_value : Optional[float] + The largest quoted market value of the index constituents. (provider: tmx) + constituent_largest_weight : Optional[float] + The largest weight of the index constituents, as a normalized percent. (provider: tmx) + constituent_smallest_market_value : Optional[float] + The smallest quoted market value of the index constituents. (provider: tmx) + constituent_smallest_weight : Optional[float] + The smallest weight of the index constituents, as a normalized percent. (provider: tmx) + + Examples + -------- + >>> from openbb import obb + >>> obb.index.snapshots(provider='tmx') + >>> obb.index.snapshots(region='us', provider='cboe') + """ # noqa: E501 + + return self._run( + "/index/snapshots", + **filter_inputs( + provider_choices={ + "provider": self._get_provider( + provider, + "/index/snapshots", + ("cboe", "tmx"), + ) + }, + standard_params={ + "region": region, + }, + extra_params=kwargs, + ) + ) + + @exception_handler + @validate + def sp500_multiples( + self, + series_name: Annotated[ + Literal[ + "shiller_pe_month", + "shiller_pe_year", + "pe_year", + "pe_month", + "dividend_year", + "dividend_month", + "dividend_growth_quarter", + "dividend_growth_year", + "dividend_yield_year", + "dividend_yield_month", + "earnings_year", + "earnings_month", + "earnings_growth_year", + "earnings_growth_quarter", + "real_earnings_growth_year", + "real_earnings_growth_quarter", + "earnings_yield_year", + "earnings_yield_month", + "real_price_year", + "real_price_month", + "inflation_adjusted_price_year", + "inflation_adjusted_price_month", + "sales_year", + "sales_quarter", + "sales_growth_year", + "sales_growth_quarter", + "real_sales_year", + "real_sales_quarter", + "real_sales_growth_year", + "real_sales_growth_quarter", + "price_to_sales_year", + "price_to_sales_quarter", + "price_to_book_value_year", + "price_to_book_value_quarter", + "book_value_year", + "book_value_quarter", + ], + OpenBBField(description="The name of the series. Defaults to 'pe_month'."), + ] = "pe_month", + start_date: Annotated[ + Union[datetime.date, None, str], + OpenBBField(description="Start date of the data, in YYYY-MM-DD format."), + ] = None, + end_date: Annotated[ + Union[datetime.date, None, str], + OpenBBField(description="End date of the data, in YYYY-MM-DD format."), + ] = None, + provider: Annotated[ + Optional[Literal["nasdaq"]], + OpenBBField( + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'nasdaq' if there is\n no default." + ), + ] = None, + **kwargs + ) -> OBBject: + """Get historical S&P 500 multiples and Shiller PE ratios. + + Parameters + ---------- + series_name : Literal['shiller_pe_month', 'shiller_pe_year', 'pe_year', 'pe_month', 'd... + The name of the series. Defaults to 'pe_month'. + start_date : Union[datetime.date, None, str] + Start date of the data, in YYYY-MM-DD format. + end_date : Union[datetime.date, None, str] + End date of the data, in YYYY-MM-DD format. + provider : Optional[Literal['nasdaq']] + The provider to use for the query, by default None. + If None, the provider specified in defaults is selected or 'nasdaq' if there is + no default. + transform : Literal['diff', 'rdiff', 'cumul', 'normalize', None] + Transform the data as difference, percent change, cumulative, or normalize. (provider: nasdaq) + collapse : Literal['daily', 'weekly', 'monthly', 'quarterly', 'annual', None] + Collapse the frequency of the time series. (provider: nasdaq) + + Returns + ------- + OBBject + results : List[SP500Multiples] + Serializable results. + provider : Optional[Literal['nasdaq']] + Provider name. + warnings : Optional[List[Warning_]] + List of warnings. + chart : Optional[Chart] + Chart object. + extra : Dict[str, Any] + Extra info. + + SP500Multiples + -------------- + date : date + The date of the data. + + Examples + -------- + >>> from openbb import obb + >>> obb.index.sp500_multiples(provider='nasdaq') + >>> obb.index.sp500_multiples(series_name='shiller_pe_year', provider='nasdaq') + """ # noqa: E501 + + return self._run( + "/index/sp500_multiples", + **filter_inputs( + provider_choices={ + "provider": self._get_provider( + provider, + "/index/sp500_multiples", + ("nasdaq",), + ) + }, + standard_params={ + "series_name": series_name, + "start_date": start_date, + "end_date": end_date, + }, + extra_params=kwargs, + ) + ) diff --git a/openbb_platform/openbb/package/news.py b/openbb_platform/openbb/package/news.py index b0e65cd2ab25..3ada18b20ebc 100644 --- a/openbb_platform/openbb/package/news.py +++ b/openbb_platform/openbb/package/news.py @@ -28,7 +28,7 @@ def company( symbol: Annotated[ Union[str, None, List[Optional[str]]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, yfinance." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance." ), ] = None, start_date: Annotated[ @@ -45,7 +45,15 @@ def company( ] = 2500, provider: Annotated[ Optional[ - Literal["benzinga", "fmp", "intrinio", "polygon", "tiingo", "yfinance"] + Literal[ + "benzinga", + "fmp", + "intrinio", + "polygon", + "tiingo", + "tmx", + "yfinance", + ] ], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'benzinga' if there is\n no default." @@ -58,7 +66,7 @@ def company( Parameters ---------- symbol : Union[str, None, List[Optional[str]]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, yfinance. + Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance. start_date : Union[datetime.date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] @@ -95,7 +103,8 @@ def company( content_types : Optional[str] Content types of the news to retrieve. (provider: benzinga) page : Optional[int] - Page number of the results. Use in combination with limit. (provider: fmp) + Page number of the results. Use in combination with limit. (provider: fmp); + The page number to start from. Use with limit. (provider: tmx) source : Optional[Union[Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases'], str]] The source of the news article. (provider: intrinio); A comma-separated list of the domains requested. (provider: tiingo) @@ -123,7 +132,7 @@ def company( OBBject results : List[CompanyNews] Serializable results. - provider : Optional[Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']] + provider : Optional[Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -165,6 +174,7 @@ def company( The source of the news article. (provider: intrinio); Source of the article. (provider: polygon); News source. (provider: tiingo); + Source of the news. (provider: tmx); Source of the news article (provider: yfinance) summary : Optional[str] The summary of the news article. (provider: intrinio) @@ -223,6 +233,7 @@ def company( "intrinio", "polygon", "tiingo", + "tmx", "yfinance", ), ) @@ -241,6 +252,7 @@ def company( "intrinio": {"multiple_items_allowed": True}, "polygon": {"multiple_items_allowed": True}, "tiingo": {"multiple_items_allowed": True}, + "tmx": {"multiple_items_allowed": True}, "yfinance": {"multiple_items_allowed": True}, } }, @@ -266,7 +278,7 @@ def world( OpenBBField(description="End date of the data, in YYYY-MM-DD format."), ] = None, provider: Annotated[ - Optional[Literal["benzinga", "fmp", "intrinio", "tiingo"]], + Optional[Literal["benzinga", "biztoc", "fmp", "intrinio", "tiingo"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'benzinga' if there is\n no default." ), @@ -283,7 +295,7 @@ def world( Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['benzinga', 'fmp', 'intrinio', 'tiingo']] + provider : Optional[Literal['benzinga', 'biztoc', 'fmp', 'intrinio', 'tiingo... 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. @@ -311,9 +323,16 @@ def world( Authors of the news to retrieve. (provider: benzinga) content_types : Optional[str] Content types of the news to retrieve. (provider: benzinga) - source : Optional[Union[Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases'], str]] + filter : Literal['crypto', 'hot', 'latest', 'main', 'media', 'source', 'tag'] + Filter by type of news. (provider: biztoc) + source : Optional[Union[str, Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases']]] + Filter by a specific publisher. Only valid when filter is set to source. (provider: biztoc); The source of the news article. (provider: intrinio); A comma-separated list of the domains requested. (provider: tiingo) + tag : Optional[str] + Tag, topic, to filter articles by. Only valid when filter is set to tag. (provider: biztoc) + term : Optional[str] + Search term to filter articles by. This overrides all other filters. (provider: biztoc) sentiment : Optional[Literal['positive', 'neutral', 'negative']] Return news only from this source. (provider: intrinio) language : Optional[str] @@ -338,7 +357,7 @@ def world( OBBject results : List[WorldNews] Serializable results. - provider : Optional[Literal['benzinga', 'fmp', 'intrinio', 'tiingo']] + provider : Optional[Literal['benzinga', 'biztoc', 'fmp', 'intrinio', 'tiingo']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -360,7 +379,7 @@ def world( url : Optional[str] URL to the article. id : Optional[str] - Article ID. (provider: benzinga, intrinio) + Article ID. (provider: benzinga, biztoc, intrinio) author : Optional[str] Author of the news. (provider: benzinga) teaser : Optional[str] @@ -369,10 +388,14 @@ def world( Channels associated with the news. (provider: benzinga) stocks : Optional[str] Stocks associated with the news. (provider: benzinga) - tags : Optional[str] - Tags associated with the news. (provider: benzinga, tiingo) + tags : Optional[Union[str, List[str]]] + Tags associated with the news. (provider: benzinga, biztoc, tiingo) updated : Optional[datetime] Updated date of the news. (provider: benzinga) + favicon : Optional[str] + Icon image for the source of the article. (provider: biztoc) + score : Optional[float] + Search relevance score for the article. (provider: biztoc) site : Optional[str] News source. (provider: fmp, tiingo) source : Optional[str] @@ -419,6 +442,8 @@ def world( >>> obb.news.world(topics='finance', provider='benzinga') >>> # Get news by source using 'tingo' as provider. >>> obb.news.world(provider='tiingo', source='bloomberg') + >>> # Filter aticles by term using 'biztoc' as provider. + >>> obb.news.world(provider='biztoc', term='apple') """ # noqa: E501 return self._run( @@ -428,7 +453,7 @@ def world( "provider": self._get_provider( provider, "/news/world", - ("benzinga", "fmp", "intrinio", "tiingo"), + ("benzinga", "biztoc", "fmp", "intrinio", "tiingo"), ) }, standard_params={ diff --git a/openbb_platform/openbb/package/regulators.py b/openbb_platform/openbb/package/regulators.py index 753e0bfc69aa..f309425d2784 100644 --- a/openbb_platform/openbb/package/regulators.py +++ b/openbb_platform/openbb/package/regulators.py @@ -6,12 +6,22 @@ class ROUTER_regulators(Container): """/regulators + /cftc /sec """ def __repr__(self) -> str: return self.__doc__ or "" + @property + def cftc(self): + # pylint: disable=import-outside-toplevel + from . import regulators_cftc + + return regulators_cftc.ROUTER_regulators_cftc( + command_runner=self._command_runner + ) + @property def sec(self): # pylint: disable=import-outside-toplevel From 3d2cc9fa9e249f81312be6f1ebed0546de723465 Mon Sep 17 00:00:00 2001 From: hjoaquim Date: Mon, 13 May 2024 09:49:51 +0100 Subject: [PATCH 3/9] reset package folder --- .../openbb/package/__extensions__.py | 48 -- .../openbb/package/crypto_price.py | 9 - openbb_platform/openbb/package/currency.py | 137 +---- .../openbb/package/currency_price.py | 9 - .../openbb/package/derivatives_options.py | 58 +- openbb_platform/openbb/package/economy.py | 313 +--------- openbb_platform/openbb/package/equity.py | 120 +--- .../openbb/package/equity_calendar.py | 74 +-- .../openbb/package/equity_compare.py | 133 ---- .../openbb/package/equity_discovery.py | 169 +----- .../openbb/package/equity_estimates.py | 42 +- .../openbb/package/equity_fundamental.py | 182 ++---- .../openbb/package/equity_ownership.py | 24 +- .../openbb/package/equity_price.py | 322 ++-------- .../openbb/package/equity_shorts.py | 164 ----- openbb_platform/openbb/package/etf.py | 387 +++--------- .../openbb/package/fixedincome_corporate.py | 176 ------ .../openbb/package/fixedincome_government.py | 572 ------------------ openbb_platform/openbb/package/index.py | 528 +--------------- openbb_platform/openbb/package/news.py | 51 +- openbb_platform/openbb/package/regulators.py | 10 - 21 files changed, 308 insertions(+), 3220 deletions(-) diff --git a/openbb_platform/openbb/package/__extensions__.py b/openbb_platform/openbb/package/__extensions__.py index ccb109554be4..2003677632f4 100644 --- a/openbb_platform/openbb/package/__extensions__.py +++ b/openbb_platform/openbb/package/__extensions__.py @@ -8,74 +8,47 @@ class Extensions(Container): # fmt: off """ Routers: - /commodity /crypto /currency /derivatives - /econometrics /economy /equity /etf /fixedincome /index /news - /quantitative /regulators - /technical Extensions: - commodity@1.0.4 - crypto@1.1.5 - currency@1.1.5 - derivatives@1.1.5 - - econometrics@1.1.5 - economy@1.1.5 - equity@1.1.5 - etf@1.1.5 - fixedincome@1.1.5 - index@1.1.5 - news@1.1.5 - - quantitative@1.1.5 - regulators@1.1.5 - - technical@1.1.6 - - alpha_vantage@1.1.5 - benzinga@1.1.5 - - biztoc@1.1.5 - - cboe@1.1.5 - - ecb@1.1.5 - econdb@1.0.0 - federal_reserve@1.1.5 - - finra@1.1.5 - - finviz@1.0.4 - fmp@1.1.5 - fred@1.1.5 - - government_us@1.1.5 - intrinio@1.1.5 - - nasdaq@1.1.6 - oecd@1.1.5 - polygon@1.1.5 - sec@1.1.5 - - seeking_alpha@1.1.5 - - stockgrid@1.1.5 - tiingo@1.1.5 - - tmx@1.0.2 - - tradier@1.0.2 - tradingeconomics@1.1.5 - - wsj@1.1.5 - yfinance@1.1.5 """ # fmt: on def __repr__(self) -> str: return self.__doc__ or "" - @property - def commodity(self): - # pylint: disable=import-outside-toplevel - from . import commodity - - return commodity.ROUTER_commodity(command_runner=self._command_runner) - @property def crypto(self): # pylint: disable=import-outside-toplevel @@ -97,13 +70,6 @@ def derivatives(self): return derivatives.ROUTER_derivatives(command_runner=self._command_runner) - @property - def econometrics(self): - # pylint: disable=import-outside-toplevel - from . import econometrics - - return econometrics.ROUTER_econometrics(command_runner=self._command_runner) - @property def economy(self): # pylint: disable=import-outside-toplevel @@ -146,23 +112,9 @@ def news(self): return news.ROUTER_news(command_runner=self._command_runner) - @property - def quantitative(self): - # pylint: disable=import-outside-toplevel - from . import quantitative - - return quantitative.ROUTER_quantitative(command_runner=self._command_runner) - @property def regulators(self): # pylint: disable=import-outside-toplevel from . import regulators return regulators.ROUTER_regulators(command_runner=self._command_runner) - - @property - def technical(self): - # pylint: disable=import-outside-toplevel - from . import technical - - return technical.ROUTER_technical(command_runner=self._command_runner) diff --git a/openbb_platform/openbb/package/crypto_price.py b/openbb_platform/openbb/package/crypto_price.py index 9fa196fd3f8f..bbd332f8d18b 100644 --- a/openbb_platform/openbb/package/crypto_price.py +++ b/openbb_platform/openbb/package/crypto_price.py @@ -37,12 +37,6 @@ def historical( Union[datetime.date, None, str], OpenBBField(description="End date of the data, in YYYY-MM-DD format."), ] = None, - chart: Annotated[ - bool, - OpenBBField( - description="Whether to create a chart or not, by default False." - ), - ] = False, provider: Annotated[ Optional[Literal["fmp", "polygon", "tiingo", "yfinance"]], OpenBBField( @@ -61,8 +55,6 @@ def historical( Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] End date of the data, in YYYY-MM-DD format. - chart : bool - Whether to create a chart or not, by default False. provider : Optional[Literal['fmp', 'polygon', 'tiingo', 'yfinance']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is @@ -143,7 +135,6 @@ def historical( "end_date": end_date, }, extra_params=kwargs, - chart=chart, info={ "symbol": { "fmp": {"multiple_items_allowed": True}, diff --git a/openbb_platform/openbb/package/currency.py b/openbb_platform/openbb/package/currency.py index fa8d1e8e9030..ba7d31d21cb9 100644 --- a/openbb_platform/openbb/package/currency.py +++ b/openbb_platform/openbb/package/currency.py @@ -13,7 +13,6 @@ class ROUTER_currency(Container): """/currency /price - reference_rates search snapshots """ @@ -28,138 +27,6 @@ def price(self): return currency_price.ROUTER_currency_price(command_runner=self._command_runner) - @exception_handler - @validate - def reference_rates( - self, - provider: Annotated[ - Optional[Literal["ecb"]], - OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'ecb' if there is\n no default." - ), - ] = None, - **kwargs - ) -> OBBject: - """Get current, official, currency reference rates. - - Foreign exchange reference rates are the exchange rates set by a major financial institution or regulatory body, - serving as a benchmark for the value of currencies around the world. - These rates are used as a standard to facilitate international trade and financial transactions, - ensuring consistency and reliability in currency conversion. - They are typically updated on a daily basis and reflect the market conditions at a specific time. - Central banks and financial institutions often use these rates to guide their own exchange rates, - impacting global trade, loans, and investments. - - - Parameters - ---------- - provider : Optional[Literal['ecb']] - The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'ecb' if there is - no default. - - Returns - ------- - OBBject - results : CurrencyReferenceRates - Serializable results. - provider : Optional[Literal['ecb']] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - - CurrencyReferenceRates - ---------------------- - date : date - The date of the data. - EUR : Optional[float] - Euro. - USD : Optional[float] - US Dollar. - JPY : Optional[float] - Japanese Yen. - BGN : Optional[float] - Bulgarian Lev. - CZK : Optional[float] - Czech Koruna. - DKK : Optional[float] - Danish Krone. - GBP : Optional[float] - Pound Sterling. - HUF : Optional[float] - Hungarian Forint. - PLN : Optional[float] - Polish Zloty. - RON : Optional[float] - Romanian Leu. - SEK : Optional[float] - Swedish Krona. - CHF : Optional[float] - Swiss Franc. - ISK : Optional[float] - Icelandic Krona. - NOK : Optional[float] - Norwegian Krone. - TRY : Optional[float] - Turkish Lira. - AUD : Optional[float] - Australian Dollar. - BRL : Optional[float] - Brazilian Real. - CAD : Optional[float] - Canadian Dollar. - CNY : Optional[float] - Chinese Yuan. - HKD : Optional[float] - Hong Kong Dollar. - IDR : Optional[float] - Indonesian Rupiah. - ILS : Optional[float] - Israeli Shekel. - INR : Optional[float] - Indian Rupee. - KRW : Optional[float] - South Korean Won. - MXN : Optional[float] - Mexican Peso. - MYR : Optional[float] - Malaysian Ringgit. - NZD : Optional[float] - New Zealand Dollar. - PHP : Optional[float] - Philippine Peso. - SGD : Optional[float] - Singapore Dollar. - THB : Optional[float] - Thai Baht. - ZAR : Optional[float] - South African Rand. - - Examples - -------- - >>> from openbb import obb - >>> obb.currency.reference_rates(provider='ecb') - """ # noqa: E501 - - return self._run( - "/currency/reference_rates", - **filter_inputs( - provider_choices={ - "provider": self._get_provider( - provider, - "/currency/reference_rates", - ("ecb",), - ) - }, - standard_params={}, - extra_params=kwargs, - ) - ) - @exception_handler @validate def search( @@ -285,7 +152,7 @@ def snapshots( ), ] = "indirect", counter_currencies: Annotated[ - Union[str, List[str], None], + Union[List[str], str, None], OpenBBField( description="An optional list of counter currency symbols to filter for. None returns all." ), @@ -306,7 +173,7 @@ def snapshots( The base currency symbol. Multiple comma separated items allowed for provider(s): fmp, polygon. quote_type : Literal['direct', 'indirect'] 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. - counter_currencies : Union[str, List[str], None] + counter_currencies : Union[List[str], str, None] An optional list of counter currency symbols to filter for. None returns all. provider : Optional[Literal['fmp', 'polygon']] The provider to use for the query, by default None. diff --git a/openbb_platform/openbb/package/currency_price.py b/openbb_platform/openbb/package/currency_price.py index 2cea262c7c56..251e422f05d8 100644 --- a/openbb_platform/openbb/package/currency_price.py +++ b/openbb_platform/openbb/package/currency_price.py @@ -37,12 +37,6 @@ def historical( Union[datetime.date, None, str], OpenBBField(description="End date of the data, in YYYY-MM-DD format."), ] = None, - chart: Annotated[ - bool, - OpenBBField( - description="Whether to create a chart or not, by default False." - ), - ] = False, provider: Annotated[ Optional[Literal["fmp", "polygon", "tiingo", "yfinance"]], OpenBBField( @@ -68,8 +62,6 @@ def historical( Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] End date of the data, in YYYY-MM-DD format. - chart : bool - Whether to create a chart or not, by default False. provider : Optional[Literal['fmp', 'polygon', 'tiingo', 'yfinance']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is @@ -146,7 +138,6 @@ def historical( "end_date": end_date, }, extra_params=kwargs, - chart=chart, info={ "symbol": { "fmp": {"multiple_items_allowed": True}, diff --git a/openbb_platform/openbb/package/derivatives_options.py b/openbb_platform/openbb/package/derivatives_options.py index ec17a1bcac45..4490181503de 100644 --- a/openbb_platform/openbb/package/derivatives_options.py +++ b/openbb_platform/openbb/package/derivatives_options.py @@ -25,9 +25,9 @@ def chains( self, symbol: Annotated[str, OpenBBField(description="Symbol to get data for.")], provider: Annotated[ - Optional[Literal["cboe", "intrinio", "tmx", "tradier"]], + Optional[Literal["intrinio"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'cboe' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'intrinio' if there is\n no default." ), ] = None, **kwargs @@ -38,23 +38,19 @@ def chains( ---------- symbol : str Symbol to get data for. - provider : Optional[Literal['cboe', 'intrinio', 'tmx', 'tradier']] + provider : Optional[Literal['intrinio']] The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'cboe' if there is + If None, the provider specified in defaults is selected or 'intrinio' if there is no default. - use_cache : bool - When True, the company directories will be cached for24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. (provider: cboe); - Caching is used to validate the supplied ticker symbol, or if a historical EOD chain is requested. To bypass, set to False. (provider: tmx) date : Optional[datetime.date] - The end-of-day date for options chains data. (provider: intrinio); - A specific date to get data for. (provider: tmx) + The end-of-day date for options chains data. (provider: intrinio) Returns ------- OBBject results : List[OptionsChains] Serializable results. - provider : Optional[Literal['cboe', 'intrinio', 'tmx', 'tradier']] + provider : Optional[Literal['intrinio']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -151,48 +147,8 @@ def chains( Vega of the option. rho : Optional[float] Rho of the option. - last_trade_timestamp : Optional[datetime] - Last trade timestamp of the option. (provider: cboe); - Timestamp of the last trade. (provider: tradier) - dte : Optional[int] - Days to expiration for the option. (provider: cboe, tmx); - Days to expiration. (provider: tradier) exercise_style : Optional[str] The exercise style of the option, American or European. (provider: intrinio) - transactions : Optional[int] - Number of transactions for the contract. (provider: tmx) - total_value : Optional[float] - Total value of the transactions. (provider: tmx) - settlement_price : Optional[float] - Settlement price on that date. (provider: tmx) - underlying_price : Optional[float] - Price of the underlying stock on that date. (provider: tmx) - phi : Optional[float] - Phi of the option. The sensitivity of the option relative to dividend yield. (provider: tradier) - bid_iv : Optional[float] - Implied volatility of the bid price. (provider: tradier) - ask_iv : Optional[float] - Implied volatility of the ask price. (provider: tradier) - orats_final_iv : Optional[float] - ORATS final implied volatility of the option, updated once per hour. (provider: tradier) - year_high : Optional[float] - 52-week high price of the option. (provider: tradier) - year_low : Optional[float] - 52-week low price of the option. (provider: tradier) - last_trade_volume : Optional[int] - Volume of the last trade. (provider: tradier) - contract_size : Optional[int] - Size of the contract. (provider: tradier) - bid_exchange : Optional[str] - Exchange of the bid price. (provider: tradier) - bid_timestamp : Optional[datetime] - Timestamp of the bid price. (provider: tradier) - ask_exchange : Optional[str] - Exchange of the ask price. (provider: tradier) - ask_timestamp : Optional[datetime] - Timestamp of the ask price. (provider: tradier) - greeks_timestamp : Optional[datetime] - Timestamp of the last greeks update. Greeks/IV data is updated once per hour. (provider: tradier) Examples -------- @@ -209,7 +165,7 @@ def chains( "provider": self._get_provider( provider, "/derivatives/options/chains", - ("cboe", "intrinio", "tmx", "tradier"), + ("intrinio",), ) }, standard_params={ diff --git a/openbb_platform/openbb/package/economy.py b/openbb_platform/openbb/package/economy.py index b7417f1be26c..dca7a2a489c4 100644 --- a/openbb_platform/openbb/package/economy.py +++ b/openbb_platform/openbb/package/economy.py @@ -14,7 +14,6 @@ class ROUTER_economy(Container): """/economy available_indicators - balance_of_payments calendar composite_leading_indicator country_profile @@ -123,290 +122,6 @@ def available_indicators( ) ) - @exception_handler - @validate - def balance_of_payments( - self, - provider: Annotated[ - Optional[Literal["ecb"]], - OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'ecb' if there is\n no default." - ), - ] = None, - **kwargs - ) -> OBBject: - """Balance of Payments Reports. - - Parameters - ---------- - provider : Optional[Literal['ecb']] - The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'ecb' if there is - no default. - report_type : Literal['main', 'summary', 'services', 'investment_income', 'direct_investment', 'portfolio_investment', 'other_investment'] - The report type, the level of detail in the data. (provider: ecb) - frequency : Literal['monthly', 'quarterly'] - The frequency of the data. Monthly is valid only for ['main', 'summary']. (provider: ecb) - country : Literal['brazil', 'canada', 'china', 'eu_ex_euro_area', 'eu_institutions', 'india', 'japan', 'russia', 'switzerland', 'united_kingdom', 'united_states', 'total', None] - The country/region of the data. This parameter will override the 'report_type' parameter. (provider: ecb) - - Returns - ------- - OBBject - results : List[BalanceOfPayments] - Serializable results. - provider : Optional[Literal['ecb']] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - - BalanceOfPayments - ----------------- - period : Optional[date] - The date representing the beginning of the reporting period. - current_account : Optional[float] - Current Account Balance (Billions of EUR) - goods : Optional[float] - Goods Balance (Billions of EUR) - services : Optional[float] - Services Balance (Billions of EUR) - primary_income : Optional[float] - Primary Income Balance (Billions of EUR) - secondary_income : Optional[float] - Secondary Income Balance (Billions of EUR) - capital_account : Optional[float] - Capital Account Balance (Billions of EUR) - net_lending_to_rest_of_world : Optional[float] - Balance of net lending to the rest of the world (Billions of EUR) - financial_account : Optional[float] - Financial Account Balance (Billions of EUR) - direct_investment : Optional[float] - Direct Investment Balance (Billions of EUR) - portfolio_investment : Optional[float] - Portfolio Investment Balance (Billions of EUR) - financial_derivatives : Optional[float] - Financial Derivatives Balance (Billions of EUR) - other_investment : Optional[float] - Other Investment Balance (Billions of EUR) - reserve_assets : Optional[float] - Reserve Assets Balance (Billions of EUR) - errors_and_ommissions : Optional[float] - Errors and Omissions (Billions of EUR) - current_account_credit : Optional[float] - Current Account Credits (Billions of EUR) - current_account_debit : Optional[float] - Current Account Debits (Billions of EUR) - current_account_balance : Optional[float] - Current Account Balance (Billions of EUR) - goods_credit : Optional[float] - Goods Credits (Billions of EUR) - goods_debit : Optional[float] - Goods Debits (Billions of EUR) - services_credit : Optional[float] - Services Credits (Billions of EUR) - services_debit : Optional[float] - Services Debits (Billions of EUR) - primary_income_credit : Optional[float] - Primary Income Credits (Billions of EUR) - primary_income_employee_compensation_credit : Optional[float] - Primary Income Employee Compensation Credit (Billions of EUR) - primary_income_debit : Optional[float] - Primary Income Debits (Billions of EUR) - primary_income_employee_compensation_debit : Optional[float] - Primary Income Employee Compensation Debit (Billions of EUR) - secondary_income_credit : Optional[float] - Secondary Income Credits (Billions of EUR) - secondary_income_debit : Optional[float] - Secondary Income Debits (Billions of EUR) - capital_account_credit : Optional[float] - Capital Account Credits (Billions of EUR) - capital_account_debit : Optional[float] - Capital Account Debits (Billions of EUR) - services_total_credit : Optional[float] - Services Total Credit (Billions of EUR) - services_total_debit : Optional[float] - Services Total Debit (Billions of EUR) - transport_credit : Optional[float] - Transport Credit (Billions of EUR) - transport_debit : Optional[float] - Transport Debit (Billions of EUR) - travel_credit : Optional[float] - Travel Credit (Billions of EUR) - travel_debit : Optional[float] - Travel Debit (Billions of EUR) - financial_services_credit : Optional[float] - Financial Services Credit (Billions of EUR) - financial_services_debit : Optional[float] - Financial Services Debit (Billions of EUR) - communications_credit : Optional[float] - Communications Credit (Billions of EUR) - communications_debit : Optional[float] - Communications Debit (Billions of EUR) - other_business_services_credit : Optional[float] - Other Business Services Credit (Billions of EUR) - other_business_services_debit : Optional[float] - Other Business Services Debit (Billions of EUR) - other_services_credit : Optional[float] - Other Services Credit (Billions of EUR) - other_services_debit : Optional[float] - Other Services Debit (Billions of EUR) - investment_total_credit : Optional[float] - Investment Total Credit (Billions of EUR) - investment_total_debit : Optional[float] - Investment Total Debit (Billions of EUR) - equity_credit : Optional[float] - Equity Credit (Billions of EUR) - equity_reinvested_earnings_credit : Optional[float] - Equity Reinvested Earnings Credit (Billions of EUR) - equity_debit : Optional[float] - Equity Debit (Billions of EUR) - equity_reinvested_earnings_debit : Optional[float] - Equity Reinvested Earnings Debit (Billions of EUR) - debt_instruments_credit : Optional[float] - Debt Instruments Credit (Billions of EUR) - debt_instruments_debit : Optional[float] - Debt Instruments Debit (Billions of EUR) - portfolio_investment_equity_credit : Optional[float] - Portfolio Investment Equity Credit (Billions of EUR) - portfolio_investment_equity_debit : Optional[float] - Portfolio Investment Equity Debit (Billions of EUR) - portfolio_investment_debt_instruments_credit : Optional[float] - Portfolio Investment Debt Instruments Credit (Billions of EUR) - portofolio_investment_debt_instruments_debit : Optional[float] - Portfolio Investment Debt Instruments Debit (Billions of EUR) - other_investment_credit : Optional[float] - Other Investment Credit (Billions of EUR) - other_investment_debit : Optional[float] - Other Investment Debit (Billions of EUR) - reserve_assets_credit : Optional[float] - Reserve Assets Credit (Billions of EUR) - assets_total : Optional[float] - Assets Total (Billions of EUR) - assets_equity : Optional[float] - Assets Equity (Billions of EUR) - assets_debt_instruments : Optional[float] - Assets Debt Instruments (Billions of EUR) - assets_mfi : Optional[float] - Assets MFIs (Billions of EUR) - assets_non_mfi : Optional[float] - Assets Non MFIs (Billions of EUR) - assets_direct_investment_abroad : Optional[float] - Assets Direct Investment Abroad (Billions of EUR) - liabilities_total : Optional[float] - Liabilities Total (Billions of EUR) - liabilities_equity : Optional[float] - Liabilities Equity (Billions of EUR) - liabilities_debt_instruments : Optional[float] - Liabilities Debt Instruments (Billions of EUR) - liabilities_mfi : Optional[float] - Liabilities MFIs (Billions of EUR) - liabilities_non_mfi : Optional[float] - Liabilities Non MFIs (Billions of EUR) - liabilities_direct_investment_euro_area : Optional[float] - Liabilities Direct Investment in Euro Area (Billions of EUR) - assets_equity_and_fund_shares : Optional[float] - Assets Equity and Investment Fund Shares (Billions of EUR) - assets_equity_shares : Optional[float] - Assets Equity Shares (Billions of EUR) - assets_investment_fund_shares : Optional[float] - Assets Investment Fund Shares (Billions of EUR) - assets_debt_short_term : Optional[float] - Assets Debt Short Term (Billions of EUR) - assets_debt_long_term : Optional[float] - Assets Debt Long Term (Billions of EUR) - assets_resident_sector_eurosystem : Optional[float] - Assets Resident Sector Eurosystem (Billions of EUR) - assets_resident_sector_mfi_ex_eurosystem : Optional[float] - Assets Resident Sector MFIs outside Eurosystem (Billions of EUR) - assets_resident_sector_government : Optional[float] - Assets Resident Sector Government (Billions of EUR) - assets_resident_sector_other : Optional[float] - Assets Resident Sector Other (Billions of EUR) - liabilities_equity_and_fund_shares : Optional[float] - Liabilities Equity and Investment Fund Shares (Billions of EUR) - liabilities_investment_fund_shares : Optional[float] - Liabilities Investment Fund Shares (Billions of EUR) - liabilities_debt_short_term : Optional[float] - Liabilities Debt Short Term (Billions of EUR) - liabilities_debt_long_term : Optional[float] - Liabilities Debt Long Term (Billions of EUR) - liabilities_resident_sector_government : Optional[float] - Liabilities Resident Sector Government (Billions of EUR) - liabilities_resident_sector_other : Optional[float] - Liabilities Resident Sector Other (Billions of EUR) - assets_currency_and_deposits : Optional[float] - Assets Currency and Deposits (Billions of EUR) - assets_loans : Optional[float] - Assets Loans (Billions of EUR) - assets_trade_credit_and_advances : Optional[float] - Assets Trade Credits and Advances (Billions of EUR) - assets_eurosystem : Optional[float] - Assets Eurosystem (Billions of EUR) - assets_other_mfi_ex_eurosystem : Optional[float] - Assets Other MFIs outside Eurosystem (Billions of EUR) - assets_government : Optional[float] - Assets Government (Billions of EUR) - assets_other_sectors : Optional[float] - Assets Other Sectors (Billions of EUR) - liabilities_currency_and_deposits : Optional[float] - Liabilities Currency and Deposits (Billions of EUR) - liabilities_loans : Optional[float] - Liabilities Loans (Billions of EUR) - liabilities_trade_credit_and_advances : Optional[float] - Liabilities Trade Credits and Advances (Billions of EUR) - liabilities_eurosystem : Optional[float] - Liabilities Eurosystem (Billions of EUR) - liabilities_other_mfi_ex_eurosystem : Optional[float] - Liabilities Other MFIs outside Eurosystem (Billions of EUR) - liabilities_government : Optional[float] - Liabilities Government (Billions of EUR) - liabilities_other_sectors : Optional[float] - Liabilities Other Sectors (Billions of EUR) - goods_balance : Optional[float] - Goods Balance (Billions of EUR) - services_balance : Optional[float] - Services Balance (Billions of EUR) - primary_income_balance : Optional[float] - Primary Income Balance (Billions of EUR) - investment_income_balance : Optional[float] - Investment Income Balance (Billions of EUR) - investment_income_credit : Optional[float] - Investment Income Credits (Billions of EUR) - investment_income_debit : Optional[float] - Investment Income Debits (Billions of EUR) - secondary_income_balance : Optional[float] - Secondary Income Balance (Billions of EUR) - capital_account_balance : Optional[float] - Capital Account Balance (Billions of EUR) - - Examples - -------- - >>> from openbb import obb - >>> obb.economy.balance_of_payments(provider='ecb') - >>> obb.economy.balance_of_payments(report_type='summary', provider='ecb') - >>> # The `country` parameter will override the `report_type`. - >>> obb.economy.balance_of_payments(country='united_states', provider='ecb') - """ # noqa: E501 - - return self._run( - "/economy/balance_of_payments", - **filter_inputs( - provider_choices={ - "provider": self._get_provider( - provider, - "/economy/balance_of_payments", - ("ecb",), - ) - }, - standard_params={}, - extra_params=kwargs, - ) - ) - @exception_handler @validate def calendar( @@ -420,7 +135,7 @@ def calendar( OpenBBField(description="End date of the data, in YYYY-MM-DD format."), ] = None, provider: Annotated[ - Optional[Literal["fmp", "nasdaq", "tradingeconomics"]], + Optional[Literal["fmp", "tradingeconomics"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -435,12 +150,12 @@ def calendar( Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fmp', 'nasdaq', 'tradingeconomics']] + provider : Optional[Literal['fmp', 'tradingeconomics']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. country : Optional[str] - Country of the event Multiple comma separated items allowed. (provider: nasdaq, tradingeconomics) + Country of the event. Multiple comma separated items allowed. (provider: tradingeconomics) importance : Optional[Literal['Low', 'Medium', 'High']] Importance of the event. (provider: tradingeconomics) group : Optional[Literal['interest rate', 'inflation', 'bonds', 'consumer', 'gdp', 'government', 'housing', 'labour', 'markets', 'money', 'prices', 'trade', 'business']] @@ -451,7 +166,7 @@ def calendar( OBBject results : List[EconomicCalendar] Serializable results. - provider : Optional[Literal['fmp', 'nasdaq', 'tradingeconomics']] + provider : Optional[Literal['fmp', 'tradingeconomics']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -498,8 +213,6 @@ def calendar( Last updated timestamp. (provider: fmp) created_at : Optional[datetime] Created at timestamp. (provider: fmp) - description : Optional[str] - Event description. (provider: nasdaq) Examples -------- @@ -507,8 +220,6 @@ def calendar( >>> # By default, the calendar will be forward-looking. >>> obb.economy.calendar(provider='fmp') >>> obb.economy.calendar(provider='fmp', start_date='2020-03-01', end_date='2020-03-31') - >>> # By default, the calendar will be forward-looking. - >>> obb.economy.calendar(provider='nasdaq') """ # noqa: E501 return self._run( @@ -518,7 +229,7 @@ def calendar( "provider": self._get_provider( provider, "/economy/calendar", - ("fmp", "nasdaq", "tradingeconomics"), + ("fmp", "tradingeconomics"), ) }, standard_params={ @@ -527,10 +238,7 @@ def calendar( }, extra_params=kwargs, info={ - "country": { - "nasdaq": {"multiple_items_allowed": True}, - "tradingeconomics": {"multiple_items_allowed": True}, - } + "country": {"tradingeconomics": {"multiple_items_allowed": True}} }, ) ) @@ -1201,12 +909,6 @@ def fred_series( Optional[int], OpenBBField(description="The number of data entries to return."), ] = 100000, - chart: Annotated[ - bool, - OpenBBField( - description="Whether to create a chart or not, by default False." - ), - ] = False, provider: Annotated[ Optional[Literal["fred", "intrinio"]], OpenBBField( @@ -1227,8 +929,6 @@ def fred_series( End date of the data, in YYYY-MM-DD format. limit : Optional[int] The number of data entries to return. - chart : bool - Whether to create a chart or not, by default False. provider : Optional[Literal['fred', 'intrinio']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is @@ -1326,7 +1026,6 @@ def fred_series( "limit": limit, }, extra_params=kwargs, - chart=chart, info={"symbol": {"fred": {"multiple_items_allowed": True}}}, ) ) diff --git a/openbb_platform/openbb/package/equity.py b/openbb_platform/openbb/package/equity.py index 2e9c2cbb5fc3..c67112ac8a1c 100644 --- a/openbb_platform/openbb/package/equity.py +++ b/openbb_platform/openbb/package/equity.py @@ -14,7 +14,6 @@ class ROUTER_equity(Container): """/equity /calendar /compare - /darkpool /discovery /estimates /fundamental @@ -46,15 +45,6 @@ def compare(self): return equity_compare.ROUTER_equity_compare(command_runner=self._command_runner) - @property - def darkpool(self): - # pylint: disable=import-outside-toplevel - from . import equity_darkpool - - return equity_darkpool.ROUTER_equity_darkpool( - command_runner=self._command_runner - ) - @property def discovery(self): # pylint: disable=import-outside-toplevel @@ -264,13 +254,13 @@ def profile( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): finviz, fmp, intrinio, tmx, yfinance." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance." ), ], provider: Annotated[ - Optional[Literal["finviz", "fmp", "intrinio", "tmx", "yfinance"]], + Optional[Literal["fmp", "intrinio", "yfinance"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'finviz' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), ] = None, **kwargs @@ -280,10 +270,10 @@ def profile( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): finviz, fmp, intrinio, tmx, yfinance. - provider : Optional[Literal['finviz', 'fmp', 'intrinio', 'tmx', 'yfinance']] + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance. + provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'finviz' if there is + If None, the provider specified in defaults is selected or 'fmp' if there is no default. Returns @@ -291,7 +281,7 @@ def profile( OBBject results : List[EquityInfo] Serializable results. - provider : Optional[Literal['finviz', 'fmp', 'intrinio', 'tmx', 'yfinance']] + provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -378,33 +368,6 @@ def profile( Date of the company's first stock price. last_stock_price_date : Optional[date] Date of the company's last stock price. - index : Optional[str] - Included in indices - i.e., Dow, Nasdaq, or S&P. (provider: finviz) - optionable : Optional[str] - Whether options trade against the ticker. (provider: finviz) - shortable : Optional[str] - If the asset is shortable. (provider: finviz) - shares_outstanding : Optional[Union[str, int]] - The number of shares outstanding, as an abbreviated string. (provider: finviz); - The number of listed shares outstanding. (provider: tmx); - The number of listed shares outstanding. (provider: yfinance) - shares_float : Optional[Union[str, int]] - The number of shares in the public float, as an abbreviated string. (provider: finviz); - The number of shares in the public float. (provider: yfinance) - short_interest : Optional[str] - The last reported number of shares sold short, as an abbreviated string. (provider: finviz) - institutional_ownership : Optional[float] - The institutional ownership of the stock, as a normalized percent. (provider: finviz) - market_cap : Optional[int] - The market capitalization of the stock, as an abbreviated string. (provider: finviz); - Market capitalization of the company. (provider: fmp); - The market capitalization of the asset. (provider: yfinance) - dividend_yield : Optional[float] - The dividend yield of the stock, as a normalized percent. (provider: finviz, yfinance) - earnings_date : Optional[str] - The last, or next confirmed, earnings date and announcement time, as a string. The format is Nov 02 AMC - for after market close. (provider: finviz) - beta : Optional[float] - The beta of the stock relative to the broad market. (provider: finviz, fmp, yfinance) is_etf : Optional[bool] If the symbol is an ETF. (provider: fmp) is_actively_trading : Optional[bool] @@ -417,6 +380,9 @@ def profile( Image of the company. (provider: fmp) currency : Optional[str] Currency in which the stock is traded. (provider: fmp, yfinance) + market_cap : Optional[int] + Market capitalization of the company. (provider: fmp); + The market capitalization of the asset. (provider: yfinance) last_price : Optional[float] The last traded price. (provider: fmp) year_high : Optional[float] @@ -427,26 +393,26 @@ def profile( Average daily trading volume. (provider: fmp) annualized_dividend_amount : Optional[float] The annualized dividend payment based on the most recent regular dividend payment. (provider: fmp) + beta : Optional[float] + Beta of the stock relative to the market. (provider: fmp, yfinance) id : Optional[str] Intrinio ID for the company. (provider: intrinio) thea_enabled : Optional[bool] Whether the company has been enabled for Thea. (provider: intrinio) - email : Optional[str] - The email of the company. (provider: tmx) - issue_type : Optional[str] - The issuance type of the asset. (provider: tmx, yfinance) - shares_escrow : Optional[int] - The number of shares held in escrow. (provider: tmx) - shares_total : Optional[int] - The total number of shares outstanding from all classes. (provider: tmx) - dividend_frequency : Optional[str] - The dividend frequency. (provider: tmx) exchange_timezone : Optional[str] The timezone of the exchange. (provider: yfinance) + issue_type : Optional[str] + The issuance type of the asset. (provider: yfinance) + shares_outstanding : Optional[int] + The number of listed shares outstanding. (provider: yfinance) + shares_float : Optional[int] + The number of shares in the public float. (provider: yfinance) shares_implied_outstanding : Optional[int] Implied shares outstanding of common equityassuming the conversion of all convertible subsidiary equity into common. (provider: yfinance) shares_short : Optional[int] The reported number of shares short. (provider: yfinance) + dividend_yield : Optional[float] + The dividend yield of the asset, as a normalized percent. (provider: yfinance) Examples -------- @@ -461,7 +427,7 @@ def profile( "provider": self._get_provider( provider, "/equity/profile", - ("finviz", "fmp", "intrinio", "tmx", "yfinance"), + ("fmp", "intrinio", "yfinance"), ) }, standard_params={ @@ -470,10 +436,8 @@ def profile( extra_params=kwargs, info={ "symbol": { - "finviz": {"multiple_items_allowed": True}, "fmp": {"multiple_items_allowed": True}, "intrinio": {"multiple_items_allowed": True}, - "tmx": {"multiple_items_allowed": True}, "yfinance": {"multiple_items_allowed": True}, } }, @@ -616,9 +580,9 @@ def search( Optional[bool], OpenBBField(description="Whether to use the cache or not.") ] = True, provider: Annotated[ - Optional[Literal["cboe", "intrinio", "nasdaq", "sec", "tmx", "tradier"]], + Optional[Literal["intrinio", "sec"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'cboe' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'intrinio' if there is\n no default." ), ] = None, **kwargs @@ -633,16 +597,14 @@ def search( Whether to search by ticker symbol. use_cache : Optional[bool] Whether to use the cache or not. - provider : Optional[Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tra... + provider : Optional[Literal['intrinio', 'sec']] The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'cboe' if there is + If None, the provider specified in defaults is selected or 'intrinio' if there is no default. active : Optional[bool] 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. (provider: intrinio) limit : Optional[int] The number of data entries to return. (provider: intrinio) - is_etf : Optional[bool] - If True, returns ETFs. (provider: nasdaq) is_fund : bool Whether to direct the search to the list of mutual funds and ETFs. (provider: sec) @@ -651,7 +613,7 @@ def search( OBBject results : List[EquitySearch] Serializable results. - provider : Optional[Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier']] + provider : Optional[Literal['intrinio', 'sec']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -666,10 +628,6 @@ def search( Symbol representing the entity requested in the data. name : Optional[str] Name of the company. - dpm_name : Optional[str] - Name of the primary market maker. (provider: cboe) - post_station : Optional[str] - Post and station location on the CBOE trading floor. (provider: cboe) cik : Optional[str] ; Central Index Key (provider: sec) @@ -677,35 +635,11 @@ def search( The Legal Entity Identifier (LEI) of the company. (provider: intrinio) intrinio_id : Optional[str] The Intrinio ID of the company. (provider: intrinio) - nasdaq_traded : Optional[str] - Is Nasdaq traded? (provider: nasdaq) - exchange : Optional[str] - Primary Exchange (provider: nasdaq); - Exchange where the security is listed. (provider: tradier) - market_category : Optional[str] - Market Category (provider: nasdaq) - etf : Optional[str] - Is ETF? (provider: nasdaq) - round_lot_size : Optional[float] - Round Lot Size (provider: nasdaq) - test_issue : Optional[str] - Is test Issue? (provider: nasdaq) - financial_status : Optional[str] - Financial Status (provider: nasdaq) - cqs_symbol : Optional[str] - CQS Symbol (provider: nasdaq) - nasdaq_symbol : Optional[str] - NASDAQ Symbol (provider: nasdaq) - next_shares : Optional[str] - Is NextShares? (provider: nasdaq) - security_type : Optional[Literal['stock', 'option', 'etf', 'index', 'mutual_fund']] - Type of security. (provider: tradier) Examples -------- >>> from openbb import obb >>> obb.equity.search(provider='intrinio') - >>> obb.equity.search(query='AAPL', is_symbol=False, use_cache=True, provider='nasdaq') """ # noqa: E501 return self._run( @@ -715,7 +649,7 @@ def search( "provider": self._get_provider( provider, "/equity/search", - ("cboe", "intrinio", "nasdaq", "sec", "tmx", "tradier"), + ("intrinio", "sec"), ) }, standard_params={ diff --git a/openbb_platform/openbb/package/equity_calendar.py b/openbb_platform/openbb/package/equity_calendar.py index dac5cc6ea73e..891ac9995f0a 100644 --- a/openbb_platform/openbb/package/equity_calendar.py +++ b/openbb_platform/openbb/package/equity_calendar.py @@ -35,7 +35,7 @@ def dividend( OpenBBField(description="End date of the data, in YYYY-MM-DD format."), ] = None, provider: Annotated[ - Optional[Literal["fmp", "nasdaq"]], + Optional[Literal["fmp"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -50,7 +50,7 @@ def dividend( Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fmp', 'nasdaq']] + provider : Optional[Literal['fmp']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. @@ -60,7 +60,7 @@ def dividend( OBBject results : List[CalendarDividend] Serializable results. - provider : Optional[Literal['fmp', 'nasdaq']] + provider : Optional[Literal['fmp']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -89,15 +89,11 @@ def dividend( The adjusted-dividend amount. (provider: fmp) label : Optional[str] Ex-dividend date formatted for display. (provider: fmp) - annualized_amount : Optional[float] - The indicated annualized dividend amount. (provider: nasdaq) Examples -------- >>> from openbb import obb >>> obb.equity.calendar.dividend(provider='fmp') - >>> # Get dividend calendar for specific dates. - >>> obb.equity.calendar.dividend(start_date='2024-02-01', end_date='2024-02-07', provider='nasdaq') """ # noqa: E501 return self._run( @@ -107,7 +103,7 @@ def dividend( "provider": self._get_provider( provider, "/equity/calendar/dividend", - ("fmp", "nasdaq"), + ("fmp",), ) }, standard_params={ @@ -131,7 +127,7 @@ def earnings( OpenBBField(description="End date of the data, in YYYY-MM-DD format."), ] = None, provider: Annotated[ - Optional[Literal["fmp", "nasdaq", "tmx"]], + Optional[Literal["fmp"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -146,7 +142,7 @@ def earnings( Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fmp', 'nasdaq', 'tmx']] + provider : Optional[Literal['fmp']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. @@ -156,7 +152,7 @@ def earnings( OBBject results : List[CalendarEarnings] Serializable results. - provider : Optional[Literal['fmp', 'nasdaq', 'tmx']] + provider : Optional[Literal['fmp']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -178,30 +174,17 @@ def earnings( eps_consensus : Optional[float] The analyst conesus earnings-per-share estimate. eps_actual : Optional[float] - The actual earnings per share announced. (provider: fmp, nasdaq); - The actual EPS in dollars. (provider: tmx) + The actual earnings per share announced. (provider: fmp) revenue_actual : Optional[float] The actual reported revenue. (provider: fmp) revenue_consensus : Optional[float] The revenue forecast consensus. (provider: fmp) - period_ending : Optional[Union[date, str]] - The fiscal period end date. (provider: fmp, nasdaq) + period_ending : Optional[date] + The fiscal period end date. (provider: fmp) reporting_time : Optional[str] - The reporting time - e.g. after market close. (provider: fmp, nasdaq); - The time of the report - i.e., before or after market. (provider: tmx) + The reporting time - e.g. after market close. (provider: fmp) updated_date : Optional[date] The date the data was updated last. (provider: fmp) - surprise_percent : Optional[float] - The earnings surprise as normalized percentage points. (provider: nasdaq); - The EPS surprise as a normalized percent. (provider: tmx) - num_estimates : Optional[int] - The number of analysts providing estimates for the consensus. (provider: nasdaq) - previous_report_date : Optional[date] - The previous report date for the same period last year. (provider: nasdaq) - market_cap : Optional[int] - The market cap (USD) of the reporting entity. (provider: nasdaq) - eps_surprise : Optional[float] - The EPS surprise in dollars. (provider: tmx) Examples -------- @@ -218,7 +201,7 @@ def earnings( "provider": self._get_provider( provider, "/equity/calendar/earnings", - ("fmp", "nasdaq", "tmx"), + ("fmp",), ) }, standard_params={ @@ -249,7 +232,7 @@ def ipo( OpenBBField(description="The number of data entries to return."), ] = 100, provider: Annotated[ - Optional[Literal["intrinio", "nasdaq"]], + Optional[Literal["intrinio"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'intrinio' if there is\n no default." ), @@ -268,26 +251,23 @@ def ipo( End date of the data, in YYYY-MM-DD format. limit : Optional[int] The number of data entries to return. - provider : Optional[Literal['intrinio', 'nasdaq']] + provider : Optional[Literal['intrinio']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. - status : Optional[Union[Literal['upcoming', 'priced', 'withdrawn'], Literal['upcoming', 'priced', 'filed', 'withdrawn']]] - Status of the IPO. [upcoming, priced, or withdrawn] (provider: intrinio); - The status of the IPO. (provider: nasdaq) + status : Optional[Literal['upcoming', 'priced', 'withdrawn']] + Status of the IPO. [upcoming, priced, or withdrawn] (provider: intrinio) min_value : Optional[int] Return IPOs with an offer dollar amount greater than the given amount. (provider: intrinio) max_value : Optional[int] Return IPOs with an offer dollar amount less than the given amount. (provider: intrinio) - is_spo : bool - If True, returns data for secondary public offerings (SPOs). (provider: nasdaq) Returns ------- OBBject results : List[CalendarIpo] Serializable results. - provider : Optional[Literal['intrinio', 'nasdaq']] + provider : Optional[Literal['intrinio']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -307,8 +287,7 @@ def ipo( exchange : Optional[str] The acronym of the stock exchange that the company is going to trade publicly on. Typically NYSE or NASDAQ. (provider: intrinio) offer_amount : Optional[float] - The total dollar amount of shares offered in the IPO. Typically this is share price * share count (provider: intrinio); - The dollar value of the shares offered. (provider: nasdaq) + The total dollar amount of shares offered in the IPO. Typically this is share price * share count (provider: intrinio) share_price : Optional[float] The price per share at which the IPO was offered. (provider: intrinio) share_price_lowest : Optional[float] @@ -316,7 +295,7 @@ def ipo( share_price_highest : Optional[float] 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). (provider: intrinio) share_count : Optional[int] - The number of shares offered in the IPO. (provider: intrinio, nasdaq) + The number of shares offered in the IPO. (provider: intrinio) share_count_lowest : Optional[int] 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). (provider: intrinio) share_count_highest : Optional[int] @@ -343,26 +322,13 @@ def ipo( The company that is going public via the IPO. (provider: intrinio) security : Optional[IntrinioSecurity] The primary Security for the Company that is going public via the IPO (provider: intrinio) - name : Optional[str] - The name of the company. (provider: nasdaq) - expected_price_date : Optional[date] - The date the pricing is expected. (provider: nasdaq) - filed_date : Optional[date] - The date the IPO was filed. (provider: nasdaq) - withdraw_date : Optional[date] - The date the IPO was withdrawn. (provider: nasdaq) - deal_status : Optional[str] - The status of the deal. (provider: nasdaq) Examples -------- >>> from openbb import obb >>> obb.equity.calendar.ipo(provider='intrinio') - >>> obb.equity.calendar.ipo(limit=100, provider='nasdaq') >>> # Get all IPOs available. >>> obb.equity.calendar.ipo(provider='intrinio') - >>> # Get IPOs for specific dates. - >>> obb.equity.calendar.ipo(start_date='2024-02-01', end_date='2024-02-07', provider='nasdaq') """ # noqa: E501 return self._run( @@ -372,7 +338,7 @@ def ipo( "provider": self._get_provider( provider, "/equity/calendar/ipo", - ("intrinio", "nasdaq"), + ("intrinio",), ) }, standard_params={ diff --git a/openbb_platform/openbb/package/equity_compare.py b/openbb_platform/openbb/package/equity_compare.py index dbdaed5e6e53..6daed76b8562 100644 --- a/openbb_platform/openbb/package/equity_compare.py +++ b/openbb_platform/openbb/package/equity_compare.py @@ -12,145 +12,12 @@ class ROUTER_equity_compare(Container): """/equity/compare - groups peers """ def __repr__(self) -> str: return self.__doc__ or "" - @exception_handler - @validate - def groups( - self, - group: Annotated[ - Optional[str], - OpenBBField( - description="The group to compare - i.e., 'sector', 'industry', 'country'. Choices vary by provider." - ), - ] = None, - metric: Annotated[ - Optional[str], - OpenBBField( - description="The type of metrics to compare - i.e, 'valuation', 'performance'. Choices vary by provider." - ), - ] = None, - provider: Annotated[ - Optional[Literal["finviz"]], - OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'finviz' if there is\n no default." - ), - ] = None, - **kwargs - ) -> OBBject: - """Get company data grouped by sector, industry or country and display either performance or valuation metrics. - - Valuation metrics include price to earnings, price to book, price to sales ratios and price to cash flow. - Performance metrics include the stock price change for different time periods. - - - Parameters - ---------- - group : Optional[str] - The group to compare - i.e., 'sector', 'industry', 'country'. Choices vary by provider. - metric : Optional[str] - The type of metrics to compare - i.e, 'valuation', 'performance'. Choices vary by provider. - provider : Optional[Literal['finviz']] - The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'finviz' if there is - no default. - - Returns - ------- - OBBject - results : List[CompareGroups] - Serializable results. - provider : Optional[Literal['finviz']] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - - CompareGroups - ------------- - name : str - Name or label of the group. - stocks : Optional[int] - The number of stocks in the group. (provider: finviz) - market_cap : Optional[int] - The market cap of the group. (provider: finviz) - performance_1_d : Optional[float] - The performance in the last day, as a normalized percent. (provider: finviz) - performance_1_w : Optional[float] - The performance in the last week, as a normalized percent. (provider: finviz) - performance_1_m : Optional[float] - The performance in the last month, as a normalized percent. (provider: finviz) - performance_3_m : Optional[float] - The performance in the last quarter, as a normalized percent. (provider: finviz) - performance_6_m : Optional[float] - The performance in the last half year, as a normalized percent. (provider: finviz) - performance_1_y : Optional[float] - The performance in the last year, as a normalized percent. (provider: finviz) - performance_ytd : Optional[float] - The performance in the year to date, as a normalized percent. (provider: finviz) - dividend_yield : Optional[float] - The dividend yield of the group, as a normalized percent. (provider: finviz) - pe : Optional[float] - The P/E ratio of the group. (provider: finviz) - forward_pe : Optional[float] - The forward P/E ratio of the group. (provider: finviz) - peg : Optional[float] - The PEG ratio of the group. (provider: finviz) - eps_growth_past_5_years : Optional[float] - The EPS growth of the group for the past 5 years, as a normalized percent. (provider: finviz) - eps_growth_next_5_years : Optional[float] - The estimated EPS growth of the groupo for the next 5 years, as a normalized percent. (provider: finviz) - sales_growth_past_5_years : Optional[float] - The sales growth of the group for the past 5 years, as a normalized percent. (provider: finviz) - float_short : Optional[float] - The percent of the float shorted for the group, as a normalized value. (provider: finviz) - analyst_recommendation : Optional[float] - The analyst consensus, on a scale of 1-5 where 1 is a buy and 5 is a sell. (provider: finviz) - volume : Optional[int] - The trading volume. (provider: finviz) - volume_average : Optional[int] - The 3-month average volume of the group. (provider: finviz) - volume_relative : Optional[float] - The relative volume compared to the 3-month average volume. (provider: finviz) - - Examples - -------- - >>> from openbb import obb - >>> obb.equity.compare.groups(provider='finviz') - >>> # Group by sector and analyze valuation. - >>> obb.equity.compare.groups(group='sector', metric='valuation', provider='finviz') - >>> # Group by industry and analyze performance. - >>> obb.equity.compare.groups(group='industry', metric='performance', provider='finviz') - >>> # Group by country and analyze valuation. - >>> obb.equity.compare.groups(group='country', metric='valuation', provider='finviz') - """ # noqa: E501 - - return self._run( - "/equity/compare/groups", - **filter_inputs( - provider_choices={ - "provider": self._get_provider( - provider, - "/equity/compare/groups", - ("finviz",), - ) - }, - standard_params={ - "group": group, - "metric": metric, - }, - extra_params=kwargs, - ) - ) - @exception_handler @validate def peers( diff --git a/openbb_platform/openbb/package/equity_discovery.py b/openbb_platform/openbb/package/equity_discovery.py index b5e20c44b697..770a2ce6daea 100644 --- a/openbb_platform/openbb/package/equity_discovery.py +++ b/openbb_platform/openbb/package/equity_discovery.py @@ -19,10 +19,8 @@ class ROUTER_equity_discovery(Container): gainers growth_tech losers - top_retail undervalued_growth undervalued_large_caps - upcoming_release_days """ def __repr__(self) -> str: @@ -326,9 +324,9 @@ def gainers( ), ] = "desc", provider: Annotated[ - Optional[Literal["tmx", "yfinance"]], + Optional[Literal["yfinance"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'tmx' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'yfinance' if there is\n no default." ), ] = None, **kwargs @@ -339,19 +337,17 @@ def gainers( ---------- sort : Literal['asc', 'desc'] Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. - provider : Optional[Literal['tmx', 'yfinance']] + provider : Optional[Literal['yfinance']] The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'tmx' if there is + If None, the provider specified in defaults is selected or 'yfinance' if there is no default. - category : Literal['dividend', 'energy', 'healthcare', 'industrials', 'price_performer', 'rising_stars', 'real_estate', 'tech', 'utilities', '52w_high', 'volume'] - The category of list to retrieve. Defaults to `price_performer`. (provider: tmx) Returns ------- OBBject results : List[EquityGainers] Serializable results. - provider : Optional[Literal['tmx', 'yfinance']] + provider : Optional[Literal['yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -374,8 +370,6 @@ def gainers( Percent change. volume : float The trading volume. - rank : Optional[int] - The rank of the stock in the list. (provider: tmx) market_cap : Optional[float] Market Cap. (provider: yfinance) avg_volume_3_months : Optional[float] @@ -397,7 +391,7 @@ def gainers( "provider": self._get_provider( provider, "/equity/discovery/gainers", - ("tmx", "yfinance"), + ("yfinance",), ) }, standard_params={ @@ -583,84 +577,6 @@ def losers( ) ) - @exception_handler - @validate - def top_retail( - self, - limit: Annotated[ - int, OpenBBField(description="The number of data entries to return.") - ] = 5, - provider: Annotated[ - Optional[Literal["nasdaq"]], - OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'nasdaq' if there is\n no default." - ), - ] = None, - **kwargs - ) -> OBBject: - """Track over $30B USD/day of individual investors trades. - - It gives a daily view into retail activity and sentiment for over 9,500 US traded stocks, - ADRs, and ETPs. - - - Parameters - ---------- - limit : int - The number of data entries to return. - provider : Optional[Literal['nasdaq']] - The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'nasdaq' if there is - no default. - - Returns - ------- - OBBject - results : List[TopRetail] - Serializable results. - provider : Optional[Literal['nasdaq']] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - - TopRetail - --------- - date : date - The date of the data. - symbol : str - Symbol representing the entity requested in the data. - activity : float - Activity of the symbol. - sentiment : float - Sentiment of the symbol. 1 is bullish, -1 is bearish. - - Examples - -------- - >>> from openbb import obb - >>> obb.equity.discovery.top_retail(provider='nasdaq') - """ # noqa: E501 - - return self._run( - "/equity/discovery/top_retail", - **filter_inputs( - provider_choices={ - "provider": self._get_provider( - provider, - "/equity/discovery/top_retail", - ("nasdaq",), - ) - }, - standard_params={ - "limit": limit, - }, - extra_params=kwargs, - ) - ) - @exception_handler @validate def undervalued_growth( @@ -836,76 +752,3 @@ def undervalued_large_caps( extra_params=kwargs, ) ) - - @exception_handler - @validate - def upcoming_release_days( - self, - provider: Annotated[ - Optional[Literal["seeking_alpha"]], - OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'seeking_alpha' if there is\n no default." - ), - ] = None, - **kwargs - ) -> OBBject: - """Get upcoming earnings release dates. - - Parameters - ---------- - provider : Optional[Literal['seeking_alpha']] - The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'seeking_alpha' if there is - no default. - limit : int - The number of data entries to return.In this case, the number of lookahead days. (provider: seeking_alpha) - - Returns - ------- - OBBject - results : List[UpcomingReleaseDays] - Serializable results. - provider : Optional[Literal['seeking_alpha']] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - - UpcomingReleaseDays - ------------------- - symbol : str - Symbol representing the entity requested in the data. - name : str - The full name of the asset. - exchange : str - The exchange the asset is traded on. - release_time_type : str - The type of release time. - release_date : date - The date of the release. - sector_id : Optional[int] - The sector ID of the asset. (provider: seeking_alpha) - - Examples - -------- - >>> from openbb import obb - >>> obb.equity.discovery.upcoming_release_days(provider='seeking_alpha') - """ # noqa: E501 - - return self._run( - "/equity/discovery/upcoming_release_days", - **filter_inputs( - provider_choices={ - "provider": self._get_provider( - provider, - "/equity/discovery/upcoming_release_days", - ("seeking_alpha",), - ) - }, - standard_params={}, - extra_params=kwargs, - ) - ) diff --git a/openbb_platform/openbb/package/equity_estimates.py b/openbb_platform/openbb/package/equity_estimates.py index 6d499634e996..01b95add7a5d 100644 --- a/openbb_platform/openbb/package/equity_estimates.py +++ b/openbb_platform/openbb/package/equity_estimates.py @@ -238,11 +238,11 @@ def consensus( symbol: Annotated[ Union[str, None, List[Optional[str]]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, tmx, yfinance." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance." ), ] = None, provider: Annotated[ - Optional[Literal["fmp", "intrinio", "tmx", "yfinance"]], + Optional[Literal["fmp", "intrinio", "yfinance"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -254,8 +254,8 @@ def consensus( Parameters ---------- symbol : Union[str, None, List[Optional[str]]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, tmx, yfinance. - provider : Optional[Literal['fmp', 'intrinio', 'tmx', 'yfinance']] + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance. + provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. @@ -267,7 +267,7 @@ def consensus( OBBject results : List[PriceTargetConsensus] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'tmx', 'yfinance']] + provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -302,18 +302,6 @@ def consensus( The date of the most recent estimate. (provider: intrinio) industry_group_number : Optional[int] The Zacks industry group number. (provider: intrinio) - target_upside : Optional[float] - Percent of upside, as a normalized percent. (provider: tmx) - total_analysts : Optional[int] - Total number of analyst. (provider: tmx) - buy_ratings : Optional[int] - Number of buy ratings. (provider: tmx) - sell_ratings : Optional[int] - Number of sell ratings. (provider: tmx) - hold_ratings : Optional[int] - Number of hold ratings. (provider: tmx) - consensus_action : Optional[str] - Consensus action. (provider: tmx) recommendation : Optional[str] Recommendation - buy, sell, etc. (provider: yfinance) recommendation_mean : Optional[float] @@ -339,7 +327,7 @@ def consensus( "provider": self._get_provider( provider, "/equity/estimates/consensus", - ("fmp", "intrinio", "tmx", "yfinance"), + ("fmp", "intrinio", "yfinance"), ) }, standard_params={ @@ -350,7 +338,6 @@ def consensus( "symbol": { "fmp": {"multiple_items_allowed": True}, "intrinio": {"multiple_items_allowed": True}, - "tmx": {"multiple_items_allowed": True}, "yfinance": {"multiple_items_allowed": True}, } }, @@ -729,14 +716,14 @@ def price_target( symbol: Annotated[ Union[str, None, List[Optional[str]]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, finviz, fmp." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp." ), ] = None, limit: Annotated[ int, OpenBBField(description="The number of data entries to return.") ] = 200, provider: Annotated[ - Optional[Literal["benzinga", "finviz", "fmp"]], + Optional[Literal["benzinga", "fmp"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'benzinga' if there is\n no default." ), @@ -748,10 +735,10 @@ def price_target( Parameters ---------- symbol : Union[str, None, List[Optional[str]]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, finviz, fmp. + Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp. limit : int The number of data entries to return. - provider : Optional[Literal['benzinga', 'finviz', 'fmp']] + provider : Optional[Literal['benzinga', 'fmp']] 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. @@ -783,7 +770,7 @@ def price_target( OBBject results : List[PriceTarget] Serializable results. - provider : Optional[Literal['benzinga', 'finviz', 'fmp']] + provider : Optional[Literal['benzinga', 'fmp']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -842,10 +829,6 @@ def price_target( Unique ID of this entry. (provider: benzinga) last_updated : Optional[datetime] Last updated timestamp, UTC. (provider: benzinga) - status : Optional[str] - The action taken by the firm. This could be 'Upgrade', 'Downgrade', 'Reiterated', etc. (provider: finviz) - rating_change : Optional[str] - The rating given by the analyst. This could be 'Buy', 'Sell', 'Underweight', etc. If the rating is a revision, the change is indicated by '->' (provider: finviz) news_url : Optional[str] News URL of the price target. (provider: fmp) news_title : Optional[str] @@ -870,7 +853,7 @@ def price_target( "provider": self._get_provider( provider, "/equity/estimates/price_target", - ("benzinga", "finviz", "fmp"), + ("benzinga", "fmp"), ) }, standard_params={ @@ -881,7 +864,6 @@ def price_target( info={ "symbol": { "benzinga": {"multiple_items_allowed": True}, - "finviz": {"multiple_items_allowed": True}, "fmp": {"multiple_items_allowed": True}, } }, diff --git a/openbb_platform/openbb/package/equity_fundamental.py b/openbb_platform/openbb/package/equity_fundamental.py index f9a62be1a85e..cc734d0f02ac 100644 --- a/openbb_platform/openbb/package/equity_fundamental.py +++ b/openbb_platform/openbb/package/equity_fundamental.py @@ -970,12 +970,7 @@ def cash_growth( @validate def dividends( self, - symbol: Annotated[ - Union[str, List[str]], - OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): nasdaq." - ), - ], + symbol: Annotated[str, OpenBBField(description="Symbol to get data for.")], start_date: Annotated[ Union[datetime.date, None, str], OpenBBField(description="Start date of the data, in YYYY-MM-DD format."), @@ -985,7 +980,7 @@ def dividends( OpenBBField(description="End date of the data, in YYYY-MM-DD format."), ] = None, provider: Annotated[ - Optional[Literal["fmp", "intrinio", "nasdaq", "tmx", "yfinance"]], + Optional[Literal["fmp", "intrinio", "yfinance"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -996,13 +991,13 @@ def dividends( Parameters ---------- - symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): nasdaq. + symbol : str + Symbol to get data for. start_date : Union[datetime.date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fmp', 'intrinio', 'nasdaq', 'tmx', 'yfinance']] + provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. @@ -1014,7 +1009,7 @@ def dividends( OBBject results : List[HistoricalDividends] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'nasdaq', 'tmx', 'yfinance']] + provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -1034,25 +1029,17 @@ def dividends( adj_dividend : Optional[float] Adjusted dividend of the historical dividends. (provider: fmp) record_date : Optional[date] - Record date of the historical dividends. (provider: fmp); - The record date of ownership for eligibility. (provider: nasdaq); - The record date of ownership for rights to the dividend. (provider: tmx) + Record date of the historical dividends. (provider: fmp) payment_date : Optional[date] - Payment date of the historical dividends. (provider: fmp); - The payment date of the dividend. (provider: nasdaq); - The date the dividend is paid. (provider: tmx) + Payment date of the historical dividends. (provider: fmp) declaration_date : Optional[date] - Declaration date of the historical dividends. (provider: fmp, nasdaq) + Declaration date of the historical dividends. (provider: fmp) factor : Optional[float] factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices. (provider: intrinio) currency : Optional[str] - The currency in which the dividend is paid. (provider: intrinio, nasdaq, tmx) + The currency in which the dividend is paid. (provider: intrinio) split_ratio : Optional[float] The ratio of the stock split, if a stock split occurred. (provider: intrinio) - dividend_type : Optional[str] - The type of dividend - i.e., cash, stock. (provider: nasdaq) - decalaration_date : Optional[date] - The date of the announcement. (provider: tmx) Examples -------- @@ -1067,7 +1054,7 @@ def dividends( "provider": self._get_provider( provider, "/equity/fundamental/dividends", - ("fmp", "intrinio", "nasdaq", "tmx", "yfinance"), + ("fmp", "intrinio", "yfinance"), ) }, standard_params={ @@ -1076,7 +1063,6 @@ def dividends( "end_date": end_date, }, extra_params=kwargs, - info={"symbol": {"nasdaq": {"multiple_items_allowed": True}}}, ) ) @@ -1179,7 +1165,7 @@ def filings( int, OpenBBField(description="The number of data entries to return.") ] = 100, provider: Annotated[ - Optional[Literal["fmp", "intrinio", "sec", "tmx"]], + Optional[Literal["fmp", "intrinio", "sec"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -1201,16 +1187,14 @@ def filings( Filter by form type. Check the data provider for available types. limit : int The number of data entries to return. - provider : Optional[Literal['fmp', 'intrinio', 'sec', 'tmx']] + provider : Optional[Literal['fmp', 'intrinio', 'sec']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. start_date : Optional[datetime.date] - Start date of the data, in YYYY-MM-DD format. (provider: intrinio); - The start date to fetch. (provider: tmx) + Start date of the data, in YYYY-MM-DD format. (provider: intrinio) end_date : Optional[datetime.date] - End date of the data, in YYYY-MM-DD format. (provider: intrinio); - The end date to fetch. (provider: tmx) + End date of the data, in YYYY-MM-DD format. (provider: intrinio) thea_enabled : Optional[bool] Return filings that have been read by Intrinio's Thea NLP. (provider: intrinio) cik : Optional[Union[int, str]] @@ -1223,7 +1207,7 @@ def filings( OBBject results : List[CompanyFilings] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'sec', 'tmx']] + provider : Optional[Literal['fmp', 'intrinio', 'sec']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -1281,14 +1265,11 @@ def filings( is_xbrl : Optional[Union[int, str]] Whether the filing is an XBRL filing. (provider: sec) size : Optional[Union[int, str]] - The size of the filing. (provider: sec); - The file size of the PDF document. (provider: tmx) + The size of the filing. (provider: sec) complete_submission_url : Optional[str] The URL to the complete filing submission. (provider: sec) filing_detail_url : Optional[str] The URL to the filing details. (provider: sec) - description : Optional[str] - The description of the filing. (provider: tmx) Examples -------- @@ -1304,7 +1285,7 @@ def filings( "provider": self._get_provider( provider, "/equity/fundamental/filings", - ("fmp", "intrinio", "sec", "tmx"), + ("fmp", "intrinio", "sec"), ) }, standard_params={ @@ -1450,16 +1431,11 @@ def historical_attributes( @validate def historical_eps( self, - symbol: Annotated[ - Union[str, List[str]], - OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): alpha_vantage." - ), - ], + symbol: Annotated[str, OpenBBField(description="Symbol to get data for.")], provider: Annotated[ - Optional[Literal["alpha_vantage", "fmp"]], + Optional[Literal["fmp"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'alpha_vantage' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), ] = None, **kwargs @@ -1468,23 +1444,21 @@ def historical_eps( Parameters ---------- - symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): alpha_vantage. - provider : Optional[Literal['alpha_vantage', 'fmp']] + symbol : str + Symbol to get data for. + provider : Optional[Literal['fmp']] The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'alpha_vantage' if there is + If None, the provider specified in defaults is selected or 'fmp' if there is no default. - period : Literal['annual', 'quarter'] - Time period of the data to return. (provider: alpha_vantage) limit : Optional[int] - The number of data entries to return. (provider: alpha_vantage, fmp) + The number of data entries to return. (provider: fmp) Returns ------- OBBject results : List[HistoricalEps] Serializable results. - provider : Optional[Literal['alpha_vantage', 'fmp']] + provider : Optional[Literal['fmp']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -1505,12 +1479,6 @@ def historical_eps( Actual EPS from the earnings date. eps_estimated : Optional[float] Estimated EPS for the earnings date. - surprise : Optional[float] - Surprise in EPS (Actual - Estimated). (provider: alpha_vantage) - surprise_percent : Optional[Union[float, str]] - EPS surprise as a normalized percent. (provider: alpha_vantage) - reported_date : Optional[date] - Date of the earnings report. (provider: alpha_vantage) revenue_estimated : Optional[float] Estimated consensus revenue for the reporting period. (provider: fmp) revenue_actual : Optional[float] @@ -1535,14 +1503,13 @@ def historical_eps( "provider": self._get_provider( provider, "/equity/fundamental/historical_eps", - ("alpha_vantage", "fmp"), + ("fmp",), ) }, standard_params={ "symbol": symbol, }, extra_params=kwargs, - info={"symbol": {"alpha_vantage": {"multiple_items_allowed": True}}}, ) ) @@ -2395,7 +2362,7 @@ def metrics( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): finviz, fmp, intrinio, yfinance." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance." ), ], period: Annotated[ @@ -2407,9 +2374,9 @@ def metrics( OpenBBField(description="The number of data entries to return."), ] = 100, provider: Annotated[ - Optional[Literal["finviz", "fmp", "intrinio", "yfinance"]], + Optional[Literal["fmp", "intrinio", "yfinance"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'finviz' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), ] = None, **kwargs @@ -2419,14 +2386,14 @@ def metrics( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): finviz, fmp, intrinio, yfinance. + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance. period : Optional[Literal['annual', 'quarter']] Time period of the data to return. limit : Optional[int] The number of data entries to return. - provider : Optional[Literal['finviz', 'fmp', 'intrinio', 'yfinance']] + provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'finviz' if there is + If None, the provider specified in defaults is selected or 'fmp' if there is no default. with_ttm : Optional[bool] Include trailing twelve months (TTM) data. (provider: fmp) @@ -2436,7 +2403,7 @@ def metrics( OBBject results : List[KeyMetrics] Serializable results. - provider : Optional[Literal['finviz', 'fmp', 'intrinio', 'yfinance']] + provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -2453,54 +2420,6 @@ def metrics( Market capitalization pe_ratio : Optional[float] Price-to-earnings ratio (P/E ratio) - foward_pe : Optional[float] - Forward price-to-earnings ratio (forward P/E) (provider: finviz) - eps : Optional[float] - Earnings per share (EPS) (provider: finviz); - Basic earnings per share. (provider: intrinio) - price_to_sales : Optional[float] - Price-to-sales ratio (P/S) (provider: finviz) - price_to_book : Optional[float] - Price-to-book ratio (P/B) (provider: finviz, intrinio, yfinance) - book_value_per_share : Optional[float] - Book value per share (Book/sh) (provider: finviz); - Book value per share (provider: fmp) - price_to_cash : Optional[float] - Price-to-cash ratio (P/C) (provider: finviz) - cash_per_share : Optional[float] - Cash per share (Cash/sh) (provider: finviz); - Cash per share (provider: fmp); - Cash per share. (provider: yfinance) - price_to_free_cash_flow : Optional[float] - Price-to-free cash flow ratio (P/FCF) (provider: finviz) - debt_to_equity : Optional[float] - Debt-to-equity ratio (Debt/Eq) (provider: finviz); - Debt-to-equity ratio (provider: fmp); - Debt-to-equity ratio. (provider: yfinance) - long_term_debt_to_equity : Optional[float] - Long-term debt-to-equity ratio (LT Debt/Eq) (provider: finviz) - quick_ratio : Optional[float] - Quick ratio (provider: finviz, intrinio, yfinance) - current_ratio : Optional[float] - Current ratio (provider: finviz, fmp, yfinance) - gross_margin : Optional[float] - Gross margin, as a normalized percent. (provider: finviz, intrinio, yfinance) - profit_margin : Optional[float] - Profit margin, as a normalized percent. (provider: finviz, intrinio, yfinance) - operating_margin : Optional[float] - Operating margin, as a normalized percent. (provider: finviz, yfinance) - return_on_assets : Optional[float] - Return on assets (ROA), as a normalized percent. (provider: finviz, intrinio, yfinance) - return_on_investment : Optional[float] - Return on investment (ROI), as a normalized percent. (provider: finviz) - return_on_equity : Optional[float] - Return on equity (ROE), as a normalized percent. (provider: finviz, intrinio, yfinance) - payout_ratio : Optional[float] - Payout ratio, as a normalized percent. (provider: finviz); - Payout ratio (provider: fmp); - Payout ratio. (provider: yfinance) - dividend_yield : Optional[float] - Dividend yield, as a normalized percent. (provider: finviz, fmp, intrinio, yfinance) date : Optional[date] The date of the data. (provider: fmp) period : Optional[str] @@ -2515,6 +2434,10 @@ def metrics( Operating cash flow per share (provider: fmp) free_cash_flow_per_share : Optional[float] Free cash flow per share (provider: fmp) + cash_per_share : Optional[float] + Cash per share (provider: fmp, yfinance) + book_value_per_share : Optional[float] + Book value per share (provider: fmp) tangible_book_value_per_share : Optional[float] Tangible book value per share (provider: fmp) shareholders_equity_per_share : Optional[float] @@ -2546,14 +2469,22 @@ def metrics( Earnings yield, as a normalized percent. (provider: intrinio) free_cash_flow_yield : Optional[float] Free cash flow yield (provider: fmp) + debt_to_equity : Optional[float] + Debt-to-equity ratio (provider: fmp, yfinance) debt_to_assets : Optional[float] Debt-to-assets ratio (provider: fmp) net_debt_to_ebitda : Optional[float] Net debt-to-EBITDA ratio (provider: fmp) + current_ratio : Optional[float] + Current ratio (provider: fmp, yfinance) interest_coverage : Optional[float] Interest coverage (provider: fmp) income_quality : Optional[float] Income quality (provider: fmp) + dividend_yield : Optional[float] + Dividend yield, as a normalized percent. (provider: fmp, intrinio, yfinance) + payout_ratio : Optional[float] + Payout ratio (provider: fmp, yfinance) sales_general_and_administrative_to_revenue : Optional[float] Sales general and administrative expenses-to-revenue ratio (provider: fmp) research_and_development_to_revenue : Optional[float] @@ -2606,12 +2537,22 @@ def metrics( Return on equity (provider: fmp) capex_per_share : Optional[float] Capital expenditures per share (provider: fmp) + price_to_book : Optional[float] + Price to book ratio. (provider: intrinio, yfinance) price_to_tangible_book : Optional[float] Price to tangible book ratio. (provider: intrinio) price_to_revenue : Optional[float] Price to revenue ratio. (provider: intrinio) + quick_ratio : Optional[float] + Quick ratio. (provider: intrinio, yfinance) + gross_margin : Optional[float] + Gross margin, as a normalized percent. (provider: intrinio, yfinance) ebit_margin : Optional[float] EBIT margin, as a normalized percent. (provider: intrinio) + profit_margin : Optional[float] + Profit margin, as a normalized percent. (provider: intrinio, yfinance) + eps : Optional[float] + Basic earnings per share. (provider: intrinio) eps_growth : Optional[float] EPS growth, as a normalized percent. (provider: intrinio) revenue_growth : Optional[float] @@ -2626,6 +2567,10 @@ def metrics( Free cash flow to firm growth, as a normalized percent. (provider: intrinio) invested_capital_growth : Optional[float] Invested capital growth, as a normalized percent. (provider: intrinio) + return_on_assets : Optional[float] + Return on assets, as a normalized percent. (provider: intrinio, yfinance) + return_on_equity : Optional[float] + Return on equity, as a normalized percent. (provider: intrinio, yfinance) return_on_invested_capital : Optional[float] Return on invested capital, as a normalized percent. (provider: intrinio) ebitda : Optional[int] @@ -2677,6 +2622,8 @@ def metrics( Quarterly earnings growth (Year Over Year), as a normalized percent. (provider: yfinance) enterprise_to_revenue : Optional[float] Enterprise value to revenue ratio. (provider: yfinance) + operating_margin : Optional[float] + Operating margin, as a normalized percent. (provider: yfinance) ebitda_margin : Optional[float] EBITDA margin, as a normalized percent. (provider: yfinance) dividend_yield_5y_avg : Optional[float] @@ -2712,7 +2659,7 @@ def metrics( "provider": self._get_provider( provider, "/equity/fundamental/metrics", - ("finviz", "fmp", "intrinio", "yfinance"), + ("fmp", "intrinio", "yfinance"), ) }, standard_params={ @@ -2723,7 +2670,6 @@ def metrics( extra_params=kwargs, info={ "symbol": { - "finviz": {"multiple_items_allowed": True}, "fmp": {"multiple_items_allowed": True}, "intrinio": {"multiple_items_allowed": True}, "yfinance": {"multiple_items_allowed": True}, diff --git a/openbb_platform/openbb/package/equity_ownership.py b/openbb_platform/openbb/package/equity_ownership.py index 9a31c21aa1bd..c9806627f8e5 100644 --- a/openbb_platform/openbb/package/equity_ownership.py +++ b/openbb_platform/openbb/package/equity_ownership.py @@ -157,7 +157,7 @@ def insider_trading( int, OpenBBField(description="The number of data entries to return.") ] = 500, provider: Annotated[ - Optional[Literal["fmp", "intrinio", "tmx"]], + Optional[Literal["fmp", "intrinio"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -172,7 +172,7 @@ def insider_trading( Symbol to get data for. limit : int The number of data entries to return. - provider : Optional[Literal['fmp', 'intrinio', 'tmx']] + provider : Optional[Literal['fmp', 'intrinio']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. @@ -186,15 +186,13 @@ def insider_trading( Type of ownership. (provider: intrinio) sort_by : Optional[Literal['filing_date', 'updated_on']] Field to sort by. (provider: intrinio) - summary : bool - Return a summary of the insider activity instead of the individuals. (provider: tmx) Returns ------- OBBject results : List[InsiderTrading] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'tmx']] + provider : Optional[Literal['fmp', 'intrinio']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -263,20 +261,6 @@ def insider_trading( Whether the owner is having a derivative transaction. (provider: intrinio) report_line_number : Optional[int] Report line number of the insider trading. (provider: intrinio) - period : Optional[str] - The period of the activity. Bucketed by three, six, and twelve months. (provider: tmx) - acquisition_or_deposition : Optional[str] - Whether the insider bought or sold the shares. (provider: tmx) - number_of_trades : Optional[int] - The number of shares traded over the period. (provider: tmx) - trade_value : Optional[float] - The value of the shares traded by the insider. (provider: tmx) - securities_bought : Optional[int] - The total number of shares bought by all insiders over the period. (provider: tmx) - securities_sold : Optional[int] - The total number of shares sold by all insiders over the period. (provider: tmx) - net_activity : Optional[int] - The total net activity by all insiders over the period. (provider: tmx) Examples -------- @@ -292,7 +276,7 @@ def insider_trading( "provider": self._get_provider( provider, "/equity/ownership/insider_trading", - ("fmp", "intrinio", "tmx"), + ("fmp", "intrinio"), ) }, standard_params={ diff --git a/openbb_platform/openbb/package/equity_price.py b/openbb_platform/openbb/package/equity_price.py index 32d7c742db0a..a4327717d3d1 100644 --- a/openbb_platform/openbb/package/equity_price.py +++ b/openbb_platform/openbb/package/equity_price.py @@ -29,7 +29,7 @@ def historical( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon, tiingo, yfinance." ), ], interval: Annotated[ @@ -44,28 +44,10 @@ def historical( Union[datetime.date, None, str], OpenBBField(description="End date of the data, in YYYY-MM-DD format."), ] = None, - chart: Annotated[ - bool, - OpenBBField( - description="Whether to create a chart or not, by default False." - ), - ] = False, provider: Annotated[ - Optional[ - Literal[ - "alpha_vantage", - "cboe", - "fmp", - "intrinio", - "polygon", - "tiingo", - "tmx", - "tradier", - "yfinance", - ] - ], + Optional[Literal["fmp", "intrinio", "polygon", "tiingo", "yfinance"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'alpha_vantage' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), ] = None, **kwargs @@ -75,30 +57,17 @@ def historical( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon, tiingo, yfinance. interval : Optional[str] Time interval of the data to return. start_date : Union[datetime.date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] End date of the data, in YYYY-MM-DD format. - chart : bool - Whether to create a chart or not, by default False. - provider : Optional[Literal['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'pol... + provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinanc... The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'alpha_vantage' if there is + If None, the provider specified in defaults is selected or 'fmp' if there is no default. - adjustment : Union[Literal['splits_only', 'splits_and_dividends', 'unadjusted'], Literal['splits_only', 'unadjusted'], Literal['splits_only', 'splits_and_dividends']] - The adjustment factor to apply. 'splits_only' is not supported for intraday data. (provider: alpha_vantage); - The adjustment factor to apply. Default is splits only. (provider: polygon); - The adjustment factor to apply. Only valid for daily data. (provider: tmx); - The adjustment factor to apply. Default is splits only. (provider: yfinance) - extended_hours : Optional[bool] - Include Pre and Post market data. (provider: alpha_vantage, polygon, tradier, yfinance) - adjusted : bool - This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead. (provider: alpha_vantage, yfinance) - use_cache : bool - When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. (provider: cboe) start_time : Optional[datetime.time] Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. (provider: intrinio) end_time : Optional[datetime.time] @@ -107,12 +76,18 @@ def historical( Timezone of the data, in the IANA format (Continent/City). (provider: intrinio) source : Literal['realtime', 'delayed', 'nasdaq_basic'] The source of the data. (provider: intrinio) + adjustment : Union[Literal['splits_only', 'unadjusted'], Literal['splits_only', 'splits_and_dividends']] + The adjustment factor to apply. Default is splits only. (provider: polygon, yfinance) + extended_hours : bool + Include Pre and Post market data. (provider: polygon, yfinance) sort : Literal['asc', 'desc'] 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. (provider: polygon) limit : int The number of data entries to return. (provider: polygon) include_actions : bool Include dividends and stock splits in results. (provider: yfinance) + adjusted : bool + This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead. (provider: yfinance) prepost : bool This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead. (provider: yfinance) @@ -121,7 +96,7 @@ def historical( OBBject results : List[EquityHistorical] Serializable results. - provider : Optional[Literal['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance']] + provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -142,35 +117,20 @@ def historical( The low price. close : float The close price. - volume : Optional[Union[float, int]] + volume : Optional[Union[int, float]] The trading volume. vwap : Optional[float] Volume Weighted Average Price over the period. - adj_close : Optional[Union[Annotated[float, Gt(gt=0)], float]] - The adjusted close price. (provider: alpha_vantage, fmp, intrinio, tiingo) - dividend : Optional[Union[Annotated[float, Ge(ge=0)], float]] - Dividend amount, if a dividend was paid. (provider: alpha_vantage, intrinio, tiingo, yfinance) - split_ratio : Optional[Union[Annotated[float, Ge(ge=0)], float]] - Split coefficient, if a split occurred. (provider: alpha_vantage); - Ratio of the equity split, if a split occurred. (provider: intrinio); - Ratio of the equity split, if a split occurred. (provider: tiingo); - Ratio of the equity split, if a split occurred. (provider: yfinance) - calls_volume : Optional[int] - Number of calls traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) - puts_volume : Optional[int] - Number of puts traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) - total_options_volume : Optional[int] - Total number of options traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) + adj_close : Optional[float] + The adjusted close price. (provider: fmp, intrinio, tiingo) unadjusted_volume : Optional[float] Unadjusted volume of the symbol. (provider: fmp) change : Optional[float] Change in the price from the previous close. (provider: fmp); - Change in the price of the symbol from the previous day. (provider: intrinio); - Change in price. (provider: tmx) + Change in the price of the symbol from the previous day. (provider: intrinio) change_percent : Optional[float] Change in the price from the previous close, as a normalized percent. (provider: fmp); - Percent change in the price of the symbol from the previous day. (provider: intrinio); - Change in price, as a normalized percentage. (provider: tmx) + Percent change in the price of the symbol from the previous day. (provider: intrinio) average : Optional[float] Average trade price of an individual equity during the interval. (provider: intrinio) adj_open : Optional[float] @@ -187,19 +147,18 @@ def historical( 52 week low price for the symbol. (provider: intrinio) factor : Optional[float] factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices. (provider: intrinio) + split_ratio : Optional[float] + Ratio of the equity split, if a split occurred. (provider: intrinio, tiingo, yfinance) + dividend : Optional[float] + Dividend amount, if a dividend was paid. (provider: intrinio, tiingo, yfinance) close_time : Optional[datetime] The timestamp that represents the end of the interval span. (provider: intrinio) interval : Optional[str] The data time frequency. (provider: intrinio) intra_period : Optional[bool] 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 (provider: intrinio) - transactions : Optional[Union[Annotated[int, Gt(gt=0)], int]] - Number of transactions for the symbol in the time period. (provider: polygon); - Total number of transactions recorded. (provider: tmx) - transactions_value : Optional[float] - Nominal value of recorded transactions. (provider: tmx) - last_price : Optional[float] - The last price of the equity. (provider: tradier) + transactions : Optional[Annotated[int, Gt(gt=0)]] + Number of transactions for the symbol in the time period. (provider: polygon) Examples -------- @@ -215,17 +174,7 @@ def historical( "provider": self._get_provider( provider, "/equity/price/historical", - ( - "alpha_vantage", - "cboe", - "fmp", - "intrinio", - "polygon", - "tiingo", - "tmx", - "tradier", - "yfinance", - ), + ("fmp", "intrinio", "polygon", "tiingo", "yfinance"), ) }, standard_params={ @@ -235,16 +184,11 @@ def historical( "end_date": end_date, }, extra_params=kwargs, - chart=chart, info={ "symbol": { - "alpha_vantage": {"multiple_items_allowed": True}, - "cboe": {"multiple_items_allowed": True}, "fmp": {"multiple_items_allowed": True}, "polygon": {"multiple_items_allowed": True}, "tiingo": {"multiple_items_allowed": True}, - "tmx": {"multiple_items_allowed": True}, - "tradier": {"multiple_items_allowed": True}, "yfinance": {"multiple_items_allowed": True}, }, "adjusted": {"deprecated": True}, @@ -366,19 +310,13 @@ def performance( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): finviz, fmp." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." ), ], - chart: Annotated[ - bool, - OpenBBField( - description="Whether to create a chart or not, by default False." - ), - ] = False, provider: Annotated[ - Optional[Literal["finviz", "fmp"]], + Optional[Literal["fmp"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'finviz' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), ] = None, **kwargs @@ -388,12 +326,10 @@ def performance( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): finviz, fmp. - chart : bool - Whether to create a chart or not, by default False. - provider : Optional[Literal['finviz', 'fmp']] + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. + provider : Optional[Literal['fmp']] The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'finviz' if there is + If None, the provider specified in defaults is selected or 'fmp' if there is no default. Returns @@ -401,7 +337,7 @@ def performance( OBBject results : List[PricePerformance] Serializable results. - provider : Optional[Literal['finviz', 'fmp']] + provider : Optional[Literal['fmp']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -446,20 +382,6 @@ def performance( Ten-year return. max : Optional[float] Return from the beginning of the time series. - volatility_week : Optional[float] - One-week realized volatility, as a normalized percent. (provider: finviz) - volatility_month : Optional[float] - One-month realized volatility, as a normalized percent. (provider: finviz) - price : Optional[float] - Last Price. (provider: finviz) - volume : Optional[float] - Current volume. (provider: finviz) - average_volume : Optional[float] - Average daily volume. (provider: finviz) - relative_volume : Optional[float] - Relative volume as a ratio of current volume to average volume. (provider: finviz) - analyst_recommendation : Optional[float] - The analyst consensus, on a scale of 1-5 where 1 is a buy and 5 is a sell. (provider: finviz) Examples -------- @@ -474,20 +396,14 @@ def performance( "provider": self._get_provider( provider, "/equity/price/performance", - ("finviz", "fmp"), + ("fmp",), ) }, standard_params={ "symbol": symbol, }, extra_params=kwargs, - chart=chart, - info={ - "symbol": { - "finviz": {"multiple_items_allowed": True}, - "fmp": {"multiple_items_allowed": True}, - } - }, + info={"symbol": {"fmp": {"multiple_items_allowed": True}}}, ) ) @@ -498,13 +414,13 @@ def quote( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): cboe, fmp, intrinio, tmx, tradier, yfinance." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance." ), ], provider: Annotated[ - Optional[Literal["cboe", "fmp", "intrinio", "tmx", "tradier", "yfinance"]], + Optional[Literal["fmp", "intrinio", "yfinance"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'cboe' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), ] = None, **kwargs @@ -514,13 +430,11 @@ def quote( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): cboe, fmp, intrinio, tmx, tradier, yfinance. - provider : Optional[Literal['cboe', 'fmp', 'intrinio', 'tmx', 'tradier', 'yf... + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance. + provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'cboe' if there is + If None, the provider specified in defaults is selected or 'fmp' if there is no default. - use_cache : bool - When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. (provider: cboe) source : Literal['iex', 'bats', 'bats_delayed', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed', 'intrinio_mx', 'intrinio_mx_plus', 'delayed_sip'] Source of the data. (provider: intrinio) @@ -529,7 +443,7 @@ def quote( OBBject results : List[EquityQuote] Serializable results. - provider : Optional[Literal['cboe', 'fmp', 'intrinio', 'tmx', 'tradier', 'yfinance']] + provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -606,51 +520,20 @@ def quote( The one year high (52W High). year_low : Optional[float] The one year low (52W Low). - iv30 : Optional[float] - The 30-day implied volatility of the stock. (provider: cboe) - iv30_change : Optional[float] - Change in 30-day implied volatility of the stock. (provider: cboe) - iv30_change_percent : Optional[float] - Change in 30-day implied volatility of the stock as a normalized percentage value. (provider: cboe) - iv30_annual_high : Optional[float] - The 1-year high of 30-day implied volatility. (provider: cboe) - hv30_annual_high : Optional[float] - The 1-year high of 30-day realized volatility. (provider: cboe) - iv30_annual_low : Optional[float] - The 1-year low of 30-day implied volatility. (provider: cboe) - hv30_annual_low : Optional[float] - The 1-year low of 30-dayrealized volatility. (provider: cboe) - iv60_annual_high : Optional[float] - The 1-year high of 60-day implied volatility. (provider: cboe) - hv60_annual_high : Optional[float] - The 1-year high of 60-day realized volatility. (provider: cboe) - iv60_annual_low : Optional[float] - The 1-year low of 60-day implied volatility. (provider: cboe) - hv60_annual_low : Optional[float] - The 1-year low of 60-day realized volatility. (provider: cboe) - iv90_annual_high : Optional[float] - The 1-year high of 90-day implied volatility. (provider: cboe) - hv90_annual_high : Optional[float] - The 1-year high of 90-day realized volatility. (provider: cboe) - iv90_annual_low : Optional[float] - The 1-year low of 90-day implied volatility. (provider: cboe) - hv90_annual_low : Optional[float] - The 1-year low of 90-day realized volatility. (provider: cboe) price_avg50 : Optional[float] 50 day moving average price. (provider: fmp) price_avg200 : Optional[float] 200 day moving average price. (provider: fmp) avg_volume : Optional[int] Average volume over the last 10 trading days. (provider: fmp) - market_cap : Optional[Union[float, int]] - Market cap of the company. (provider: fmp); - Market capitalization. (provider: tmx) + market_cap : Optional[float] + Market cap of the company. (provider: fmp) shares_outstanding : Optional[int] - Number of shares outstanding. (provider: fmp, tmx) - eps : Optional[Union[float, str]] - Earnings per share. (provider: fmp, tmx) - pe : Optional[Union[float, str]] - Price earnings ratio. (provider: fmp, tmx) + Number of shares outstanding. (provider: fmp) + eps : Optional[float] + Earnings per share. (provider: fmp) + pe : Optional[float] + Price earnings ratio. (provider: fmp) earnings_announcement : Optional[datetime] Upcoming earnings announcement date. (provider: fmp) is_darkpool : Optional[bool] @@ -661,110 +544,6 @@ def quote( Date and Time when the data was last updated. (provider: intrinio) security : Optional[IntrinioSecurity] Security details related to the quote. (provider: intrinio) - security_type : Optional[str] - The issuance type of the asset. (provider: tmx) - sector : Optional[str] - The sector of the asset. (provider: tmx) - industry_category : Optional[str] - The industry category of the asset. (provider: tmx) - industry_group : Optional[str] - The industry group of the asset. (provider: tmx) - vwap : Optional[float] - Volume Weighted Average Price over the period. (provider: tmx) - ma_21 : Optional[float] - Twenty-one day moving average. (provider: tmx) - ma_50 : Optional[float] - Fifty day moving average. (provider: tmx) - ma_200 : Optional[float] - Two-hundred day moving average. (provider: tmx) - volume_avg_10d : Optional[int] - Ten day average volume. (provider: tmx) - volume_avg_30d : Optional[int] - Thirty day average volume. (provider: tmx) - volume_avg_50d : Optional[int] - Fifty day average volume. (provider: tmx) - market_cap_all_classes : Optional[int] - Market capitalization of all share classes. (provider: tmx) - div_amount : Optional[float] - The most recent dividend amount. (provider: tmx) - div_currency : Optional[str] - The currency the dividend is paid in. (provider: tmx) - div_yield : Optional[float] - The dividend yield as a normalized percentage. (provider: tmx) - div_freq : Optional[str] - The frequency of dividend payments. (provider: tmx) - div_ex_date : Optional[date] - The ex-dividend date. (provider: tmx) - div_pay_date : Optional[date] - The next dividend ayment date. (provider: tmx) - div_growth_3y : Optional[Union[str, float]] - The three year dividend growth as a normalized percentage. (provider: tmx) - div_growth_5y : Optional[Union[str, float]] - The five year dividend growth as a normalized percentage. (provider: tmx) - debt_to_equity : Optional[Union[str, float]] - The debt to equity ratio. (provider: tmx) - price_to_book : Optional[Union[str, float]] - The price to book ratio. (provider: tmx) - price_to_cf : Optional[Union[str, float]] - The price to cash flow ratio. (provider: tmx) - return_on_equity : Optional[Union[str, float]] - The return on equity, as a normalized percentage. (provider: tmx) - return_on_assets : Optional[Union[str, float]] - The return on assets, as a normalized percentage. (provider: tmx) - beta : Optional[Union[str, float]] - The beta relative to the TSX Composite. (provider: tmx) - alpha : Optional[Union[str, float]] - The alpha relative to the TSX Composite. (provider: tmx) - shares_escrow : Optional[int] - The number of shares held in escrow. (provider: tmx) - shares_total : Optional[int] - The total number of shares outstanding from all classes. (provider: tmx) - last_volume : Optional[int] - The last trade volume. (provider: tradier) - volume_avg : Optional[int] - The average daily trading volume. (provider: tradier) - bid_timestamp : Optional[datetime] - Timestamp of the bid price. (provider: tradier) - ask_timestamp : Optional[datetime] - Timestamp of the ask price. (provider: tradier) - greeks_timestamp : Optional[datetime] - Timestamp of the greeks data. (provider: tradier) - underlying : Optional[str] - The underlying symbol for the option. (provider: tradier) - root_symbol : Optional[str] - The root symbol for the option. (provider: tradier) - option_type : Optional[Literal['call', 'put']] - Type of option - call or put. (provider: tradier) - contract_size : Optional[int] - The number of shares in a standard contract. (provider: tradier) - expiration_type : Optional[str] - The expiration type of the option - i.e, standard, weekly, etc. (provider: tradier) - expiration_date : Optional[date] - The expiration date of the option. (provider: tradier) - strike : Optional[float] - The strike price of the option. (provider: tradier) - open_interest : Optional[int] - The number of open contracts for the option. (provider: tradier) - bid_iv : Optional[float] - Implied volatility of the bid price. (provider: tradier) - ask_iv : Optional[float] - Implied volatility of the ask price. (provider: tradier) - mid_iv : Optional[float] - Mid-point implied volatility of the option. (provider: tradier) - orats_final_iv : Optional[float] - ORATS final implied volatility of the option. (provider: tradier) - delta : Optional[float] - Delta of the option. (provider: tradier) - gamma : Optional[float] - Gamma of the option. (provider: tradier) - theta : Optional[float] - Theta of the option. (provider: tradier) - vega : Optional[float] - Vega of the option. (provider: tradier) - rho : Optional[float] - Rho of the option. (provider: tradier) - phi : Optional[float] - Phi of the option. (provider: tradier) ma_50d : Optional[float] 50-day moving average price. (provider: yfinance) ma_200d : Optional[float] @@ -789,7 +568,7 @@ def quote( "provider": self._get_provider( provider, "/equity/price/quote", - ("cboe", "fmp", "intrinio", "tmx", "tradier", "yfinance"), + ("fmp", "intrinio", "yfinance"), ) }, standard_params={ @@ -798,11 +577,8 @@ def quote( extra_params=kwargs, info={ "symbol": { - "cboe": {"multiple_items_allowed": True}, "fmp": {"multiple_items_allowed": True}, "intrinio": {"multiple_items_allowed": True}, - "tmx": {"multiple_items_allowed": True}, - "tradier": {"multiple_items_allowed": True}, "yfinance": {"multiple_items_allowed": True}, } }, diff --git a/openbb_platform/openbb/package/equity_shorts.py b/openbb_platform/openbb/package/equity_shorts.py index 30b88ed44cda..8cb08479541f 100644 --- a/openbb_platform/openbb/package/equity_shorts.py +++ b/openbb_platform/openbb/package/equity_shorts.py @@ -13,8 +13,6 @@ class ROUTER_equity_shorts(Container): """/equity/shorts fails_to_deliver - short_interest - short_volume """ def __repr__(self) -> str: @@ -106,165 +104,3 @@ def fails_to_deliver( extra_params=kwargs, ) ) - - @exception_handler - @validate - def short_interest( - self, - symbol: Annotated[str, OpenBBField(description="Symbol to get data for.")], - provider: Annotated[ - Optional[Literal["finra"]], - OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'finra' if there is\n no default." - ), - ] = None, - **kwargs - ) -> OBBject: - """Get reported short volume and days to cover data. - - Parameters - ---------- - symbol : str - Symbol to get data for. - provider : Optional[Literal['finra']] - The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'finra' if there is - no default. - - Returns - ------- - OBBject - results : List[EquityShortInterest] - Serializable results. - provider : Optional[Literal['finra']] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - - EquityShortInterest - ------------------- - settlement_date : date - The mid-month short interest report is based on short positions held by members on the settlement date of the 15th of each month. If the 15th falls on a weekend or another non-settlement date, the designated settlement date will be the previous business day on which transactions settled. The end-of-month short interest report is based on short positions held on the last business day of the month on which transactions settle. Once the short position reports are received, the short interest data is compiled for each equity security and provided for publication on the 7th business day after the reporting settlement date. - symbol : str - Symbol representing the entity requested in the data. - issue_name : str - Unique identifier of the issue. - market_class : str - Primary listing market. - current_short_position : float - The total number of shares in the issue that are reflected on the books and records of the reporting firms as short as defined by Rule 200 of Regulation SHO as of the current cycle’s designated settlement date. - previous_short_position : float - The total number of shares in the issue that are reflected on the books and records of the reporting firms as short as defined by Rule 200 of Regulation SHO as of the previous cycle’s designated settlement date. - avg_daily_volume : float - Total Volume or Adjusted Volume in case of splits / Total trade days between (previous settlement date + 1) to (current settlement date). The NULL values are translated as zero. - days_to_cover : float - The number of days of average share volume it would require to buy all of the shares that were sold short during the reporting cycle. Formula: Short Interest / Average Daily Share Volume, Rounded to Hundredths. 1.00 will be displayed for any values equal or less than 1 (i.e., Average Daily Share is equal to or greater than Short Interest). N/A will be displayed If the days to cover is Zero (i.e., Average Daily Share Volume is Zero). - change : float - Change in Shares Short from Previous Cycle: Difference in short interest between the current cycle and the previous cycle. - change_pct : float - Change in Shares Short from Previous Cycle as a percent. - - Examples - -------- - >>> from openbb import obb - >>> obb.equity.shorts.short_interest(symbol='AAPL', provider='finra') - """ # noqa: E501 - - return self._run( - "/equity/shorts/short_interest", - **filter_inputs( - provider_choices={ - "provider": self._get_provider( - provider, - "/equity/shorts/short_interest", - ("finra",), - ) - }, - standard_params={ - "symbol": symbol, - }, - extra_params=kwargs, - ) - ) - - @exception_handler - @validate - def short_volume( - self, - symbol: Annotated[str, OpenBBField(description="Symbol to get data for.")], - provider: Annotated[ - Optional[Literal["stockgrid"]], - OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'stockgrid' if there is\n no default." - ), - ] = None, - **kwargs - ) -> OBBject: - """Get reported Fail-to-deliver (FTD) data. - - Parameters - ---------- - symbol : str - Symbol to get data for. - provider : Optional[Literal['stockgrid']] - The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'stockgrid' if there is - no default. - - Returns - ------- - OBBject - results : List[ShortVolume] - Serializable results. - provider : Optional[Literal['stockgrid']] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - - ShortVolume - ----------- - date : Optional[date] - The date of the data. - market : Optional[str] - Reporting Facility ID. N=NYSE TRF, Q=NASDAQ TRF Carteret, B=NASDAQ TRY Chicago, D=FINRA ADF - short_volume : Optional[int] - Aggregate reported share volume of executed short sale and short sale exempt trades during regular trading hours - short_exempt_volume : Optional[int] - Aggregate reported share volume of executed short sale exempt trades during regular trading hours - total_volume : Optional[int] - Aggregate reported share volume of executed trades during regular trading hours - close : Optional[float] - Closing price of the stock on the date. (provider: stockgrid) - short_volume_percent : Optional[float] - Percentage of the total volume that was short volume. (provider: stockgrid) - - Examples - -------- - >>> from openbb import obb - >>> obb.equity.shorts.short_volume(symbol='AAPL', provider='stockgrid') - """ # noqa: E501 - - return self._run( - "/equity/shorts/short_volume", - **filter_inputs( - provider_choices={ - "provider": self._get_provider( - provider, - "/equity/shorts/short_volume", - ("stockgrid",), - ) - }, - standard_params={ - "symbol": symbol, - }, - extra_params=kwargs, - ) - ) diff --git a/openbb_platform/openbb/package/etf.py b/openbb_platform/openbb/package/etf.py index 8be3dab6a5f3..5609ba550160 100644 --- a/openbb_platform/openbb/package/etf.py +++ b/openbb_platform/openbb/package/etf.py @@ -16,7 +16,6 @@ class ROUTER_etf(Container): """/etf countries - /discovery equity_exposure historical holdings @@ -38,11 +37,11 @@ def countries( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, tmx." + description="Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp." ), ], provider: Annotated[ - Optional[Literal["fmp", "tmx"]], + Optional[Literal["fmp"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -54,20 +53,18 @@ def countries( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, tmx. - provider : Optional[Literal['fmp', 'tmx']] + Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp. + provider : Optional[Literal['fmp']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. - use_cache : bool - Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. (provider: tmx) Returns ------- OBBject results : List[EtfCountries] Serializable results. - provider : Optional[Literal['fmp', 'tmx']] + provider : Optional[Literal['fmp']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -94,29 +91,17 @@ def countries( "provider": self._get_provider( provider, "/etf/countries", - ("fmp", "tmx"), + ("fmp",), ) }, standard_params={ "symbol": symbol, }, extra_params=kwargs, - info={ - "symbol": { - "fmp": {"multiple_items_allowed": True}, - "tmx": {"multiple_items_allowed": True}, - } - }, + info={"symbol": {"fmp": {"multiple_items_allowed": True}}}, ) ) - @property - def discovery(self): - # pylint: disable=import-outside-toplevel - from . import etf_discovery - - return etf_discovery.ROUTER_etf_discovery(command_runner=self._command_runner) - @exception_handler @validate def equity_exposure( @@ -206,7 +191,7 @@ def historical( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon, tiingo, yfinance." ), ], interval: Annotated[ @@ -221,28 +206,10 @@ def historical( Union[datetime.date, None, str], OpenBBField(description="End date of the data, in YYYY-MM-DD format."), ] = None, - chart: Annotated[ - bool, - OpenBBField( - description="Whether to create a chart or not, by default False." - ), - ] = False, provider: Annotated[ - Optional[ - Literal[ - "alpha_vantage", - "cboe", - "fmp", - "intrinio", - "polygon", - "tiingo", - "tmx", - "tradier", - "yfinance", - ] - ], + Optional[Literal["fmp", "intrinio", "polygon", "tiingo", "yfinance"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'alpha_vantage' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), ] = None, **kwargs @@ -252,30 +219,17 @@ def historical( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon, tiingo, yfinance. interval : Optional[str] Time interval of the data to return. start_date : Union[datetime.date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] End date of the data, in YYYY-MM-DD format. - chart : bool - Whether to create a chart or not, by default False. - provider : Optional[Literal['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'pol... + provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinanc... The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'alpha_vantage' if there is + If None, the provider specified in defaults is selected or 'fmp' if there is no default. - adjustment : Union[Literal['splits_only', 'splits_and_dividends', 'unadjusted'], Literal['splits_only', 'unadjusted'], Literal['splits_only', 'splits_and_dividends']] - The adjustment factor to apply. 'splits_only' is not supported for intraday data. (provider: alpha_vantage); - The adjustment factor to apply. Default is splits only. (provider: polygon); - The adjustment factor to apply. Only valid for daily data. (provider: tmx); - The adjustment factor to apply. Default is splits only. (provider: yfinance) - extended_hours : Optional[bool] - Include Pre and Post market data. (provider: alpha_vantage, polygon, tradier, yfinance) - adjusted : bool - This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead. (provider: alpha_vantage, yfinance) - use_cache : bool - When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. (provider: cboe) start_time : Optional[datetime.time] Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. (provider: intrinio) end_time : Optional[datetime.time] @@ -284,12 +238,18 @@ def historical( Timezone of the data, in the IANA format (Continent/City). (provider: intrinio) source : Literal['realtime', 'delayed', 'nasdaq_basic'] The source of the data. (provider: intrinio) + adjustment : Union[Literal['splits_only', 'unadjusted'], Literal['splits_only', 'splits_and_dividends']] + The adjustment factor to apply. Default is splits only. (provider: polygon, yfinance) + extended_hours : bool + Include Pre and Post market data. (provider: polygon, yfinance) sort : Literal['asc', 'desc'] 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. (provider: polygon) limit : int The number of data entries to return. (provider: polygon) include_actions : bool Include dividends and stock splits in results. (provider: yfinance) + adjusted : bool + This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead. (provider: yfinance) prepost : bool This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead. (provider: yfinance) @@ -298,7 +258,7 @@ def historical( OBBject results : List[EtfHistorical] Serializable results. - provider : Optional[Literal['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance']] + provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -319,35 +279,20 @@ def historical( The low price. close : float The close price. - volume : Optional[Union[float, int]] + volume : Optional[Union[int, float]] The trading volume. vwap : Optional[float] Volume Weighted Average Price over the period. - adj_close : Optional[Union[Annotated[float, Gt(gt=0)], float]] - The adjusted close price. (provider: alpha_vantage, fmp, intrinio, tiingo) - dividend : Optional[Union[Annotated[float, Ge(ge=0)], float]] - Dividend amount, if a dividend was paid. (provider: alpha_vantage, intrinio, tiingo, yfinance) - split_ratio : Optional[Union[Annotated[float, Ge(ge=0)], float]] - Split coefficient, if a split occurred. (provider: alpha_vantage); - Ratio of the equity split, if a split occurred. (provider: intrinio); - Ratio of the equity split, if a split occurred. (provider: tiingo); - Ratio of the equity split, if a split occurred. (provider: yfinance) - calls_volume : Optional[int] - Number of calls traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) - puts_volume : Optional[int] - Number of puts traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) - total_options_volume : Optional[int] - Total number of options traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) + adj_close : Optional[float] + The adjusted close price. (provider: fmp, intrinio, tiingo) unadjusted_volume : Optional[float] Unadjusted volume of the symbol. (provider: fmp) change : Optional[float] Change in the price from the previous close. (provider: fmp); - Change in the price of the symbol from the previous day. (provider: intrinio); - Change in price. (provider: tmx) + Change in the price of the symbol from the previous day. (provider: intrinio) change_percent : Optional[float] Change in the price from the previous close, as a normalized percent. (provider: fmp); - Percent change in the price of the symbol from the previous day. (provider: intrinio); - Change in price, as a normalized percentage. (provider: tmx) + Percent change in the price of the symbol from the previous day. (provider: intrinio) average : Optional[float] Average trade price of an individual equity during the interval. (provider: intrinio) adj_open : Optional[float] @@ -364,19 +309,18 @@ def historical( 52 week low price for the symbol. (provider: intrinio) factor : Optional[float] factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices. (provider: intrinio) + split_ratio : Optional[float] + Ratio of the equity split, if a split occurred. (provider: intrinio, tiingo, yfinance) + dividend : Optional[float] + Dividend amount, if a dividend was paid. (provider: intrinio, tiingo, yfinance) close_time : Optional[datetime] The timestamp that represents the end of the interval span. (provider: intrinio) interval : Optional[str] The data time frequency. (provider: intrinio) intra_period : Optional[bool] 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 (provider: intrinio) - transactions : Optional[Union[Annotated[int, Gt(gt=0)], int]] - Number of transactions for the symbol in the time period. (provider: polygon); - Total number of transactions recorded. (provider: tmx) - transactions_value : Optional[float] - Nominal value of recorded transactions. (provider: tmx) - last_price : Optional[float] - The last price of the equity. (provider: tradier) + transactions : Optional[Annotated[int, Gt(gt=0)]] + Number of transactions for the symbol in the time period. (provider: polygon) Examples -------- @@ -394,17 +338,7 @@ def historical( "provider": self._get_provider( provider, "/etf/historical", - ( - "alpha_vantage", - "cboe", - "fmp", - "intrinio", - "polygon", - "tiingo", - "tmx", - "tradier", - "yfinance", - ), + ("fmp", "intrinio", "polygon", "tiingo", "yfinance"), ) }, standard_params={ @@ -414,16 +348,11 @@ def historical( "end_date": end_date, }, extra_params=kwargs, - chart=chart, info={ "symbol": { - "alpha_vantage": {"multiple_items_allowed": True}, - "cboe": {"multiple_items_allowed": True}, "fmp": {"multiple_items_allowed": True}, "polygon": {"multiple_items_allowed": True}, "tiingo": {"multiple_items_allowed": True}, - "tmx": {"multiple_items_allowed": True}, - "tradier": {"multiple_items_allowed": True}, "yfinance": {"multiple_items_allowed": True}, }, "adjusted": {"deprecated": True}, @@ -439,14 +368,8 @@ def holdings( symbol: Annotated[ str, OpenBBField(description="Symbol to get data for. (ETF)") ], - chart: Annotated[ - bool, - OpenBBField( - description="Whether to create a chart or not, by default False." - ), - ] = False, provider: Annotated[ - Optional[Literal["fmp", "intrinio", "sec", "tmx"]], + Optional[Literal["fmp", "intrinio", "sec"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -459,9 +382,7 @@ def holdings( ---------- symbol : str Symbol to get data for. (ETF) - chart : bool - Whether to create a chart or not, by default False. - provider : Optional[Literal['fmp', 'intrinio', 'sec', 'tmx']] + provider : Optional[Literal['fmp', 'intrinio', 'sec']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. @@ -472,15 +393,14 @@ def holdings( cik : Optional[str] The CIK of the filing entity. Overrides symbol. (provider: fmp) use_cache : bool - Whether or not to use cache for the request. (provider: sec); - Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. (provider: tmx) + Whether or not to use cache for the request. (provider: sec) Returns ------- OBBject results : List[EtfHoldings] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'sec', 'tmx']] + provider : Optional[Literal['fmp', 'intrinio', 'sec']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -511,13 +431,12 @@ def holdings( The type of units. (provider: fmp); The units of the holding. (provider: sec) currency : Optional[str] - The currency of the holding. (provider: fmp, sec, tmx) + The currency of the holding. (provider: fmp, sec) value : Optional[float] The value of the holding, in dollars. (provider: fmp, intrinio, sec) weight : Optional[float] The weight of the holding, as a normalized percent. (provider: fmp, intrinio); - The weight of the holding in ETF in %. (provider: sec); - The weight of the asset in the portfolio, as a normalized percentage. (provider: tmx) + The weight of the holding in ETF in %. (provider: sec) payoff_profile : Optional[str] The payoff profile of the holding. (provider: fmp, sec) asset_category : Optional[str] @@ -525,7 +444,7 @@ def holdings( issuer_category : Optional[str] The issuer category of the holding. (provider: fmp, sec) country : Optional[str] - The country of the holding. (provider: fmp, intrinio, sec, tmx) + The country of the holding. (provider: fmp, intrinio, sec) is_restricted : Optional[str] Whether the holding is restricted. (provider: fmp, sec) fair_value_level : Optional[int] @@ -675,20 +594,6 @@ def holdings( The currency of the derivative's notional amount. (provider: sec) unrealized_gain : Optional[float] The unrealized gain or loss on the derivative. (provider: sec) - shares : Optional[Union[int, str]] - The value of the assets under management. (provider: tmx) - market_value : Optional[Union[str, float]] - The market value of the holding. (provider: tmx) - share_percentage : Optional[float] - The share percentage of the holding, as a normalized percentage. (provider: tmx) - share_change : Optional[Union[str, float]] - The change in shares of the holding. (provider: tmx) - exchange : Optional[str] - The exchange code of the holding. (provider: tmx) - type_id : Optional[str] - The holding type ID of the asset. (provider: tmx) - fund_id : Optional[str] - The fund ID of the asset. (provider: tmx) Examples -------- @@ -707,14 +612,13 @@ def holdings( "provider": self._get_provider( provider, "/etf/holdings", - ("fmp", "intrinio", "sec", "tmx"), + ("fmp", "intrinio", "sec"), ) }, standard_params={ "symbol": symbol, }, extra_params=kwargs, - chart=chart, ) ) @@ -910,11 +814,11 @@ def info( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, intrinio, tmx, yfinance." + description="Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance." ), ], provider: Annotated[ - Optional[Literal["fmp", "intrinio", "tmx", "yfinance"]], + Optional[Literal["fmp", "intrinio", "yfinance"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -926,20 +830,18 @@ def info( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, intrinio, tmx, yfinance. - provider : Optional[Literal['fmp', 'intrinio', 'tmx', 'yfinance']] + Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance. + provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. - use_cache : bool - Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. (provider: tmx) Returns ------- OBBject results : List[EtfInfo] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'tmx', 'yfinance']] + provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -960,8 +862,7 @@ def info( Inception date of the ETF. issuer : Optional[str] Company of the ETF. (provider: fmp); - Issuer of the ETF. (provider: intrinio); - The issuer of the ETF. (provider: tmx) + Issuer of the ETF. (provider: intrinio) cusip : Optional[str] CUSIP of the ETF. (provider: fmp) isin : Optional[str] @@ -974,8 +875,7 @@ def info( Asset class of the ETF. (provider: fmp); Captures the underlying nature of the securities in the Exchanged Traded Product (ETP). (provider: intrinio) aum : Optional[float] - Assets under management. (provider: fmp); - The AUM of the ETF. (provider: tmx) + Assets under management. (provider: fmp) nav : Optional[float] Net asset value of the ETF. (provider: fmp) nav_currency : Optional[str] @@ -984,12 +884,10 @@ def info( The expense ratio, as a normalized percent. (provider: fmp) holdings_count : Optional[int] Number of holdings. (provider: fmp) - avg_volume : Optional[Union[float, int]] - Average daily trading volume. (provider: fmp); - The average daily volume of the ETF. (provider: tmx) + avg_volume : Optional[float] + Average daily trading volume. (provider: fmp) website : Optional[str] - Website of the issuer. (provider: fmp); - The website of the ETF. (provider: tmx) + Website of the issuer. (provider: fmp) fund_listing_date : Optional[date] The date on which the Exchange Traded Product (ETP) or share class of the ETP is listed on a specific exchange. (provider: intrinio) data_change_date : Optional[date] @@ -1031,7 +929,7 @@ def info( This field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor. (provider: intrinio); The fund family. (provider: yfinance) investment_style : Optional[str] - Investment style of the ETF. (provider: intrinio, tmx) + Investment style of the ETF. (provider: intrinio) derivatives_based : Optional[str] This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio. (provider: intrinio) income_category : Optional[str] @@ -1212,55 +1110,14 @@ def info( Gross expense net of Fee Waivers, as a percentage of net assets as published by the ETF issuer. (provider: intrinio) etf_portfolio_turnover : Optional[float] The percentage of positions turned over in the last 12 months. (provider: intrinio) - esg : Optional[bool] - Whether the ETF qualifies as an ESG fund. (provider: tmx) - currency : Optional[str] - The currency of the ETF. (provider: tmx); - The currency in which the fund is listed. (provider: yfinance) - unit_price : Optional[float] - The unit price of the ETF. (provider: tmx) - close : Optional[float] - The closing price of the ETF. (provider: tmx) - prev_close : Optional[float] - The previous closing price of the ETF. (provider: tmx, yfinance) - return_1m : Optional[float] - The one-month return of the ETF, as a normalized percent (provider: tmx) - return_3m : Optional[float] - The three-month return of the ETF, as a normalized percent. (provider: tmx) - return_6m : Optional[float] - The six-month return of the ETF, as a normalized percent. (provider: tmx) - return_ytd : Optional[float] - The year-to-date return of the ETF, as a normalized percent. (provider: tmx, yfinance) - return_1y : Optional[float] - The one-year return of the ETF, as a normalized percent. (provider: tmx) - return_3y : Optional[float] - The three-year return of the ETF, as a normalized percent. (provider: tmx) - return_5y : Optional[float] - The five-year return of the ETF, as a normalized percent. (provider: tmx) - return_10y : Optional[float] - The ten-year return of the ETF, as a normalized percent. (provider: tmx) - return_from_inception : Optional[float] - The return from inception of the ETF, as a normalized percent. (provider: tmx) - avg_volume_30d : Optional[int] - The 30-day average volume of the ETF. (provider: tmx) - pe_ratio : Optional[float] - The price-to-earnings ratio of the ETF. (provider: tmx) - pb_ratio : Optional[float] - The price-to-book ratio of the ETF. (provider: tmx) - management_fee : Optional[float] - The management fee of the ETF, as a normalized percent. (provider: tmx) - mer : Optional[float] - The management expense ratio of the ETF, as a normalized percent. (provider: tmx) - distribution_yield : Optional[float] - The distribution yield of the ETF, as a normalized percent. (provider: tmx) - dividend_frequency : Optional[str] - The dividend payment frequency of the ETF. (provider: tmx) fund_type : Optional[str] The legal type of fund. (provider: yfinance) category : Optional[str] The fund category. (provider: yfinance) exchange_timezone : Optional[str] The timezone of the exchange. (provider: yfinance) + currency : Optional[str] + The currency in which the fund is listed. (provider: yfinance) nav_price : Optional[float] The net asset value per unit of the fund. (provider: yfinance) total_assets : Optional[int] @@ -1281,6 +1138,8 @@ def info( 50-day moving average price. (provider: yfinance) ma_200d : Optional[float] 200-day moving average price. (provider: yfinance) + return_ytd : Optional[float] + The year-to-date return of the fund, as a normalized percent. (provider: yfinance) return_3y_avg : Optional[float] The three year average return of the fund, as a normalized percent. (provider: yfinance) return_5y_avg : Optional[float] @@ -1307,6 +1166,8 @@ def info( The lowest price of the most recent trading session. (provider: yfinance) volume : Optional[int] The trading volume of the most recent trading session. (provider: yfinance) + prev_close : Optional[float] + The previous closing price. (provider: yfinance) Examples -------- @@ -1323,7 +1184,7 @@ def info( "provider": self._get_provider( provider, "/etf/info", - ("fmp", "intrinio", "tmx", "yfinance"), + ("fmp", "intrinio", "yfinance"), ) }, standard_params={ @@ -1334,7 +1195,6 @@ def info( "symbol": { "fmp": {"multiple_items_allowed": True}, "intrinio": {"multiple_items_allowed": True}, - "tmx": {"multiple_items_allowed": True}, "yfinance": {"multiple_items_allowed": True}, } }, @@ -1348,19 +1208,13 @@ def price_performance( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): finviz, fmp, intrinio." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio." ), ], - chart: Annotated[ - bool, - OpenBBField( - description="Whether to create a chart or not, by default False." - ), - ] = False, provider: Annotated[ - Optional[Literal["finviz", "fmp", "intrinio"]], + Optional[Literal["fmp", "intrinio"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'finviz' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), ] = None, **kwargs @@ -1370,12 +1224,10 @@ def price_performance( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): finviz, fmp, intrinio. - chart : bool - Whether to create a chart or not, by default False. - provider : Optional[Literal['finviz', 'fmp', 'intrinio']] + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio. + provider : Optional[Literal['fmp', 'intrinio']] The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'finviz' if there is + If None, the provider specified in defaults is selected or 'fmp' if there is no default. return_type : Literal['trailing', 'calendar'] The type of returns to return, a trailing or calendar window. (provider: intrinio) @@ -1387,7 +1239,7 @@ def price_performance( OBBject results : List[EtfPricePerformance] Serializable results. - provider : Optional[Literal['finviz', 'fmp', 'intrinio']] + provider : Optional[Literal['fmp', 'intrinio']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -1432,21 +1284,6 @@ def price_performance( Ten-year return. max : Optional[float] Return from the beginning of the time series. - volatility_week : Optional[float] - One-week realized volatility, as a normalized percent. (provider: finviz) - volatility_month : Optional[float] - One-month realized volatility, as a normalized percent. (provider: finviz) - price : Optional[float] - Last Price. (provider: finviz) - volume : Optional[Union[float, int]] - Current volume. (provider: finviz); - The trading volume. (provider: intrinio) - average_volume : Optional[float] - Average daily volume. (provider: finviz) - relative_volume : Optional[float] - Relative volume as a ratio of current volume to average volume. (provider: finviz) - analyst_recommendation : Optional[float] - The analyst consensus, on a scale of 1-5 where 1 is a buy and 5 is a sell. (provider: finviz) max_annualized : Optional[float] Annualized rate of return from inception. (provider: intrinio) volatility_one_year : Optional[float] @@ -1455,6 +1292,8 @@ def price_performance( Trailing three-year annualized volatility. (provider: intrinio) volatility_five_year : Optional[float] Trailing five-year annualized volatility. (provider: intrinio) + volume : Optional[int] + The trading volume. (provider: intrinio) volume_avg_30 : Optional[float] The one-month average daily volume. (provider: intrinio) volume_avg_90 : Optional[float] @@ -1490,17 +1329,15 @@ def price_performance( "provider": self._get_provider( provider, "/etf/price_performance", - ("finviz", "fmp", "intrinio"), + ("fmp", "intrinio"), ) }, standard_params={ "symbol": symbol, }, extra_params=kwargs, - chart=chart, info={ "symbol": { - "finviz": {"multiple_items_allowed": True}, "fmp": {"multiple_items_allowed": True}, "intrinio": {"multiple_items_allowed": True}, } @@ -1514,7 +1351,7 @@ def search( self, query: Annotated[Optional[str], OpenBBField(description="Search query.")] = "", provider: Annotated[ - Optional[Literal["fmp", "intrinio", "tmx"]], + Optional[Literal["fmp", "intrinio"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -1530,7 +1367,7 @@ def search( ---------- query : Optional[str] Search query. - provider : Optional[Literal['fmp', 'intrinio', 'tmx']] + provider : Optional[Literal['fmp', 'intrinio']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. @@ -1539,19 +1376,13 @@ def search( Target a specific exchange by providing the MIC code. (provider: intrinio) is_active : Optional[Literal[True, False]] Whether the ETF is actively trading. (provider: fmp) - div_freq : Optional[Literal['monthly', 'annually', 'quarterly']] - The dividend payment frequency. (provider: tmx) - sort_by : Optional[Literal['nav', 'return_1m', 'return_3m', 'return_6m', 'return_1y', 'return_3y', 'return_ytd', 'beta_1y', 'volume_avg_daily', 'management_fee', 'distribution_yield', 'pb_ratio', 'pe_ratio']] - The column to sort by. (provider: tmx) - use_cache : bool - Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. (provider: tmx) Returns ------- OBBject results : List[EtfSearch] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'tmx']] + provider : Optional[Literal['fmp', 'intrinio']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -1599,70 +1430,6 @@ def search( The Stock Exchange Daily Official List. (provider: intrinio) intrinio_id : Optional[str] The unique Intrinio ID for the security. (provider: intrinio) - short_name : Optional[str] - The short name of the ETF. (provider: tmx) - inception_date : Optional[str] - The inception date of the ETF. (provider: tmx) - issuer : Optional[str] - The issuer of the ETF. (provider: tmx) - investment_style : Optional[str] - The investment style of the ETF. (provider: tmx) - esg : Optional[bool] - Whether the ETF qualifies as an ESG fund. (provider: tmx) - currency : Optional[str] - The currency of the ETF. (provider: tmx) - unit_price : Optional[float] - The unit price of the ETF. (provider: tmx) - close : Optional[float] - The closing price of the ETF. (provider: tmx) - prev_close : Optional[float] - The previous closing price of the ETF. (provider: tmx) - return_1m : Optional[float] - The one-month return of the ETF, as a normalized percent. (provider: tmx) - return_3m : Optional[float] - The three-month return of the ETF, as a normalized percent. (provider: tmx) - return_6m : Optional[float] - The six-month return of the ETF, as a normalized percent. (provider: tmx) - return_ytd : Optional[float] - The year-to-date return of the ETF, as a normalized percent. (provider: tmx) - return_1y : Optional[float] - The one-year return of the ETF, as a normalized percent. (provider: tmx) - beta_1y : Optional[float] - The one-year beta of the ETF, as a normalized percent. (provider: tmx) - return_3y : Optional[float] - The three-year return of the ETF, as a normalized percent. (provider: tmx) - beta_3y : Optional[float] - The three-year beta of the ETF, as a normalized percent. (provider: tmx) - return_5y : Optional[float] - The five-year return of the ETF, as a normalized percent. (provider: tmx) - beta_5y : Optional[float] - The five-year beta of the ETF, as a normalized percent. (provider: tmx) - return_10y : Optional[float] - The ten-year return of the ETF, as a normalized percent. (provider: tmx) - beta_10y : Optional[float] - The ten-year beta of the ETF. (provider: tmx) - beta_15y : Optional[float] - The fifteen-year beta of the ETF. (provider: tmx) - return_from_inception : Optional[float] - The return from inception of the ETF, as a normalized percent. (provider: tmx) - avg_volume : Optional[int] - The average daily volume of the ETF. (provider: tmx) - avg_volume_30d : Optional[int] - The 30-day average volume of the ETF. (provider: tmx) - aum : Optional[float] - The AUM of the ETF. (provider: tmx) - pe_ratio : Optional[float] - The price-to-earnings ratio of the ETF. (provider: tmx) - pb_ratio : Optional[float] - The price-to-book ratio of the ETF. (provider: tmx) - management_fee : Optional[float] - The management fee of the ETF, as a normalized percent. (provider: tmx) - mer : Optional[float] - The management expense ratio of the ETF, as a normalized percent. (provider: tmx) - distribution_yield : Optional[float] - The distribution yield of the ETF, as a normalized percent. (provider: tmx) - dividend_frequency : Optional[str] - The dividend payment frequency of the ETF. (provider: tmx) Examples -------- @@ -1680,7 +1447,7 @@ def search( "provider": self._get_provider( provider, "/etf/search", - ("fmp", "intrinio", "tmx"), + ("fmp", "intrinio"), ) }, standard_params={ @@ -1698,7 +1465,7 @@ def sectors( str, OpenBBField(description="Symbol to get data for. (ETF)") ], provider: Annotated[ - Optional[Literal["fmp", "tmx"]], + Optional[Literal["fmp"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), @@ -1711,19 +1478,17 @@ def sectors( ---------- symbol : str Symbol to get data for. (ETF) - provider : Optional[Literal['fmp', 'tmx']] + provider : Optional[Literal['fmp']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. - use_cache : bool - Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. (provider: tmx) Returns ------- OBBject results : List[EtfSectors] Serializable results. - provider : Optional[Literal['fmp', 'tmx']] + provider : Optional[Literal['fmp']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -1752,7 +1517,7 @@ def sectors( "provider": self._get_provider( provider, "/etf/sectors", - ("fmp", "tmx"), + ("fmp",), ) }, standard_params={ diff --git a/openbb_platform/openbb/package/fixedincome_corporate.py b/openbb_platform/openbb/package/fixedincome_corporate.py index 182a82fd6cef..47da6e18862e 100644 --- a/openbb_platform/openbb/package/fixedincome_corporate.py +++ b/openbb_platform/openbb/package/fixedincome_corporate.py @@ -13,7 +13,6 @@ class ROUTER_fixedincome_corporate(Container): """/fixedincome/corporate - bond_prices commercial_paper hqm ice_bofa @@ -24,181 +23,6 @@ class ROUTER_fixedincome_corporate(Container): def __repr__(self) -> str: return self.__doc__ or "" - @exception_handler - @validate - def bond_prices( - self, - country: Annotated[ - Optional[str], - OpenBBField(description="The country to get data. Matches partial name."), - ] = None, - issuer_name: Annotated[ - Optional[str], - OpenBBField( - description="Name of the issuer. Returns partial matches and is case insensitive." - ), - ] = None, - isin: Annotated[ - Union[List, str, None], - OpenBBField( - description="International Securities Identification Number(s) of the bond(s)." - ), - ] = None, - lei: Annotated[ - Optional[str], - OpenBBField(description="Legal Entity Identifier of the issuing entity."), - ] = None, - currency: Annotated[ - Union[List, str, None], - OpenBBField( - description="Currency of the bond. Formatted as the 3-letter ISO 4217 code (e.g. GBP, EUR, USD)." - ), - ] = None, - coupon_min: Annotated[ - Optional[float], OpenBBField(description="Minimum coupon rate of the bond.") - ] = None, - coupon_max: Annotated[ - Optional[float], OpenBBField(description="Maximum coupon rate of the bond.") - ] = None, - issued_amount_min: Annotated[ - Optional[int], OpenBBField(description="Minimum issued amount of the bond.") - ] = None, - issued_amount_max: Annotated[ - Optional[str], OpenBBField(description="Maximum issued amount of the bond.") - ] = None, - maturity_date_min: Annotated[ - Optional[datetime.date], - OpenBBField(description="Minimum maturity date of the bond."), - ] = None, - maturity_date_max: Annotated[ - Optional[datetime.date], - OpenBBField(description="Maximum maturity date of the bond."), - ] = None, - provider: Annotated[ - Optional[Literal["tmx"]], - OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'tmx' if there is\n no default." - ), - ] = None, - **kwargs - ) -> OBBject: - """Corporate Bond Prices. - - Parameters - ---------- - country : Optional[str] - The country to get data. Matches partial name. - issuer_name : Optional[str] - Name of the issuer. Returns partial matches and is case insensitive. - isin : Union[List, str, None] - International Securities Identification Number(s) of the bond(s). - lei : Optional[str] - Legal Entity Identifier of the issuing entity. - currency : Union[List, str, None] - Currency of the bond. Formatted as the 3-letter ISO 4217 code (e.g. GBP, EUR, USD). - coupon_min : Optional[float] - Minimum coupon rate of the bond. - coupon_max : Optional[float] - Maximum coupon rate of the bond. - issued_amount_min : Optional[int] - Minimum issued amount of the bond. - issued_amount_max : Optional[str] - Maximum issued amount of the bond. - maturity_date_min : Optional[datetime.date] - Minimum maturity date of the bond. - maturity_date_max : Optional[datetime.date] - Maximum maturity date of the bond. - provider : Optional[Literal['tmx']] - The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'tmx' if there is - no default. - issue_date_min : Optional[datetime.date] - Filter by the minimum original issue date. (provider: tmx) - issue_date_max : Optional[datetime.date] - Filter by the maximum original issue date. (provider: tmx) - last_traded_min : Optional[datetime.date] - Filter by the minimum last trade date. (provider: tmx) - use_cache : bool - All bond data is sourced from a single JSON file that is updated daily. The file is cached for one day to eliminate downloading more than once. Caching will significantly speed up subsequent queries. To bypass, set to False. (provider: tmx) - - Returns - ------- - OBBject - results : List[BondPrices] - Serializable results. - provider : Optional[Literal['tmx']] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - - BondPrices - ---------- - isin : Optional[str] - International Securities Identification Number of the bond. - lei : Optional[str] - Legal Entity Identifier of the issuing entity. - figi : Optional[str] - FIGI of the bond. - cusip : Optional[str] - CUSIP of the bond. - coupon_rate : Optional[float] - Coupon rate of the bond. - ytm : Optional[float] - Yield to maturity (YTM) is the rate of return anticipated on a bond if it is held until the maturity date. It takes into account the current market price, par value, coupon rate and time to maturity. It is assumed that all coupons are reinvested at the same rate. Values are returned as a normalized percent. (provider: tmx) - price : Optional[float] - The last price for the bond. (provider: tmx) - highest_price : Optional[float] - The highest price for the bond on the last traded date. (provider: tmx) - lowest_price : Optional[float] - The lowest price for the bond on the last traded date. (provider: tmx) - total_trades : Optional[int] - Total number of trades on the last traded date. (provider: tmx) - last_traded_date : Optional[date] - Last traded date of the bond. (provider: tmx) - maturity_date : Optional[date] - Maturity date of the bond. (provider: tmx) - issue_date : Optional[date] - Issue date of the bond. This is the date when the bond first accrues interest. (provider: tmx) - issuer_name : Optional[str] - Name of the issuing entity. (provider: tmx) - - Examples - -------- - >>> from openbb import obb - >>> obb.fixedincome.corporate.bond_prices(provider='tmx') - """ # noqa: E501 - - return self._run( - "/fixedincome/corporate/bond_prices", - **filter_inputs( - provider_choices={ - "provider": self._get_provider( - provider, - "/fixedincome/corporate/bond_prices", - ("tmx",), - ) - }, - standard_params={ - "country": country, - "issuer_name": issuer_name, - "isin": isin, - "lei": lei, - "currency": currency, - "coupon_min": coupon_min, - "coupon_max": coupon_max, - "issued_amount_min": issued_amount_min, - "issued_amount_max": issued_amount_max, - "maturity_date_min": maturity_date_min, - "maturity_date_max": maturity_date_max, - }, - extra_params=kwargs, - ) - ) - @exception_handler @validate def commercial_paper( diff --git a/openbb_platform/openbb/package/fixedincome_government.py b/openbb_platform/openbb/package/fixedincome_government.py index 4a32701af147..7bf4e522c836 100644 --- a/openbb_platform/openbb/package/fixedincome_government.py +++ b/openbb_platform/openbb/package/fixedincome_government.py @@ -13,9 +13,6 @@ class ROUTER_fixedincome_government(Container): """/fixedincome/government - eu_yield_curve - treasury_auctions - treasury_prices treasury_rates us_yield_curve """ @@ -23,575 +20,6 @@ class ROUTER_fixedincome_government(Container): def __repr__(self) -> str: return self.__doc__ or "" - @exception_handler - @validate - def eu_yield_curve( - self, - date: Annotated[ - Union[datetime.date, None, str], - OpenBBField(description="A specific date to get data for."), - ] = None, - provider: Annotated[ - Optional[Literal["ecb"]], - OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'ecb' if there is\n no default." - ), - ] = None, - **kwargs - ) -> OBBject: - """Euro Area Yield Curve. - - Gets euro area yield curve data from ECB. - - The graphic depiction of the relationship between the yield on bonds of the same credit quality but different - maturities is known as the yield curve. In the past, most market participants have constructed yield curves from - the observations of prices and yields in the Treasury market. Two reasons account for this tendency. First, - Treasury securities are viewed as free of default risk, and differences in creditworthiness do not affect yield - estimates. Second, as the most active bond market, the Treasury market offers the fewest problems of illiquidity - or infrequent trading. The key function of the Treasury yield curve is to serve as a benchmark for pricing bonds - and setting yields in other sectors of the debt market. - - It is clear that the market’s expectations of future rate changes are one important determinant of the - yield-curve shape. For example, a steeply upward-sloping curve may indicate market expectations of near-term Fed - tightening or of rising inflation. However, it may be too restrictive to assume that the yield differences across - bonds with different maturities only reflect the market’s rate expectations. The well-known pure expectations - hypothesis has such an extreme implication. The pure expectations hypothesis asserts that all government bonds - have the same near-term expected return (as the nominally riskless short-term bond) because the return-seeking - activity of risk-neutral traders removes all expected return differentials across bonds. - - - Parameters - ---------- - date : Union[datetime.date, None, str] - A specific date to get data for. - provider : Optional[Literal['ecb']] - The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'ecb' if there is - no default. - rating : Literal['aaa', 'all_ratings'] - The rating type, either 'aaa' or 'all_ratings'. (provider: ecb) - yield_curve_type : Literal['spot_rate', 'instantaneous_forward', 'par_yield'] - The yield curve type. (provider: ecb) - - Returns - ------- - OBBject - results : List[EUYieldCurve] - Serializable results. - provider : Optional[Literal['ecb']] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - - EUYieldCurve - ------------ - maturity : Optional[float] - Maturity, in years. - rate : Optional[float] - Yield curve rate, as a normalized percent. - - Examples - -------- - >>> from openbb import obb - >>> obb.fixedincome.government.eu_yield_curve(provider='ecb') - >>> obb.fixedincome.government.eu_yield_curve(yield_curve_type='spot_rate', provider='ecb') - """ # noqa: E501 - - return self._run( - "/fixedincome/government/eu_yield_curve", - **filter_inputs( - provider_choices={ - "provider": self._get_provider( - provider, - "/fixedincome/government/eu_yield_curve", - ("ecb",), - ) - }, - standard_params={ - "date": date, - }, - extra_params=kwargs, - ) - ) - - @exception_handler - @validate - def treasury_auctions( - self, - security_type: Annotated[ - Literal["Bill", "Note", "Bond", "CMB", "TIPS", "FRN", None], - OpenBBField( - description="Used to only return securities of a particular type." - ), - ] = None, - cusip: Annotated[ - Optional[str], OpenBBField(description="Filter securities by CUSIP.") - ] = None, - page_size: Annotated[ - Optional[int], - OpenBBField( - description="Maximum number of results to return; you must also include pagenum when using pagesize." - ), - ] = None, - page_num: Annotated[ - Optional[int], - OpenBBField( - description="The first page number to display results for; used in combination with page size." - ), - ] = None, - start_date: Annotated[ - Union[datetime.date, None, str], - OpenBBField( - description="Start date of the data, in YYYY-MM-DD format. The default is 90 days ago." - ), - ] = None, - end_date: Annotated[ - Union[datetime.date, None, str], - OpenBBField( - description="End date of the data, in YYYY-MM-DD format. The default is today." - ), - ] = None, - provider: Annotated[ - Optional[Literal["government_us"]], - OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'government_us' if there is\n no default." - ), - ] = None, - **kwargs - ) -> OBBject: - """Government Treasury Auctions. - - Parameters - ---------- - security_type : Literal['Bill', 'Note', 'Bond', 'CMB', 'TIPS', 'FRN', None] - Used to only return securities of a particular type. - cusip : Optional[str] - Filter securities by CUSIP. - page_size : Optional[int] - Maximum number of results to return; you must also include pagenum when using pagesize. - page_num : Optional[int] - The first page number to display results for; used in combination with page size. - start_date : Union[datetime.date, None, str] - Start date of the data, in YYYY-MM-DD format. The default is 90 days ago. - end_date : Union[datetime.date, None, str] - End date of the data, in YYYY-MM-DD format. The default is today. - provider : Optional[Literal['government_us']] - The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'government_us' if there is - no default. - - Returns - ------- - OBBject - results : List[TreasuryAuctions] - Serializable results. - provider : Optional[Literal['government_us']] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - - TreasuryAuctions - ---------------- - cusip : str - CUSIP of the Security. - issue_date : date - The issue date of the security. - security_type : Literal['Bill', 'Note', 'Bond', 'CMB', 'TIPS', 'FRN'] - The type of security. - security_term : str - The term of the security. - maturity_date : date - The maturity date of the security. - interest_rate : Optional[float] - The interest rate of the security. - cpi_on_issue_date : Optional[float] - Reference CPI rate on the issue date of the security. - cpi_on_dated_date : Optional[float] - Reference CPI rate on the dated date of the security. - announcement_date : Optional[date] - The announcement date of the security. - auction_date : Optional[date] - The auction date of the security. - auction_date_year : Optional[int] - The auction date year of the security. - dated_date : Optional[date] - The dated date of the security. - first_payment_date : Optional[date] - The first payment date of the security. - accrued_interest_per_100 : Optional[float] - Accrued interest per $100. - accrued_interest_per_1000 : Optional[float] - Accrued interest per $1000. - adjusted_accrued_interest_per_100 : Optional[float] - Adjusted accrued interest per $100. - adjusted_accrued_interest_per_1000 : Optional[float] - Adjusted accrued interest per $1000. - adjusted_price : Optional[float] - Adjusted price. - allocation_percentage : Optional[float] - Allocation percentage, as normalized percentage points. - allocation_percentage_decimals : Optional[float] - The number of decimals in the Allocation percentage. - announced_cusip : Optional[str] - The announced CUSIP of the security. - auction_format : Optional[str] - The auction format of the security. - avg_median_discount_rate : Optional[float] - The average median discount rate of the security. - avg_median_investment_rate : Optional[float] - The average median investment rate of the security. - avg_median_price : Optional[float] - The average median price paid for the security. - avg_median_discount_margin : Optional[float] - The average median discount margin of the security. - avg_median_yield : Optional[float] - The average median yield of the security. - back_dated : Optional[Literal['Yes', 'No']] - Whether the security is back dated. - back_dated_date : Optional[date] - The back dated date of the security. - bid_to_cover_ratio : Optional[float] - The bid to cover ratio of the security. - call_date : Optional[date] - The call date of the security. - callable : Optional[Literal['Yes', 'No']] - Whether the security is callable. - called_date : Optional[date] - The called date of the security. - cash_management_bill : Optional[Literal['Yes', 'No']] - Whether the security is a cash management bill. - closing_time_competitive : Optional[str] - The closing time for competitive bids on the security. - closing_time_non_competitive : Optional[str] - The closing time for non-competitive bids on the security. - competitive_accepted : Optional[int] - The accepted value for competitive bids on the security. - competitive_accepted_decimals : Optional[int] - The number of decimals in the Competitive Accepted. - competitive_tendered : Optional[int] - The tendered value for competitive bids on the security. - competitive_tenders_accepted : Optional[Literal['Yes', 'No']] - Whether competitive tenders are accepted on the security. - corp_us_cusip : Optional[str] - The CUSIP of the security. - cpi_base_reference_period : Optional[str] - The CPI base reference period of the security. - currently_outstanding : Optional[int] - The currently outstanding value on the security. - direct_bidder_accepted : Optional[int] - The accepted value from direct bidders on the security. - direct_bidder_tendered : Optional[int] - The tendered value from direct bidders on the security. - est_amount_of_publicly_held_maturing_security : Optional[int] - The estimated amount of publicly held maturing securities on the security. - fima_included : Optional[Literal['Yes', 'No']] - Whether the security is included in the FIMA (Foreign and International Money Authorities). - fima_non_competitive_accepted : Optional[int] - The non-competitive accepted value on the security from FIMAs. - fima_non_competitive_tendered : Optional[int] - The non-competitive tendered value on the security from FIMAs. - first_interest_period : Optional[str] - The first interest period of the security. - first_interest_payment_date : Optional[date] - The first interest payment date of the security. - floating_rate : Optional[Literal['Yes', 'No']] - Whether the security is a floating rate. - frn_index_determination_date : Optional[date] - The FRN index determination date of the security. - frn_index_determination_rate : Optional[float] - The FRN index determination rate of the security. - high_discount_rate : Optional[float] - The high discount rate of the security. - high_investment_rate : Optional[float] - The high investment rate of the security. - high_price : Optional[float] - The high price of the security at auction. - high_discount_margin : Optional[float] - The high discount margin of the security. - high_yield : Optional[float] - The high yield of the security at auction. - index_ratio_on_issue_date : Optional[float] - The index ratio on the issue date of the security. - indirect_bidder_accepted : Optional[int] - The accepted value from indirect bidders on the security. - indirect_bidder_tendered : Optional[int] - The tendered value from indirect bidders on the security. - interest_payment_frequency : Optional[str] - The interest payment frequency of the security. - low_discount_rate : Optional[float] - The low discount rate of the security. - low_investment_rate : Optional[float] - The low investment rate of the security. - low_price : Optional[float] - The low price of the security at auction. - low_discount_margin : Optional[float] - The low discount margin of the security. - low_yield : Optional[float] - The low yield of the security at auction. - maturing_date : Optional[date] - The maturing date of the security. - max_competitive_award : Optional[int] - The maximum competitive award at auction. - max_non_competitive_award : Optional[int] - The maximum non-competitive award at auction. - max_single_bid : Optional[int] - The maximum single bid at auction. - min_bid_amount : Optional[int] - The minimum bid amount at auction. - min_strip_amount : Optional[int] - The minimum strip amount at auction. - min_to_issue : Optional[int] - The minimum to issue at auction. - multiples_to_bid : Optional[int] - The multiples to bid at auction. - multiples_to_issue : Optional[int] - The multiples to issue at auction. - nlp_exclusion_amount : Optional[int] - The NLP exclusion amount at auction. - nlp_reporting_threshold : Optional[int] - The NLP reporting threshold at auction. - non_competitive_accepted : Optional[int] - The accepted value from non-competitive bidders on the security. - non_competitive_tenders_accepted : Optional[Literal['Yes', 'No']] - Whether or not the auction accepted non-competitive tenders. - offering_amount : Optional[int] - The offering amount at auction. - original_cusip : Optional[str] - The original CUSIP of the security. - original_dated_date : Optional[date] - The original dated date of the security. - original_issue_date : Optional[date] - The original issue date of the security. - original_security_term : Optional[str] - The original term of the security. - pdf_announcement : Optional[str] - The PDF filename for the announcement of the security. - pdf_competitive_results : Optional[str] - The PDF filename for the competitive results of the security. - pdf_non_competitive_results : Optional[str] - The PDF filename for the non-competitive results of the security. - pdf_special_announcement : Optional[str] - The PDF filename for the special announcements. - price_per_100 : Optional[float] - The price per 100 of the security. - primary_dealer_accepted : Optional[int] - The primary dealer accepted value on the security. - primary_dealer_tendered : Optional[int] - The primary dealer tendered value on the security. - reopening : Optional[Literal['Yes', 'No']] - Whether or not the auction was reopened. - security_term_day_month : Optional[str] - The security term in days or months. - security_term_week_year : Optional[str] - The security term in weeks or years. - series : Optional[str] - The series name of the security. - soma_accepted : Optional[int] - The SOMA accepted value on the security. - soma_holdings : Optional[int] - The SOMA holdings on the security. - soma_included : Optional[Literal['Yes', 'No']] - Whether or not the SOMA (System Open Market Account) was included on the security. - soma_tendered : Optional[int] - The SOMA tendered value on the security. - spread : Optional[float] - The spread on the security. - standard_payment_per_1000 : Optional[float] - The standard payment per 1000 of the security. - strippable : Optional[Literal['Yes', 'No']] - Whether or not the security is strippable. - term : Optional[str] - The term of the security. - tiin_conversion_factor_per_1000 : Optional[float] - The TIIN conversion factor per 1000 of the security. - tips : Optional[Literal['Yes', 'No']] - Whether or not the security is TIPS. - total_accepted : Optional[int] - The total accepted value at auction. - total_tendered : Optional[int] - The total tendered value at auction. - treasury_retail_accepted : Optional[int] - The accepted value on the security from retail. - treasury_retail_tenders_accepted : Optional[Literal['Yes', 'No']] - Whether or not the tender offers from retail are accepted - type : Optional[str] - The type of issuance. This might be different than the security type. - unadjusted_accrued_interest_per_1000 : Optional[float] - The unadjusted accrued interest per 1000 of the security. - unadjusted_price : Optional[float] - The unadjusted price of the security. - updated_timestamp : Optional[datetime] - The updated timestamp of the security. - xml_announcement : Optional[str] - The XML filename for the announcement of the security. - xml_competitive_results : Optional[str] - The XML filename for the competitive results of the security. - xml_special_announcement : Optional[str] - The XML filename for special announcements. - tint_cusip1 : Optional[str] - Tint CUSIP 1. - tint_cusip2 : Optional[str] - Tint CUSIP 2. - - Examples - -------- - >>> from openbb import obb - >>> obb.fixedincome.government.treasury_auctions(provider='government_us') - >>> obb.fixedincome.government.treasury_auctions(security_type='Bill', start_date='2022-01-01', end_date='2023-01-01', provider='government_us') - """ # noqa: E501 - - return self._run( - "/fixedincome/government/treasury_auctions", - **filter_inputs( - provider_choices={ - "provider": self._get_provider( - provider, - "/fixedincome/government/treasury_auctions", - ("government_us",), - ) - }, - standard_params={ - "security_type": security_type, - "cusip": cusip, - "page_size": page_size, - "page_num": page_num, - "start_date": start_date, - "end_date": end_date, - }, - extra_params=kwargs, - ) - ) - - @exception_handler - @validate - def treasury_prices( - self, - date: Annotated[ - Union[datetime.date, None, str], - OpenBBField( - description="A specific date to get data for. Defaults to the last business day." - ), - ] = None, - provider: Annotated[ - Optional[Literal["government_us", "tmx"]], - OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'government_us' if there is\n no default." - ), - ] = None, - **kwargs - ) -> OBBject: - """Government Treasury Prices by date. - - Parameters - ---------- - date : Union[datetime.date, None, str] - A specific date to get data for. Defaults to the last business day. - provider : Optional[Literal['government_us', 'tmx']] - The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'government_us' if there is - no default. - cusip : Optional[str] - Filter by CUSIP. (provider: government_us) - security_type : Optional[Literal['bill', 'note', 'bond', 'tips', 'frn']] - Filter by security type. (provider: government_us) - govt_type : Literal['federal', 'provincial', 'municipal'] - The level of government issuer. (provider: tmx) - issue_date_min : Optional[datetime.date] - Filter by the minimum original issue date. (provider: tmx) - issue_date_max : Optional[datetime.date] - Filter by the maximum original issue date. (provider: tmx) - last_traded_min : Optional[datetime.date] - Filter by the minimum last trade date. (provider: tmx) - maturity_date_min : Optional[datetime.date] - Filter by the minimum maturity date. (provider: tmx) - maturity_date_max : Optional[datetime.date] - Filter by the maximum maturity date. (provider: tmx) - use_cache : bool - All bond data is sourced from a single JSON file that is updated daily. The file is cached for one day to eliminate downloading more than once. Caching will significantly speed up subsequent queries. To bypass, set to False. (provider: tmx) - - Returns - ------- - OBBject - results : List[TreasuryPrices] - Serializable results. - provider : Optional[Literal['government_us', 'tmx']] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - - TreasuryPrices - -------------- - issuer_name : Optional[str] - Name of the issuing entity. - cusip : Optional[str] - CUSIP of the security. - isin : Optional[str] - ISIN of the security. - security_type : Optional[str] - The type of Treasury security - i.e., Bill, Note, Bond, TIPS, FRN. - issue_date : Optional[date] - The original issue date of the security. - maturity_date : Optional[date] - The maturity date of the security. - call_date : Optional[date] - The call date of the security. - bid : Optional[float] - The bid price of the security. - offer : Optional[float] - The offer price of the security. - eod_price : Optional[float] - The end-of-day price of the security. - last_traded_date : Optional[date] - The last trade date of the security. - total_trades : Optional[int] - Total number of trades on the last traded date. - last_price : Optional[float] - The last price of the security. - highest_price : Optional[float] - The highest price for the bond on the last traded date. - lowest_price : Optional[float] - The lowest price for the bond on the last traded date. - rate : Optional[float] - The annualized interest rate or coupon of the security. - ytm : Optional[float] - Yield to maturity (YTM) is the rate of return anticipated on a bond if it is held until the maturity date. It takes into account the current market price, par value, coupon rate and time to maturity. It is assumed that all coupons are reinvested at the same rate. - - Examples - -------- - >>> from openbb import obb - >>> obb.fixedincome.government.treasury_prices(provider='government_us') - >>> obb.fixedincome.government.treasury_prices(date='2019-02-05', provider='government_us') - """ # noqa: E501 - - return self._run( - "/fixedincome/government/treasury_prices", - **filter_inputs( - provider_choices={ - "provider": self._get_provider( - provider, - "/fixedincome/government/treasury_prices", - ("government_us", "tmx"), - ) - }, - standard_params={ - "date": date, - }, - extra_params=kwargs, - ) - ) - @exception_handler @validate def treasury_rates( diff --git a/openbb_platform/openbb/package/index.py b/openbb_platform/openbb/package/index.py index bc55bbd52408..46f5881f8b4c 100644 --- a/openbb_platform/openbb/package/index.py +++ b/openbb_platform/openbb/package/index.py @@ -19,10 +19,6 @@ class ROUTER_index(Container): constituents market /price - search - sectors - snapshots - sp500_multiples """ def __repr__(self) -> str: @@ -33,9 +29,9 @@ def __repr__(self) -> str: def available( self, provider: Annotated[ - Optional[Literal["cboe", "fmp", "tmx", "yfinance"]], + Optional[Literal["fmp", "yfinance"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'cboe' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), ] = None, **kwargs @@ -44,20 +40,17 @@ def available( Parameters ---------- - provider : Optional[Literal['cboe', 'fmp', 'tmx', 'yfinance']] + provider : Optional[Literal['fmp', 'yfinance']] The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'cboe' if there is + If None, the provider specified in defaults is selected or 'fmp' if there is no default. - use_cache : bool - When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass. (provider: cboe); - Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False. (provider: tmx) Returns ------- OBBject results : List[AvailableIndices] Serializable results. - provider : Optional[Literal['cboe', 'fmp', 'tmx', 'yfinance']] + provider : Optional[Literal['fmp', 'yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -72,30 +65,14 @@ def available( Name of the index. currency : Optional[str] Currency the index is traded in. - symbol : Optional[str] - Symbol for the index. (provider: cboe, tmx, yfinance) - description : Optional[str] - Description for the index. Valid only for US indices. (provider: cboe) - data_delay : Optional[int] - Data delay for the index. Valid only for US indices. (provider: cboe) - open_time : Optional[datetime.time] - Opening time for the index. Valid only for US indices. (provider: cboe) - close_time : Optional[datetime.time] - Closing time for the index. Valid only for US indices. (provider: cboe) - time_zone : Optional[str] - Time zone for the index. Valid only for US indices. (provider: cboe) - tick_days : Optional[str] - The trading days for the index. Valid only for US indices. (provider: cboe) - tick_frequency : Optional[str] - The frequency of the index ticks. Valid only for US indices. (provider: cboe) - tick_period : Optional[str] - The period of the index ticks. Valid only for US indices. (provider: cboe) stock_exchange : Optional[str] Stock exchange where the index is listed. (provider: fmp) exchange_short_name : Optional[str] Short name of the stock exchange where the index is listed. (provider: fmp) code : Optional[str] ID code for keying the index in the OpenBB Terminal. (provider: yfinance) + symbol : Optional[str] + Symbol for the index. (provider: yfinance) Examples -------- @@ -111,7 +88,7 @@ def available( "provider": self._get_provider( provider, "/index/available", - ("cboe", "fmp", "tmx", "yfinance"), + ("fmp", "yfinance"), ) }, standard_params={}, @@ -125,9 +102,9 @@ def constituents( self, symbol: Annotated[str, OpenBBField(description="Symbol to get data for.")], provider: Annotated[ - Optional[Literal["cboe", "fmp", "tmx"]], + Optional[Literal["fmp"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'cboe' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), ] = None, **kwargs @@ -138,19 +115,17 @@ def constituents( ---------- symbol : str Symbol to get data for. - provider : Optional[Literal['cboe', 'fmp', 'tmx']] + provider : Optional[Literal['fmp']] The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'cboe' if there is + If None, the provider specified in defaults is selected or 'fmp' if there is no default. - use_cache : bool - Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False. (provider: tmx) Returns ------- OBBject results : List[IndexConstituents] Serializable results. - provider : Optional[Literal['cboe', 'fmp', 'tmx']] + provider : Optional[Literal['fmp']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -165,32 +140,6 @@ def constituents( Symbol representing the entity requested in the data. name : Optional[str] Name of the constituent company in the index. - security_type : Optional[str] - The type of security represented. (provider: cboe) - last_price : Optional[float] - Last price for the symbol. (provider: cboe) - open : Optional[float] - The open price. (provider: cboe) - high : Optional[float] - The high price. (provider: cboe) - low : Optional[float] - The low price. (provider: cboe) - close : Optional[float] - The close price. (provider: cboe) - volume : Optional[int] - The trading volume. (provider: cboe) - prev_close : Optional[float] - The previous close price. (provider: cboe) - change : Optional[float] - Change in price. (provider: cboe) - change_percent : Optional[float] - Change in price as a normalized percentage. (provider: cboe) - tick : Optional[str] - Whether the last sale was an up or down tick. (provider: cboe) - last_trade_time : Optional[datetime] - Last trade timestamp for the symbol. (provider: cboe) - asset_type : Optional[str] - Type of asset. (provider: cboe) sector : Optional[str] Sector the constituent company in the index belongs to. (provider: fmp) sub_sector : Optional[str] @@ -203,15 +152,11 @@ def constituents( Central Index Key (CIK) for the requested entity. (provider: fmp) founded : Optional[Union[str, date]] Founding year of the constituent company in the index. (provider: fmp) - market_value : Optional[float] - The quoted market value of the asset. (provider: tmx) Examples -------- >>> from openbb import obb >>> obb.index.constituents(symbol='dowjones', provider='fmp') - >>> # Providers other than FMP will use the ticker symbol. - >>> obb.index.constituents(symbol='BEP50P', provider='cboe') """ # noqa: E501 return self._run( @@ -221,7 +166,7 @@ def constituents( "provider": self._get_provider( provider, "/index/constituents", - ("cboe", "fmp", "tmx"), + ("fmp",), ) }, standard_params={ @@ -242,7 +187,7 @@ def market( symbol: Annotated[ Union[str, List[str]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, polygon, yfinance." ), ], start_date: Annotated[ @@ -258,9 +203,9 @@ def market( OpenBBField(description="Time interval of the data to return."), ] = "1d", provider: Annotated[ - Optional[Literal["cboe", "fmp", "intrinio", "polygon", "yfinance"]], + Optional[Literal["fmp", "intrinio", "polygon", "yfinance"]], OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'cboe' if there is\n no default." + description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default." ), ] = None, **kwargs @@ -270,19 +215,17 @@ def market( Parameters ---------- symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, polygon, yfinance. start_date : Union[datetime.date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] End date of the data, in YYYY-MM-DD format. interval : Optional[str] Time interval of the data to return. - provider : Optional[Literal['cboe', 'fmp', 'intrinio', 'polygon', 'yfinance'... + provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']] The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'cboe' if there is + If None, the provider specified in defaults is selected or 'fmp' if there is no default. - use_cache : bool - When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. (provider: cboe) limit : Optional[int] The number of data entries to return. (provider: intrinio, polygon) sort : Literal['asc', 'desc'] @@ -293,7 +236,7 @@ def market( OBBject results : List[MarketIndices] Serializable results. - provider : Optional[Literal['cboe', 'fmp', 'intrinio', 'polygon', 'yfinance']] + provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -316,12 +259,6 @@ def market( The close price. volume : Optional[int] The trading volume. - calls_volume : Optional[float] - Number of calls traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) - puts_volume : Optional[float] - Number of puts traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) - total_options_volume : Optional[float] - Total number of options traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) vwap : Optional[float] Volume Weighted Average Price over the period. (provider: fmp) change : Optional[float] @@ -351,7 +288,7 @@ def market( "provider": self._get_provider( provider, "/index/market", - ("cboe", "fmp", "intrinio", "polygon", "yfinance"), + ("fmp", "intrinio", "polygon", "yfinance"), ) }, standard_params={ @@ -363,7 +300,6 @@ def market( extra_params=kwargs, info={ "symbol": { - "cboe": {"multiple_items_allowed": True}, "fmp": {"multiple_items_allowed": True}, "intrinio": {"multiple_items_allowed": True}, "polygon": {"multiple_items_allowed": True}, @@ -379,423 +315,3 @@ def price(self): from . import index_price return index_price.ROUTER_index_price(command_runner=self._command_runner) - - @exception_handler - @validate - def search( - self, - query: Annotated[str, OpenBBField(description="Search query.")] = "", - is_symbol: Annotated[ - bool, OpenBBField(description="Whether to search by ticker symbol.") - ] = False, - provider: Annotated[ - Optional[Literal["cboe"]], - OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'cboe' if there is\n no default." - ), - ] = None, - **kwargs - ) -> OBBject: - """Filter indices for rows containing the query. - - Parameters - ---------- - query : str - Search query. - is_symbol : bool - Whether to search by ticker symbol. - provider : Optional[Literal['cboe']] - The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'cboe' if there is - no default. - use_cache : bool - When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass. (provider: cboe) - - Returns - ------- - OBBject - results : List[IndexSearch] - Serializable results. - provider : Optional[Literal['cboe']] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - - IndexSearch - ----------- - symbol : str - Symbol representing the entity requested in the data. - name : str - Name of the index. - description : Optional[str] - Description for the index. (provider: cboe) - data_delay : Optional[int] - Data delay for the index. Valid only for US indices. (provider: cboe) - currency : Optional[str] - Currency for the index. (provider: cboe) - time_zone : Optional[str] - Time zone for the index. Valid only for US indices. (provider: cboe) - open_time : Optional[datetime.time] - Opening time for the index. Valid only for US indices. (provider: cboe) - close_time : Optional[datetime.time] - Closing time for the index. Valid only for US indices. (provider: cboe) - tick_days : Optional[str] - The trading days for the index. Valid only for US indices. (provider: cboe) - tick_frequency : Optional[str] - Tick frequency for the index. Valid only for US indices. (provider: cboe) - tick_period : Optional[str] - Tick period for the index. Valid only for US indices. (provider: cboe) - - Examples - -------- - >>> from openbb import obb - >>> obb.index.search(provider='cboe') - >>> obb.index.search(query='SPX', provider='cboe') - """ # noqa: E501 - - return self._run( - "/index/search", - **filter_inputs( - provider_choices={ - "provider": self._get_provider( - provider, - "/index/search", - ("cboe",), - ) - }, - standard_params={ - "query": query, - "is_symbol": is_symbol, - }, - extra_params=kwargs, - ) - ) - - @exception_handler - @validate - def sectors( - self, - symbol: Annotated[str, OpenBBField(description="Symbol to get data for.")], - provider: Annotated[ - Optional[Literal["tmx"]], - OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'tmx' if there is\n no default." - ), - ] = None, - **kwargs - ) -> OBBject: - """Get Index Sectors. Sector weighting of an index. - - Parameters - ---------- - symbol : str - Symbol to get data for. - provider : Optional[Literal['tmx']] - The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'tmx' if there is - no default. - use_cache : bool - Whether to use a cached request. All Index data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 1 day. (provider: tmx) - - Returns - ------- - OBBject - results : List[IndexSectors] - Serializable results. - provider : Optional[Literal['tmx']] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - - IndexSectors - ------------ - sector : str - The sector name. - weight : float - The weight of the sector in the index. - - Examples - -------- - >>> from openbb import obb - >>> obb.index.sectors(symbol='^TX60', provider='tmx') - """ # noqa: E501 - - return self._run( - "/index/sectors", - **filter_inputs( - provider_choices={ - "provider": self._get_provider( - provider, - "/index/sectors", - ("tmx",), - ) - }, - standard_params={ - "symbol": symbol, - }, - extra_params=kwargs, - ) - ) - - @exception_handler - @validate - def snapshots( - self, - region: Annotated[ - str, - OpenBBField(description="The region of focus for the data - i.e., us, eu."), - ] = "us", - provider: Annotated[ - Optional[Literal["cboe", "tmx"]], - OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'cboe' if there is\n no default." - ), - ] = None, - **kwargs - ) -> OBBject: - """Index Snapshots. Current levels for all indices from a provider, grouped by `region`. - - Parameters - ---------- - region : str - The region of focus for the data - i.e., us, eu. - provider : Optional[Literal['cboe', 'tmx']] - The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'cboe' if there is - no default. - use_cache : bool - Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False. (provider: tmx) - - Returns - ------- - OBBject - results : List[IndexSnapshots] - Serializable results. - provider : Optional[Literal['cboe', 'tmx']] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - - IndexSnapshots - -------------- - symbol : str - Symbol representing the entity requested in the data. - name : Optional[str] - Name of the index. - currency : Optional[str] - Currency of the index. - price : Optional[float] - Current price of the index. - open : Optional[float] - The open price. - high : Optional[float] - The high price. - low : Optional[float] - The low price. - close : Optional[float] - The close price. - volume : Optional[int] - The trading volume. - prev_close : Optional[float] - The previous close price. - change : Optional[float] - Change in value of the index. - change_percent : Optional[float] - Change, in normalized percentage points, of the index. - bid : Optional[float] - Current bid price. (provider: cboe) - ask : Optional[float] - Current ask price. (provider: cboe) - last_trade_time : Optional[datetime] - Last trade timestamp for the symbol. (provider: cboe) - status : Optional[str] - Status of the market, open or closed. (provider: cboe) - year_high : Optional[float] - The 52-week high of the index. (provider: tmx) - year_low : Optional[float] - The 52-week low of the index. (provider: tmx) - return_mtd : Optional[float] - The month-to-date return of the index, as a normalized percent. (provider: tmx) - return_qtd : Optional[float] - The quarter-to-date return of the index, as a normalized percent. (provider: tmx) - return_ytd : Optional[float] - The year-to-date return of the index, as a normalized percent. (provider: tmx) - total_market_value : Optional[float] - The total quoted market value of the index. (provider: tmx) - number_of_constituents : Optional[int] - The number of constituents in the index. (provider: tmx) - constituent_average_market_value : Optional[float] - The average quoted market value of the index constituents. (provider: tmx) - constituent_median_market_value : Optional[float] - The median quoted market value of the index constituents. (provider: tmx) - constituent_top10_market_value : Optional[float] - The sum of the top 10 quoted market values of the index constituents. (provider: tmx) - constituent_largest_market_value : Optional[float] - The largest quoted market value of the index constituents. (provider: tmx) - constituent_largest_weight : Optional[float] - The largest weight of the index constituents, as a normalized percent. (provider: tmx) - constituent_smallest_market_value : Optional[float] - The smallest quoted market value of the index constituents. (provider: tmx) - constituent_smallest_weight : Optional[float] - The smallest weight of the index constituents, as a normalized percent. (provider: tmx) - - Examples - -------- - >>> from openbb import obb - >>> obb.index.snapshots(provider='tmx') - >>> obb.index.snapshots(region='us', provider='cboe') - """ # noqa: E501 - - return self._run( - "/index/snapshots", - **filter_inputs( - provider_choices={ - "provider": self._get_provider( - provider, - "/index/snapshots", - ("cboe", "tmx"), - ) - }, - standard_params={ - "region": region, - }, - extra_params=kwargs, - ) - ) - - @exception_handler - @validate - def sp500_multiples( - self, - series_name: Annotated[ - Literal[ - "shiller_pe_month", - "shiller_pe_year", - "pe_year", - "pe_month", - "dividend_year", - "dividend_month", - "dividend_growth_quarter", - "dividend_growth_year", - "dividend_yield_year", - "dividend_yield_month", - "earnings_year", - "earnings_month", - "earnings_growth_year", - "earnings_growth_quarter", - "real_earnings_growth_year", - "real_earnings_growth_quarter", - "earnings_yield_year", - "earnings_yield_month", - "real_price_year", - "real_price_month", - "inflation_adjusted_price_year", - "inflation_adjusted_price_month", - "sales_year", - "sales_quarter", - "sales_growth_year", - "sales_growth_quarter", - "real_sales_year", - "real_sales_quarter", - "real_sales_growth_year", - "real_sales_growth_quarter", - "price_to_sales_year", - "price_to_sales_quarter", - "price_to_book_value_year", - "price_to_book_value_quarter", - "book_value_year", - "book_value_quarter", - ], - OpenBBField(description="The name of the series. Defaults to 'pe_month'."), - ] = "pe_month", - start_date: Annotated[ - Union[datetime.date, None, str], - OpenBBField(description="Start date of the data, in YYYY-MM-DD format."), - ] = None, - end_date: Annotated[ - Union[datetime.date, None, str], - OpenBBField(description="End date of the data, in YYYY-MM-DD format."), - ] = None, - provider: Annotated[ - Optional[Literal["nasdaq"]], - OpenBBField( - description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'nasdaq' if there is\n no default." - ), - ] = None, - **kwargs - ) -> OBBject: - """Get historical S&P 500 multiples and Shiller PE ratios. - - Parameters - ---------- - series_name : Literal['shiller_pe_month', 'shiller_pe_year', 'pe_year', 'pe_month', 'd... - The name of the series. Defaults to 'pe_month'. - start_date : Union[datetime.date, None, str] - Start date of the data, in YYYY-MM-DD format. - end_date : Union[datetime.date, None, str] - End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['nasdaq']] - The provider to use for the query, by default None. - If None, the provider specified in defaults is selected or 'nasdaq' if there is - no default. - transform : Literal['diff', 'rdiff', 'cumul', 'normalize', None] - Transform the data as difference, percent change, cumulative, or normalize. (provider: nasdaq) - collapse : Literal['daily', 'weekly', 'monthly', 'quarterly', 'annual', None] - Collapse the frequency of the time series. (provider: nasdaq) - - Returns - ------- - OBBject - results : List[SP500Multiples] - Serializable results. - provider : Optional[Literal['nasdaq']] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - - SP500Multiples - -------------- - date : date - The date of the data. - - Examples - -------- - >>> from openbb import obb - >>> obb.index.sp500_multiples(provider='nasdaq') - >>> obb.index.sp500_multiples(series_name='shiller_pe_year', provider='nasdaq') - """ # noqa: E501 - - return self._run( - "/index/sp500_multiples", - **filter_inputs( - provider_choices={ - "provider": self._get_provider( - provider, - "/index/sp500_multiples", - ("nasdaq",), - ) - }, - standard_params={ - "series_name": series_name, - "start_date": start_date, - "end_date": end_date, - }, - extra_params=kwargs, - ) - ) diff --git a/openbb_platform/openbb/package/news.py b/openbb_platform/openbb/package/news.py index 3ada18b20ebc..b0e65cd2ab25 100644 --- a/openbb_platform/openbb/package/news.py +++ b/openbb_platform/openbb/package/news.py @@ -28,7 +28,7 @@ def company( symbol: Annotated[ Union[str, None, List[Optional[str]]], OpenBBField( - description="Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance." + description="Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, yfinance." ), ] = None, start_date: Annotated[ @@ -45,15 +45,7 @@ def company( ] = 2500, provider: Annotated[ Optional[ - Literal[ - "benzinga", - "fmp", - "intrinio", - "polygon", - "tiingo", - "tmx", - "yfinance", - ] + Literal["benzinga", "fmp", "intrinio", "polygon", "tiingo", "yfinance"] ], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'benzinga' if there is\n no default." @@ -66,7 +58,7 @@ def company( Parameters ---------- symbol : Union[str, None, List[Optional[str]]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance. + Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, yfinance. start_date : Union[datetime.date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] @@ -103,8 +95,7 @@ def company( content_types : Optional[str] Content types of the news to retrieve. (provider: benzinga) page : Optional[int] - Page number of the results. Use in combination with limit. (provider: fmp); - The page number to start from. Use with limit. (provider: tmx) + Page number of the results. Use in combination with limit. (provider: fmp) source : Optional[Union[Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases'], str]] The source of the news article. (provider: intrinio); A comma-separated list of the domains requested. (provider: tiingo) @@ -132,7 +123,7 @@ def company( OBBject results : List[CompanyNews] Serializable results. - provider : Optional[Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'yfinance']] + provider : Optional[Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -174,7 +165,6 @@ def company( The source of the news article. (provider: intrinio); Source of the article. (provider: polygon); News source. (provider: tiingo); - Source of the news. (provider: tmx); Source of the news article (provider: yfinance) summary : Optional[str] The summary of the news article. (provider: intrinio) @@ -233,7 +223,6 @@ def company( "intrinio", "polygon", "tiingo", - "tmx", "yfinance", ), ) @@ -252,7 +241,6 @@ def company( "intrinio": {"multiple_items_allowed": True}, "polygon": {"multiple_items_allowed": True}, "tiingo": {"multiple_items_allowed": True}, - "tmx": {"multiple_items_allowed": True}, "yfinance": {"multiple_items_allowed": True}, } }, @@ -278,7 +266,7 @@ def world( OpenBBField(description="End date of the data, in YYYY-MM-DD format."), ] = None, provider: Annotated[ - Optional[Literal["benzinga", "biztoc", "fmp", "intrinio", "tiingo"]], + Optional[Literal["benzinga", "fmp", "intrinio", "tiingo"]], OpenBBField( description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'benzinga' if there is\n no default." ), @@ -295,7 +283,7 @@ def world( Start date of the data, in YYYY-MM-DD format. end_date : Union[datetime.date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['benzinga', 'biztoc', 'fmp', 'intrinio', 'tiingo... + provider : Optional[Literal['benzinga', 'fmp', 'intrinio', 'tiingo']] 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. @@ -323,16 +311,9 @@ def world( Authors of the news to retrieve. (provider: benzinga) content_types : Optional[str] Content types of the news to retrieve. (provider: benzinga) - filter : Literal['crypto', 'hot', 'latest', 'main', 'media', 'source', 'tag'] - Filter by type of news. (provider: biztoc) - source : Optional[Union[str, Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases']]] - Filter by a specific publisher. Only valid when filter is set to source. (provider: biztoc); + source : Optional[Union[Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases'], str]] The source of the news article. (provider: intrinio); A comma-separated list of the domains requested. (provider: tiingo) - tag : Optional[str] - Tag, topic, to filter articles by. Only valid when filter is set to tag. (provider: biztoc) - term : Optional[str] - Search term to filter articles by. This overrides all other filters. (provider: biztoc) sentiment : Optional[Literal['positive', 'neutral', 'negative']] Return news only from this source. (provider: intrinio) language : Optional[str] @@ -357,7 +338,7 @@ def world( OBBject results : List[WorldNews] Serializable results. - provider : Optional[Literal['benzinga', 'biztoc', 'fmp', 'intrinio', 'tiingo']] + provider : Optional[Literal['benzinga', 'fmp', 'intrinio', 'tiingo']] Provider name. warnings : Optional[List[Warning_]] List of warnings. @@ -379,7 +360,7 @@ def world( url : Optional[str] URL to the article. id : Optional[str] - Article ID. (provider: benzinga, biztoc, intrinio) + Article ID. (provider: benzinga, intrinio) author : Optional[str] Author of the news. (provider: benzinga) teaser : Optional[str] @@ -388,14 +369,10 @@ def world( Channels associated with the news. (provider: benzinga) stocks : Optional[str] Stocks associated with the news. (provider: benzinga) - tags : Optional[Union[str, List[str]]] - Tags associated with the news. (provider: benzinga, biztoc, tiingo) + tags : Optional[str] + Tags associated with the news. (provider: benzinga, tiingo) updated : Optional[datetime] Updated date of the news. (provider: benzinga) - favicon : Optional[str] - Icon image for the source of the article. (provider: biztoc) - score : Optional[float] - Search relevance score for the article. (provider: biztoc) site : Optional[str] News source. (provider: fmp, tiingo) source : Optional[str] @@ -442,8 +419,6 @@ def world( >>> obb.news.world(topics='finance', provider='benzinga') >>> # Get news by source using 'tingo' as provider. >>> obb.news.world(provider='tiingo', source='bloomberg') - >>> # Filter aticles by term using 'biztoc' as provider. - >>> obb.news.world(provider='biztoc', term='apple') """ # noqa: E501 return self._run( @@ -453,7 +428,7 @@ def world( "provider": self._get_provider( provider, "/news/world", - ("benzinga", "biztoc", "fmp", "intrinio", "tiingo"), + ("benzinga", "fmp", "intrinio", "tiingo"), ) }, standard_params={ diff --git a/openbb_platform/openbb/package/regulators.py b/openbb_platform/openbb/package/regulators.py index f309425d2784..753e0bfc69aa 100644 --- a/openbb_platform/openbb/package/regulators.py +++ b/openbb_platform/openbb/package/regulators.py @@ -6,22 +6,12 @@ class ROUTER_regulators(Container): """/regulators - /cftc /sec """ def __repr__(self) -> str: return self.__doc__ or "" - @property - def cftc(self): - # pylint: disable=import-outside-toplevel - from . import regulators_cftc - - return regulators_cftc.ROUTER_regulators_cftc( - command_runner=self._command_runner - ) - @property def sec(self): # pylint: disable=import-outside-toplevel From 9740eb2b0856a8238f86b996c3b7d6a8b60a935f Mon Sep 17 00:00:00 2001 From: hjoaquim Date: Mon, 13 May 2024 09:50:22 +0100 Subject: [PATCH 4/9] reset reference --- openbb_platform/openbb/assets/reference.json | 41535 ++++++----------- 1 file changed, 15069 insertions(+), 26466 deletions(-) diff --git a/openbb_platform/openbb/assets/reference.json b/openbb_platform/openbb/assets/reference.json index 291bb07f726f..5ff26093f056 100644 --- a/openbb_platform/openbb/assets/reference.json +++ b/openbb_platform/openbb/assets/reference.json @@ -10,225 +10,32 @@ "crypto@1.1.5", "currency@1.1.5", "derivatives@1.1.5", - "econometrics@1.1.5", "economy@1.1.5", "equity@1.1.5", "etf@1.1.5", "fixedincome@1.1.5", "index@1.1.5", "news@1.1.5", - "quantitative@1.1.5", - "regulators@1.1.5", - "technical@1.1.6" + "regulators@1.1.5" ], "openbb_provider_extension": [ - "alpha_vantage@1.1.5", "benzinga@1.1.5", - "biztoc@1.1.5", - "cboe@1.1.5", - "ecb@1.1.5", "econdb@1.0.0", "federal_reserve@1.1.5", - "finra@1.1.5", - "finviz@1.0.4", "fmp@1.1.5", "fred@1.1.5", - "government_us@1.1.5", "intrinio@1.1.5", - "nasdaq@1.1.6", "oecd@1.1.5", "polygon@1.1.5", "sec@1.1.5", - "seeking_alpha@1.1.5", - "stockgrid@1.1.5", "tiingo@1.1.5", - "tmx@1.0.2", - "tradier@1.0.2", "tradingeconomics@1.1.5", - "wsj@1.1.5", "yfinance@1.1.5" ], - "openbb_obbject_extension": [ - "openbb_charting@2.0.3" - ] + "openbb_obbject_extension": [] } }, "paths": { - "/commodity/lbma_fixing": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Daily LBMA Fixing Prices in USD/EUR/GBP.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.commodity.lbma_fixing(provider='nasdaq')\n# Get the daily LBMA fixing prices for silver in 2023.\nobb.commodity.lbma_fixing(asset='silver', start_date='2023-01-01', end_date='2023-12-31', transform=rdiff, collapse=monthly, provider='nasdaq')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "asset", - "type": "Literal['gold', 'silver']", - "description": "The metal to get price fixing rates for.", - "default": "gold", - "optional": true - }, - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "provider", - "type": "Literal['nasdaq']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default.", - "default": "nasdaq", - "optional": true - } - ], - "nasdaq": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "transform", - "type": "Literal['diff', 'rdiff', 'cumul', 'normalize']", - "description": "Transform the data as difference, percent change, cumulative, or normalize.", - "default": null, - "optional": true - }, - { - "name": "collapse", - "type": "Literal['daily', 'weekly', 'monthly', 'quarterly', 'annual']", - "description": "Collapse the frequency of the time series.", - "default": null, - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[LbmaFixing]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['nasdaq']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "usd_am", - "type": "float", - "description": "AM fixing price in USD.", - "default": null, - "optional": true - }, - { - "name": "usd_pm", - "type": "float", - "description": "PM fixing price in USD.", - "default": null, - "optional": true - }, - { - "name": "gbp_am", - "type": "float", - "description": "AM fixing price in GBP.", - "default": null, - "optional": true - }, - { - "name": "gbp_pm", - "type": "float", - "description": "PM fixing price in GBP.", - "default": null, - "optional": true - }, - { - "name": "euro_am", - "type": "float", - "description": "AM fixing price in EUR.", - "default": null, - "optional": true - }, - { - "name": "euro_pm", - "type": "float", - "description": "PM fixing price in EUR.", - "default": null, - "optional": true - }, - { - "name": "usd", - "type": "float", - "description": "Daily fixing price in USD.", - "default": null, - "optional": true - }, - { - "name": "gbp", - "type": "float", - "description": "Daily fixing price in GBP.", - "default": null, - "optional": true - }, - { - "name": "eur", - "type": "float", - "description": "Daily fixing price in EUR.", - "default": null, - "optional": true - } - ], - "nasdaq": [] - }, - "model": "LbmaFixing" - }, "/crypto/price/historical": { "deprecated": { "flag": null, @@ -937,35 +744,57 @@ }, "model": "CurrencyPairs" }, - "/currency/reference_rates": { + "/currency/snapshots": { "deprecated": { "flag": null, "message": null }, - "description": "Get current, official, currency reference rates.\n\nForeign exchange reference rates are the exchange rates set by a major financial institution or regulatory body,\nserving as a benchmark for the value of currencies around the world.\nThese rates are used as a standard to facilitate international trade and financial transactions,\nensuring consistency and reliability in currency conversion.\nThey are typically updated on a daily basis and reflect the market conditions at a specific time.\nCentral banks and financial institutions often use these rates to guide their own exchange rates,\nimpacting global trade, loans, and investments.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.currency.reference_rates(provider='ecb')\n```\n\n", + "description": "Snapshots of currency exchange rates from an indirect or direct perspective of a base currency.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.currency.snapshots(provider='fmp')\n# Get exchange rates from USD and XAU to EUR, JPY, and GBP using 'fmp' as provider.\nobb.currency.snapshots(provider='fmp', base='USD,XAU', counter_currencies='EUR,JPY,GBP', quote_type='indirect')\n```\n\n", "parameters": { "standard": [ + { + "name": "base", + "type": "Union[str, List[str]]", + "description": "The base currency symbol. Multiple items allowed for provider(s): fmp, polygon.", + "default": "usd", + "optional": true + }, + { + "name": "quote_type", + "type": "Literal['direct', 'indirect']", + "description": "Whether the quote is direct or indirect. Selecting 'direct' will return the exchange rate as the amount of domestic currency required to buy one unit of the foreign currency. Selecting 'indirect' (default) will return the exchange rate as the amount of foreign currency required to buy one unit of the domestic currency.", + "default": "indirect", + "optional": true + }, + { + "name": "counter_currencies", + "type": "Union[List[str], str]", + "description": "An optional list of counter currency symbols to filter for. None returns all.", + "default": null, + "optional": true + }, { "name": "provider", - "type": "Literal['ecb']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'ecb' if there is no default.", - "default": "ecb", + "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 } ], - "ecb": [] + "fmp": [], + "polygon": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[CurrencyReferenceRates]", + "type": "List[CurrencySnapshots]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['ecb']]", + "type": "Optional[Literal['fmp', 'polygon']]", "description": "Provider name." }, { @@ -988,285 +817,309 @@ "data": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "base_currency", + "type": "str", + "description": "The base, or domestic, currency.", + "default": "", + "optional": false + }, + { + "name": "counter_currency", + "type": "str", + "description": "The counter, or foreign, currency.", "default": "", "optional": false }, { - "name": "EUR", + "name": "last_rate", "type": "float", - "description": "Euro.", - "default": null, - "optional": true + "description": "The exchange rate, relative to the base currency. Rates are expressed as the amount of foreign currency received from selling one unit of the base currency, or the quantity of foreign currency required to purchase one unit of the domestic currency. To inverse the perspective, set the 'quote_type' parameter as 'direct'.", + "default": "", + "optional": false }, { - "name": "USD", + "name": "open", "type": "float", - "description": "US Dollar.", + "description": "The open price.", "default": null, "optional": true }, { - "name": "JPY", + "name": "high", "type": "float", - "description": "Japanese Yen.", + "description": "The high price.", "default": null, "optional": true }, { - "name": "BGN", + "name": "low", "type": "float", - "description": "Bulgarian Lev.", + "description": "The low price.", "default": null, "optional": true }, { - "name": "CZK", + "name": "close", "type": "float", - "description": "Czech Koruna.", + "description": "The close price.", "default": null, "optional": true }, { - "name": "DKK", - "type": "float", - "description": "Danish Krone.", + "name": "volume", + "type": "int", + "description": "The trading volume.", "default": null, "optional": true }, { - "name": "GBP", + "name": "prev_close", "type": "float", - "description": "Pound Sterling.", + "description": "The previous close price.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "HUF", + "name": "change", "type": "float", - "description": "Hungarian Forint.", + "description": "The change in the price from the previous close.", "default": null, "optional": true }, { - "name": "PLN", + "name": "change_percent", "type": "float", - "description": "Polish Zloty.", + "description": "The change in the price from the previous close, as a normalized percent.", "default": null, "optional": true }, { - "name": "RON", + "name": "ma50", "type": "float", - "description": "Romanian Leu.", + "description": "The 50-day moving average.", "default": null, "optional": true }, { - "name": "SEK", + "name": "ma200", "type": "float", - "description": "Swedish Krona.", + "description": "The 200-day moving average.", "default": null, "optional": true }, { - "name": "CHF", + "name": "year_high", "type": "float", - "description": "Swiss Franc.", + "description": "The 52-week high.", "default": null, "optional": true }, { - "name": "ISK", + "name": "year_low", "type": "float", - "description": "Icelandic Krona.", + "description": "The 52-week low.", "default": null, "optional": true }, { - "name": "NOK", - "type": "float", - "description": "Norwegian Krone.", + "name": "last_rate_timestamp", + "type": "datetime", + "description": "The timestamp of the last rate.", "default": null, "optional": true - }, + } + ], + "polygon": [ { - "name": "TRY", + "name": "vwap", "type": "float", - "description": "Turkish Lira.", + "description": "The volume-weighted average price.", "default": null, "optional": true }, { - "name": "AUD", + "name": "change", "type": "float", - "description": "Australian Dollar.", + "description": "The change in price from the previous day.", "default": null, "optional": true }, { - "name": "BRL", + "name": "change_percent", "type": "float", - "description": "Brazilian Real.", + "description": "The percentage change in price from the previous day.", "default": null, "optional": true }, { - "name": "CAD", + "name": "prev_open", "type": "float", - "description": "Canadian Dollar.", + "description": "The previous day's opening price.", "default": null, "optional": true }, { - "name": "CNY", + "name": "prev_high", "type": "float", - "description": "Chinese Yuan.", + "description": "The previous day's high price.", "default": null, "optional": true }, { - "name": "HKD", + "name": "prev_low", "type": "float", - "description": "Hong Kong Dollar.", + "description": "The previous day's low price.", "default": null, "optional": true }, { - "name": "IDR", + "name": "prev_volume", "type": "float", - "description": "Indonesian Rupiah.", + "description": "The previous day's volume.", "default": null, "optional": true }, { - "name": "ILS", + "name": "prev_vwap", "type": "float", - "description": "Israeli Shekel.", + "description": "The previous day's VWAP.", "default": null, "optional": true }, { - "name": "INR", + "name": "bid", "type": "float", - "description": "Indian Rupee.", + "description": "The current bid price.", "default": null, "optional": true }, { - "name": "KRW", + "name": "ask", "type": "float", - "description": "South Korean Won.", + "description": "The current ask price.", "default": null, "optional": true }, { - "name": "MXN", + "name": "minute_open", "type": "float", - "description": "Mexican Peso.", + "description": "The open price from the most recent minute bar.", "default": null, "optional": true }, { - "name": "MYR", + "name": "minute_high", "type": "float", - "description": "Malaysian Ringgit.", + "description": "The high price from the most recent minute bar.", "default": null, "optional": true }, { - "name": "NZD", + "name": "minute_low", "type": "float", - "description": "New Zealand Dollar.", + "description": "The low price from the most recent minute bar.", "default": null, "optional": true }, { - "name": "PHP", + "name": "minute_close", "type": "float", - "description": "Philippine Peso.", + "description": "The close price from the most recent minute bar.", "default": null, "optional": true }, { - "name": "SGD", + "name": "minute_volume", "type": "float", - "description": "Singapore Dollar.", + "description": "The volume from the most recent minute bar.", "default": null, "optional": true }, { - "name": "THB", + "name": "minute_vwap", "type": "float", - "description": "Thai Baht.", + "description": "The VWAP from the most recent minute bar.", "default": null, "optional": true }, { - "name": "ZAR", + "name": "minute_transactions", "type": "float", - "description": "South African Rand.", + "description": "The number of transactions in the most recent minute bar.", + "default": null, + "optional": true + }, + { + "name": "quote_timestamp", + "type": "datetime", + "description": "The timestamp of the last quote.", + "default": null, + "optional": true + }, + { + "name": "minute_timestamp", + "type": "datetime", + "description": "The timestamp for the start of the most recent minute bar.", "default": null, "optional": true + }, + { + "name": "last_updated", + "type": "datetime", + "description": "The last time the data was updated.", + "default": "", + "optional": false } - ], - "ecb": [] + ] }, - "model": "CurrencyReferenceRates" + "model": "CurrencySnapshots" }, - "/currency/snapshots": { + "/derivatives/options/chains": { "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", + "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": "base", - "type": "Union[str, List[str]]", - "description": "The base currency symbol. Multiple items allowed for provider(s): fmp, polygon.", - "default": "usd", - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "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", + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", "optional": true - }, + } + ], + "intrinio": [ { - "name": "counter_currencies", - "type": "Union[str, List[str]]", - "description": "An optional list of counter currency symbols to filter for. None returns all.", + "name": "date", + "type": "Union[date, str]", + "description": "The end-of-day date for options chains data.", "default": null, "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp', 'polygon']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true } - ], - "fmp": [], - "polygon": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[CurrencySnapshots]", + "type": "List[OptionsChains]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'polygon']]", + "type": "Optional[Literal['intrinio']]", "description": "Provider name." }, { @@ -1289,51 +1142,51 @@ "data": { "standard": [ { - "name": "base_currency", + "name": "symbol", "type": "str", - "description": "The base, or domestic, currency.", - "default": "", - "optional": false + "description": "Symbol representing the entity requested in the data. Here, it is the underlying symbol for the option.", + "default": null, + "optional": true }, { - "name": "counter_currency", + "name": "contract_symbol", "type": "str", - "description": "The counter, or foreign, currency.", - "default": "", - "optional": false - }, - { - "name": "last_rate", - "type": "float", - "description": "The exchange rate, relative to the base currency. Rates are expressed as the amount of foreign currency received from selling one unit of the base currency, or the quantity of foreign currency required to purchase one unit of the domestic currency. To inverse the perspective, set the 'quote_type' parameter as 'direct'.", + "description": "Contract symbol for the option.", "default": "", "optional": false }, { - "name": "open", - "type": "float", - "description": "The open price.", + "name": "eod_date", + "type": "date", + "description": "Date for which the options chains are returned.", "default": null, "optional": true }, { - "name": "high", - "type": "float", - "description": "The high price.", - "default": null, - "optional": true + "name": "expiration", + "type": "date", + "description": "Expiration date of the contract.", + "default": "", + "optional": false }, { - "name": "low", + "name": "strike", "type": "float", - "description": "The low price.", - "default": null, - "optional": true + "description": "Strike price of the contract.", + "default": "", + "optional": false }, { - "name": "close", - "type": "float", - "description": "The close price.", + "name": "option_type", + "type": "str", + "description": "Call or Put.", + "default": "", + "optional": false + }, + { + "name": "open_interest", + "type": "int", + "description": "Open interest on the contract.", "default": null, "optional": true }, @@ -1345,279 +1198,356 @@ "optional": true }, { - "name": "prev_close", - "type": "float", - "description": "The previous close price.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "change", + "name": "theoretical_price", "type": "float", - "description": "The change in the price from the previous close.", + "description": "Theoretical value of the option.", "default": null, "optional": true }, { - "name": "change_percent", + "name": "last_trade_price", "type": "float", - "description": "The change in the price from the previous close, as a normalized percent.", + "description": "Last trade price of the option.", "default": null, "optional": true }, { - "name": "ma50", - "type": "float", - "description": "The 50-day moving average.", + "name": "tick", + "type": "str", + "description": "Whether the last tick was up or down in price.", "default": null, "optional": true }, { - "name": "ma200", + "name": "bid", "type": "float", - "description": "The 200-day moving average.", + "description": "Current bid price for the option.", "default": null, "optional": true }, { - "name": "year_high", - "type": "float", - "description": "The 52-week high.", + "name": "bid_size", + "type": "int", + "description": "Bid size for the option.", "default": null, "optional": true }, { - "name": "year_low", + "name": "ask", "type": "float", - "description": "The 52-week low.", + "description": "Current ask price for the option.", "default": null, "optional": true }, { - "name": "last_rate_timestamp", - "type": "datetime", - "description": "The timestamp of the last rate.", + "name": "ask_size", + "type": "int", + "description": "Ask size for the option.", "default": null, "optional": true - } - ], - "polygon": [ + }, { - "name": "vwap", + "name": "mark", "type": "float", - "description": "The volume-weighted average price.", + "description": "The mid-price between the latest bid and ask.", "default": null, "optional": true }, { - "name": "change", + "name": "open", "type": "float", - "description": "The change in price from the previous day.", + "description": "The open price.", "default": null, "optional": true }, { - "name": "change_percent", + "name": "open_bid", "type": "float", - "description": "The percentage change in price from the previous day.", + "description": "The opening bid price for the option that day.", "default": null, "optional": true }, { - "name": "prev_open", + "name": "open_ask", "type": "float", - "description": "The previous day's opening price.", + "description": "The opening ask price for the option that day.", "default": null, "optional": true }, { - "name": "prev_high", + "name": "high", "type": "float", - "description": "The previous day's high price.", + "description": "The high price.", "default": null, "optional": true }, { - "name": "prev_low", + "name": "bid_high", "type": "float", - "description": "The previous day's low price.", + "description": "The highest bid price for the option that day.", "default": null, "optional": true }, { - "name": "prev_volume", + "name": "ask_high", "type": "float", - "description": "The previous day's volume.", + "description": "The highest ask price for the option that day.", "default": null, "optional": true }, { - "name": "prev_vwap", + "name": "low", "type": "float", - "description": "The previous day's VWAP.", + "description": "The low price.", "default": null, "optional": true }, { - "name": "bid", + "name": "bid_low", "type": "float", - "description": "The current bid price.", + "description": "The lowest bid price for the option that day.", "default": null, "optional": true }, { - "name": "ask", + "name": "ask_low", "type": "float", - "description": "The current ask price.", + "description": "The lowest ask price for the option that day.", "default": null, "optional": true }, { - "name": "minute_open", + "name": "close", "type": "float", - "description": "The open price from the most recent minute bar.", + "description": "The close price.", "default": null, "optional": true }, { - "name": "minute_high", - "type": "float", - "description": "The high price from the most recent minute bar.", + "name": "close_size", + "type": "int", + "description": "The closing trade size for the option that day.", "default": null, "optional": true }, { - "name": "minute_low", - "type": "float", - "description": "The low price from the most recent minute bar.", + "name": "close_time", + "type": "datetime", + "description": "The time of the closing price for the option that day.", "default": null, "optional": true }, { - "name": "minute_close", + "name": "close_bid", "type": "float", - "description": "The close price from the most recent minute bar.", + "description": "The closing bid price for the option that day.", "default": null, "optional": true }, { - "name": "minute_volume", - "type": "float", - "description": "The volume from the most recent minute bar.", + "name": "close_bid_size", + "type": "int", + "description": "The closing bid size for the option that day.", "default": null, "optional": true }, { - "name": "minute_vwap", - "type": "float", - "description": "The VWAP from the most recent minute bar.", + "name": "close_bid_time", + "type": "datetime", + "description": "The time of the bid closing price for the option that day.", "default": null, "optional": true }, { - "name": "minute_transactions", + "name": "close_ask", "type": "float", - "description": "The number of transactions in the most recent minute bar.", + "description": "The closing ask price for the option that day.", "default": null, "optional": true }, { - "name": "quote_timestamp", - "type": "datetime", - "description": "The timestamp of the last quote.", + "name": "close_ask_size", + "type": "int", + "description": "The closing ask size for the option that day.", "default": null, "optional": true }, { - "name": "minute_timestamp", + "name": "close_ask_time", "type": "datetime", - "description": "The timestamp for the start of the most recent minute bar.", + "description": "The time of the ask closing price for the option that day.", "default": null, "optional": true }, { - "name": "last_updated", - "type": "datetime", - "description": "The last time the data was updated.", - "default": "", - "optional": false + "name": "prev_close", + "type": "float", + "description": "The previous close price.", + "default": null, + "optional": true + }, + { + "name": "change", + "type": "float", + "description": "The change in the price of the option.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Change, in normalizezd percentage points, of the option.", + "default": null, + "optional": true + }, + { + "name": "implied_volatility", + "type": "float", + "description": "Implied volatility of the option.", + "default": null, + "optional": true + }, + { + "name": "delta", + "type": "float", + "description": "Delta of the option.", + "default": null, + "optional": true + }, + { + "name": "gamma", + "type": "float", + "description": "Gamma of the option.", + "default": null, + "optional": true + }, + { + "name": "theta", + "type": "float", + "description": "Theta of the option.", + "default": null, + "optional": true + }, + { + "name": "vega", + "type": "float", + "description": "Vega of the option.", + "default": null, + "optional": true + }, + { + "name": "rho", + "type": "float", + "description": "Rho of the option.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "exercise_style", + "type": "str", + "description": "The exercise style of the option, American or European.", + "default": null, + "optional": true } ] }, - "model": "CurrencySnapshots" + "model": "OptionsChains" }, - "/derivatives/options/chains": { + "/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.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", + "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.", - "default": "", - "optional": false + "description": "Symbol to get data for. (the underlying symbol)", + "default": null, + "optional": true }, { "name": "provider", - "type": "Literal['cboe', 'intrinio', 'tmx', 'tradier']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.", - "default": "cboe", - "optional": true - } - ], - "cboe": [ - { - "name": "use_cache", - "type": "bool", - "description": "When True, the company directories will be cached for24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass.", - "default": true, + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", "optional": true } ], "intrinio": [ { - "name": "date", + "name": "start_date", "type": "Union[date, str]", - "description": "The end-of-day date for options chains data.", + "description": "Start date of the data, in YYYY-MM-DD format. If no symbol is supplied, requests are only allowed for a single date. Use the start_date for the target date. Intrinio appears to have data beginning Feb/2022, but is unclear when it actually began.", "default": null, "optional": true - } - ], - "tmx": [ + }, { - "name": "date", + "name": "end_date", "type": "Union[date, str]", - "description": "A specific date to get data for.", + "description": "End date of the data, in YYYY-MM-DD format. If a symbol is not supplied, do not include an end date.", "default": null, "optional": true }, { - "name": "use_cache", - "type": "bool", - "description": "Caching is used to validate the supplied ticker symbol, or if a historical EOD chain is requested. To bypass, set to False.", - "default": true, + "name": "trade_type", + "type": "Literal['block', 'sweep', 'large']", + "description": "The type of unusual activity to query for.", + "default": null, + "optional": true + }, + { + "name": "sentiment", + "type": "Literal['bullish', 'bearish', 'neutral']", + "description": "The sentiment type to query for.", + "default": null, + "optional": true + }, + { + "name": "min_value", + "type": "Union[int, float]", + "description": "The inclusive minimum total value for the unusual activity.", + "default": null, + "optional": true + }, + { + "name": "max_value", + "type": "Union[int, float]", + "description": "The inclusive maximum total value for the unusual activity.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return. A typical day for all symbols will yield 50-80K records. The API will paginate at 1000 records. The high default limit (100K) is to be able to reliably capture the most days. The high absolute limit (1.25M) is to allow for outlier days. Queries at the absolute limit will take a long time, and might be unreliable. Apply filters to improve performance.", + "default": 100000, + "optional": true + }, + { + "name": "source", + "type": "Literal['delayed', 'realtime']", + "description": "The source of the data. Either realtime or delayed.", + "default": "delayed", "optional": true } - ], - "tradier": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[OptionsChains]", + "type": "List[OptionsUnusual]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['cboe', 'intrinio', 'tmx', 'tradier']]", + "type": "Optional[Literal['intrinio']]", "description": "Provider name." }, { @@ -1640,9 +1570,9 @@ "data": { "standard": [ { - "name": "symbol", + "name": "underlying_symbol", "type": "str", - "description": "Symbol representing the entity requested in the data. Here, it is the underlying symbol for the option.", + "description": "Symbol representing the entity requested in the data. (the underlying symbol)", "default": null, "optional": true }, @@ -1652,546 +1582,539 @@ "description": "Contract symbol for the option.", "default": "", "optional": false - }, - { - "name": "eod_date", - "type": "date", - "description": "Date for which the options chains are returned.", - "default": null, - "optional": true - }, + } + ], + "intrinio": [ { - "name": "expiration", - "type": "date", - "description": "Expiration date of the contract.", + "name": "trade_timestamp", + "type": "datetime", + "description": "The datetime of order placement.", "default": "", "optional": false }, { - "name": "strike", - "type": "float", - "description": "Strike price of the contract.", + "name": "trade_type", + "type": "Literal['block', 'sweep', 'large']", + "description": "The type of unusual trade.", "default": "", "optional": false }, { - "name": "option_type", - "type": "str", - "description": "Call or Put.", + "name": "sentiment", + "type": "Literal['bullish', 'bearish', 'neutral']", + "description": "Bullish, Bearish, or Neutral Sentiment is estimated based on whether the trade was executed at the bid, ask, or mark price.", "default": "", "optional": false }, { - "name": "open_interest", - "type": "int", - "description": "Open interest on the contract.", - "default": null, - "optional": true - }, - { - "name": "volume", - "type": "int", - "description": "The trading volume.", - "default": null, - "optional": true - }, - { - "name": "theoretical_price", + "name": "bid_at_execution", "type": "float", - "description": "Theoretical value of the option.", - "default": null, - "optional": true + "description": "Bid price at execution.", + "default": "", + "optional": false }, { - "name": "last_trade_price", + "name": "ask_at_execution", "type": "float", - "description": "Last trade price of the option.", - "default": null, - "optional": true + "description": "Ask price at execution.", + "default": "", + "optional": false }, { - "name": "tick", - "type": "str", - "description": "Whether the last tick was up or down in price.", - "default": null, - "optional": true + "name": "average_price", + "type": "float", + "description": "The average premium paid per option contract.", + "default": "", + "optional": false }, { - "name": "bid", + "name": "underlying_price_at_execution", "type": "float", - "description": "Current bid price for the option.", + "description": "Price of the underlying security at execution of trade.", "default": null, "optional": true }, { - "name": "bid_size", + "name": "total_size", "type": "int", - "description": "Bid size for the option.", - "default": null, - "optional": true + "description": "The total number of contracts involved in a single transaction.", + "default": "", + "optional": false }, { - "name": "ask", - "type": "float", - "description": "Current ask price for the option.", - "default": null, - "optional": true - }, + "name": "total_value", + "type": "Union[int, float]", + "description": "The aggregated value of all option contract premiums included in the trade.", + "default": "", + "optional": false + } + ] + }, + "model": "OptionsUnusual" + }, + "/derivatives/futures/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Historical futures prices.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.derivatives.futures.historical(symbol='ES', provider='yfinance')\n# Enter multiple symbols.\nobb.derivatives.futures.historical(symbol='ES,NQ', provider='yfinance')\n# Enter expiration dates as \"YYYY-MM\".\nobb.derivatives.futures.historical(symbol='ES', provider='yfinance', expiration='2025-12')\n```\n\n", + "parameters": { + "standard": [ { - "name": "ask_size", - "type": "int", - "description": "Ask size for the option.", - "default": null, - "optional": true + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": "", + "optional": false }, { - "name": "mark", - "type": "float", - "description": "The mid-price between the latest bid and ask.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "open", - "type": "float", - "description": "The open price.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "open_bid", - "type": "float", - "description": "The opening bid price for the option that day.", + "name": "expiration", + "type": "str", + "description": "Future expiry date with format YYYY-MM", "default": null, "optional": true }, { - "name": "open_ask", - "type": "float", - "description": "The opening ask price for the option that day.", - "default": null, + "name": "provider", + "type": "Literal['yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default.", + "default": "yfinance", "optional": true - }, + } + ], + "yfinance": [ { - "name": "high", - "type": "float", - "description": "The high price.", - "default": null, + "name": "interval", + "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", + "description": "Time interval of the data to return.", + "default": "1d", "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[FuturesHistorical]", + "description": "Serializable results." }, { - "name": "bid_high", - "type": "float", - "description": "The highest bid price for the option that day.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['yfinance']]", + "description": "Provider name." }, { - "name": "ask_high", - "type": "float", - "description": "The highest ask price for the option that day.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "low", + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "datetime", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "open", "type": "float", - "description": "The low price.", - "default": null, - "optional": true + "description": "The open price.", + "default": "", + "optional": false }, { - "name": "bid_low", + "name": "high", "type": "float", - "description": "The lowest bid price for the option that day.", - "default": null, - "optional": true + "description": "The high price.", + "default": "", + "optional": false }, { - "name": "ask_low", + "name": "low", "type": "float", - "description": "The lowest ask price for the option that day.", - "default": null, - "optional": true + "description": "The low price.", + "default": "", + "optional": false }, { "name": "close", "type": "float", "description": "The close price.", - "default": null, - "optional": true + "default": "", + "optional": false }, { - "name": "close_size", - "type": "int", - "description": "The closing trade size for the option that day.", - "default": null, - "optional": true - }, + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false + } + ], + "yfinance": [] + }, + "model": "FuturesHistorical" + }, + "/derivatives/futures/curve": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Futures Term Structure, current or historical.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Enter a date to get the term structure from a historical date.\nobb.derivatives.futures.curve(symbol='NG', provider='yfinance', date='2023-01-01')\n```\n\n", + "parameters": { + "standard": [ { - "name": "close_time", - "type": "datetime", - "description": "The time of the closing price for the option that day.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "close_bid", - "type": "float", - "description": "The closing bid price for the option that day.", + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", "default": null, "optional": true }, { - "name": "close_bid_size", - "type": "int", - "description": "The closing bid size for the option that day.", - "default": null, + "name": "provider", + "type": "Literal['yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default.", + "default": "yfinance", "optional": true - }, + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ { - "name": "close_bid_time", - "type": "datetime", - "description": "The time of the bid closing price for the option that day.", - "default": null, - "optional": true + "name": "results", + "type": "List[FuturesCurve]", + "description": "Serializable results." }, { - "name": "close_ask", - "type": "float", - "description": "The closing ask price for the option that day.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['yfinance']]", + "description": "Provider name." }, { - "name": "close_ask_size", - "type": "int", - "description": "The closing ask size for the option that day.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "close_ask_time", - "type": "datetime", - "description": "The time of the ask closing price for the option that day.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "prev_close", - "type": "float", - "description": "The previous close price.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "expiration", + "type": "str", + "description": "Futures expiration month.", + "default": "", + "optional": false }, { - "name": "change", + "name": "price", "type": "float", - "description": "The change in the price of the option.", + "description": "The close price.", "default": null, "optional": true - }, - { - "name": "change_percent", - "type": "float", - "description": "Change, in normalizezd percentage points, of the option.", - "default": null, - "optional": true - }, - { - "name": "implied_volatility", - "type": "float", - "description": "Implied volatility of the option.", - "default": null, - "optional": true - }, + } + ], + "yfinance": [] + }, + "model": "FuturesCurve" + }, + "/economy/gdp/forecast": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Forecasted GDP Data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.gdp.forecast(provider='oecd')\nobb.economy.gdp.forecast(period='annual', type='real', provider='oecd')\n```\n\n", + "parameters": { + "standard": [ { - "name": "delta", - "type": "float", - "description": "Delta of the option.", - "default": null, + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return. Units for nominal GDP period. Either quarter or annual.", + "default": "annual", "optional": true }, { - "name": "gamma", - "type": "float", - "description": "Gamma of the option.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "theta", - "type": "float", - "description": "Theta of the option.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "vega", - "type": "float", - "description": "Vega of the option.", - "default": null, + "name": "type", + "type": "Literal['nominal', 'real']", + "description": "Type of GDP to get forecast of. Either nominal or real.", + "default": "real", "optional": true }, { - "name": "rho", - "type": "float", - "description": "Rho of the option.", - "default": null, - "optional": true - } - ], - "cboe": [ - { - "name": "last_trade_timestamp", - "type": "datetime", - "description": "Last trade timestamp of the option.", - "default": null, + "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 - }, - { - "name": "dte", - "type": "int", - "description": "Days to expiration for the option.", - "default": "", - "optional": false } ], - "intrinio": [ + "oecd": [ { - "name": "exercise_style", - "type": "str", - "description": "The exercise style of the option, American or European.", - "default": null, + "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 } - ], - "tmx": [ + ] + }, + "returns": { + "OBBject": [ { - "name": "transactions", - "type": "int", - "description": "Number of transactions for the contract.", - "default": null, - "optional": true + "name": "results", + "type": "List[GdpForecast]", + "description": "Serializable results." }, { - "name": "total_value", - "type": "float", - "description": "Total value of the transactions.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['oecd']]", + "description": "Provider name." }, { - "name": "settlement_price", - "type": "float", - "description": "Settlement price on that date.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "underlying_price", - "type": "float", - "description": "Price of the underlying stock on that date.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "dte", - "type": "int", - "description": "Days to expiration for the option.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } - ], - "tradier": [ - { - "name": "phi", - "type": "float", - "description": "Phi of the option. The sensitivity of the option relative to dividend yield.", - "default": null, - "optional": true - }, + ] + }, + "data": { + "standard": [ { - "name": "bid_iv", - "type": "float", - "description": "Implied volatility of the bid price.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": null, "optional": true }, { - "name": "ask_iv", + "name": "value", "type": "float", - "description": "Implied volatility of the ask price.", + "description": "Nominal GDP value on the date.", "default": null, "optional": true - }, + } + ], + "oecd": [] + }, + "model": "GdpForecast" + }, + "/economy/gdp/nominal": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Nominal GDP Data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.gdp.nominal(provider='oecd')\nobb.economy.gdp.nominal(units='usd', provider='oecd')\n```\n\n", + "parameters": { + "standard": [ { - "name": "orats_final_iv", - "type": "float", - "description": "ORATS final implied volatility of the option, updated once per hour.", - "default": null, + "name": "units", + "type": "Literal['usd', 'usd_cap']", + "description": "The unit of measurement for the data. Units to get nominal GDP in. Either usd or usd_cap indicating per capita.", + "default": "usd", "optional": true }, { - "name": "year_high", - "type": "float", - "description": "52-week high price of the option.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "year_low", - "type": "float", - "description": "52-week low price of the option.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "last_trade_volume", - "type": "int", - "description": "Volume of the last trade.", - "default": null, + "name": "provider", + "type": "Literal['oecd']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default.", + "default": "oecd", "optional": true - }, + } + ], + "oecd": [ { - "name": "dte", - "type": "int", - "description": "Days to expiration.", - "default": null, + "name": "country", + "type": "Literal['australia', 'austria', 'belgium', 'brazil', 'canada', 'chile', 'colombia', 'costa_rica', 'czech_republic', 'denmark', 'estonia', 'euro_area', 'european_union', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'norway', 'poland', 'portugal', 'russia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'all']", + "description": "Country to get GDP for.", + "default": "united_states", "optional": true - }, + } + ] + }, + "returns": { + "OBBject": [ { - "name": "contract_size", - "type": "int", - "description": "Size of the contract.", - "default": null, - "optional": true + "name": "results", + "type": "List[GdpNominal]", + "description": "Serializable results." }, { - "name": "bid_exchange", - "type": "str", - "description": "Exchange of the bid price.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['oecd']]", + "description": "Provider name." }, { - "name": "bid_timestamp", - "type": "datetime", - "description": "Timestamp of the bid price.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "ask_exchange", - "type": "str", - "description": "Exchange of the ask price.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "ask_timestamp", - "type": "datetime", - "description": "Timestamp of the ask price.", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "greeks_timestamp", - "type": "datetime", - "description": "Timestamp of the last greeks update. Greeks/IV data is updated once per hour.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": null, "optional": true }, { - "name": "last_trade_timestamp", - "type": "datetime", - "description": "Timestamp of the last trade.", + "name": "value", + "type": "float", + "description": "Nominal GDP value on the date.", "default": null, "optional": true } - ] + ], + "oecd": [] }, - "model": "OptionsChains" + "model": "GdpNominal" }, - "/derivatives/options/unusual": { + "/economy/gdp/real": { "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", + "description": "Get Real GDP Data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.gdp.real(provider='oecd')\nobb.economy.gdp.real(units='yoy', provider='oecd')\n```\n\n", "parameters": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for. (the underlying symbol)", - "default": null, - "optional": true - }, - { - "name": "provider", - "type": "Literal['intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", + "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 - } - ], - "intrinio": [ + }, { "name": "start_date", "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format. If no symbol is supplied, requests are only allowed for a single date. Use the start_date for the target date. Intrinio appears to have data beginning Feb/2022, but is unclear when it actually began.", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { "name": "end_date", "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format. If a symbol is not supplied, do not include an end date.", - "default": null, - "optional": true - }, - { - "name": "trade_type", - "type": "Literal['block', 'sweep', 'large']", - "description": "The type of unusual activity to query for.", - "default": null, - "optional": true - }, - { - "name": "sentiment", - "type": "Literal['bullish', 'bearish', 'neutral']", - "description": "The sentiment type to query for.", - "default": null, - "optional": true - }, - { - "name": "min_value", - "type": "Union[int, float]", - "description": "The inclusive minimum total value for the unusual activity.", - "default": null, - "optional": true - }, - { - "name": "max_value", - "type": "Union[int, float]", - "description": "The inclusive maximum total value for the unusual activity.", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. 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, + "name": "provider", + "type": "Literal['oecd']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default.", + "default": "oecd", "optional": true - }, + } + ], + "oecd": [ { - "name": "source", - "type": "Literal['delayed', 'realtime']", - "description": "The source of the data. Either realtime or delayed.", - "default": "delayed", + "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 } ] @@ -2200,12 +2123,12 @@ "OBBject": [ { "name": "results", - "type": "List[OptionsUnusual]", + "type": "List[GdpReal]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['intrinio']]", + "type": "Optional[Literal['oecd']]", "description": "Provider name." }, { @@ -2228,104 +2151,33 @@ "data": { "standard": [ { - "name": "underlying_symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data. (the underlying symbol)", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": null, "optional": true }, { - "name": "contract_symbol", - "type": "str", - "description": "Contract symbol for the option.", - "default": "", - "optional": false - } - ], - "intrinio": [ - { - "name": "trade_timestamp", - "type": "datetime", - "description": "The datetime of order placement.", - "default": "", - "optional": false - }, - { - "name": "trade_type", - "type": "Literal['block', 'sweep', 'large']", - "description": "The type of unusual trade.", - "default": "", - "optional": false - }, - { - "name": "sentiment", - "type": "Literal['bullish', 'bearish', 'neutral']", - "description": "Bullish, Bearish, or Neutral Sentiment is estimated based on whether the trade was executed at the bid, ask, or mark price.", - "default": "", - "optional": false - }, - { - "name": "bid_at_execution", - "type": "float", - "description": "Bid price at execution.", - "default": "", - "optional": false - }, - { - "name": "ask_at_execution", - "type": "float", - "description": "Ask price at execution.", - "default": "", - "optional": false - }, - { - "name": "average_price", - "type": "float", - "description": "The average premium paid per option contract.", - "default": "", - "optional": false - }, - { - "name": "underlying_price_at_execution", + "name": "value", "type": "float", - "description": "Price of the underlying security at execution of trade.", + "description": "Nominal GDP value on the date.", "default": null, "optional": true - }, - { - "name": "total_size", - "type": "int", - "description": "The total number of contracts involved in a single transaction.", - "default": "", - "optional": false - }, - { - "name": "total_value", - "type": "Union[int, float]", - "description": "The aggregated value of all option contract premiums included in the trade.", - "default": "", - "optional": false } - ] + ], + "oecd": [] }, - "model": "OptionsUnusual" + "model": "GdpReal" }, - "/derivatives/futures/historical": { + "/economy/calendar": { "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", + "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": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", - "default": "", - "optional": false - }, { "name": "start_date", "type": "Union[date, str]", @@ -2341,26 +2193,34 @@ "optional": true }, { - "name": "expiration", - "type": "str", - "description": "Future expiry date with format YYYY-MM", + "name": "provider", + "type": "Literal['fmp', 'tradingeconomics']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [], + "tradingeconomics": [ + { + "name": "country", + "type": "Union[str, List[str]]", + "description": "Country of the event. Multiple items allowed for provider(s): tradingeconomics.", "default": null, "optional": true }, { - "name": "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", + "name": "importance", + "type": "Literal['Low', 'Medium', 'High']", + "description": "Importance of the event.", + "default": null, "optional": true - } - ], - "yfinance": [ + }, { - "name": "interval", - "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", - "description": "Time interval of the data to return.", - "default": "1d", + "name": "group", + "type": "Literal['interest rate', 'inflation', 'bonds', 'consumer', 'gdp', 'government', 'housing', 'labour', 'markets', 'money', 'prices', 'trade', 'business']", + "description": "Grouping of events", + "default": null, "optional": true } ] @@ -2369,12 +2229,12 @@ "OBBject": [ { "name": "results", - "type": "List[FuturesHistorical]", + "type": "List[EconomicCalendar]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['yfinance']]", + "type": "Optional[Literal['fmp', 'tradingeconomics']]", "description": "Provider name." }, { @@ -2400,93 +2260,206 @@ "name": "date", "type": "datetime", "description": "The date of the data.", - "default": "", - "optional": false + "default": null, + "optional": true }, { - "name": "open", - "type": "float", - "description": "The open price.", - "default": "", - "optional": false + "name": "country", + "type": "str", + "description": "Country of event.", + "default": null, + "optional": true }, { - "name": "high", - "type": "float", - "description": "The high price.", - "default": "", - "optional": false + "name": "event", + "type": "str", + "description": "Event name.", + "default": null, + "optional": true }, { - "name": "low", - "type": "float", - "description": "The low price.", - "default": "", - "optional": false + "name": "reference", + "type": "str", + "description": "Abbreviated period for which released data refers to.", + "default": null, + "optional": true }, { - "name": "close", - "type": "float", - "description": "The close price.", - "default": "", - "optional": false + "name": "source", + "type": "str", + "description": "Source of the data.", + "default": null, + "optional": true }, { - "name": "volume", - "type": "float", - "description": "The trading volume.", - "default": "", - "optional": false - } - ], - "yfinance": [] - }, - "model": "FuturesHistorical" - }, - "/derivatives/futures/curve": { - "deprecated": { - "flag": null, + "name": "sourceurl", + "type": "str", + "description": "Source URL.", + "default": null, + "optional": true + }, + { + "name": "actual", + "type": "Union[str, float]", + "description": "Latest released value.", + "default": null, + "optional": true + }, + { + "name": "previous", + "type": "Union[str, float]", + "description": "Value for the previous period after the revision (if revision is applicable).", + "default": null, + "optional": true + }, + { + "name": "consensus", + "type": "Union[str, float]", + "description": "Average forecast among a representative group of economists.", + "default": null, + "optional": true + }, + { + "name": "forecast", + "type": "Union[str, float]", + "description": "Trading Economics projections", + "default": null, + "optional": true + }, + { + "name": "url", + "type": "str", + "description": "Trading Economics URL", + "default": null, + "optional": true + }, + { + "name": "importance", + "type": "Union[Literal[0, 1, 2, 3], str]", + "description": "Importance of the event. 1-Low, 2-Medium, 3-High", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency of the data.", + "default": null, + "optional": true + }, + { + "name": "unit", + "type": "str", + "description": "Unit of the data.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "change", + "type": "float", + "description": "Value change since previous.", + "default": null, + "optional": true + }, + { + "name": "change_percent", + "type": "float", + "description": "Percentage change since previous.", + "default": null, + "optional": true + }, + { + "name": "updated_at", + "type": "datetime", + "description": "Last updated timestamp.", + "default": null, + "optional": true + }, + { + "name": "created_at", + "type": "datetime", + "description": "Created at timestamp.", + "default": null, + "optional": true + } + ], + "tradingeconomics": [] + }, + "model": "EconomicCalendar" + }, + "/economy/cpi": { + "deprecated": { + "flag": null, "message": null }, - "description": "Futures Term Structure, current or historical.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.derivatives.futures.curve(symbol='VX', provider='cboe')\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", + "description": "Get Consumer Price Index (CPI).\n\nReturns either the rescaled index value, or a rate of change (inflation).", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.cpi(country='japan,china,turkey', provider='fred')\n# Use the `units` parameter to define the reference period for the change in values.\nobb.economy.cpi(country='united_states,united_kingdom', units='growth_previous', provider='fred')\n```\n\n", "parameters": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "name": "country", + "type": "Union[str, List[str]]", + "description": "The country to get data. Multiple items allowed for provider(s): fred.", "default": "", "optional": false }, { - "name": "date", + "name": "units", + "type": "Literal['growth_previous', 'growth_same', 'index_2015']", + "description": "The unit of measurement for the data. Options: - `growth_previous`: Percent growth from the previous period. If monthly data, this is month-over-month, etc - `growth_same`: Percent growth from the same period in the previous year. If looking at monthly data, this would be year-over-year, etc. - `index_2015`: Rescaled index value, such that the value in 2015 is 100.", + "default": "growth_same", + "optional": true + }, + { + "name": "frequency", + "type": "Literal['monthly', 'quarter', 'annual']", + "description": "The frequency of the data. Options: `monthly`, `quarter`, and `annual`.", + "default": "monthly", + "optional": true + }, + { + "name": "harmonized", + "type": "bool", + "description": "Whether you wish to obtain harmonized data.", + "default": false, + "optional": true + }, + { + "name": "start_date", "type": "Union[date, str]", - "description": "A specific date to get data for.", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { "name": "provider", - "type": "Literal['cboe', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.", - "default": "cboe", + "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 } ], - "cboe": [], - "yfinance": [] + "fred": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[FuturesCurve]", + "type": "List[ConsumerPriceIndex]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['cboe', 'yfinance']]", + "type": "Optional[Literal['fred']]", "description": "Provider name." }, { @@ -2509,231 +2482,187 @@ "data": { "standard": [ { - "name": "expiration", - "type": "str", - "description": "Futures expiration month.", - "default": "", - "optional": false - }, - { - "name": "price", - "type": "float", - "description": "The close price.", - "default": null, - "optional": true - } - ], - "cboe": [ - { - "name": "symbol", - "type": "str", - "description": "The trading symbol for the tenor of future.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false } ], - "yfinance": [] + "fred": [] }, - "model": "FuturesCurve" + "model": "ConsumerPriceIndex" }, - "/econometrics/correlation_matrix": { + "/economy/risk_premium": { "deprecated": { "flag": null, "message": null }, - "description": "Get the correlation matrix of an input dataset.\n\n The correlation matrix provides a view of how different variables in your dataset relate to one another.\n By quantifying the degree to which variables move in relation to each other, this matrix can help identify patterns,\n trends, and potential areas for deeper analysis. The correlation score ranges from -1 to 1, with -1 indicating a\n perfect negative correlation, 0 indicating no correlation, and 1 indicating a perfect positive correlation.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the correlation matrix of a dataset.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.econometrics.correlation_matrix(data=stock_data)\nobb.econometrics.correlation_matrix(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "description": "Get Market Risk Premium by country.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.risk_premium(provider='fmp')\n```\n\n", "parameters": { "standard": [ { - "name": "data", - "type": "List[Data]", - "description": "Input dataset.", - "default": "", - "optional": false + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true } - ] + ], + "fmp": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[Data]", - "description": "Correlation matrix." + "type": "List[RiskPremium]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } ] }, - "data": {}, - "model": "" - }, - "/econometrics/ols_regression": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Perform Ordinary Least Squares (OLS) regression.\n\n OLS regression is a fundamental statistical method to explore and model the relationship between a\n dependent variable and one or more independent variables. By fitting the best possible linear equation to the data,\n it helps uncover how changes in the independent variables are associated with changes in the dependent variable.\n This returns the model and results objects from statsmodels library.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Perform Ordinary Least Squares (OLS) regression.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.econometrics.ols_regression(data=stock_data, y_column=\"close\", x_columns=[\"open\", \"high\", \"low\"])\nobb.econometrics.ols_regression(y_column='close', x_columns=['open', 'high', 'low'], data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", - "parameters": { + "data": { "standard": [ { - "name": "data", - "type": "List[Data]", - "description": "Input dataset.", + "name": "country", + "type": "str", + "description": "Market country.", "default": "", "optional": false }, { - "name": "y_column", + "name": "continent", "type": "str", - "description": "Target column.", - "default": "", - "optional": false + "description": "Continent of the country.", + "default": null, + "optional": true }, { - "name": "x_columns", - "type": "List[str]", - "description": "List of columns to use as exogenous variables.", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ + "name": "total_equity_risk_premium", + "type": "Annotated[float, Gt(gt=0)]", + "description": "Total equity risk premium for the country.", + "default": null, + "optional": true + }, { - "name": "results", - "type": "Dict", - "description": "OBBject with the results being model and results objects." + "name": "country_risk_premium", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Country-specific risk premium.", + "default": null, + "optional": true } - ] + ], + "fmp": [] }, - "data": {}, - "model": "" + "model": "RiskPremium" }, - "/econometrics/ols_regression_summary": { + "/economy/fred_search": { "deprecated": { "flag": null, "message": null }, - "description": "Perform Ordinary Least Squares (OLS) regression.\n\n This returns the summary object from statsmodels.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Perform Ordinary Least Squares (OLS) regression and return the summary.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.econometrics.ols_regression_summary(data=stock_data, y_column=\"close\", x_columns=[\"open\", \"high\", \"low\"])\nobb.econometrics.ols_regression_summary(y_column='close', x_columns=['open', 'high', 'low'], data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "description": "Search for FRED series or economic releases by ID or string.\n\nThis does not return the observation values, only the metadata.\nUse this function to find series IDs for `fred_series()`.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.fred_search(provider='fred')\n```\n\n", "parameters": { "standard": [ { - "name": "data", - "type": "List[Data]", - "description": "Input dataset.", - "default": "", - "optional": false - }, - { - "name": "y_column", + "name": "query", "type": "str", - "description": "Target column.", - "default": "", - "optional": false + "description": "The search word(s).", + "default": null, + "optional": true }, { - "name": "x_columns", - "type": "List[str]", - "description": "List of columns to use as exogenous variables.", - "default": "", - "optional": false + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", + "optional": true } - ] - }, - "returns": { - "OBBject": [ + ], + "fred": [ { - "name": "results", - "type": "Data", - "description": "OBBject with the results being summary object." - } - ] - }, - "data": {}, - "model": "" - }, - "/econometrics/autocorrelation": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Perform Durbin-Watson test for autocorrelation.\n\n The Durbin-Watson test is a widely used method for detecting the presence of autocorrelation in the residuals\n from a statistical or econometric model. Autocorrelation occurs when past values in the data series influence\n future values, which can be a critical issue in time-series analysis, affecting the reliability of\n model predictions. The test provides a statistic that ranges from 0 to 4, where a value around 2 suggests\n no autocorrelation, values towards 0 indicate positive autocorrelation, and values towards 4 suggest\n negative autocorrelation. Understanding the degree of autocorrelation helps in refining models to better capture\n the underlying dynamics of the data, ensuring more accurate and trustworthy results.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Perform Durbin-Watson test for autocorrelation.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.econometrics.autocorrelation(data=stock_data, y_column=\"close\", x_columns=[\"open\", \"high\", \"low\"])\nobb.econometrics.autocorrelation(y_column='close', x_columns=['open', 'high', 'low'], data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", - "parameters": { - "standard": [ + "name": "is_release", + "type": "bool", + "description": "Is release? If True, other search filter variables are ignored. If no query text or release_id is supplied, this defaults to True.", + "default": false, + "optional": true + }, { - "name": "data", - "type": "List[Data]", - "description": "Input dataset.", - "default": "", - "optional": false + "name": "release_id", + "type": "Union[int, str]", + "description": "A specific release ID to target.", + "default": null, + "optional": true }, { - "name": "y_column", - "type": "str", - "description": "Target column.", - "default": "", - "optional": false + "name": "limit", + "type": "int", + "description": "The number of data entries to return. (1-1000)", + "default": null, + "optional": true }, { - "name": "x_columns", - "type": "List[str]", - "description": "List of columns to use as exogenous variables.", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ + "name": "offset", + "type": "Annotated[int, Ge(ge=0)]", + "description": "Offset the results in conjunction with limit.", + "default": 0, + "optional": true + }, { - "name": "results", - "type": "Dict", - "description": "OBBject with the results being the score from the test." - } - ] - }, - "data": {}, - "model": "" - }, - "/econometrics/residual_autocorrelation": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Perform Breusch-Godfrey Lagrange Multiplier tests for residual autocorrelation.\n\n The Breusch-Godfrey Lagrange Multiplier test is a sophisticated tool for uncovering autocorrelation within the\n residuals of a regression model. Autocorrelation in residuals can indicate that a model fails to capture some\n aspect of the underlying data structure, possibly leading to biased or inefficient estimates.\n By specifying the number of lags, you can control the depth of the test to check for autocorrelation,\n allowing for a tailored analysis that matches the specific characteristics of your data.\n This test is particularly valuable in econometrics and time-series analysis, where understanding the independence\n of errors is crucial for model validity.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Perform Breusch-Godfrey Lagrange Multiplier tests for residual autocorrelation.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.econometrics.residual_autocorrelation(data=stock_data, y_column=\"close\", x_columns=[\"open\", \"high\", \"low\"])\nobb.econometrics.residual_autocorrelation(y_column='close', x_columns=['open', 'high', 'low'], data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", - "parameters": { - "standard": [ + "name": "filter_variable", + "type": "Literal['frequency', 'units', 'seasonal_adjustment']", + "description": "Filter by an attribute.", + "default": null, + "optional": true + }, { - "name": "data", - "type": "List[Data]", - "description": "Input dataset.", - "default": "", - "optional": false + "name": "filter_value", + "type": "str", + "description": "String value to filter the variable by. Used in conjunction with filter_variable.", + "default": null, + "optional": true }, { - "name": "y_column", + "name": "tag_names", "type": "str", - "description": "Target column.", - "default": "", - "optional": false + "description": "A semicolon delimited list of tag names that series match all of. Example: 'japan;imports'", + "default": null, + "optional": true }, { - "name": "x_columns", - "type": "List[str]", - "description": "List of columns to use as exogenous variables.", - "default": "", - "optional": 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": null, + "optional": true }, { - "name": "lags", - "type": "PositiveInt", - "description": "Number of lags to use in the test.", - "default": "", - "optional": 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": null, + "optional": true } ] }, @@ -2741,432 +2670,194 @@ "OBBject": [ { "name": "results", - "type": "Data", - "description": "OBBject with the results being the score from the test." - } - ] - }, - "data": {}, - "model": "" - }, - "/econometrics/cointegration": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Show co-integration between two timeseries using the two step Engle-Granger test.\n\n The two-step Engle-Granger test is a method designed to detect co-integration between two time series.\n Co-integration is a statistical property indicating that two or more time series move together over the long term,\n even if they are individually non-stationary. This concept is crucial in economics and finance, where identifying\n pairs or groups of assets that share a common stochastic trend can inform long-term investment strategies\n and risk management practices. The Engle-Granger test first checks for a stable, long-term relationship by\n regressing one time series on the other and then tests the residuals for stationarity.\n If the residuals are found to be stationary, it suggests that despite any short-term deviations,\n the series are bound by an equilibrium relationship over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Perform co-integration test between two timeseries.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.econometrics.cointegration(data=stock_data, columns=[\"open\", \"close\"])\n```\n\n", - "parameters": { - "standard": [ + "type": "List[FredSearch]", + "description": "Serializable results." + }, { - "name": "data", - "type": "List[Data]", - "description": "Input dataset.", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "columns", - "type": "List[str]", - "description": "Data columns to check cointegration", - "default": "", - "optional": false + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "maxlag", - "type": "PositiveInt", - "description": "Number of lags to use in the test.", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, { - "name": "results", - "type": "Data", - "description": "OBBject with the results being the score from the test." + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } ] }, - "data": {}, - "model": "" - }, - "/econometrics/causality": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Perform Granger causality test to determine if X 'causes' y.\n\n The Granger causality test is a statistical hypothesis test to determine if one time series is useful in\n forecasting another. While 'causality' in this context does not imply a cause-and-effect relationship in\n the philosophical sense, it does test whether changes in one variable are systematically followed by changes\n in another variable, suggesting a predictive relationship. By specifying a lag, you set the number of periods to\n look back in the time series to assess this relationship. This test is particularly useful in economic and\n financial data analysis, where understanding the lead-lag relationship between indicators can inform investment\n decisions and policy making.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Perform Granger causality test to determine if X 'causes' y.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.econometrics.causality(data=stock_data, y_column=\"close\", x_column=\"open\")\n# Example with mock data.\nobb.econometrics.causality(y_column='close', x_column='open', lag=1, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", - "parameters": { + "data": { "standard": [ { - "name": "data", - "type": "List[Data]", - "description": "Input dataset.", - "default": "", - "optional": false + "name": "release_id", + "type": "Union[int, str]", + "description": "The release ID for queries.", + "default": null, + "optional": true }, { - "name": "y_column", + "name": "series_id", "type": "str", - "description": "Target column.", - "default": "", - "optional": false + "description": "The series ID for the item in the release.", + "default": null, + "optional": true }, { - "name": "x_column", + "name": "name", "type": "str", - "description": "Columns to use as exogenous variables.", - "default": "", - "optional": false + "description": "The name of the release.", + "default": null, + "optional": true }, { - "name": "lag", - "type": "PositiveInt", - "description": "Number of lags to use in the test.", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ + "name": "title", + "type": "str", + "description": "The title of the series.", + "default": null, + "optional": true + }, { - "name": "results", - "type": "Data", - "description": "OBBject with the results being the score from the test." - } - ] - }, - "data": {}, - "model": "" - }, - "/econometrics/unit_root": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Perform Augmented Dickey-Fuller (ADF) unit root test.\n\n The ADF test is a popular method for testing the presence of a unit root in a time series.\n A unit root indicates that the series may be non-stationary, meaning its statistical properties such as mean,\n variance, and autocorrelation can change over time. The presence of a unit root suggests that the time series might\n be influenced by a random walk process, making it unpredictable and challenging for modeling and forecasting.\n The 'regression' parameter allows you to specify the model used in the test: 'c' for a constant term,\n 'ct' for a constant and trend term, and 'ctt' for a constant, linear, and quadratic trend.\n This flexibility helps tailor the test to the specific characteristics of your data, providing a more accurate\n assessment of its stationarity.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Perform Augmented Dickey-Fuller (ADF) unit root test.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.econometrics.unit_root(data=stock_data, column=\"close\")\nobb.econometrics.unit_root(data=stock_data, column=\"close\", regression=\"ct\")\nobb.econometrics.unit_root(column='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", - "parameters": { - "standard": [ + "name": "observation_start", + "type": "date", + "description": "The date of the first observation in the series.", + "default": null, + "optional": true + }, { - "name": "data", - "type": "List[Data]", - "description": "Input dataset.", - "default": "", - "optional": false + "name": "observation_end", + "type": "date", + "description": "The date of the last observation in the series.", + "default": null, + "optional": true }, { - "name": "column", + "name": "frequency", "type": "str", - "description": "Data columns to check unit root", - "default": "", - "optional": false + "description": "The frequency of the data.", + "default": null, + "optional": true }, { - "name": "regression", - "type": "Literal[\"c\", \"ct\", \"ctt\"]", - "description": "Regression type to use in the test. Either \"c\" for constant only, \"ct\" for constant and trend, or \"ctt\" for", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "Data", - "description": "OBBject with the results being the score from the test." - } - ] - }, - "data": {}, - "model": "" - }, - "/econometrics/panel_random_effects": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Perform One-way Random Effects model for panel data.\n\n One-way Random Effects model to panel data is offering a nuanced approach to analyzing data that spans across both\n time and entities (such as individuals, companies, countries, etc.). By acknowledging and modeling the random\n variation that exists within these entities, this method provides insights into the general patterns that\n emerge across the dataset.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.panel_random_effects(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}])\n```\n\n", - "parameters": { - "standard": [ + "name": "frequency_short", + "type": "str", + "description": "Short form of the data frequency.", + "default": null, + "optional": true + }, { - "name": "data", - "type": "List[Data]", - "description": "Input dataset.", - "default": "", - "optional": false + "name": "units", + "type": "str", + "description": "The units of the data.", + "default": null, + "optional": true }, { - "name": "y_column", + "name": "units_short", "type": "str", - "description": "Target column.", - "default": "", - "optional": false + "description": "Short form of the data units.", + "default": null, + "optional": true }, { - "name": "x_columns", - "type": "List[str]", - "description": "List of columns to use as exogenous variables.", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "Dict", - "description": "OBBject with the fit model returned" - } - ] - }, - "data": {}, - "model": "" - }, - "/econometrics/panel_between": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Perform a Between estimator regression on panel data.\n\n The Between estimator for regression analysis on panel data is focusing on the differences between entities\n (such as individuals, companies, or countries) over time. By aggregating the data for each entity and analyzing the\n average outcomes, this method provides insights into the overall impact of explanatory variables (x_columns) on\n the dependent variable (y_column) across all entities.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.panel_between(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}])\n```\n\n", - "parameters": { - "standard": [ - { - "name": "data", - "type": "List[Data]", - "description": "Input dataset.", - "default": "", - "optional": false + "name": "seasonal_adjustment", + "type": "str", + "description": "The seasonal adjustment of the data.", + "default": null, + "optional": true }, { - "name": "y_column", + "name": "seasonal_adjustment_short", "type": "str", - "description": "Target column.", - "default": "", - "optional": false + "description": "Short form of the data seasonal adjustment.", + "default": null, + "optional": true }, { - "name": "x_columns", - "type": "List[str]", - "description": "List of columns to use as exogenous variables.", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "Dict", - "description": "OBBject with the fit model returned" - } - ] - }, - "data": {}, - "model": "" - }, - "/econometrics/panel_pooled": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Perform a Pooled coefficient estimator regression on panel data.\n\n The Pooled coefficient estimator for regression analysis on panel data is treating the data as a large\n cross-section without distinguishing between variations across time or entities\n (such as individuals, companies, or countries). By assuming that the explanatory variables (x_columns) have a\n uniform effect on the dependent variable (y_column) across all entities and time periods, this method simplifies\n the analysis and provides a generalized view of the relationships within the data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.panel_pooled(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}])\n```\n\n", - "parameters": { - "standard": [ - { - "name": "data", - "type": "List[Data]", - "description": "Input dataset.", - "default": "", - "optional": false + "name": "last_updated", + "type": "datetime", + "description": "The datetime of the last update to the data.", + "default": null, + "optional": true }, { - "name": "y_column", + "name": "notes", "type": "str", - "description": "Target column.", - "default": "", - "optional": false + "description": "Description of the release.", + "default": null, + "optional": true }, { - "name": "x_columns", - "type": "List[str]", - "description": "List of columns to use as exogenous variables.", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "Dict", - "description": "OBBject with the fit model returned" - } - ] - }, - "data": {}, - "model": "" - }, - "/econometrics/panel_fixed": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "One- and two-way fixed effects estimator for panel data.\n\n The Fixed Effects estimator to panel data is enabling a focused analysis on the unique characteristics of entities\n (such as individuals, companies, or countries) and/or time periods. By controlling for entity-specific and/or\n time-specific influences, this method isolates the effect of explanatory variables (x_columns) on the dependent\n variable (y_column), under the assumption that these entity or time effects capture unobserved heterogeneity.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.panel_fixed(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}])\n```\n\n", - "parameters": { - "standard": [ - { - "name": "data", - "type": "List[Data]", - "description": "Input dataset.", - "default": "", - "optional": false + "name": "press_release", + "type": "bool", + "description": "If the release is a press release.", + "default": null, + "optional": true }, { - "name": "y_column", + "name": "url", "type": "str", - "description": "Target column.", - "default": "", - "optional": false - }, - { - "name": "x_columns", - "type": "List[str]", - "description": "List of columns to use as exogenous variables.", - "default": "", - "optional": false + "description": "URL to the release.", + "default": null, + "optional": true } - ] - }, - "returns": { - "OBBject": [ + ], + "fred": [ { - "name": "results", - "type": "Dict", - "description": "OBBject with the fit model returned" - } - ] - }, - "data": {}, - "model": "" - }, - "/econometrics/panel_first_difference": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Perform a first-difference estimate for panel data.\n\n The First-Difference estimator for panel data analysis is focusing on the changes between consecutive observations\n for each entity (such as individuals, companies, or countries). By differencing the data, this method effectively\n removes entity-specific effects that are constant over time, allowing for the examination of the impact of changes\n in explanatory variables (x_columns) on the change in the dependent variable (y_column).", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.panel_first_difference(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}])\n```\n\n", - "parameters": { - "standard": [ + "name": "popularity", + "type": "int", + "description": "Popularity of the series", + "default": null, + "optional": true + }, { - "name": "data", - "type": "List[Data]", - "description": "Input dataset.", - "default": "", - "optional": false + "name": "group_popularity", + "type": "int", + "description": "Group popularity of the release", + "default": null, + "optional": true }, { - "name": "y_column", + "name": "region_type", "type": "str", - "description": "Target column.", - "default": "", - "optional": false + "description": "The region type of the series.", + "default": null, + "optional": true }, { - "name": "x_columns", - "type": "List[str]", - "description": "List of columns to use as exogenous variables.", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "Dict", - "description": "OBBject with the fit model returned" + "name": "series_group", + "type": "Union[int, str]", + "description": "The series group ID of the series. This value is used to query for regional data.", + "default": null, + "optional": true } ] }, - "data": {}, - "model": "" + "model": "FredSearch" }, - "/econometrics/panel_fmac": { + "/economy/fred_series": { "deprecated": { "flag": null, "message": null }, - "description": "Fama-MacBeth estimator for panel data.\n\n The Fama-MacBeth estimator, a two-step procedure renowned for its application in finance to estimate the risk\n premiums and evaluate the capital asset pricing model. By first estimating cross-sectional regressions for each\n time period and then averaging the regression coefficients over time, this method provides insights into the\n relationship between the dependent variable (y_column) and explanatory variables (x_columns) across different\n entities (such as individuals, companies, or countries).", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.panel_fmac(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}])\n```\n\n", + "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": "data", - "type": "List[Data]", - "description": "Input dataset.", - "default": "", - "optional": false - }, - { - "name": "y_column", - "type": "str", - "description": "Target column.", - "default": "", - "optional": false - }, - { - "name": "x_columns", - "type": "List[str]", - "description": "List of columns to use as exogenous variables.", + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fred.", "default": "", "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "Dict", - "description": "OBBject with the fit model returned" - } - ] - }, - "data": {}, - "model": "" - }, - "/economy/gdp/forecast": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get Forecasted GDP Data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.gdp.forecast(provider='oecd')\nobb.economy.gdp.forecast(period='annual', type='real', provider='oecd')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "period", - "type": "Literal['quarter', 'annual']", - "description": "Time period of the data to return. Units for nominal GDP period. Either quarter or annual.", - "default": "annual", - "optional": true }, { "name": "start_date", @@ -3183,54 +2874,91 @@ "optional": true }, { - "name": "type", - "type": "Literal['nominal', 'real']", - "description": "Type of GDP to get forecast of. Either nominal or real.", - "default": "real", + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100000, "optional": true }, { "name": "provider", - "type": "Literal['oecd']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default.", - "default": "oecd", + "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 } ], - "oecd": [ + "fred": [ { - "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", + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100000, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[GdpForecast]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['oecd']]", - "description": "Provider name." }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "frequency", + "type": "Literal['a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", + "description": "Frequency aggregation to convert high frequency data to lower frequency. None = No change a = Annual q = Quarterly m = Monthly w = Weekly d = Daily wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "aggregation_method", + "type": "Literal['avg', 'sum', 'eop']", + "description": "A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. avg = Average sum = Sum eop = End of Period", + "default": "eop", + "optional": true }, { - "name": "extra", + "name": "transform", + "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", + "description": "Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "all_pages", + "type": "bool", + "description": "Returns all pages of data from the API call at once.", + "default": false, + "optional": true + }, + { + "name": "sleep", + "type": "float", + "description": "Time to sleep between requests to avoid rate limiting.", + "default": 1.0, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[FredSeries]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred', 'intrinio']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", "type": "Dict[str, Any]", "description": "Extra info." } @@ -3242,37 +2970,32 @@ "name": "date", "type": "date", "description": "The date of the data.", - "default": null, - "optional": true - }, + "default": "", + "optional": false + } + ], + "fred": [], + "intrinio": [ { "name": "value", "type": "float", - "description": "Nominal GDP value on the date.", + "description": "Value of the index.", "default": null, "optional": true } - ], - "oecd": [] + ] }, - "model": "GdpForecast" + "model": "FredSeries" }, - "/economy/gdp/nominal": { + "/economy/money_measures": { "deprecated": { "flag": null, "message": null }, - "description": "Get Nominal GDP Data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.gdp.nominal(provider='oecd')\nobb.economy.gdp.nominal(units='usd', provider='oecd')\n```\n\n", + "description": "Get Money Measures (M1/M2 and components).\n\nThe Federal Reserve publishes as part of the H.6 Release.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.money_measures(provider='federal_reserve')\nobb.economy.money_measures(adjusted=False, provider='federal_reserve')\n```\n\n", "parameters": { "standard": [ - { - "name": "units", - "type": "Literal['usd', 'usd_cap']", - "description": "The unit of measurement for the data. Units to get nominal GDP in. Either usd or usd_cap indicating per capita.", - "default": "usd", - "optional": true - }, { "name": "start_date", "type": "Union[date, str]", @@ -3288,33 +3011,32 @@ "optional": true }, { - "name": "provider", - "type": "Literal['oecd']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default.", - "default": "oecd", + "name": "adjusted", + "type": "bool", + "description": "Whether to return seasonally adjusted data.", + "default": true, "optional": true - } - ], - "oecd": [ + }, { - "name": "country", - "type": "Literal['australia', 'austria', 'belgium', 'brazil', 'canada', 'chile', 'colombia', 'costa_rica', 'czech_republic', 'denmark', 'estonia', 'euro_area', 'european_union', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'norway', 'poland', 'portugal', 'russia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'all']", - "description": "Country to get GDP for.", - "default": "united_states", + "name": "provider", + "type": "Literal['federal_reserve']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default.", + "default": "federal_reserve", "optional": true } - ] + ], + "federal_reserve": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[GdpNominal]", + "type": "List[MoneyMeasures]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['oecd']]", + "type": "Optional[Literal['federal_reserve']]", "description": "Provider name." }, { @@ -3337,40 +3059,75 @@ "data": { "standard": [ { - "name": "date", + "name": "month", "type": "date", "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "M1", + "type": "float", + "description": "Value of the M1 money supply in billions.", + "default": "", + "optional": false + }, + { + "name": "M2", + "type": "float", + "description": "Value of the M2 money supply in billions.", + "default": "", + "optional": false + }, + { + "name": "currency", + "type": "float", + "description": "Value of currency in circulation in billions.", "default": null, "optional": true }, { - "name": "value", + "name": "demand_deposits", "type": "float", - "description": "Nominal GDP value on the date.", + "description": "Value of demand deposits in billions.", + "default": null, + "optional": true + }, + { + "name": "retail_money_market_funds", + "type": "float", + "description": "Value of retail money market funds in billions.", + "default": null, + "optional": true + }, + { + "name": "other_liquid_deposits", + "type": "float", + "description": "Value of other liquid deposits in billions.", + "default": null, + "optional": true + }, + { + "name": "small_denomination_time_deposits", + "type": "float", + "description": "Value of small denomination time deposits in billions.", "default": null, "optional": true } ], - "oecd": [] + "federal_reserve": [] }, - "model": "GdpNominal" + "model": "MoneyMeasures" }, - "/economy/gdp/real": { + "/economy/unemployment": { "deprecated": { "flag": null, "message": null }, - "description": "Get Real GDP Data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.gdp.real(provider='oecd')\nobb.economy.gdp.real(units='yoy', provider='oecd')\n```\n\n", + "description": "Get global unemployment data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.unemployment(provider='oecd')\nobb.economy.unemployment(country=all, frequency=quarterly, provider='oecd')\n# Demographics for the statistics are selected with the `age` parameter.\nobb.economy.unemployment(country=all, frequency=quarterly, age=25-54, provider='oecd')\n```\n\n", "parameters": { "standard": [ - { - "name": "units", - "type": "Literal['idx', 'qoq', 'yoy']", - "description": "The unit of measurement for the data. Either idx (indicating 2015=100), qoq (previous period) or yoy (same period, previous year).)", - "default": "yoy", - "optional": true - }, { "name": "start_date", "type": "Union[date, str]", @@ -3396,10 +3153,38 @@ "oecd": [ { "name": "country", - "type": "Literal['G20', 'G7', 'argentina', 'australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'colombia', 'costa_rica', 'croatia', 'czech_republic', 'denmark', 'estonia', 'euro_area_19', 'europe', 'european_union_27', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'india', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'norway', 'oecd_total', 'poland', 'portugal', 'romania', 'russia', 'saudi_arabia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'all']", + "type": "Literal['colombia', 'new_zealand', 'united_kingdom', 'italy', 'luxembourg', 'euro_area19', 'sweden', 'oecd', 'south_africa', 'denmark', 'canada', 'switzerland', 'slovakia', 'hungary', 'portugal', 'spain', 'france', 'czech_republic', 'costa_rica', 'japan', 'slovenia', 'russia', 'austria', 'latvia', 'netherlands', 'israel', 'iceland', 'united_states', 'ireland', 'mexico', 'germany', 'greece', 'turkey', 'australia', 'poland', 'south_korea', 'chile', 'finland', 'european_union27_2020', 'norway', 'lithuania', 'euro_area20', 'estonia', 'belgium', 'brazil', 'indonesia', 'all']", "description": "Country to get GDP for.", "default": "united_states", "optional": true + }, + { + "name": "sex", + "type": "Literal['total', 'male', 'female']", + "description": "Sex to get unemployment for.", + "default": "total", + "optional": true + }, + { + "name": "frequency", + "type": "Literal['monthly', 'quarterly', 'annual']", + "description": "Frequency to get unemployment for.", + "default": "monthly", + "optional": true + }, + { + "name": "age", + "type": "Literal['total', '15-24', '15-64', '25-54', '55-64']", + "description": "Age group to get unemployment for. Total indicates 15 years or over", + "default": "total", + "optional": true + }, + { + "name": "seasonal_adjustment", + "type": "bool", + "description": "Whether to get seasonally adjusted unemployment. Defaults to False.", + "default": false, + "optional": true } ] }, @@ -3407,7 +3192,7 @@ "OBBject": [ { "name": "results", - "type": "List[GdpReal]", + "type": "List[Unemployment]", "description": "Serializable results." }, { @@ -3444,22 +3229,29 @@ { "name": "value", "type": "float", - "description": "Nominal GDP value on the date.", + "description": "Unemployment rate (given as a whole number, i.e 10=10%)", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Country for which unemployment rate is given", "default": null, "optional": true } ], "oecd": [] }, - "model": "GdpReal" + "model": "Unemployment" }, - "/economy/calendar": { + "/economy/composite_leading_indicator": { "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# By default, the calendar will be forward-looking.\nobb.economy.calendar(provider='nasdaq')\n```\n\n", + "description": "Use the composite leading indicator (CLI).\n\nIt is designed to provide early signals of turning points\nin business cycles showing fluctuation of the economic activity around its long term potential level.\n\nCLIs show short-term economic movements in qualitative rather than quantitative terms.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.composite_leading_indicator(provider='oecd')\nobb.economy.composite_leading_indicator(country=all, provider='oecd')\n```\n\n", "parameters": { "standard": [ { @@ -3478,42 +3270,18 @@ }, { "name": "provider", - "type": "Literal['fmp', 'nasdaq', 'tradingeconomics']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [], - "nasdaq": [ - { - "name": "country", - "type": "Union[str, List[str]]", - "description": "Country of the event Multiple items allowed for provider(s): nasdaq, tradingeconomics.", - "default": null, + "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 } ], - "tradingeconomics": [ + "oecd": [ { "name": "country", - "type": "Union[str, List[str]]", - "description": "Country of the event. Multiple items allowed for provider(s): tradingeconomics.", - "default": null, - "optional": true - }, - { - "name": "importance", - "type": "Literal['Low', 'Medium', 'High']", - "description": "Importance of the event.", - "default": null, - "optional": true - }, - { - "name": "group", - "type": "Literal['interest rate', 'inflation', 'bonds', 'consumer', 'gdp', 'government', 'housing', 'labour', 'markets', 'money', 'prices', 'trade', 'business']", - "description": "Grouping of events", - "default": null, + "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 } ] @@ -3522,12 +3290,12 @@ "OBBject": [ { "name": "results", - "type": "List[EconomicCalendar]", + "type": "List[CLI]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'nasdaq', 'tradingeconomics']]", + "type": "Optional[Literal['oecd']]", "description": "Provider name." }, { @@ -3551,183 +3319,144 @@ "standard": [ { "name": "date", - "type": "datetime", + "type": "date", "description": "The date of the data.", "default": null, "optional": true }, { - "name": "country", - "type": "str", - "description": "Country of event.", - "default": null, - "optional": true - }, - { - "name": "event", - "type": "str", - "description": "Event name.", + "name": "value", + "type": "float", + "description": "CLI value", "default": null, "optional": true }, { - "name": "reference", + "name": "country", "type": "str", - "description": "Abbreviated period for which released data refers to.", + "description": "Country for which CLI is given", "default": null, "optional": true - }, + } + ], + "oecd": [] + }, + "model": "CLI" + }, + "/economy/short_term_interest_rate": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Short-term interest rates.\n\nThey are the rates at which short-term borrowings are effected between\nfinancial institutions or the rate at which short-term government paper is issued or traded in the market.\n\nShort-term interest rates are generally averages of daily rates, measured as a percentage.\nShort-term interest rates are based on three-month money market rates where available.\nTypical standardised names are \"money market rate\" and \"treasury bill rate\".", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.short_term_interest_rate(provider='oecd')\nobb.economy.short_term_interest_rate(country=all, frequency=quarterly, provider='oecd')\n```\n\n", + "parameters": { + "standard": [ { - "name": "source", - "type": "str", - "description": "Source of the data.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "sourceurl", - "type": "str", - "description": "Source URL.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "actual", - "type": "Union[str, float]", - "description": "Latest released value.", - "default": null, + "name": "provider", + "type": "Literal['oecd']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default.", + "default": "oecd", "optional": true - }, + } + ], + "oecd": [ { - "name": "previous", - "type": "Union[str, float]", - "description": "Value for the previous period after the revision (if revision is applicable).", - "default": null, + "name": "country", + "type": "Literal['belgium', 'ireland', 'mexico', 'indonesia', 'new_zealand', 'japan', 'united_kingdom', 'france', 'chile', 'canada', 'netherlands', 'united_states', 'south_korea', 'norway', 'austria', 'south_africa', 'denmark', 'switzerland', 'hungary', 'luxembourg', 'australia', 'germany', 'sweden', 'iceland', 'turkey', 'greece', 'israel', 'czech_republic', 'latvia', 'slovenia', 'poland', 'estonia', 'lithuania', 'portugal', 'costa_rica', 'slovakia', 'finland', 'spain', 'russia', 'euro_area19', 'colombia', 'italy', 'india', 'china', 'croatia', 'all']", + "description": "Country to get GDP for.", + "default": "united_states", "optional": true }, { - "name": "consensus", - "type": "Union[str, float]", - "description": "Average forecast among a representative group of economists.", - "default": null, + "name": "frequency", + "type": "Literal['monthly', 'quarterly', 'annual']", + "description": "Frequency to get interest rate for for.", + "default": "monthly", "optional": true - }, + } + ] + }, + "returns": { + "OBBject": [ { - "name": "forecast", - "type": "Union[str, float]", - "description": "Trading Economics projections", - "default": null, - "optional": true + "name": "results", + "type": "List[STIR]", + "description": "Serializable results." }, { - "name": "url", - "type": "str", - "description": "Trading Economics URL", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['oecd']]", + "description": "Provider name." }, { - "name": "importance", - "type": "Union[Literal[0, 1, 2, 3], str]", - "description": "Importance of the event. 1-Low, 2-Medium, 3-High", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "currency", - "type": "str", - "description": "Currency of the data.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "unit", - "type": "str", - "description": "Unit of the data.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } - ], - "fmp": [ + ] + }, + "data": { + "standard": [ { - "name": "change", - "type": "float", - "description": "Value change since previous.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": null, "optional": true }, { - "name": "change_percent", + "name": "value", "type": "float", - "description": "Percentage change since previous.", - "default": null, - "optional": true - }, - { - "name": "updated_at", - "type": "datetime", - "description": "Last updated timestamp.", + "description": "Interest rate (given as a whole number, i.e 10=10%)", "default": null, "optional": true }, { - "name": "created_at", - "type": "datetime", - "description": "Created at timestamp.", - "default": null, - "optional": true - } - ], - "nasdaq": [ - { - "name": "description", + "name": "country", "type": "str", - "description": "Event description.", + "description": "Country for which interest rate is given", "default": null, "optional": true } ], - "tradingeconomics": [] + "oecd": [] }, - "model": "EconomicCalendar" + "model": "STIR" }, - "/economy/cpi": { + "/economy/long_term_interest_rate": { "deprecated": { "flag": null, "message": null }, - "description": "Get Consumer Price Index (CPI).\n\nReturns either the rescaled index value, or a rate of change (inflation).", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.cpi(country='japan,china,turkey', provider='fred')\n# Use the `units` parameter to define the reference period for the change in values.\nobb.economy.cpi(country='united_states,united_kingdom', units='growth_previous', provider='fred')\n```\n\n", + "description": "Get Long-term interest rates that refer to government bonds maturing in ten years.\n\nRates are mainly determined by the price charged by the lender, the risk from the borrower and the\nfall in the capital value. Long-term interest rates are generally averages of daily rates,\nmeasured as a percentage. These interest rates are implied by the prices at which the government bonds are\ntraded on financial markets, not the interest rates at which the loans were issued.\nIn all cases, they refer to bonds whose capital repayment is guaranteed by governments.\nLong-term interest rates are one of the determinants of business investment.\nLow long-term interest rates encourage investment in new equipment and high interest rates discourage it.\nInvestment is, in turn, a major source of economic growth.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.long_term_interest_rate(provider='oecd')\nobb.economy.long_term_interest_rate(country=all, frequency=quarterly, provider='oecd')\n```\n\n", "parameters": { "standard": [ - { - "name": "country", - "type": "Union[str, List[str]]", - "description": "The country to get data. Multiple items allowed for provider(s): fred.", - "default": "", - "optional": false - }, - { - "name": "units", - "type": "Literal['growth_previous', 'growth_same', 'index_2015']", - "description": "The unit of measurement for the data. Options: - `growth_previous`: Percent growth from the previous period. If monthly data, this is month-over-month, etc - `growth_same`: Percent growth from the same period in the previous year. If looking at monthly data, this would be year-over-year, etc. - `index_2015`: Rescaled index value, such that the value in 2015 is 100.", - "default": "growth_same", - "optional": true - }, - { - "name": "frequency", - "type": "Literal['monthly', 'quarter', 'annual']", - "description": "The frequency of the data. Options: `monthly`, `quarter`, and `annual`.", - "default": "monthly", - "optional": true - }, - { - "name": "harmonized", - "type": "bool", - "description": "Whether you wish to obtain harmonized data.", - "default": false, - "optional": true - }, { "name": "start_date", "type": "Union[date, str]", @@ -3744,24 +3473,39 @@ }, { "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "type": "Literal['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 } ], - "fred": [] + "oecd": [ + { + "name": "country", + "type": "Literal['belgium', 'ireland', 'mexico', 'indonesia', 'new_zealand', 'japan', 'united_kingdom', 'france', 'chile', 'canada', 'netherlands', 'united_states', 'south_korea', 'norway', 'austria', 'south_africa', 'denmark', 'switzerland', 'hungary', 'luxembourg', 'australia', 'germany', 'sweden', 'iceland', 'turkey', 'greece', 'israel', 'czech_republic', 'latvia', 'slovenia', 'poland', 'estonia', 'lithuania', 'portugal', 'costa_rica', 'slovakia', 'finland', 'spain', 'russia', 'euro_area19', 'colombia', 'italy', 'india', 'china', 'croatia', 'all']", + "description": "Country to get GDP for.", + "default": "united_states", + "optional": true + }, + { + "name": "frequency", + "type": "Literal['monthly', 'quarterly', 'annual']", + "description": "Frequency to get interest rate for for.", + "default": "monthly", + "optional": true + } + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[ConsumerPriceIndex]", + "type": "List[LTIR]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fred']]", + "type": "Optional[Literal['oecd']]", "description": "Provider name." }, { @@ -3787,43 +3531,142 @@ "name": "date", "type": "date", "description": "The date of the data.", - "default": "", - "optional": false + "default": null, + "optional": true + }, + { + "name": "value", + "type": "float", + "description": "Interest rate (given as a whole number, i.e 10=10%)", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Country for which interest rate is given", + "default": null, + "optional": true } ], - "fred": [] + "oecd": [] }, - "model": "ConsumerPriceIndex" + "model": "LTIR" }, - "/economy/risk_premium": { + "/economy/fred_regional": { "deprecated": { "flag": null, "message": null }, - "description": "Get Market Risk Premium by country.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.risk_premium(provider='fmp')\n```\n\n", + "description": "Query the Geo Fred API for regional economic data by series group.\n\nThe series group ID is found by using `fred_search` and the `series_id` parameter.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.fred_regional(symbol='NYICLAIMS', provider='fred')\n# With a date, time series data is returned.\nobb.economy.fred_regional(symbol='NYICLAIMS', start_date='2021-01-01', end_date='2021-12-31', limit=10, provider='fred')\n```\n\n", "parameters": { "standard": [ { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [] - }, + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100000, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", + "optional": true + } + ], + "fred": [ + { + "name": "symbol", + "type": "str", + "description": "For this function, it is the series_group ID or series ID. If the symbol provided is for a series_group, set the `is_series_group` parameter to True. Not all series that are in FRED have geographical data.", + "default": "", + "optional": false + }, + { + "name": "is_series_group", + "type": "bool", + "description": "When True, the symbol provided is for a series_group, else it is for a series ID.", + "default": false, + "optional": true + }, + { + "name": "region_type", + "type": "Literal['bea', 'msa', 'frb', 'necta', 'state', 'country', 'county', 'censusregion']", + "description": "The type of regional data. Parameter is only valid when `is_series_group` is True.", + "default": null, + "optional": true + }, + { + "name": "season", + "type": "Literal['SA', 'NSA', 'SSA']", + "description": "The seasonal adjustments to the data. Parameter is only valid when `is_series_group` is True.", + "default": "NSA", + "optional": true + }, + { + "name": "units", + "type": "str", + "description": "The units of the data. This should match the units returned from searching by series ID. An incorrect field will not necessarily return an error. Parameter is only valid when `is_series_group` is True.", + "default": null, + "optional": true + }, + { + "name": "frequency", + "type": "Literal['d', 'w', 'bw', 'm', 'q', 'sa', 'a', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", + "description": "Frequency aggregation to convert high frequency data to lower frequency. Parameter is only valid when `is_series_group` is True. a = Annual sa= Semiannual q = Quarterly m = Monthly w = Weekly d = Daily wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday", + "default": null, + "optional": true + }, + { + "name": "aggregation_method", + "type": "Literal['avg', 'sum', 'eop']", + "description": "A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. Only valid when `is_series_group` is True. avg = Average sum = Sum eop = End of Period", + "default": "avg", + "optional": true + }, + { + "name": "transform", + "type": "Literal['lin', 'chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", + "description": "Transformation type. Only valid when `is_series_group` is True. lin = Levels (No transformation) chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log", + "default": "lin", + "optional": true + } + ] + }, "returns": { "OBBject": [ { "name": "results", - "type": "List[RiskPremium]", + "type": "List[FredRegional]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['fred']]", "description": "Provider name." }, { @@ -3846,75 +3689,83 @@ "data": { "standard": [ { - "name": "country", + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + } + ], + "fred": [ + { + "name": "region", "type": "str", - "description": "Market country.", + "description": "The name of the region.", "default": "", "optional": false }, { - "name": "continent", - "type": "str", - "description": "Continent of the country.", - "default": null, - "optional": true + "name": "code", + "type": "Union[str, int]", + "description": "The code of the region.", + "default": "", + "optional": false }, { - "name": "total_equity_risk_premium", - "type": "Annotated[float, Gt(gt=0)]", - "description": "Total equity risk premium for the country.", + "name": "value", + "type": "Union[int, float]", + "description": "The obersvation value. The units are defined in the search results by series ID.", "default": null, "optional": true }, { - "name": "country_risk_premium", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Country-specific risk premium.", - "default": null, - "optional": true + "name": "series_id", + "type": "str", + "description": "The individual series ID for the region.", + "default": "", + "optional": false } - ], - "fmp": [] + ] }, - "model": "RiskPremium" + "model": "FredRegional" }, - "/economy/balance_of_payments": { + "/economy/country_profile": { "deprecated": { "flag": null, "message": null }, - "description": "Balance of Payments Reports.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.balance_of_payments(provider='ecb')\nobb.economy.balance_of_payments(report_type=summary, provider='ecb')\n# The `country` parameter will override the `report_type`.\nobb.economy.balance_of_payments(country=united_states, provider='ecb')\n```\n\n", + "description": "Get a profile of country statistics and economic indicators.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.country_profile(provider='econdb', country='united_kingdom')\n# Enter the country as the full name, or iso code. If `latest` is False, the complete history for each series is returned.\nobb.economy.country_profile(country='united_states,jp', latest=False, provider='econdb')\n```\n\n", "parameters": { "standard": [ + { + "name": "country", + "type": "Union[str, List[str]]", + "description": "The country to get data. Multiple items allowed for provider(s): econdb.", + "default": "", + "optional": false + }, { "name": "provider", - "type": "Literal['ecb']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'ecb' if there is no default.", - "default": "ecb", + "type": "Literal['econdb']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'econdb' if there is no default.", + "default": "econdb", "optional": true } ], - "ecb": [ - { - "name": "report_type", - "type": "Literal['main', 'summary', 'services', 'investment_income', 'direct_investment', 'portfolio_investment', 'other_investment']", - "description": "The report type, the level of detail in the data.", - "default": "main", - "optional": true - }, + "econdb": [ { - "name": "frequency", - "type": "Literal['monthly', 'quarterly']", - "description": "The frequency of the data. Monthly is valid only for ['main', 'summary'].", - "default": "monthly", + "name": "latest", + "type": "bool", + "description": "If True, return only the latest data. If False, return all available data for each indicator.", + "default": true, "optional": true }, { - "name": "country", - "type": "Literal['brazil', 'canada', 'china', 'eu_ex_euro_area', 'eu_institutions', 'india', 'japan', 'russia', 'switzerland', 'united_kingdom', 'united_states', 'total']", - "description": "The country/region of the data. This parameter will override the 'report_type' parameter.", - "default": null, + "name": "use_cache", + "type": "bool", + "description": "If True, the request will be cached for one day.Using cache is recommended to avoid needlessly requesting the same data.", + "default": true, "optional": true } ] @@ -3923,12 +3774,12 @@ "OBBject": [ { "name": "results", - "type": "List[BalanceOfPayments]", + "type": "List[CountryProfile]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['ecb']]", + "type": "Optional[Literal['econdb']]", "description": "Provider name." }, { @@ -3951,866 +3802,950 @@ "data": { "standard": [ { - "name": "period", - "type": "date", - "description": "The date representing the beginning of the reporting period.", - "default": null, - "optional": true + "name": "country", + "type": "str", + "description": "", + "default": "", + "optional": false }, { - "name": "current_account", - "type": "float", - "description": "Current Account Balance (Billions of EUR)", + "name": "population", + "type": "int", + "description": "Population.", "default": null, "optional": true }, { - "name": "goods", + "name": "gdp_usd", "type": "float", - "description": "Goods Balance (Billions of EUR)", + "description": "Gross Domestic Product, in billions of USD.", "default": null, "optional": true }, { - "name": "services", + "name": "gdp_qoq", "type": "float", - "description": "Services Balance (Billions of EUR)", + "description": "GDP growth quarter-over-quarter change, as a normalized percent.", "default": null, "optional": true }, { - "name": "primary_income", + "name": "gdp_yoy", "type": "float", - "description": "Primary Income Balance (Billions of EUR)", + "description": "GDP growth year-over-year change, as a normalized percent.", "default": null, "optional": true }, { - "name": "secondary_income", + "name": "cpi_yoy", "type": "float", - "description": "Secondary Income Balance (Billions of EUR)", + "description": "Consumer Price Index year-over-year change, as a normalized percent.", "default": null, "optional": true }, { - "name": "capital_account", + "name": "core_yoy", "type": "float", - "description": "Capital Account Balance (Billions of EUR)", + "description": "Core Consumer Price Index year-over-year change, as a normalized percent.", "default": null, "optional": true }, { - "name": "net_lending_to_rest_of_world", + "name": "retail_sales_yoy", "type": "float", - "description": "Balance of net lending to the rest of the world (Billions of EUR)", + "description": "Retail Sales year-over-year change, as a normalized percent.", "default": null, "optional": true }, { - "name": "financial_account", + "name": "industrial_production_yoy", "type": "float", - "description": "Financial Account Balance (Billions of EUR)", + "description": "Industrial Production year-over-year change, as a normalized percent.", "default": null, "optional": true }, { - "name": "direct_investment", + "name": "policy_rate", "type": "float", - "description": "Direct Investment Balance (Billions of EUR)", + "description": "Short term policy rate, as a normalized percent.", "default": null, "optional": true }, { - "name": "portfolio_investment", + "name": "yield_10y", "type": "float", - "description": "Portfolio Investment Balance (Billions of EUR)", + "description": "10-year government bond yield, as a normalized percent.", "default": null, "optional": true }, { - "name": "financial_derivatives", + "name": "govt_debt_gdp", "type": "float", - "description": "Financial Derivatives Balance (Billions of EUR)", + "description": "Government debt as a percent (normalized) of GDP.", "default": null, "optional": true }, { - "name": "other_investment", + "name": "current_account_gdp", "type": "float", - "description": "Other Investment Balance (Billions of EUR)", + "description": "Current account balance as a percent (normalized) of GDP.", "default": null, "optional": true }, { - "name": "reserve_assets", + "name": "jobless_rate", "type": "float", - "description": "Reserve Assets Balance (Billions of EUR)", + "description": "Unemployment rate, as a normalized percent.", "default": null, "optional": true - }, + } + ], + "econdb": [] + }, + "model": "CountryProfile" + }, + "/economy/available_indicators": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the available economic indicators for a provider.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.available_indicators(provider='econdb')\n```\n\n", + "parameters": { + "standard": [ { - "name": "errors_and_ommissions", - "type": "float", - "description": "Errors and Omissions (Billions of EUR)", - "default": null, + "name": "provider", + "type": "Literal['econdb']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'econdb' if there is no default.", + "default": "econdb", "optional": true - }, + } + ], + "econdb": [ { - "name": "current_account_credit", - "type": "float", - "description": "Current Account Credits (Billions of EUR)", - "default": null, + "name": "use_cache", + "type": "bool", + "description": "Whether to use cache or not, by default is True The cache of indicator symbols will persist for one week.", + "default": true, "optional": true - }, + } + ] + }, + "returns": { + "OBBject": [ { - "name": "current_account_debit", - "type": "float", - "description": "Current Account Debits (Billions of EUR)", - "default": null, - "optional": true + "name": "results", + "type": "List[AvailableIndicators]", + "description": "Serializable results." }, { - "name": "current_account_balance", - "type": "float", - "description": "Current Account Balance (Billions of EUR)", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['econdb']]", + "description": "Provider name." }, { - "name": "goods_credit", - "type": "float", - "description": "Goods Credits (Billions of EUR)", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "goods_debit", - "type": "float", - "description": "Goods Debits (Billions of EUR)", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "services_credit", - "type": "float", - "description": "Services Credits (Billions of EUR)", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "services_debit", - "type": "float", - "description": "Services Debits (Billions of EUR)", + "name": "symbol_root", + "type": "str", + "description": "The root symbol representing the indicator.", "default": null, "optional": true }, { - "name": "primary_income_credit", - "type": "float", - "description": "Primary Income Credits (Billions of EUR)", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. The root symbol with additional codes.", "default": null, "optional": true }, { - "name": "primary_income_employee_compensation_credit", - "type": "float", - "description": "Primary Income Employee Compensation Credit (Billions of EUR)", + "name": "country", + "type": "str", + "description": "The name of the country, region, or entity represented by the symbol.", "default": null, "optional": true }, { - "name": "primary_income_debit", - "type": "float", - "description": "Primary Income Debits (Billions of EUR)", + "name": "iso", + "type": "str", + "description": "The ISO code of the country, region, or entity represented by the symbol.", "default": null, "optional": true }, { - "name": "primary_income_employee_compensation_debit", - "type": "float", - "description": "Primary Income Employee Compensation Debit (Billions of EUR)", + "name": "description", + "type": "str", + "description": "The description of the indicator.", "default": null, "optional": true }, { - "name": "secondary_income_credit", - "type": "float", - "description": "Secondary Income Credits (Billions of EUR)", + "name": "frequency", + "type": "str", + "description": "The frequency of the indicator data.", "default": null, "optional": true - }, + } + ], + "econdb": [ { - "name": "secondary_income_debit", - "type": "float", - "description": "Secondary Income Debits (Billions of EUR)", + "name": "currency", + "type": "str", + "description": "The currency, or unit, the data is based in.", "default": null, "optional": true }, { - "name": "capital_account_credit", - "type": "float", - "description": "Capital Account Credits (Billions of EUR)", + "name": "scale", + "type": "str", + "description": "The scale of the data.", "default": null, "optional": true }, { - "name": "capital_account_debit", - "type": "float", - "description": "Capital Account Debits (Billions of EUR)", - "default": null, - "optional": true + "name": "multiplier", + "type": "int", + "description": "The multiplier of the data to arrive at whole units.", + "default": "", + "optional": false }, { - "name": "services_total_credit", - "type": "float", - "description": "Services Total Credit (Billions of EUR)", - "default": null, - "optional": true + "name": "transformation", + "type": "str", + "description": "Transformation type.", + "default": "", + "optional": false }, { - "name": "services_total_debit", - "type": "float", - "description": "Services Total Debit (Billions of EUR)", + "name": "source", + "type": "str", + "description": "The original source of the data.", "default": null, "optional": true }, { - "name": "transport_credit", - "type": "float", - "description": "Transport Credit (Billions of EUR)", + "name": "first_date", + "type": "date", + "description": "The first date of the data.", "default": null, "optional": true }, { - "name": "transport_debit", - "type": "float", - "description": "Transport Debit (Billions of EUR)", + "name": "last_date", + "type": "date", + "description": "The last date of the data.", "default": null, "optional": true }, { - "name": "travel_credit", - "type": "float", - "description": "Travel Credit (Billions of EUR)", + "name": "last_insert_timestamp", + "type": "datetime", + "description": "The time of the last update. Data is typically reported with a lag.", "default": null, "optional": true - }, + } + ] + }, + "model": "AvailableIndicators" + }, + "/economy/indicators": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get economic indicators by country and indicator.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.indicators(provider='econdb', symbol='PCOCO')\n# Enter the country as the full name, or iso code. Use `available_indicators()` to get a list of supported indicators from EconDB.\nobb.economy.indicators(symbol='CPI', country='united_states,jp', provider='econdb')\n# Use the `main` symbol to get the group of main indicators for a country.\nobb.economy.indicators(provider='econdb', symbol='main', country='eu')\n```\n\n", + "parameters": { + "standard": [ { - "name": "travel_debit", - "type": "float", - "description": "Travel Debit (Billions of EUR)", - "default": null, - "optional": true + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Multiple items allowed for provider(s): econdb.", + "default": "", + "optional": false }, { - "name": "financial_services_credit", - "type": "float", - "description": "Financial Services Credit (Billions of EUR)", + "name": "country", + "type": "Union[str, List[str]]", + "description": "The country to get data. The country represented by the indicator, if available. Multiple items allowed for provider(s): econdb.", "default": null, "optional": true }, { - "name": "financial_services_debit", - "type": "float", - "description": "Financial Services Debit (Billions of EUR)", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "communications_credit", - "type": "float", - "description": "Communications Credit (Billions of EUR)", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "communications_debit", - "type": "float", - "description": "Communications Debit (Billions of EUR)", - "default": null, + "name": "provider", + "type": "Literal['econdb']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'econdb' if there is no default.", + "default": "econdb", "optional": true - }, + } + ], + "econdb": [ { - "name": "other_business_services_credit", - "type": "float", - "description": "Other Business Services Credit (Billions of EUR)", + "name": "transform", + "type": "Literal['toya', 'tpop', 'tusd', 'tpgp']", + "description": "The transformation to apply to the data, default is None. tpop: Change from previous period toya: Change from one year ago tusd: Values as US dollars tpgp: Values as a percent of GDP Only 'tpop' and 'toya' are applicable to all indicators. Applying transformations across multiple indicators/countries may produce unexpected results. This is because not all indicators are compatible with all transformations, and the original units and scale differ between entities. `tusd` should only be used where values are currencies.", "default": null, "optional": true }, { - "name": "other_business_services_debit", - "type": "float", - "description": "Other Business Services Debit (Billions of EUR)", - "default": null, + "name": "frequency", + "type": "Literal['annual', 'quarter', 'month']", + "description": "The frequency of the data, default is 'quarter'. Only valid when 'symbol' is 'main'.", + "default": "quarter", "optional": true }, { - "name": "other_services_credit", - "type": "float", - "description": "Other Services Credit (Billions of EUR)", - "default": null, + "name": "use_cache", + "type": "bool", + "description": "If True, the request will be cached for one day. Using cache is recommended to avoid needlessly requesting the same data.", + "default": true, "optional": true - }, + } + ] + }, + "returns": { + "OBBject": [ { - "name": "other_services_debit", - "type": "float", - "description": "Other Services Debit (Billions of EUR)", - "default": null, - "optional": true + "name": "results", + "type": "List[EconomicIndicators]", + "description": "Serializable results." }, { - "name": "investment_total_credit", - "type": "float", - "description": "Investment Total Credit (Billions of EUR)", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['econdb']]", + "description": "Provider name." }, { - "name": "investment_total_debit", - "type": "float", - "description": "Investment Total Debit (Billions of EUR)", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "equity_credit", - "type": "float", - "description": "Equity Credit (Billions of EUR)", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "equity_reinvested_earnings_credit", - "type": "float", - "description": "Equity Reinvested Earnings Credit (Billions of EUR)", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "equity_debit", - "type": "float", - "description": "Equity Debit (Billions of EUR)", + "name": "symbol_root", + "type": "str", + "description": "The root symbol for the indicator (e.g. GDP).", "default": null, "optional": true }, { - "name": "equity_reinvested_earnings_debit", - "type": "float", - "description": "Equity Reinvested Earnings Debit (Billions of EUR)", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "debt_instruments_credit", - "type": "float", - "description": "Debt Instruments Credit (Billions of EUR)", + "name": "country", + "type": "str", + "description": "The country represented by the data.", "default": null, "optional": true }, { - "name": "debt_instruments_debit", - "type": "float", - "description": "Debt Instruments Debit (Billions of EUR)", + "name": "value", + "type": "Union[int, float]", + "description": "", "default": null, "optional": true - }, + } + ], + "econdb": [] + }, + "model": "EconomicIndicators" + }, + "/equity/calendar/ipo": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical and upcoming initial public offerings (IPOs).", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.calendar.ipo(provider='intrinio')\n# Get all IPOs available.\nobb.equity.calendar.ipo(provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ { - "name": "portfolio_investment_equity_credit", - "type": "float", - "description": "Portfolio Investment Equity Credit (Billions of EUR)", + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", "default": null, "optional": true }, { - "name": "portfolio_investment_equity_debit", - "type": "float", - "description": "Portfolio Investment Equity Debit (Billions of EUR)", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "portfolio_investment_debt_instruments_credit", - "type": "float", - "description": "Portfolio Investment Debt Instruments Credit (Billions of EUR)", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "portofolio_investment_debt_instruments_debit", - "type": "float", - "description": "Portfolio Investment Debt Instruments Debit (Billions of EUR)", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100, "optional": true }, { - "name": "other_investment_credit", - "type": "float", - "description": "Other Investment Credit (Billions of EUR)", - "default": null, - "optional": true - }, - { - "name": "other_investment_debit", - "type": "float", - "description": "Other Investment Debit (Billions of EUR)", - "default": null, + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", "optional": true - }, + } + ], + "intrinio": [ { - "name": "reserve_assets_credit", - "type": "float", - "description": "Reserve Assets Credit (Billions of EUR)", + "name": "status", + "type": "Literal['upcoming', 'priced', 'withdrawn']", + "description": "Status of the IPO. [upcoming, priced, or withdrawn]", "default": null, "optional": true }, { - "name": "assets_total", - "type": "float", - "description": "Assets Total (Billions of EUR)", + "name": "min_value", + "type": "int", + "description": "Return IPOs with an offer dollar amount greater than the given amount.", "default": null, "optional": true }, { - "name": "assets_equity", - "type": "float", - "description": "Assets Equity (Billions of EUR)", + "name": "max_value", + "type": "int", + "description": "Return IPOs with an offer dollar amount less than the given amount.", "default": null, "optional": true - }, + } + ] + }, + "returns": { + "OBBject": [ { - "name": "assets_debt_instruments", - "type": "float", - "description": "Assets Debt Instruments (Billions of EUR)", - "default": null, - "optional": true + "name": "results", + "type": "List[CalendarIpo]", + "description": "Serializable results." }, { - "name": "assets_mfi", - "type": "float", - "description": "Assets MFIs (Billions of EUR)", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['intrinio']]", + "description": "Provider name." }, { - "name": "assets_non_mfi", - "type": "float", - "description": "Assets Non MFIs (Billions of EUR)", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "assets_direct_investment_abroad", - "type": "float", - "description": "Assets Direct Investment Abroad (Billions of EUR)", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "liabilities_total", - "type": "float", - "description": "Liabilities Total (Billions of EUR)", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "liabilities_equity", - "type": "float", - "description": "Liabilities Equity (Billions of EUR)", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "liabilities_debt_instruments", - "type": "float", - "description": "Liabilities Debt Instruments (Billions of EUR)", + "name": "ipo_date", + "type": "date", + "description": "The date of the IPO, when the stock first trades on a major exchange.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "liabilities_mfi", - "type": "float", - "description": "Liabilities MFIs (Billions of EUR)", + "name": "status", + "type": "Literal['upcoming', 'priced', 'withdrawn']", + "description": "The status of the IPO. Upcoming IPOs have not taken place yet but are expected to. Priced IPOs have taken place. Withdrawn IPOs were expected to take place, but were subsequently withdrawn.", "default": null, "optional": true }, { - "name": "liabilities_non_mfi", - "type": "float", - "description": "Liabilities Non MFIs (Billions of EUR)", + "name": "exchange", + "type": "str", + "description": "The acronym of the stock exchange that the company is going to trade publicly on. Typically NYSE or NASDAQ.", "default": null, "optional": true }, { - "name": "liabilities_direct_investment_euro_area", + "name": "offer_amount", "type": "float", - "description": "Liabilities Direct Investment in Euro Area (Billions of EUR)", + "description": "The total dollar amount of shares offered in the IPO. Typically this is share price * share count", "default": null, "optional": true }, { - "name": "assets_equity_and_fund_shares", + "name": "share_price", "type": "float", - "description": "Assets Equity and Investment Fund Shares (Billions of EUR)", + "description": "The price per share at which the IPO was offered.", "default": null, "optional": true }, { - "name": "assets_equity_shares", + "name": "share_price_lowest", "type": "float", - "description": "Assets Equity Shares (Billions of EUR)", + "description": "The expected lowest price per share at which the IPO will be offered. Before an IPO is priced, companies typically provide a range of prices per share at which they expect to offer the IPO (typically available for upcoming IPOs).", "default": null, "optional": true }, { - "name": "assets_investment_fund_shares", + "name": "share_price_highest", "type": "float", - "description": "Assets Investment Fund Shares (Billions of EUR)", + "description": "The expected highest price per share at which the IPO will be offered. Before an IPO is priced, companies typically provide a range of prices per share at which they expect to offer the IPO (typically available for upcoming IPOs).", "default": null, "optional": true }, { - "name": "assets_debt_short_term", - "type": "float", - "description": "Assets Debt Short Term (Billions of EUR)", + "name": "share_count", + "type": "int", + "description": "The number of shares offered in the IPO.", "default": null, "optional": true }, { - "name": "assets_debt_long_term", - "type": "float", - "description": "Assets Debt Long Term (Billions of EUR)", + "name": "share_count_lowest", + "type": "int", + "description": "The expected lowest number of shares that will be offered in the IPO. Before an IPO is priced, companies typically provide a range of shares that they expect to offer in the IPO (typically available for upcoming IPOs).", "default": null, "optional": true }, { - "name": "assets_resident_sector_eurosystem", - "type": "float", - "description": "Assets Resident Sector Eurosystem (Billions of EUR)", + "name": "share_count_highest", + "type": "int", + "description": "The expected highest number of shares that will be offered in the IPO. Before an IPO is priced, companies typically provide a range of shares that they expect to offer in the IPO (typically available for upcoming IPOs).", "default": null, "optional": true }, { - "name": "assets_resident_sector_mfi_ex_eurosystem", - "type": "float", - "description": "Assets Resident Sector MFIs outside Eurosystem (Billions of EUR)", + "name": "announcement_url", + "type": "str", + "description": "The URL to the company's announcement of the IPO", "default": null, "optional": true }, { - "name": "assets_resident_sector_government", - "type": "float", - "description": "Assets Resident Sector Government (Billions of EUR)", + "name": "sec_report_url", + "type": "str", + "description": "The URL to the company's S-1, S-1/A, F-1, or F-1/A SEC filing, which is required to be filed before an IPO takes place.", "default": null, "optional": true }, { - "name": "assets_resident_sector_other", + "name": "open_price", "type": "float", - "description": "Assets Resident Sector Other (Billions of EUR)", + "description": "The opening price at the beginning of the first trading day (only available for priced IPOs).", "default": null, "optional": true }, { - "name": "liabilities_equity_and_fund_shares", + "name": "close_price", "type": "float", - "description": "Liabilities Equity and Investment Fund Shares (Billions of EUR)", + "description": "The closing price at the end of the first trading day (only available for priced IPOs).", "default": null, "optional": true }, { - "name": "liabilities_investment_fund_shares", - "type": "float", - "description": "Liabilities Investment Fund Shares (Billions of EUR)", + "name": "volume", + "type": "int", + "description": "The volume at the end of the first trading day (only available for priced IPOs).", "default": null, "optional": true }, { - "name": "liabilities_debt_short_term", + "name": "day_change", "type": "float", - "description": "Liabilities Debt Short Term (Billions of EUR)", + "description": "The percentage change between the open price and the close price on the first trading day (only available for priced IPOs).", "default": null, "optional": true }, { - "name": "liabilities_debt_long_term", + "name": "week_change", "type": "float", - "description": "Liabilities Debt Long Term (Billions of EUR)", + "description": "The percentage change between the open price on the first trading day and the close price approximately a week after the first trading day (only available for priced IPOs).", "default": null, "optional": true }, { - "name": "liabilities_resident_sector_government", + "name": "month_change", "type": "float", - "description": "Liabilities Resident Sector Government (Billions of EUR)", + "description": "The percentage change between the open price on the first trading day and the close price approximately a month after the first trading day (only available for priced IPOs).", "default": null, "optional": true }, { - "name": "liabilities_resident_sector_other", - "type": "float", - "description": "Liabilities Resident Sector Other (Billions of EUR)", + "name": "id", + "type": "str", + "description": "The Intrinio ID of the IPO.", "default": null, "optional": true }, { - "name": "assets_currency_and_deposits", - "type": "float", - "description": "Assets Currency and Deposits (Billions of EUR)", + "name": "company", + "type": "IntrinioCompany", + "description": "The company that is going public via the IPO.", "default": null, "optional": true }, { - "name": "assets_loans", - "type": "float", - "description": "Assets Loans (Billions of EUR)", + "name": "security", + "type": "IntrinioSecurity", + "description": "The primary Security for the Company that is going public via the IPO", "default": null, "optional": true - }, + } + ] + }, + "model": "CalendarIpo" + }, + "/equity/calendar/dividend": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical and upcoming dividend payments. Includes dividend amount, ex-dividend and payment dates.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.calendar.dividend(provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "assets_trade_credit_and_advances", - "type": "float", - "description": "Assets Trade Credits and Advances (Billions of EUR)", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "assets_eurosystem", - "type": "float", - "description": "Assets Eurosystem (Billions of EUR)", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "assets_other_mfi_ex_eurosystem", - "type": "float", - "description": "Assets Other MFIs outside Eurosystem (Billions of EUR)", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ { - "name": "assets_government", - "type": "float", - "description": "Assets Government (Billions of EUR)", - "default": null, - "optional": true + "name": "results", + "type": "List[CalendarDividend]", + "description": "Serializable results." }, { - "name": "assets_other_sectors", - "type": "float", - "description": "Assets Other Sectors (Billions of EUR)", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "liabilities_currency_and_deposits", - "type": "float", - "description": "Liabilities Currency and Deposits (Billions of EUR)", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "liabilities_loans", - "type": "float", - "description": "Liabilities Loans (Billions of EUR)", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "liabilities_trade_credit_and_advances", - "type": "float", - "description": "Liabilities Trade Credits and Advances (Billions of EUR)", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "liabilities_eurosystem", - "type": "float", - "description": "Liabilities Eurosystem (Billions of EUR)", - "default": null, - "optional": true + "name": "ex_dividend_date", + "type": "date", + "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", + "default": "", + "optional": false }, { - "name": "liabilities_other_mfi_ex_eurosystem", - "type": "float", - "description": "Liabilities Other MFIs outside Eurosystem (Billions of EUR)", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "liabilities_government", + "name": "amount", "type": "float", - "description": "Liabilities Government (Billions of EUR)", + "description": "The dividend amount per share.", "default": null, "optional": true }, { - "name": "liabilities_other_sectors", - "type": "float", - "description": "Liabilities Other Sectors (Billions of EUR)", + "name": "name", + "type": "str", + "description": "Name of the entity.", "default": null, "optional": true }, { - "name": "goods_balance", - "type": "float", - "description": "Goods Balance (Billions of EUR)", + "name": "record_date", + "type": "date", + "description": "The record date of ownership for eligibility.", "default": null, "optional": true }, { - "name": "services_balance", - "type": "float", - "description": "Services Balance (Billions of EUR)", + "name": "payment_date", + "type": "date", + "description": "The payment date of the dividend.", "default": null, "optional": true }, { - "name": "primary_income_balance", - "type": "float", - "description": "Primary Income Balance (Billions of EUR)", + "name": "declaration_date", + "type": "date", + "description": "Declaration date of the dividend.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "investment_income_balance", + "name": "adjusted_amount", "type": "float", - "description": "Investment Income Balance (Billions of EUR)", + "description": "The adjusted-dividend amount.", "default": null, "optional": true }, { - "name": "investment_income_credit", - "type": "float", - "description": "Investment Income Credits (Billions of EUR)", - "default": null, - "optional": true - }, - { - "name": "investment_income_debit", - "type": "float", - "description": "Investment Income Debits (Billions of EUR)", - "default": null, - "optional": true - }, - { - "name": "secondary_income_balance", - "type": "float", - "description": "Secondary Income Balance (Billions of EUR)", - "default": null, - "optional": true - }, - { - "name": "capital_account_balance", - "type": "float", - "description": "Capital Account Balance (Billions of EUR)", + "name": "label", + "type": "str", + "description": "Ex-dividend date formatted for display.", "default": null, "optional": true } - ], - "ecb": [] + ] }, - "model": "BalanceOfPayments" + "model": "CalendarDividend" }, - "/economy/fred_search": { + "/equity/calendar/splits": { "deprecated": { "flag": null, "message": null }, - "description": "Search for FRED series or economic releases by ID or string.\n\nThis does not return the observation values, only the metadata.\nUse this function to find series IDs for `fred_series()`.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.fred_search(provider='fred')\n```\n\n", + "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": "query", - "type": "str", - "description": "The search word(s).", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true } ], - "fred": [ + "fmp": [] + }, + "returns": { + "OBBject": [ { - "name": "is_release", - "type": "bool", - "description": "Is release? If True, other search filter variables are ignored. If no query text or release_id is supplied, this defaults to True.", - "default": false, - "optional": true + "name": "results", + "type": "List[CalendarSplits]", + "description": "Serializable results." }, { - "name": "release_id", - "type": "Union[int, str]", - "description": "A specific release ID to target.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. (1-1000)", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "offset", - "type": "Annotated[int, Ge(ge=0)]", - "description": "Offset the results in conjunction with limit.", - "default": 0, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "filter_variable", - "type": "Literal['frequency', 'units', 'seasonal_adjustment']", - "description": "Filter by an attribute.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "filter_value", + "name": "label", "type": "str", - "description": "String value to filter the variable by. Used in conjunction with filter_variable.", - "default": null, - "optional": true + "description": "Label of the stock splits.", + "default": "", + "optional": false }, { - "name": "tag_names", + "name": "symbol", "type": "str", - "description": "A semicolon delimited list of tag names that series match all of. Example: 'japan;imports'", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "numerator", + "type": "float", + "description": "Numerator of the stock splits.", + "default": "", + "optional": false + }, + { + "name": "denominator", + "type": "float", + "description": "Denominator of the stock splits.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "CalendarSplits" + }, + "/equity/calendar/earnings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical and upcoming company earnings releases. Includes earnings per share (EPS) and revenue data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.calendar.earnings(provider='fmp')\n# Get earnings calendar for specific dates.\nobb.equity.calendar.earnings(start_date='2024-02-01', end_date='2024-02-07', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "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.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "series_id", - "type": "str", - "description": "A FRED Series ID to return series group information for. This returns the required information to query for regional data. Not all series that are in FRED have geographical data. Entering a value for series_id will override all other parameters. Multiple series_ids can be separated by commas.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true } - ] + ], + "fmp": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[FredSearch]", + "type": "List[CalendarEarnings]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fred']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -4833,166 +4768,202 @@ "data": { "standard": [ { - "name": "release_id", - "type": "Union[int, str]", - "description": "The release ID for queries.", - "default": null, - "optional": true + "name": "report_date", + "type": "date", + "description": "The date of the earnings report.", + "default": "", + "optional": false }, { - "name": "series_id", + "name": "symbol", "type": "str", - "description": "The series ID for the item in the release.", - "default": null, - "optional": true + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { "name": "name", "type": "str", - "description": "The name of the release.", + "description": "Name of the entity.", "default": null, "optional": true }, { - "name": "title", - "type": "str", - "description": "The title of the series.", + "name": "eps_previous", + "type": "float", + "description": "The earnings-per-share from the same previously reported period.", "default": null, "optional": true }, { - "name": "observation_start", - "type": "date", - "description": "The date of the first observation in the series.", + "name": "eps_consensus", + "type": "float", + "description": "The analyst conesus earnings-per-share estimate.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "observation_end", - "type": "date", - "description": "The date of the last observation in the series.", + "name": "eps_actual", + "type": "float", + "description": "The actual earnings per share announced.", "default": null, "optional": true }, { - "name": "frequency", - "type": "str", - "description": "The frequency of the data.", + "name": "revenue_actual", + "type": "float", + "description": "The actual reported revenue.", "default": null, "optional": true }, { - "name": "frequency_short", - "type": "str", - "description": "Short form of the data frequency.", + "name": "revenue_consensus", + "type": "float", + "description": "The revenue forecast consensus.", "default": null, "optional": true }, { - "name": "units", - "type": "str", - "description": "The units of the data.", + "name": "period_ending", + "type": "date", + "description": "The fiscal period end date.", "default": null, "optional": true }, { - "name": "units_short", + "name": "reporting_time", "type": "str", - "description": "Short form of the data units.", + "description": "The reporting time - e.g. after market close.", "default": null, "optional": true }, { - "name": "seasonal_adjustment", - "type": "str", - "description": "The seasonal adjustment of the data.", + "name": "updated_date", + "type": "date", + "description": "The date the data was updated last.", "default": null, "optional": true - }, + } + ] + }, + "model": "CalendarEarnings" + }, + "/equity/compare/peers": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the closest peers for a given company.\n\nPeers consist of companies trading on the same exchange, operating within the same sector\nand with comparable market capitalizations.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.compare.peers(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "seasonal_adjustment_short", + "name": "symbol", "type": "str", - "description": "Short form of the data seasonal adjustment.", - "default": null, - "optional": true + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "last_updated", - "type": "datetime", - "description": "The datetime of the last update to the data.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ { - "name": "notes", - "type": "str", - "description": "Description of the release.", - "default": null, - "optional": true + "name": "results", + "type": "List[EquityPeers]", + "description": "Serializable results." }, { - "name": "press_release", - "type": "bool", - "description": "If the release is a press release.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "url", - "type": "str", - "description": "URL to the release.", - "default": null, - "optional": true - } - ], - "fred": [ - { - "name": "popularity", - "type": "int", - "description": "Popularity of the series", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "group_popularity", - "type": "int", - "description": "Group popularity of the release", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "region_type", - "type": "str", - "description": "The region type of the series.", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "series_group", - "type": "Union[int, str]", - "description": "The series group ID of the series. This value is used to query for regional data.", - "default": null, + "name": "peers_list", + "type": "List[str]", + "description": "A list of equity peers based on sector, exchange and market cap.", + "default": "", "optional": true } - ] + ], + "fmp": [] }, - "model": "FredSearch" + "model": "EquityPeers" }, - "/economy/fred_series": { + "/equity/estimates/price_target": { "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", + "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): fred.", - "default": "", - "optional": false + "description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 200, + "optional": true + }, + { + "name": "provider", + "type": "Literal['benzinga', 'fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default.", + "default": "benzinga", + "optional": true + } + ], + "benzinga": [ + { + "name": "page", + "type": "int", + "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. Used in conjunction with the limit and date parameters.", + "default": 0, + "optional": true + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "Date for calendar data, shorthand for date_from and date_to.", + "default": null, + "optional": true }, { "name": "start_date", @@ -5009,64 +4980,55 @@ "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 100000, + "name": "updated", + "type": "Union[date, int]", + "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. The date can be a date string or a Unix timestamp. The date string must be in the format of YYYY-MM-DD.", + "default": null, "optional": true }, { - "name": "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", + "name": "importance", + "type": "int", + "description": "Importance level to filter by. Uses Greater Than or Equal To the importance indicated", + "default": null, "optional": true - } - ], - "fred": [ + }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 100000, + "name": "action", + "type": "Literal['downgrades', 'maintains', 'reinstates', 'reiterates', 'upgrades', 'assumes', 'initiates', 'terminates', 'removes', 'suspends', 'firm_dissolved']", + "description": "Filter by a specific action_company.", + "default": null, "optional": true }, { - "name": "frequency", - "type": "Literal['a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", - "description": "Frequency aggregation to convert high frequency data to lower frequency. None = No change a = Annual q = Quarterly m = Monthly w = Weekly d = Daily wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday", + "name": "analyst_ids", + "type": "Union[List[str], str]", + "description": "Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts.", "default": null, "optional": true }, { - "name": "aggregation_method", - "type": "Literal['avg', 'sum', 'eop']", - "description": "A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. avg = Average sum = Sum eop = End of Period", - "default": "eop", + "name": "firm_ids", + "type": "Union[List[str], str]", + "description": "Comma-separated list of firm IDs.", + "default": null, "optional": true }, { - "name": "transform", - "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", - "description": "Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log", + "name": "fields", + "type": "Union[List[str], str]", + "description": "Comma-separated list of fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields.", "default": null, "optional": true } ], - "intrinio": [ + "fmp": [ { - "name": "all_pages", + "name": "with_grade", "type": "bool", - "description": "Returns all pages of data from the API call at once.", + "description": "Include upgrades and downgrades in the response.", "default": false, "optional": true - }, - { - "name": "sleep", - "type": "float", - "description": "Time to sleep between requests to avoid rate limiting.", - "default": 1.0, - "optional": true } ] }, @@ -5074,12 +5036,12 @@ "OBBject": [ { "name": "results", - "type": "List[FredSeries]", + "type": "List[PriceTarget]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fred', 'intrinio']]", + "type": "Optional[Literal['benzinga', 'fmp']]", "description": "Provider name." }, { @@ -5102,223 +5064,253 @@ "data": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "published_date", + "type": "Union[date, datetime]", + "description": "Published date of the price target.", "default": "", "optional": false - } - ], - "fred": [], - "intrinio": [ + }, { - "name": "value", - "type": "float", - "description": "Value of the index.", + "name": "published_time", + "type": "datetime.time", + "description": "Time of the original rating, UTC.", "default": null, "optional": true - } - ] - }, - "model": "FredSeries" - }, - "/economy/money_measures": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get Money Measures (M1/M2 and components).\n\nThe Federal Reserve publishes as part of the H.6 Release.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.money_measures(provider='federal_reserve')\nobb.economy.money_measures(adjusted=False, provider='federal_reserve')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "exchange", + "type": "str", + "description": "Exchange where the company is traded.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "company_name", + "type": "str", + "description": "Name of company that is the subject of rating.", "default": null, "optional": true }, { - "name": "adjusted", - "type": "bool", - "description": "Whether to return seasonally adjusted data.", - "default": true, + "name": "analyst_name", + "type": "str", + "description": "Analyst name.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['federal_reserve']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default.", - "default": "federal_reserve", - "optional": true - } - ], - "federal_reserve": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[MoneyMeasures]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['federal_reserve']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "analyst_firm", + "type": "str", + "description": "Name of the analyst firm that published the price target.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "currency", + "type": "str", + "description": "Currency the data is denominated in.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "month", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "price_target", + "type": "float", + "description": "The current price target.", + "default": null, + "optional": true }, { - "name": "M1", + "name": "adj_price_target", "type": "float", - "description": "Value of the M1 money supply in billions.", - "default": "", - "optional": false + "description": "Adjusted price target for splits and stock dividends.", + "default": null, + "optional": true }, { - "name": "M2", + "name": "price_target_previous", "type": "float", - "description": "Value of the M2 money supply in billions.", - "default": "", - "optional": false + "description": "Previous price target.", + "default": null, + "optional": true }, { - "name": "currency", + "name": "previous_adj_price_target", "type": "float", - "description": "Value of currency in circulation in billions.", + "description": "Previous adjusted price target.", "default": null, "optional": true }, { - "name": "demand_deposits", + "name": "price_when_posted", "type": "float", - "description": "Value of demand deposits in billions.", + "description": "Price when posted.", "default": null, "optional": true }, { - "name": "retail_money_market_funds", - "type": "float", - "description": "Value of retail money market funds in billions.", + "name": "rating_current", + "type": "str", + "description": "The analyst's rating for the company.", "default": null, "optional": true }, { - "name": "other_liquid_deposits", - "type": "float", - "description": "Value of other liquid deposits in billions.", + "name": "rating_previous", + "type": "str", + "description": "Previous analyst rating for the company.", "default": null, "optional": true }, { - "name": "small_denomination_time_deposits", - "type": "float", - "description": "Value of small denomination time deposits in billions.", + "name": "action", + "type": "str", + "description": "Description of the change in rating from firm's last rating.", "default": null, "optional": true } ], - "federal_reserve": [] - }, - "model": "MoneyMeasures" - }, - "/economy/unemployment": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get global unemployment data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.unemployment(provider='oecd')\nobb.economy.unemployment(country=all, frequency=quarterly, provider='oecd')\n# Demographics for the statistics are selected with the `age` parameter.\nobb.economy.unemployment(country=all, frequency=quarterly, age=25-54, provider='oecd')\n```\n\n", - "parameters": { - "standard": [ + "benzinga": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "action", + "type": "Literal['Downgrades', 'Maintains', 'Reinstates', 'Reiterates', 'Upgrades', 'Assumes', 'Initiates Coverage On', 'Terminates Coverage On', 'Removes', 'Suspends', 'Firm Dissolved']", + "description": "Description of the change in rating from firm's last rating.Note that all of these terms are precisely defined.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "action_change", + "type": "Literal['Announces', 'Maintains', 'Lowers', 'Raises', 'Removes', 'Adjusts']", + "description": "Description of the change in price target from firm's last price target.", "default": null, "optional": true }, { - "name": "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", + "name": "importance", + "type": "Literal[0, 1, 2, 3, 4, 5]", + "description": "Subjective Basis of How Important Event is to Market. 5 = High", + "default": null, + "optional": true + }, + { + "name": "notes", + "type": "str", + "description": "Notes of the price target.", + "default": null, + "optional": true + }, + { + "name": "analyst_id", + "type": "str", + "description": "Id of the analyst.", + "default": null, + "optional": true + }, + { + "name": "url_news", + "type": "str", + "description": "URL for analyst ratings news articles for this ticker on Benzinga.com.", + "default": null, + "optional": true + }, + { + "name": "url_analyst", + "type": "str", + "description": "URL for analyst ratings page for this ticker on Benzinga.com.", + "default": null, + "optional": true + }, + { + "name": "id", + "type": "str", + "description": "Unique ID of this entry.", + "default": null, + "optional": true + }, + { + "name": "last_updated", + "type": "datetime", + "description": "Last updated timestamp, UTC.", + "default": null, "optional": true } ], - "oecd": [ + "fmp": [ { - "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", + "name": "news_url", + "type": "str", + "description": "News URL of the price target.", + "default": null, "optional": true }, { - "name": "sex", - "type": "Literal['total', 'male', 'female']", - "description": "Sex to get unemployment for.", - "default": "total", + "name": "news_title", + "type": "str", + "description": "News title of the price target.", + "default": null, "optional": true }, { - "name": "frequency", - "type": "Literal['monthly', 'quarterly', 'annual']", - "description": "Frequency to get unemployment for.", - "default": "monthly", + "name": "news_publisher", + "type": "str", + "description": "News publisher of the price target.", + "default": null, "optional": true }, { - "name": "age", - "type": "Literal['total', '15-24', '15-64', '25-54', '55-64']", - "description": "Age group to get unemployment for. Total indicates 15 years or over", - "default": "total", + "name": "news_base_url", + "type": "str", + "description": "News base URL of the price target.", + "default": null, "optional": true + } + ] + }, + "model": "PriceTarget" + }, + "/equity/estimates/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical analyst estimates for earnings and revenue.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.historical(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false }, { - "name": "seasonal_adjustment", - "type": "bool", - "description": "Whether to get seasonally adjusted unemployment. Defaults to False.", - "default": false, + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": null, "optional": true } ] @@ -5327,12 +5319,12 @@ "OBBject": [ { "name": "results", - "type": "List[Unemployment]", + "type": "List[AnalystEstimates]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['oecd']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -5355,187 +5347,210 @@ "data": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "value", - "type": "float", - "description": "Unemployment rate (given as a whole number, i.e 10=10%)", + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "estimated_revenue_low", + "type": "int", + "description": "Estimated revenue low.", "default": null, "optional": true }, { - "name": "country", - "type": "str", - "description": "Country for which unemployment rate is given", + "name": "estimated_revenue_high", + "type": "int", + "description": "Estimated revenue high.", "default": null, "optional": true - } - ], - "oecd": [] - }, - "model": "Unemployment" - }, - "/economy/composite_leading_indicator": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Use the composite leading indicator (CLI).\n\nIt is designed to provide early signals of turning points\nin business cycles showing fluctuation of the economic activity around its long term potential level.\n\nCLIs show short-term economic movements in qualitative rather than quantitative terms.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.composite_leading_indicator(provider='oecd')\nobb.economy.composite_leading_indicator(country=all, provider='oecd')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "estimated_revenue_avg", + "type": "int", + "description": "Estimated revenue average.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "estimated_sga_expense_low", + "type": "int", + "description": "Estimated SGA expense low.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['oecd']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default.", - "default": "oecd", + "name": "estimated_sga_expense_high", + "type": "int", + "description": "Estimated SGA expense high.", + "default": null, "optional": true - } - ], - "oecd": [ + }, { - "name": "country", - "type": "Literal['united_states', 'united_kingdom', 'japan', 'mexico', 'indonesia', 'australia', 'brazil', 'canada', 'italy', 'germany', 'turkey', 'france', 'south_africa', 'south_korea', 'spain', 'india', 'china', 'g7', 'g20', 'all']", - "description": "Country to get GDP for.", - "default": "united_states", + "name": "estimated_sga_expense_avg", + "type": "int", + "description": "Estimated SGA expense average.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[CLI]", - "description": "Serializable results." + "name": "estimated_ebitda_low", + "type": "int", + "description": "Estimated EBITDA low.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['oecd']]", - "description": "Provider name." + "name": "estimated_ebitda_high", + "type": "int", + "description": "Estimated EBITDA high.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "estimated_ebitda_avg", + "type": "int", + "description": "Estimated EBITDA average.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "estimated_ebit_low", + "type": "int", + "description": "Estimated EBIT low.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "estimated_ebit_high", + "type": "int", + "description": "Estimated EBIT high.", + "default": null, + "optional": true + }, { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "estimated_ebit_avg", + "type": "int", + "description": "Estimated EBIT average.", "default": null, "optional": true }, { - "name": "value", + "name": "estimated_net_income_low", + "type": "int", + "description": "Estimated net income low.", + "default": null, + "optional": true + }, + { + "name": "estimated_net_income_high", + "type": "int", + "description": "Estimated net income high.", + "default": null, + "optional": true + }, + { + "name": "estimated_net_income_avg", + "type": "int", + "description": "Estimated net income average.", + "default": null, + "optional": true + }, + { + "name": "estimated_eps_avg", "type": "float", - "description": "CLI value", + "description": "Estimated EPS average.", "default": null, "optional": true }, { - "name": "country", - "type": "str", - "description": "Country for which CLI is given", + "name": "estimated_eps_high", + "type": "float", + "description": "Estimated EPS high.", + "default": null, + "optional": true + }, + { + "name": "estimated_eps_low", + "type": "float", + "description": "Estimated EPS low.", + "default": null, + "optional": true + }, + { + "name": "number_analyst_estimated_revenue", + "type": "int", + "description": "Number of analysts who estimated revenue.", + "default": null, + "optional": true + }, + { + "name": "number_analysts_estimated_eps", + "type": "int", + "description": "Number of analysts who estimated EPS.", "default": null, "optional": true } ], - "oecd": [] + "fmp": [] }, - "model": "CLI" + "model": "AnalystEstimates" }, - "/economy/short_term_interest_rate": { + "/equity/estimates/consensus": { "deprecated": { "flag": null, "message": null }, - "description": "Get Short-term interest rates.\n\nThey are the rates at which short-term borrowings are effected between\nfinancial institutions or the rate at which short-term government paper is issued or traded in the market.\n\nShort-term interest rates are generally averages of daily rates, measured as a percentage.\nShort-term interest rates are based on three-month money market rates where available.\nTypical standardised names are \"money market rate\" and \"treasury bill rate\".", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.short_term_interest_rate(provider='oecd')\nobb.economy.short_term_interest_rate(country=all, frequency=quarterly, provider='oecd')\n```\n\n", + "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": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": null, "optional": true }, { "name": "provider", - "type": "Literal['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", + "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 } ], - "oecd": [ - { - "name": "country", - "type": "Literal['belgium', 'ireland', 'mexico', 'indonesia', 'new_zealand', 'japan', 'united_kingdom', 'france', 'chile', 'canada', 'netherlands', 'united_states', 'south_korea', 'norway', 'austria', 'south_africa', 'denmark', 'switzerland', 'hungary', 'luxembourg', 'australia', 'germany', 'sweden', 'iceland', 'turkey', 'greece', 'israel', 'czech_republic', 'latvia', 'slovenia', 'poland', 'estonia', 'lithuania', 'portugal', 'costa_rica', 'slovakia', 'finland', 'spain', 'russia', 'euro_area19', 'colombia', 'italy', 'india', 'china', 'croatia', 'all']", - "description": "Country to get GDP for.", - "default": "united_states", - "optional": true - }, + "fmp": [], + "intrinio": [ { - "name": "frequency", - "type": "Literal['monthly', 'quarterly', 'annual']", - "description": "Frequency to get interest rate for for.", - "default": "monthly", + "name": "industry_group_number", + "type": "int", + "description": "The Zacks industry group number.", + "default": null, "optional": true } - ] + ], + "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[STIR]", + "type": "List[PriceTargetConsensus]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['oecd']]", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", "description": "Provider name." }, { @@ -5558,236 +5573,198 @@ "data": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "The company name", "default": null, "optional": true }, { - "name": "value", + "name": "target_high", "type": "float", - "description": "Interest rate (given as a whole number, i.e 10=10%)", + "description": "High target of the price target consensus.", "default": null, "optional": true }, { - "name": "country", - "type": "str", - "description": "Country for which interest rate is given", - "default": null, - "optional": true - } - ], - "oecd": [] - }, - "model": "STIR" - }, - "/economy/long_term_interest_rate": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get Long-term interest rates that refer to government bonds maturing in ten years.\n\nRates are mainly determined by the price charged by the lender, the risk from the borrower and the\nfall in the capital value. Long-term interest rates are generally averages of daily rates,\nmeasured as a percentage. These interest rates are implied by the prices at which the government bonds are\ntraded on financial markets, not the interest rates at which the loans were issued.\nIn all cases, they refer to bonds whose capital repayment is guaranteed by governments.\nLong-term interest rates are one of the determinants of business investment.\nLow long-term interest rates encourage investment in new equipment and high interest rates discourage it.\nInvestment is, in turn, a major source of economic growth.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.long_term_interest_rate(provider='oecd')\nobb.economy.long_term_interest_rate(country=all, frequency=quarterly, provider='oecd')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "target_low", + "type": "float", + "description": "Low target of the price target consensus.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "target_consensus", + "type": "float", + "description": "Consensus target of the price target consensus.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['oecd']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default.", - "default": "oecd", + "name": "target_median", + "type": "float", + "description": "Median target of the price target consensus.", + "default": null, "optional": true } ], - "oecd": [ + "fmp": [], + "intrinio": [ { - "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", + "name": "standard_deviation", + "type": "float", + "description": "The standard deviation of target price estimates.", + "default": null, "optional": true }, { - "name": "frequency", - "type": "Literal['monthly', 'quarterly', 'annual']", - "description": "Frequency to get interest rate for for.", - "default": "monthly", + "name": "total_anaylsts", + "type": "int", + "description": "The total number of target price estimates in consensus.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[LTIR]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['oecd']]", - "description": "Provider name." + "name": "raised", + "type": "int", + "description": "The number of analysts that have raised their target price estimates.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "lowered", + "type": "int", + "description": "The number of analysts that have lowered their target price estimates.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "most_recent_date", + "type": "date", + "description": "The date of the most recent estimate.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "industry_group_number", + "type": "int", + "description": "The Zacks industry group number.", + "default": null, + "optional": true } - ] - }, - "data": { - "standard": [ + ], + "yfinance": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "recommendation", + "type": "str", + "description": "Recommendation - buy, sell, etc.", "default": null, "optional": true }, { - "name": "value", + "name": "recommendation_mean", "type": "float", - "description": "Interest rate (given as a whole number, i.e 10=10%)", + "description": "Mean recommendation score where 1 is strong buy and 5 is strong sell.", "default": null, "optional": true }, { - "name": "country", + "name": "number_of_analysts", + "type": "int", + "description": "Number of analysts providing opinions.", + "default": null, + "optional": true + }, + { + "name": "current_price", + "type": "float", + "description": "Current price of the stock.", + "default": null, + "optional": true + }, + { + "name": "currency", "type": "str", - "description": "Country for which interest rate is given", + "description": "Currency the stock is priced in.", "default": null, "optional": true } - ], - "oecd": [] + ] }, - "model": "LTIR" + "model": "PriceTargetConsensus" }, - "/economy/fred_regional": { + "/equity/estimates/analyst_search": { "deprecated": { "flag": null, "message": null }, - "description": "Query the Geo Fred API for regional economic data by series group.\n\nThe series group ID is found by using `fred_search` and the `series_id` parameter.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.fred_regional(symbol='NYICLAIMS', provider='fred')\n# With a date, time series data is returned.\nobb.economy.fred_regional(symbol='NYICLAIMS', start_date='2021-01-01', end_date='2021-12-31', limit=10, provider='fred')\n```\n\n", + "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": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "analyst_name", + "type": "Union[str, List[str]]", + "description": "Analyst names to return. Omitting will return all available analysts. Multiple items allowed for provider(s): benzinga.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "firm_name", + "type": "Union[str, List[str]]", + "description": "Firm names to return. Omitting will return all available firms. Multiple items allowed for provider(s): benzinga.", "default": null, "optional": true }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 100000, - "optional": true - }, { "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "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 } ], - "fred": [ - { - "name": "symbol", - "type": "str", - "description": "For this function, it is the series_group ID or series ID. If the symbol provided is for a series_group, set the `is_series_group` parameter to True. Not all series that are in FRED have geographical data.", - "default": "", - "optional": false - }, - { - "name": "is_series_group", - "type": "bool", - "description": "When True, the symbol provided is for a series_group, else it is for a series ID.", - "default": false, - "optional": true - }, + "benzinga": [ { - "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.", + "name": "analyst_ids", + "type": "Union[str, List[str]]", + "description": "List of analyst IDs to return. Multiple items allowed for provider(s): benzinga.", "default": null, "optional": true }, { - "name": "season", - "type": "Literal['SA', 'NSA', 'SSA']", - "description": "The seasonal adjustments to the data. Parameter is only valid when `is_series_group` is True.", - "default": "NSA", - "optional": true - }, - { - "name": "units", - "type": "str", - "description": "The units of the data. This should match the units returned from searching by series ID. An incorrect field will not necessarily return an error. Parameter is only valid when `is_series_group` is True.", + "name": "firm_ids", + "type": "Union[str, List[str]]", + "description": "Firm IDs to return. Multiple items allowed for provider(s): benzinga.", "default": null, "optional": true }, { - "name": "frequency", - "type": "Literal['d', 'w', 'bw', 'm', 'q', 'sa', 'a', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", - "description": "Frequency aggregation to convert high frequency data to lower frequency. Parameter is only valid when `is_series_group` is True. a = Annual sa= Semiannual q = Quarterly m = Monthly w = Weekly d = Daily wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday", - "default": null, + "name": "limit", + "type": "int", + "description": "Number of results returned. Limit 1000.", + "default": 100, "optional": true }, { - "name": "aggregation_method", - "type": "Literal['avg', 'sum', 'eop']", - "description": "A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. Only valid when `is_series_group` is True. avg = Average sum = Sum eop = End of Period", - "default": "avg", + "name": "page", + "type": "int", + "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date.", + "default": 0, "optional": true }, { - "name": "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", + "name": "fields", + "type": "Union[str, List[str]]", + "description": "Fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple items allowed for provider(s): benzinga.", + "default": null, "optional": true } ] @@ -5796,12 +5773,12 @@ "OBBject": [ { "name": "results", - "type": "List[FredRegional]", + "type": "List[AnalystSearch]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fred']]", + "type": "Optional[Literal['benzinga']]", "description": "Provider name." }, { @@ -5824,448 +5801,454 @@ "data": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - } - ], - "fred": [ - { - "name": "region", - "type": "str", - "description": "The name of the region.", - "default": "", - "optional": false + "name": "last_updated", + "type": "datetime", + "description": "Date of the last update.", + "default": null, + "optional": true }, { - "name": "code", - "type": "Union[str, int]", - "description": "The code of the region.", - "default": "", - "optional": false + "name": "firm_name", + "type": "str", + "description": "Firm name of the analyst.", + "default": null, + "optional": true }, { - "name": "value", - "type": "Union[int, float]", - "description": "The obersvation value. The units are defined in the search results by series ID.", + "name": "name_first", + "type": "str", + "description": "Analyst first name.", "default": null, "optional": true }, { - "name": "series_id", + "name": "name_last", "type": "str", - "description": "The individual series ID for the region.", - "default": "", - "optional": false - } - ] - }, - "model": "FredRegional" - }, - "/economy/country_profile": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get a profile of country statistics and economic indicators.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.country_profile(provider='econdb', country='united_kingdom')\n# Enter the country as the full name, or iso code. If `latest` is False, the complete history for each series is returned.\nobb.economy.country_profile(country='united_states,jp', latest=False, provider='econdb')\n```\n\n", - "parameters": { - "standard": [ + "description": "Analyst last name.", + "default": null, + "optional": true + }, { - "name": "country", - "type": "Union[str, List[str]]", - "description": "The country to get data. Multiple items allowed for provider(s): econdb.", + "name": "name_full", + "type": "str", + "description": "Analyst full name.", "default": "", "optional": false - }, - { - "name": "provider", - "type": "Literal['econdb']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'econdb' if there is no default.", - "default": "econdb", - "optional": true } ], - "econdb": [ + "benzinga": [ { - "name": "latest", - "type": "bool", - "description": "If True, return only the latest data. If False, return all available data for each indicator.", - "default": true, + "name": "analyst_id", + "type": "str", + "description": "ID of the analyst.", + "default": null, "optional": true }, { - "name": "use_cache", - "type": "bool", - "description": "If True, the request will be cached for one day.Using cache is recommended to avoid needlessly requesting the same data.", - "default": true, + "name": "firm_id", + "type": "str", + "description": "ID of the analyst firm.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[CountryProfile]", - "description": "Serializable results." + "name": "smart_score", + "type": "float", + "description": "A weighted average of the total_ratings_percentile, overall_avg_return_percentile, and overall_success_rate", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['econdb']]", - "description": "Provider name." + "name": "overall_success_rate", + "type": "float", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain overall.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "overall_avg_return_percentile", + "type": "float", + "description": "The percentile (normalized) of this analyst's overall average return per rating in comparison to other analysts' overall average returns per rating.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "total_ratings_percentile", + "type": "float", + "description": "The percentile (normalized) of this analyst's total number of ratings in comparison to the total number of ratings published by all other analysts", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "total_ratings", + "type": "int", + "description": "Number of recommendations made by this analyst.", + "default": null, + "optional": true + }, { - "name": "country", - "type": "str", - "description": "", - "default": "", - "optional": false + "name": "overall_gain_count", + "type": "int", + "description": "The number of ratings that have gained value since the date of recommendation", + "default": null, + "optional": true }, { - "name": "population", + "name": "overall_loss_count", "type": "int", - "description": "Population.", + "description": "The number of ratings that have lost value since the date of recommendation", "default": null, "optional": true }, { - "name": "gdp_usd", + "name": "overall_average_return", "type": "float", - "description": "Gross Domestic Product, in billions of USD.", + "description": "The average percent (normalized) price difference per rating since the date of recommendation", "default": null, "optional": true }, { - "name": "gdp_qoq", + "name": "overall_std_dev", "type": "float", - "description": "GDP growth quarter-over-quarter change, as a normalized percent.", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings since the date of recommendation", "default": null, "optional": true }, { - "name": "gdp_yoy", - "type": "float", - "description": "GDP growth year-over-year change, as a normalized percent.", + "name": "gain_count_1m", + "type": "int", + "description": "The number of ratings that have gained value over the last month", "default": null, "optional": true }, { - "name": "cpi_yoy", - "type": "float", - "description": "Consumer Price Index year-over-year change, as a normalized percent.", + "name": "loss_count_1m", + "type": "int", + "description": "The number of ratings that have lost value over the last month", "default": null, "optional": true }, { - "name": "core_yoy", + "name": "average_return_1m", "type": "float", - "description": "Core Consumer Price Index year-over-year change, as a normalized percent.", + "description": "The average percent (normalized) price difference per rating over the last month", "default": null, "optional": true }, { - "name": "retail_sales_yoy", + "name": "std_dev_1m", "type": "float", - "description": "Retail Sales year-over-year change, as a normalized percent.", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last month", "default": null, "optional": true }, { - "name": "industrial_production_yoy", + "name": "smart_score_1m", "type": "float", - "description": "Industrial Production year-over-year change, as a normalized percent.", + "description": "A weighted average smart score over the last month.", "default": null, "optional": true }, { - "name": "policy_rate", + "name": "success_rate_1m", "type": "float", - "description": "Short term policy rate, as a normalized percent.", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last month", "default": null, "optional": true }, { - "name": "yield_10y", - "type": "float", - "description": "10-year government bond yield, as a normalized percent.", + "name": "gain_count_3m", + "type": "int", + "description": "The number of ratings that have gained value over the last 3 months", "default": null, "optional": true }, { - "name": "govt_debt_gdp", - "type": "float", - "description": "Government debt as a percent (normalized) of GDP.", + "name": "loss_count_3m", + "type": "int", + "description": "The number of ratings that have lost value over the last 3 months", "default": null, "optional": true }, { - "name": "current_account_gdp", + "name": "average_return_3m", "type": "float", - "description": "Current account balance as a percent (normalized) of GDP.", + "description": "The average percent (normalized) price difference per rating over the last 3 months", "default": null, "optional": true }, { - "name": "jobless_rate", + "name": "std_dev_3m", "type": "float", - "description": "Unemployment rate, as a normalized percent.", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 months", "default": null, "optional": true - } - ], - "econdb": [] - }, - "model": "CountryProfile" - }, - "/economy/available_indicators": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the available economic indicators for a provider.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.available_indicators(provider='econdb')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "provider", - "type": "Literal['econdb']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'econdb' if there is no default.", - "default": "econdb", + "name": "smart_score_3m", + "type": "float", + "description": "A weighted average smart score over the last 3 months.", + "default": null, "optional": true - } - ], - "econdb": [ + }, { - "name": "use_cache", - "type": "bool", - "description": "Whether to use cache or not, by default is True The cache of indicator symbols will persist for one week.", - "default": true, + "name": "success_rate_3m", + "type": "float", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 months", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[AvailableIndicators]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['econdb']]", - "description": "Provider name." + "name": "gain_count_6m", + "type": "int", + "description": "The number of ratings that have gained value over the last 6 months", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "loss_count_6m", + "type": "int", + "description": "The number of ratings that have lost value over the last 6 months", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "average_return_6m", + "type": "float", + "description": "The average percent (normalized) price difference per rating over the last 6 months", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "std_dev_6m", + "type": "float", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 6 months", + "default": null, + "optional": true + }, { - "name": "symbol_root", - "type": "str", - "description": "The root symbol representing the indicator.", + "name": "gain_count_9m", + "type": "int", + "description": "The number of ratings that have gained value over the last 9 months", "default": null, "optional": true }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data. The root symbol with additional codes.", + "name": "loss_count_9m", + "type": "int", + "description": "The number of ratings that have lost value over the last 9 months", "default": null, "optional": true }, { - "name": "country", - "type": "str", - "description": "The name of the country, region, or entity represented by the symbol.", + "name": "average_return_9m", + "type": "float", + "description": "The average percent (normalized) price difference per rating over the last 9 months", "default": null, "optional": true }, { - "name": "iso", - "type": "str", - "description": "The ISO code of the country, region, or entity represented by the symbol.", + "name": "std_dev_9m", + "type": "float", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 9 months", "default": null, "optional": true }, { - "name": "description", - "type": "str", - "description": "The description of the indicator.", + "name": "smart_score_9m", + "type": "float", + "description": "A weighted average smart score over the last 9 months.", "default": null, "optional": true }, { - "name": "frequency", - "type": "str", - "description": "The frequency of the indicator data.", + "name": "success_rate_9m", + "type": "float", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 9 months", "default": null, "optional": true - } - ], - "econdb": [ + }, { - "name": "currency", - "type": "str", - "description": "The currency, or unit, the data is based in.", + "name": "gain_count_1y", + "type": "int", + "description": "The number of ratings that have gained value over the last 1 year", "default": null, "optional": true }, { - "name": "scale", - "type": "str", - "description": "The scale of the data.", + "name": "loss_count_1y", + "type": "int", + "description": "The number of ratings that have lost value over the last 1 year", "default": null, "optional": true }, { - "name": "multiplier", + "name": "average_return_1y", + "type": "float", + "description": "The average percent (normalized) price difference per rating over the last 1 year", + "default": null, + "optional": true + }, + { + "name": "std_dev_1y", + "type": "float", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 1 year", + "default": null, + "optional": true + }, + { + "name": "smart_score_1y", + "type": "float", + "description": "A weighted average smart score over the last 1 year.", + "default": null, + "optional": true + }, + { + "name": "success_rate_1y", + "type": "float", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 1 year", + "default": null, + "optional": true + }, + { + "name": "gain_count_2y", "type": "int", - "description": "The multiplier of the data to arrive at whole units.", - "default": "", - "optional": false + "description": "The number of ratings that have gained value over the last 2 years", + "default": null, + "optional": true }, { - "name": "transformation", - "type": "str", - "description": "Transformation type.", - "default": "", - "optional": false + "name": "loss_count_2y", + "type": "int", + "description": "The number of ratings that have lost value over the last 2 years", + "default": null, + "optional": true }, { - "name": "source", - "type": "str", - "description": "The original source of the data.", + "name": "average_return_2y", + "type": "float", + "description": "The average percent (normalized) price difference per rating over the last 2 years", "default": null, "optional": true }, { - "name": "first_date", - "type": "date", - "description": "The first date of the data.", + "name": "std_dev_2y", + "type": "float", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 2 years", "default": null, "optional": true }, { - "name": "last_date", - "type": "date", - "description": "The last date of the data.", + "name": "smart_score_2y", + "type": "float", + "description": "A weighted average smart score over the last 3 years.", "default": null, "optional": true }, { - "name": "last_insert_timestamp", - "type": "datetime", - "description": "The time of the last update. Data is typically reported with a lag.", + "name": "success_rate_2y", + "type": "float", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 2 years", + "default": null, + "optional": true + }, + { + "name": "gain_count_3y", + "type": "int", + "description": "The number of ratings that have gained value over the last 3 years", + "default": null, + "optional": true + }, + { + "name": "loss_count_3y", + "type": "int", + "description": "The number of ratings that have lost value over the last 3 years", + "default": null, + "optional": true + }, + { + "name": "average_return_3y", + "type": "float", + "description": "The average percent (normalized) price difference per rating over the last 3 years", + "default": null, + "optional": true + }, + { + "name": "std_dev_3y", + "type": "float", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 years", + "default": null, + "optional": true + }, + { + "name": "smart_score_3y", + "type": "float", + "description": "A weighted average smart score over the last 3 years.", + "default": null, + "optional": true + }, + { + "name": "success_rate_3y", + "type": "float", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 years", "default": null, "optional": true } ] }, - "model": "AvailableIndicators" + "model": "AnalystSearch" }, - "/economy/indicators": { + "/equity/estimates/forward_sales": { "deprecated": { "flag": null, "message": null }, - "description": "Get economic indicators by country and indicator.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.indicators(provider='econdb', symbol='PCOCO')\n# Enter the country as the full name, or iso code. Use `available_indicators()` to get a list of supported indicators from EconDB.\nobb.economy.indicators(symbol='CPI', country='united_states,jp', provider='econdb')\n# Use the `main` symbol to get the group of main indicators for a country.\nobb.economy.indicators(provider='econdb', symbol='main', country='eu')\n```\n\n", + "description": "Get forward sales estimates.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.forward_sales(symbol='AAPL', provider='intrinio')\nobb.equity.estimates.forward_sales(fiscal_year=2025, fiscal_period=fy, provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, List[str]]", - "description": "Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Multiple items allowed for provider(s): econdb.", - "default": "", - "optional": false - }, - { - "name": "country", - "type": "Union[str, List[str]]", - "description": "The country to get data. The country represented by the indicator, if available. Multiple items allowed for provider(s): econdb.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", "default": null, "optional": true }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", "optional": true - }, + } + ], + "intrinio": [ { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "fiscal_year", + "type": "int", + "description": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['econdb']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'econdb' if there is no default.", - "default": "econdb", - "optional": true - } - ], - "econdb": [ - { - "name": "transform", - "type": "Literal['toya', 'tpop', 'tusd', 'tpgp']", - "description": "The transformation to apply to the data, default is None. tpop: Change from previous period toya: Change from one year ago tusd: Values as US dollars tpgp: Values as a percent of GDP Only 'tpop' and 'toya' are applicable to all indicators. Applying transformations across multiple indicators/countries may produce unexpected results. This is because not all indicators are compatible with all transformations, and the original units and scale differ between entities. `tusd` should only be used where values are currencies.", + "name": "fiscal_period", + "type": "Literal['fy', 'q1', 'q2', 'q3', 'q4']", + "description": "The future fiscal period to retrieve estimates for.", "default": null, "optional": true }, { - "name": "frequency", - "type": "Literal['annual', 'quarter', 'month']", - "description": "The frequency of the data, default is 'quarter'. Only valid when 'symbol' is 'main'.", - "default": "quarter", + "name": "calendar_year", + "type": "int", + "description": "The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", + "default": null, "optional": true }, { - "name": "use_cache", - "type": "bool", - "description": "If True, the request will be cached for one day. Using cache is recommended to avoid needlessly requesting the same data.", - "default": true, + "name": "calendar_period", + "type": "Literal['q1', 'q2', 'q3', 'q4']", + "description": "The future calendar period to retrieve estimates for.", + "default": null, "optional": true } ] @@ -6274,12 +6257,12 @@ "OBBject": [ { "name": "results", - "type": "List[EconomicIndicators]", + "type": "List[ForwardSalesEstimates]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['econdb']]", + "type": "Optional[Literal['intrinio']]", "description": "Provider name." }, { @@ -6302,126 +6285,239 @@ "data": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "symbol_root", + "name": "name", "type": "str", - "description": "The root symbol for the indicator (e.g. GDP).", + "description": "Name of the entity.", "default": null, "optional": true }, { - "name": "symbol", + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "fiscal_year", + "type": "int", + "description": "Fiscal year for the estimate.", + "default": null, + "optional": true + }, + { + "name": "fiscal_period", "type": "str", - "description": "Symbol representing the entity requested in the data.", + "description": "Fiscal quarter for the estimate.", "default": null, "optional": true }, { - "name": "country", + "name": "calendar_year", + "type": "int", + "description": "Calendar year for the estimate.", + "default": null, + "optional": true + }, + { + "name": "calendar_period", "type": "str", - "description": "The country represented by the data.", + "description": "Calendar quarter for the estimate.", "default": null, "optional": true }, { - "name": "value", - "type": "Union[int, float]", - "description": "", + "name": "low_estimate", + "type": "int", + "description": "The sales estimate low for the period.", + "default": null, + "optional": true + }, + { + "name": "high_estimate", + "type": "int", + "description": "The sales estimate high for the period.", + "default": null, + "optional": true + }, + { + "name": "mean", + "type": "int", + "description": "The sales estimate mean for the period.", + "default": null, + "optional": true + }, + { + "name": "median", + "type": "int", + "description": "The sales estimate median for the period.", + "default": null, + "optional": true + }, + { + "name": "standard_deviation", + "type": "int", + "description": "The sales estimate standard deviation for the period.", + "default": null, + "optional": true + }, + { + "name": "number_of_analysts", + "type": "int", + "description": "Number of analysts providing estimates for the period.", "default": null, "optional": true } ], - "econdb": [] + "intrinio": [ + { + "name": "revisions_1w_up", + "type": "int", + "description": "Number of revisions up in the last week.", + "default": null, + "optional": true + }, + { + "name": "revisions_1w_down", + "type": "int", + "description": "Number of revisions down in the last week.", + "default": null, + "optional": true + }, + { + "name": "revisions_1w_change_percent", + "type": "float", + "description": "The analyst revisions percent change in estimate for the period of 1 week.", + "default": null, + "optional": true + }, + { + "name": "revisions_1m_up", + "type": "int", + "description": "Number of revisions up in the last month.", + "default": null, + "optional": true + }, + { + "name": "revisions_1m_down", + "type": "int", + "description": "Number of revisions down in the last month.", + "default": null, + "optional": true + }, + { + "name": "revisions_1m_change_percent", + "type": "float", + "description": "The analyst revisions percent change in estimate for the period of 1 month.", + "default": null, + "optional": true + }, + { + "name": "revisions_3m_up", + "type": "int", + "description": "Number of revisions up in the last 3 months.", + "default": null, + "optional": true + }, + { + "name": "revisions_3m_down", + "type": "int", + "description": "Number of revisions down in the last 3 months.", + "default": null, + "optional": true + }, + { + "name": "revisions_3m_change_percent", + "type": "float", + "description": "The analyst revisions percent change in estimate for the period of 3 months.", + "default": null, + "optional": true + } + ] }, - "model": "EconomicIndicators" + "model": "ForwardSalesEstimates" }, - "/equity/calendar/ipo": { + "/equity/estimates/forward_eps": { "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')\nobb.equity.calendar.ipo(limit=100, provider='nasdaq')\n# Get all IPOs available.\nobb.equity.calendar.ipo(provider='intrinio')\n# Get IPOs for specific dates.\nobb.equity.calendar.ipo(start_date='2024-02-01', end_date='2024-02-07', provider='nasdaq')\n```\n\n", + "description": "Get forward EPS estimates.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.forward_eps(symbol='AAPL', provider='intrinio')\nobb.equity.estimates.forward_eps(fiscal_year=2025, fiscal_period=fy, provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", "default": null, "optional": true }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, + "name": "provider", + "type": "Literal['fmp', 'intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, + "name": "fiscal_period", + "type": "Literal['annual', 'quarter']", + "description": "The future fiscal period to retrieve estimates for.", + "default": "annual", "optional": true }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", - "default": 100, + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['intrinio', 'nasdaq']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", + "name": "include_historical", + "type": "bool", + "description": "If True, the data will include all past data and the limit will be ignored.", + "default": false, "optional": true } ], "intrinio": [ { - "name": "status", - "type": "Literal['upcoming', 'priced', 'withdrawn']", - "description": "Status of the IPO. [upcoming, priced, or withdrawn]", + "name": "fiscal_year", + "type": "int", + "description": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", "default": null, "optional": true }, { - "name": "min_value", - "type": "int", - "description": "Return IPOs with an offer dollar amount greater than the given amount.", + "name": "fiscal_period", + "type": "Literal['fy', 'q1', 'q2', 'q3', 'q4']", + "description": "The future fiscal period to retrieve estimates for.", "default": null, "optional": true }, { - "name": "max_value", + "name": "calendar_year", "type": "int", - "description": "Return IPOs with an offer dollar amount less than the given amount.", + "description": "The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", "default": null, "optional": true - } - ], - "nasdaq": [ - { - "name": "status", - "type": "Literal['upcoming', 'priced', 'filed', 'withdrawn']", - "description": "The status of the IPO.", - "default": "priced", - "optional": true }, { - "name": "is_spo", - "type": "bool", - "description": "If True, returns data for secondary public offerings (SPOs).", - "default": false, + "name": "calendar_period", + "type": "Literal['q1', 'q2', 'q3', 'q4']", + "description": "The future calendar period to retrieve estimates for.", + "default": null, "optional": true } ] @@ -6430,12 +6526,12 @@ "OBBject": [ { "name": "results", - "type": "List[CalendarIpo]", + "type": "List[ForwardEpsEstimates]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['intrinio', 'nasdaq']]", + "type": "Optional[Literal['fmp', 'intrinio']]", "description": "Provider name." }, { @@ -6461,257 +6557,171 @@ "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", "default": null, "optional": true }, { - "name": "ipo_date", + "name": "date", "type": "date", - "description": "The date of the IPO, when the stock first trades on a major exchange.", - "default": null, - "optional": true - } - ], - "intrinio": [ + "description": "The date of the data.", + "default": "", + "optional": false + }, { - "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.", + "name": "fiscal_year", + "type": "int", + "description": "Fiscal year for the estimate.", "default": null, "optional": true }, { - "name": "exchange", + "name": "fiscal_period", "type": "str", - "description": "The acronym of the stock exchange that the company is going to trade publicly on. Typically NYSE or NASDAQ.", + "description": "Fiscal quarter for the estimate.", "default": null, "optional": true }, { - "name": "offer_amount", - "type": "float", - "description": "The total dollar amount of shares offered in the IPO. Typically this is share price * share count", + "name": "calendar_year", + "type": "int", + "description": "Calendar year for the estimate.", "default": null, "optional": true }, { - "name": "share_price", - "type": "float", - "description": "The price per share at which the IPO was offered.", + "name": "calendar_period", + "type": "str", + "description": "Calendar quarter for the estimate.", "default": null, "optional": true }, { - "name": "share_price_lowest", + "name": "low_estimate", "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).", + "description": "Estimated EPS low for the period.", "default": null, "optional": true }, { - "name": "share_price_highest", + "name": "high_estimate", "type": "float", - "description": "The expected highest price per share at which the IPO will be offered. Before an IPO is priced, companies typically provide a range of prices per share at which they expect to offer the IPO (typically available for upcoming IPOs).", - "default": null, - "optional": true - }, - { - "name": "share_count", - "type": "int", - "description": "The number of shares offered in the IPO.", - "default": null, - "optional": true - }, - { - "name": "share_count_lowest", - "type": "int", - "description": "The expected lowest number of shares that will be offered in the IPO. Before an IPO is priced, companies typically provide a range of shares that they expect to offer in the IPO (typically available for upcoming IPOs).", - "default": null, - "optional": true - }, - { - "name": "share_count_highest", - "type": "int", - "description": "The expected highest number of shares that will be offered in the IPO. Before an IPO is priced, companies typically provide a range of shares that they expect to offer in the IPO (typically available for upcoming IPOs).", - "default": null, - "optional": true - }, - { - "name": "announcement_url", - "type": "str", - "description": "The URL to the company's announcement of the IPO", + "description": "Estimated EPS high for the period.", "default": null, "optional": true }, { - "name": "sec_report_url", - "type": "str", - "description": "The URL to the company's S-1, S-1/A, F-1, or F-1/A SEC filing, which is required to be filed before an IPO takes place.", + "name": "mean", + "type": "float", + "description": "Estimated EPS mean for the period.", "default": null, "optional": true }, { - "name": "open_price", + "name": "median", "type": "float", - "description": "The opening price at the beginning of the first trading day (only available for priced IPOs).", + "description": "Estimated EPS median for the period.", "default": null, "optional": true }, { - "name": "close_price", + "name": "standard_deviation", "type": "float", - "description": "The closing price at the end of the first trading day (only available for priced IPOs).", + "description": "Estimated EPS standard deviation for the period.", "default": null, "optional": true }, { - "name": "volume", + "name": "number_of_analysts", "type": "int", - "description": "The volume at the end of the first trading day (only available for priced IPOs).", + "description": "Number of analysts providing estimates for the period.", "default": null, "optional": true - }, + } + ], + "fmp": [], + "intrinio": [ { - "name": "day_change", + "name": "revisions_change_percent", "type": "float", - "description": "The percentage change between the open price and the close price on the first trading day (only available for priced IPOs).", + "description": "The earnings per share (EPS) percent change in estimate for the period.", "default": null, "optional": true }, { - "name": "week_change", + "name": "mean_1w", "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).", + "description": "The mean estimate for the period one week ago.", "default": null, "optional": true }, { - "name": "month_change", + "name": "mean_1m", "type": "float", - "description": "The percentage change between the open price on the first trading day and the close price approximately a month after the first trading day (only available for priced IPOs).", - "default": null, - "optional": true - }, - { - "name": "id", - "type": "str", - "description": "The Intrinio ID of the IPO.", - "default": null, - "optional": true - }, - { - "name": "company", - "type": "IntrinioCompany", - "description": "The company that is going public via the IPO.", - "default": null, - "optional": true - }, - { - "name": "security", - "type": "IntrinioSecurity", - "description": "The primary Security for the Company that is going public via the IPO", - "default": null, - "optional": true - } - ], - "nasdaq": [ - { - "name": "name", - "type": "str", - "description": "The name of the company.", + "description": "The mean estimate for the period one month ago.", "default": null, "optional": true }, { - "name": "offer_amount", + "name": "mean_2m", "type": "float", - "description": "The dollar value of the shares offered.", - "default": null, - "optional": true - }, - { - "name": "share_count", - "type": "int", - "description": "The number of shares offered.", - "default": null, - "optional": true - }, - { - "name": "expected_price_date", - "type": "date", - "description": "The date the pricing is expected.", - "default": null, - "optional": true - }, - { - "name": "filed_date", - "type": "date", - "description": "The date the IPO was filed.", - "default": null, - "optional": true - }, - { - "name": "withdraw_date", - "type": "date", - "description": "The date the IPO was withdrawn.", + "description": "The mean estimate for the period two months ago.", "default": null, "optional": true }, { - "name": "deal_status", - "type": "str", - "description": "The status of the deal.", + "name": "mean_3m", + "type": "float", + "description": "The mean estimate for the period three months ago.", "default": null, "optional": true } ] }, - "model": "CalendarIpo" + "model": "ForwardEpsEstimates" }, - "/equity/calendar/dividend": { + "/equity/discovery/gainers": { "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# Get dividend calendar for specific dates.\nobb.equity.calendar.dividend(start_date='2024-02-01', end_date='2024-02-07', provider='nasdaq')\n```\n\n", + "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": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", "optional": true }, { "name": "provider", - "type": "Literal['fmp', 'nasdaq']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "type": "Literal['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 } ], - "fmp": [], - "nasdaq": [] + "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[CalendarDividend]", + "type": "List[EquityGainers]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'nasdaq']]", + "type": "Optional[Literal['yfinance']]", "description": "Provider name." }, { @@ -6733,13 +6743,6 @@ }, "data": { "standard": [ - { - "name": "ex_dividend_date", - "type": "date", - "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", - "default": "", - "optional": false - }, { "name": "symbol", "type": "str", @@ -6747,113 +6750,104 @@ "default": "", "optional": false }, - { - "name": "amount", - "type": "float", - "description": "The dividend amount per share.", - "default": null, - "optional": true - }, { "name": "name", "type": "str", "description": "Name of the entity.", - "default": null, - "optional": true + "default": "", + "optional": false }, { - "name": "record_date", - "type": "date", - "description": "The record date of ownership for eligibility.", - "default": null, - "optional": true + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false }, { - "name": "payment_date", - "type": "date", - "description": "The payment date of the dividend.", - "default": null, - "optional": true + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false }, { - "name": "declaration_date", - "type": "date", - "description": "Declaration date of the dividend.", - "default": null, - "optional": true + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false } ], - "fmp": [ + "yfinance": [ { - "name": "adjusted_amount", + "name": "market_cap", "type": "float", - "description": "The adjusted-dividend amount.", - "default": null, - "optional": true + "description": "Market Cap.", + "default": "", + "optional": false }, { - "name": "label", - "type": "str", - "description": "Ex-dividend date formatted for display.", - "default": null, - "optional": true - } - ], - "nasdaq": [ + "name": "avg_volume_3_months", + "type": "float", + "description": "Average volume over the last 3 months in millions.", + "default": "", + "optional": false + }, { - "name": "annualized_amount", + "name": "pe_ratio_ttm", "type": "float", - "description": "The indicated annualized dividend amount.", + "description": "PE Ratio (TTM).", "default": null, "optional": true } ] }, - "model": "CalendarDividend" + "model": "EquityGainers" }, - "/equity/calendar/splits": { + "/equity/discovery/losers": { "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", + "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": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", "optional": true }, { "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "type": "Literal['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 } ], - "fmp": [] + "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[CalendarSplits]", + "type": "List[EquityLosers]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['yfinance']]", "description": "Provider name." }, { @@ -6876,90 +6870,110 @@ "data": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "label", + "name": "name", "type": "str", - "description": "Label of the stock splits.", + "description": "Name of the entity.", "default": "", "optional": false }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "price", + "type": "float", + "description": "Last price.", "default": "", "optional": false }, { - "name": "numerator", + "name": "change", "type": "float", - "description": "Numerator of the stock splits.", + "description": "Change in price value.", "default": "", "optional": false }, { - "name": "denominator", + "name": "percent_change", "type": "float", - "description": "Denominator of the stock splits.", + "description": "Percent change.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", "default": "", "optional": false } ], - "fmp": [] + "yfinance": [ + { + "name": "market_cap", + "type": "float", + "description": "Market Cap.", + "default": "", + "optional": false + }, + { + "name": "avg_volume_3_months", + "type": "float", + "description": "Average volume over the last 3 months in millions.", + "default": "", + "optional": false + }, + { + "name": "pe_ratio_ttm", + "type": "float", + "description": "PE Ratio (TTM).", + "default": null, + "optional": true + } + ] }, - "model": "CalendarSplits" + "model": "EquityLosers" }, - "/equity/calendar/earnings": { + "/equity/discovery/active": { "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", + "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": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", "optional": true }, { "name": "provider", - "type": "Literal['fmp', 'nasdaq', 'tmx']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "type": "Literal['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 } ], - "fmp": [], - "nasdaq": [], - "tmx": [] + "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[CalendarEarnings]", + "type": "List[EquityActive]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'nasdaq', 'tmx']]", + "type": "Optional[Literal['yfinance']]", "description": "Provider name." }, { @@ -6981,13 +6995,6 @@ }, "data": { "standard": [ - { - "name": "report_date", - "type": "date", - "description": "The date of the earnings report.", - "default": "", - "optional": false - }, { "name": "symbol", "type": "str", @@ -6999,202 +7006,226 @@ "name": "name", "type": "str", "description": "Name of the entity.", - "default": null, - "optional": true + "default": "", + "optional": false }, { - "name": "eps_previous", + "name": "price", "type": "float", - "description": "The earnings-per-share from the same previously reported period.", - "default": null, - "optional": true + "description": "Last price.", + "default": "", + "optional": false }, { - "name": "eps_consensus", + "name": "change", "type": "float", - "description": "The analyst conesus earnings-per-share estimate.", - "default": null, - "optional": true - } - ], - "fmp": [ + "description": "Change in price value.", + "default": "", + "optional": false + }, { - "name": "eps_actual", + "name": "percent_change", "type": "float", - "description": "The actual earnings per share announced.", - "default": null, - "optional": true + "description": "Percent change.", + "default": "", + "optional": false }, { - "name": "revenue_actual", + "name": "volume", "type": "float", - "description": "The actual reported revenue.", - "default": null, - "optional": true + "description": "The trading volume.", + "default": "", + "optional": false + } + ], + "yfinance": [ + { + "name": "market_cap", + "type": "float", + "description": "Market Cap displayed in billions.", + "default": "", + "optional": false }, { - "name": "revenue_consensus", + "name": "avg_volume_3_months", "type": "float", - "description": "The revenue forecast consensus.", - "default": null, - "optional": true + "description": "Average volume over the last 3 months in millions.", + "default": "", + "optional": false }, { - "name": "period_ending", - "type": "date", - "description": "The fiscal period end date.", + "name": "pe_ratio_ttm", + "type": "float", + "description": "PE Ratio (TTM).", "default": null, "optional": true - }, + } + ] + }, + "model": "EquityActive" + }, + "/equity/discovery/undervalued_large_caps": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get potentially undervalued large cap stocks.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.undervalued_large_caps(provider='yfinance')\nobb.equity.discovery.undervalued_large_caps(sort='desc', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ { - "name": "reporting_time", - "type": "str", - "description": "The reporting time - e.g. after market close.", - "default": null, + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", "optional": true }, { - "name": "updated_date", - "type": "date", - "description": "The date the data was updated last.", - "default": null, + "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 } ], - "nasdaq": [ + "yfinance": [] + }, + "returns": { + "OBBject": [ { - "name": "eps_actual", - "type": "float", - "description": "The actual earnings per share (USD) announced.", - "default": null, - "optional": true + "name": "results", + "type": "List[EquityUndervaluedLargeCaps]", + "description": "Serializable results." }, { - "name": "surprise_percent", - "type": "float", - "description": "The earnings surprise as normalized percentage points.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['yfinance']]", + "description": "Provider name." }, { - "name": "num_estimates", - "type": "int", - "description": "The number of analysts providing estimates for the consensus.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "period_ending", - "type": "str", - "description": "The fiscal period end date.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "previous_report_date", - "type": "date", - "description": "The previous report date for the same period last year.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "reporting_time", + "name": "name", "type": "str", - "description": "The reporting time - e.g. after market close.", - "default": null, - "optional": true + "description": "Name of the entity.", + "default": "", + "optional": false }, { - "name": "market_cap", - "type": "int", - "description": "The market cap (USD) of the reporting entity.", - "default": null, - "optional": true - } - ], - "tmx": [ - { - "name": "name", - "type": "str", - "description": "The company's name.", + "name": "price", + "type": "float", + "description": "Last price.", "default": "", "optional": false }, { - "name": "eps_consensus", + "name": "change", "type": "float", - "description": "The consensus estimated EPS in dollars.", - "default": null, - "optional": true + "description": "Change in price value.", + "default": "", + "optional": false }, { - "name": "eps_actual", + "name": "percent_change", "type": "float", - "description": "The actual EPS in dollars.", - "default": null, - "optional": true + "description": "Percent change.", + "default": "", + "optional": false }, { - "name": "eps_surprise", + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false + } + ], + "yfinance": [ + { + "name": "market_cap", "type": "float", - "description": "The EPS surprise in dollars.", + "description": "Market Cap.", "default": null, "optional": true }, { - "name": "surprise_percent", + "name": "avg_volume_3_months", "type": "float", - "description": "The EPS surprise as a normalized percent.", + "description": "Average volume over the last 3 months in millions.", "default": null, "optional": true }, { - "name": "reporting_time", - "type": "str", - "description": "The time of the report - i.e., before or after market.", + "name": "pe_ratio_ttm", + "type": "float", + "description": "PE Ratio (TTM).", "default": null, "optional": true } ] }, - "model": "CalendarEarnings" + "model": "EquityUndervaluedLargeCaps" }, - "/equity/compare/peers": { + "/equity/discovery/undervalued_growth": { "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", + "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": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true }, { "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "type": "Literal['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 } ], - "fmp": [] + "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EquityPeers]", + "type": "List[EquityUndervaluedGrowth]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['yfinance']]", "description": "Provider name." }, { @@ -7217,75 +7248,110 @@ "data": { "standard": [ { - "name": "peers_list", - "type": "List[str]", - "description": "A list of equity peers based on sector, exchange and market cap.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": true + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": "", + "optional": false + }, + { + "name": "change", + "type": "float", + "description": "Change in price value.", + "default": "", + "optional": false + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "float", + "description": "The trading volume.", + "default": "", + "optional": false } ], - "fmp": [] - }, - "model": "EquityPeers" - }, - "/equity/compare/groups": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get company data grouped by sector, industry or country and display either performance or valuation metrics.\n\nValuation metrics include price to earnings, price to book, price to sales ratios and price to cash flow.\nPerformance metrics include the stock price change for different time periods.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.compare.groups(provider='finviz')\n# Group by sector and analyze valuation.\nobb.equity.compare.groups(group='sector', metric='valuation', provider='finviz')\n# Group by industry and analyze performance.\nobb.equity.compare.groups(group='industry', metric='performance', provider='finviz')\n# Group by country and analyze valuation.\nobb.equity.compare.groups(group='country', metric='valuation', provider='finviz')\n```\n\n", - "parameters": { - "standard": [ + "yfinance": [ { - "name": "group", - "type": "str", - "description": "The group to compare - i.e., 'sector', 'industry', 'country'. Choices vary by provider.", + "name": "market_cap", + "type": "float", + "description": "Market Cap.", "default": null, "optional": true }, { - "name": "metric", - "type": "str", - "description": "The type of metrics to compare - i.e, 'valuation', 'performance'. Choices vary by provider.", + "name": "avg_volume_3_months", + "type": "float", + "description": "Average volume over the last 3 months in millions.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['finviz']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default.", - "default": "finviz", + "name": "pe_ratio_ttm", + "type": "float", + "description": "PE Ratio (TTM).", + "default": null, "optional": true } - ], - "finviz": [ + ] + }, + "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": "group", - "type": "Literal['sector', 'industry', 'country', 'capitalization', 'energy', 'materials', 'industrials', 'consumer_cyclical', 'consumer_defensive', 'healthcare', 'financial', 'technology', 'communication_services', 'utilities', 'real_estate']", - "description": "US-listed stocks only. When a sector is selected, it is broken down by industry. The default is sector.", - "default": "sector", + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", "optional": true }, { - "name": "metric", - "type": "Literal['performance', 'valuation', 'overview']", - "description": "Select from: performance, valuation, overview. The default is performance.", - "default": "performance", + "name": "provider", + "type": "Literal['yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default.", + "default": "yfinance", "optional": true } - ] + ], + "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[CompareGroups]", + "type": "List[EquityAggressiveSmallCaps]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['finviz']]", + "type": "Optional[Literal['yfinance']]", "description": "Provider name." }, { @@ -7308,211 +7374,209 @@ "data": { "standard": [ { - "name": "name", + "name": "symbol", "type": "str", - "description": "Name or label of the group.", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false - } - ], - "finviz": [ - { - "name": "stocks", - "type": "int", - "description": "The number of stocks in the group.", - "default": null, - "optional": true }, { - "name": "market_cap", - "type": "int", - "description": "The market cap of the group.", - "default": null, - "optional": true + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false }, { - "name": "performance_1D", + "name": "price", "type": "float", - "description": "The performance in the last day, as a normalized percent.", - "default": null, - "optional": true + "description": "Last price.", + "default": "", + "optional": false }, { - "name": "performance_1W", + "name": "change", "type": "float", - "description": "The performance in the last week, as a normalized percent.", - "default": null, - "optional": true + "description": "Change in price value.", + "default": "", + "optional": false }, { - "name": "performance_1M", + "name": "percent_change", "type": "float", - "description": "The performance in the last month, as a normalized percent.", - "default": null, - "optional": true + "description": "Percent change.", + "default": "", + "optional": false }, { - "name": "performance_3M", + "name": "volume", "type": "float", - "description": "The performance in the last quarter, as a normalized percent.", - "default": null, - "optional": true - }, + "description": "The trading volume.", + "default": "", + "optional": false + } + ], + "yfinance": [ { - "name": "performance_6M", + "name": "market_cap", "type": "float", - "description": "The performance in the last half year, as a normalized percent.", + "description": "Market Cap.", "default": null, "optional": true }, { - "name": "performance_1Y", + "name": "avg_volume_3_months", "type": "float", - "description": "The performance in the last year, as a normalized percent.", + "description": "Average volume over the last 3 months in millions.", "default": null, "optional": true }, { - "name": "performance_YTD", + "name": "pe_ratio_ttm", "type": "float", - "description": "The performance in the year to date, as a normalized percent.", + "description": "PE Ratio (TTM).", "default": null, "optional": true - }, + } + ] + }, + "model": "EquityAggressiveSmallCaps" + }, + "/equity/discovery/growth_tech": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get top tech stocks based on revenue and earnings growth.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.growth_tech(provider='yfinance')\nobb.equity.discovery.growth_tech(sort='desc', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ { - "name": "dividend_yield", - "type": "float", - "description": "The dividend yield of the group, as a normalized percent.", - "default": null, + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", "optional": true }, { - "name": "pe", - "type": "float", - "description": "The P/E ratio of the group.", - "default": null, - "optional": true - }, - { - "name": "forward_pe", - "type": "float", - "description": "The forward P/E ratio of the group.", - "default": null, + "name": "provider", + "type": "Literal['yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default.", + "default": "yfinance", "optional": true + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[GrowthTechEquities]", + "description": "Serializable results." }, { - "name": "peg", - "type": "float", - "description": "The PEG ratio of the group.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['yfinance']]", + "description": "Provider name." }, { - "name": "eps_growth_past_5_years", - "type": "float", - "description": "The EPS growth of the group for the past 5 years, as a normalized percent.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "eps_growth_next_5_years", - "type": "float", - "description": "The estimated EPS growth of the groupo for the next 5 years, as a normalized percent.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity.", + "default": "", + "optional": false }, { - "name": "sales_growth_past_5_years", + "name": "price", "type": "float", - "description": "The sales growth of the group for the past 5 years, as a normalized percent.", - "default": null, - "optional": true + "description": "Last price.", + "default": "", + "optional": false }, { - "name": "float_short", + "name": "change", "type": "float", - "description": "The percent of the float shorted for the group, as a normalized value.", - "default": null, - "optional": true + "description": "Change in price value.", + "default": "", + "optional": false }, { - "name": "analyst_recommendation", + "name": "percent_change", "type": "float", - "description": "The analyst consensus, on a scale of 1-5 where 1 is a buy and 5 is a sell.", - "default": null, - "optional": true + "description": "Percent change.", + "default": "", + "optional": false }, { "name": "volume", - "type": "int", + "type": "float", "description": "The trading volume.", + "default": "", + "optional": false + } + ], + "yfinance": [ + { + "name": "market_cap", + "type": "float", + "description": "Market Cap.", "default": null, "optional": true }, { - "name": "volume_average", - "type": "int", - "description": "The 3-month average volume of the group.", + "name": "avg_volume_3_months", + "type": "float", + "description": "Average volume over the last 3 months in millions.", "default": null, "optional": true }, { - "name": "volume_relative", + "name": "pe_ratio_ttm", "type": "float", - "description": "The relative volume compared to the 3-month average volume.", + "description": "PE Ratio (TTM).", "default": null, "optional": true } ] }, - "model": "CompareGroups" + "model": "GrowthTechEquities" }, - "/equity/estimates/price_target": { + "/equity/discovery/filings": { "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", + "description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more.\n\nSEC filings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114,\nForeign Investment Disclosures and others. The annual 10-K report is required to be\nfiled annually and includes the company's financial statements, management discussion and analysis,\nand audited financial statements.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.filings(provider='fmp')\n# Get filings for the year 2023, limited to 100 results\nobb.equity.discovery.filings(start_date='2023-01-01', end_date='2023-12-31', limit=100, provider='fmp')\n```\n\n", "parameters": { "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga, finviz, fmp.", - "default": null, - "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 200, - "optional": true - }, - { - "name": "provider", - "type": "Literal['benzinga', 'finviz', 'fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default.", - "default": "benzinga", - "optional": true - } - ], - "benzinga": [ - { - "name": "page", - "type": "int", - "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. Used in conjunction with the limit and date parameters.", - "default": 0, - "optional": true - }, - { - "name": "date", - "type": "Union[date, str]", - "description": "Date for calendar data, shorthand for date_from and date_to.", - "default": null, - "optional": true - }, { "name": "start_date", "type": "Union[date, str]", @@ -7528,55 +7592,33 @@ "optional": true }, { - "name": "updated", - "type": "Union[date, int]", - "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. The date can be a date string or a Unix timestamp. The date string must be in the format of YYYY-MM-DD.", + "name": "form_type", + "type": "str", + "description": "Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types.", "default": null, "optional": true }, { - "name": "importance", + "name": "limit", "type": "int", - "description": "Importance level to filter by. Uses Greater Than or Equal To the importance indicated", - "default": null, - "optional": true - }, - { - "name": "action", - "type": "Literal['downgrades', 'maintains', 'reinstates', 'reiterates', 'upgrades', 'assumes', 'initiates', 'terminates', 'removes', 'suspends', 'firm_dissolved']", - "description": "Filter by a specific action_company.", - "default": null, - "optional": true - }, - { - "name": "analyst_ids", - "type": "Union[List[str], str]", - "description": "Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts.", - "default": null, - "optional": true - }, - { - "name": "firm_ids", - "type": "Union[List[str], str]", - "description": "Comma-separated list of firm IDs.", - "default": null, + "description": "The number of data entries to return.", + "default": 100, "optional": true }, { - "name": "fields", - "type": "Union[List[str], str]", - "description": "Comma-separated list of fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields.", - "default": null, + "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 } ], - "finviz": [], "fmp": [ { - "name": "with_grade", + "name": "is_done", "type": "bool", - "description": "Include upgrades and downgrades in the response.", - "default": false, + "description": "Flag for whether or not the filing is done.", + "default": null, "optional": true } ] @@ -7585,12 +7627,12 @@ "OBBject": [ { "name": "results", - "type": "List[PriceTarget]", + "type": "List[DiscoveryFilings]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['benzinga', 'finviz', 'fmp']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -7612,20 +7654,6 @@ }, "data": { "standard": [ - { - "name": "published_date", - "type": "Union[date, datetime]", - "description": "Published date of the price target.", - "default": "", - "optional": false - }, - { - "name": "published_time", - "type": "datetime.time", - "description": "Time of the original rating, UTC.", - "default": null, - "optional": true - }, { "name": "symbol", "type": "str", @@ -7634,218 +7662,52 @@ "optional": false }, { - "name": "exchange", + "name": "cik", "type": "str", - "description": "Exchange where the company is traded.", - "default": null, - "optional": true + "description": "Central Index Key (CIK) for the requested entity.", + "default": "", + "optional": false }, { - "name": "company_name", + "name": "title", "type": "str", - "description": "Name of company that is the subject of rating.", - "default": null, - "optional": true + "description": "Title of the filing.", + "default": "", + "optional": false }, { - "name": "analyst_name", - "type": "str", - "description": "Analyst name.", - "default": null, - "optional": true + "name": "date", + "type": "datetime", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "analyst_firm", + "name": "form_type", "type": "str", - "description": "Name of the analyst firm that published the price target.", - "default": null, - "optional": true + "description": "The form type of the filing", + "default": "", + "optional": false }, { - "name": "currency", + "name": "link", "type": "str", - "description": "Currency the data is denominated in.", - "default": null, - "optional": true - }, - { - "name": "price_target", - "type": "float", - "description": "The current price target.", - "default": null, - "optional": true - }, - { - "name": "adj_price_target", - "type": "float", - "description": "Adjusted price target for splits and stock dividends.", - "default": null, - "optional": true - }, - { - "name": "price_target_previous", - "type": "float", - "description": "Previous price target.", - "default": null, - "optional": true - }, - { - "name": "previous_adj_price_target", - "type": "float", - "description": "Previous adjusted price target.", - "default": null, - "optional": true - }, - { - "name": "price_when_posted", - "type": "float", - "description": "Price when posted.", - "default": null, - "optional": true - }, - { - "name": "rating_current", - "type": "str", - "description": "The analyst's rating for the company.", - "default": null, - "optional": true - }, - { - "name": "rating_previous", - "type": "str", - "description": "Previous analyst rating for the company.", - "default": null, - "optional": true - }, - { - "name": "action", - "type": "str", - "description": "Description of the change in rating from firm's last rating.", - "default": null, - "optional": true - } - ], - "benzinga": [ - { - "name": "action", - "type": "Literal['Downgrades', 'Maintains', 'Reinstates', 'Reiterates', 'Upgrades', 'Assumes', 'Initiates Coverage On', 'Terminates Coverage On', 'Removes', 'Suspends', 'Firm Dissolved']", - "description": "Description of the change in rating from firm's last rating.Note that all of these terms are precisely defined.", - "default": null, - "optional": true - }, - { - "name": "action_change", - "type": "Literal['Announces', 'Maintains', 'Lowers', 'Raises', 'Removes', 'Adjusts']", - "description": "Description of the change in price target from firm's last price target.", - "default": null, - "optional": true - }, - { - "name": "importance", - "type": "Literal[0, 1, 2, 3, 4, 5]", - "description": "Subjective Basis of How Important Event is to Market. 5 = High", - "default": null, - "optional": true - }, - { - "name": "notes", - "type": "str", - "description": "Notes of the price target.", - "default": null, - "optional": true - }, - { - "name": "analyst_id", - "type": "str", - "description": "Id of the analyst.", - "default": null, - "optional": true - }, - { - "name": "url_news", - "type": "str", - "description": "URL for analyst ratings news articles for this ticker on Benzinga.com.", - "default": null, - "optional": true - }, - { - "name": "url_analyst", - "type": "str", - "description": "URL for analyst ratings page for this ticker on Benzinga.com.", - "default": null, - "optional": true - }, - { - "name": "id", - "type": "str", - "description": "Unique ID of this entry.", - "default": null, - "optional": true - }, - { - "name": "last_updated", - "type": "datetime", - "description": "Last updated timestamp, UTC.", - "default": null, - "optional": true - } - ], - "finviz": [ - { - "name": "status", - "type": "str", - "description": "The action taken by the firm. This could be 'Upgrade', 'Downgrade', 'Reiterated', etc.", - "default": null, - "optional": true - }, - { - "name": "rating_change", - "type": "str", - "description": "The rating given by the analyst. This could be 'Buy', 'Sell', 'Underweight', etc. If the rating is a revision, the change is indicated by '->'", - "default": null, - "optional": true + "description": "URL to the filing page on the SEC site.", + "default": "", + "optional": false } ], - "fmp": [ - { - "name": "news_url", - "type": "str", - "description": "News URL of the price target.", - "default": null, - "optional": true - }, - { - "name": "news_title", - "type": "str", - "description": "News title of the price target.", - "default": null, - "optional": true - }, - { - "name": "news_publisher", - "type": "str", - "description": "News publisher of the price target.", - "default": null, - "optional": true - }, - { - "name": "news_base_url", - "type": "str", - "description": "News base URL of the price target.", - "default": null, - "optional": true - } - ] + "fmp": [] }, - "model": "PriceTarget" + "model": "DiscoveryFilings" }, - "/equity/estimates/historical": { + "/equity/fundamental/multiples": { "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", + "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": [ { @@ -7863,28 +7725,13 @@ "optional": true } ], - "fmp": [ - { - "name": "period", - "type": "Literal['quarter', 'annual']", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": null, - "optional": true - } - ] + "fmp": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[AnalystEstimates]", + "type": "List[EquityValuationMultiples]", "description": "Serializable results." }, { @@ -7919,2039 +7766,1892 @@ "optional": false }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "revenue_per_share_ttm", + "type": "float", + "description": "Revenue per share calculated as trailing twelve months.", + "default": null, + "optional": true }, { - "name": "estimated_revenue_low", - "type": "int", - "description": "Estimated revenue low.", + "name": "net_income_per_share_ttm", + "type": "float", + "description": "Net income per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "estimated_revenue_high", - "type": "int", - "description": "Estimated revenue high.", + "name": "operating_cash_flow_per_share_ttm", + "type": "float", + "description": "Operating cash flow per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "estimated_revenue_avg", - "type": "int", - "description": "Estimated revenue average.", + "name": "free_cash_flow_per_share_ttm", + "type": "float", + "description": "Free cash flow per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "estimated_sga_expense_low", - "type": "int", - "description": "Estimated SGA expense low.", + "name": "cash_per_share_ttm", + "type": "float", + "description": "Cash per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "estimated_sga_expense_high", - "type": "int", - "description": "Estimated SGA expense high.", + "name": "book_value_per_share_ttm", + "type": "float", + "description": "Book value per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "estimated_sga_expense_avg", - "type": "int", - "description": "Estimated SGA expense average.", + "name": "tangible_book_value_per_share_ttm", + "type": "float", + "description": "Tangible book value per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "estimated_ebitda_low", - "type": "int", - "description": "Estimated EBITDA low.", + "name": "shareholders_equity_per_share_ttm", + "type": "float", + "description": "Shareholders equity per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "estimated_ebitda_high", - "type": "int", - "description": "Estimated EBITDA high.", + "name": "interest_debt_per_share_ttm", + "type": "float", + "description": "Interest debt per share calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "estimated_ebitda_avg", - "type": "int", - "description": "Estimated EBITDA average.", + "name": "market_cap_ttm", + "type": "float", + "description": "Market capitalization calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "estimated_ebit_low", - "type": "int", - "description": "Estimated EBIT low.", + "name": "enterprise_value_ttm", + "type": "float", + "description": "Enterprise value calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "estimated_ebit_high", - "type": "int", - "description": "Estimated EBIT high.", + "name": "pe_ratio_ttm", + "type": "float", + "description": "Price-to-earnings ratio (P/E ratio) calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "estimated_ebit_avg", - "type": "int", - "description": "Estimated EBIT average.", + "name": "price_to_sales_ratio_ttm", + "type": "float", + "description": "Price-to-sales ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "estimated_net_income_low", - "type": "int", - "description": "Estimated net income low.", + "name": "pocf_ratio_ttm", + "type": "float", + "description": "Price-to-operating cash flow ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "estimated_net_income_high", - "type": "int", - "description": "Estimated net income high.", + "name": "pfcf_ratio_ttm", + "type": "float", + "description": "Price-to-free cash flow ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "estimated_net_income_avg", - "type": "int", - "description": "Estimated net income average.", + "name": "pb_ratio_ttm", + "type": "float", + "description": "Price-to-book ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "estimated_eps_avg", + "name": "ptb_ratio_ttm", "type": "float", - "description": "Estimated EPS average.", + "description": "Price-to-tangible book ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "estimated_eps_high", + "name": "ev_to_sales_ttm", "type": "float", - "description": "Estimated EPS high.", + "description": "Enterprise value-to-sales ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "estimated_eps_low", + "name": "enterprise_value_over_ebitda_ttm", "type": "float", - "description": "Estimated EPS low.", + "description": "Enterprise value-to-EBITDA ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "number_analyst_estimated_revenue", - "type": "int", - "description": "Number of analysts who estimated revenue.", + "name": "ev_to_operating_cash_flow_ttm", + "type": "float", + "description": "Enterprise value-to-operating cash flow ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "number_analysts_estimated_eps", - "type": "int", - "description": "Number of analysts who estimated EPS.", + "name": "ev_to_free_cash_flow_ttm", + "type": "float", + "description": "Enterprise value-to-free cash flow ratio calculated as trailing twelve months.", "default": null, "optional": true - } - ], - "fmp": [] - }, - "model": "AnalystEstimates" - }, - "/equity/estimates/consensus": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get consensus price target and recommendation.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.consensus(symbol='AAPL', provider='fmp')\nobb.equity.estimates.consensus(symbol='AAPL,MSFT', provider='yfinance')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, tmx, yfinance.", + "name": "earnings_yield_ttm", + "type": "float", + "description": "Earnings yield calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'tmx', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "free_cash_flow_yield_ttm", + "type": "float", + "description": "Free cash flow yield calculated as trailing twelve months.", + "default": null, "optional": true - } - ], - "fmp": [], - "intrinio": [ + }, { - "name": "industry_group_number", - "type": "int", - "description": "The Zacks industry group number.", + "name": "debt_to_equity_ttm", + "type": "float", + "description": "Debt-to-equity ratio calculated as trailing twelve months.", "default": null, "optional": true - } - ], - "tmx": [], - "yfinance": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[PriceTargetConsensus]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'tmx', 'yfinance']]", - "description": "Provider name." + "name": "debt_to_assets_ttm", + "type": "float", + "description": "Debt-to-assets ratio calculated as trailing twelve months.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "net_debt_to_ebitda_ttm", + "type": "float", + "description": "Net debt-to-EBITDA ratio calculated as trailing twelve months.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "current_ratio_ttm", + "type": "float", + "description": "Current ratio calculated as trailing twelve months.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "interest_coverage_ttm", + "type": "float", + "description": "Interest coverage calculated as trailing twelve months.", + "default": null, + "optional": true }, { - "name": "name", - "type": "str", - "description": "The company name", + "name": "income_quality_ttm", + "type": "float", + "description": "Income quality calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "target_high", + "name": "dividend_yield_ttm", "type": "float", - "description": "High target of the price target consensus.", + "description": "Dividend yield calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "target_low", + "name": "dividend_yield_percentage_ttm", "type": "float", - "description": "Low target of the price target consensus.", + "description": "Dividend yield percentage calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "target_consensus", + "name": "dividend_to_market_cap_ttm", "type": "float", - "description": "Consensus target of the price target consensus.", + "description": "Dividend to market capitalization ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "target_median", + "name": "dividend_per_share_ttm", "type": "float", - "description": "Median target of the price target consensus.", + "description": "Dividend per share calculated as trailing twelve months.", "default": null, "optional": true - } - ], - "fmp": [], - "intrinio": [ + }, { - "name": "standard_deviation", + "name": "payout_ratio_ttm", "type": "float", - "description": "The standard deviation of target price estimates.", + "description": "Payout ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "total_anaylsts", - "type": "int", - "description": "The total number of target price estimates in consensus.", + "name": "sales_general_and_administrative_to_revenue_ttm", + "type": "float", + "description": "Sales general and administrative expenses-to-revenue ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "raised", - "type": "int", - "description": "The number of analysts that have raised their target price estimates.", + "name": "research_and_development_to_revenue_ttm", + "type": "float", + "description": "Research and development expenses-to-revenue ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "lowered", - "type": "int", - "description": "The number of analysts that have lowered their target price estimates.", + "name": "intangibles_to_total_assets_ttm", + "type": "float", + "description": "Intangibles-to-total assets ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "most_recent_date", - "type": "date", - "description": "The date of the most recent estimate.", + "name": "capex_to_operating_cash_flow_ttm", + "type": "float", + "description": "Capital expenditures-to-operating cash flow ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "industry_group_number", - "type": "int", - "description": "The Zacks industry group number.", + "name": "capex_to_revenue_ttm", + "type": "float", + "description": "Capital expenditures-to-revenue ratio calculated as trailing twelve months.", "default": null, "optional": true - } - ], - "tmx": [ + }, { - "name": "target_upside", + "name": "capex_to_depreciation_ttm", "type": "float", - "description": "Percent of upside, as a normalized percent.", + "description": "Capital expenditures-to-depreciation ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "total_analysts", - "type": "int", - "description": "Total number of analyst.", + "name": "stock_based_compensation_to_revenue_ttm", + "type": "float", + "description": "Stock-based compensation-to-revenue ratio calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "buy_ratings", - "type": "int", - "description": "Number of buy ratings.", + "name": "graham_number_ttm", + "type": "float", + "description": "Graham number calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "sell_ratings", - "type": "int", - "description": "Number of sell ratings.", + "name": "roic_ttm", + "type": "float", + "description": "Return on invested capital calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "hold_ratings", - "type": "int", - "description": "Number of hold ratings.", + "name": "return_on_tangible_assets_ttm", + "type": "float", + "description": "Return on tangible assets calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "consensus_action", - "type": "str", - "description": "Consensus action.", + "name": "graham_net_net_ttm", + "type": "float", + "description": "Graham net-net working capital calculated as trailing twelve months.", "default": null, "optional": true - } - ], - "yfinance": [ + }, { - "name": "recommendation", - "type": "str", - "description": "Recommendation - buy, sell, etc.", + "name": "working_capital_ttm", + "type": "float", + "description": "Working capital calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "recommendation_mean", + "name": "tangible_asset_value_ttm", "type": "float", - "description": "Mean recommendation score where 1 is strong buy and 5 is strong sell.", + "description": "Tangible asset value calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "number_of_analysts", - "type": "int", - "description": "Number of analysts providing opinions.", + "name": "net_current_asset_value_ttm", + "type": "float", + "description": "Net current asset value calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "current_price", + "name": "invested_capital_ttm", "type": "float", - "description": "Current price of the stock.", + "description": "Invested capital calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "currency", - "type": "str", - "description": "Currency the stock is priced in.", + "name": "average_receivables_ttm", + "type": "float", + "description": "Average receivables calculated as trailing twelve months.", "default": null, "optional": true - } - ] - }, - "model": "PriceTargetConsensus" - }, - "/equity/estimates/analyst_search": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Search for specific analysts and get their forecast track record.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.analyst_search(provider='benzinga')\nobb.equity.estimates.analyst_search(firm_name='Wedbush', provider='benzinga')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "analyst_name", - "type": "Union[str, List[str]]", - "description": "Analyst names to return. Omitting will return all available analysts. Multiple items allowed for provider(s): benzinga.", + "name": "average_payables_ttm", + "type": "float", + "description": "Average payables calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "firm_name", - "type": "Union[str, List[str]]", - "description": "Firm names to return. Omitting will return all available firms. Multiple items allowed for provider(s): benzinga.", + "name": "average_inventory_ttm", + "type": "float", + "description": "Average inventory calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['benzinga']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default.", - "default": "benzinga", - "optional": true - } - ], - "benzinga": [ - { - "name": "analyst_ids", - "type": "Union[str, List[str]]", - "description": "List of analyst IDs to return. Multiple items allowed for provider(s): benzinga.", + "name": "days_sales_outstanding_ttm", + "type": "float", + "description": "Days sales outstanding calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "firm_ids", - "type": "Union[str, List[str]]", - "description": "Firm IDs to return. Multiple items allowed for provider(s): benzinga.", + "name": "days_payables_outstanding_ttm", + "type": "float", + "description": "Days payables outstanding calculated as trailing twelve months.", "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "Number of results returned. Limit 1000.", - "default": 100, + "name": "days_of_inventory_on_hand_ttm", + "type": "float", + "description": "Days of inventory on hand calculated as trailing twelve months.", + "default": null, "optional": true }, { - "name": "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, + "name": "receivables_turnover_ttm", + "type": "float", + "description": "Receivables turnover calculated as trailing twelve months.", + "default": null, "optional": true }, { - "name": "fields", - "type": "Union[str, List[str]]", - "description": "Fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple items allowed for provider(s): benzinga.", + "name": "payables_turnover_ttm", + "type": "float", + "description": "Payables turnover calculated as trailing twelve months.", "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[AnalystSearch]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['benzinga']]", - "description": "Provider name." }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "inventory_turnover_ttm", + "type": "float", + "description": "Inventory turnover calculated as trailing twelve months.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "roe_ttm", + "type": "float", + "description": "Return on equity calculated as trailing twelve months.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "capex_per_share_ttm", + "type": "float", + "description": "Capital expenditures per share calculated as trailing twelve months.", + "default": null, + "optional": true } - ] + ], + "fmp": [] }, - "data": { + "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": "last_updated", - "type": "datetime", - "description": "Date of the last update.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "firm_name", + "name": "period", "type": "str", - "description": "Firm name of the analyst.", - "default": null, + "description": "Time period of the data to return.", + "default": "annual", "optional": true }, { - "name": "name_first", - "type": "str", - "description": "Analyst first name.", - "default": null, + "name": "limit", + "type": "Annotated[int, Ge(ge=0)]", + "description": "The number of data entries to return.", + "default": 5, "optional": true }, { - "name": "name_last", - "type": "str", - "description": "Analyst last name.", - "default": null, + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "name_full", - "type": "str", - "description": "Analyst full name.", - "default": "", - "optional": false + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true } ], - "benzinga": [ + "intrinio": [ { - "name": "analyst_id", - "type": "str", - "description": "ID of the analyst.", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", "optional": true }, { - "name": "firm_id", - "type": "str", - "description": "ID of the analyst firm.", + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", "default": null, "optional": true - }, + } + ], + "polygon": [ { - "name": "smart_score", - "type": "float", - "description": "A weighted average of the total_ratings_percentile, overall_avg_return_percentile, and overall_success_rate", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm']", + "description": "None", + "default": "annual", "optional": true }, { - "name": "overall_success_rate", - "type": "float", - "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain overall.", + "name": "filing_date", + "type": "date", + "description": "Filing date of the financial statement.", "default": null, "optional": true }, { - "name": "overall_avg_return_percentile", - "type": "float", - "description": "The percentile (normalized) of this analyst's overall average return per rating in comparison to other analysts' overall average returns per rating.", + "name": "filing_date_lt", + "type": "date", + "description": "Filing date less than the given date.", "default": null, "optional": true }, { - "name": "total_ratings_percentile", - "type": "float", - "description": "The percentile (normalized) of this analyst's total number of ratings in comparison to the total number of ratings published by all other analysts", + "name": "filing_date_lte", + "type": "date", + "description": "Filing date less than or equal to the given date.", "default": null, "optional": true }, { - "name": "total_ratings", - "type": "int", - "description": "Number of recommendations made by this analyst.", + "name": "filing_date_gt", + "type": "date", + "description": "Filing date greater than the given date.", "default": null, "optional": true }, { - "name": "overall_gain_count", - "type": "int", - "description": "The number of ratings that have gained value since the date of recommendation", + "name": "filing_date_gte", + "type": "date", + "description": "Filing date greater than or equal to the given date.", "default": null, "optional": true }, { - "name": "overall_loss_count", - "type": "int", - "description": "The number of ratings that have lost value since the date of recommendation", + "name": "period_of_report_date", + "type": "date", + "description": "Period of report date of the financial statement.", "default": null, "optional": true }, { - "name": "overall_average_return", - "type": "float", - "description": "The average percent (normalized) price difference per rating since the date of recommendation", + "name": "period_of_report_date_lt", + "type": "date", + "description": "Period of report date less than the given date.", "default": null, "optional": true }, { - "name": "overall_std_dev", - "type": "float", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings since the date of recommendation", + "name": "period_of_report_date_lte", + "type": "date", + "description": "Period of report date less than or equal to the given date.", "default": null, "optional": true }, { - "name": "gain_count_1m", - "type": "int", - "description": "The number of ratings that have gained value over the last month", + "name": "period_of_report_date_gt", + "type": "date", + "description": "Period of report date greater than the given date.", "default": null, "optional": true }, { - "name": "loss_count_1m", - "type": "int", - "description": "The number of ratings that have lost value over the last month", + "name": "period_of_report_date_gte", + "type": "date", + "description": "Period of report date greater than or equal to the given date.", "default": null, "optional": true }, { - "name": "average_return_1m", - "type": "float", - "description": "The average percent (normalized) price difference per rating over the last month", - "default": null, + "name": "include_sources", + "type": "bool", + "description": "Whether to include the sources of the financial statement.", + "default": true, "optional": true }, { - "name": "std_dev_1m", - "type": "float", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last month", + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order of the financial statement.", "default": null, "optional": true }, { - "name": "smart_score_1m", - "type": "float", - "description": "A weighted average smart score over the last month.", + "name": "sort", + "type": "Literal['filing_date', 'period_of_report_date']", + "description": "Sort of the financial statement.", "default": null, "optional": true + } + ], + "yfinance": [ + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[BalanceSheet]", + "description": "Serializable results." }, { - "name": "success_rate_1m", - "type": "float", - "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last month", + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", "default": null, "optional": true }, { - "name": "gain_count_3m", + "name": "fiscal_year", "type": "int", - "description": "The number of ratings that have gained value over the last 3 months", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "filing_date", + "type": "date", + "description": "The date when the filing was made.", "default": null, "optional": true }, { - "name": "loss_count_3m", - "type": "int", - "description": "The number of ratings that have lost value over the last 3 months", + "name": "accepted_date", + "type": "datetime", + "description": "The date and time when the filing was accepted.", "default": null, "optional": true }, { - "name": "average_return_3m", - "type": "float", - "description": "The average percent (normalized) price difference per rating over the last 3 months", + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet was reported.", "default": null, "optional": true }, { - "name": "std_dev_3m", + "name": "cash_and_cash_equivalents", "type": "float", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 months", + "description": "Cash and cash equivalents.", "default": null, "optional": true }, { - "name": "smart_score_3m", + "name": "short_term_investments", "type": "float", - "description": "A weighted average smart score over the last 3 months.", + "description": "Short term investments.", "default": null, "optional": true }, { - "name": "success_rate_3m", + "name": "cash_and_short_term_investments", "type": "float", - "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 months", + "description": "Cash and short term investments.", "default": null, "optional": true }, { - "name": "gain_count_6m", - "type": "int", - "description": "The number of ratings that have gained value over the last 6 months", + "name": "net_receivables", + "type": "float", + "description": "Net receivables.", "default": null, "optional": true }, { - "name": "loss_count_6m", - "type": "int", - "description": "The number of ratings that have lost value over the last 6 months", + "name": "inventory", + "type": "float", + "description": "Inventory.", "default": null, "optional": true }, { - "name": "average_return_6m", + "name": "other_current_assets", "type": "float", - "description": "The average percent (normalized) price difference per rating over the last 6 months", + "description": "Other current assets.", "default": null, "optional": true }, { - "name": "std_dev_6m", + "name": "total_current_assets", "type": "float", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 6 months", + "description": "Total current assets.", "default": null, "optional": true }, { - "name": "gain_count_9m", - "type": "int", - "description": "The number of ratings that have gained value over the last 9 months", + "name": "plant_property_equipment_net", + "type": "float", + "description": "Plant property equipment net.", "default": null, "optional": true }, { - "name": "loss_count_9m", - "type": "int", - "description": "The number of ratings that have lost value over the last 9 months", + "name": "goodwill", + "type": "float", + "description": "Goodwill.", "default": null, "optional": true }, { - "name": "average_return_9m", + "name": "intangible_assets", "type": "float", - "description": "The average percent (normalized) price difference per rating over the last 9 months", + "description": "Intangible assets.", "default": null, "optional": true }, { - "name": "std_dev_9m", + "name": "goodwill_and_intangible_assets", "type": "float", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 9 months", + "description": "Goodwill and intangible assets.", "default": null, "optional": true }, { - "name": "smart_score_9m", + "name": "long_term_investments", "type": "float", - "description": "A weighted average smart score over the last 9 months.", + "description": "Long term investments.", "default": null, "optional": true }, { - "name": "success_rate_9m", + "name": "tax_assets", "type": "float", - "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 9 months", + "description": "Tax assets.", "default": null, "optional": true }, { - "name": "gain_count_1y", - "type": "int", - "description": "The number of ratings that have gained value over the last 1 year", + "name": "other_non_current_assets", + "type": "float", + "description": "Other non current assets.", "default": null, "optional": true }, { - "name": "loss_count_1y", - "type": "int", - "description": "The number of ratings that have lost value over the last 1 year", + "name": "non_current_assets", + "type": "float", + "description": "Total non current assets.", "default": null, "optional": true }, { - "name": "average_return_1y", + "name": "other_assets", "type": "float", - "description": "The average percent (normalized) price difference per rating over the last 1 year", + "description": "Other assets.", "default": null, "optional": true }, { - "name": "std_dev_1y", + "name": "total_assets", "type": "float", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 1 year", + "description": "Total assets.", "default": null, "optional": true }, { - "name": "smart_score_1y", + "name": "accounts_payable", "type": "float", - "description": "A weighted average smart score over the last 1 year.", + "description": "Accounts payable.", "default": null, "optional": true }, { - "name": "success_rate_1y", + "name": "short_term_debt", "type": "float", - "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 1 year", + "description": "Short term debt.", "default": null, "optional": true }, { - "name": "gain_count_2y", - "type": "int", - "description": "The number of ratings that have gained value over the last 2 years", + "name": "tax_payables", + "type": "float", + "description": "Tax payables.", "default": null, "optional": true }, { - "name": "loss_count_2y", - "type": "int", - "description": "The number of ratings that have lost value over the last 2 years", + "name": "current_deferred_revenue", + "type": "float", + "description": "Current deferred revenue.", "default": null, "optional": true }, { - "name": "average_return_2y", + "name": "other_current_liabilities", "type": "float", - "description": "The average percent (normalized) price difference per rating over the last 2 years", + "description": "Other current liabilities.", "default": null, "optional": true }, { - "name": "std_dev_2y", + "name": "total_current_liabilities", "type": "float", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 2 years", + "description": "Total current liabilities.", "default": null, "optional": true }, { - "name": "smart_score_2y", + "name": "long_term_debt", "type": "float", - "description": "A weighted average smart score over the last 3 years.", + "description": "Long term debt.", "default": null, "optional": true }, { - "name": "success_rate_2y", + "name": "deferred_revenue_non_current", "type": "float", - "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 2 years", + "description": "Non current deferred revenue.", "default": null, "optional": true }, { - "name": "gain_count_3y", - "type": "int", - "description": "The number of ratings that have gained value over the last 3 years", + "name": "deferred_tax_liabilities_non_current", + "type": "float", + "description": "Deferred tax liabilities non current.", "default": null, "optional": true }, { - "name": "loss_count_3y", - "type": "int", - "description": "The number of ratings that have lost value over the last 3 years", + "name": "other_non_current_liabilities", + "type": "float", + "description": "Other non current liabilities.", "default": null, "optional": true }, { - "name": "average_return_3y", + "name": "total_non_current_liabilities", "type": "float", - "description": "The average percent (normalized) price difference per rating over the last 3 years", + "description": "Total non current liabilities.", "default": null, "optional": true }, { - "name": "std_dev_3y", + "name": "other_liabilities", "type": "float", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 years", + "description": "Other liabilities.", "default": null, "optional": true }, { - "name": "smart_score_3y", + "name": "capital_lease_obligations", "type": "float", - "description": "A weighted average smart score over the last 3 years.", + "description": "Capital lease obligations.", "default": null, "optional": true }, { - "name": "success_rate_3y", + "name": "total_liabilities", "type": "float", - "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 years", + "description": "Total liabilities.", "default": null, "optional": true - } - ] - }, - "model": "AnalystSearch" - }, - "/equity/estimates/forward_sales": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get forward sales estimates.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.forward_sales(symbol='AAPL', provider='intrinio')\nobb.equity.estimates.forward_sales(fiscal_year=2025, fiscal_period=fy, provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", + "name": "preferred_stock", + "type": "float", + "description": "Preferred stock.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", + "name": "common_stock", + "type": "float", + "description": "Common stock.", + "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "fiscal_year", - "type": "int", - "description": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", + "name": "retained_earnings", + "type": "float", + "description": "Retained earnings.", "default": null, "optional": true }, { - "name": "fiscal_period", - "type": "Literal['fy', 'q1', 'q2', 'q3', 'q4']", - "description": "The future fiscal period to retrieve estimates for.", + "name": "accumulated_other_comprehensive_income", + "type": "float", + "description": "Accumulated other comprehensive income (loss).", "default": null, "optional": true }, { - "name": "calendar_year", - "type": "int", - "description": "The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", + "name": "other_shareholders_equity", + "type": "float", + "description": "Other shareholders equity.", "default": null, "optional": true }, { - "name": "calendar_period", - "type": "Literal['q1', 'q2', 'q3', 'q4']", - "description": "The future calendar period to retrieve estimates for.", + "name": "other_total_shareholders_equity", + "type": "float", + "description": "Other total shareholders equity.", "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[ForwardSalesEstimates]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['intrinio']]", - "description": "Provider name." + "name": "total_common_equity", + "type": "float", + "description": "Total common equity.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "total_equity_non_controlling_interests", + "type": "float", + "description": "Total equity non controlling interests.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "total_liabilities_and_shareholders_equity", + "type": "float", + "description": "Total liabilities and shareholders equity.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "minority_interest", + "type": "float", + "description": "Minority interest.", + "default": null, + "optional": true + }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "total_liabilities_and_total_equity", + "type": "float", + "description": "Total liabilities and total equity.", + "default": null, + "optional": true }, { - "name": "name", - "type": "str", - "description": "Name of the entity.", + "name": "total_investments", + "type": "float", + "description": "Total investments.", "default": null, "optional": true }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "total_debt", + "type": "float", + "description": "Total debt.", + "default": null, + "optional": true }, { - "name": "fiscal_year", - "type": "int", - "description": "Fiscal year for the estimate.", + "name": "net_debt", + "type": "float", + "description": "Net debt.", "default": null, "optional": true }, { - "name": "fiscal_period", + "name": "link", "type": "str", - "description": "Fiscal quarter for the estimate.", + "description": "Link to the filing.", "default": null, "optional": true }, { - "name": "calendar_year", - "type": "int", - "description": "Calendar year for the estimate.", + "name": "final_link", + "type": "str", + "description": "Link to the filing document.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "calendar_period", + "name": "reported_currency", "type": "str", - "description": "Calendar quarter for the estimate.", + "description": "The currency in which the balance sheet is reported.", "default": null, "optional": true }, { - "name": "low_estimate", - "type": "int", - "description": "The sales estimate low for the period.", + "name": "cash_and_cash_equivalents", + "type": "float", + "description": "Cash and cash equivalents.", "default": null, "optional": true }, { - "name": "high_estimate", - "type": "int", - "description": "The sales estimate high for the period.", + "name": "cash_and_due_from_banks", + "type": "float", + "description": "Cash and due from banks.", "default": null, "optional": true }, { - "name": "mean", - "type": "int", - "description": "The sales estimate mean for the period.", + "name": "restricted_cash", + "type": "float", + "description": "Restricted cash.", "default": null, "optional": true }, { - "name": "median", - "type": "int", - "description": "The sales estimate median for the period.", + "name": "short_term_investments", + "type": "float", + "description": "Short term investments.", "default": null, "optional": true }, { - "name": "standard_deviation", - "type": "int", - "description": "The sales estimate standard deviation for the period.", + "name": "federal_funds_sold", + "type": "float", + "description": "Federal funds sold.", "default": null, "optional": true }, { - "name": "number_of_analysts", - "type": "int", - "description": "Number of analysts providing estimates for the period.", + "name": "accounts_receivable", + "type": "float", + "description": "Accounts receivable.", "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "revisions_1w_up", - "type": "int", - "description": "Number of revisions up in the last week.", + "name": "note_and_lease_receivable", + "type": "float", + "description": "Note and lease receivable. (Vendor non-trade receivables)", "default": null, "optional": true }, { - "name": "revisions_1w_down", - "type": "int", - "description": "Number of revisions down in the last week.", + "name": "inventories", + "type": "float", + "description": "Net Inventories.", "default": null, "optional": true }, { - "name": "revisions_1w_change_percent", + "name": "customer_and_other_receivables", "type": "float", - "description": "The analyst revisions percent change in estimate for the period of 1 week.", + "description": "Customer and other receivables.", "default": null, "optional": true }, { - "name": "revisions_1m_up", - "type": "int", - "description": "Number of revisions up in the last month.", + "name": "interest_bearing_deposits_at_other_banks", + "type": "float", + "description": "Interest bearing deposits at other banks.", "default": null, "optional": true }, { - "name": "revisions_1m_down", - "type": "int", - "description": "Number of revisions down in the last month.", + "name": "time_deposits_placed_and_other_short_term_investments", + "type": "float", + "description": "Time deposits placed and other short term investments.", "default": null, "optional": true }, { - "name": "revisions_1m_change_percent", + "name": "trading_account_securities", "type": "float", - "description": "The analyst revisions percent change in estimate for the period of 1 month.", + "description": "Trading account securities.", "default": null, "optional": true }, { - "name": "revisions_3m_up", - "type": "int", - "description": "Number of revisions up in the last 3 months.", + "name": "loans_and_leases", + "type": "float", + "description": "Loans and leases.", "default": null, "optional": true }, { - "name": "revisions_3m_down", - "type": "int", - "description": "Number of revisions down in the last 3 months.", + "name": "allowance_for_loan_and_lease_losses", + "type": "float", + "description": "Allowance for loan and lease losses.", "default": null, "optional": true }, { - "name": "revisions_3m_change_percent", + "name": "current_deferred_refundable_income_taxes", "type": "float", - "description": "The analyst revisions percent change in estimate for the period of 3 months.", + "description": "Current deferred refundable income taxes.", "default": null, "optional": true - } - ] - }, - "model": "ForwardSalesEstimates" - }, - "/equity/estimates/forward_eps": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get forward EPS estimates.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.forward_eps(symbol='AAPL', provider='intrinio')\nobb.equity.estimates.forward_eps(fiscal_year=2025, fiscal_period=fy, provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", + "name": "other_current_assets", + "type": "float", + "description": "Other current assets.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "loans_and_leases_net_of_allowance", + "type": "float", + "description": "Loans and leases net of allowance.", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "fiscal_period", - "type": "Literal['annual', 'quarter']", - "description": "The future fiscal period to retrieve estimates for.", - "default": "annual", + "name": "accrued_investment_income", + "type": "float", + "description": "Accrued investment income.", + "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", + "name": "other_current_non_operating_assets", + "type": "float", + "description": "Other current non-operating assets.", "default": null, "optional": true }, { - "name": "include_historical", - "type": "bool", - "description": "If True, the data will include all past data and the limit will be ignored.", - "default": false, + "name": "loans_held_for_sale", + "type": "float", + "description": "Loans held for sale.", + "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "fiscal_year", - "type": "int", - "description": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", + "name": "prepaid_expenses", + "type": "float", + "description": "Prepaid expenses.", "default": null, "optional": true }, { - "name": "fiscal_period", - "type": "Literal['fy', 'q1', 'q2', 'q3', 'q4']", - "description": "The future fiscal period to retrieve estimates for.", + "name": "total_current_assets", + "type": "float", + "description": "Total current assets.", "default": null, "optional": true }, { - "name": "calendar_year", - "type": "int", - "description": "The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", + "name": "plant_property_equipment_gross", + "type": "float", + "description": "Plant property equipment gross.", "default": null, "optional": true }, { - "name": "calendar_period", - "type": "Literal['q1', 'q2', 'q3', 'q4']", - "description": "The future calendar period to retrieve estimates for.", + "name": "accumulated_depreciation", + "type": "float", + "description": "Accumulated depreciation.", "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[ForwardEpsEstimates]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio']]", - "description": "Provider name." + "name": "premises_and_equipment_net", + "type": "float", + "description": "Net premises and equipment.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "plant_property_equipment_net", + "type": "float", + "description": "Net plant property equipment.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "long_term_investments", + "type": "float", + "description": "Long term investments.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "mortgage_servicing_rights", + "type": "float", + "description": "Mortgage servicing rights.", + "default": null, + "optional": true }, { - "name": "name", - "type": "str", - "description": "Name of the entity.", + "name": "unearned_premiums_asset", + "type": "float", + "description": "Unearned premiums asset.", "default": null, "optional": true }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "non_current_note_lease_receivables", + "type": "float", + "description": "Non-current note lease receivables.", + "default": null, + "optional": true }, { - "name": "fiscal_year", - "type": "int", - "description": "Fiscal year for the estimate.", + "name": "deferred_acquisition_cost", + "type": "float", + "description": "Deferred acquisition cost.", "default": null, "optional": true }, { - "name": "fiscal_period", - "type": "str", - "description": "Fiscal quarter for the estimate.", + "name": "goodwill", + "type": "float", + "description": "Goodwill.", "default": null, "optional": true }, { - "name": "calendar_year", - "type": "int", - "description": "Calendar year for the estimate.", + "name": "separate_account_business_assets", + "type": "float", + "description": "Separate account business assets.", "default": null, "optional": true }, { - "name": "calendar_period", - "type": "str", - "description": "Calendar quarter for the estimate.", + "name": "non_current_deferred_refundable_income_taxes", + "type": "float", + "description": "Noncurrent deferred refundable income taxes.", "default": null, "optional": true }, { - "name": "low_estimate", + "name": "intangible_assets", "type": "float", - "description": "Estimated EPS low for the period.", + "description": "Intangible assets.", "default": null, "optional": true }, { - "name": "high_estimate", + "name": "employee_benefit_assets", "type": "float", - "description": "Estimated EPS high for the period.", + "description": "Employee benefit assets.", "default": null, "optional": true }, { - "name": "mean", + "name": "other_assets", "type": "float", - "description": "Estimated EPS mean for the period.", + "description": "Other assets.", "default": null, "optional": true }, { - "name": "median", + "name": "other_non_current_operating_assets", "type": "float", - "description": "Estimated EPS median for the period.", + "description": "Other noncurrent operating assets.", "default": null, "optional": true }, { - "name": "standard_deviation", + "name": "other_non_current_non_operating_assets", "type": "float", - "description": "Estimated EPS standard deviation for the period.", + "description": "Other noncurrent non-operating assets.", "default": null, "optional": true }, { - "name": "number_of_analysts", - "type": "int", - "description": "Number of analysts providing estimates for the period.", + "name": "interest_bearing_deposits", + "type": "float", + "description": "Interest bearing deposits.", "default": null, "optional": true - } - ], - "fmp": [], - "intrinio": [ + }, { - "name": "revisions_change_percent", + "name": "total_non_current_assets", "type": "float", - "description": "The earnings per share (EPS) percent change in estimate for the period.", + "description": "Total noncurrent assets.", "default": null, "optional": true }, { - "name": "mean_1w", + "name": "total_assets", "type": "float", - "description": "The mean estimate for the period one week ago.", + "description": "Total assets.", "default": null, "optional": true }, { - "name": "mean_1m", + "name": "non_interest_bearing_deposits", "type": "float", - "description": "The mean estimate for the period one month ago.", + "description": "Non interest bearing deposits.", "default": null, "optional": true }, { - "name": "mean_2m", + "name": "federal_funds_purchased_and_securities_sold", "type": "float", - "description": "The mean estimate for the period two months ago.", + "description": "Federal funds purchased and securities sold.", "default": null, "optional": true }, { - "name": "mean_3m", + "name": "bankers_acceptance_outstanding", "type": "float", - "description": "The mean estimate for the period three months ago.", + "description": "Bankers acceptance outstanding.", "default": null, "optional": true - } - ] - }, - "model": "ForwardEpsEstimates" - }, - "/equity/darkpool/otc": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the weekly aggregate trade data for Over The Counter deals.\n\nATS and non-ATS trading data for each ATS/firm\nwith trade reporting obligations under FINRA rules.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.darkpool.otc(provider='finra')\n# Get OTC data for a symbol\nobb.equity.darkpool.otc(symbol='AAPL', provider='finra')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", + "name": "short_term_debt", + "type": "float", + "description": "Short term debt.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['finra']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finra' if there is no default.", - "default": "finra", + "name": "accounts_payable", + "type": "float", + "description": "Accounts payable.", + "default": null, "optional": true - } - ], - "finra": [ + }, { - "name": "tier", - "type": "Literal['T1', 'T2', 'OTCE']", - "description": "'T1 - Securities included in the S&P 500, Russell 1000 and selected exchange-traded products; T2 - All other NMS stocks; OTC - Over-the-Counter equity securities", - "default": "T1", + "name": "current_deferred_revenue", + "type": "float", + "description": "Current deferred revenue.", + "default": null, "optional": true }, { - "name": "is_ats", - "type": "bool", - "description": "ATS data if true, NON-ATS otherwise", - "default": true, + "name": "current_deferred_payable_income_tax_liabilities", + "type": "float", + "description": "Current deferred payable income tax liabilities.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[OTCAggregate]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['finra']]", - "description": "Provider name." + "name": "accrued_interest_payable", + "type": "float", + "description": "Accrued interest payable.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "accrued_expenses", + "type": "float", + "description": "Accrued expenses.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "other_short_term_payables", + "type": "float", + "description": "Other short term payables.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "update_date", - "type": "date", - "description": "Most recent date on which total trades is updated based on data received from each ATS/OTC.", - "default": "", - "optional": false + "name": "customer_deposits", + "type": "float", + "description": "Customer deposits.", + "default": null, + "optional": true }, { - "name": "share_quantity", + "name": "dividends_payable", "type": "float", - "description": "Aggregate weekly total number of shares reported by each ATS for the Symbol.", - "default": "", - "optional": false + "description": "Dividends payable.", + "default": null, + "optional": true }, { - "name": "trade_quantity", + "name": "claims_and_claim_expense", "type": "float", - "description": "Aggregate weekly total number of trades reported by each ATS for the Symbol", - "default": "", - "optional": false - } - ], - "finra": [] - }, - "model": "OTCAggregate" - }, - "/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", + "description": "Claims and claim expense.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['tmx', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default.", - "default": "tmx", + "name": "future_policy_benefits", + "type": "float", + "description": "Future policy benefits.", + "default": null, "optional": true - } - ], - "tmx": [ + }, { - "name": "category", - "type": "Literal['dividend', 'energy', 'healthcare', 'industrials', 'price_performer', 'rising_stars', 'real_estate', 'tech', 'utilities', '52w_high', 'volume']", - "description": "The category of list to retrieve. Defaults to `price_performer`.", - "default": "price_performer", + "name": "current_employee_benefit_liabilities", + "type": "float", + "description": "Current employee benefit liabilities.", + "default": null, "optional": true - } - ], - "yfinance": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EquityGainers]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['tmx', 'yfinance']]", - "description": "Provider name." + "name": "unearned_premiums_liability", + "type": "float", + "description": "Unearned premiums liability.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "other_taxes_payable", + "type": "float", + "description": "Other taxes payable.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "policy_holder_funds", + "type": "float", + "description": "Policy holder funds.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "other_current_liabilities", + "type": "float", + "description": "Other current liabilities.", + "default": null, + "optional": true }, { - "name": "name", - "type": "str", - "description": "Name of the entity.", - "default": "", - "optional": false + "name": "other_current_non_operating_liabilities", + "type": "float", + "description": "Other current non-operating liabilities.", + "default": null, + "optional": true }, { - "name": "price", + "name": "separate_account_business_liabilities", "type": "float", - "description": "Last price.", - "default": "", - "optional": false + "description": "Separate account business liabilities.", + "default": null, + "optional": true }, { - "name": "change", + "name": "total_current_liabilities", "type": "float", - "description": "Change in price value.", - "default": "", - "optional": false + "description": "Total current liabilities.", + "default": null, + "optional": true }, { - "name": "percent_change", + "name": "long_term_debt", "type": "float", - "description": "Percent change.", - "default": "", - "optional": false + "description": "Long term debt.", + "default": null, + "optional": true }, { - "name": "volume", + "name": "other_long_term_liabilities", "type": "float", - "description": "The trading volume.", - "default": "", - "optional": false - } - ], - "tmx": [ - { - "name": "rank", - "type": "int", - "description": "The rank of the stock in the list.", - "default": "", - "optional": false - } - ], - "yfinance": [ + "description": "Other long term liabilities.", + "default": null, + "optional": true + }, { - "name": "market_cap", + "name": "non_current_deferred_revenue", "type": "float", - "description": "Market Cap.", - "default": "", - "optional": false + "description": "Non-current deferred revenue.", + "default": null, + "optional": true }, { - "name": "avg_volume_3_months", + "name": "non_current_deferred_payable_income_tax_liabilities", "type": "float", - "description": "Average volume over the last 3 months in millions.", - "default": "", - "optional": false + "description": "Non-current deferred payable income tax liabilities.", + "default": null, + "optional": true }, { - "name": "pe_ratio_ttm", + "name": "non_current_employee_benefit_liabilities", "type": "float", - "description": "PE Ratio (TTM).", + "description": "Non-current employee benefit liabilities.", "default": null, "optional": true - } - ] - }, - "model": "EquityGainers" - }, - "/equity/discovery/losers": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the top price losers in the stock market.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.losers(provider='yfinance')\nobb.equity.discovery.losers(sort='desc', provider='yfinance')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", - "default": "desc", + "name": "other_non_current_operating_liabilities", + "type": "float", + "description": "Other non-current operating liabilities.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default.", - "default": "yfinance", + "name": "other_non_current_non_operating_liabilities", + "type": "float", + "description": "Other non-current, non-operating liabilities.", + "default": null, "optional": true - } - ], - "yfinance": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EquityLosers]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['yfinance']]", - "description": "Provider name." + "name": "total_non_current_liabilities", + "type": "float", + "description": "Total non-current liabilities.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "capital_lease_obligations", + "type": "float", + "description": "Capital lease obligations.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "asset_retirement_reserve_litigation_obligation", + "type": "float", + "description": "Asset retirement reserve litigation obligation.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "total_liabilities", + "type": "float", + "description": "Total liabilities.", + "default": null, + "optional": true }, { - "name": "name", - "type": "str", - "description": "Name of the entity.", - "default": "", - "optional": false + "name": "commitments_contingencies", + "type": "float", + "description": "Commitments contingencies.", + "default": null, + "optional": true }, { - "name": "price", + "name": "redeemable_non_controlling_interest", "type": "float", - "description": "Last price.", - "default": "", - "optional": false + "description": "Redeemable non-controlling interest.", + "default": null, + "optional": true }, { - "name": "change", + "name": "preferred_stock", "type": "float", - "description": "Change in price value.", - "default": "", - "optional": false + "description": "Preferred stock.", + "default": null, + "optional": true }, { - "name": "percent_change", + "name": "common_stock", "type": "float", - "description": "Percent change.", - "default": "", - "optional": false + "description": "Common stock.", + "default": null, + "optional": true }, { - "name": "volume", + "name": "retained_earnings", "type": "float", - "description": "The trading volume.", - "default": "", - "optional": false - } - ], - "yfinance": [ + "description": "Retained earnings.", + "default": null, + "optional": true + }, { - "name": "market_cap", + "name": "treasury_stock", "type": "float", - "description": "Market Cap.", - "default": "", - "optional": false + "description": "Treasury stock.", + "default": null, + "optional": true }, { - "name": "avg_volume_3_months", + "name": "accumulated_other_comprehensive_income", "type": "float", - "description": "Average volume over the last 3 months in millions.", - "default": "", - "optional": false + "description": "Accumulated other comprehensive income.", + "default": null, + "optional": true }, { - "name": "pe_ratio_ttm", + "name": "participating_policy_holder_equity", "type": "float", - "description": "PE Ratio (TTM).", + "description": "Participating policy holder equity.", "default": null, "optional": true - } - ] - }, - "model": "EquityLosers" - }, - "/equity/discovery/active": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the most actively traded stocks based on volume.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.active(provider='yfinance')\nobb.equity.discovery.active(sort='desc', provider='yfinance')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", - "default": "desc", + "name": "other_equity_adjustments", + "type": "float", + "description": "Other equity adjustments.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default.", - "default": "yfinance", + "name": "total_common_equity", + "type": "float", + "description": "Total common equity.", + "default": null, "optional": true - } - ], - "yfinance": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EquityActive]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['yfinance']]", - "description": "Provider name." + "name": "total_preferred_common_equity", + "type": "float", + "description": "Total preferred common equity.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "non_controlling_interest", + "type": "float", + "description": "Non-controlling interest.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "total_equity_non_controlling_interests", + "type": "float", + "description": "Total equity non-controlling interests.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "total_liabilities_shareholders_equity", + "type": "float", + "description": "Total liabilities and shareholders equity.", + "default": null, + "optional": true } - ] - }, - "data": { - "standard": [ + ], + "polygon": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "accounts_receivable", + "type": "int", + "description": "Accounts receivable", + "default": null, + "optional": true }, { - "name": "name", - "type": "str", - "description": "Name of the entity.", - "default": "", - "optional": false + "name": "marketable_securities", + "type": "int", + "description": "Marketable securities", + "default": null, + "optional": true }, { - "name": "price", - "type": "float", - "description": "Last price.", - "default": "", - "optional": false + "name": "prepaid_expenses", + "type": "int", + "description": "Prepaid expenses", + "default": null, + "optional": true }, { - "name": "change", - "type": "float", - "description": "Change in price value.", - "default": "", - "optional": false + "name": "other_current_assets", + "type": "int", + "description": "Other current assets", + "default": null, + "optional": true }, { - "name": "percent_change", - "type": "float", - "description": "Percent change.", - "default": "", - "optional": false + "name": "total_current_assets", + "type": "int", + "description": "Total current assets", + "default": null, + "optional": true }, { - "name": "volume", - "type": "float", - "description": "The trading volume.", - "default": "", - "optional": false - } - ], - "yfinance": [ + "name": "property_plant_equipment_net", + "type": "int", + "description": "Property plant and equipment net", + "default": null, + "optional": true + }, { - "name": "market_cap", - "type": "float", - "description": "Market Cap displayed in billions.", - "default": "", - "optional": false + "name": "inventory", + "type": "int", + "description": "Inventory", + "default": null, + "optional": true }, { - "name": "avg_volume_3_months", - "type": "float", - "description": "Average volume over the last 3 months in millions.", - "default": "", - "optional": false + "name": "other_non_current_assets", + "type": "int", + "description": "Other non-current assets", + "default": null, + "optional": true }, { - "name": "pe_ratio_ttm", - "type": "float", - "description": "PE Ratio (TTM).", + "name": "total_non_current_assets", + "type": "int", + "description": "Total non-current assets", "default": null, "optional": true - } - ] - }, - "model": "EquityActive" - }, - "/equity/discovery/undervalued_large_caps": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get potentially undervalued large cap stocks.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.undervalued_large_caps(provider='yfinance')\nobb.equity.discovery.undervalued_large_caps(sort='desc', provider='yfinance')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", - "default": "desc", + "name": "intangible_assets", + "type": "int", + "description": "Intangible assets", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default.", - "default": "yfinance", + "name": "total_assets", + "type": "int", + "description": "Total assets", + "default": null, "optional": true - } - ], - "yfinance": [] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[EquityUndervaluedLargeCaps]", - "description": "Serializable results." + "name": "accounts_payable", + "type": "int", + "description": "Accounts payable", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['yfinance']]", - "description": "Provider name." + "name": "employee_wages", + "type": "int", + "description": "Employee wages", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "other_current_liabilities", + "type": "int", + "description": "Other current liabilities", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "total_current_liabilities", + "type": "int", + "description": "Total current liabilities", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "other_non_current_liabilities", + "type": "int", + "description": "Other non-current liabilities", + "default": null, + "optional": true + }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "total_non_current_liabilities", + "type": "int", + "description": "Total non-current liabilities", + "default": null, + "optional": true }, { - "name": "name", - "type": "str", - "description": "Name of the entity.", - "default": "", - "optional": false + "name": "long_term_debt", + "type": "int", + "description": "Long term debt", + "default": null, + "optional": true }, { - "name": "price", - "type": "float", - "description": "Last price.", - "default": "", - "optional": false + "name": "total_liabilities", + "type": "int", + "description": "Total liabilities", + "default": null, + "optional": true }, { - "name": "change", - "type": "float", - "description": "Change in price value.", - "default": "", - "optional": false + "name": "minority_interest", + "type": "int", + "description": "Minority interest", + "default": null, + "optional": true }, { - "name": "percent_change", - "type": "float", - "description": "Percent change.", - "default": "", - "optional": false + "name": "temporary_equity_attributable_to_parent", + "type": "int", + "description": "Temporary equity attributable to parent", + "default": null, + "optional": true }, { - "name": "volume", - "type": "float", - "description": "The trading volume.", - "default": "", - "optional": false - } - ], - "yfinance": [ + "name": "equity_attributable_to_parent", + "type": "int", + "description": "Equity attributable to parent", + "default": null, + "optional": true + }, { - "name": "market_cap", - "type": "float", - "description": "Market Cap.", + "name": "temporary_equity", + "type": "int", + "description": "Temporary equity", "default": null, "optional": true }, { - "name": "avg_volume_3_months", - "type": "float", - "description": "Average volume over the last 3 months in millions.", + "name": "preferred_stock", + "type": "int", + "description": "Preferred stock", "default": null, "optional": true }, { - "name": "pe_ratio_ttm", - "type": "float", - "description": "PE Ratio (TTM).", + "name": "redeemable_non_controlling_interest", + "type": "int", + "description": "Redeemable non-controlling interest", + "default": null, + "optional": true + }, + { + "name": "redeemable_non_controlling_interest_other", + "type": "int", + "description": "Redeemable non-controlling interest other", + "default": null, + "optional": true + }, + { + "name": "total_stock_holders_equity", + "type": "int", + "description": "Total stock holders equity", + "default": null, + "optional": true + }, + { + "name": "total_liabilities_and_stock_holders_equity", + "type": "int", + "description": "Total liabilities and stockholders equity", + "default": null, + "optional": true + }, + { + "name": "total_equity", + "type": "int", + "description": "Total equity", "default": null, "optional": true } - ] + ], + "yfinance": [] }, - "model": "EquityUndervaluedLargeCaps" + "model": "BalanceSheet" }, - "/equity/discovery/undervalued_growth": { + "/equity/fundamental/balance_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", + "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": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", - "default": "desc", + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10, "optional": true }, { "name": "provider", - "type": "Literal['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", + "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 } ], - "yfinance": [] + "fmp": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EquityUndervaluedGrowth]", + "type": "List[BalanceSheetGrowth]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['yfinance']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -9977,559 +9677,334 @@ "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "name", + "name": "period", "type": "str", - "description": "Name of the entity.", + "description": "Reporting period.", "default": "", "optional": false }, { - "name": "price", + "name": "growth_cash_and_cash_equivalents", "type": "float", - "description": "Last price.", + "description": "Growth rate of cash and cash equivalents.", "default": "", "optional": false }, { - "name": "change", + "name": "growth_short_term_investments", "type": "float", - "description": "Change in price value.", + "description": "Growth rate of short-term investments.", "default": "", "optional": false }, { - "name": "percent_change", + "name": "growth_cash_and_short_term_investments", "type": "float", - "description": "Percent change.", + "description": "Growth rate of cash and short-term investments.", "default": "", "optional": false }, { - "name": "volume", + "name": "growth_net_receivables", "type": "float", - "description": "The trading volume.", + "description": "Growth rate of net receivables.", "default": "", "optional": false - } - ], - "yfinance": [ - { - "name": "market_cap", - "type": "float", - "description": "Market Cap.", - "default": null, - "optional": true }, { - "name": "avg_volume_3_months", + "name": "growth_inventory", "type": "float", - "description": "Average volume over the last 3 months in millions.", - "default": null, - "optional": true + "description": "Growth rate of inventory.", + "default": "", + "optional": false }, { - "name": "pe_ratio_ttm", + "name": "growth_other_current_assets", "type": "float", - "description": "PE Ratio (TTM).", - "default": null, - "optional": true - } - ] - }, - "model": "EquityUndervaluedGrowth" - }, - "/equity/discovery/aggressive_small_caps": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get top small cap stocks based on earnings growth.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.aggressive_small_caps(provider='yfinance')\nobb.equity.discovery.aggressive_small_caps(sort='desc', provider='yfinance')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", - "default": "desc", - "optional": true + "description": "Growth rate of other current assets.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Literal['yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default.", - "default": "yfinance", - "optional": true - } - ], - "yfinance": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EquityAggressiveSmallCaps]", - "description": "Serializable results." + "name": "growth_total_current_assets", + "type": "float", + "description": "Growth rate of total current assets.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Optional[Literal['yfinance']]", - "description": "Provider name." + "name": "growth_property_plant_equipment_net", + "type": "float", + "description": "Growth rate of net property, plant, and equipment.", + "default": "", + "optional": false }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "growth_goodwill", + "type": "float", + "description": "Growth rate of goodwill.", + "default": "", + "optional": false }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "growth_intangible_assets", + "type": "float", + "description": "Growth rate of intangible assets.", + "default": "", + "optional": false }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "growth_goodwill_and_intangible_assets", + "type": "float", + "description": "Growth rate of goodwill and intangible assets.", "default": "", "optional": false }, { - "name": "name", - "type": "str", - "description": "Name of the entity.", + "name": "growth_long_term_investments", + "type": "float", + "description": "Growth rate of long-term investments.", "default": "", "optional": false }, { - "name": "price", + "name": "growth_tax_assets", "type": "float", - "description": "Last price.", + "description": "Growth rate of tax assets.", "default": "", "optional": false }, { - "name": "change", + "name": "growth_other_non_current_assets", "type": "float", - "description": "Change in price value.", + "description": "Growth rate of other non-current assets.", "default": "", "optional": false }, { - "name": "percent_change", + "name": "growth_total_non_current_assets", "type": "float", - "description": "Percent change.", + "description": "Growth rate of total non-current assets.", "default": "", "optional": false }, { - "name": "volume", + "name": "growth_other_assets", "type": "float", - "description": "The trading volume.", + "description": "Growth rate of other assets.", "default": "", "optional": false - } - ], - "yfinance": [ + }, { - "name": "market_cap", + "name": "growth_total_assets", "type": "float", - "description": "Market Cap.", - "default": null, - "optional": true + "description": "Growth rate of total assets.", + "default": "", + "optional": false }, { - "name": "avg_volume_3_months", + "name": "growth_account_payables", "type": "float", - "description": "Average volume over the last 3 months in millions.", - "default": null, - "optional": true + "description": "Growth rate of accounts payable.", + "default": "", + "optional": false }, { - "name": "pe_ratio_ttm", + "name": "growth_short_term_debt", "type": "float", - "description": "PE Ratio (TTM).", - "default": null, - "optional": true - } - ] - }, - "model": "EquityAggressiveSmallCaps" - }, - "/equity/discovery/growth_tech": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get top tech stocks based on revenue and earnings growth.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.growth_tech(provider='yfinance')\nobb.equity.discovery.growth_tech(sort='desc', provider='yfinance')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", - "default": "desc", - "optional": true + "description": "Growth rate of short-term debt.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Literal['yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default.", - "default": "yfinance", - "optional": true - } - ], - "yfinance": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[GrowthTechEquities]", - "description": "Serializable results." + "name": "growth_tax_payables", + "type": "float", + "description": "Growth rate of tax payables.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Optional[Literal['yfinance']]", - "description": "Provider name." + "name": "growth_deferred_revenue", + "type": "float", + "description": "Growth rate of deferred revenue.", + "default": "", + "optional": false }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "growth_other_current_liabilities", + "type": "float", + "description": "Growth rate of other current liabilities.", + "default": "", + "optional": false }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "growth_total_current_liabilities", + "type": "float", + "description": "Growth rate of total current liabilities.", + "default": "", + "optional": false }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "growth_long_term_debt", + "type": "float", + "description": "Growth rate of long-term debt.", "default": "", "optional": false }, { - "name": "name", - "type": "str", - "description": "Name of the entity.", + "name": "growth_deferred_revenue_non_current", + "type": "float", + "description": "Growth rate of non-current deferred revenue.", "default": "", "optional": false }, { - "name": "price", + "name": "growth_deferrred_tax_liabilities_non_current", "type": "float", - "description": "Last price.", + "description": "Growth rate of non-current deferred tax liabilities.", "default": "", "optional": false }, { - "name": "change", + "name": "growth_other_non_current_liabilities", "type": "float", - "description": "Change in price value.", + "description": "Growth rate of other non-current liabilities.", "default": "", "optional": false }, { - "name": "percent_change", + "name": "growth_total_non_current_liabilities", "type": "float", - "description": "Percent change.", + "description": "Growth rate of total non-current liabilities.", "default": "", "optional": false }, { - "name": "volume", + "name": "growth_other_liabilities", "type": "float", - "description": "The trading volume.", + "description": "Growth rate of other liabilities.", "default": "", "optional": false - } - ], - "yfinance": [ - { - "name": "market_cap", - "type": "float", - "description": "Market Cap.", - "default": null, - "optional": true }, { - "name": "avg_volume_3_months", + "name": "growth_total_liabilities", "type": "float", - "description": "Average volume over the last 3 months in millions.", - "default": null, - "optional": true + "description": "Growth rate of total liabilities.", + "default": "", + "optional": false }, { - "name": "pe_ratio_ttm", + "name": "growth_common_stock", "type": "float", - "description": "PE Ratio (TTM).", - "default": null, - "optional": true - } - ] - }, - "model": "GrowthTechEquities" - }, - "/equity/discovery/top_retail": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Track over $30B USD/day of individual investors trades.\n\nIt gives a daily view into retail activity and sentiment for over 9,500 US traded stocks,\nADRs, and ETPs.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.top_retail(provider='nasdaq')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 5, - "optional": true - }, - { - "name": "provider", - "type": "Literal['nasdaq']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default.", - "default": "nasdaq", - "optional": true - } - ], - "nasdaq": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[TopRetail]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['nasdaq']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", + "description": "Growth rate of common stock.", "default": "", "optional": false }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "growth_retained_earnings", + "type": "float", + "description": "Growth rate of retained earnings.", "default": "", "optional": false }, { - "name": "activity", + "name": "growth_accumulated_other_comprehensive_income_loss", "type": "float", - "description": "Activity of the symbol.", + "description": "Growth rate of accumulated other comprehensive income/loss.", "default": "", "optional": false }, { - "name": "sentiment", + "name": "growth_othertotal_stockholders_equity", "type": "float", - "description": "Sentiment of the symbol. 1 is bullish, -1 is bearish.", + "description": "Growth rate of other total stockholders' equity.", "default": "", "optional": false - } - ], - "nasdaq": [] - }, - "model": "TopRetail" - }, - "/equity/discovery/upcoming_release_days": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get upcoming earnings release dates.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.upcoming_release_days(provider='seeking_alpha')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "provider", - "type": "Literal['seeking_alpha']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'seeking_alpha' if there is no default.", - "default": "seeking_alpha", - "optional": true - } - ], - "seeking_alpha": [ - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.In this case, the number of lookahead days.", - "default": 10, - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[UpcomingReleaseDays]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['seeking_alpha']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "growth_total_stockholders_equity", + "type": "float", + "description": "Growth rate of total stockholders' equity.", "default": "", "optional": false }, { - "name": "name", - "type": "str", - "description": "The full name of the asset.", + "name": "growth_total_liabilities_and_stockholders_equity", + "type": "float", + "description": "Growth rate of total liabilities and stockholders' equity.", "default": "", "optional": false }, { - "name": "exchange", - "type": "str", - "description": "The exchange the asset is traded on.", + "name": "growth_total_investments", + "type": "float", + "description": "Growth rate of total investments.", "default": "", "optional": false }, { - "name": "release_time_type", - "type": "str", - "description": "The type of release time.", + "name": "growth_total_debt", + "type": "float", + "description": "Growth rate of total debt.", "default": "", "optional": false }, { - "name": "release_date", - "type": "date", - "description": "The date of the release.", + "name": "growth_net_debt", + "type": "float", + "description": "Growth rate of net debt.", "default": "", "optional": false } ], - "seeking_alpha": [ - { - "name": "sector_id", - "type": "int", - "description": "The sector ID of the asset.", - "default": "", - "optional": false - } - ] + "fmp": [] }, - "model": "UpcomingReleaseDays" + "model": "BalanceSheetGrowth" }, - "/equity/discovery/filings": { + "/equity/fundamental/cash": { "deprecated": { "flag": null, "message": null }, - "description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more.\n\nSEC filings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114,\nForeign Investment Disclosures and others. The annual 10-K report is required to be\nfiled annually and includes the company's financial statements, management discussion and analysis,\nand audited financial statements.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.filings(provider='fmp')\n# Get filings for the year 2023, limited to 100 results\nobb.equity.discovery.filings(start_date='2023-01-01', end_date='2023-12-31', limit=100, provider='fmp')\n```\n\n", + "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": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "form_type", + "name": "period", "type": "str", - "description": "Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types.", - "default": null, + "description": "Time period of the data to return.", + "default": "annual", "optional": true }, { "name": "limit", - "type": "int", + "type": "Annotated[int, Ge(ge=0)]", "description": "The number of data entries to return.", - "default": 100, + "default": 5, "optional": true }, { "name": "provider", - "type": "Literal['fmp']", + "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", "default": "fmp", "optional": true @@ -10537,128 +10012,149 @@ ], "fmp": [ { - "name": "is_done", - "type": "bool", - "description": "Flag for whether or not the filing is done.", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", "optional": true } - ] - }, - "returns": { - "OBBject": [ + ], + "intrinio": [ { - "name": "results", - "type": "List[DiscoveryFilings]", - "description": "Serializable results." + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", + "description": "None", + "default": "annual", + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", + "default": null, + "optional": true + } + ], + "polygon": [ { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, + "name": "filing_date", + "type": "date", + "description": "Filing date of the financial statement.", + "default": null, + "optional": true + }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "filing_date_lt", + "type": "date", + "description": "Filing date less than the given date.", + "default": null, + "optional": true + }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "filing_date_lte", + "type": "date", + "description": "Filing date less than or equal to the given date.", + "default": null, + "optional": true }, { - "name": "cik", - "type": "str", - "description": "Central Index Key (CIK) for the requested entity.", - "default": "", - "optional": false + "name": "filing_date_gt", + "type": "date", + "description": "Filing date greater than the given date.", + "default": null, + "optional": true }, { - "name": "title", - "type": "str", - "description": "Title of the filing.", - "default": "", - "optional": false + "name": "filing_date_gte", + "type": "date", + "description": "Filing date greater than or equal to the given date.", + "default": null, + "optional": true }, { - "name": "date", - "type": "datetime", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "period_of_report_date", + "type": "date", + "description": "Period of report date of the financial statement.", + "default": null, + "optional": true }, { - "name": "form_type", - "type": "str", - "description": "The form type of the filing", - "default": "", - "optional": false + "name": "period_of_report_date_lt", + "type": "date", + "description": "Period of report date less than the given date.", + "default": null, + "optional": true }, { - "name": "link", - "type": "str", - "description": "URL to the filing page on the SEC site.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "DiscoveryFilings" - }, - "/equity/fundamental/multiples": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get equity valuation multiples for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.multiples(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ + "name": "period_of_report_date_lte", + "type": "date", + "description": "Period of report date less than or equal to the given date.", + "default": null, + "optional": true + }, { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", - "default": "", - "optional": false + "name": "period_of_report_date_gt", + "type": "date", + "description": "Period of report date greater than the given date.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "period_of_report_date_gte", + "type": "date", + "description": "Period of report date greater than or equal to the given date.", + "default": null, + "optional": true + }, + { + "name": "include_sources", + "type": "bool", + "description": "Whether to include the sources of the financial statement.", + "default": false, + "optional": true + }, + { + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order of the financial statement.", + "default": null, + "optional": true + }, + { + "name": "sort", + "type": "Literal['filing_date', 'period_of_report_date']", + "description": "Sort of the financial statement.", + "default": null, "optional": true } ], - "fmp": [] + "yfinance": [ + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", + "optional": true + } + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EquityValuationMultiples]", + "type": "List[CashFlowStatement]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", "description": "Provider name." }, { @@ -10681,1899 +10177,1868 @@ "data": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", "default": "", "optional": false }, { - "name": "revenue_per_share_ttm", - "type": "float", - "description": "Revenue per share calculated as trailing twelve months.", + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", "default": null, "optional": true }, { - "name": "net_income_per_share_ttm", - "type": "float", - "description": "Net income per share calculated as trailing twelve months.", + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "operating_cash_flow_per_share_ttm", - "type": "float", - "description": "Operating cash flow per share calculated as trailing twelve months.", + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", "default": null, "optional": true }, { - "name": "free_cash_flow_per_share_ttm", - "type": "float", - "description": "Free cash flow per share calculated as trailing twelve months.", + "name": "filing_date", + "type": "date", + "description": "The date of the filing.", "default": null, "optional": true }, { - "name": "cash_per_share_ttm", - "type": "float", - "description": "Cash per share calculated as trailing twelve months.", + "name": "accepted_date", + "type": "datetime", + "description": "The date the filing was accepted.", "default": null, "optional": true }, { - "name": "book_value_per_share_ttm", - "type": "float", - "description": "Book value per share calculated as trailing twelve months.", + "name": "reported_currency", + "type": "str", + "description": "The currency in which the cash flow statement was reported.", "default": null, "optional": true }, { - "name": "tangible_book_value_per_share_ttm", + "name": "net_income", "type": "float", - "description": "Tangible book value per share calculated as trailing twelve months.", + "description": "Net income.", "default": null, "optional": true }, { - "name": "shareholders_equity_per_share_ttm", + "name": "depreciation_and_amortization", "type": "float", - "description": "Shareholders equity per share calculated as trailing twelve months.", + "description": "Depreciation and amortization.", "default": null, "optional": true }, { - "name": "interest_debt_per_share_ttm", + "name": "deferred_income_tax", "type": "float", - "description": "Interest debt per share calculated as trailing twelve months.", + "description": "Deferred income tax.", "default": null, "optional": true }, { - "name": "market_cap_ttm", + "name": "stock_based_compensation", "type": "float", - "description": "Market capitalization calculated as trailing twelve months.", + "description": "Stock-based compensation.", "default": null, "optional": true }, { - "name": "enterprise_value_ttm", + "name": "change_in_working_capital", "type": "float", - "description": "Enterprise value calculated as trailing twelve months.", + "description": "Change in working capital.", "default": null, "optional": true }, { - "name": "pe_ratio_ttm", + "name": "change_in_account_receivables", "type": "float", - "description": "Price-to-earnings ratio (P/E ratio) calculated as trailing twelve months.", + "description": "Change in account receivables.", "default": null, "optional": true }, { - "name": "price_to_sales_ratio_ttm", + "name": "change_in_inventory", "type": "float", - "description": "Price-to-sales ratio calculated as trailing twelve months.", + "description": "Change in inventory.", "default": null, "optional": true }, { - "name": "pocf_ratio_ttm", + "name": "change_in_account_payable", "type": "float", - "description": "Price-to-operating cash flow ratio calculated as trailing twelve months.", + "description": "Change in account payable.", "default": null, "optional": true }, { - "name": "pfcf_ratio_ttm", + "name": "change_in_other_working_capital", "type": "float", - "description": "Price-to-free cash flow ratio calculated as trailing twelve months.", + "description": "Change in other working capital.", "default": null, "optional": true }, { - "name": "pb_ratio_ttm", + "name": "change_in_other_non_cash_items", "type": "float", - "description": "Price-to-book ratio calculated as trailing twelve months.", + "description": "Change in other non-cash items.", "default": null, "optional": true }, { - "name": "ptb_ratio_ttm", + "name": "net_cash_from_operating_activities", "type": "float", - "description": "Price-to-tangible book ratio calculated as trailing twelve months.", + "description": "Net cash from operating activities.", "default": null, "optional": true }, { - "name": "ev_to_sales_ttm", + "name": "purchase_of_property_plant_and_equipment", "type": "float", - "description": "Enterprise value-to-sales ratio calculated as trailing twelve months.", + "description": "Purchase of property, plant and equipment.", "default": null, "optional": true }, { - "name": "enterprise_value_over_ebitda_ttm", + "name": "acquisitions", "type": "float", - "description": "Enterprise value-to-EBITDA ratio calculated as trailing twelve months.", + "description": "Acquisitions.", "default": null, "optional": true }, { - "name": "ev_to_operating_cash_flow_ttm", + "name": "purchase_of_investment_securities", "type": "float", - "description": "Enterprise value-to-operating cash flow ratio calculated as trailing twelve months.", + "description": "Purchase of investment securities.", "default": null, "optional": true }, { - "name": "ev_to_free_cash_flow_ttm", + "name": "sale_and_maturity_of_investments", "type": "float", - "description": "Enterprise value-to-free cash flow ratio calculated as trailing twelve months.", + "description": "Sale and maturity of investments.", "default": null, "optional": true }, { - "name": "earnings_yield_ttm", + "name": "other_investing_activities", "type": "float", - "description": "Earnings yield calculated as trailing twelve months.", + "description": "Other investing activities.", "default": null, "optional": true }, { - "name": "free_cash_flow_yield_ttm", + "name": "net_cash_from_investing_activities", "type": "float", - "description": "Free cash flow yield calculated as trailing twelve months.", + "description": "Net cash from investing activities.", "default": null, "optional": true }, { - "name": "debt_to_equity_ttm", + "name": "repayment_of_debt", "type": "float", - "description": "Debt-to-equity ratio calculated as trailing twelve months.", + "description": "Repayment of debt.", "default": null, "optional": true }, { - "name": "debt_to_assets_ttm", + "name": "issuance_of_common_equity", "type": "float", - "description": "Debt-to-assets ratio calculated as trailing twelve months.", + "description": "Issuance of common equity.", "default": null, "optional": true }, { - "name": "net_debt_to_ebitda_ttm", + "name": "repurchase_of_common_equity", "type": "float", - "description": "Net debt-to-EBITDA ratio calculated as trailing twelve months.", + "description": "Repurchase of common equity.", "default": null, "optional": true }, { - "name": "current_ratio_ttm", + "name": "payment_of_dividends", "type": "float", - "description": "Current ratio calculated as trailing twelve months.", + "description": "Payment of dividends.", "default": null, "optional": true }, { - "name": "interest_coverage_ttm", + "name": "other_financing_activities", "type": "float", - "description": "Interest coverage calculated as trailing twelve months.", + "description": "Other financing activities.", "default": null, "optional": true }, { - "name": "income_quality_ttm", + "name": "net_cash_from_financing_activities", "type": "float", - "description": "Income quality calculated as trailing twelve months.", + "description": "Net cash from financing activities.", "default": null, "optional": true }, { - "name": "dividend_yield_ttm", + "name": "effect_of_exchange_rate_changes_on_cash", "type": "float", - "description": "Dividend yield calculated as trailing twelve months.", + "description": "Effect of exchange rate changes on cash.", "default": null, "optional": true }, { - "name": "dividend_yield_percentage_ttm", + "name": "net_change_in_cash_and_equivalents", "type": "float", - "description": "Dividend yield percentage calculated as trailing twelve months.", + "description": "Net change in cash and equivalents.", "default": null, "optional": true }, { - "name": "dividend_to_market_cap_ttm", + "name": "cash_at_beginning_of_period", "type": "float", - "description": "Dividend to market capitalization ratio calculated as trailing twelve months.", + "description": "Cash at beginning of period.", "default": null, "optional": true }, { - "name": "dividend_per_share_ttm", + "name": "cash_at_end_of_period", "type": "float", - "description": "Dividend per share calculated as trailing twelve months.", + "description": "Cash at end of period.", "default": null, "optional": true }, { - "name": "payout_ratio_ttm", + "name": "operating_cash_flow", "type": "float", - "description": "Payout ratio calculated as trailing twelve months.", + "description": "Operating cash flow.", "default": null, "optional": true }, { - "name": "sales_general_and_administrative_to_revenue_ttm", + "name": "capital_expenditure", "type": "float", - "description": "Sales general and administrative expenses-to-revenue ratio calculated as trailing twelve months.", + "description": "Capital expenditure.", "default": null, "optional": true }, { - "name": "research_and_development_to_revenue_ttm", + "name": "free_cash_flow", "type": "float", - "description": "Research and development expenses-to-revenue ratio calculated as trailing twelve months.", + "description": "None", "default": null, "optional": true }, { - "name": "intangibles_to_total_assets_ttm", - "type": "float", - "description": "Intangibles-to-total assets ratio calculated as trailing twelve months.", + "name": "link", + "type": "str", + "description": "Link to the filing.", "default": null, "optional": true }, { - "name": "capex_to_operating_cash_flow_ttm", - "type": "float", - "description": "Capital expenditures-to-operating cash flow ratio calculated as trailing twelve months.", + "name": "final_link", + "type": "str", + "description": "Link to the filing document.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "capex_to_revenue_ttm", - "type": "float", - "description": "Capital expenditures-to-revenue ratio calculated as trailing twelve months.", + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet is reported.", "default": null, "optional": true }, { - "name": "capex_to_depreciation_ttm", + "name": "net_income_continuing_operations", "type": "float", - "description": "Capital expenditures-to-depreciation ratio calculated as trailing twelve months.", + "description": "Net Income (Continuing Operations)", "default": null, "optional": true }, { - "name": "stock_based_compensation_to_revenue_ttm", + "name": "net_income_discontinued_operations", "type": "float", - "description": "Stock-based compensation-to-revenue ratio calculated as trailing twelve months.", + "description": "Net Income (Discontinued Operations)", "default": null, "optional": true }, { - "name": "graham_number_ttm", + "name": "net_income", "type": "float", - "description": "Graham number calculated as trailing twelve months.", + "description": "Consolidated Net Income.", "default": null, "optional": true }, { - "name": "roic_ttm", + "name": "provision_for_loan_losses", "type": "float", - "description": "Return on invested capital calculated as trailing twelve months.", + "description": "Provision for Loan Losses", "default": null, "optional": true }, { - "name": "return_on_tangible_assets_ttm", + "name": "provision_for_credit_losses", "type": "float", - "description": "Return on tangible assets calculated as trailing twelve months.", + "description": "Provision for credit losses", "default": null, "optional": true }, { - "name": "graham_net_net_ttm", + "name": "depreciation_expense", "type": "float", - "description": "Graham net-net working capital calculated as trailing twelve months.", + "description": "Depreciation Expense.", "default": null, "optional": true }, { - "name": "working_capital_ttm", + "name": "amortization_expense", "type": "float", - "description": "Working capital calculated as trailing twelve months.", + "description": "Amortization Expense.", "default": null, "optional": true }, { - "name": "tangible_asset_value_ttm", + "name": "share_based_compensation", "type": "float", - "description": "Tangible asset value calculated as trailing twelve months.", + "description": "Share-based compensation.", "default": null, "optional": true }, { - "name": "net_current_asset_value_ttm", + "name": "non_cash_adjustments_to_reconcile_net_income", "type": "float", - "description": "Net current asset value calculated as trailing twelve months.", + "description": "Non-Cash Adjustments to Reconcile Net Income.", "default": null, "optional": true }, { - "name": "invested_capital_ttm", + "name": "changes_in_operating_assets_and_liabilities", "type": "float", - "description": "Invested capital calculated as trailing twelve months.", + "description": "Changes in Operating Assets and Liabilities (Net)", "default": null, "optional": true }, { - "name": "average_receivables_ttm", + "name": "net_cash_from_continuing_operating_activities", "type": "float", - "description": "Average receivables calculated as trailing twelve months.", + "description": "Net Cash from Continuing Operating Activities", "default": null, "optional": true }, { - "name": "average_payables_ttm", + "name": "net_cash_from_discontinued_operating_activities", "type": "float", - "description": "Average payables calculated as trailing twelve months.", + "description": "Net Cash from Discontinued Operating Activities", "default": null, "optional": true }, { - "name": "average_inventory_ttm", + "name": "net_cash_from_operating_activities", "type": "float", - "description": "Average inventory calculated as trailing twelve months.", + "description": "Net Cash from Operating Activities", "default": null, "optional": true }, { - "name": "days_sales_outstanding_ttm", + "name": "divestitures", "type": "float", - "description": "Days sales outstanding calculated as trailing twelve months.", + "description": "Divestitures", "default": null, "optional": true }, { - "name": "days_payables_outstanding_ttm", + "name": "sale_of_property_plant_and_equipment", "type": "float", - "description": "Days payables outstanding calculated as trailing twelve months.", + "description": "Sale of Property, Plant, and Equipment", "default": null, "optional": true }, { - "name": "days_of_inventory_on_hand_ttm", + "name": "acquisitions", "type": "float", - "description": "Days of inventory on hand calculated as trailing twelve months.", + "description": "Acquisitions", "default": null, "optional": true }, { - "name": "receivables_turnover_ttm", + "name": "purchase_of_investments", "type": "float", - "description": "Receivables turnover calculated as trailing twelve months.", + "description": "Purchase of Investments", "default": null, "optional": true }, { - "name": "payables_turnover_ttm", + "name": "purchase_of_investment_securities", "type": "float", - "description": "Payables turnover calculated as trailing twelve months.", + "description": "Purchase of Investment Securities", "default": null, "optional": true }, { - "name": "inventory_turnover_ttm", + "name": "sale_and_maturity_of_investments", "type": "float", - "description": "Inventory turnover calculated as trailing twelve months.", + "description": "Sale and Maturity of Investments", "default": null, "optional": true }, { - "name": "roe_ttm", + "name": "loans_held_for_sale", "type": "float", - "description": "Return on equity calculated as trailing twelve months.", + "description": "Loans Held for Sale (Net)", "default": null, "optional": true }, { - "name": "capex_per_share_ttm", + "name": "purchase_of_property_plant_and_equipment", "type": "float", - "description": "Capital expenditures per share calculated as trailing twelve months.", + "description": "Purchase of Property, Plant, and Equipment", "default": null, "optional": true - } - ], - "fmp": [] - }, - "model": "EquityValuationMultiples" - }, - "/equity/fundamental/balance": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the balance sheet for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.balance(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.balance(symbol='AAPL', period='annual', limit=5, provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "period", - "type": "str", - "description": "Time period of the data to return.", - "default": "annual", + "name": "other_investing_activities", + "type": "float", + "description": "Other Investing Activities (Net)", + "default": null, "optional": true }, { - "name": "limit", - "type": "Annotated[int, Ge(ge=0)]", - "description": "The number of data entries to return.", - "default": 5, + "name": "net_cash_from_continuing_investing_activities", + "type": "float", + "description": "Net Cash from Continuing Investing Activities", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", - "optional": true - } - ], - "intrinio": [ - { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", + "name": "net_cash_from_discontinued_investing_activities", + "type": "float", + "description": "Net Cash from Discontinued Investing Activities", + "default": null, "optional": true }, { - "name": "fiscal_year", - "type": "int", - "description": "The specific fiscal year. Reports do not go beyond 2008.", + "name": "net_cash_from_investing_activities", + "type": "float", + "description": "Net Cash from Investing Activities", "default": null, "optional": true - } - ], - "polygon": [ - { - "name": "period", - "type": "Literal['annual', 'quarter', 'ttm']", - "description": "None", - "default": "annual", - "optional": true }, { - "name": "filing_date", - "type": "date", - "description": "Filing date of the financial statement.", + "name": "payment_of_dividends", + "type": "float", + "description": "Payment of Dividends", "default": null, "optional": true }, { - "name": "filing_date_lt", - "type": "date", - "description": "Filing date less than the given date.", + "name": "repurchase_of_common_equity", + "type": "float", + "description": "Repurchase of Common Equity", "default": null, "optional": true }, { - "name": "filing_date_lte", - "type": "date", - "description": "Filing date less than or equal to the given date.", - "default": null, - "optional": true - }, - { - "name": "filing_date_gt", - "type": "date", - "description": "Filing date greater than the given date.", - "default": null, - "optional": true - }, - { - "name": "filing_date_gte", - "type": "date", - "description": "Filing date greater than or equal to the given date.", - "default": null, - "optional": true - }, - { - "name": "period_of_report_date", - "type": "date", - "description": "Period of report date of the financial statement.", - "default": null, - "optional": true - }, - { - "name": "period_of_report_date_lt", - "type": "date", - "description": "Period of report date less than the given date.", + "name": "repurchase_of_preferred_equity", + "type": "float", + "description": "Repurchase of Preferred Equity", "default": null, "optional": true }, { - "name": "period_of_report_date_lte", - "type": "date", - "description": "Period of report date less than or equal to the given date.", + "name": "issuance_of_common_equity", + "type": "float", + "description": "Issuance of Common Equity", "default": null, "optional": true }, { - "name": "period_of_report_date_gt", - "type": "date", - "description": "Period of report date greater than the given date.", + "name": "issuance_of_preferred_equity", + "type": "float", + "description": "Issuance of Preferred Equity", "default": null, "optional": true }, { - "name": "period_of_report_date_gte", - "type": "date", - "description": "Period of report date greater than or equal to the given date.", + "name": "issuance_of_debt", + "type": "float", + "description": "Issuance of Debt", "default": null, "optional": true }, { - "name": "include_sources", - "type": "bool", - "description": "Whether to include the sources of the financial statement.", - "default": true, - "optional": true - }, - { - "name": "order", - "type": "Literal['asc', 'desc']", - "description": "Order of the financial statement.", + "name": "repayment_of_debt", + "type": "float", + "description": "Repayment of Debt", "default": null, "optional": true }, { - "name": "sort", - "type": "Literal['filing_date', 'period_of_report_date']", - "description": "Sort of the financial statement.", + "name": "other_financing_activities", + "type": "float", + "description": "Other Financing Activities (Net)", "default": null, "optional": true - } - ], - "yfinance": [ - { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[BalanceSheet]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "period_ending", - "type": "date", - "description": "The end date of the reporting period.", - "default": "", - "optional": false }, { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the report.", + "name": "cash_interest_received", + "type": "float", + "description": "Cash Interest Received", "default": null, "optional": true }, { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the fiscal period.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "filing_date", - "type": "date", - "description": "The date when the filing was made.", + "name": "net_change_in_deposits", + "type": "float", + "description": "Net Change in Deposits", "default": null, "optional": true }, { - "name": "accepted_date", - "type": "datetime", - "description": "The date and time when the filing was accepted.", + "name": "net_increase_in_fed_funds_sold", + "type": "float", + "description": "Net Increase in Fed Funds Sold", "default": null, "optional": true }, { - "name": "reported_currency", - "type": "str", - "description": "The currency in which the balance sheet was reported.", + "name": "net_cash_from_continuing_financing_activities", + "type": "float", + "description": "Net Cash from Continuing Financing Activities", "default": null, "optional": true }, { - "name": "cash_and_cash_equivalents", + "name": "net_cash_from_discontinued_financing_activities", "type": "float", - "description": "Cash and cash equivalents.", + "description": "Net Cash from Discontinued Financing Activities", "default": null, "optional": true }, { - "name": "short_term_investments", + "name": "net_cash_from_financing_activities", "type": "float", - "description": "Short term investments.", + "description": "Net Cash from Financing Activities", "default": null, "optional": true }, { - "name": "cash_and_short_term_investments", + "name": "effect_of_exchange_rate_changes", "type": "float", - "description": "Cash and short term investments.", + "description": "Effect of Exchange Rate Changes", "default": null, "optional": true }, { - "name": "net_receivables", + "name": "other_net_changes_in_cash", "type": "float", - "description": "Net receivables.", + "description": "Other Net Changes in Cash", "default": null, "optional": true }, { - "name": "inventory", + "name": "net_change_in_cash_and_equivalents", "type": "float", - "description": "Inventory.", + "description": "Net Change in Cash and Equivalents", "default": null, "optional": true }, { - "name": "other_current_assets", + "name": "cash_income_taxes_paid", "type": "float", - "description": "Other current assets.", + "description": "Cash Income Taxes Paid", "default": null, "optional": true }, { - "name": "total_current_assets", + "name": "cash_interest_paid", "type": "float", - "description": "Total current assets.", + "description": "Cash Interest Paid", "default": null, "optional": true - }, + } + ], + "polygon": [ { - "name": "plant_property_equipment_net", - "type": "float", - "description": "Plant property equipment net.", + "name": "net_cash_flow_from_operating_activities_continuing", + "type": "int", + "description": "Net cash flow from operating activities continuing.", "default": null, "optional": true }, { - "name": "goodwill", - "type": "float", - "description": "Goodwill.", + "name": "net_cash_flow_from_operating_activities_discontinued", + "type": "int", + "description": "Net cash flow from operating activities discontinued.", "default": null, "optional": true }, { - "name": "intangible_assets", - "type": "float", - "description": "Intangible assets.", + "name": "net_cash_flow_from_operating_activities", + "type": "int", + "description": "Net cash flow from operating activities.", "default": null, "optional": true }, { - "name": "goodwill_and_intangible_assets", - "type": "float", - "description": "Goodwill and intangible assets.", + "name": "net_cash_flow_from_investing_activities_continuing", + "type": "int", + "description": "Net cash flow from investing activities continuing.", "default": null, "optional": true }, { - "name": "long_term_investments", - "type": "float", - "description": "Long term investments.", + "name": "net_cash_flow_from_investing_activities_discontinued", + "type": "int", + "description": "Net cash flow from investing activities discontinued.", "default": null, "optional": true }, { - "name": "tax_assets", - "type": "float", - "description": "Tax assets.", + "name": "net_cash_flow_from_investing_activities", + "type": "int", + "description": "Net cash flow from investing activities.", "default": null, "optional": true }, { - "name": "other_non_current_assets", - "type": "float", - "description": "Other non current assets.", + "name": "net_cash_flow_from_financing_activities_continuing", + "type": "int", + "description": "Net cash flow from financing activities continuing.", "default": null, "optional": true }, { - "name": "non_current_assets", - "type": "float", - "description": "Total non current assets.", + "name": "net_cash_flow_from_financing_activities_discontinued", + "type": "int", + "description": "Net cash flow from financing activities discontinued.", "default": null, "optional": true }, { - "name": "other_assets", - "type": "float", - "description": "Other assets.", + "name": "net_cash_flow_from_financing_activities", + "type": "int", + "description": "Net cash flow from financing activities.", "default": null, "optional": true }, { - "name": "total_assets", - "type": "float", - "description": "Total assets.", + "name": "net_cash_flow_continuing", + "type": "int", + "description": "Net cash flow continuing.", "default": null, "optional": true }, { - "name": "accounts_payable", - "type": "float", - "description": "Accounts payable.", + "name": "net_cash_flow_discontinued", + "type": "int", + "description": "Net cash flow discontinued.", "default": null, "optional": true }, { - "name": "short_term_debt", - "type": "float", - "description": "Short term debt.", + "name": "exchange_gains_losses", + "type": "int", + "description": "Exchange gains losses.", "default": null, "optional": true }, { - "name": "tax_payables", - "type": "float", - "description": "Tax payables.", + "name": "net_cash_flow", + "type": "int", + "description": "Net cash flow.", "default": null, "optional": true - }, + } + ], + "yfinance": [] + }, + "model": "CashFlowStatement" + }, + "/equity/fundamental/reported_financials": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get financial statements as reported by the company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.reported_financials(symbol='AAPL', provider='intrinio')\n# Get AAPL balance sheet with a limit of 10 items.\nobb.equity.fundamental.reported_financials(symbol='AAPL', period='annual', statement_type='balance', limit=10, provider='intrinio')\n# Get reported income statement\nobb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='income', provider='intrinio')\n# Get reported cash flow statement\nobb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='cash', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ { - "name": "current_deferred_revenue", - "type": "float", - "description": "Current deferred revenue.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "other_current_liabilities", - "type": "float", - "description": "Other current liabilities.", - "default": null, + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", "optional": true }, { - "name": "total_current_liabilities", - "type": "float", - "description": "Total current liabilities.", - "default": null, + "name": "statement_type", + "type": "str", + "description": "The type of financial statement - i.e, balance, income, cash.", + "default": "balance", "optional": true }, { - "name": "long_term_debt", - "type": "float", - "description": "Long term debt.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return. Although the response object contains multiple results, because of the variance in the fields, year-to-year and quarter-to-quarter, it is recommended to view results in small chunks.", + "default": 100, "optional": true }, { - "name": "deferred_revenue_non_current", - "type": "float", - "description": "Non current deferred revenue.", - "default": null, + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", "optional": true - }, + } + ], + "intrinio": [ { - "name": "deferred_tax_liabilities_non_current", - "type": "float", - "description": "Deferred tax liabilities non current.", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", "optional": true }, { - "name": "other_non_current_liabilities", - "type": "float", - "description": "Other non current liabilities.", - "default": null, + "name": "statement_type", + "type": "Literal['balance', 'income', 'cash']", + "description": "Cash flow statements are reported as YTD, Q4 is the same as FY.", + "default": "income", "optional": true }, { - "name": "total_non_current_liabilities", - "type": "float", - "description": "Total non current liabilities.", + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", "default": null, "optional": true - }, + } + ] + }, + "returns": { + "OBBject": [ { - "name": "other_liabilities", - "type": "float", - "description": "Other liabilities.", - "default": null, - "optional": true + "name": "results", + "type": "List[ReportedFinancials]", + "description": "Serializable results." }, { - "name": "capital_lease_obligations", - "type": "float", - "description": "Capital lease obligations.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['intrinio']]", + "description": "Provider name." }, { - "name": "total_liabilities", - "type": "float", - "description": "Total liabilities.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "preferred_stock", - "type": "float", - "description": "Preferred stock.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "common_stock", - "type": "float", - "description": "Common stock.", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "retained_earnings", - "type": "float", - "description": "Retained earnings.", - "default": null, - "optional": true + "name": "period_ending", + "type": "date", + "description": "The ending date of the reporting period.", + "default": "", + "optional": false }, { - "name": "accumulated_other_comprehensive_income", - "type": "float", - "description": "Accumulated other comprehensive income (loss).", - "default": null, - "optional": true + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report (e.g. FY, Q1, etc.).", + "default": "", + "optional": false }, { - "name": "other_shareholders_equity", - "type": "float", - "description": "Other shareholders equity.", + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", "default": null, "optional": true + } + ], + "intrinio": [] + }, + "model": "ReportedFinancials" + }, + "/equity/fundamental/cash_growth": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the growth of a company's cash flow statement items over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.cash_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.cash_growth(symbol='AAPL', limit=10, provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "other_total_shareholders_equity", - "type": "float", - "description": "Other total shareholders equity.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10, "optional": true }, { - "name": "total_common_equity", - "type": "float", - "description": "Total common equity.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CashFlowStatementGrowth]", + "description": "Serializable results." }, { - "name": "total_equity_non_controlling_interests", - "type": "float", - "description": "Total equity non controlling interests.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "total_liabilities_and_shareholders_equity", - "type": "float", - "description": "Total liabilities and shareholders equity.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "minority_interest", - "type": "float", - "description": "Minority interest.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "total_liabilities_and_total_equity", - "type": "float", - "description": "Total liabilities and total equity.", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "total_investments", - "type": "float", - "description": "Total investments.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "total_debt", - "type": "float", - "description": "Total debt.", - "default": null, - "optional": true + "name": "period", + "type": "str", + "description": "Period the statement is returned for.", + "default": "", + "optional": false }, { - "name": "net_debt", + "name": "growth_net_income", "type": "float", - "description": "Net debt.", - "default": null, - "optional": true + "description": "Growth rate of net income.", + "default": "", + "optional": false }, { - "name": "link", - "type": "str", - "description": "Link to the filing.", - "default": null, - "optional": true + "name": "growth_depreciation_and_amortization", + "type": "float", + "description": "Growth rate of depreciation and amortization.", + "default": "", + "optional": false }, { - "name": "final_link", - "type": "str", - "description": "Link to the filing document.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "reported_currency", - "type": "str", - "description": "The currency in which the balance sheet is reported.", - "default": null, - "optional": true + "name": "growth_deferred_income_tax", + "type": "float", + "description": "Growth rate of deferred income tax.", + "default": "", + "optional": false }, { - "name": "cash_and_cash_equivalents", + "name": "growth_stock_based_compensation", "type": "float", - "description": "Cash and cash equivalents.", - "default": null, - "optional": true + "description": "Growth rate of stock-based compensation.", + "default": "", + "optional": false }, { - "name": "cash_and_due_from_banks", + "name": "growth_change_in_working_capital", "type": "float", - "description": "Cash and due from banks.", - "default": null, - "optional": true + "description": "Growth rate of change in working capital.", + "default": "", + "optional": false }, { - "name": "restricted_cash", + "name": "growth_accounts_receivables", "type": "float", - "description": "Restricted cash.", - "default": null, - "optional": true + "description": "Growth rate of accounts receivables.", + "default": "", + "optional": false }, { - "name": "short_term_investments", + "name": "growth_inventory", "type": "float", - "description": "Short term investments.", - "default": null, - "optional": true + "description": "Growth rate of inventory.", + "default": "", + "optional": false }, { - "name": "federal_funds_sold", + "name": "growth_accounts_payables", "type": "float", - "description": "Federal funds sold.", - "default": null, - "optional": true + "description": "Growth rate of accounts payables.", + "default": "", + "optional": false }, { - "name": "accounts_receivable", + "name": "growth_other_working_capital", "type": "float", - "description": "Accounts receivable.", - "default": null, - "optional": true + "description": "Growth rate of other working capital.", + "default": "", + "optional": false }, { - "name": "note_and_lease_receivable", + "name": "growth_other_non_cash_items", "type": "float", - "description": "Note and lease receivable. (Vendor non-trade receivables)", - "default": null, - "optional": true + "description": "Growth rate of other non-cash items.", + "default": "", + "optional": false }, { - "name": "inventories", + "name": "growth_net_cash_provided_by_operating_activities", "type": "float", - "description": "Net Inventories.", - "default": null, - "optional": true + "description": "Growth rate of net cash provided by operating activities.", + "default": "", + "optional": false }, { - "name": "customer_and_other_receivables", + "name": "growth_investments_in_property_plant_and_equipment", "type": "float", - "description": "Customer and other receivables.", - "default": null, - "optional": true + "description": "Growth rate of investments in property, plant, and equipment.", + "default": "", + "optional": false }, { - "name": "interest_bearing_deposits_at_other_banks", + "name": "growth_acquisitions_net", "type": "float", - "description": "Interest bearing deposits at other banks.", - "default": null, - "optional": true + "description": "Growth rate of net acquisitions.", + "default": "", + "optional": false }, { - "name": "time_deposits_placed_and_other_short_term_investments", + "name": "growth_purchases_of_investments", "type": "float", - "description": "Time deposits placed and other short term investments.", - "default": null, - "optional": true + "description": "Growth rate of purchases of investments.", + "default": "", + "optional": false }, { - "name": "trading_account_securities", + "name": "growth_sales_maturities_of_investments", "type": "float", - "description": "Trading account securities.", - "default": null, - "optional": true + "description": "Growth rate of sales maturities of investments.", + "default": "", + "optional": false }, { - "name": "loans_and_leases", + "name": "growth_other_investing_activities", "type": "float", - "description": "Loans and leases.", - "default": null, - "optional": true + "description": "Growth rate of other investing activities.", + "default": "", + "optional": false }, { - "name": "allowance_for_loan_and_lease_losses", + "name": "growth_net_cash_used_for_investing_activities", "type": "float", - "description": "Allowance for loan and lease losses.", - "default": null, - "optional": true + "description": "Growth rate of net cash used for investing activities.", + "default": "", + "optional": false }, { - "name": "current_deferred_refundable_income_taxes", + "name": "growth_debt_repayment", "type": "float", - "description": "Current deferred refundable income taxes.", - "default": null, - "optional": true + "description": "Growth rate of debt repayment.", + "default": "", + "optional": false }, { - "name": "other_current_assets", + "name": "growth_common_stock_issued", "type": "float", - "description": "Other current assets.", - "default": null, - "optional": true + "description": "Growth rate of common stock issued.", + "default": "", + "optional": false }, { - "name": "loans_and_leases_net_of_allowance", + "name": "growth_common_stock_repurchased", "type": "float", - "description": "Loans and leases net of allowance.", - "default": null, - "optional": true + "description": "Growth rate of common stock repurchased.", + "default": "", + "optional": false }, { - "name": "accrued_investment_income", + "name": "growth_dividends_paid", "type": "float", - "description": "Accrued investment income.", - "default": null, - "optional": true + "description": "Growth rate of dividends paid.", + "default": "", + "optional": false }, { - "name": "other_current_non_operating_assets", + "name": "growth_other_financing_activities", "type": "float", - "description": "Other current non-operating assets.", - "default": null, - "optional": true + "description": "Growth rate of other financing activities.", + "default": "", + "optional": false }, { - "name": "loans_held_for_sale", + "name": "growth_net_cash_used_provided_by_financing_activities", "type": "float", - "description": "Loans held for sale.", - "default": null, - "optional": true + "description": "Growth rate of net cash used/provided by financing activities.", + "default": "", + "optional": false }, { - "name": "prepaid_expenses", + "name": "growth_effect_of_forex_changes_on_cash", "type": "float", - "description": "Prepaid expenses.", - "default": null, - "optional": true + "description": "Growth rate of the effect of foreign exchange changes on cash.", + "default": "", + "optional": false }, { - "name": "total_current_assets", + "name": "growth_net_change_in_cash", "type": "float", - "description": "Total current assets.", - "default": null, - "optional": true + "description": "Growth rate of net change in cash.", + "default": "", + "optional": false }, { - "name": "plant_property_equipment_gross", + "name": "growth_cash_at_end_of_period", "type": "float", - "description": "Plant property equipment gross.", - "default": null, - "optional": true + "description": "Growth rate of cash at the end of the period.", + "default": "", + "optional": false }, { - "name": "accumulated_depreciation", + "name": "growth_cash_at_beginning_of_period", "type": "float", - "description": "Accumulated depreciation.", - "default": null, - "optional": true + "description": "Growth rate of cash at the beginning of the period.", + "default": "", + "optional": false }, { - "name": "premises_and_equipment_net", + "name": "growth_operating_cash_flow", "type": "float", - "description": "Net premises and equipment.", - "default": null, - "optional": true + "description": "Growth rate of operating cash flow.", + "default": "", + "optional": false }, { - "name": "plant_property_equipment_net", + "name": "growth_capital_expenditure", "type": "float", - "description": "Net plant property equipment.", - "default": null, - "optional": true + "description": "Growth rate of capital expenditure.", + "default": "", + "optional": false }, { - "name": "long_term_investments", + "name": "growth_free_cash_flow", "type": "float", - "description": "Long term investments.", - "default": null, - "optional": true + "description": "Growth rate of free cash flow.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "CashFlowStatementGrowth" + }, + "/equity/fundamental/dividends": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical dividend data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.dividends(symbol='AAPL', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "mortgage_servicing_rights", - "type": "float", - "description": "Mortgage servicing rights.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "unearned_premiums_asset", - "type": "float", - "description": "Unearned premiums asset.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "non_current_note_lease_receivables", - "type": "float", - "description": "Non-current note lease receivables.", - "default": null, + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [], + "intrinio": [ { - "name": "deferred_acquisition_cost", - "type": "float", - "description": "Deferred acquisition cost.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100, "optional": true + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[HistoricalDividends]", + "description": "Serializable results." }, { - "name": "goodwill", - "type": "float", - "description": "Goodwill.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "description": "Provider name." }, { - "name": "separate_account_business_assets", - "type": "float", - "description": "Separate account business assets.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "non_current_deferred_refundable_income_taxes", - "type": "float", - "description": "Noncurrent deferred refundable income taxes.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "intangible_assets", - "type": "float", - "description": "Intangible assets.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "ex_dividend_date", + "type": "date", + "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", + "default": "", + "optional": false }, { - "name": "employee_benefit_assets", + "name": "amount", "type": "float", - "description": "Employee benefit assets.", - "default": null, - "optional": true + "description": "The dividend amount per share.", + "default": "", + "optional": false + } + ], + "fmp": [ + { + "name": "label", + "type": "str", + "description": "Label of the historical dividends.", + "default": "", + "optional": false }, { - "name": "other_assets", + "name": "adj_dividend", "type": "float", - "description": "Other assets.", - "default": null, - "optional": true + "description": "Adjusted dividend of the historical dividends.", + "default": "", + "optional": false }, { - "name": "other_non_current_operating_assets", - "type": "float", - "description": "Other noncurrent operating assets.", + "name": "record_date", + "type": "date", + "description": "Record date of the historical dividends.", "default": null, "optional": true }, { - "name": "other_non_current_non_operating_assets", - "type": "float", - "description": "Other noncurrent non-operating assets.", + "name": "payment_date", + "type": "date", + "description": "Payment date of the historical dividends.", "default": null, "optional": true }, { - "name": "interest_bearing_deposits", - "type": "float", - "description": "Interest bearing deposits.", + "name": "declaration_date", + "type": "date", + "description": "Declaration date of the historical dividends.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "total_non_current_assets", + "name": "factor", "type": "float", - "description": "Total noncurrent assets.", + "description": "factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.", "default": null, "optional": true }, { - "name": "total_assets", - "type": "float", - "description": "Total assets.", + "name": "currency", + "type": "str", + "description": "The currency in which the dividend is paid.", "default": null, "optional": true }, { - "name": "non_interest_bearing_deposits", + "name": "split_ratio", "type": "float", - "description": "Non interest bearing deposits.", + "description": "The ratio of the stock split, if a stock split occurred.", "default": null, "optional": true + } + ], + "yfinance": [] + }, + "model": "HistoricalDividends" + }, + "/equity/fundamental/historical_eps": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical earnings per share data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_eps(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "federal_funds_purchased_and_securities_sold", - "type": "float", - "description": "Federal funds purchased and securities sold.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "bankers_acceptance_outstanding", - "type": "float", - "description": "Bankers acceptance outstanding.", + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", "default": null, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[HistoricalEps]", + "description": "Serializable results." }, { - "name": "short_term_debt", - "type": "float", - "description": "Short term debt.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "accounts_payable", - "type": "float", - "description": "Accounts payable.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "current_deferred_revenue", - "type": "float", - "description": "Current deferred revenue.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "current_deferred_payable_income_tax_liabilities", - "type": "float", - "description": "Current deferred payable income tax liabilities.", - "default": null, - "optional": true - }, - { - "name": "accrued_interest_payable", - "type": "float", - "description": "Accrued interest payable.", - "default": null, - "optional": true - }, - { - "name": "accrued_expenses", - "type": "float", - "description": "Accrued expenses.", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "other_short_term_payables", - "type": "float", - "description": "Other short term payables.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": null, "optional": true }, { - "name": "customer_deposits", - "type": "float", - "description": "Customer deposits.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "dividends_payable", - "type": "float", - "description": "Dividends payable.", + "name": "announce_time", + "type": "str", + "description": "Timing of the earnings announcement.", "default": null, "optional": true }, { - "name": "claims_and_claim_expense", + "name": "eps_actual", "type": "float", - "description": "Claims and claim expense.", + "description": "Actual EPS from the earnings date.", "default": null, "optional": true }, { - "name": "future_policy_benefits", + "name": "eps_estimated", "type": "float", - "description": "Future policy benefits.", + "description": "Estimated EPS for the earnings date.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "current_employee_benefit_liabilities", + "name": "revenue_estimated", "type": "float", - "description": "Current employee benefit liabilities.", + "description": "Estimated consensus revenue for the reporting period.", "default": null, "optional": true }, { - "name": "unearned_premiums_liability", + "name": "revenue_actual", "type": "float", - "description": "Unearned premiums liability.", + "description": "The actual reported revenue.", "default": null, "optional": true }, { - "name": "other_taxes_payable", - "type": "float", - "description": "Other taxes payable.", + "name": "reporting_time", + "type": "str", + "description": "The reporting time - e.g. after market close.", "default": null, "optional": true }, { - "name": "policy_holder_funds", - "type": "float", - "description": "Policy holder funds.", + "name": "updated_at", + "type": "date", + "description": "The date when the data was last updated.", "default": null, "optional": true }, { - "name": "other_current_liabilities", - "type": "float", - "description": "Other current liabilities.", + "name": "period_ending", + "type": "date", + "description": "The fiscal period end date.", "default": null, "optional": true - }, + } + ] + }, + "model": "HistoricalEps" + }, + "/equity/fundamental/employee_count": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical employee count data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.employee_count(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "other_current_non_operating_liabilities", - "type": "float", - "description": "Other current non-operating liabilities.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "separate_account_business_liabilities", - "type": "float", - "description": "Separate account business liabilities.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ { - "name": "total_current_liabilities", - "type": "float", - "description": "Total current liabilities.", - "default": null, - "optional": true + "name": "results", + "type": "List[HistoricalEmployees]", + "description": "Serializable results." }, { - "name": "long_term_debt", - "type": "float", - "description": "Long term debt.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "other_long_term_liabilities", - "type": "float", - "description": "Other long term liabilities.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "non_current_deferred_revenue", - "type": "float", - "description": "Non-current deferred revenue.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "non_current_deferred_payable_income_tax_liabilities", - "type": "float", - "description": "Non-current deferred payable income tax liabilities.", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "non_current_employee_benefit_liabilities", - "type": "float", - "description": "Non-current employee benefit liabilities.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "other_non_current_operating_liabilities", - "type": "float", - "description": "Other non-current operating liabilities.", - "default": null, - "optional": true + "name": "cik", + "type": "int", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "", + "optional": false }, { - "name": "other_non_current_non_operating_liabilities", - "type": "float", - "description": "Other non-current, non-operating liabilities.", - "default": null, - "optional": true + "name": "acceptance_time", + "type": "datetime", + "description": "Time of acceptance of the company employee.", + "default": "", + "optional": false }, { - "name": "total_non_current_liabilities", - "type": "float", - "description": "Total non-current liabilities.", - "default": null, - "optional": true + "name": "period_of_report", + "type": "date", + "description": "Date of reporting of the company employee.", + "default": "", + "optional": false }, { - "name": "capital_lease_obligations", - "type": "float", - "description": "Capital lease obligations.", - "default": null, - "optional": true + "name": "company_name", + "type": "str", + "description": "Registered name of the company to retrieve the historical employees of.", + "default": "", + "optional": false }, { - "name": "asset_retirement_reserve_litigation_obligation", - "type": "float", - "description": "Asset retirement reserve litigation obligation.", - "default": null, - "optional": true + "name": "form_type", + "type": "str", + "description": "Form type of the company employee.", + "default": "", + "optional": false }, { - "name": "total_liabilities", - "type": "float", - "description": "Total liabilities.", - "default": null, - "optional": true + "name": "filing_date", + "type": "date", + "description": "Filing date of the company employee", + "default": "", + "optional": false }, { - "name": "commitments_contingencies", - "type": "float", - "description": "Commitments contingencies.", - "default": null, - "optional": true + "name": "employee_count", + "type": "int", + "description": "Count of employees of the company.", + "default": "", + "optional": false }, { - "name": "redeemable_non_controlling_interest", - "type": "float", - "description": "Redeemable non-controlling interest.", - "default": null, - "optional": true - }, + "name": "source", + "type": "str", + "description": "Source URL which retrieves this data for the company.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "HistoricalEmployees" + }, + "/equity/fundamental/search_attributes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search Intrinio data tags to search in latest or historical attributes.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.search_attributes(query='ebitda', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ { - "name": "preferred_stock", - "type": "float", - "description": "Preferred stock.", - "default": null, - "optional": true + "name": "query", + "type": "str", + "description": "Query to search for.", + "default": "", + "optional": false }, { - "name": "common_stock", - "type": "float", - "description": "Common stock.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 1000, "optional": true }, { - "name": "retained_earnings", - "type": "float", - "description": "Retained earnings.", - "default": null, + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", "optional": true - }, + } + ], + "intrinio": [] + }, + "returns": { + "OBBject": [ { - "name": "treasury_stock", - "type": "float", - "description": "Treasury stock.", - "default": null, - "optional": true + "name": "results", + "type": "List[SearchAttributes]", + "description": "Serializable results." }, { - "name": "accumulated_other_comprehensive_income", - "type": "float", - "description": "Accumulated other comprehensive income.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['intrinio']]", + "description": "Provider name." }, { - "name": "participating_policy_holder_equity", - "type": "float", - "description": "Participating policy holder equity.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "other_equity_adjustments", - "type": "float", - "description": "Other equity adjustments.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "total_common_equity", - "type": "float", - "description": "Total common equity.", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "total_preferred_common_equity", - "type": "float", - "description": "Total preferred common equity.", - "default": null, - "optional": true + "name": "id", + "type": "str", + "description": "ID of the financial attribute.", + "default": "", + "optional": false }, { - "name": "non_controlling_interest", - "type": "float", - "description": "Non-controlling interest.", - "default": null, - "optional": true + "name": "name", + "type": "str", + "description": "Name of the financial attribute.", + "default": "", + "optional": false }, { - "name": "total_equity_non_controlling_interests", - "type": "float", - "description": "Total equity non-controlling interests.", - "default": null, - "optional": true + "name": "tag", + "type": "str", + "description": "Tag of the financial attribute.", + "default": "", + "optional": false }, { - "name": "total_liabilities_shareholders_equity", - "type": "float", - "description": "Total liabilities and shareholders equity.", - "default": null, - "optional": true - } - ], - "polygon": [ - { - "name": "accounts_receivable", - "type": "int", - "description": "Accounts receivable", - "default": null, - "optional": true + "name": "statement_code", + "type": "str", + "description": "Code of the financial statement.", + "default": "", + "optional": false }, { - "name": "marketable_securities", - "type": "int", - "description": "Marketable securities", + "name": "statement_type", + "type": "str", + "description": "Type of the financial statement.", "default": null, "optional": true }, { - "name": "prepaid_expenses", - "type": "int", - "description": "Prepaid expenses", + "name": "parent_name", + "type": "str", + "description": "Parent's name of the financial attribute.", "default": null, "optional": true }, { - "name": "other_current_assets", + "name": "sequence", "type": "int", - "description": "Other current assets", + "description": "Sequence of the financial statement.", "default": null, "optional": true }, { - "name": "total_current_assets", - "type": "int", - "description": "Total current assets", + "name": "factor", + "type": "str", + "description": "Unit of the financial attribute.", "default": null, "optional": true }, { - "name": "property_plant_equipment_net", - "type": "int", - "description": "Property plant and equipment net", + "name": "transaction", + "type": "str", + "description": "Transaction type (credit/debit) of the financial attribute.", "default": null, "optional": true }, { - "name": "inventory", - "type": "int", - "description": "Inventory", + "name": "type", + "type": "str", + "description": "Type of the financial attribute.", "default": null, "optional": true }, { - "name": "other_non_current_assets", - "type": "int", - "description": "Other non-current assets", + "name": "unit", + "type": "str", + "description": "Unit of the financial attribute.", "default": null, "optional": true + } + ], + "intrinio": [] + }, + "model": "SearchAttributes" + }, + "/equity/fundamental/latest_attributes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the latest value of a data tag from Intrinio.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.latest_attributes(symbol='AAPL', tag='ceo', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", + "default": "", + "optional": false }, { - "name": "total_non_current_assets", - "type": "int", - "description": "Total non-current assets", - "default": null, - "optional": 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 }, { - "name": "intangible_assets", - "type": "int", - "description": "Intangible assets", - "default": null, + "name": "provider", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", "optional": true + } + ], + "intrinio": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[LatestAttributes]", + "description": "Serializable results." }, { - "name": "total_assets", - "type": "int", - "description": "Total assets", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['intrinio']]", + "description": "Provider name." }, { - "name": "accounts_payable", - "type": "int", - "description": "Accounts payable", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "employee_wages", - "type": "int", - "description": "Employee wages", - "default": null, - "optional": true - }, - { - "name": "other_current_liabilities", - "type": "int", - "description": "Other current liabilities", - "default": null, - "optional": true - }, - { - "name": "total_current_liabilities", - "type": "int", - "description": "Total current liabilities", - "default": null, - "optional": true - }, - { - "name": "other_non_current_liabilities", - "type": "int", - "description": "Other non-current liabilities", - "default": null, - "optional": true - }, - { - "name": "total_non_current_liabilities", - "type": "int", - "description": "Total non-current liabilities", - "default": null, - "optional": true - }, - { - "name": "long_term_debt", - "type": "int", - "description": "Long term debt", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "total_liabilities", - "type": "int", - "description": "Total liabilities", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "minority_interest", - "type": "int", - "description": "Minority interest", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "temporary_equity_attributable_to_parent", - "type": "int", - "description": "Temporary equity attributable to parent", + "name": "tag", + "type": "str", + "description": "Tag name for the fetched data.", "default": null, "optional": true }, { - "name": "equity_attributable_to_parent", - "type": "int", - "description": "Equity attributable to parent", + "name": "value", + "type": "Union[str, float]", + "description": "The value of the data.", "default": null, "optional": true - }, + } + ], + "intrinio": [] + }, + "model": "LatestAttributes" + }, + "/equity/fundamental/historical_attributes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the historical values of a data tag from Intrinio.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_attributes(symbol='AAPL', tag='ebitda', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ { - "name": "temporary_equity", - "type": "int", - "description": "Temporary equity", - "default": null, - "optional": true + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", + "default": "", + "optional": false }, { - "name": "preferred_stock", - "type": "int", - "description": "Preferred stock", - "default": null, - "optional": 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 }, { - "name": "redeemable_non_controlling_interest", - "type": "int", - "description": "Redeemable non-controlling interest", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "redeemable_non_controlling_interest_other", - "type": "int", - "description": "Redeemable non-controlling interest other", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "total_stock_holders_equity", - "type": "int", - "description": "Total stock holders equity", - "default": null, + "name": "frequency", + "type": "Literal['daily', 'weekly', 'monthly', 'quarterly', 'yearly']", + "description": "The frequency of the data.", + "default": "yearly", "optional": true }, { - "name": "total_liabilities_and_stock_holders_equity", + "name": "limit", "type": "int", - "description": "Total liabilities and stockholders equity", - "default": null, + "description": "The number of data entries to return.", + "default": 1000, "optional": true }, { - "name": "total_equity", - "type": "int", - "description": "Total equity", + "name": "tag_type", + "type": "str", + "description": "Filter by type, when applicable.", "default": null, "optional": true - } - ], - "yfinance": [] - }, - "model": "BalanceSheet" - }, - "/equity/fundamental/balance_growth": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the growth of a company's balance sheet items over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.balance_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.balance_growth(symbol='AAPL', limit=10, provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 10, + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order.", + "default": "desc", "optional": true }, { "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "type": "Literal['intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", "optional": true } ], - "fmp": [] + "intrinio": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[BalanceSheetGrowth]", + "type": "List[HistoricalAttributes]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['intrinio']]", "description": "Provider name." }, { @@ -12595,13 +12060,6 @@ }, "data": { "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": null, - "optional": true - }, { "name": "date", "type": "date", @@ -12610,10190 +12068,200 @@ "optional": false }, { - "name": "period", + "name": "symbol", "type": "str", - "description": "Reporting period.", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "growth_cash_and_cash_equivalents", - "type": "float", - "description": "Growth rate of cash and cash equivalents.", - "default": "", - "optional": false + "name": "tag", + "type": "str", + "description": "Tag name for the fetched data.", + "default": null, + "optional": true }, { - "name": "growth_short_term_investments", + "name": "value", "type": "float", - "description": "Growth rate of short-term investments.", + "description": "The value of the data.", + "default": null, + "optional": true + } + ], + "intrinio": [] + }, + "model": "HistoricalAttributes" + }, + "/equity/fundamental/income": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the income statement for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.income(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.income(symbol='AAPL', period='annual', limit=5, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", "default": "", "optional": false }, { - "name": "growth_cash_and_short_term_investments", - "type": "float", - "description": "Growth rate of cash and short-term investments.", - "default": "", - "optional": false + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true }, { - "name": "growth_net_receivables", - "type": "float", - "description": "Growth rate of net receivables.", - "default": "", - "optional": false + "name": "limit", + "type": "Annotated[int, Ge(ge=0)]", + "description": "The number of data entries to return.", + "default": 5, + "optional": true }, { - "name": "growth_inventory", - "type": "float", - "description": "Growth rate of inventory.", - "default": "", - "optional": false - }, - { - "name": "growth_other_current_assets", - "type": "float", - "description": "Growth rate of other current assets.", - "default": "", - "optional": false - }, - { - "name": "growth_total_current_assets", - "type": "float", - "description": "Growth rate of total current assets.", - "default": "", - "optional": false - }, - { - "name": "growth_property_plant_equipment_net", - "type": "float", - "description": "Growth rate of net property, plant, and equipment.", - "default": "", - "optional": false - }, - { - "name": "growth_goodwill", - "type": "float", - "description": "Growth rate of goodwill.", - "default": "", - "optional": false - }, - { - "name": "growth_intangible_assets", - "type": "float", - "description": "Growth rate of intangible assets.", - "default": "", - "optional": false - }, - { - "name": "growth_goodwill_and_intangible_assets", - "type": "float", - "description": "Growth rate of goodwill and intangible assets.", - "default": "", - "optional": false - }, - { - "name": "growth_long_term_investments", - "type": "float", - "description": "Growth rate of long-term investments.", - "default": "", - "optional": false - }, - { - "name": "growth_tax_assets", - "type": "float", - "description": "Growth rate of tax assets.", - "default": "", - "optional": false - }, - { - "name": "growth_other_non_current_assets", - "type": "float", - "description": "Growth rate of other non-current assets.", - "default": "", - "optional": false - }, - { - "name": "growth_total_non_current_assets", - "type": "float", - "description": "Growth rate of total non-current assets.", - "default": "", - "optional": false - }, - { - "name": "growth_other_assets", - "type": "float", - "description": "Growth rate of other assets.", - "default": "", - "optional": false - }, - { - "name": "growth_total_assets", - "type": "float", - "description": "Growth rate of total assets.", - "default": "", - "optional": false - }, - { - "name": "growth_account_payables", - "type": "float", - "description": "Growth rate of accounts payable.", - "default": "", - "optional": false - }, - { - "name": "growth_short_term_debt", - "type": "float", - "description": "Growth rate of short-term debt.", - "default": "", - "optional": false - }, - { - "name": "growth_tax_payables", - "type": "float", - "description": "Growth rate of tax payables.", - "default": "", - "optional": false - }, - { - "name": "growth_deferred_revenue", - "type": "float", - "description": "Growth rate of deferred revenue.", - "default": "", - "optional": false - }, - { - "name": "growth_other_current_liabilities", - "type": "float", - "description": "Growth rate of other current liabilities.", - "default": "", - "optional": false - }, - { - "name": "growth_total_current_liabilities", - "type": "float", - "description": "Growth rate of total current liabilities.", - "default": "", - "optional": false - }, - { - "name": "growth_long_term_debt", - "type": "float", - "description": "Growth rate of long-term debt.", - "default": "", - "optional": false - }, - { - "name": "growth_deferred_revenue_non_current", - "type": "float", - "description": "Growth rate of non-current deferred revenue.", - "default": "", - "optional": false - }, - { - "name": "growth_deferrred_tax_liabilities_non_current", - "type": "float", - "description": "Growth rate of non-current deferred tax liabilities.", - "default": "", - "optional": false - }, - { - "name": "growth_other_non_current_liabilities", - "type": "float", - "description": "Growth rate of other non-current liabilities.", - "default": "", - "optional": false - }, - { - "name": "growth_total_non_current_liabilities", - "type": "float", - "description": "Growth rate of total non-current liabilities.", - "default": "", - "optional": false - }, - { - "name": "growth_other_liabilities", - "type": "float", - "description": "Growth rate of other liabilities.", - "default": "", - "optional": false - }, - { - "name": "growth_total_liabilities", - "type": "float", - "description": "Growth rate of total liabilities.", - "default": "", - "optional": false - }, - { - "name": "growth_common_stock", - "type": "float", - "description": "Growth rate of common stock.", - "default": "", - "optional": false - }, - { - "name": "growth_retained_earnings", - "type": "float", - "description": "Growth rate of retained earnings.", - "default": "", - "optional": false - }, - { - "name": "growth_accumulated_other_comprehensive_income_loss", - "type": "float", - "description": "Growth rate of accumulated other comprehensive income/loss.", - "default": "", - "optional": false - }, - { - "name": "growth_othertotal_stockholders_equity", - "type": "float", - "description": "Growth rate of other total stockholders' equity.", - "default": "", - "optional": false - }, - { - "name": "growth_total_stockholders_equity", - "type": "float", - "description": "Growth rate of total stockholders' equity.", - "default": "", - "optional": false - }, - { - "name": "growth_total_liabilities_and_stockholders_equity", - "type": "float", - "description": "Growth rate of total liabilities and stockholders' equity.", - "default": "", - "optional": false - }, - { - "name": "growth_total_investments", - "type": "float", - "description": "Growth rate of total investments.", - "default": "", - "optional": false - }, - { - "name": "growth_total_debt", - "type": "float", - "description": "Growth rate of total debt.", - "default": "", - "optional": false - }, - { - "name": "growth_net_debt", - "type": "float", - "description": "Growth rate of net debt.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "BalanceSheetGrowth" - }, - "/equity/fundamental/cash": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the cash flow statement for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.cash(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.cash(symbol='AAPL', period='annual', limit=5, provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "period", - "type": "str", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - }, - { - "name": "limit", - "type": "Annotated[int, Ge(ge=0)]", - "description": "The number of data entries to return.", - "default": 5, - "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", - "optional": true - } - ], - "intrinio": [ - { - "name": "period", - "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", - "description": "None", - "default": "annual", - "optional": true - }, - { - "name": "fiscal_year", - "type": "int", - "description": "The specific fiscal year. Reports do not go beyond 2008.", - "default": null, - "optional": true - } - ], - "polygon": [ - { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", - "optional": true - }, - { - "name": "filing_date", - "type": "date", - "description": "Filing date of the financial statement.", - "default": null, - "optional": true - }, - { - "name": "filing_date_lt", - "type": "date", - "description": "Filing date less than the given date.", - "default": null, - "optional": true - }, - { - "name": "filing_date_lte", - "type": "date", - "description": "Filing date less than or equal to the given date.", - "default": null, - "optional": true - }, - { - "name": "filing_date_gt", - "type": "date", - "description": "Filing date greater than the given date.", - "default": null, - "optional": true - }, - { - "name": "filing_date_gte", - "type": "date", - "description": "Filing date greater than or equal to the given date.", - "default": null, - "optional": true - }, - { - "name": "period_of_report_date", - "type": "date", - "description": "Period of report date of the financial statement.", - "default": null, - "optional": true - }, - { - "name": "period_of_report_date_lt", - "type": "date", - "description": "Period of report date less than the given date.", - "default": null, - "optional": true - }, - { - "name": "period_of_report_date_lte", - "type": "date", - "description": "Period of report date less than or equal to the given date.", - "default": null, - "optional": true - }, - { - "name": "period_of_report_date_gt", - "type": "date", - "description": "Period of report date greater than the given date.", - "default": null, - "optional": true - }, - { - "name": "period_of_report_date_gte", - "type": "date", - "description": "Period of report date greater than or equal to the given date.", - "default": null, - "optional": true - }, - { - "name": "include_sources", - "type": "bool", - "description": "Whether to include the sources of the financial statement.", - "default": false, - "optional": true - }, - { - "name": "order", - "type": "Literal['asc', 'desc']", - "description": "Order of the financial statement.", - "default": null, - "optional": true - }, - { - "name": "sort", - "type": "Literal['filing_date', 'period_of_report_date']", - "description": "Sort of the financial statement.", - "default": null, - "optional": true - } - ], - "yfinance": [ - { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[CashFlowStatement]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "period_ending", - "type": "date", - "description": "The end date of the reporting period.", - "default": "", - "optional": false - }, - { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the report.", - "default": null, - "optional": true - }, - { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the fiscal period.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the fiscal period.", - "default": null, - "optional": true - }, - { - "name": "filing_date", - "type": "date", - "description": "The date of the filing.", - "default": null, - "optional": true - }, - { - "name": "accepted_date", - "type": "datetime", - "description": "The date the filing was accepted.", - "default": null, - "optional": true - }, - { - "name": "reported_currency", - "type": "str", - "description": "The currency in which the cash flow statement was reported.", - "default": null, - "optional": true - }, - { - "name": "net_income", - "type": "float", - "description": "Net income.", - "default": null, - "optional": true - }, - { - "name": "depreciation_and_amortization", - "type": "float", - "description": "Depreciation and amortization.", - "default": null, - "optional": true - }, - { - "name": "deferred_income_tax", - "type": "float", - "description": "Deferred income tax.", - "default": null, - "optional": true - }, - { - "name": "stock_based_compensation", - "type": "float", - "description": "Stock-based compensation.", - "default": null, - "optional": true - }, - { - "name": "change_in_working_capital", - "type": "float", - "description": "Change in working capital.", - "default": null, - "optional": true - }, - { - "name": "change_in_account_receivables", - "type": "float", - "description": "Change in account receivables.", - "default": null, - "optional": true - }, - { - "name": "change_in_inventory", - "type": "float", - "description": "Change in inventory.", - "default": null, - "optional": true - }, - { - "name": "change_in_account_payable", - "type": "float", - "description": "Change in account payable.", - "default": null, - "optional": true - }, - { - "name": "change_in_other_working_capital", - "type": "float", - "description": "Change in other working capital.", - "default": null, - "optional": true - }, - { - "name": "change_in_other_non_cash_items", - "type": "float", - "description": "Change in other non-cash items.", - "default": null, - "optional": true - }, - { - "name": "net_cash_from_operating_activities", - "type": "float", - "description": "Net cash from operating activities.", - "default": null, - "optional": true - }, - { - "name": "purchase_of_property_plant_and_equipment", - "type": "float", - "description": "Purchase of property, plant and equipment.", - "default": null, - "optional": true - }, - { - "name": "acquisitions", - "type": "float", - "description": "Acquisitions.", - "default": null, - "optional": true - }, - { - "name": "purchase_of_investment_securities", - "type": "float", - "description": "Purchase of investment securities.", - "default": null, - "optional": true - }, - { - "name": "sale_and_maturity_of_investments", - "type": "float", - "description": "Sale and maturity of investments.", - "default": null, - "optional": true - }, - { - "name": "other_investing_activities", - "type": "float", - "description": "Other investing activities.", - "default": null, - "optional": true - }, - { - "name": "net_cash_from_investing_activities", - "type": "float", - "description": "Net cash from investing activities.", - "default": null, - "optional": true - }, - { - "name": "repayment_of_debt", - "type": "float", - "description": "Repayment of debt.", - "default": null, - "optional": true - }, - { - "name": "issuance_of_common_equity", - "type": "float", - "description": "Issuance of common equity.", - "default": null, - "optional": true - }, - { - "name": "repurchase_of_common_equity", - "type": "float", - "description": "Repurchase of common equity.", - "default": null, - "optional": true - }, - { - "name": "payment_of_dividends", - "type": "float", - "description": "Payment of dividends.", - "default": null, - "optional": true - }, - { - "name": "other_financing_activities", - "type": "float", - "description": "Other financing activities.", - "default": null, - "optional": true - }, - { - "name": "net_cash_from_financing_activities", - "type": "float", - "description": "Net cash from financing activities.", - "default": null, - "optional": true - }, - { - "name": "effect_of_exchange_rate_changes_on_cash", - "type": "float", - "description": "Effect of exchange rate changes on cash.", - "default": null, - "optional": true - }, - { - "name": "net_change_in_cash_and_equivalents", - "type": "float", - "description": "Net change in cash and equivalents.", - "default": null, - "optional": true - }, - { - "name": "cash_at_beginning_of_period", - "type": "float", - "description": "Cash at beginning of period.", - "default": null, - "optional": true - }, - { - "name": "cash_at_end_of_period", - "type": "float", - "description": "Cash at end of period.", - "default": null, - "optional": true - }, - { - "name": "operating_cash_flow", - "type": "float", - "description": "Operating cash flow.", - "default": null, - "optional": true - }, - { - "name": "capital_expenditure", - "type": "float", - "description": "Capital expenditure.", - "default": null, - "optional": true - }, - { - "name": "free_cash_flow", - "type": "float", - "description": "None", - "default": null, - "optional": true - }, - { - "name": "link", - "type": "str", - "description": "Link to the filing.", - "default": null, - "optional": true - }, - { - "name": "final_link", - "type": "str", - "description": "Link to the filing document.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "reported_currency", - "type": "str", - "description": "The currency in which the balance sheet is reported.", - "default": null, - "optional": true - }, - { - "name": "net_income_continuing_operations", - "type": "float", - "description": "Net Income (Continuing Operations)", - "default": null, - "optional": true - }, - { - "name": "net_income_discontinued_operations", - "type": "float", - "description": "Net Income (Discontinued Operations)", - "default": null, - "optional": true - }, - { - "name": "net_income", - "type": "float", - "description": "Consolidated Net Income.", - "default": null, - "optional": true - }, - { - "name": "provision_for_loan_losses", - "type": "float", - "description": "Provision for Loan Losses", - "default": null, - "optional": true - }, - { - "name": "provision_for_credit_losses", - "type": "float", - "description": "Provision for credit losses", - "default": null, - "optional": true - }, - { - "name": "depreciation_expense", - "type": "float", - "description": "Depreciation Expense.", - "default": null, - "optional": true - }, - { - "name": "amortization_expense", - "type": "float", - "description": "Amortization Expense.", - "default": null, - "optional": true - }, - { - "name": "share_based_compensation", - "type": "float", - "description": "Share-based compensation.", - "default": null, - "optional": true - }, - { - "name": "non_cash_adjustments_to_reconcile_net_income", - "type": "float", - "description": "Non-Cash Adjustments to Reconcile Net Income.", - "default": null, - "optional": true - }, - { - "name": "changes_in_operating_assets_and_liabilities", - "type": "float", - "description": "Changes in Operating Assets and Liabilities (Net)", - "default": null, - "optional": true - }, - { - "name": "net_cash_from_continuing_operating_activities", - "type": "float", - "description": "Net Cash from Continuing Operating Activities", - "default": null, - "optional": true - }, - { - "name": "net_cash_from_discontinued_operating_activities", - "type": "float", - "description": "Net Cash from Discontinued Operating Activities", - "default": null, - "optional": true - }, - { - "name": "net_cash_from_operating_activities", - "type": "float", - "description": "Net Cash from Operating Activities", - "default": null, - "optional": true - }, - { - "name": "divestitures", - "type": "float", - "description": "Divestitures", - "default": null, - "optional": true - }, - { - "name": "sale_of_property_plant_and_equipment", - "type": "float", - "description": "Sale of Property, Plant, and Equipment", - "default": null, - "optional": true - }, - { - "name": "acquisitions", - "type": "float", - "description": "Acquisitions", - "default": null, - "optional": true - }, - { - "name": "purchase_of_investments", - "type": "float", - "description": "Purchase of Investments", - "default": null, - "optional": true - }, - { - "name": "purchase_of_investment_securities", - "type": "float", - "description": "Purchase of Investment Securities", - "default": null, - "optional": true - }, - { - "name": "sale_and_maturity_of_investments", - "type": "float", - "description": "Sale and Maturity of Investments", - "default": null, - "optional": true - }, - { - "name": "loans_held_for_sale", - "type": "float", - "description": "Loans Held for Sale (Net)", - "default": null, - "optional": true - }, - { - "name": "purchase_of_property_plant_and_equipment", - "type": "float", - "description": "Purchase of Property, Plant, and Equipment", - "default": null, - "optional": true - }, - { - "name": "other_investing_activities", - "type": "float", - "description": "Other Investing Activities (Net)", - "default": null, - "optional": true - }, - { - "name": "net_cash_from_continuing_investing_activities", - "type": "float", - "description": "Net Cash from Continuing Investing Activities", - "default": null, - "optional": true - }, - { - "name": "net_cash_from_discontinued_investing_activities", - "type": "float", - "description": "Net Cash from Discontinued Investing Activities", - "default": null, - "optional": true - }, - { - "name": "net_cash_from_investing_activities", - "type": "float", - "description": "Net Cash from Investing Activities", - "default": null, - "optional": true - }, - { - "name": "payment_of_dividends", - "type": "float", - "description": "Payment of Dividends", - "default": null, - "optional": true - }, - { - "name": "repurchase_of_common_equity", - "type": "float", - "description": "Repurchase of Common Equity", - "default": null, - "optional": true - }, - { - "name": "repurchase_of_preferred_equity", - "type": "float", - "description": "Repurchase of Preferred Equity", - "default": null, - "optional": true - }, - { - "name": "issuance_of_common_equity", - "type": "float", - "description": "Issuance of Common Equity", - "default": null, - "optional": true - }, - { - "name": "issuance_of_preferred_equity", - "type": "float", - "description": "Issuance of Preferred Equity", - "default": null, - "optional": true - }, - { - "name": "issuance_of_debt", - "type": "float", - "description": "Issuance of Debt", - "default": null, - "optional": true - }, - { - "name": "repayment_of_debt", - "type": "float", - "description": "Repayment of Debt", - "default": null, - "optional": true - }, - { - "name": "other_financing_activities", - "type": "float", - "description": "Other Financing Activities (Net)", - "default": null, - "optional": true - }, - { - "name": "cash_interest_received", - "type": "float", - "description": "Cash Interest Received", - "default": null, - "optional": true - }, - { - "name": "net_change_in_deposits", - "type": "float", - "description": "Net Change in Deposits", - "default": null, - "optional": true - }, - { - "name": "net_increase_in_fed_funds_sold", - "type": "float", - "description": "Net Increase in Fed Funds Sold", - "default": null, - "optional": true - }, - { - "name": "net_cash_from_continuing_financing_activities", - "type": "float", - "description": "Net Cash from Continuing Financing Activities", - "default": null, - "optional": true - }, - { - "name": "net_cash_from_discontinued_financing_activities", - "type": "float", - "description": "Net Cash from Discontinued Financing Activities", - "default": null, - "optional": true - }, - { - "name": "net_cash_from_financing_activities", - "type": "float", - "description": "Net Cash from Financing Activities", - "default": null, - "optional": true - }, - { - "name": "effect_of_exchange_rate_changes", - "type": "float", - "description": "Effect of Exchange Rate Changes", - "default": null, - "optional": true - }, - { - "name": "other_net_changes_in_cash", - "type": "float", - "description": "Other Net Changes in Cash", - "default": null, - "optional": true - }, - { - "name": "net_change_in_cash_and_equivalents", - "type": "float", - "description": "Net Change in Cash and Equivalents", - "default": null, - "optional": true - }, - { - "name": "cash_income_taxes_paid", - "type": "float", - "description": "Cash Income Taxes Paid", - "default": null, - "optional": true - }, - { - "name": "cash_interest_paid", - "type": "float", - "description": "Cash Interest Paid", - "default": null, - "optional": true - } - ], - "polygon": [ - { - "name": "net_cash_flow_from_operating_activities_continuing", - "type": "int", - "description": "Net cash flow from operating activities continuing.", - "default": null, - "optional": true - }, - { - "name": "net_cash_flow_from_operating_activities_discontinued", - "type": "int", - "description": "Net cash flow from operating activities discontinued.", - "default": null, - "optional": true - }, - { - "name": "net_cash_flow_from_operating_activities", - "type": "int", - "description": "Net cash flow from operating activities.", - "default": null, - "optional": true - }, - { - "name": "net_cash_flow_from_investing_activities_continuing", - "type": "int", - "description": "Net cash flow from investing activities continuing.", - "default": null, - "optional": true - }, - { - "name": "net_cash_flow_from_investing_activities_discontinued", - "type": "int", - "description": "Net cash flow from investing activities discontinued.", - "default": null, - "optional": true - }, - { - "name": "net_cash_flow_from_investing_activities", - "type": "int", - "description": "Net cash flow from investing activities.", - "default": null, - "optional": true - }, - { - "name": "net_cash_flow_from_financing_activities_continuing", - "type": "int", - "description": "Net cash flow from financing activities continuing.", - "default": null, - "optional": true - }, - { - "name": "net_cash_flow_from_financing_activities_discontinued", - "type": "int", - "description": "Net cash flow from financing activities discontinued.", - "default": null, - "optional": true - }, - { - "name": "net_cash_flow_from_financing_activities", - "type": "int", - "description": "Net cash flow from financing activities.", - "default": null, - "optional": true - }, - { - "name": "net_cash_flow_continuing", - "type": "int", - "description": "Net cash flow continuing.", - "default": null, - "optional": true - }, - { - "name": "net_cash_flow_discontinued", - "type": "int", - "description": "Net cash flow discontinued.", - "default": null, - "optional": true - }, - { - "name": "exchange_gains_losses", - "type": "int", - "description": "Exchange gains losses.", - "default": null, - "optional": true - }, - { - "name": "net_cash_flow", - "type": "int", - "description": "Net cash flow.", - "default": null, - "optional": true - } - ], - "yfinance": [] - }, - "model": "CashFlowStatement" - }, - "/equity/fundamental/reported_financials": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get financial statements as reported by the company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.reported_financials(symbol='AAPL', provider='intrinio')\n# Get AAPL balance sheet with a limit of 10 items.\nobb.equity.fundamental.reported_financials(symbol='AAPL', period='annual', statement_type='balance', limit=10, provider='intrinio')\n# Get reported income statement\nobb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='income', provider='intrinio')\n# Get reported cash flow statement\nobb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='cash', provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "period", - "type": "str", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - }, - { - "name": "statement_type", - "type": "str", - "description": "The type of financial statement - i.e, balance, income, cash.", - "default": "balance", - "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. Although the response object contains multiple results, because of the variance in the fields, year-to-year and quarter-to-quarter, it is recommended to view results in small chunks.", - "default": 100, - "optional": true - }, - { - "name": "provider", - "type": "Literal['intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", - "optional": true - } - ], - "intrinio": [ - { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", - "optional": true - }, - { - "name": "statement_type", - "type": "Literal['balance', 'income', 'cash']", - "description": "Cash flow statements are reported as YTD, Q4 is the same as FY.", - "default": "income", - "optional": true - }, - { - "name": "fiscal_year", - "type": "int", - "description": "The specific fiscal year. Reports do not go beyond 2008.", - "default": null, - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[ReportedFinancials]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['intrinio']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "period_ending", - "type": "date", - "description": "The ending date of the reporting period.", - "default": "", - "optional": false - }, - { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the report (e.g. FY, Q1, etc.).", - "default": "", - "optional": false - }, - { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the fiscal period.", - "default": null, - "optional": true - } - ], - "intrinio": [] - }, - "model": "ReportedFinancials" - }, - "/equity/fundamental/cash_growth": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the growth of a company's cash flow statement items over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.cash_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.cash_growth(symbol='AAPL', limit=10, provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 10, - "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[CashFlowStatementGrowth]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": null, - "optional": true - }, - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "period", - "type": "str", - "description": "Period the statement is returned for.", - "default": "", - "optional": false - }, - { - "name": "growth_net_income", - "type": "float", - "description": "Growth rate of net income.", - "default": "", - "optional": false - }, - { - "name": "growth_depreciation_and_amortization", - "type": "float", - "description": "Growth rate of depreciation and amortization.", - "default": "", - "optional": false - }, - { - "name": "growth_deferred_income_tax", - "type": "float", - "description": "Growth rate of deferred income tax.", - "default": "", - "optional": false - }, - { - "name": "growth_stock_based_compensation", - "type": "float", - "description": "Growth rate of stock-based compensation.", - "default": "", - "optional": false - }, - { - "name": "growth_change_in_working_capital", - "type": "float", - "description": "Growth rate of change in working capital.", - "default": "", - "optional": false - }, - { - "name": "growth_accounts_receivables", - "type": "float", - "description": "Growth rate of accounts receivables.", - "default": "", - "optional": false - }, - { - "name": "growth_inventory", - "type": "float", - "description": "Growth rate of inventory.", - "default": "", - "optional": false - }, - { - "name": "growth_accounts_payables", - "type": "float", - "description": "Growth rate of accounts payables.", - "default": "", - "optional": false - }, - { - "name": "growth_other_working_capital", - "type": "float", - "description": "Growth rate of other working capital.", - "default": "", - "optional": false - }, - { - "name": "growth_other_non_cash_items", - "type": "float", - "description": "Growth rate of other non-cash items.", - "default": "", - "optional": false - }, - { - "name": "growth_net_cash_provided_by_operating_activities", - "type": "float", - "description": "Growth rate of net cash provided by operating activities.", - "default": "", - "optional": false - }, - { - "name": "growth_investments_in_property_plant_and_equipment", - "type": "float", - "description": "Growth rate of investments in property, plant, and equipment.", - "default": "", - "optional": false - }, - { - "name": "growth_acquisitions_net", - "type": "float", - "description": "Growth rate of net acquisitions.", - "default": "", - "optional": false - }, - { - "name": "growth_purchases_of_investments", - "type": "float", - "description": "Growth rate of purchases of investments.", - "default": "", - "optional": false - }, - { - "name": "growth_sales_maturities_of_investments", - "type": "float", - "description": "Growth rate of sales maturities of investments.", - "default": "", - "optional": false - }, - { - "name": "growth_other_investing_activities", - "type": "float", - "description": "Growth rate of other investing activities.", - "default": "", - "optional": false - }, - { - "name": "growth_net_cash_used_for_investing_activities", - "type": "float", - "description": "Growth rate of net cash used for investing activities.", - "default": "", - "optional": false - }, - { - "name": "growth_debt_repayment", - "type": "float", - "description": "Growth rate of debt repayment.", - "default": "", - "optional": false - }, - { - "name": "growth_common_stock_issued", - "type": "float", - "description": "Growth rate of common stock issued.", - "default": "", - "optional": false - }, - { - "name": "growth_common_stock_repurchased", - "type": "float", - "description": "Growth rate of common stock repurchased.", - "default": "", - "optional": false - }, - { - "name": "growth_dividends_paid", - "type": "float", - "description": "Growth rate of dividends paid.", - "default": "", - "optional": false - }, - { - "name": "growth_other_financing_activities", - "type": "float", - "description": "Growth rate of other financing activities.", - "default": "", - "optional": false - }, - { - "name": "growth_net_cash_used_provided_by_financing_activities", - "type": "float", - "description": "Growth rate of net cash used/provided by financing activities.", - "default": "", - "optional": false - }, - { - "name": "growth_effect_of_forex_changes_on_cash", - "type": "float", - "description": "Growth rate of the effect of foreign exchange changes on cash.", - "default": "", - "optional": false - }, - { - "name": "growth_net_change_in_cash", - "type": "float", - "description": "Growth rate of net change in cash.", - "default": "", - "optional": false - }, - { - "name": "growth_cash_at_end_of_period", - "type": "float", - "description": "Growth rate of cash at the end of the period.", - "default": "", - "optional": false - }, - { - "name": "growth_cash_at_beginning_of_period", - "type": "float", - "description": "Growth rate of cash at the beginning of the period.", - "default": "", - "optional": false - }, - { - "name": "growth_operating_cash_flow", - "type": "float", - "description": "Growth rate of operating cash flow.", - "default": "", - "optional": false - }, - { - "name": "growth_capital_expenditure", - "type": "float", - "description": "Growth rate of capital expenditure.", - "default": "", - "optional": false - }, - { - "name": "growth_free_cash_flow", - "type": "float", - "description": "Growth rate of free cash flow.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "CashFlowStatementGrowth" - }, - "/equity/fundamental/dividends": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get historical dividend data for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.dividends(symbol='AAPL', provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): nasdaq.", - "default": "", - "optional": false - }, - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'nasdaq', 'tmx', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [], - "intrinio": [ - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 100, - "optional": true - } - ], - "nasdaq": [], - "tmx": [], - "yfinance": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[HistoricalDividends]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'nasdaq', 'tmx', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "ex_dividend_date", - "type": "date", - "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", - "default": "", - "optional": false - }, - { - "name": "amount", - "type": "float", - "description": "The dividend amount per share.", - "default": "", - "optional": false - } - ], - "fmp": [ - { - "name": "label", - "type": "str", - "description": "Label of the historical dividends.", - "default": "", - "optional": false - }, - { - "name": "adj_dividend", - "type": "float", - "description": "Adjusted dividend of the historical dividends.", - "default": "", - "optional": false - }, - { - "name": "record_date", - "type": "date", - "description": "Record date of the historical dividends.", - "default": null, - "optional": true - }, - { - "name": "payment_date", - "type": "date", - "description": "Payment date of the historical dividends.", - "default": null, - "optional": true - }, - { - "name": "declaration_date", - "type": "date", - "description": "Declaration date of the historical dividends.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "factor", - "type": "float", - "description": "factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.", - "default": null, - "optional": true - }, - { - "name": "currency", - "type": "str", - "description": "The currency in which the dividend is paid.", - "default": null, - "optional": true - }, - { - "name": "split_ratio", - "type": "float", - "description": "The ratio of the stock split, if a stock split occurred.", - "default": null, - "optional": true - } - ], - "nasdaq": [ - { - "name": "dividend_type", - "type": "str", - "description": "The type of dividend - i.e., cash, stock.", - "default": null, - "optional": true - }, - { - "name": "currency", - "type": "str", - "description": "The currency in which the dividend is paid.", - "default": null, - "optional": true - }, - { - "name": "record_date", - "type": "date", - "description": "The record date of ownership for eligibility.", - "default": null, - "optional": true - }, - { - "name": "payment_date", - "type": "date", - "description": "The payment date of the dividend.", - "default": null, - "optional": true - }, - { - "name": "declaration_date", - "type": "date", - "description": "Declaration date of the dividend.", - "default": null, - "optional": true - } - ], - "tmx": [ - { - "name": "currency", - "type": "str", - "description": "The currency the dividend is paid in.", - "default": null, - "optional": true - }, - { - "name": "decalaration_date", - "type": "date", - "description": "The date of the announcement.", - "default": null, - "optional": true - }, - { - "name": "record_date", - "type": "date", - "description": "The record date of ownership for rights to the dividend.", - "default": null, - "optional": true - }, - { - "name": "payment_date", - "type": "date", - "description": "The date the dividend is paid.", - "default": null, - "optional": true - } - ], - "yfinance": [] - }, - "model": "HistoricalDividends" - }, - "/equity/fundamental/historical_eps": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get historical earnings per share data for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_eps(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage.", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['alpha_vantage', 'fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default.", - "default": "alpha_vantage", - "optional": true - } - ], - "alpha_vantage": [ - { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "Time period of the data to return.", - "default": "quarter", - "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": null, - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[HistoricalEps]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['alpha_vantage', 'fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": null, - "optional": true - }, - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "announce_time", - "type": "str", - "description": "Timing of the earnings announcement.", - "default": null, - "optional": true - }, - { - "name": "eps_actual", - "type": "float", - "description": "Actual EPS from the earnings date.", - "default": null, - "optional": true - }, - { - "name": "eps_estimated", - "type": "float", - "description": "Estimated EPS for the earnings date.", - "default": null, - "optional": true - } - ], - "alpha_vantage": [ - { - "name": "surprise", - "type": "float", - "description": "Surprise in EPS (Actual - Estimated).", - "default": null, - "optional": true - }, - { - "name": "surprise_percent", - "type": "Union[float, str]", - "description": "EPS surprise as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "reported_date", - "type": "date", - "description": "Date of the earnings report.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "revenue_estimated", - "type": "float", - "description": "Estimated consensus revenue for the reporting period.", - "default": null, - "optional": true - }, - { - "name": "revenue_actual", - "type": "float", - "description": "The actual reported revenue.", - "default": null, - "optional": true - }, - { - "name": "reporting_time", - "type": "str", - "description": "The reporting time - e.g. after market close.", - "default": null, - "optional": true - }, - { - "name": "updated_at", - "type": "date", - "description": "The date when the data was last updated.", - "default": null, - "optional": true - }, - { - "name": "period_ending", - "type": "date", - "description": "The fiscal period end date.", - "default": null, - "optional": true - } - ] - }, - "model": "HistoricalEps" - }, - "/equity/fundamental/employee_count": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get historical employee count data for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.employee_count(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[HistoricalEmployees]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "cik", - "type": "int", - "description": "Central Index Key (CIK) for the requested entity.", - "default": "", - "optional": false - }, - { - "name": "acceptance_time", - "type": "datetime", - "description": "Time of acceptance of the company employee.", - "default": "", - "optional": false - }, - { - "name": "period_of_report", - "type": "date", - "description": "Date of reporting of the company employee.", - "default": "", - "optional": false - }, - { - "name": "company_name", - "type": "str", - "description": "Registered name of the company to retrieve the historical employees of.", - "default": "", - "optional": false - }, - { - "name": "form_type", - "type": "str", - "description": "Form type of the company employee.", - "default": "", - "optional": false - }, - { - "name": "filing_date", - "type": "date", - "description": "Filing date of the company employee", - "default": "", - "optional": false - }, - { - "name": "employee_count", - "type": "int", - "description": "Count of employees of the company.", - "default": "", - "optional": false - }, - { - "name": "source", - "type": "str", - "description": "Source URL which retrieves this data for the company.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "HistoricalEmployees" - }, - "/equity/fundamental/search_attributes": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Search Intrinio data tags to search in latest or historical attributes.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.search_attributes(query='ebitda', provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "query", - "type": "str", - "description": "Query to search for.", - "default": "", - "optional": false - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 1000, - "optional": true - }, - { - "name": "provider", - "type": "Literal['intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", - "optional": true - } - ], - "intrinio": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[SearchAttributes]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['intrinio']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "id", - "type": "str", - "description": "ID of the financial attribute.", - "default": "", - "optional": false - }, - { - "name": "name", - "type": "str", - "description": "Name of the financial attribute.", - "default": "", - "optional": false - }, - { - "name": "tag", - "type": "str", - "description": "Tag of the financial attribute.", - "default": "", - "optional": false - }, - { - "name": "statement_code", - "type": "str", - "description": "Code of the financial statement.", - "default": "", - "optional": false - }, - { - "name": "statement_type", - "type": "str", - "description": "Type of the financial statement.", - "default": null, - "optional": true - }, - { - "name": "parent_name", - "type": "str", - "description": "Parent's name of the financial attribute.", - "default": null, - "optional": true - }, - { - "name": "sequence", - "type": "int", - "description": "Sequence of the financial statement.", - "default": null, - "optional": true - }, - { - "name": "factor", - "type": "str", - "description": "Unit of the financial attribute.", - "default": null, - "optional": true - }, - { - "name": "transaction", - "type": "str", - "description": "Transaction type (credit/debit) of the financial attribute.", - "default": null, - "optional": true - }, - { - "name": "type", - "type": "str", - "description": "Type of the financial attribute.", - "default": null, - "optional": true - }, - { - "name": "unit", - "type": "str", - "description": "Unit of the financial attribute.", - "default": null, - "optional": true - } - ], - "intrinio": [] - }, - "model": "SearchAttributes" - }, - "/equity/fundamental/latest_attributes": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the latest value of a data tag from Intrinio.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.latest_attributes(symbol='AAPL', tag='ceo', provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", - "default": "", - "optional": false - }, - { - "name": "tag", - "type": "Union[str, List[str]]", - "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", - "optional": true - } - ], - "intrinio": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[LatestAttributes]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['intrinio']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "tag", - "type": "str", - "description": "Tag name for the fetched data.", - "default": null, - "optional": true - }, - { - "name": "value", - "type": "Union[str, float]", - "description": "The value of the data.", - "default": null, - "optional": true - } - ], - "intrinio": [] - }, - "model": "LatestAttributes" - }, - "/equity/fundamental/historical_attributes": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the historical values of a data tag from Intrinio.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_attributes(symbol='AAPL', tag='ebitda', provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", - "default": "", - "optional": false - }, - { - "name": "tag", - "type": "Union[str, List[str]]", - "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", - "default": "", - "optional": false - }, - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "frequency", - "type": "Literal['daily', 'weekly', 'monthly', 'quarterly', 'yearly']", - "description": "The frequency of the data.", - "default": "yearly", - "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 1000, - "optional": true - }, - { - "name": "tag_type", - "type": "str", - "description": "Filter by type, when applicable.", - "default": null, - "optional": true - }, - { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order.", - "default": "desc", - "optional": true - }, - { - "name": "provider", - "type": "Literal['intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", - "default": "intrinio", - "optional": true - } - ], - "intrinio": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[HistoricalAttributes]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['intrinio']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "tag", - "type": "str", - "description": "Tag name for the fetched data.", - "default": null, - "optional": true - }, - { - "name": "value", - "type": "float", - "description": "The value of the data.", - "default": null, - "optional": true - } - ], - "intrinio": [] - }, - "model": "HistoricalAttributes" - }, - "/equity/fundamental/income": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the income statement for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.income(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.income(symbol='AAPL', period='annual', limit=5, provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "period", - "type": "str", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - }, - { - "name": "limit", - "type": "Annotated[int, Ge(ge=0)]", - "description": "The number of data entries to return.", - "default": 5, - "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", - "optional": true - } - ], - "intrinio": [ - { - "name": "period", - "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", - "description": "None", - "default": "annual", - "optional": true - }, - { - "name": "fiscal_year", - "type": "int", - "description": "The specific fiscal year. Reports do not go beyond 2008.", - "default": null, - "optional": true - } - ], - "polygon": [ - { - "name": "period", - "type": "Literal['annual', 'quarter', 'ttm']", - "description": "None", - "default": "annual", - "optional": true - }, - { - "name": "filing_date", - "type": "date", - "description": "Filing date of the financial statement.", - "default": null, - "optional": true - }, - { - "name": "filing_date_lt", - "type": "date", - "description": "Filing date less than the given date.", - "default": null, - "optional": true - }, - { - "name": "filing_date_lte", - "type": "date", - "description": "Filing date less than or equal to the given date.", - "default": null, - "optional": true - }, - { - "name": "filing_date_gt", - "type": "date", - "description": "Filing date greater than the given date.", - "default": null, - "optional": true - }, - { - "name": "filing_date_gte", - "type": "date", - "description": "Filing date greater than or equal to the given date.", - "default": null, - "optional": true - }, - { - "name": "period_of_report_date", - "type": "date", - "description": "Period of report date of the financial statement.", - "default": null, - "optional": true - }, - { - "name": "period_of_report_date_lt", - "type": "date", - "description": "Period of report date less than the given date.", - "default": null, - "optional": true - }, - { - "name": "period_of_report_date_lte", - "type": "date", - "description": "Period of report date less than or equal to the given date.", - "default": null, - "optional": true - }, - { - "name": "period_of_report_date_gt", - "type": "date", - "description": "Period of report date greater than the given date.", - "default": null, - "optional": true - }, - { - "name": "period_of_report_date_gte", - "type": "date", - "description": "Period of report date greater than or equal to the given date.", - "default": null, - "optional": true - }, - { - "name": "include_sources", - "type": "bool", - "description": "Whether to include the sources of the financial statement.", - "default": null, - "optional": true - }, - { - "name": "order", - "type": "Literal['asc', 'desc']", - "description": "Order of the financial statement.", - "default": null, - "optional": true - }, - { - "name": "sort", - "type": "Literal['filing_date', 'period_of_report_date']", - "description": "Sort of the financial statement.", - "default": null, - "optional": true - } - ], - "yfinance": [ - { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "None", - "default": "annual", - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[IncomeStatement]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "period_ending", - "type": "date", - "description": "The end date of the reporting period.", - "default": "", - "optional": false - }, - { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the report.", - "default": null, - "optional": true - }, - { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the fiscal period.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "filing_date", - "type": "date", - "description": "The date when the filing was made.", - "default": null, - "optional": true - }, - { - "name": "accepted_date", - "type": "datetime", - "description": "The date and time when the filing was accepted.", - "default": null, - "optional": true - }, - { - "name": "reported_currency", - "type": "str", - "description": "The currency in which the balance sheet was reported.", - "default": null, - "optional": true - }, - { - "name": "revenue", - "type": "float", - "description": "Total revenue.", - "default": null, - "optional": true - }, - { - "name": "cost_of_revenue", - "type": "float", - "description": "Cost of revenue.", - "default": null, - "optional": true - }, - { - "name": "gross_profit", - "type": "float", - "description": "Gross profit.", - "default": null, - "optional": true - }, - { - "name": "gross_profit_margin", - "type": "float", - "description": "Gross profit margin.", - "default": null, - "optional": true - }, - { - "name": "general_and_admin_expense", - "type": "float", - "description": "General and administrative expenses.", - "default": null, - "optional": true - }, - { - "name": "research_and_development_expense", - "type": "float", - "description": "Research and development expenses.", - "default": null, - "optional": true - }, - { - "name": "selling_and_marketing_expense", - "type": "float", - "description": "Selling and marketing expenses.", - "default": null, - "optional": true - }, - { - "name": "selling_general_and_admin_expense", - "type": "float", - "description": "Selling, general and administrative expenses.", - "default": null, - "optional": true - }, - { - "name": "other_expenses", - "type": "float", - "description": "Other expenses.", - "default": null, - "optional": true - }, - { - "name": "total_operating_expenses", - "type": "float", - "description": "Total operating expenses.", - "default": null, - "optional": true - }, - { - "name": "cost_and_expenses", - "type": "float", - "description": "Cost and expenses.", - "default": null, - "optional": true - }, - { - "name": "interest_income", - "type": "float", - "description": "Interest income.", - "default": null, - "optional": true - }, - { - "name": "total_interest_expense", - "type": "float", - "description": "Total interest expenses.", - "default": null, - "optional": true - }, - { - "name": "depreciation_and_amortization", - "type": "float", - "description": "Depreciation and amortization.", - "default": null, - "optional": true - }, - { - "name": "ebitda", - "type": "float", - "description": "EBITDA.", - "default": null, - "optional": true - }, - { - "name": "ebitda_margin", - "type": "float", - "description": "EBITDA margin.", - "default": null, - "optional": true - }, - { - "name": "total_operating_income", - "type": "float", - "description": "Total operating income.", - "default": null, - "optional": true - }, - { - "name": "operating_income_margin", - "type": "float", - "description": "Operating income margin.", - "default": null, - "optional": true - }, - { - "name": "total_other_income_expenses", - "type": "float", - "description": "Total other income and expenses.", - "default": null, - "optional": true - }, - { - "name": "total_pre_tax_income", - "type": "float", - "description": "Total pre-tax income.", - "default": null, - "optional": true - }, - { - "name": "pre_tax_income_margin", - "type": "float", - "description": "Pre-tax income margin.", - "default": null, - "optional": true - }, - { - "name": "income_tax_expense", - "type": "float", - "description": "Income tax expense.", - "default": null, - "optional": true - }, - { - "name": "consolidated_net_income", - "type": "float", - "description": "Consolidated net income.", - "default": null, - "optional": true - }, - { - "name": "net_income_margin", - "type": "float", - "description": "Net income margin.", - "default": null, - "optional": true - }, - { - "name": "basic_earnings_per_share", - "type": "float", - "description": "Basic earnings per share.", - "default": null, - "optional": true - }, - { - "name": "diluted_earnings_per_share", - "type": "float", - "description": "Diluted earnings per share.", - "default": null, - "optional": true - }, - { - "name": "weighted_average_basic_shares_outstanding", - "type": "float", - "description": "Weighted average basic shares outstanding.", - "default": null, - "optional": true - }, - { - "name": "weighted_average_diluted_shares_outstanding", - "type": "float", - "description": "Weighted average diluted shares outstanding.", - "default": null, - "optional": true - }, - { - "name": "link", - "type": "str", - "description": "Link to the filing.", - "default": null, - "optional": true - }, - { - "name": "final_link", - "type": "str", - "description": "Link to the filing document.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "reported_currency", - "type": "str", - "description": "The currency in which the balance sheet is reported.", - "default": null, - "optional": true - }, - { - "name": "revenue", - "type": "float", - "description": "Total revenue", - "default": null, - "optional": true - }, - { - "name": "operating_revenue", - "type": "float", - "description": "Total operating revenue", - "default": null, - "optional": true - }, - { - "name": "cost_of_revenue", - "type": "float", - "description": "Total cost of revenue", - "default": null, - "optional": true - }, - { - "name": "operating_cost_of_revenue", - "type": "float", - "description": "Total operating cost of revenue", - "default": null, - "optional": true - }, - { - "name": "gross_profit", - "type": "float", - "description": "Total gross profit", - "default": null, - "optional": true - }, - { - "name": "gross_profit_margin", - "type": "float", - "description": "Gross margin ratio.", - "default": null, - "optional": true - }, - { - "name": "provision_for_credit_losses", - "type": "float", - "description": "Provision for credit losses", - "default": null, - "optional": true - }, - { - "name": "research_and_development_expense", - "type": "float", - "description": "Research and development expense", - "default": null, - "optional": true - }, - { - "name": "selling_general_and_admin_expense", - "type": "float", - "description": "Selling, general, and admin expense", - "default": null, - "optional": true - }, - { - "name": "salaries_and_employee_benefits", - "type": "float", - "description": "Salaries and employee benefits", - "default": null, - "optional": true - }, - { - "name": "marketing_expense", - "type": "float", - "description": "Marketing expense", - "default": null, - "optional": true - }, - { - "name": "net_occupancy_and_equipment_expense", - "type": "float", - "description": "Net occupancy and equipment expense", - "default": null, - "optional": true - }, - { - "name": "other_operating_expenses", - "type": "float", - "description": "Other operating expenses", - "default": null, - "optional": true - }, - { - "name": "depreciation_expense", - "type": "float", - "description": "Depreciation expense", - "default": null, - "optional": true - }, - { - "name": "amortization_expense", - "type": "float", - "description": "Amortization expense", - "default": null, - "optional": true - }, - { - "name": "amortization_of_deferred_policy_acquisition_costs", - "type": "float", - "description": "Amortization of deferred policy acquisition costs", - "default": null, - "optional": true - }, - { - "name": "exploration_expense", - "type": "float", - "description": "Exploration expense", - "default": null, - "optional": true - }, - { - "name": "depletion_expense", - "type": "float", - "description": "Depletion expense", - "default": null, - "optional": true - }, - { - "name": "total_operating_expenses", - "type": "float", - "description": "Total operating expenses", - "default": null, - "optional": true - }, - { - "name": "total_operating_income", - "type": "float", - "description": "Total operating income", - "default": null, - "optional": true - }, - { - "name": "deposits_and_money_market_investments_interest_income", - "type": "float", - "description": "Deposits and money market investments interest income", - "default": null, - "optional": true - }, - { - "name": "federal_funds_sold_and_securities_borrowed_interest_income", - "type": "float", - "description": "Federal funds sold and securities borrowed interest income", - "default": null, - "optional": true - }, - { - "name": "investment_securities_interest_income", - "type": "float", - "description": "Investment securities interest income", - "default": null, - "optional": true - }, - { - "name": "loans_and_leases_interest_income", - "type": "float", - "description": "Loans and leases interest income", - "default": null, - "optional": true - }, - { - "name": "trading_account_interest_income", - "type": "float", - "description": "Trading account interest income", - "default": null, - "optional": true - }, - { - "name": "other_interest_income", - "type": "float", - "description": "Other interest income", - "default": null, - "optional": true - }, - { - "name": "total_non_interest_income", - "type": "float", - "description": "Total non-interest income", - "default": null, - "optional": true - }, - { - "name": "interest_and_investment_income", - "type": "float", - "description": "Interest and investment income", - "default": null, - "optional": true - }, - { - "name": "short_term_borrowings_interest_expense", - "type": "float", - "description": "Short-term borrowings interest expense", - "default": null, - "optional": true - }, - { - "name": "long_term_debt_interest_expense", - "type": "float", - "description": "Long-term debt interest expense", - "default": null, - "optional": true - }, - { - "name": "capitalized_lease_obligations_interest_expense", - "type": "float", - "description": "Capitalized lease obligations interest expense", - "default": null, - "optional": true - }, - { - "name": "deposits_interest_expense", - "type": "float", - "description": "Deposits interest expense", - "default": null, - "optional": true - }, - { - "name": "federal_funds_purchased_and_securities_sold_interest_expense", - "type": "float", - "description": "Federal funds purchased and securities sold interest expense", - "default": null, - "optional": true - }, - { - "name": "other_interest_expense", - "type": "float", - "description": "Other interest expense", - "default": null, - "optional": true - }, - { - "name": "total_interest_expense", - "type": "float", - "description": "Total interest expense", - "default": null, - "optional": true - }, - { - "name": "net_interest_income", - "type": "float", - "description": "Net interest income", - "default": null, - "optional": true - }, - { - "name": "other_non_interest_income", - "type": "float", - "description": "Other non-interest income", - "default": null, - "optional": true - }, - { - "name": "investment_banking_income", - "type": "float", - "description": "Investment banking income", - "default": null, - "optional": true - }, - { - "name": "trust_fees_by_commissions", - "type": "float", - "description": "Trust fees by commissions", - "default": null, - "optional": true - }, - { - "name": "premiums_earned", - "type": "float", - "description": "Premiums earned", - "default": null, - "optional": true - }, - { - "name": "insurance_policy_acquisition_costs", - "type": "float", - "description": "Insurance policy acquisition costs", - "default": null, - "optional": true - }, - { - "name": "current_and_future_benefits", - "type": "float", - "description": "Current and future benefits", - "default": null, - "optional": true - }, - { - "name": "property_and_liability_insurance_claims", - "type": "float", - "description": "Property and liability insurance claims", - "default": null, - "optional": true - }, - { - "name": "total_non_interest_expense", - "type": "float", - "description": "Total non-interest expense", - "default": null, - "optional": true - }, - { - "name": "net_realized_and_unrealized_capital_gains_on_investments", - "type": "float", - "description": "Net realized and unrealized capital gains on investments", - "default": null, - "optional": true - }, - { - "name": "other_gains", - "type": "float", - "description": "Other gains", - "default": null, - "optional": true - }, - { - "name": "non_operating_income", - "type": "float", - "description": "Non-operating income", - "default": null, - "optional": true - }, - { - "name": "other_income", - "type": "float", - "description": "Other income", - "default": null, - "optional": true - }, - { - "name": "other_revenue", - "type": "float", - "description": "Other revenue", - "default": null, - "optional": true - }, - { - "name": "extraordinary_income", - "type": "float", - "description": "Extraordinary income", - "default": null, - "optional": true - }, - { - "name": "total_other_income", - "type": "float", - "description": "Total other income", - "default": null, - "optional": true - }, - { - "name": "ebitda", - "type": "float", - "description": "Earnings Before Interest, Taxes, Depreciation and Amortization.", - "default": null, - "optional": true - }, - { - "name": "ebitda_margin", - "type": "float", - "description": "Margin on Earnings Before Interest, Taxes, Depreciation and Amortization.", - "default": null, - "optional": true - }, - { - "name": "total_pre_tax_income", - "type": "float", - "description": "Total pre-tax income", - "default": null, - "optional": true - }, - { - "name": "ebit", - "type": "float", - "description": "Earnings Before Interest and Taxes.", - "default": null, - "optional": true - }, - { - "name": "pre_tax_income_margin", - "type": "float", - "description": "Pre-Tax Income Margin.", - "default": null, - "optional": true - }, - { - "name": "income_tax_expense", - "type": "float", - "description": "Income tax expense", - "default": null, - "optional": true - }, - { - "name": "impairment_charge", - "type": "float", - "description": "Impairment charge", - "default": null, - "optional": true - }, - { - "name": "restructuring_charge", - "type": "float", - "description": "Restructuring charge", - "default": null, - "optional": true - }, - { - "name": "service_charges_on_deposit_accounts", - "type": "float", - "description": "Service charges on deposit accounts", - "default": null, - "optional": true - }, - { - "name": "other_service_charges", - "type": "float", - "description": "Other service charges", - "default": null, - "optional": true - }, - { - "name": "other_special_charges", - "type": "float", - "description": "Other special charges", - "default": null, - "optional": true - }, - { - "name": "other_cost_of_revenue", - "type": "float", - "description": "Other cost of revenue", - "default": null, - "optional": true - }, - { - "name": "net_income_continuing_operations", - "type": "float", - "description": "Net income (continuing operations)", - "default": null, - "optional": true - }, - { - "name": "net_income_discontinued_operations", - "type": "float", - "description": "Net income (discontinued operations)", - "default": null, - "optional": true - }, - { - "name": "consolidated_net_income", - "type": "float", - "description": "Consolidated net income", - "default": null, - "optional": true - }, - { - "name": "other_adjustments_to_consolidated_net_income", - "type": "float", - "description": "Other adjustments to consolidated net income", - "default": null, - "optional": true - }, - { - "name": "other_adjustment_to_net_income_attributable_to_common_shareholders", - "type": "float", - "description": "Other adjustment to net income attributable to common shareholders", - "default": null, - "optional": true - }, - { - "name": "net_income_attributable_to_noncontrolling_interest", - "type": "float", - "description": "Net income attributable to noncontrolling interest", - "default": null, - "optional": true - }, - { - "name": "net_income_attributable_to_common_shareholders", - "type": "float", - "description": "Net income attributable to common shareholders", - "default": null, - "optional": true - }, - { - "name": "basic_earnings_per_share", - "type": "float", - "description": "Basic earnings per share", - "default": null, - "optional": true - }, - { - "name": "diluted_earnings_per_share", - "type": "float", - "description": "Diluted earnings per share", - "default": null, - "optional": true - }, - { - "name": "basic_and_diluted_earnings_per_share", - "type": "float", - "description": "Basic and diluted earnings per share", - "default": null, - "optional": true - }, - { - "name": "cash_dividends_to_common_per_share", - "type": "float", - "description": "Cash dividends to common per share", - "default": null, - "optional": true - }, - { - "name": "preferred_stock_dividends_declared", - "type": "float", - "description": "Preferred stock dividends declared", - "default": null, - "optional": true - }, - { - "name": "weighted_average_basic_shares_outstanding", - "type": "float", - "description": "Weighted average basic shares outstanding", - "default": null, - "optional": true - }, - { - "name": "weighted_average_diluted_shares_outstanding", - "type": "float", - "description": "Weighted average diluted shares outstanding", - "default": null, - "optional": true - }, - { - "name": "weighted_average_basic_and_diluted_shares_outstanding", - "type": "float", - "description": "Weighted average basic and diluted shares outstanding", - "default": null, - "optional": true - } - ], - "polygon": [ - { - "name": "revenue", - "type": "float", - "description": "Total Revenue", - "default": null, - "optional": true - }, - { - "name": "cost_of_revenue_goods", - "type": "float", - "description": "Cost of Revenue - Goods", - "default": null, - "optional": true - }, - { - "name": "cost_of_revenue_services", - "type": "float", - "description": "Cost of Revenue - Services", - "default": null, - "optional": true - }, - { - "name": "cost_of_revenue", - "type": "float", - "description": "Cost of Revenue", - "default": null, - "optional": true - }, - { - "name": "gross_profit", - "type": "float", - "description": "Gross Profit", - "default": null, - "optional": true - }, - { - "name": "provisions_for_loan_lease_and_other_losses", - "type": "float", - "description": "Provisions for loan lease and other losses", - "default": null, - "optional": true - }, - { - "name": "depreciation_and_amortization", - "type": "float", - "description": "Depreciation and Amortization", - "default": null, - "optional": true - }, - { - "name": "income_tax_expense_benefit_current", - "type": "float", - "description": "Income tax expense benefit current", - "default": null, - "optional": true - }, - { - "name": "deferred_tax_benefit", - "type": "float", - "description": "Deferred tax benefit", - "default": null, - "optional": true - }, - { - "name": "benefits_costs_expenses", - "type": "float", - "description": "Benefits, costs and expenses", - "default": null, - "optional": true - }, - { - "name": "selling_general_and_administrative_expense", - "type": "float", - "description": "Selling, general and administrative expense", - "default": null, - "optional": true - }, - { - "name": "research_and_development", - "type": "float", - "description": "Research and development", - "default": null, - "optional": true - }, - { - "name": "costs_and_expenses", - "type": "float", - "description": "Costs and expenses", - "default": null, - "optional": true - }, - { - "name": "other_operating_expenses", - "type": "float", - "description": "Other Operating Expenses", - "default": null, - "optional": true - }, - { - "name": "operating_expenses", - "type": "float", - "description": "Operating expenses", - "default": null, - "optional": true - }, - { - "name": "operating_income", - "type": "float", - "description": "Operating Income/Loss", - "default": null, - "optional": true - }, - { - "name": "non_operating_income", - "type": "float", - "description": "Non Operating Income/Loss", - "default": null, - "optional": true - }, - { - "name": "interest_and_dividend_income", - "type": "float", - "description": "Interest and Dividend Income", - "default": null, - "optional": true - }, - { - "name": "total_interest_expense", - "type": "float", - "description": "Interest Expense", - "default": null, - "optional": true - }, - { - "name": "interest_and_debt_expense", - "type": "float", - "description": "Interest and Debt Expense", - "default": null, - "optional": true - }, - { - "name": "net_interest_income", - "type": "float", - "description": "Interest Income Net", - "default": null, - "optional": true - }, - { - "name": "interest_income_after_provision_for_losses", - "type": "float", - "description": "Interest Income After Provision for Losses", - "default": null, - "optional": true - }, - { - "name": "non_interest_expense", - "type": "float", - "description": "Non-Interest Expense", - "default": null, - "optional": true - }, - { - "name": "non_interest_income", - "type": "float", - "description": "Non-Interest Income", - "default": null, - "optional": true - }, - { - "name": "income_from_discontinued_operations_net_of_tax_on_disposal", - "type": "float", - "description": "Income From Discontinued Operations Net of Tax on Disposal", - "default": null, - "optional": true - }, - { - "name": "income_from_discontinued_operations_net_of_tax", - "type": "float", - "description": "Income From Discontinued Operations Net of Tax", - "default": null, - "optional": true - }, - { - "name": "income_before_equity_method_investments", - "type": "float", - "description": "Income Before Equity Method Investments", - "default": null, - "optional": true - }, - { - "name": "income_from_equity_method_investments", - "type": "float", - "description": "Income From Equity Method Investments", - "default": null, - "optional": true - }, - { - "name": "total_pre_tax_income", - "type": "float", - "description": "Income Before Tax", - "default": null, - "optional": true - }, - { - "name": "income_tax_expense", - "type": "float", - "description": "Income Tax Expense", - "default": null, - "optional": true - }, - { - "name": "income_after_tax", - "type": "float", - "description": "Income After Tax", - "default": null, - "optional": true - }, - { - "name": "consolidated_net_income", - "type": "float", - "description": "Net Income/Loss", - "default": null, - "optional": true - }, - { - "name": "net_income_attributable_noncontrolling_interest", - "type": "float", - "description": "Net income (loss) attributable to noncontrolling interest", - "default": null, - "optional": true - }, - { - "name": "net_income_attributable_to_parent", - "type": "float", - "description": "Net income (loss) attributable to parent", - "default": null, - "optional": true - }, - { - "name": "net_income_attributable_to_common_shareholders", - "type": "float", - "description": "Net Income/Loss Available To Common Stockholders Basic", - "default": null, - "optional": true - }, - { - "name": "participating_securities_earnings", - "type": "float", - "description": "Participating Securities Distributed And Undistributed Earnings Loss Basic", - "default": null, - "optional": true - }, - { - "name": "undistributed_earnings_allocated_to_participating_securities", - "type": "float", - "description": "Undistributed Earnings Allocated To Participating Securities", - "default": null, - "optional": true - }, - { - "name": "common_stock_dividends", - "type": "float", - "description": "Common Stock Dividends", - "default": null, - "optional": true - }, - { - "name": "preferred_stock_dividends_and_other_adjustments", - "type": "float", - "description": "Preferred stock dividends and other adjustments", - "default": null, - "optional": true - }, - { - "name": "basic_earnings_per_share", - "type": "float", - "description": "Earnings Per Share", - "default": null, - "optional": true - }, - { - "name": "diluted_earnings_per_share", - "type": "float", - "description": "Diluted Earnings Per Share", - "default": null, - "optional": true - }, - { - "name": "weighted_average_basic_shares_outstanding", - "type": "float", - "description": "Basic Average Shares", - "default": null, - "optional": true - }, - { - "name": "weighted_average_diluted_shares_outstanding", - "type": "float", - "description": "Diluted Average Shares", - "default": null, - "optional": true - } - ], - "yfinance": [] - }, - "model": "IncomeStatement" - }, - "/equity/fundamental/income_growth": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the growth of a company's income statement items over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.income_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.income_growth(symbol='AAPL', limit=10, period='annual', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 10, - "optional": true - }, - { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[IncomeStatementGrowth]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": null, - "optional": true - }, - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "period", - "type": "str", - "description": "Period the statement is returned for.", - "default": "", - "optional": false - }, - { - "name": "growth_revenue", - "type": "float", - "description": "Growth rate of total revenue.", - "default": "", - "optional": false - }, - { - "name": "growth_cost_of_revenue", - "type": "float", - "description": "Growth rate of cost of goods sold.", - "default": "", - "optional": false - }, - { - "name": "growth_gross_profit", - "type": "float", - "description": "Growth rate of gross profit.", - "default": "", - "optional": false - }, - { - "name": "growth_gross_profit_ratio", - "type": "float", - "description": "Growth rate of gross profit as a percentage of revenue.", - "default": "", - "optional": false - }, - { - "name": "growth_research_and_development_expenses", - "type": "float", - "description": "Growth rate of expenses on research and development.", - "default": "", - "optional": false - }, - { - "name": "growth_general_and_administrative_expenses", - "type": "float", - "description": "Growth rate of general and administrative expenses.", - "default": "", - "optional": false - }, - { - "name": "growth_selling_and_marketing_expenses", - "type": "float", - "description": "Growth rate of expenses on selling and marketing activities.", - "default": "", - "optional": false - }, - { - "name": "growth_other_expenses", - "type": "float", - "description": "Growth rate of other operating expenses.", - "default": "", - "optional": false - }, - { - "name": "growth_operating_expenses", - "type": "float", - "description": "Growth rate of total operating expenses.", - "default": "", - "optional": false - }, - { - "name": "growth_cost_and_expenses", - "type": "float", - "description": "Growth rate of total costs and expenses.", - "default": "", - "optional": false - }, - { - "name": "growth_interest_expense", - "type": "float", - "description": "Growth rate of interest expenses.", - "default": "", - "optional": false - }, - { - "name": "growth_depreciation_and_amortization", - "type": "float", - "description": "Growth rate of depreciation and amortization expenses.", - "default": "", - "optional": false - }, - { - "name": "growth_ebitda", - "type": "float", - "description": "Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization.", - "default": "", - "optional": false - }, - { - "name": "growth_ebitda_ratio", - "type": "float", - "description": "Growth rate of EBITDA as a percentage of revenue.", - "default": "", - "optional": false - }, - { - "name": "growth_operating_income", - "type": "float", - "description": "Growth rate of operating income.", - "default": "", - "optional": false - }, - { - "name": "growth_operating_income_ratio", - "type": "float", - "description": "Growth rate of operating income as a percentage of revenue.", - "default": "", - "optional": false - }, - { - "name": "growth_total_other_income_expenses_net", - "type": "float", - "description": "Growth rate of net total other income and expenses.", - "default": "", - "optional": false - }, - { - "name": "growth_income_before_tax", - "type": "float", - "description": "Growth rate of income before taxes.", - "default": "", - "optional": false - }, - { - "name": "growth_income_before_tax_ratio", - "type": "float", - "description": "Growth rate of income before taxes as a percentage of revenue.", - "default": "", - "optional": false - }, - { - "name": "growth_income_tax_expense", - "type": "float", - "description": "Growth rate of income tax expenses.", - "default": "", - "optional": false - }, - { - "name": "growth_net_income", - "type": "float", - "description": "Growth rate of net income.", - "default": "", - "optional": false - }, - { - "name": "growth_net_income_ratio", - "type": "float", - "description": "Growth rate of net income as a percentage of revenue.", - "default": "", - "optional": false - }, - { - "name": "growth_eps", - "type": "float", - "description": "Growth rate of Earnings Per Share (EPS).", - "default": "", - "optional": false - }, - { - "name": "growth_eps_diluted", - "type": "float", - "description": "Growth rate of diluted Earnings Per Share (EPS).", - "default": "", - "optional": false - }, - { - "name": "growth_weighted_average_shs_out", - "type": "float", - "description": "Growth rate of weighted average shares outstanding.", - "default": "", - "optional": false - }, - { - "name": "growth_weighted_average_shs_out_dil", - "type": "float", - "description": "Growth rate of diluted weighted average shares outstanding.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "IncomeStatementGrowth" - }, - "/equity/fundamental/metrics": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get fundamental metrics for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.metrics(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.metrics(symbol='AAPL', period='annual', limit=100, provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, yfinance.", - "default": "", - "optional": false - }, - { - "name": "period", - "type": "Literal['annual', 'quarter']", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 100, - "optional": true - }, - { - "name": "provider", - "type": "Literal['finviz', 'fmp', 'intrinio', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default.", - "default": "finviz", - "optional": true - } - ], - "finviz": [], - "fmp": [ - { - "name": "with_ttm", - "type": "bool", - "description": "Include trailing twelve months (TTM) data.", - "default": false, - "optional": true - } - ], - "intrinio": [], - "yfinance": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[KeyMetrics]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['finviz', 'fmp', 'intrinio', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": null, - "optional": true - }, - { - "name": "market_cap", - "type": "float", - "description": "Market capitalization", - "default": null, - "optional": true - }, - { - "name": "pe_ratio", - "type": "float", - "description": "Price-to-earnings ratio (P/E ratio)", - "default": null, - "optional": true - } - ], - "finviz": [ - { - "name": "foward_pe", - "type": "float", - "description": "Forward price-to-earnings ratio (forward P/E)", - "default": null, - "optional": true - }, - { - "name": "eps", - "type": "float", - "description": "Earnings per share (EPS)", - "default": null, - "optional": true - }, - { - "name": "price_to_sales", - "type": "float", - "description": "Price-to-sales ratio (P/S)", - "default": null, - "optional": true - }, - { - "name": "price_to_book", - "type": "float", - "description": "Price-to-book ratio (P/B)", - "default": null, - "optional": true - }, - { - "name": "book_value_per_share", - "type": "float", - "description": "Book value per share (Book/sh)", - "default": null, - "optional": true - }, - { - "name": "price_to_cash", - "type": "float", - "description": "Price-to-cash ratio (P/C)", - "default": null, - "optional": true - }, - { - "name": "cash_per_share", - "type": "float", - "description": "Cash per share (Cash/sh)", - "default": null, - "optional": true - }, - { - "name": "price_to_free_cash_flow", - "type": "float", - "description": "Price-to-free cash flow ratio (P/FCF)", - "default": null, - "optional": true - }, - { - "name": "debt_to_equity", - "type": "float", - "description": "Debt-to-equity ratio (Debt/Eq)", - "default": null, - "optional": true - }, - { - "name": "long_term_debt_to_equity", - "type": "float", - "description": "Long-term debt-to-equity ratio (LT Debt/Eq)", - "default": null, - "optional": true - }, - { - "name": "quick_ratio", - "type": "float", - "description": "Quick ratio", - "default": null, - "optional": true - }, - { - "name": "current_ratio", - "type": "float", - "description": "Current ratio", - "default": null, - "optional": true - }, - { - "name": "gross_margin", - "type": "float", - "description": "Gross margin, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "profit_margin", - "type": "float", - "description": "Profit margin, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "operating_margin", - "type": "float", - "description": "Operating margin, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "return_on_assets", - "type": "float", - "description": "Return on assets (ROA), as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "return_on_investment", - "type": "float", - "description": "Return on investment (ROI), as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "return_on_equity", - "type": "float", - "description": "Return on equity (ROE), as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "payout_ratio", - "type": "float", - "description": "Payout ratio, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "dividend_yield", - "type": "float", - "description": "Dividend yield, as a normalized percent.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "period", - "type": "str", - "description": "Period of the data.", - "default": "", - "optional": false - }, - { - "name": "calendar_year", - "type": "int", - "description": "Calendar year.", - "default": null, - "optional": true - }, - { - "name": "revenue_per_share", - "type": "float", - "description": "Revenue per share", - "default": null, - "optional": true - }, - { - "name": "net_income_per_share", - "type": "float", - "description": "Net income per share", - "default": null, - "optional": true - }, - { - "name": "operating_cash_flow_per_share", - "type": "float", - "description": "Operating cash flow per share", - "default": null, - "optional": true - }, - { - "name": "free_cash_flow_per_share", - "type": "float", - "description": "Free cash flow per share", - "default": null, - "optional": true - }, - { - "name": "cash_per_share", - "type": "float", - "description": "Cash per share", - "default": null, - "optional": true - }, - { - "name": "book_value_per_share", - "type": "float", - "description": "Book value per share", - "default": null, - "optional": true - }, - { - "name": "tangible_book_value_per_share", - "type": "float", - "description": "Tangible book value per share", - "default": null, - "optional": true - }, - { - "name": "shareholders_equity_per_share", - "type": "float", - "description": "Shareholders equity per share", - "default": null, - "optional": true - }, - { - "name": "interest_debt_per_share", - "type": "float", - "description": "Interest debt per share", - "default": null, - "optional": true - }, - { - "name": "enterprise_value", - "type": "float", - "description": "Enterprise value", - "default": null, - "optional": true - }, - { - "name": "price_to_sales_ratio", - "type": "float", - "description": "Price-to-sales ratio", - "default": null, - "optional": true - }, - { - "name": "pocf_ratio", - "type": "float", - "description": "Price-to-operating cash flow ratio", - "default": null, - "optional": true - }, - { - "name": "pfcf_ratio", - "type": "float", - "description": "Price-to-free cash flow ratio", - "default": null, - "optional": true - }, - { - "name": "pb_ratio", - "type": "float", - "description": "Price-to-book ratio", - "default": null, - "optional": true - }, - { - "name": "ptb_ratio", - "type": "float", - "description": "Price-to-tangible book ratio", - "default": null, - "optional": true - }, - { - "name": "ev_to_sales", - "type": "float", - "description": "Enterprise value-to-sales ratio", - "default": null, - "optional": true - }, - { - "name": "enterprise_value_over_ebitda", - "type": "float", - "description": "Enterprise value-to-EBITDA ratio", - "default": null, - "optional": true - }, - { - "name": "ev_to_operating_cash_flow", - "type": "float", - "description": "Enterprise value-to-operating cash flow ratio", - "default": null, - "optional": true - }, - { - "name": "ev_to_free_cash_flow", - "type": "float", - "description": "Enterprise value-to-free cash flow ratio", - "default": null, - "optional": true - }, - { - "name": "earnings_yield", - "type": "float", - "description": "Earnings yield", - "default": null, - "optional": true - }, - { - "name": "free_cash_flow_yield", - "type": "float", - "description": "Free cash flow yield", - "default": null, - "optional": true - }, - { - "name": "debt_to_equity", - "type": "float", - "description": "Debt-to-equity ratio", - "default": null, - "optional": true - }, - { - "name": "debt_to_assets", - "type": "float", - "description": "Debt-to-assets ratio", - "default": null, - "optional": true - }, - { - "name": "net_debt_to_ebitda", - "type": "float", - "description": "Net debt-to-EBITDA ratio", - "default": null, - "optional": true - }, - { - "name": "current_ratio", - "type": "float", - "description": "Current ratio", - "default": null, - "optional": true - }, - { - "name": "interest_coverage", - "type": "float", - "description": "Interest coverage", - "default": null, - "optional": true - }, - { - "name": "income_quality", - "type": "float", - "description": "Income quality", - "default": null, - "optional": true - }, - { - "name": "dividend_yield", - "type": "float", - "description": "Dividend yield, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "payout_ratio", - "type": "float", - "description": "Payout ratio", - "default": null, - "optional": true - }, - { - "name": "sales_general_and_administrative_to_revenue", - "type": "float", - "description": "Sales general and administrative expenses-to-revenue ratio", - "default": null, - "optional": true - }, - { - "name": "research_and_development_to_revenue", - "type": "float", - "description": "Research and development expenses-to-revenue ratio", - "default": null, - "optional": true - }, - { - "name": "intangibles_to_total_assets", - "type": "float", - "description": "Intangibles-to-total assets ratio", - "default": null, - "optional": true - }, - { - "name": "capex_to_operating_cash_flow", - "type": "float", - "description": "Capital expenditures-to-operating cash flow ratio", - "default": null, - "optional": true - }, - { - "name": "capex_to_revenue", - "type": "float", - "description": "Capital expenditures-to-revenue ratio", - "default": null, - "optional": true - }, - { - "name": "capex_to_depreciation", - "type": "float", - "description": "Capital expenditures-to-depreciation ratio", - "default": null, - "optional": true - }, - { - "name": "stock_based_compensation_to_revenue", - "type": "float", - "description": "Stock-based compensation-to-revenue ratio", - "default": null, - "optional": true - }, - { - "name": "graham_number", - "type": "float", - "description": "Graham number", - "default": null, - "optional": true - }, - { - "name": "roic", - "type": "float", - "description": "Return on invested capital", - "default": null, - "optional": true - }, - { - "name": "return_on_tangible_assets", - "type": "float", - "description": "Return on tangible assets", - "default": null, - "optional": true - }, - { - "name": "graham_net_net", - "type": "float", - "description": "Graham net-net working capital", - "default": null, - "optional": true - }, - { - "name": "working_capital", - "type": "float", - "description": "Working capital", - "default": null, - "optional": true - }, - { - "name": "tangible_asset_value", - "type": "float", - "description": "Tangible asset value", - "default": null, - "optional": true - }, - { - "name": "net_current_asset_value", - "type": "float", - "description": "Net current asset value", - "default": null, - "optional": true - }, - { - "name": "invested_capital", - "type": "float", - "description": "Invested capital", - "default": null, - "optional": true - }, - { - "name": "average_receivables", - "type": "float", - "description": "Average receivables", - "default": null, - "optional": true - }, - { - "name": "average_payables", - "type": "float", - "description": "Average payables", - "default": null, - "optional": true - }, - { - "name": "average_inventory", - "type": "float", - "description": "Average inventory", - "default": null, - "optional": true - }, - { - "name": "days_sales_outstanding", - "type": "float", - "description": "Days sales outstanding", - "default": null, - "optional": true - }, - { - "name": "days_payables_outstanding", - "type": "float", - "description": "Days payables outstanding", - "default": null, - "optional": true - }, - { - "name": "days_of_inventory_on_hand", - "type": "float", - "description": "Days of inventory on hand", - "default": null, - "optional": true - }, - { - "name": "receivables_turnover", - "type": "float", - "description": "Receivables turnover", - "default": null, - "optional": true - }, - { - "name": "payables_turnover", - "type": "float", - "description": "Payables turnover", - "default": null, - "optional": true - }, - { - "name": "inventory_turnover", - "type": "float", - "description": "Inventory turnover", - "default": null, - "optional": true - }, - { - "name": "roe", - "type": "float", - "description": "Return on equity", - "default": null, - "optional": true - }, - { - "name": "capex_per_share", - "type": "float", - "description": "Capital expenditures per share", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "price_to_book", - "type": "float", - "description": "Price to book ratio.", - "default": null, - "optional": true - }, - { - "name": "price_to_tangible_book", - "type": "float", - "description": "Price to tangible book ratio.", - "default": null, - "optional": true - }, - { - "name": "price_to_revenue", - "type": "float", - "description": "Price to revenue ratio.", - "default": null, - "optional": true - }, - { - "name": "quick_ratio", - "type": "float", - "description": "Quick ratio.", - "default": null, - "optional": true - }, - { - "name": "gross_margin", - "type": "float", - "description": "Gross margin, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "ebit_margin", - "type": "float", - "description": "EBIT margin, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "profit_margin", - "type": "float", - "description": "Profit margin, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "eps", - "type": "float", - "description": "Basic earnings per share.", - "default": null, - "optional": true - }, - { - "name": "eps_growth", - "type": "float", - "description": "EPS growth, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "revenue_growth", - "type": "float", - "description": "Revenue growth, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "ebitda_growth", - "type": "float", - "description": "EBITDA growth, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "ebit_growth", - "type": "float", - "description": "EBIT growth, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "net_income_growth", - "type": "float", - "description": "Net income growth, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "free_cash_flow_to_firm_growth", - "type": "float", - "description": "Free cash flow to firm growth, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "invested_capital_growth", - "type": "float", - "description": "Invested capital growth, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "return_on_assets", - "type": "float", - "description": "Return on assets, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "return_on_equity", - "type": "float", - "description": "Return on equity, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "return_on_invested_capital", - "type": "float", - "description": "Return on invested capital, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "ebitda", - "type": "int", - "description": "Earnings before interest, taxes, depreciation, and amortization.", - "default": null, - "optional": true - }, - { - "name": "ebit", - "type": "int", - "description": "Earnings before interest and taxes.", - "default": null, - "optional": true - }, - { - "name": "long_term_debt", - "type": "int", - "description": "Long-term debt.", - "default": null, - "optional": true - }, - { - "name": "total_debt", - "type": "int", - "description": "Total debt.", - "default": null, - "optional": true - }, - { - "name": "total_capital", - "type": "int", - "description": "The sum of long-term debt and total shareholder equity.", - "default": null, - "optional": true - }, - { - "name": "enterprise_value", - "type": "int", - "description": "Enterprise value.", - "default": null, - "optional": true - }, - { - "name": "free_cash_flow_to_firm", - "type": "int", - "description": "Free cash flow to firm.", - "default": null, - "optional": true - }, - { - "name": "altman_z_score", - "type": "float", - "description": "Altman Z-score.", - "default": null, - "optional": true - }, - { - "name": "beta", - "type": "float", - "description": "Beta relative to the broad market (rolling three-year).", - "default": null, - "optional": true - }, - { - "name": "dividend_yield", - "type": "float", - "description": "Dividend yield, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "earnings_yield", - "type": "float", - "description": "Earnings yield, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "last_price", - "type": "float", - "description": "Last price of the stock.", - "default": null, - "optional": true - }, - { - "name": "year_high", - "type": "float", - "description": "52 week high", - "default": null, - "optional": true - }, - { - "name": "year_low", - "type": "float", - "description": "52 week low", - "default": null, - "optional": true - }, - { - "name": "volume_avg", - "type": "int", - "description": "Average daily volume.", - "default": null, - "optional": true - }, - { - "name": "short_interest", - "type": "int", - "description": "Number of shares reported as sold short.", - "default": null, - "optional": true - }, - { - "name": "shares_outstanding", - "type": "int", - "description": "Weighted average shares outstanding (TTM).", - "default": null, - "optional": true - }, - { - "name": "days_to_cover", - "type": "float", - "description": "Days to cover short interest, based on average daily volume.", - "default": null, - "optional": true - } - ], - "yfinance": [ - { - "name": "forward_pe", - "type": "float", - "description": "Forward price-to-earnings ratio.", - "default": null, - "optional": true - }, - { - "name": "peg_ratio", - "type": "float", - "description": "PEG ratio (5-year expected).", - "default": null, - "optional": true - }, - { - "name": "peg_ratio_ttm", - "type": "float", - "description": "PEG ratio (TTM).", - "default": null, - "optional": true - }, - { - "name": "eps_ttm", - "type": "float", - "description": "Earnings per share (TTM).", - "default": null, - "optional": true - }, - { - "name": "eps_forward", - "type": "float", - "description": "Forward earnings per share.", - "default": null, - "optional": true - }, - { - "name": "enterprise_to_ebitda", - "type": "float", - "description": "Enterprise value to EBITDA ratio.", - "default": null, - "optional": true - }, - { - "name": "earnings_growth", - "type": "float", - "description": "Earnings growth (Year Over Year), as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "earnings_growth_quarterly", - "type": "float", - "description": "Quarterly earnings growth (Year Over Year), as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "revenue_per_share", - "type": "float", - "description": "Revenue per share (TTM).", - "default": null, - "optional": true - }, - { - "name": "revenue_growth", - "type": "float", - "description": "Revenue growth (Year Over Year), as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "enterprise_to_revenue", - "type": "float", - "description": "Enterprise value to revenue ratio.", - "default": null, - "optional": true - }, - { - "name": "cash_per_share", - "type": "float", - "description": "Cash per share.", - "default": null, - "optional": true - }, - { - "name": "quick_ratio", - "type": "float", - "description": "Quick ratio.", - "default": null, - "optional": true - }, - { - "name": "current_ratio", - "type": "float", - "description": "Current ratio.", - "default": null, - "optional": true - }, - { - "name": "debt_to_equity", - "type": "float", - "description": "Debt-to-equity ratio.", - "default": null, - "optional": true - }, - { - "name": "gross_margin", - "type": "float", - "description": "Gross margin, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "operating_margin", - "type": "float", - "description": "Operating margin, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "ebitda_margin", - "type": "float", - "description": "EBITDA margin, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "profit_margin", - "type": "float", - "description": "Profit margin, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "return_on_assets", - "type": "float", - "description": "Return on assets, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "return_on_equity", - "type": "float", - "description": "Return on equity, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "dividend_yield", - "type": "float", - "description": "Dividend yield, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "dividend_yield_5y_avg", - "type": "float", - "description": "5-year average dividend yield, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "payout_ratio", - "type": "float", - "description": "Payout ratio.", - "default": null, - "optional": true - }, - { - "name": "book_value", - "type": "float", - "description": "Book value per share.", - "default": null, - "optional": true - }, - { - "name": "price_to_book", - "type": "float", - "description": "Price-to-book ratio.", - "default": null, - "optional": true - }, - { - "name": "enterprise_value", - "type": "int", - "description": "Enterprise value.", - "default": null, - "optional": true - }, - { - "name": "overall_risk", - "type": "float", - "description": "Overall risk score.", - "default": null, - "optional": true - }, - { - "name": "audit_risk", - "type": "float", - "description": "Audit risk score.", - "default": null, - "optional": true - }, - { - "name": "board_risk", - "type": "float", - "description": "Board risk score.", - "default": null, - "optional": true - }, - { - "name": "compensation_risk", - "type": "float", - "description": "Compensation risk score.", - "default": null, - "optional": true - }, - { - "name": "shareholder_rights_risk", - "type": "float", - "description": "Shareholder rights risk score.", - "default": null, - "optional": true - }, - { - "name": "beta", - "type": "float", - "description": "Beta relative to the broad market (5-year monthly).", - "default": null, - "optional": true - }, - { - "name": "price_return_1y", - "type": "float", - "description": "One-year price return, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "currency", - "type": "str", - "description": "Currency in which the data is presented.", - "default": null, - "optional": true - } - ] - }, - "model": "KeyMetrics" - }, - "/equity/fundamental/management": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get executive management team data for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.management(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['fmp', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [], - "yfinance": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[KeyExecutives]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "title", - "type": "str", - "description": "Designation of the key executive.", - "default": "", - "optional": false - }, - { - "name": "name", - "type": "str", - "description": "Name of the key executive.", - "default": "", - "optional": false - }, - { - "name": "pay", - "type": "int", - "description": "Pay of the key executive.", - "default": null, - "optional": true - }, - { - "name": "currency_pay", - "type": "str", - "description": "Currency of the pay.", - "default": null, - "optional": true - }, - { - "name": "gender", - "type": "str", - "description": "Gender of the key executive.", - "default": null, - "optional": true - }, - { - "name": "year_born", - "type": "int", - "description": "Birth year of the key executive.", - "default": null, - "optional": true - }, - { - "name": "title_since", - "type": "int", - "description": "Date the tile was held since.", - "default": null, - "optional": true - } - ], - "fmp": [], - "yfinance": [ - { - "name": "exercised_value", - "type": "int", - "description": "Value of shares exercised.", - "default": null, - "optional": true - }, - { - "name": "unexercised_value", - "type": "int", - "description": "Value of shares not exercised.", - "default": null, - "optional": true - } - ] - }, - "model": "KeyExecutives" - }, - "/equity/fundamental/management_compensation": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get executive management team compensation for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.management_compensation(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "year", - "type": "int", - "description": "Year of the compensation.", - "default": null, - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[ExecutiveCompensation]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "cik", - "type": "str", - "description": "Central Index Key (CIK) for the requested entity.", - "default": null, - "optional": true - }, - { - "name": "company_name", - "type": "str", - "description": "The name of the company.", - "default": null, - "optional": true - }, - { - "name": "industry", - "type": "str", - "description": "The industry of the company.", - "default": null, - "optional": true - }, - { - "name": "year", - "type": "int", - "description": "Year of the compensation.", - "default": null, - "optional": true - }, - { - "name": "name_and_position", - "type": "str", - "description": "Name and position.", - "default": null, - "optional": true - }, - { - "name": "salary", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Salary.", - "default": null, - "optional": true - }, - { - "name": "bonus", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Bonus payments.", - "default": null, - "optional": true - }, - { - "name": "stock_award", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Stock awards.", - "default": null, - "optional": true - }, - { - "name": "incentive_plan_compensation", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Incentive plan compensation.", - "default": null, - "optional": true - }, - { - "name": "all_other_compensation", - "type": "Annotated[float, Ge(ge=0)]", - "description": "All other compensation.", - "default": null, - "optional": true - }, - { - "name": "total", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Total compensation.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "filing_date", - "type": "date", - "description": "Date of the filing.", - "default": null, - "optional": true - }, - { - "name": "accepted_date", - "type": "datetime", - "description": "Date the filing was accepted.", - "default": null, - "optional": true - }, - { - "name": "url", - "type": "str", - "description": "URL to the filing data.", - "default": null, - "optional": true - } - ] - }, - "model": "ExecutiveCompensation" - }, - "/equity/fundamental/overview": { - "deprecated": { - "flag": true, - "message": "This endpoint is deprecated; use `/equity/profile` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.3." - }, - "description": "Get company general business and stock data for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.overview(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[CompanyOverview]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "price", - "type": "float", - "description": "Price of the company.", - "default": null, - "optional": true - }, - { - "name": "beta", - "type": "float", - "description": "Beta of the company.", - "default": null, - "optional": true - }, - { - "name": "vol_avg", - "type": "int", - "description": "Volume average of the company.", - "default": null, - "optional": true - }, - { - "name": "mkt_cap", - "type": "int", - "description": "Market capitalization of the company.", - "default": null, - "optional": true - }, - { - "name": "last_div", - "type": "float", - "description": "Last dividend of the company.", - "default": null, - "optional": true - }, - { - "name": "range", - "type": "str", - "description": "Range of the company.", - "default": null, - "optional": true - }, - { - "name": "changes", - "type": "float", - "description": "Changes of the company.", - "default": null, - "optional": true - }, - { - "name": "company_name", - "type": "str", - "description": "Company name of the company.", - "default": null, - "optional": true - }, - { - "name": "currency", - "type": "str", - "description": "Currency of the company.", - "default": null, - "optional": true - }, - { - "name": "cik", - "type": "str", - "description": "Central Index Key (CIK) for the requested entity.", - "default": null, - "optional": true - }, - { - "name": "isin", - "type": "str", - "description": "ISIN of the company.", - "default": null, - "optional": true - }, - { - "name": "cusip", - "type": "str", - "description": "CUSIP of the company.", - "default": null, - "optional": true - }, - { - "name": "exchange", - "type": "str", - "description": "Exchange of the company.", - "default": null, - "optional": true - }, - { - "name": "exchange_short_name", - "type": "str", - "description": "Exchange short name of the company.", - "default": null, - "optional": true - }, - { - "name": "industry", - "type": "str", - "description": "Industry of the company.", - "default": null, - "optional": true - }, - { - "name": "website", - "type": "str", - "description": "Website of the company.", - "default": null, - "optional": true - }, - { - "name": "description", - "type": "str", - "description": "Description of the company.", - "default": null, - "optional": true - }, - { - "name": "ceo", - "type": "str", - "description": "CEO of the company.", - "default": null, - "optional": true - }, - { - "name": "sector", - "type": "str", - "description": "Sector of the company.", - "default": null, - "optional": true - }, - { - "name": "country", - "type": "str", - "description": "Country of the company.", - "default": null, - "optional": true - }, - { - "name": "full_time_employees", - "type": "str", - "description": "Full time employees of the company.", - "default": null, - "optional": true - }, - { - "name": "phone", - "type": "str", - "description": "Phone of the company.", - "default": null, - "optional": true - }, - { - "name": "address", - "type": "str", - "description": "Address of the company.", - "default": null, - "optional": true - }, - { - "name": "city", - "type": "str", - "description": "City of the company.", - "default": null, - "optional": true - }, - { - "name": "state", - "type": "str", - "description": "State of the company.", - "default": null, - "optional": true - }, - { - "name": "zip", - "type": "str", - "description": "Zip of the company.", - "default": null, - "optional": true - }, - { - "name": "dcf_diff", - "type": "float", - "description": "Discounted cash flow difference of the company.", - "default": null, - "optional": true - }, - { - "name": "dcf", - "type": "float", - "description": "Discounted cash flow of the company.", - "default": null, - "optional": true - }, - { - "name": "image", - "type": "str", - "description": "Image of the company.", - "default": null, - "optional": true - }, - { - "name": "ipo_date", - "type": "date", - "description": "IPO date of the company.", - "default": null, - "optional": true - }, - { - "name": "default_image", - "type": "bool", - "description": "If the image is the default image.", - "default": "", - "optional": false - }, - { - "name": "is_etf", - "type": "bool", - "description": "If the company is an ETF.", - "default": "", - "optional": false - }, - { - "name": "is_actively_trading", - "type": "bool", - "description": "If the company is actively trading.", - "default": "", - "optional": false - }, - { - "name": "is_adr", - "type": "bool", - "description": "If the company is an ADR.", - "default": "", - "optional": false - }, - { - "name": "is_fund", - "type": "bool", - "description": "If the company is a fund.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "CompanyOverview" - }, - "/equity/fundamental/ratios": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get an extensive set of financial and accounting ratios for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.ratios(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.ratios(symbol='AAPL', period='annual', limit=12, provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "period", - "type": "str", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 12, - "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp', 'intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "period", - "type": "Literal['annual', 'quarter', 'ttm']", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - } - ], - "intrinio": [ - { - "name": "period", - "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - }, - { - "name": "fiscal_year", - "type": "int", - "description": "The specific fiscal year. Reports do not go beyond 2008.", - "default": null, - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[FinancialRatios]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "period_ending", - "type": "str", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "fiscal_period", - "type": "str", - "description": "Period of the financial ratios.", - "default": "", - "optional": false - }, - { - "name": "fiscal_year", - "type": "int", - "description": "Fiscal year.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "current_ratio", - "type": "float", - "description": "Current ratio.", - "default": null, - "optional": true - }, - { - "name": "quick_ratio", - "type": "float", - "description": "Quick ratio.", - "default": null, - "optional": true - }, - { - "name": "cash_ratio", - "type": "float", - "description": "Cash ratio.", - "default": null, - "optional": true - }, - { - "name": "days_of_sales_outstanding", - "type": "float", - "description": "Days of sales outstanding.", - "default": null, - "optional": true - }, - { - "name": "days_of_inventory_outstanding", - "type": "float", - "description": "Days of inventory outstanding.", - "default": null, - "optional": true - }, - { - "name": "operating_cycle", - "type": "float", - "description": "Operating cycle.", - "default": null, - "optional": true - }, - { - "name": "days_of_payables_outstanding", - "type": "float", - "description": "Days of payables outstanding.", - "default": null, - "optional": true - }, - { - "name": "cash_conversion_cycle", - "type": "float", - "description": "Cash conversion cycle.", - "default": null, - "optional": true - }, - { - "name": "gross_profit_margin", - "type": "float", - "description": "Gross profit margin.", - "default": null, - "optional": true - }, - { - "name": "operating_profit_margin", - "type": "float", - "description": "Operating profit margin.", - "default": null, - "optional": true - }, - { - "name": "pretax_profit_margin", - "type": "float", - "description": "Pretax profit margin.", - "default": null, - "optional": true - }, - { - "name": "net_profit_margin", - "type": "float", - "description": "Net profit margin.", - "default": null, - "optional": true - }, - { - "name": "effective_tax_rate", - "type": "float", - "description": "Effective tax rate.", - "default": null, - "optional": true - }, - { - "name": "return_on_assets", - "type": "float", - "description": "Return on assets.", - "default": null, - "optional": true - }, - { - "name": "return_on_equity", - "type": "float", - "description": "Return on equity.", - "default": null, - "optional": true - }, - { - "name": "return_on_capital_employed", - "type": "float", - "description": "Return on capital employed.", - "default": null, - "optional": true - }, - { - "name": "net_income_per_ebt", - "type": "float", - "description": "Net income per EBT.", - "default": null, - "optional": true - }, - { - "name": "ebt_per_ebit", - "type": "float", - "description": "EBT per EBIT.", - "default": null, - "optional": true - }, - { - "name": "ebit_per_revenue", - "type": "float", - "description": "EBIT per revenue.", - "default": null, - "optional": true - }, - { - "name": "debt_ratio", - "type": "float", - "description": "Debt ratio.", - "default": null, - "optional": true - }, - { - "name": "debt_equity_ratio", - "type": "float", - "description": "Debt equity ratio.", - "default": null, - "optional": true - }, - { - "name": "long_term_debt_to_capitalization", - "type": "float", - "description": "Long term debt to capitalization.", - "default": null, - "optional": true - }, - { - "name": "total_debt_to_capitalization", - "type": "float", - "description": "Total debt to capitalization.", - "default": null, - "optional": true - }, - { - "name": "interest_coverage", - "type": "float", - "description": "Interest coverage.", - "default": null, - "optional": true - }, - { - "name": "cash_flow_to_debt_ratio", - "type": "float", - "description": "Cash flow to debt ratio.", - "default": null, - "optional": true - }, - { - "name": "company_equity_multiplier", - "type": "float", - "description": "Company equity multiplier.", - "default": null, - "optional": true - }, - { - "name": "receivables_turnover", - "type": "float", - "description": "Receivables turnover.", - "default": null, - "optional": true - }, - { - "name": "payables_turnover", - "type": "float", - "description": "Payables turnover.", - "default": null, - "optional": true - }, - { - "name": "inventory_turnover", - "type": "float", - "description": "Inventory turnover.", - "default": null, - "optional": true - }, - { - "name": "fixed_asset_turnover", - "type": "float", - "description": "Fixed asset turnover.", - "default": null, - "optional": true - }, - { - "name": "asset_turnover", - "type": "float", - "description": "Asset turnover.", - "default": null, - "optional": true - }, - { - "name": "operating_cash_flow_per_share", - "type": "float", - "description": "Operating cash flow per share.", - "default": null, - "optional": true - }, - { - "name": "free_cash_flow_per_share", - "type": "float", - "description": "Free cash flow per share.", - "default": null, - "optional": true - }, - { - "name": "cash_per_share", - "type": "float", - "description": "Cash per share.", - "default": null, - "optional": true - }, - { - "name": "payout_ratio", - "type": "float", - "description": "Payout ratio.", - "default": null, - "optional": true - }, - { - "name": "operating_cash_flow_sales_ratio", - "type": "float", - "description": "Operating cash flow sales ratio.", - "default": null, - "optional": true - }, - { - "name": "free_cash_flow_operating_cash_flow_ratio", - "type": "float", - "description": "Free cash flow operating cash flow ratio.", - "default": null, - "optional": true - }, - { - "name": "cash_flow_coverage_ratios", - "type": "float", - "description": "Cash flow coverage ratios.", - "default": null, - "optional": true - }, - { - "name": "short_term_coverage_ratios", - "type": "float", - "description": "Short term coverage ratios.", - "default": null, - "optional": true - }, - { - "name": "capital_expenditure_coverage_ratio", - "type": "float", - "description": "Capital expenditure coverage ratio.", - "default": null, - "optional": true - }, - { - "name": "dividend_paid_and_capex_coverage_ratio", - "type": "float", - "description": "Dividend paid and capex coverage ratio.", - "default": null, - "optional": true - }, - { - "name": "dividend_payout_ratio", - "type": "float", - "description": "Dividend payout ratio.", - "default": null, - "optional": true - }, - { - "name": "price_book_value_ratio", - "type": "float", - "description": "Price book value ratio.", - "default": null, - "optional": true - }, - { - "name": "price_to_book_ratio", - "type": "float", - "description": "Price to book ratio.", - "default": null, - "optional": true - }, - { - "name": "price_to_sales_ratio", - "type": "float", - "description": "Price to sales ratio.", - "default": null, - "optional": true - }, - { - "name": "price_earnings_ratio", - "type": "float", - "description": "Price earnings ratio.", - "default": null, - "optional": true - }, - { - "name": "price_to_free_cash_flows_ratio", - "type": "float", - "description": "Price to free cash flows ratio.", - "default": null, - "optional": true - }, - { - "name": "price_to_operating_cash_flows_ratio", - "type": "float", - "description": "Price to operating cash flows ratio.", - "default": null, - "optional": true - }, - { - "name": "price_cash_flow_ratio", - "type": "float", - "description": "Price cash flow ratio.", - "default": null, - "optional": true - }, - { - "name": "price_earnings_to_growth_ratio", - "type": "float", - "description": "Price earnings to growth ratio.", - "default": null, - "optional": true - }, - { - "name": "price_sales_ratio", - "type": "float", - "description": "Price sales ratio.", - "default": null, - "optional": true - }, - { - "name": "dividend_yield", - "type": "float", - "description": "Dividend yield.", - "default": null, - "optional": true - }, - { - "name": "dividend_yield_percentage", - "type": "float", - "description": "Dividend yield percentage.", - "default": null, - "optional": true - }, - { - "name": "dividend_per_share", - "type": "float", - "description": "Dividend per share.", - "default": null, - "optional": true - }, - { - "name": "enterprise_value_multiple", - "type": "float", - "description": "Enterprise value multiple.", - "default": null, - "optional": true - }, - { - "name": "price_fair_value", - "type": "float", - "description": "Price fair value.", - "default": null, - "optional": true - } - ], - "intrinio": [] - }, - "model": "FinancialRatios" - }, - "/equity/fundamental/revenue_per_geography": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the revenue geographic breakdown for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.revenue_per_geography(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.revenue_per_geography(symbol='AAPL', period='annual', structure='flat', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "period", - "type": "Literal['quarter', 'annual']", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - }, - { - "name": "structure", - "type": "Literal['hierarchical', 'flat']", - "description": "Structure of the returned data.", - "default": "flat", - "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[RevenueGeographic]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "period_ending", - "type": "date", - "description": "The end date of the reporting period.", - "default": "", - "optional": false - }, - { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the reporting period.", - "default": null, - "optional": true - }, - { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the reporting period.", - "default": null, - "optional": true - }, - { - "name": "filing_date", - "type": "date", - "description": "The filing date of the report.", - "default": null, - "optional": true - }, - { - "name": "geographic_segment", - "type": "int", - "description": "Dictionary of the revenue by geographic segment.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "RevenueGeographic" - }, - "/equity/fundamental/revenue_per_segment": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the revenue breakdown by business segment for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.revenue_per_segment(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.revenue_per_segment(symbol='AAPL', period='annual', structure='flat', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "period", - "type": "Literal['quarter', 'annual']", - "description": "Time period of the data to return.", - "default": "annual", - "optional": true - }, - { - "name": "structure", - "type": "Literal['hierarchical', 'flat']", - "description": "Structure of the returned data.", - "default": "flat", - "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[RevenueBusinessLine]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "period_ending", - "type": "date", - "description": "The end date of the reporting period.", - "default": "", - "optional": false - }, - { - "name": "fiscal_period", - "type": "str", - "description": "The fiscal period of the reporting period.", - "default": null, - "optional": true - }, - { - "name": "fiscal_year", - "type": "int", - "description": "The fiscal year of the reporting period.", - "default": null, - "optional": true - }, - { - "name": "filing_date", - "type": "date", - "description": "The filing date of the report.", - "default": null, - "optional": true - }, - { - "name": "business_line", - "type": "int", - "description": "Dictionary containing the revenue of the business line.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "RevenueBusinessLine" - }, - "/equity/fundamental/filings": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more. SEC\nfilings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114,\nForeign Investment Disclosures and others. The annual 10-K report is required to be\nfiled annually and includes the company's financial statements, management discussion and analysis,\nand audited financial statements.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.filings(provider='fmp')\nobb.equity.fundamental.filings(limit=100, provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": null, - "optional": true - }, - { - "name": "form_type", - "type": "str", - "description": "Filter by form type. Check the data provider for available types.", - "default": null, - "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 100, - "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'sec', 'tmx']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [], - "intrinio": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "thea_enabled", - "type": "bool", - "description": "Return filings that have been read by Intrinio's Thea NLP.", - "default": null, - "optional": true - } - ], - "sec": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": null, - "optional": true - }, - { - "name": "form_type", - "type": "Literal['1', '1-A', '1-A POS', '1-A-W', '1-E', '1-E AD', '1-K', '1-SA', '1-U', '1-Z', '1-Z-W', '10-12B', '10-12G', '10-D', '10-K', '10-KT', '10-Q', '10-QT', '11-K', '11-KT', '13F-HR', '13F-NT', '13FCONP', '144', '15-12B', '15-12G', '15-15D', '15F-12B', '15F-12G', '15F-15D', '18-12B', '18-K', '19B-4E', '2-A', '2-AF', '2-E', '20-F', '20FR12B', '20FR12G', '24F-2NT', '25', '25-NSE', '253G1', '253G2', '253G3', '253G4', '3', '305B2', '34-12H', '4', '40-17F1', '40-17F2', '40-17G', '40-17GCS', '40-202A', '40-203A', '40-206A', '40-24B2', '40-33', '40-6B', '40-8B25', '40-8F-2', '40-APP', '40-F', '40-OIP', '40FR12B', '40FR12G', '424A', '424B1', '424B2', '424B3', '424B4', '424B5', '424B7', '424B8', '424H', '425', '485APOS', '485BPOS', '485BXT', '486APOS', '486BPOS', '486BXT', '487', '497', '497AD', '497H2', '497J', '497K', '497VPI', '497VPU', '5', '6-K', '6B NTC', '6B ORDR', '8-A12B', '8-A12G', '8-K', '8-K12B', '8-K12G3', '8-K15D5', '8-M', '8F-2 NTC', '8F-2 ORDR', '9-M', 'ABS-15G', 'ABS-EE', 'ADN-MTL', 'ADV-E', 'ADV-H-C', 'ADV-H-T', 'ADV-NR', 'ANNLRPT', 'APP NTC', 'APP ORDR', 'APP WD', 'APP WDG', 'ARS', 'ATS-N', 'ATS-N-C', 'ATS-N/UA', 'AW', 'AW WD', 'C', 'C-AR', 'C-AR-W', 'C-TR', 'C-TR-W', 'C-U', 'C-U-W', 'C-W', 'CB', 'CERT', 'CERTARCA', 'CERTBATS', 'CERTCBO', 'CERTNAS', 'CERTNYS', 'CERTPAC', 'CFPORTAL', 'CFPORTAL-W', 'CORRESP', 'CT ORDER', 'D', 'DEF 14A', 'DEF 14C', 'DEFA14A', 'DEFA14C', 'DEFC14A', 'DEFC14C', 'DEFM14A', 'DEFM14C', 'DEFN14A', 'DEFR14A', 'DEFR14C', 'DEL AM', 'DFAN14A', 'DFRN14A', 'DOS', 'DOSLTR', 'DRS', 'DRSLTR', 'DSTRBRPT', 'EFFECT', 'F-1', 'F-10', 'F-10EF', 'F-10POS', 'F-1MEF', 'F-3', 'F-3ASR', 'F-3D', 'F-3DPOS', 'F-3MEF', 'F-4', 'F-4 POS', 'F-4MEF', 'F-6', 'F-6 POS', 'F-6EF', 'F-7', 'F-7 POS', 'F-8', 'F-8 POS', 'F-80', 'F-80POS', 'F-9', 'F-9 POS', 'F-N', 'F-X', 'FOCUSN', 'FWP', 'G-405', 'G-405N', 'G-FIN', 'G-FINW', 'IRANNOTICE', 'MA', 'MA-A', 'MA-I', 'MA-W', 'MSD', 'MSDCO', 'MSDW', 'N-1', 'N-14', 'N-14 8C', 'N-14MEF', 'N-18F1', 'N-1A', 'N-2', 'N-2 POSASR', 'N-23C-2', 'N-23C3A', 'N-23C3B', 'N-23C3C', 'N-2ASR', 'N-2MEF', 'N-30B-2', 'N-30D', 'N-4', 'N-5', 'N-54A', 'N-54C', 'N-6', 'N-6F', 'N-8A', 'N-8B-2', 'N-8F', 'N-8F NTC', 'N-8F ORDR', 'N-CEN', 'N-CR', 'N-CSR', 'N-CSRS', 'N-MFP', 'N-MFP1', 'N-MFP2', 'N-PX', 'N-Q', 'N-VP', 'N-VPFS', 'NO ACT', 'NPORT-EX', 'NPORT-NP', 'NPORT-P', 'NRSRO-CE', 'NRSRO-UPD', 'NSAR-A', 'NSAR-AT', 'NSAR-B', 'NSAR-BT', 'NSAR-U', 'NT 10-D', 'NT 10-K', 'NT 10-Q', 'NT 11-K', 'NT 20-F', 'NT N-CEN', 'NT N-MFP', 'NT N-MFP1', 'NT N-MFP2', 'NT NPORT-EX', 'NT NPORT-P', 'NT-NCEN', 'NT-NCSR', 'NT-NSAR', 'NTFNCEN', 'NTFNCSR', 'NTFNSAR', 'NTN 10D', 'NTN 10K', 'NTN 10Q', 'NTN 20F', 'OIP NTC', 'OIP ORDR', 'POS 8C', 'POS AM', 'POS AMI', 'POS EX', 'POS462B', 'POS462C', 'POSASR', 'PRE 14A', 'PRE 14C', 'PREC14A', 'PREC14C', 'PREM14A', 'PREM14C', 'PREN14A', 'PRER14A', 'PRER14C', 'PRRN14A', 'PX14A6G', 'PX14A6N', 'QRTLYRPT', 'QUALIF', 'REG-NR', 'REVOKED', 'RW', 'RW WD', 'S-1', 'S-11', 'S-11MEF', 'S-1MEF', 'S-20', 'S-3', 'S-3ASR', 'S-3D', 'S-3DPOS', 'S-3MEF', 'S-4', 'S-4 POS', 'S-4EF', 'S-4MEF', 'S-6', 'S-8', 'S-8 POS', 'S-B', 'S-BMEF', 'SBSE', 'SBSE-A', 'SBSE-BD', 'SBSE-C', 'SBSE-W', 'SC 13D', 'SC 13E1', 'SC 13E3', 'SC 13G', 'SC 14D9', 'SC 14F1', 'SC 14N', 'SC TO-C', 'SC TO-I', 'SC TO-T', 'SC13E4F', 'SC14D1F', 'SC14D9C', 'SC14D9F', 'SD', 'SDR', 'SE', 'SEC ACTION', 'SEC STAFF ACTION', 'SEC STAFF LETTER', 'SF-1', 'SF-3', 'SL', 'SP 15D2', 'STOP ORDER', 'SUPPL', 'T-3', 'TA-1', 'TA-2', 'TA-W', 'TACO', 'TH', 'TTW', 'UNDER', 'UPLOAD', 'WDL-REQ', 'X-17A-5']", - "description": "Type of the SEC filing form.", - "default": null, - "optional": true - }, - { - "name": "cik", - "type": "Union[int, str]", - "description": "Lookup filings by Central Index Key (CIK) instead of by symbol.", - "default": null, - "optional": true - }, - { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache. If True, cache will store for one day.", - "default": true, - "optional": true - } - ], - "tmx": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "The start date to fetch.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "The end date to fetch.", - "default": null, - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[CompanyFilings]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'sec', 'tmx']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "filing_date", - "type": "date", - "description": "The date of the filing.", - "default": "", - "optional": false - }, - { - "name": "accepted_date", - "type": "datetime", - "description": "Accepted date of the filing.", - "default": null, - "optional": true - }, - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": null, - "optional": true - }, - { - "name": "cik", - "type": "str", - "description": "Central Index Key (CIK) for the requested entity.", - "default": null, - "optional": true - }, - { - "name": "report_type", - "type": "str", - "description": "Type of filing.", - "default": null, - "optional": true - }, - { - "name": "filing_url", - "type": "str", - "description": "URL to the filing page.", - "default": null, - "optional": true - }, - { - "name": "report_url", - "type": "str", - "description": "URL to the actual report.", - "default": "", - "optional": false - } - ], - "fmp": [], - "intrinio": [ - { - "name": "id", - "type": "str", - "description": "Intrinio ID of the filing.", - "default": "", - "optional": false - }, - { - "name": "period_end_date", - "type": "date", - "description": "Ending date of the fiscal period for the filing.", - "default": null, - "optional": true - }, - { - "name": "sec_unique_id", - "type": "str", - "description": "SEC unique ID of the filing.", - "default": "", - "optional": false - }, - { - "name": "instance_url", - "type": "str", - "description": "URL for the XBRL filing for the report.", - "default": null, - "optional": true - }, - { - "name": "industry_group", - "type": "str", - "description": "Industry group of the company.", - "default": "", - "optional": false - }, - { - "name": "industry_category", - "type": "str", - "description": "Industry category of the company.", - "default": "", - "optional": false - } - ], - "sec": [ - { - "name": "report_date", - "type": "date", - "description": "The date of the filing.", - "default": null, - "optional": true - }, - { - "name": "act", - "type": "Union[int, str]", - "description": "The SEC Act number.", - "default": null, - "optional": true - }, - { - "name": "items", - "type": "Union[str, float]", - "description": "The SEC Item numbers.", - "default": null, - "optional": true - }, - { - "name": "primary_doc_description", - "type": "str", - "description": "The description of the primary document.", - "default": null, - "optional": true - }, - { - "name": "primary_doc", - "type": "str", - "description": "The filename of the primary document.", - "default": null, - "optional": true - }, - { - "name": "accession_number", - "type": "Union[int, str]", - "description": "The accession number.", - "default": null, - "optional": true - }, - { - "name": "file_number", - "type": "Union[int, str]", - "description": "The file number.", - "default": null, - "optional": true - }, - { - "name": "film_number", - "type": "Union[int, str]", - "description": "The film number.", - "default": null, - "optional": true - }, - { - "name": "is_inline_xbrl", - "type": "Union[int, str]", - "description": "Whether the filing is an inline XBRL filing.", - "default": null, - "optional": true - }, - { - "name": "is_xbrl", - "type": "Union[int, str]", - "description": "Whether the filing is an XBRL filing.", - "default": null, - "optional": true - }, - { - "name": "size", - "type": "Union[int, str]", - "description": "The size of the filing.", - "default": null, - "optional": true - }, - { - "name": "complete_submission_url", - "type": "str", - "description": "The URL to the complete filing submission.", - "default": null, - "optional": true - }, - { - "name": "filing_detail_url", - "type": "str", - "description": "The URL to the filing details.", - "default": null, - "optional": true - } - ], - "tmx": [ - { - "name": "description", - "type": "str", - "description": "The description of the filing.", - "default": "", - "optional": false - }, - { - "name": "size", - "type": "str", - "description": "The file size of the PDF document.", - "default": "", - "optional": 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 - }, - { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[HistoricalSplits]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "numerator", - "type": "float", - "description": "Numerator of the split.", - "default": null, - "optional": true - }, - { - "name": "denominator", - "type": "float", - "description": "Denominator of the split.", - "default": null, - "optional": true - }, - { - "name": "split_ratio", - "type": "str", - "description": "Split ratio.", - "default": null, - "optional": true - } - ], - "fmp": [] - }, - "model": "HistoricalSplits" - }, - "/equity/fundamental/transcript": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get earnings call transcripts for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.transcript(symbol='AAPL', year=2020, provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "year", - "type": "int", - "description": "Year of the earnings call transcript.", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EarningsCallTranscript]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "quarter", - "type": "int", - "description": "Quarter of the earnings call transcript.", - "default": "", - "optional": false - }, - { - "name": "year", - "type": "int", - "description": "Year of the earnings call transcript.", - "default": "", - "optional": false - }, - { - "name": "date", - "type": "datetime", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "content", - "type": "str", - "description": "Content of the earnings call transcript.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "EarningsCallTranscript" - }, - "/equity/fundamental/trailing_dividend_yield": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the 1 year trailing dividend yield for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.trailing_dividend_yield(symbol='AAPL', provider='tiingo')\nobb.equity.fundamental.trailing_dividend_yield(symbol='AAPL', limit=252, provider='tiingo')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. Default is 252, the number of trading days in a year.", - "default": 252, - "optional": true - }, - { - "name": "provider", - "type": "Literal['tiingo']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tiingo' if there is no default.", - "default": "tiingo", - "optional": true - } - ], - "tiingo": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[TrailingDividendYield]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['tiingo']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "trailing_dividend_yield", - "type": "float", - "description": "Trailing dividend yield.", - "default": "", - "optional": false - } - ], - "tiingo": [] - }, - "model": "TrailingDividendYield" - }, - "/equity/ownership/major_holders": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get data about major holders for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.major_holders(symbol='AAPL', provider='fmp')\nobb.equity.ownership.major_holders(symbol='AAPL', page=0, provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", - "default": null, - "optional": true - }, - { - "name": "page", - "type": "int", - "description": "Page number of the data to fetch.", - "default": 0, - "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EquityOwnership]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "cik", - "type": "int", - "description": "Central Index Key (CIK) for the requested entity.", - "default": "", - "optional": false - }, - { - "name": "filing_date", - "type": "date", - "description": "Filing date of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "investor_name", - "type": "str", - "description": "Investor name of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "security_name", - "type": "str", - "description": "Security name of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "type_of_security", - "type": "str", - "description": "Type of security of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "security_cusip", - "type": "str", - "description": "Security cusip of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "shares_type", - "type": "str", - "description": "Shares type of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "put_call_share", - "type": "str", - "description": "Put call share of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "investment_discretion", - "type": "str", - "description": "Investment discretion of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "industry_title", - "type": "str", - "description": "Industry title of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "weight", - "type": "float", - "description": "Weight of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "last_weight", - "type": "float", - "description": "Last weight of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "change_in_weight", - "type": "float", - "description": "Change in weight of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "change_in_weight_percentage", - "type": "float", - "description": "Change in weight percentage of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "market_value", - "type": "int", - "description": "Market value of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "last_market_value", - "type": "int", - "description": "Last market value of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "change_in_market_value", - "type": "int", - "description": "Change in market value of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "change_in_market_value_percentage", - "type": "float", - "description": "Change in market value percentage of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "shares_number", - "type": "int", - "description": "Shares number of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "last_shares_number", - "type": "int", - "description": "Last shares number of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "change_in_shares_number", - "type": "float", - "description": "Change in shares number of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "change_in_shares_number_percentage", - "type": "float", - "description": "Change in shares number percentage of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "quarter_end_price", - "type": "float", - "description": "Quarter end price of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "avg_price_paid", - "type": "float", - "description": "Average price paid of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "is_new", - "type": "bool", - "description": "Is the stock ownership new.", - "default": "", - "optional": false - }, - { - "name": "is_sold_out", - "type": "bool", - "description": "Is the stock ownership sold out.", - "default": "", - "optional": false - }, - { - "name": "ownership", - "type": "float", - "description": "How much is the ownership.", - "default": "", - "optional": false - }, - { - "name": "last_ownership", - "type": "float", - "description": "Last ownership amount.", - "default": "", - "optional": false - }, - { - "name": "change_in_ownership", - "type": "float", - "description": "Change in ownership amount.", - "default": "", - "optional": false - }, - { - "name": "change_in_ownership_percentage", - "type": "float", - "description": "Change in ownership percentage.", - "default": "", - "optional": false - }, - { - "name": "holding_period", - "type": "int", - "description": "Holding period of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "first_added", - "type": "date", - "description": "First added date of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "performance", - "type": "float", - "description": "Performance of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "performance_percentage", - "type": "float", - "description": "Performance percentage of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "last_performance", - "type": "float", - "description": "Last performance of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "change_in_performance", - "type": "float", - "description": "Change in performance of the stock ownership.", - "default": "", - "optional": false - }, - { - "name": "is_counted_for_performance", - "type": "bool", - "description": "Is the stock ownership counted for performance.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "EquityOwnership" - }, - "/equity/ownership/institutional": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get data about institutional ownership for a given company over time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.institutional(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "include_current_quarter", - "type": "bool", - "description": "Include current quarter data.", - "default": false, - "optional": true - }, - { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", - "default": null, - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[InstitutionalOwnership]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "cik", - "type": "str", - "description": "Central Index Key (CIK) for the requested entity.", - "default": null, - "optional": true - }, - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - } - ], - "fmp": [ - { - "name": "investors_holding", - "type": "int", - "description": "Number of investors holding the stock.", - "default": "", - "optional": false - }, - { - "name": "last_investors_holding", - "type": "int", - "description": "Number of investors holding the stock in the last quarter.", - "default": "", - "optional": false - }, - { - "name": "investors_holding_change", - "type": "int", - "description": "Change in the number of investors holding the stock.", - "default": "", - "optional": false - }, - { - "name": "number_of_13f_shares", - "type": "int", - "description": "Number of 13F shares.", - "default": null, - "optional": true - }, - { - "name": "last_number_of_13f_shares", - "type": "int", - "description": "Number of 13F shares in the last quarter.", - "default": null, - "optional": true - }, - { - "name": "number_of_13f_shares_change", - "type": "int", - "description": "Change in the number of 13F shares.", - "default": null, - "optional": true - }, - { - "name": "total_invested", - "type": "float", - "description": "Total amount invested.", - "default": "", - "optional": false - }, - { - "name": "last_total_invested", - "type": "float", - "description": "Total amount invested in the last quarter.", - "default": "", - "optional": false - }, - { - "name": "total_invested_change", - "type": "float", - "description": "Change in the total amount invested.", - "default": "", - "optional": false - }, - { - "name": "ownership_percent", - "type": "float", - "description": "Ownership percent.", - "default": "", - "optional": false - }, - { - "name": "last_ownership_percent", - "type": "float", - "description": "Ownership percent in the last quarter.", - "default": "", - "optional": false - }, - { - "name": "ownership_percent_change", - "type": "float", - "description": "Change in the ownership percent.", - "default": "", - "optional": false - }, - { - "name": "new_positions", - "type": "int", - "description": "Number of new positions.", - "default": "", - "optional": false - }, - { - "name": "last_new_positions", - "type": "int", - "description": "Number of new positions in the last quarter.", - "default": "", - "optional": false - }, - { - "name": "new_positions_change", - "type": "int", - "description": "Change in the number of new positions.", - "default": "", - "optional": false - }, - { - "name": "increased_positions", - "type": "int", - "description": "Number of increased positions.", - "default": "", - "optional": false - }, - { - "name": "last_increased_positions", - "type": "int", - "description": "Number of increased positions in the last quarter.", - "default": "", - "optional": false - }, - { - "name": "increased_positions_change", - "type": "int", - "description": "Change in the number of increased positions.", - "default": "", - "optional": false - }, - { - "name": "closed_positions", - "type": "int", - "description": "Number of closed positions.", - "default": "", - "optional": false - }, - { - "name": "last_closed_positions", - "type": "int", - "description": "Number of closed positions in the last quarter.", - "default": "", - "optional": false - }, - { - "name": "closed_positions_change", - "type": "int", - "description": "Change in the number of closed positions.", - "default": "", - "optional": false - }, - { - "name": "reduced_positions", - "type": "int", - "description": "Number of reduced positions.", - "default": "", - "optional": false - }, - { - "name": "last_reduced_positions", - "type": "int", - "description": "Number of reduced positions in the last quarter.", - "default": "", - "optional": false - }, - { - "name": "reduced_positions_change", - "type": "int", - "description": "Change in the number of reduced positions.", - "default": "", - "optional": false - }, - { - "name": "total_calls", - "type": "int", - "description": "Total number of call options contracts traded for Apple Inc. on the specified date.", - "default": "", - "optional": false - }, - { - "name": "last_total_calls", - "type": "int", - "description": "Total number of call options contracts traded for Apple Inc. on the previous reporting date.", - "default": "", - "optional": false - }, - { - "name": "total_calls_change", - "type": "int", - "description": "Change in the total number of call options contracts traded between the current and previous reporting dates.", - "default": "", - "optional": false - }, - { - "name": "total_puts", - "type": "int", - "description": "Total number of put options contracts traded for Apple Inc. on the specified date.", - "default": "", - "optional": false - }, - { - "name": "last_total_puts", - "type": "int", - "description": "Total number of put options contracts traded for Apple Inc. on the previous reporting date.", - "default": "", - "optional": false - }, - { - "name": "total_puts_change", - "type": "int", - "description": "Change in the total number of put options contracts traded between the current and previous reporting dates.", - "default": "", - "optional": false - }, - { - "name": "put_call_ratio", - "type": "float", - "description": "Put-call ratio, which is the ratio of the total number of put options to call options traded on the specified date.", - "default": "", - "optional": false - }, - { - "name": "last_put_call_ratio", - "type": "float", - "description": "Put-call ratio on the previous reporting date.", - "default": "", - "optional": false - }, - { - "name": "put_call_ratio_change", - "type": "float", - "description": "Change in the put-call ratio between the current and previous reporting dates.", - "default": "", - "optional": false - } - ] - }, - "model": "InstitutionalOwnership" - }, - "/equity/ownership/insider_trading": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get data about trading by a company's management team and board of directors.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.insider_trading(symbol='AAPL', provider='fmp')\nobb.equity.ownership.insider_trading(symbol='AAPL', limit=500, provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 500, - "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'tmx']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "transaction_type", - "type": "Literal[None, 'award', 'conversion', 'return', 'expire_short', 'in_kind', 'gift', 'expire_long', 'discretionary', 'other', 'small', 'exempt', 'otm', 'purchase', 'sale', 'tender', 'will', 'itm', 'trust']", - "description": "Type of the transaction.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": "", - "optional": false - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": "", - "optional": false - }, - { - "name": "ownership_type", - "type": "Literal['D', 'I']", - "description": "Type of ownership.", - "default": null, - "optional": true - }, - { - "name": "sort_by", - "type": "Literal['filing_date', 'updated_on']", - "description": "Field to sort by.", - "default": "updated_on", - "optional": true - } - ], - "tmx": [ - { - "name": "summary", - "type": "bool", - "description": "Return a summary of the insider activity instead of the individuals.", - "default": false, - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[InsiderTrading]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'tmx']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": null, - "optional": true - }, - { - "name": "company_cik", - "type": "Union[int, str]", - "description": "CIK number of the company.", - "default": null, - "optional": true - }, - { - "name": "filing_date", - "type": "Union[date, datetime]", - "description": "Filing date of the trade.", - "default": null, - "optional": true - }, - { - "name": "transaction_date", - "type": "date", - "description": "Date of the transaction.", - "default": null, - "optional": true - }, - { - "name": "owner_cik", - "type": "Union[int, str]", - "description": "Reporting individual's CIK.", - "default": null, - "optional": true - }, - { - "name": "owner_name", - "type": "str", - "description": "Name of the reporting individual.", - "default": null, - "optional": true - }, - { - "name": "owner_title", - "type": "str", - "description": "The title held by the reporting individual.", - "default": null, - "optional": true - }, - { - "name": "transaction_type", - "type": "str", - "description": "Type of transaction being reported.", - "default": null, - "optional": true - }, - { - "name": "acquisition_or_disposition", - "type": "str", - "description": "Acquisition or disposition of the shares.", - "default": null, - "optional": true - }, - { - "name": "security_type", - "type": "str", - "description": "The type of security transacted.", - "default": null, - "optional": true - }, - { - "name": "securities_owned", - "type": "float", - "description": "Number of securities owned by the reporting individual.", - "default": null, - "optional": true - }, - { - "name": "securities_transacted", - "type": "float", - "description": "Number of securities transacted by the reporting individual.", - "default": null, - "optional": true - }, - { - "name": "transaction_price", - "type": "float", - "description": "The price of the transaction.", - "default": null, - "optional": true - }, - { - "name": "filing_url", - "type": "str", - "description": "Link to the filing.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "form_type", - "type": "str", - "description": "Form type of the insider trading.", - "default": "", - "optional": false - } - ], - "intrinio": [ - { - "name": "filing_url", - "type": "str", - "description": "URL of the filing.", - "default": null, - "optional": true - }, - { - "name": "company_name", - "type": "str", - "description": "Name of the company.", - "default": "", - "optional": false - }, - { - "name": "conversion_exercise_price", - "type": "float", - "description": "Conversion/Exercise price of the shares.", - "default": null, - "optional": true - }, - { - "name": "deemed_execution_date", - "type": "date", - "description": "Deemed execution date of the trade.", - "default": null, - "optional": true - }, - { - "name": "exercise_date", - "type": "date", - "description": "Exercise date of the trade.", - "default": null, - "optional": true - }, - { - "name": "expiration_date", - "type": "date", - "description": "Expiration date of the derivative.", - "default": null, - "optional": true - }, - { - "name": "underlying_security_title", - "type": "str", - "description": "Name of the underlying non-derivative security related to this derivative transaction.", - "default": null, - "optional": true - }, - { - "name": "underlying_shares", - "type": "Union[int, float]", - "description": "Number of underlying shares related to this derivative transaction.", - "default": null, - "optional": true - }, - { - "name": "nature_of_ownership", - "type": "str", - "description": "Nature of ownership of the insider trading.", - "default": null, - "optional": true - }, - { - "name": "director", - "type": "bool", - "description": "Whether the owner is a director.", - "default": null, - "optional": true - }, - { - "name": "officer", - "type": "bool", - "description": "Whether the owner is an officer.", - "default": null, - "optional": true - }, - { - "name": "ten_percent_owner", - "type": "bool", - "description": "Whether the owner is a 10% owner.", - "default": null, - "optional": true - }, - { - "name": "other_relation", - "type": "bool", - "description": "Whether the owner is having another relation.", - "default": null, - "optional": true - }, - { - "name": "derivative_transaction", - "type": "bool", - "description": "Whether the owner is having a derivative transaction.", - "default": null, - "optional": true - }, - { - "name": "report_line_number", - "type": "int", - "description": "Report line number of the insider trading.", - "default": null, - "optional": true - } - ], - "tmx": [ - { - "name": "owner_name", - "type": "str", - "description": "The name of the insider.", - "default": null, - "optional": true - }, - { - "name": "securities_owned", - "type": "int", - "description": "The number of shares held by the insider.", - "default": null, - "optional": true - }, - { - "name": "securities_transacted", - "type": "int", - "description": "The total number of shares traded by the insider over the period.", - "default": null, - "optional": true - }, - { - "name": "period", - "type": "str", - "description": "The period of the activity. Bucketed by three, six, and twelve months.", - "default": "", - "optional": false - }, - { - "name": "acquisition_or_deposition", - "type": "str", - "description": "Whether the insider bought or sold the shares.", - "default": null, - "optional": true - }, - { - "name": "number_of_trades", - "type": "int", - "description": "The number of shares traded over the period.", - "default": null, - "optional": true - }, - { - "name": "trade_value", - "type": "float", - "description": "The value of the shares traded by the insider.", - "default": null, - "optional": true - }, - { - "name": "securities_bought", - "type": "int", - "description": "The total number of shares bought by all insiders over the period.", - "default": null, - "optional": true - }, - { - "name": "securities_sold", - "type": "int", - "description": "The total number of shares sold by all insiders over the period.", - "default": null, - "optional": true - }, - { - "name": "net_activity", - "type": "int", - "description": "The total net activity by all insiders over the period.", - "default": null, - "optional": true - } - ] - }, - "model": "InsiderTrading" - }, - "/equity/ownership/share_statistics": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get data about share float for a given company.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.share_statistics(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [], - "intrinio": [], - "yfinance": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[ShareStatistics]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": null, - "optional": true - }, - { - "name": "free_float", - "type": "float", - "description": "Percentage of unrestricted shares of a publicly-traded company.", - "default": null, - "optional": true - }, - { - "name": "float_shares", - "type": "float", - "description": "Number of shares available for trading by the general public.", - "default": null, - "optional": true - }, - { - "name": "outstanding_shares", - "type": "float", - "description": "Total number of shares of a publicly-traded company.", - "default": null, - "optional": true - }, - { - "name": "source", - "type": "str", - "description": "Source of the received data.", - "default": null, - "optional": true - } - ], - "fmp": [], - "intrinio": [ - { - "name": "adjusted_outstanding_shares", - "type": "float", - "description": "Total number of shares of a publicly-traded company, adjusted for splits.", - "default": null, - "optional": true - }, - { - "name": "public_float", - "type": "float", - "description": "Aggregate market value of the shares of a publicly-traded company.", - "default": null, - "optional": true - } - ], - "yfinance": [ - { - "name": "implied_shares_outstanding", - "type": "int", - "description": "Implied Shares Outstanding of common equity, assuming the conversion of all convertible subsidiary equity into common.", - "default": null, - "optional": true - }, - { - "name": "short_interest", - "type": "int", - "description": "Number of shares that are reported short.", - "default": null, - "optional": true - }, - { - "name": "short_percent_of_float", - "type": "float", - "description": "Percentage of shares that are reported short, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "days_to_cover", - "type": "float", - "description": "Number of days to repurchase the shares as a ratio of average daily volume", - "default": null, - "optional": true - }, - { - "name": "short_interest_prev_month", - "type": "int", - "description": "Number of shares that were reported short in the previous month.", - "default": null, - "optional": true - }, - { - "name": "short_interest_prev_date", - "type": "date", - "description": "Date of the previous month's report.", - "default": null, - "optional": true - }, - { - "name": "insider_ownership", - "type": "float", - "description": "Percentage of shares held by insiders, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "institution_ownership", - "type": "float", - "description": "Percentage of shares held by institutions, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "institution_float_ownership", - "type": "float", - "description": "Percentage of float held by institutions, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "institutions_count", - "type": "int", - "description": "Number of institutions holding shares.", - "default": null, - "optional": true - } - ] - }, - "model": "ShareStatistics" - }, - "/equity/ownership/form_13f": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the form 13F.\n\nThe Securities and Exchange Commission's (SEC) Form 13F is a quarterly report\nthat is required to be filed by all institutional investment managers with at least\n$100 million in assets under management.\nManagers are required to file Form 13F within 45 days after the last day of the calendar quarter.\nMost funds wait until the end of this period in order to conceal\ntheir investment strategy from competitors and the public.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.form_13f(symbol='NVDA', provider='sec')\n# Enter a date (calendar quarter ending) for a specific report.\nobb.equity.ownership.form_13f(symbol='BRK-A', date='2016-09-30', provider='sec')\n# Example finding Michael Burry's filings.\ncik = obb.regulators.sec.institutions_search(\"Scion Asset Management\").results[0].cik\n# Use the `limit` parameter to return N number of reports from the most recent.\nobb.equity.ownership.form_13f(cik, limit=2).to_df()\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for. A CIK or Symbol can be used.", - "default": "", - "optional": false - }, - { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported.", - "default": null, - "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter.", - "default": 1, - "optional": true - }, - { - "name": "provider", - "type": "Literal['sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", - "default": "sec", - "optional": true - } - ], - "sec": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[Form13FHR]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['sec']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "period_ending", - "type": "date", - "description": "The end-of-quarter date of the filing.", - "default": "", - "optional": false - }, - { - "name": "issuer", - "type": "str", - "description": "The name of the issuer.", - "default": "", - "optional": false - }, - { - "name": "cusip", - "type": "str", - "description": "The CUSIP of the security.", - "default": "", - "optional": false - }, - { - "name": "asset_class", - "type": "str", - "description": "The title of the asset class for the security.", - "default": "", - "optional": false - }, - { - "name": "security_type", - "type": "Literal['SH', 'PRN']", - "description": "The total number of shares of the class of security or the principal amount of such class. 'SH' for shares. 'PRN' for principal amount. Convertible debt securities are reported as 'PRN'.", - "default": null, - "optional": true - }, - { - "name": "option_type", - "type": "Literal['call', 'put']", - "description": "Defined when the holdings being reported are put or call options. Only long positions are reported.", - "default": null, - "optional": true - }, - { - "name": "voting_authority_sole", - "type": "int", - "description": "The number of shares for which the Manager exercises sole voting authority (none).", - "default": null, - "optional": true - }, - { - "name": "voting_authority_shared", - "type": "int", - "description": "The number of shares for which the Manager exercises a defined shared voting authority (none).", - "default": null, - "optional": true - }, - { - "name": "voting_authority_other", - "type": "int", - "description": "The number of shares for which the Manager exercises other shared voting authority (none).", - "default": null, - "optional": true - }, - { - "name": "principal_amount", - "type": "int", - "description": "The total number of shares of the class of security or the principal amount of such class. Only long positions are reported", - "default": "", - "optional": false - }, - { - "name": "value", - "type": "int", - "description": "The fair market value of the holding of the particular class of security. The value reported for options is the fair market value of the underlying security with respect to the number of shares controlled. Values are rounded to the nearest US dollar and use the closing price of the last trading day of the calendar year or quarter.", - "default": "", - "optional": false - } - ], - "sec": [ - { - "name": "weight", - "type": "float", - "description": "The weight of the security relative to the market value of all securities in the filing , as a normalized percent.", - "default": "", - "optional": false - } - ] - }, - "model": "Form13FHR" - }, - "/equity/price/quote": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the latest quote for a given stock. Quote includes price, volume, and other data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.quote(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, tmx, tradier, yfinance.", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['cboe', 'fmp', 'intrinio', 'tmx', 'tradier', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.", - "default": "cboe", - "optional": true - } - ], - "cboe": [ - { - "name": "use_cache", - "type": "bool", - "description": "When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass.", - "default": true, - "optional": true - } - ], - "fmp": [], - "intrinio": [ - { - "name": "symbol", - "type": "str", - "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", - "default": "", - "optional": false - }, - { - "name": "source", - "type": "Literal['iex', 'bats', 'bats_delayed', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed', 'intrinio_mx', 'intrinio_mx_plus', 'delayed_sip']", - "description": "Source of the data.", - "default": "iex", - "optional": true - } - ], - "tmx": [], - "tradier": [], - "yfinance": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EquityQuote]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['cboe', 'fmp', 'intrinio', 'tmx', 'tradier', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false - }, - { - "name": "asset_type", - "type": "str", - "description": "Type of asset - i.e, stock, ETF, etc.", - "default": null, - "optional": true - }, - { - "name": "name", - "type": "str", - "description": "Name of the company or asset.", - "default": null, - "optional": true - }, - { - "name": "exchange", - "type": "str", - "description": "The name or symbol of the venue where the data is from.", - "default": null, - "optional": true - }, - { - "name": "bid", - "type": "float", - "description": "Price of the top bid order.", - "default": null, - "optional": true - }, - { - "name": "bid_size", - "type": "int", - "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", - "default": null, - "optional": true - }, - { - "name": "bid_exchange", - "type": "str", - "description": "The specific trading venue where the purchase order was placed.", - "default": null, - "optional": true - }, - { - "name": "ask", - "type": "float", - "description": "Price of the top ask order.", - "default": null, - "optional": true - }, - { - "name": "ask_size", - "type": "int", - "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", - "default": null, - "optional": true - }, - { - "name": "ask_exchange", - "type": "str", - "description": "The specific trading venue where the sale order was placed.", - "default": null, - "optional": true - }, - { - "name": "quote_conditions", - "type": "Union[str, int, List[str], List[int]]", - "description": "Conditions or condition codes applicable to the quote.", - "default": null, - "optional": true - }, - { - "name": "quote_indicators", - "type": "Union[str, int, List[str], List[int]]", - "description": "Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO.", - "default": null, - "optional": true - }, - { - "name": "sales_conditions", - "type": "Union[str, int, List[str], List[int]]", - "description": "Conditions or condition codes applicable to the sale.", - "default": null, - "optional": true - }, - { - "name": "sequence_number", - "type": "int", - "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11).", - "default": null, - "optional": true - }, - { - "name": "market_center", - "type": "str", - "description": "The ID of the UTP participant that originated the message.", - "default": null, - "optional": true - }, - { - "name": "participant_timestamp", - "type": "datetime", - "description": "Timestamp for when the quote was generated by the exchange.", - "default": null, - "optional": true - }, - { - "name": "trf_timestamp", - "type": "datetime", - "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message.", - "default": null, - "optional": true - }, - { - "name": "sip_timestamp", - "type": "datetime", - "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange.", - "default": null, - "optional": true - }, - { - "name": "last_price", - "type": "float", - "description": "Price of the last trade.", - "default": null, - "optional": true - }, - { - "name": "last_tick", - "type": "str", - "description": "Whether the last sale was an up or down tick.", - "default": null, - "optional": true - }, - { - "name": "last_size", - "type": "int", - "description": "Size of the last trade.", - "default": null, - "optional": true - }, - { - "name": "last_timestamp", - "type": "datetime", - "description": "Date and Time when the last price was recorded.", - "default": null, - "optional": true - }, - { - "name": "open", - "type": "float", - "description": "The open price.", - "default": null, - "optional": true - }, - { - "name": "high", - "type": "float", - "description": "The high price.", - "default": null, - "optional": true - }, - { - "name": "low", - "type": "float", - "description": "The low price.", - "default": null, - "optional": true - }, - { - "name": "close", - "type": "float", - "description": "The close price.", - "default": null, - "optional": true - }, - { - "name": "volume", - "type": "Union[int, float]", - "description": "The trading volume.", - "default": null, - "optional": true - }, - { - "name": "exchange_volume", - "type": "Union[int, float]", - "description": "Volume of shares exchanged during the trading day on the specific exchange.", - "default": null, - "optional": true - }, - { - "name": "prev_close", - "type": "float", - "description": "The previous close price.", - "default": null, - "optional": true - }, - { - "name": "change", - "type": "float", - "description": "Change in price from previous close.", - "default": null, - "optional": true - }, - { - "name": "change_percent", - "type": "float", - "description": "Change in price as a normalized percentage.", - "default": null, - "optional": true - }, - { - "name": "year_high", - "type": "float", - "description": "The one year high (52W High).", - "default": null, - "optional": true - }, - { - "name": "year_low", - "type": "float", - "description": "The one year low (52W Low).", - "default": null, - "optional": true - } - ], - "cboe": [ - { - "name": "iv30", - "type": "float", - "description": "The 30-day implied volatility of the stock.", - "default": null, - "optional": true - }, - { - "name": "iv30_change", - "type": "float", - "description": "Change in 30-day implied volatility of the stock.", - "default": null, - "optional": true - }, - { - "name": "iv30_change_percent", - "type": "float", - "description": "Change in 30-day implied volatility of the stock as a normalized percentage value.", - "default": null, - "optional": true - }, - { - "name": "iv30_annual_high", - "type": "float", - "description": "The 1-year high of 30-day implied volatility.", - "default": null, - "optional": true - }, - { - "name": "hv30_annual_high", - "type": "float", - "description": "The 1-year high of 30-day realized volatility.", - "default": null, - "optional": true - }, - { - "name": "iv30_annual_low", - "type": "float", - "description": "The 1-year low of 30-day implied volatility.", - "default": null, - "optional": true - }, - { - "name": "hv30_annual_low", - "type": "float", - "description": "The 1-year low of 30-dayrealized volatility.", - "default": null, - "optional": true - }, - { - "name": "iv60_annual_high", - "type": "float", - "description": "The 1-year high of 60-day implied volatility.", - "default": null, - "optional": true - }, - { - "name": "hv60_annual_high", - "type": "float", - "description": "The 1-year high of 60-day realized volatility.", - "default": null, - "optional": true - }, - { - "name": "iv60_annual_low", - "type": "float", - "description": "The 1-year low of 60-day implied volatility.", - "default": null, - "optional": true - }, - { - "name": "hv60_annual_low", - "type": "float", - "description": "The 1-year low of 60-day realized volatility.", - "default": null, - "optional": true - }, - { - "name": "iv90_annual_high", - "type": "float", - "description": "The 1-year high of 90-day implied volatility.", - "default": null, - "optional": true - }, - { - "name": "hv90_annual_high", - "type": "float", - "description": "The 1-year high of 90-day realized volatility.", - "default": null, - "optional": true - }, - { - "name": "iv90_annual_low", - "type": "float", - "description": "The 1-year low of 90-day implied volatility.", - "default": null, - "optional": true - }, - { - "name": "hv90_annual_low", - "type": "float", - "description": "The 1-year low of 90-day realized volatility.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "price_avg50", - "type": "float", - "description": "50 day moving average price.", - "default": null, - "optional": true - }, - { - "name": "price_avg200", - "type": "float", - "description": "200 day moving average price.", - "default": null, - "optional": true - }, - { - "name": "avg_volume", - "type": "int", - "description": "Average volume over the last 10 trading days.", - "default": null, - "optional": true - }, - { - "name": "market_cap", - "type": "float", - "description": "Market cap of the company.", - "default": null, - "optional": true - }, - { - "name": "shares_outstanding", - "type": "int", - "description": "Number of shares outstanding.", - "default": null, - "optional": true - }, - { - "name": "eps", - "type": "float", - "description": "Earnings per share.", - "default": null, - "optional": true - }, - { - "name": "pe", - "type": "float", - "description": "Price earnings ratio.", - "default": null, - "optional": true - }, - { - "name": "earnings_announcement", - "type": "datetime", - "description": "Upcoming earnings announcement date.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "is_darkpool", - "type": "bool", - "description": "Whether or not the current trade is from a darkpool.", - "default": null, - "optional": true - }, - { - "name": "source", - "type": "str", - "description": "Source of the Intrinio data.", - "default": null, - "optional": true - }, - { - "name": "updated_on", - "type": "datetime", - "description": "Date and Time when the data was last updated.", - "default": "", - "optional": false - }, - { - "name": "security", - "type": "IntrinioSecurity", - "description": "Security details related to the quote.", - "default": null, - "optional": true - } - ], - "tmx": [ - { - "name": "name", - "type": "str", - "description": "The name of the asset.", - "default": null, - "optional": true - }, - { - "name": "exchange", - "type": "str", - "description": "The listing exchange code.", - "default": null, - "optional": true - }, - { - "name": "last_price", - "type": "float", - "description": "The last price of the asset.", - "default": null, - "optional": true - }, - { - "name": "open", - "type": "float", - "description": "The open price.", - "default": null, - "optional": true - }, - { - "name": "high", - "type": "float", - "description": "The high price.", - "default": null, - "optional": true - }, - { - "name": "low", - "type": "float", - "description": "The low price.", - "default": null, - "optional": true - }, - { - "name": "close", - "type": "float", - "description": "None", - "default": null, - "optional": true - }, - { - "name": "volume", - "type": "int", - "description": "Volume Weighted Average Price over the period.", - "default": null, - "optional": true - }, - { - "name": "prev_close", - "type": "float", - "description": "The previous close price.", - "default": null, - "optional": true - }, - { - "name": "change", - "type": "float", - "description": "The change in price.", - "default": null, - "optional": true - }, - { - "name": "change_percent", - "type": "float", - "description": "The change in price as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "year_high", - "type": "float", - "description": "Fifty-two week high.", - "default": null, - "optional": true - }, - { - "name": "year_low", - "type": "float", - "description": "Fifty-two week low.", - "default": null, - "optional": true - }, - { - "name": "security_type", - "type": "str", - "description": "The issuance type of the asset.", - "default": null, - "optional": true - }, - { - "name": "sector", - "type": "str", - "description": "The sector of the asset.", - "default": null, - "optional": true - }, - { - "name": "industry_category", - "type": "str", - "description": "The industry category of the asset.", - "default": null, - "optional": true - }, - { - "name": "industry_group", - "type": "str", - "description": "The industry group of the asset.", - "default": null, - "optional": true - }, - { - "name": "vwap", - "type": "float", - "description": "Volume Weighted Average Price over the period.", - "default": null, - "optional": true - }, - { - "name": "ma_21", - "type": "float", - "description": "Twenty-one day moving average.", - "default": null, - "optional": true - }, - { - "name": "ma_50", - "type": "float", - "description": "Fifty day moving average.", - "default": null, - "optional": true - }, - { - "name": "ma_200", - "type": "float", - "description": "Two-hundred day moving average.", - "default": null, - "optional": true - }, - { - "name": "volume_avg_10d", - "type": "int", - "description": "Ten day average volume.", - "default": null, - "optional": true - }, - { - "name": "volume_avg_30d", - "type": "int", - "description": "Thirty day average volume.", - "default": null, - "optional": true - }, - { - "name": "volume_avg_50d", - "type": "int", - "description": "Fifty day average volume.", - "default": null, - "optional": true - }, - { - "name": "market_cap", - "type": "int", - "description": "Market capitalization.", - "default": null, - "optional": true - }, - { - "name": "market_cap_all_classes", - "type": "int", - "description": "Market capitalization of all share classes.", - "default": null, - "optional": true - }, - { - "name": "div_amount", - "type": "float", - "description": "The most recent dividend amount.", - "default": null, - "optional": true - }, - { - "name": "div_currency", - "type": "str", - "description": "The currency the dividend is paid in.", - "default": null, - "optional": true - }, - { - "name": "div_yield", - "type": "float", - "description": "The dividend yield as a normalized percentage.", - "default": null, - "optional": true - }, - { - "name": "div_freq", - "type": "str", - "description": "The frequency of dividend payments.", - "default": null, - "optional": true - }, - { - "name": "div_ex_date", - "type": "date", - "description": "The ex-dividend date.", - "default": null, - "optional": true - }, - { - "name": "div_pay_date", - "type": "date", - "description": "The next dividend ayment date.", - "default": null, - "optional": true - }, - { - "name": "div_growth_3y", - "type": "Union[str, float]", - "description": "The three year dividend growth as a normalized percentage.", - "default": null, - "optional": true - }, - { - "name": "div_growth_5y", - "type": "Union[str, float]", - "description": "The five year dividend growth as a normalized percentage.", - "default": null, - "optional": true - }, - { - "name": "pe", - "type": "Union[str, float]", - "description": "The price to earnings ratio.", - "default": null, - "optional": true - }, - { - "name": "eps", - "type": "Union[str, float]", - "description": "The earnings per share.", - "default": null, - "optional": true - }, - { - "name": "debt_to_equity", - "type": "Union[str, float]", - "description": "The debt to equity ratio.", - "default": null, - "optional": true - }, - { - "name": "price_to_book", - "type": "Union[str, float]", - "description": "The price to book ratio.", - "default": null, - "optional": true - }, - { - "name": "price_to_cf", - "type": "Union[str, float]", - "description": "The price to cash flow ratio.", - "default": null, - "optional": true - }, - { - "name": "return_on_equity", - "type": "Union[str, float]", - "description": "The return on equity, as a normalized percentage.", - "default": null, - "optional": true - }, - { - "name": "return_on_assets", - "type": "Union[str, float]", - "description": "The return on assets, as a normalized percentage.", - "default": null, - "optional": true - }, - { - "name": "beta", - "type": "Union[str, float]", - "description": "The beta relative to the TSX Composite.", - "default": null, - "optional": true - }, - { - "name": "alpha", - "type": "Union[str, float]", - "description": "The alpha relative to the TSX Composite.", - "default": null, - "optional": true - }, - { - "name": "shares_outstanding", - "type": "int", - "description": "The number of listed shares outstanding.", - "default": null, - "optional": true - }, - { - "name": "shares_escrow", - "type": "int", - "description": "The number of shares held in escrow.", - "default": null, - "optional": true - }, - { - "name": "shares_total", - "type": "int", - "description": "The total number of shares outstanding from all classes.", - "default": null, - "optional": true - } - ], - "tradier": [ - { - "name": "last_volume", - "type": "int", - "description": "The last trade volume.", - "default": null, - "optional": true - }, - { - "name": "volume_avg", - "type": "int", - "description": "The average daily trading volume.", - "default": null, - "optional": true - }, - { - "name": "bid_timestamp", - "type": "datetime", - "description": "Timestamp of the bid price.", - "default": null, - "optional": true - }, - { - "name": "ask_timestamp", - "type": "datetime", - "description": "Timestamp of the ask price.", - "default": null, - "optional": true - }, - { - "name": "greeks_timestamp", - "type": "datetime", - "description": "Timestamp of the greeks data.", - "default": null, - "optional": true - }, - { - "name": "underlying", - "type": "str", - "description": "The underlying symbol for the option.", - "default": null, - "optional": true - }, - { - "name": "root_symbol", - "type": "str", - "description": "The root symbol for the option.", - "default": null, - "optional": true - }, - { - "name": "option_type", - "type": "Literal['call', 'put']", - "description": "Type of option - call or put.", - "default": null, - "optional": true - }, - { - "name": "contract_size", - "type": "int", - "description": "The number of shares in a standard contract.", - "default": null, - "optional": true - }, - { - "name": "expiration_type", - "type": "str", - "description": "The expiration type of the option - i.e, standard, weekly, etc.", - "default": null, - "optional": true - }, - { - "name": "expiration_date", - "type": "date", - "description": "The expiration date of the option.", - "default": null, - "optional": true - }, - { - "name": "strike", - "type": "float", - "description": "The strike price of the option.", - "default": null, - "optional": true - }, - { - "name": "open_interest", - "type": "int", - "description": "The number of open contracts for the option.", - "default": null, - "optional": true - }, - { - "name": "bid_iv", - "type": "float", - "description": "Implied volatility of the bid price.", - "default": null, - "optional": true - }, - { - "name": "ask_iv", - "type": "float", - "description": "Implied volatility of the ask price.", - "default": null, - "optional": true - }, - { - "name": "mid_iv", - "type": "float", - "description": "Mid-point implied volatility of the option.", - "default": null, - "optional": true - }, - { - "name": "orats_final_iv", - "type": "float", - "description": "ORATS final implied volatility of the option.", - "default": null, - "optional": true - }, - { - "name": "delta", - "type": "float", - "description": "Delta of the option.", - "default": null, - "optional": true - }, - { - "name": "gamma", - "type": "float", - "description": "Gamma of the option.", - "default": null, - "optional": true - }, - { - "name": "theta", - "type": "float", - "description": "Theta of the option.", - "default": null, - "optional": true - }, - { - "name": "vega", - "type": "float", - "description": "Vega of the option.", - "default": null, - "optional": true - }, - { - "name": "rho", - "type": "float", - "description": "Rho of the option.", - "default": null, - "optional": true - }, - { - "name": "phi", - "type": "float", - "description": "Phi of the option.", - "default": null, - "optional": true - } - ], - "yfinance": [ - { - "name": "ma_50d", - "type": "float", - "description": "50-day moving average price.", - "default": null, - "optional": true - }, - { - "name": "ma_200d", - "type": "float", - "description": "200-day moving average price.", - "default": null, - "optional": true - }, - { - "name": "volume_average", - "type": "float", - "description": "Average daily trading volume.", - "default": null, - "optional": true - }, - { - "name": "volume_average_10d", - "type": "float", - "description": "Average daily trading volume in the last 10 days.", - "default": null, - "optional": true - }, - { - "name": "currency", - "type": "str", - "description": "Currency of the price.", - "default": null, - "optional": true - } - ] - }, - "model": "EquityQuote" - }, - "/equity/price/nbbo": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the National Best Bid and Offer for a given stock.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.nbbo(symbol='AAPL', provider='polygon')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false - }, - { - "name": "provider", - "type": "Literal['polygon']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'polygon' if there is no default.", - "default": "polygon", - "optional": true - } - ], - "polygon": [ - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. Up to ten million records will be returned. Pagination occurs in groups of 50,000. Remaining limit values will always return 50,000 more records unless it is the last page. High volume tickers will require multiple max requests for a single day's NBBO records. Expect stocks, like SPY, to approach 1GB in size, per day, as a raw CSV. Splitting large requests into chunks is recommended for full-day requests of high-volume symbols.", - "default": 50000, - "optional": true - }, - { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for. Use bracketed the timestamp parameters to specify exact time ranges.", - "default": null, - "optional": true - }, - { - "name": "timestamp_lt", - "type": "Union[datetime, str]", - "description": "Query by datetime, less than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", - "default": null, - "optional": true - }, - { - "name": "timestamp_gt", - "type": "Union[datetime, str]", - "description": "Query by datetime, greater than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", - "default": null, - "optional": true - }, - { - "name": "timestamp_lte", - "type": "Union[datetime, str]", - "description": "Query by datetime, less than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", - "default": null, - "optional": true - }, - { - "name": "timestamp_gte", - "type": "Union[datetime, str]", - "description": "Query by datetime, greater than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", - "default": null, - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EquityNBBO]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['polygon']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "ask_exchange", - "type": "str", - "description": "The exchange ID for the ask.", - "default": "", - "optional": false - }, - { - "name": "ask", - "type": "float", - "description": "The last ask price.", - "default": "", - "optional": false - }, - { - "name": "ask_size", - "type": "int", - "description": "The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price.", - "default": "", - "optional": false - }, - { - "name": "bid_size", - "type": "int", - "description": "The bid size in round lots.", - "default": "", - "optional": false - }, - { - "name": "bid", - "type": "float", - "description": "The last bid price.", - "default": "", - "optional": false - }, - { - "name": "bid_exchange", - "type": "str", - "description": "The exchange ID for the bid.", - "default": "", - "optional": false - } - ], - "polygon": [ - { - "name": "tape", - "type": "str", - "description": "The exchange tape.", - "default": null, - "optional": true - }, - { - "name": "conditions", - "type": "Union[str, List[int], List[str]]", - "description": "A list of condition codes.", - "default": null, - "optional": true - }, - { - "name": "indicators", - "type": "List[int]", - "description": "A list of indicator codes.", - "default": null, - "optional": true - }, - { - "name": "sequence_num", - "type": "int", - "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11)", - "default": null, - "optional": true - }, - { - "name": "participant_timestamp", - "type": "datetime", - "description": "The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.", - "default": null, - "optional": true - }, - { - "name": "sip_timestamp", - "type": "datetime", - "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it.", - "default": null, - "optional": true - }, - { - "name": "trf_timestamp", - "type": "datetime", - "description": "The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this quote.", - "default": null, - "optional": true - } - ] - }, - "model": "EquityNBBO" - }, - "/equity/price/historical": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get historical price data for a given stock. This includes open, high, low, close, and volume.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.historical(symbol='AAPL', provider='fmp')\nobb.equity.price.historical(symbol='AAPL', interval='1d', provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance.", - "default": "", - "optional": false - }, - { - "name": "interval", - "type": "str", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - }, - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "provider", - "type": "Literal['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default.", - "default": "alpha_vantage", - "optional": true - } - ], - "alpha_vantage": [ - { - "name": "interval", - "type": "Literal['1m', '5m', '15m', '30m', '60m', '1d', '1W', '1M']", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - }, - { - "name": "adjustment", - "type": "Literal['splits_only', 'splits_and_dividends', 'unadjusted']", - "description": "The adjustment factor to apply. 'splits_only' is not supported for intraday data.", - "default": "splits_only", - "optional": true - }, - { - "name": "extended_hours", - "type": "bool", - "description": "Include Pre and Post market data.", - "default": false, - "optional": true - }, - { - "name": "adjusted", - "type": "bool", - "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead.", - "default": false, - "optional": true - } - ], - "cboe": [ - { - "name": "interval", - "type": "Literal['1m', '1d']", - "description": "Time interval of the data to return. The most recent trading day is not including in daily historical data. Intraday data is only available for the most recent trading day at 1 minute intervals.", - "default": "1d", - "optional": true - }, - { - "name": "use_cache", - "type": "bool", - "description": "When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass.", - "default": true, + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true } ], "fmp": [ { - "name": "interval", - "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", - "description": "Time interval of the data to return.", - "default": "1d", + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", "optional": true } ], "intrinio": [ { - "name": "symbol", - "type": "str", - "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", - "default": "", - "optional": false - }, - { - "name": "interval", - "type": "Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y']", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - }, - { - "name": "start_time", - "type": "datetime.time", - "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'.", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", + "description": "None", + "default": "annual", "optional": true }, { - "name": "end_time", - "type": "datetime.time", - "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'.", + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", "default": null, "optional": true - }, - { - "name": "timezone", - "type": "str", - "description": "Timezone of the data, in the IANA format (Continent/City).", - "default": "America/New_York", - "optional": true - }, - { - "name": "source", - "type": "Literal['realtime', 'delayed', 'nasdaq_basic']", - "description": "The source of the data.", - "default": "realtime", - "optional": true } ], "polygon": [ { - "name": "interval", - "type": "str", - "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", - "default": "1d", + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm']", + "description": "None", + "default": "annual", "optional": true }, { - "name": "adjustment", - "type": "Literal['splits_only', 'unadjusted']", - "description": "The adjustment factor to apply. Default is splits only.", - "default": "splits_only", + "name": "filing_date", + "type": "date", + "description": "Filing date of the financial statement.", + "default": null, "optional": true }, { - "name": "extended_hours", - "type": "bool", - "description": "Include Pre and Post market data.", - "default": false, + "name": "filing_date_lt", + "type": "date", + "description": "Filing date less than the given date.", + "default": null, "optional": true }, { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", - "default": "asc", + "name": "filing_date_lte", + "type": "date", + "description": "Filing date less than or equal to the given date.", + "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 49999, - "optional": true - } - ], - "tiingo": [ - { - "name": "interval", - "type": "Literal['1d', '1W', '1M', '1Y']", - "description": "Time interval of the data to return.", - "default": "1d", + "name": "filing_date_gt", + "type": "date", + "description": "Filing date greater than the given date.", + "default": null, "optional": true - } - ], - "tmx": [ + }, { - "name": "interval", - "type": "Union[Literal['1m', '2m', '5m', '15m', '30m', '60m', '1h', '1d', '1W', '1M'], str, int]", - "description": "Time interval of the data to return. Or, any integer (entered as a string) representing the number of minutes. Default is daily data. There is no extended hours data, and intraday data is limited to after April 12 2022.", - "default": "day", + "name": "filing_date_gte", + "type": "date", + "description": "Filing date greater than or equal to the given date.", + "default": null, "optional": true }, { - "name": "adjustment", - "type": "Literal['splits_only', 'splits_and_dividends', 'unadjusted']", - "description": "The adjustment factor to apply. Only valid for daily data.", - "default": "splits_only", + "name": "period_of_report_date", + "type": "date", + "description": "Period of report date of the financial statement.", + "default": null, "optional": true - } - ], - "tradier": [ + }, { - "name": "interval", - "type": "Literal['1m', '5m', '15m', '1d', '1W', '1M']", - "description": "Time interval of the data to return.", - "default": "1d", + "name": "period_of_report_date_lt", + "type": "date", + "description": "Period of report date less than the given date.", + "default": null, "optional": true }, { - "name": "extended_hours", - "type": "bool", - "description": "Include Pre and Post market data.", - "default": false, + "name": "period_of_report_date_lte", + "type": "date", + "description": "Period of report date less than or equal to the given date.", + "default": null, "optional": true - } - ], - "yfinance": [ + }, { - "name": "interval", - "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", - "description": "Time interval of the data to return.", - "default": "1d", + "name": "period_of_report_date_gt", + "type": "date", + "description": "Period of report date greater than the given date.", + "default": null, "optional": true }, { - "name": "extended_hours", - "type": "bool", - "description": "Include Pre and Post market data.", - "default": false, + "name": "period_of_report_date_gte", + "type": "date", + "description": "Period of report date greater than or equal to the given date.", + "default": null, "optional": true }, { - "name": "include_actions", + "name": "include_sources", "type": "bool", - "description": "Include dividends and stock splits in results.", - "default": true, + "description": "Whether to include the sources of the financial statement.", + "default": null, "optional": true }, { - "name": "adjustment", - "type": "Literal['splits_only', 'splits_and_dividends']", - "description": "The adjustment factor to apply. Default is splits only.", - "default": "splits_only", + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order of the financial statement.", + "default": null, "optional": true }, { - "name": "adjusted", - "type": "bool", - "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead.", - "default": false, + "name": "sort", + "type": "Literal['filing_date', 'period_of_report_date']", + "description": "Sort of the financial statement.", + "default": null, "optional": true - }, + } + ], + "yfinance": [ { - "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, + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "None", + "default": "annual", "optional": true } ] @@ -22802,12 +12270,12 @@ "OBBject": [ { "name": "results", - "type": "List[EquityHistorical]", + "type": "List[IncomeStatement]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance']]", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", "description": "Provider name." }, { @@ -22830,1410 +12298,1167 @@ "data": { "standard": [ { - "name": "date", - "type": "Union[date, datetime]", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "open", - "type": "float", - "description": "The open price.", - "default": "", - "optional": false - }, - { - "name": "high", - "type": "float", - "description": "The high price.", - "default": "", - "optional": false - }, - { - "name": "low", - "type": "float", - "description": "The low price.", - "default": "", - "optional": false - }, - { - "name": "close", - "type": "float", - "description": "The close price.", + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", "default": "", "optional": false }, { - "name": "volume", - "type": "Union[float, int]", - "description": "The trading volume.", + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the report.", "default": null, "optional": true }, { - "name": "vwap", - "type": "float", - "description": "Volume Weighted Average Price over the period.", + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the fiscal period.", "default": null, "optional": true } ], - "alpha_vantage": [ - { - "name": "adj_close", - "type": "Annotated[float, Gt(gt=0)]", - "description": "The adjusted close price.", - "default": null, - "optional": true - }, + "fmp": [ { - "name": "dividend", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Dividend amount, if a dividend was paid.", + "name": "filing_date", + "type": "date", + "description": "The date when the filing was made.", "default": null, "optional": true }, { - "name": "split_ratio", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Split coefficient, if a split occurred.", + "name": "accepted_date", + "type": "datetime", + "description": "The date and time when the filing was accepted.", "default": null, "optional": true - } - ], - "cboe": [ + }, { - "name": "calls_volume", - "type": "int", - "description": "Number of calls traded during the most recent trading period. Only valid if interval is 1m.", + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet was reported.", "default": null, "optional": true }, { - "name": "puts_volume", - "type": "int", - "description": "Number of puts traded during the most recent trading period. Only valid if interval is 1m.", + "name": "revenue", + "type": "float", + "description": "Total revenue.", "default": null, "optional": true }, { - "name": "total_options_volume", - "type": "int", - "description": "Total number of options traded during the most recent trading period. Only valid if interval is 1m.", + "name": "cost_of_revenue", + "type": "float", + "description": "Cost of revenue.", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "adj_close", + "name": "gross_profit", "type": "float", - "description": "The adjusted close price.", + "description": "Gross profit.", "default": null, "optional": true }, { - "name": "unadjusted_volume", + "name": "gross_profit_margin", "type": "float", - "description": "Unadjusted volume of the symbol.", + "description": "Gross profit margin.", "default": null, "optional": true }, { - "name": "change", + "name": "general_and_admin_expense", "type": "float", - "description": "Change in the price from the previous close.", + "description": "General and administrative expenses.", "default": null, "optional": true }, { - "name": "change_percent", + "name": "research_and_development_expense", "type": "float", - "description": "Change in the price from the previous close, as a normalized percent.", + "description": "Research and development expenses.", "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "average", + "name": "selling_and_marketing_expense", "type": "float", - "description": "Average trade price of an individual equity during the interval.", + "description": "Selling and marketing expenses.", "default": null, "optional": true }, { - "name": "change", + "name": "selling_general_and_admin_expense", "type": "float", - "description": "Change in the price of the symbol from the previous day.", + "description": "Selling, general and administrative expenses.", "default": null, "optional": true }, { - "name": "change_percent", + "name": "other_expenses", "type": "float", - "description": "Percent change in the price of the symbol from the previous day.", + "description": "Other expenses.", "default": null, "optional": true }, { - "name": "adj_open", + "name": "total_operating_expenses", "type": "float", - "description": "The adjusted open price.", + "description": "Total operating expenses.", "default": null, "optional": true }, { - "name": "adj_high", + "name": "cost_and_expenses", "type": "float", - "description": "The adjusted high price.", + "description": "Cost and expenses.", "default": null, "optional": true }, { - "name": "adj_low", + "name": "interest_income", "type": "float", - "description": "The adjusted low price.", + "description": "Interest income.", "default": null, "optional": true }, { - "name": "adj_close", + "name": "total_interest_expense", "type": "float", - "description": "The adjusted close price.", + "description": "Total interest expenses.", "default": null, "optional": true }, { - "name": "adj_volume", + "name": "depreciation_and_amortization", "type": "float", - "description": "The adjusted volume.", + "description": "Depreciation and amortization.", "default": null, "optional": true }, { - "name": "fifty_two_week_high", + "name": "ebitda", "type": "float", - "description": "52 week high price for the symbol.", + "description": "EBITDA.", "default": null, "optional": true }, { - "name": "fifty_two_week_low", + "name": "ebitda_margin", "type": "float", - "description": "52 week low price for the symbol.", + "description": "EBITDA margin.", "default": null, "optional": true }, { - "name": "factor", + "name": "total_operating_income", "type": "float", - "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices.", + "description": "Total operating income.", "default": null, "optional": true }, { - "name": "split_ratio", + "name": "operating_income_margin", "type": "float", - "description": "Ratio of the equity split, if a split occurred.", + "description": "Operating income margin.", "default": null, "optional": true }, { - "name": "dividend", + "name": "total_other_income_expenses", "type": "float", - "description": "Dividend amount, if a dividend was paid.", + "description": "Total other income and expenses.", "default": null, "optional": true }, { - "name": "close_time", - "type": "datetime", - "description": "The timestamp that represents the end of the interval span.", + "name": "total_pre_tax_income", + "type": "float", + "description": "Total pre-tax income.", "default": null, "optional": true }, { - "name": "interval", - "type": "str", - "description": "The data time frequency.", + "name": "pre_tax_income_margin", + "type": "float", + "description": "Pre-tax income margin.", "default": null, "optional": true }, { - "name": "intra_period", - "type": "bool", - "description": "If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period", + "name": "income_tax_expense", + "type": "float", + "description": "Income tax expense.", "default": null, "optional": true - } - ], - "polygon": [ + }, { - "name": "transactions", - "type": "Annotated[int, Gt(gt=0)]", - "description": "Number of transactions for the symbol in the time period.", + "name": "consolidated_net_income", + "type": "float", + "description": "Consolidated net income.", "default": null, "optional": true - } - ], - "tiingo": [ + }, { - "name": "adj_open", + "name": "net_income_margin", "type": "float", - "description": "The adjusted open price.", + "description": "Net income margin.", "default": null, "optional": true }, { - "name": "adj_high", + "name": "basic_earnings_per_share", "type": "float", - "description": "The adjusted high price.", + "description": "Basic earnings per share.", "default": null, "optional": true }, { - "name": "adj_low", + "name": "diluted_earnings_per_share", "type": "float", - "description": "The adjusted low price.", + "description": "Diluted earnings per share.", "default": null, "optional": true }, { - "name": "adj_close", + "name": "weighted_average_basic_shares_outstanding", "type": "float", - "description": "The adjusted close price.", + "description": "Weighted average basic shares outstanding.", "default": null, "optional": true }, { - "name": "adj_volume", + "name": "weighted_average_diluted_shares_outstanding", "type": "float", - "description": "The adjusted volume.", + "description": "Weighted average diluted shares outstanding.", "default": null, "optional": true }, { - "name": "split_ratio", - "type": "float", - "description": "Ratio of the equity split, if a split occurred.", + "name": "link", + "type": "str", + "description": "Link to the filing.", "default": null, "optional": true }, { - "name": "dividend", - "type": "float", - "description": "Dividend amount, if a dividend was paid.", + "name": "final_link", + "type": "str", + "description": "Link to the filing document.", "default": null, "optional": true } ], - "tmx": [ + "intrinio": [ { - "name": "vwap", - "type": "float", - "description": "Volume weighted average price for the day.", + "name": "reported_currency", + "type": "str", + "description": "The currency in which the balance sheet is reported.", "default": null, "optional": true }, { - "name": "change", + "name": "revenue", "type": "float", - "description": "Change in price.", + "description": "Total revenue", "default": null, "optional": true }, { - "name": "change_percent", + "name": "operating_revenue", "type": "float", - "description": "Change in price, as a normalized percentage.", + "description": "Total operating revenue", "default": null, "optional": true }, { - "name": "transactions", - "type": "int", - "description": "Total number of transactions recorded.", + "name": "cost_of_revenue", + "type": "float", + "description": "Total cost of revenue", "default": null, "optional": true }, { - "name": "transactions_value", + "name": "operating_cost_of_revenue", "type": "float", - "description": "Nominal value of recorded transactions.", + "description": "Total operating cost of revenue", "default": null, "optional": true - } - ], - "tradier": [ + }, { - "name": "last_price", + "name": "gross_profit", "type": "float", - "description": "The last price of the equity.", + "description": "Total gross profit", "default": null, "optional": true - } - ], - "yfinance": [ + }, { - "name": "split_ratio", + "name": "gross_profit_margin", "type": "float", - "description": "Ratio of the equity split, if a split occurred.", + "description": "Gross margin ratio.", "default": null, "optional": true }, { - "name": "dividend", + "name": "provision_for_credit_losses", "type": "float", - "description": "Dividend amount (split-adjusted), if a dividend was paid.", + "description": "Provision for credit losses", "default": null, "optional": true - } - ] - }, - "model": "EquityHistorical" - }, - "/equity/price/performance": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get price performance data for a given stock. This includes price changes for different time periods.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.performance(symbol='AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp.", - "default": "", - "optional": false }, { - "name": "provider", - "type": "Literal['finviz', 'fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default.", - "default": "finviz", + "name": "research_and_development_expense", + "type": "float", + "description": "Research and development expense", + "default": null, "optional": true - } - ], - "finviz": [], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[PricePerformance]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['finviz', 'fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + { + "name": "selling_general_and_admin_expense", + "type": "float", + "description": "Selling, general, and admin expense", "default": null, "optional": true }, { - "name": "one_day", + "name": "salaries_and_employee_benefits", "type": "float", - "description": "One-day return.", + "description": "Salaries and employee benefits", "default": null, "optional": true }, { - "name": "wtd", + "name": "marketing_expense", "type": "float", - "description": "Week to date return.", + "description": "Marketing expense", "default": null, "optional": true }, { - "name": "one_week", + "name": "net_occupancy_and_equipment_expense", "type": "float", - "description": "One-week return.", + "description": "Net occupancy and equipment expense", "default": null, "optional": true }, { - "name": "mtd", + "name": "other_operating_expenses", "type": "float", - "description": "Month to date return.", + "description": "Other operating expenses", "default": null, "optional": true }, { - "name": "one_month", + "name": "depreciation_expense", "type": "float", - "description": "One-month return.", + "description": "Depreciation expense", "default": null, "optional": true }, { - "name": "qtd", + "name": "amortization_expense", "type": "float", - "description": "Quarter to date return.", + "description": "Amortization expense", "default": null, "optional": true }, { - "name": "three_month", + "name": "amortization_of_deferred_policy_acquisition_costs", "type": "float", - "description": "Three-month return.", + "description": "Amortization of deferred policy acquisition costs", "default": null, "optional": true }, { - "name": "six_month", + "name": "exploration_expense", "type": "float", - "description": "Six-month return.", + "description": "Exploration expense", "default": null, "optional": true }, { - "name": "ytd", + "name": "depletion_expense", "type": "float", - "description": "Year to date return.", + "description": "Depletion expense", "default": null, "optional": true }, { - "name": "one_year", + "name": "total_operating_expenses", "type": "float", - "description": "One-year return.", + "description": "Total operating expenses", "default": null, "optional": true }, { - "name": "two_year", + "name": "total_operating_income", "type": "float", - "description": "Two-year return.", + "description": "Total operating income", "default": null, "optional": true }, { - "name": "three_year", + "name": "deposits_and_money_market_investments_interest_income", "type": "float", - "description": "Three-year return.", + "description": "Deposits and money market investments interest income", "default": null, "optional": true }, { - "name": "four_year", + "name": "federal_funds_sold_and_securities_borrowed_interest_income", "type": "float", - "description": "Four-year", + "description": "Federal funds sold and securities borrowed interest income", "default": null, "optional": true }, { - "name": "five_year", + "name": "investment_securities_interest_income", "type": "float", - "description": "Five-year return.", + "description": "Investment securities interest income", "default": null, "optional": true }, { - "name": "ten_year", + "name": "loans_and_leases_interest_income", "type": "float", - "description": "Ten-year return.", + "description": "Loans and leases interest income", "default": null, "optional": true }, { - "name": "max", + "name": "trading_account_interest_income", "type": "float", - "description": "Return from the beginning of the time series.", + "description": "Trading account interest income", "default": null, "optional": true - } - ], - "finviz": [ + }, { - "name": "symbol", - "type": "str", - "description": "The ticker symbol.", + "name": "other_interest_income", + "type": "float", + "description": "Other interest income", "default": null, "optional": true }, { - "name": "volatility_week", + "name": "total_non_interest_income", "type": "float", - "description": "One-week realized volatility, as a normalized percent.", + "description": "Total non-interest income", "default": null, "optional": true }, { - "name": "volatility_month", + "name": "interest_and_investment_income", "type": "float", - "description": "One-month realized volatility, as a normalized percent.", + "description": "Interest and investment income", "default": null, "optional": true }, { - "name": "price", + "name": "short_term_borrowings_interest_expense", "type": "float", - "description": "Last Price.", + "description": "Short-term borrowings interest expense", "default": null, "optional": true }, { - "name": "volume", + "name": "long_term_debt_interest_expense", "type": "float", - "description": "Current volume.", + "description": "Long-term debt interest expense", "default": null, "optional": true }, { - "name": "average_volume", + "name": "capitalized_lease_obligations_interest_expense", "type": "float", - "description": "Average daily volume.", + "description": "Capitalized lease obligations interest expense", "default": null, "optional": true }, { - "name": "relative_volume", + "name": "deposits_interest_expense", "type": "float", - "description": "Relative volume as a ratio of current volume to average volume.", + "description": "Deposits interest expense", "default": null, "optional": true }, { - "name": "analyst_recommendation", + "name": "federal_funds_purchased_and_securities_sold_interest_expense", "type": "float", - "description": "The analyst consensus, on a scale of 1-5 where 1 is a buy and 5 is a sell.", + "description": "Federal funds purchased and securities sold interest expense", "default": null, "optional": true - } - ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "The ticker symbol.", - "default": "", - "optional": false - } - ] - }, - "model": "PricePerformance" - }, - "/equity/shorts/fails_to_deliver": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get reported Fail-to-deliver (FTD) data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.shorts.fails_to_deliver(symbol='AAPL', provider='sec')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "provider", - "type": "Literal['sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", - "default": "sec", + "name": "other_interest_expense", + "type": "float", + "description": "Other interest expense", + "default": null, "optional": true - } - ], - "sec": [ + }, { - "name": "limit", - "type": "int", - "description": "Limit the number of reports to parse, from most recent. Approximately 24 reports per year, going back to 2009.", - "default": 24, + "name": "total_interest_expense", + "type": "float", + "description": "Total interest expense", + "default": null, "optional": true }, { - "name": "skip_reports", - "type": "int", - "description": "Skip N number of reports from current. A value of 1 will skip the most recent report.", - "default": 0, + "name": "net_interest_income", + "type": "float", + "description": "Net interest income", + "default": null, "optional": true }, { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache for the request, default is True. Each reporting period is a separate URL, new reports will be added to the cache.", - "default": true, + "name": "other_non_interest_income", + "type": "float", + "description": "Other non-interest income", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EquityFTD]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['sec']]", - "description": "Provider name." + "name": "investment_banking_income", + "type": "float", + "description": "Investment banking income", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "trust_fees_by_commissions", + "type": "float", + "description": "Trust fees by commissions", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "premiums_earned", + "type": "float", + "description": "Premiums earned", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "settlement_date", - "type": "date", - "description": "The settlement date of the fail.", + "name": "insurance_policy_acquisition_costs", + "type": "float", + "description": "Insurance policy acquisition costs", "default": null, "optional": true }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "current_and_future_benefits", + "type": "float", + "description": "Current and future benefits", "default": null, "optional": true }, { - "name": "cusip", - "type": "str", - "description": "CUSIP of the Security.", + "name": "property_and_liability_insurance_claims", + "type": "float", + "description": "Property and liability insurance claims", "default": null, "optional": true }, { - "name": "quantity", - "type": "int", - "description": "The number of fails on that settlement date.", + "name": "total_non_interest_expense", + "type": "float", + "description": "Total non-interest expense", "default": null, "optional": true }, { - "name": "price", + "name": "net_realized_and_unrealized_capital_gains_on_investments", "type": "float", - "description": "The price at the previous closing price from the settlement date.", + "description": "Net realized and unrealized capital gains on investments", "default": null, "optional": true }, { - "name": "description", - "type": "str", - "description": "The description of the Security.", + "name": "other_gains", + "type": "float", + "description": "Other gains", "default": null, "optional": true - } - ], - "sec": [] - }, - "model": "EquityFTD" - }, - "/equity/shorts/short_volume": { - "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.short_volume(symbol='AAPL', provider='stockgrid')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false + "name": "non_operating_income", + "type": "float", + "description": "Non-operating income", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Literal['stockgrid']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'stockgrid' if there is no default.", - "default": "stockgrid", + "name": "other_income", + "type": "float", + "description": "Other income", + "default": null, "optional": true - } - ], - "stockgrid": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[ShortVolume]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['stockgrid']]", - "description": "Provider name." + "name": "other_revenue", + "type": "float", + "description": "Other revenue", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "extraordinary_income", + "type": "float", + "description": "Extraordinary income", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "total_other_income", + "type": "float", + "description": "Total other income", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "ebitda", + "type": "float", + "description": "Earnings Before Interest, Taxes, Depreciation and Amortization.", "default": null, "optional": true }, { - "name": "market", - "type": "str", - "description": "Reporting Facility ID. N=NYSE TRF, Q=NASDAQ TRF Carteret, B=NASDAQ TRY Chicago, D=FINRA ADF", + "name": "ebitda_margin", + "type": "float", + "description": "Margin on Earnings Before Interest, Taxes, Depreciation and Amortization.", "default": null, "optional": true }, { - "name": "short_volume", - "type": "int", - "description": "Aggregate reported share volume of executed short sale and short sale exempt trades during regular trading hours", + "name": "total_pre_tax_income", + "type": "float", + "description": "Total pre-tax income", "default": null, "optional": true }, { - "name": "short_exempt_volume", - "type": "int", - "description": "Aggregate reported share volume of executed short sale exempt trades during regular trading hours", + "name": "ebit", + "type": "float", + "description": "Earnings Before Interest and Taxes.", "default": null, "optional": true }, { - "name": "total_volume", - "type": "int", - "description": "Aggregate reported share volume of executed trades during regular trading hours", + "name": "pre_tax_income_margin", + "type": "float", + "description": "Pre-Tax Income Margin.", "default": null, "optional": true - } - ], - "stockgrid": [ + }, { - "name": "close", + "name": "income_tax_expense", "type": "float", - "description": "Closing price of the stock on the date.", + "description": "Income tax expense", "default": null, "optional": true }, { - "name": "short_volume_percent", + "name": "impairment_charge", "type": "float", - "description": "Percentage of the total volume that was short volume.", + "description": "Impairment charge", "default": null, "optional": true - } - ] - }, - "model": "ShortVolume" - }, - "/equity/shorts/short_interest": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get reported short volume and days to cover data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.shorts.short_interest(symbol='AAPL', provider='finra')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "provider", - "type": "Literal['finra']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finra' if there is no default.", - "default": "finra", + "name": "restructuring_charge", + "type": "float", + "description": "Restructuring charge", + "default": null, "optional": true - } - ], - "finra": [] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[EquityShortInterest]", - "description": "Serializable results." + "name": "service_charges_on_deposit_accounts", + "type": "float", + "description": "Service charges on deposit accounts", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['finra']]", - "description": "Provider name." + "name": "other_service_charges", + "type": "float", + "description": "Other service charges", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "other_special_charges", + "type": "float", + "description": "Other special charges", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "other_cost_of_revenue", + "type": "float", + "description": "Other cost of revenue", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "net_income_continuing_operations", + "type": "float", + "description": "Net income (continuing operations)", + "default": null, + "optional": true + }, { - "name": "settlement_date", - "type": "date", - "description": "The mid-month short interest report is based on short positions held by members on the settlement date of the 15th of each month. If the 15th falls on a weekend or another non-settlement date, the designated settlement date will be the previous business day on which transactions settled. The end-of-month short interest report is based on short positions held on the last business day of the month on which transactions settle. Once the short position reports are received, the short interest data is compiled for each equity security and provided for publication on the 7th business day after the reporting settlement date.", - "default": "", - "optional": false + "name": "net_income_discontinued_operations", + "type": "float", + "description": "Net income (discontinued operations)", + "default": null, + "optional": true }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "consolidated_net_income", + "type": "float", + "description": "Consolidated net income", + "default": null, + "optional": true }, { - "name": "issue_name", - "type": "str", - "description": "Unique identifier of the issue.", - "default": "", - "optional": false + "name": "other_adjustments_to_consolidated_net_income", + "type": "float", + "description": "Other adjustments to consolidated net income", + "default": null, + "optional": true }, { - "name": "market_class", - "type": "str", - "description": "Primary listing market.", - "default": "", - "optional": false + "name": "other_adjustment_to_net_income_attributable_to_common_shareholders", + "type": "float", + "description": "Other adjustment to net income attributable to common shareholders", + "default": null, + "optional": true }, { - "name": "current_short_position", + "name": "net_income_attributable_to_noncontrolling_interest", "type": "float", - "description": "The total number of shares in the issue that are reflected on the books and records of the reporting firms as short as defined by Rule 200 of Regulation SHO as of the current cycle\u2019s designated settlement date.", - "default": "", - "optional": false + "description": "Net income attributable to noncontrolling interest", + "default": null, + "optional": true }, { - "name": "previous_short_position", + "name": "net_income_attributable_to_common_shareholders", "type": "float", - "description": "The total number of shares in the issue that are reflected on the books and records of the reporting firms as short as defined by Rule 200 of Regulation SHO as of the previous cycle\u2019s designated settlement date.", - "default": "", - "optional": false + "description": "Net income attributable to common shareholders", + "default": null, + "optional": true }, { - "name": "avg_daily_volume", + "name": "basic_earnings_per_share", "type": "float", - "description": "Total Volume or Adjusted Volume in case of splits / Total trade days between (previous settlement date + 1) to (current settlement date). The NULL values are translated as zero.", - "default": "", - "optional": false + "description": "Basic earnings per share", + "default": null, + "optional": true }, { - "name": "days_to_cover", + "name": "diluted_earnings_per_share", "type": "float", - "description": "The number of days of average share volume it would require to buy all of the shares that were sold short during the reporting cycle. Formula: Short Interest / Average Daily Share Volume, Rounded to Hundredths. 1.00 will be displayed for any values equal or less than 1 (i.e., Average Daily Share is equal to or greater than Short Interest). N/A will be displayed If the days to cover is Zero (i.e., Average Daily Share Volume is Zero).", - "default": "", - "optional": false + "description": "Diluted earnings per share", + "default": null, + "optional": true }, { - "name": "change", + "name": "basic_and_diluted_earnings_per_share", "type": "float", - "description": "Change in Shares Short from Previous Cycle: Difference in short interest between the current cycle and the previous cycle.", - "default": "", - "optional": false + "description": "Basic and diluted earnings per share", + "default": null, + "optional": true }, { - "name": "change_pct", + "name": "cash_dividends_to_common_per_share", "type": "float", - "description": "Change in Shares Short from Previous Cycle as a percent.", - "default": "", - "optional": false - } - ], - "finra": [] - }, - "model": "EquityShortInterest" - }, - "/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')\nobb.equity.search(query='AAPL', is_symbol=False, use_cache=True, provider='nasdaq')\n```\n\n", - "parameters": { - "standard": [ + "description": "Cash dividends to common per share", + "default": null, + "optional": true + }, { - "name": "query", - "type": "str", - "description": "Search query.", - "default": "", + "name": "preferred_stock_dividends_declared", + "type": "float", + "description": "Preferred stock dividends declared", + "default": null, "optional": true }, { - "name": "is_symbol", - "type": "bool", - "description": "Whether to search by ticker symbol.", - "default": false, + "name": "weighted_average_basic_shares_outstanding", + "type": "float", + "description": "Weighted average basic shares outstanding", + "default": null, "optional": true }, { - "name": "use_cache", - "type": "bool", - "description": "Whether to use the cache or not.", - "default": true, + "name": "weighted_average_diluted_shares_outstanding", + "type": "float", + "description": "Weighted average diluted shares outstanding", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.", - "default": "cboe", + "name": "weighted_average_basic_and_diluted_shares_outstanding", + "type": "float", + "description": "Weighted average basic and diluted shares outstanding", + "default": null, "optional": true } ], - "cboe": [], - "intrinio": [ + "polygon": [ { - "name": "active", - "type": "bool", - "description": "When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded.", - "default": true, + "name": "revenue", + "type": "float", + "description": "Total Revenue", + "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 10000, + "name": "cost_of_revenue_goods", + "type": "float", + "description": "Cost of Revenue - Goods", + "default": null, "optional": true - } - ], - "nasdaq": [ + }, { - "name": "is_etf", - "type": "bool", - "description": "If True, returns ETFs.", + "name": "cost_of_revenue_services", + "type": "float", + "description": "Cost of Revenue - Services", "default": null, "optional": true - } - ], - "sec": [ + }, { - "name": "is_fund", - "type": "bool", - "description": "Whether to direct the search to the list of mutual funds and ETFs.", - "default": false, + "name": "cost_of_revenue", + "type": "float", + "description": "Cost of Revenue", + "default": null, "optional": true - } - ], - "tmx": [ + }, { - "name": "use_cache", - "type": "bool", - "description": "Whether to use a cached request. The list of companies is cached for two days.", - "default": true, + "name": "gross_profit", + "type": "float", + "description": "Gross Profit", + "default": null, "optional": true - } - ], - "tradier": [ + }, { - "name": "is_symbol", - "type": "bool", - "description": "Whether the query is a symbol. Defaults to False.", - "default": false, + "name": "provisions_for_loan_lease_and_other_losses", + "type": "float", + "description": "Provisions for loan lease and other losses", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EquitySearch]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier']]", - "description": "Provider name." + "name": "depreciation_and_amortization", + "type": "float", + "description": "Depreciation and Amortization", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "income_tax_expense_benefit_current", + "type": "float", + "description": "Income tax expense benefit current", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "deferred_tax_benefit", + "type": "float", + "description": "Deferred tax benefit", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "benefits_costs_expenses", + "type": "float", + "description": "Benefits, costs and expenses", "default": null, "optional": true }, { - "name": "name", - "type": "str", - "description": "Name of the company.", + "name": "selling_general_and_administrative_expense", + "type": "float", + "description": "Selling, general and administrative expense", "default": null, "optional": true - } - ], - "cboe": [ + }, { - "name": "dpm_name", - "type": "str", - "description": "Name of the primary market maker.", + "name": "research_and_development", + "type": "float", + "description": "Research and development", "default": null, "optional": true }, { - "name": "post_station", - "type": "str", - "description": "Post and station location on the CBOE trading floor.", + "name": "costs_and_expenses", + "type": "float", + "description": "Costs and expenses", "default": null, "optional": true - } - ], - "intrinio": [ - { - "name": "cik", - "type": "str", - "description": "", - "default": "", - "optional": false }, { - "name": "lei", - "type": "str", - "description": "The Legal Entity Identifier (LEI) of the company.", - "default": "", - "optional": false + "name": "other_operating_expenses", + "type": "float", + "description": "Other Operating Expenses", + "default": null, + "optional": true }, { - "name": "intrinio_id", - "type": "str", - "description": "The Intrinio ID of the company.", - "default": "", - "optional": false - } - ], - "nasdaq": [ - { - "name": "nasdaq_traded", - "type": "str", - "description": "Is Nasdaq traded?", + "name": "operating_expenses", + "type": "float", + "description": "Operating expenses", "default": null, "optional": true }, { - "name": "exchange", - "type": "str", - "description": "Primary Exchange", + "name": "operating_income", + "type": "float", + "description": "Operating Income/Loss", "default": null, "optional": true }, { - "name": "market_category", - "type": "str", - "description": "Market Category", + "name": "non_operating_income", + "type": "float", + "description": "Non Operating Income/Loss", "default": null, "optional": true }, { - "name": "etf", - "type": "str", - "description": "Is ETF?", + "name": "interest_and_dividend_income", + "type": "float", + "description": "Interest and Dividend Income", "default": null, "optional": true }, { - "name": "round_lot_size", + "name": "total_interest_expense", "type": "float", - "description": "Round Lot Size", + "description": "Interest Expense", "default": null, "optional": true }, { - "name": "test_issue", - "type": "str", - "description": "Is test Issue?", + "name": "interest_and_debt_expense", + "type": "float", + "description": "Interest and Debt Expense", "default": null, "optional": true }, { - "name": "financial_status", - "type": "str", - "description": "Financial Status", + "name": "net_interest_income", + "type": "float", + "description": "Interest Income Net", "default": null, "optional": true }, { - "name": "cqs_symbol", - "type": "str", - "description": "CQS Symbol", + "name": "interest_income_after_provision_for_losses", + "type": "float", + "description": "Interest Income After Provision for Losses", "default": null, "optional": true }, { - "name": "nasdaq_symbol", - "type": "str", - "description": "NASDAQ Symbol", + "name": "non_interest_expense", + "type": "float", + "description": "Non-Interest Expense", "default": null, "optional": true }, { - "name": "next_shares", - "type": "str", - "description": "Is NextShares?", + "name": "non_interest_income", + "type": "float", + "description": "Non-Interest Income", "default": null, "optional": true - } - ], - "sec": [ - { - "name": "cik", - "type": "str", - "description": "Central Index Key", - "default": "", - "optional": false - } - ], - "tmx": [], - "tradier": [ + }, { - "name": "exchange", - "type": "str", - "description": "Exchange where the security is listed.", - "default": "", - "optional": false + "name": "income_from_discontinued_operations_net_of_tax_on_disposal", + "type": "float", + "description": "Income From Discontinued Operations Net of Tax on Disposal", + "default": null, + "optional": true }, { - "name": "security_type", - "type": "Literal['stock', 'option', 'etf', 'index', 'mutual_fund']", - "description": "Type of security.", - "default": "", - "optional": false - } - ] - }, - "model": "EquitySearch" - }, - "/equity/screener": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Screen for companies meeting various criteria.\n\nThese criteria include market cap, price, beta, volume, and dividend yield.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.screener(provider='fmp')\n```\n\n", - "parameters": { - "standard": [ + "name": "income_from_discontinued_operations_net_of_tax", + "type": "float", + "description": "Income From Discontinued Operations Net of Tax", + "default": null, + "optional": true + }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "income_before_equity_method_investments", + "type": "float", + "description": "Income Before Equity Method Investments", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "mktcap_min", - "type": "int", - "description": "Filter by market cap greater than this value.", + "name": "income_from_equity_method_investments", + "type": "float", + "description": "Income From Equity Method Investments", "default": null, "optional": true }, { - "name": "mktcap_max", - "type": "int", - "description": "Filter by market cap less than this value.", + "name": "total_pre_tax_income", + "type": "float", + "description": "Income Before Tax", "default": null, "optional": true }, { - "name": "price_min", + "name": "income_tax_expense", "type": "float", - "description": "Filter by price greater than this value.", + "description": "Income Tax Expense", "default": null, "optional": true }, { - "name": "price_max", + "name": "income_after_tax", "type": "float", - "description": "Filter by price less than this value.", + "description": "Income After Tax", "default": null, "optional": true }, { - "name": "beta_min", + "name": "consolidated_net_income", "type": "float", - "description": "Filter by a beta greater than this value.", + "description": "Net Income/Loss", "default": null, "optional": true }, { - "name": "beta_max", + "name": "net_income_attributable_noncontrolling_interest", "type": "float", - "description": "Filter by a beta less than this value.", + "description": "Net income (loss) attributable to noncontrolling interest", "default": null, "optional": true }, { - "name": "volume_min", - "type": "int", - "description": "Filter by volume greater than this value.", + "name": "net_income_attributable_to_parent", + "type": "float", + "description": "Net income (loss) attributable to parent", "default": null, "optional": true }, { - "name": "volume_max", - "type": "int", - "description": "Filter by volume less than this value.", + "name": "net_income_attributable_to_common_shareholders", + "type": "float", + "description": "Net Income/Loss Available To Common Stockholders Basic", "default": null, "optional": true }, { - "name": "dividend_min", + "name": "participating_securities_earnings", "type": "float", - "description": "Filter by dividend amount greater than this value.", + "description": "Participating Securities Distributed And Undistributed Earnings Loss Basic", "default": null, "optional": true }, { - "name": "dividend_max", + "name": "undistributed_earnings_allocated_to_participating_securities", "type": "float", - "description": "Filter by dividend amount less than this value.", + "description": "Undistributed Earnings Allocated To Participating Securities", "default": null, "optional": true }, { - "name": "is_etf", - "type": "bool", - "description": "If true, returns only ETFs.", - "default": false, + "name": "common_stock_dividends", + "type": "float", + "description": "Common Stock Dividends", + "default": null, "optional": true }, { - "name": "is_active", - "type": "bool", - "description": "If false, returns only inactive tickers.", - "default": true, + "name": "preferred_stock_dividends_and_other_adjustments", + "type": "float", + "description": "Preferred stock dividends and other adjustments", + "default": null, "optional": true }, { - "name": "sector", - "type": "Literal['Consumer Cyclical', 'Energy', 'Technology', 'Industrials', 'Financial Services', 'Basic Materials', 'Communication Services', 'Consumer Defensive', 'Healthcare', 'Real Estate', 'Utilities', 'Industrial Goods', 'Financial', 'Services', 'Conglomerates']", - "description": "Filter by sector.", + "name": "basic_earnings_per_share", + "type": "float", + "description": "Earnings Per Share", "default": null, "optional": true }, { - "name": "industry", - "type": "str", - "description": "Filter by industry.", + "name": "diluted_earnings_per_share", + "type": "float", + "description": "Diluted Earnings Per Share", "default": null, "optional": true }, { - "name": "country", - "type": "str", - "description": "Filter by country, as a two-letter country code.", + "name": "weighted_average_basic_shares_outstanding", + "type": "float", + "description": "Basic Average Shares", "default": null, "optional": true }, { - "name": "exchange", - "type": "Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra']", - "description": "Filter by exchange.", + "name": "weighted_average_diluted_shares_outstanding", + "type": "float", + "description": "Diluted Average Shares", "default": null, "optional": true + } + ], + "yfinance": [] + }, + "model": "IncomeStatement" + }, + "/equity/fundamental/income_growth": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the growth of a company's income statement items over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.income_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.income_growth(symbol='AAPL', limit=10, period='annual', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { "name": "limit", "type": "int", - "description": "Limit the number of results to return.", - "default": 50000, + "description": "The number of data entries to return.", + "default": 10, + "optional": true + }, + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true } - ] + ], + "fmp": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EquityScreener]", + "type": "List[IncomeStatementGrowth]", "description": "Serializable results." }, { @@ -24264,146 +13489,270 @@ "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "name", + "name": "period", "type": "str", - "description": "Name of the company.", + "description": "Period the statement is returned for.", "default": "", "optional": false - } - ], - "fmp": [ + }, { - "name": "market_cap", - "type": "int", - "description": "The market cap of ticker.", - "default": null, - "optional": true + "name": "growth_revenue", + "type": "float", + "description": "Growth rate of total revenue.", + "default": "", + "optional": false }, { - "name": "sector", - "type": "str", - "description": "The sector the ticker belongs to.", - "default": null, - "optional": true + "name": "growth_cost_of_revenue", + "type": "float", + "description": "Growth rate of cost of goods sold.", + "default": "", + "optional": false + }, + { + "name": "growth_gross_profit", + "type": "float", + "description": "Growth rate of gross profit.", + "default": "", + "optional": false + }, + { + "name": "growth_gross_profit_ratio", + "type": "float", + "description": "Growth rate of gross profit as a percentage of revenue.", + "default": "", + "optional": false + }, + { + "name": "growth_research_and_development_expenses", + "type": "float", + "description": "Growth rate of expenses on research and development.", + "default": "", + "optional": false + }, + { + "name": "growth_general_and_administrative_expenses", + "type": "float", + "description": "Growth rate of general and administrative expenses.", + "default": "", + "optional": false + }, + { + "name": "growth_selling_and_marketing_expenses", + "type": "float", + "description": "Growth rate of expenses on selling and marketing activities.", + "default": "", + "optional": false + }, + { + "name": "growth_other_expenses", + "type": "float", + "description": "Growth rate of other operating expenses.", + "default": "", + "optional": false + }, + { + "name": "growth_operating_expenses", + "type": "float", + "description": "Growth rate of total operating expenses.", + "default": "", + "optional": false + }, + { + "name": "growth_cost_and_expenses", + "type": "float", + "description": "Growth rate of total costs and expenses.", + "default": "", + "optional": false + }, + { + "name": "growth_interest_expense", + "type": "float", + "description": "Growth rate of interest expenses.", + "default": "", + "optional": false + }, + { + "name": "growth_depreciation_and_amortization", + "type": "float", + "description": "Growth rate of depreciation and amortization expenses.", + "default": "", + "optional": false + }, + { + "name": "growth_ebitda", + "type": "float", + "description": "Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization.", + "default": "", + "optional": false + }, + { + "name": "growth_ebitda_ratio", + "type": "float", + "description": "Growth rate of EBITDA as a percentage of revenue.", + "default": "", + "optional": false + }, + { + "name": "growth_operating_income", + "type": "float", + "description": "Growth rate of operating income.", + "default": "", + "optional": false + }, + { + "name": "growth_operating_income_ratio", + "type": "float", + "description": "Growth rate of operating income as a percentage of revenue.", + "default": "", + "optional": false }, { - "name": "industry", - "type": "str", - "description": "The industry ticker belongs to.", - "default": null, - "optional": true + "name": "growth_total_other_income_expenses_net", + "type": "float", + "description": "Growth rate of net total other income and expenses.", + "default": "", + "optional": false }, { - "name": "beta", + "name": "growth_income_before_tax", "type": "float", - "description": "The beta of the ETF.", - "default": null, - "optional": true + "description": "Growth rate of income before taxes.", + "default": "", + "optional": false }, { - "name": "price", + "name": "growth_income_before_tax_ratio", "type": "float", - "description": "The current price.", - "default": null, - "optional": true + "description": "Growth rate of income before taxes as a percentage of revenue.", + "default": "", + "optional": false }, { - "name": "last_annual_dividend", + "name": "growth_income_tax_expense", "type": "float", - "description": "The last annual amount dividend paid.", - "default": null, - "optional": true + "description": "Growth rate of income tax expenses.", + "default": "", + "optional": false }, { - "name": "volume", - "type": "int", - "description": "The current trading volume.", - "default": null, - "optional": true + "name": "growth_net_income", + "type": "float", + "description": "Growth rate of net income.", + "default": "", + "optional": false }, { - "name": "exchange", - "type": "str", - "description": "The exchange code the asset trades on.", - "default": null, - "optional": true + "name": "growth_net_income_ratio", + "type": "float", + "description": "Growth rate of net income as a percentage of revenue.", + "default": "", + "optional": false }, { - "name": "exchange_name", - "type": "str", - "description": "The full name of the primary exchange.", - "default": null, - "optional": true + "name": "growth_eps", + "type": "float", + "description": "Growth rate of Earnings Per Share (EPS).", + "default": "", + "optional": false }, { - "name": "country", - "type": "str", - "description": "The two-letter country abbreviation where the head office is located.", - "default": null, - "optional": true + "name": "growth_eps_diluted", + "type": "float", + "description": "Growth rate of diluted Earnings Per Share (EPS).", + "default": "", + "optional": false }, { - "name": "is_etf", - "type": "Literal[True, False]", - "description": "Whether the ticker is an ETF.", - "default": null, - "optional": true + "name": "growth_weighted_average_shs_out", + "type": "float", + "description": "Growth rate of weighted average shares outstanding.", + "default": "", + "optional": false }, { - "name": "actively_trading", - "type": "Literal[True, False]", - "description": "Whether the ETF is actively trading.", - "default": null, - "optional": true + "name": "growth_weighted_average_shs_out_dil", + "type": "float", + "description": "Growth rate of diluted weighted average shares outstanding.", + "default": "", + "optional": false } - ] + ], + "fmp": [] }, - "model": "EquityScreener" + "model": "IncomeStatementGrowth" }, - "/equity/profile": { + "/equity/fundamental/metrics": { "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", + "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): finviz, fmp, intrinio, tmx, yfinance.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": "", "optional": false }, + { + "name": "period", + "type": "Literal['annual', 'quarter']", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100, + "optional": true + }, { "name": "provider", - "type": "Literal['finviz', 'fmp', 'intrinio', 'tmx', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default.", - "default": "finviz", + "type": "Literal['fmp', 'intrinio', 'yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "with_ttm", + "type": "bool", + "description": "Include trailing twelve months (TTM) data.", + "default": false, "optional": true } ], - "finviz": [], - "fmp": [], "intrinio": [], - "tmx": [], "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EquityInfo]", + "type": "List[KeyMetrics]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['finviz', 'fmp', 'intrinio', 'tmx', 'yfinance']]", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", "description": "Provider name." }, { @@ -24429,1047 +13778,1108 @@ "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "market_cap", + "type": "float", + "description": "Market capitalization", + "default": null, + "optional": true + }, + { + "name": "pe_ratio", + "type": "float", + "description": "Price-to-earnings ratio (P/E ratio)", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "name", + "name": "period", "type": "str", - "description": "Common name of the company.", + "description": "Period of the data.", + "default": "", + "optional": false + }, + { + "name": "calendar_year", + "type": "int", + "description": "Calendar year.", "default": null, "optional": true }, { - "name": "cik", - "type": "str", - "description": "Central Index Key (CIK) for the requested entity.", + "name": "revenue_per_share", + "type": "float", + "description": "Revenue per share", "default": null, "optional": true }, { - "name": "cusip", - "type": "str", - "description": "CUSIP identifier for the company.", + "name": "net_income_per_share", + "type": "float", + "description": "Net income per share", "default": null, "optional": true }, { - "name": "isin", - "type": "str", - "description": "International Securities Identification Number.", + "name": "operating_cash_flow_per_share", + "type": "float", + "description": "Operating cash flow per share", "default": null, "optional": true }, { - "name": "lei", - "type": "str", - "description": "Legal Entity Identifier assigned to the company.", + "name": "free_cash_flow_per_share", + "type": "float", + "description": "Free cash flow per share", "default": null, "optional": true }, { - "name": "legal_name", - "type": "str", - "description": "Official legal name of the company.", + "name": "cash_per_share", + "type": "float", + "description": "Cash per share", "default": null, "optional": true }, { - "name": "stock_exchange", - "type": "str", - "description": "Stock exchange where the company is traded.", + "name": "book_value_per_share", + "type": "float", + "description": "Book value per share", "default": null, "optional": true }, { - "name": "sic", - "type": "int", - "description": "Standard Industrial Classification code for the company.", + "name": "tangible_book_value_per_share", + "type": "float", + "description": "Tangible book value per share", "default": null, "optional": true }, { - "name": "short_description", - "type": "str", - "description": "Short description of the company.", + "name": "shareholders_equity_per_share", + "type": "float", + "description": "Shareholders equity per share", + "default": null, + "optional": true + }, + { + "name": "interest_debt_per_share", + "type": "float", + "description": "Interest debt per share", + "default": null, + "optional": true + }, + { + "name": "enterprise_value", + "type": "float", + "description": "Enterprise value", + "default": null, + "optional": true + }, + { + "name": "price_to_sales_ratio", + "type": "float", + "description": "Price-to-sales ratio", + "default": null, + "optional": true + }, + { + "name": "pocf_ratio", + "type": "float", + "description": "Price-to-operating cash flow ratio", + "default": null, + "optional": true + }, + { + "name": "pfcf_ratio", + "type": "float", + "description": "Price-to-free cash flow ratio", "default": null, "optional": true }, { - "name": "long_description", - "type": "str", - "description": "Long description of the company.", + "name": "pb_ratio", + "type": "float", + "description": "Price-to-book ratio", "default": null, "optional": true }, { - "name": "ceo", - "type": "str", - "description": "Chief Executive Officer of the company.", + "name": "ptb_ratio", + "type": "float", + "description": "Price-to-tangible book ratio", "default": null, "optional": true }, { - "name": "company_url", - "type": "str", - "description": "URL of the company's website.", + "name": "ev_to_sales", + "type": "float", + "description": "Enterprise value-to-sales ratio", "default": null, "optional": true }, { - "name": "business_address", - "type": "str", - "description": "Address of the company's headquarters.", + "name": "enterprise_value_over_ebitda", + "type": "float", + "description": "Enterprise value-to-EBITDA ratio", "default": null, "optional": true }, { - "name": "mailing_address", - "type": "str", - "description": "Mailing address of the company.", + "name": "ev_to_operating_cash_flow", + "type": "float", + "description": "Enterprise value-to-operating cash flow ratio", "default": null, "optional": true }, { - "name": "business_phone_no", - "type": "str", - "description": "Phone number of the company's headquarters.", + "name": "ev_to_free_cash_flow", + "type": "float", + "description": "Enterprise value-to-free cash flow ratio", "default": null, "optional": true }, { - "name": "hq_address1", - "type": "str", - "description": "Address of the company's headquarters.", + "name": "earnings_yield", + "type": "float", + "description": "Earnings yield", "default": null, "optional": true }, { - "name": "hq_address2", - "type": "str", - "description": "Address of the company's headquarters.", + "name": "free_cash_flow_yield", + "type": "float", + "description": "Free cash flow yield", "default": null, "optional": true }, { - "name": "hq_address_city", - "type": "str", - "description": "City of the company's headquarters.", + "name": "debt_to_equity", + "type": "float", + "description": "Debt-to-equity ratio", "default": null, "optional": true }, { - "name": "hq_address_postal_code", - "type": "str", - "description": "Zip code of the company's headquarters.", + "name": "debt_to_assets", + "type": "float", + "description": "Debt-to-assets ratio", "default": null, "optional": true }, { - "name": "hq_state", - "type": "str", - "description": "State of the company's headquarters.", + "name": "net_debt_to_ebitda", + "type": "float", + "description": "Net debt-to-EBITDA ratio", "default": null, "optional": true }, { - "name": "hq_country", - "type": "str", - "description": "Country of the company's headquarters.", + "name": "current_ratio", + "type": "float", + "description": "Current ratio", "default": null, "optional": true }, { - "name": "inc_state", - "type": "str", - "description": "State in which the company is incorporated.", + "name": "interest_coverage", + "type": "float", + "description": "Interest coverage", "default": null, "optional": true }, { - "name": "inc_country", - "type": "str", - "description": "Country in which the company is incorporated.", + "name": "income_quality", + "type": "float", + "description": "Income quality", "default": null, "optional": true }, { - "name": "employees", - "type": "int", - "description": "Number of employees working for the company.", + "name": "dividend_yield", + "type": "float", + "description": "Dividend yield, as a normalized percent.", "default": null, "optional": true }, { - "name": "entity_legal_form", - "type": "str", - "description": "Legal form of the company.", + "name": "payout_ratio", + "type": "float", + "description": "Payout ratio", "default": null, "optional": true }, { - "name": "entity_status", - "type": "str", - "description": "Status of the company.", + "name": "sales_general_and_administrative_to_revenue", + "type": "float", + "description": "Sales general and administrative expenses-to-revenue ratio", "default": null, "optional": true }, { - "name": "latest_filing_date", - "type": "date", - "description": "Date of the company's latest filing.", + "name": "research_and_development_to_revenue", + "type": "float", + "description": "Research and development expenses-to-revenue ratio", "default": null, "optional": true }, { - "name": "irs_number", - "type": "str", - "description": "IRS number assigned to the company.", + "name": "intangibles_to_total_assets", + "type": "float", + "description": "Intangibles-to-total assets ratio", "default": null, "optional": true }, { - "name": "sector", - "type": "str", - "description": "Sector in which the company operates.", + "name": "capex_to_operating_cash_flow", + "type": "float", + "description": "Capital expenditures-to-operating cash flow ratio", "default": null, "optional": true }, { - "name": "industry_category", - "type": "str", - "description": "Category of industry in which the company operates.", + "name": "capex_to_revenue", + "type": "float", + "description": "Capital expenditures-to-revenue ratio", "default": null, "optional": true }, { - "name": "industry_group", - "type": "str", - "description": "Group of industry in which the company operates.", + "name": "capex_to_depreciation", + "type": "float", + "description": "Capital expenditures-to-depreciation ratio", "default": null, "optional": true }, { - "name": "template", - "type": "str", - "description": "Template used to standardize the company's financial statements.", + "name": "stock_based_compensation_to_revenue", + "type": "float", + "description": "Stock-based compensation-to-revenue ratio", "default": null, "optional": true }, { - "name": "standardized_active", - "type": "bool", - "description": "Whether the company is active or not.", + "name": "graham_number", + "type": "float", + "description": "Graham number", "default": null, "optional": true }, { - "name": "first_fundamental_date", - "type": "date", - "description": "Date of the company's first fundamental.", + "name": "roic", + "type": "float", + "description": "Return on invested capital", "default": null, "optional": true }, { - "name": "last_fundamental_date", - "type": "date", - "description": "Date of the company's last fundamental.", + "name": "return_on_tangible_assets", + "type": "float", + "description": "Return on tangible assets", "default": null, "optional": true }, { - "name": "first_stock_price_date", - "type": "date", - "description": "Date of the company's first stock price.", + "name": "graham_net_net", + "type": "float", + "description": "Graham net-net working capital", "default": null, "optional": true }, { - "name": "last_stock_price_date", - "type": "date", - "description": "Date of the company's last stock price.", + "name": "working_capital", + "type": "float", + "description": "Working capital", "default": null, "optional": true - } - ], - "finviz": [ + }, { - "name": "index", - "type": "str", - "description": "Included in indices - i.e., Dow, Nasdaq, or S&P.", + "name": "tangible_asset_value", + "type": "float", + "description": "Tangible asset value", "default": null, "optional": true }, { - "name": "optionable", - "type": "str", - "description": "Whether options trade against the ticker.", + "name": "net_current_asset_value", + "type": "float", + "description": "Net current asset value", "default": null, "optional": true }, { - "name": "shortable", - "type": "str", - "description": "If the asset is shortable.", + "name": "invested_capital", + "type": "float", + "description": "Invested capital", "default": null, "optional": true }, { - "name": "shares_outstanding", - "type": "str", - "description": "The number of shares outstanding, as an abbreviated string.", + "name": "average_receivables", + "type": "float", + "description": "Average receivables", "default": null, "optional": true }, { - "name": "shares_float", - "type": "str", - "description": "The number of shares in the public float, as an abbreviated string.", + "name": "average_payables", + "type": "float", + "description": "Average payables", "default": null, "optional": true }, { - "name": "short_interest", - "type": "str", - "description": "The last reported number of shares sold short, as an abbreviated string.", + "name": "average_inventory", + "type": "float", + "description": "Average inventory", "default": null, "optional": true }, { - "name": "institutional_ownership", + "name": "days_sales_outstanding", "type": "float", - "description": "The institutional ownership of the stock, as a normalized percent.", + "description": "Days sales outstanding", "default": null, "optional": true }, { - "name": "market_cap", - "type": "str", - "description": "The market capitalization of the stock, as an abbreviated string.", + "name": "days_payables_outstanding", + "type": "float", + "description": "Days payables outstanding", "default": null, "optional": true }, { - "name": "dividend_yield", + "name": "days_of_inventory_on_hand", "type": "float", - "description": "The dividend yield of the stock, as a normalized percent.", + "description": "Days of inventory on hand", "default": null, "optional": true }, { - "name": "earnings_date", - "type": "str", - "description": "The last, or next confirmed, earnings date and announcement time, as a string. The format is Nov 02 AMC - for after market close.", + "name": "receivables_turnover", + "type": "float", + "description": "Receivables turnover", "default": null, "optional": true }, { - "name": "beta", + "name": "payables_turnover", "type": "float", - "description": "The beta of the stock relative to the broad market.", + "description": "Payables turnover", "default": null, "optional": true - } - ], - "fmp": [ - { - "name": "is_etf", - "type": "bool", - "description": "If the symbol is an ETF.", - "default": "", - "optional": false }, { - "name": "is_actively_trading", - "type": "bool", - "description": "If the company is actively trading.", - "default": "", - "optional": false + "name": "inventory_turnover", + "type": "float", + "description": "Inventory turnover", + "default": null, + "optional": true }, { - "name": "is_adr", - "type": "bool", - "description": "If the stock is an ADR.", - "default": "", - "optional": false + "name": "roe", + "type": "float", + "description": "Return on equity", + "default": null, + "optional": true }, { - "name": "is_fund", - "type": "bool", - "description": "If the company is a fund.", - "default": "", - "optional": false - }, + "name": "capex_per_share", + "type": "float", + "description": "Capital expenditures per share", + "default": null, + "optional": true + } + ], + "intrinio": [ { - "name": "image", - "type": "str", - "description": "Image of the company.", + "name": "price_to_book", + "type": "float", + "description": "Price to book ratio.", "default": null, "optional": true }, { - "name": "currency", - "type": "str", - "description": "Currency in which the stock is traded.", + "name": "price_to_tangible_book", + "type": "float", + "description": "Price to tangible book ratio.", "default": null, "optional": true }, { - "name": "market_cap", - "type": "int", - "description": "Market capitalization of the company.", + "name": "price_to_revenue", + "type": "float", + "description": "Price to revenue ratio.", "default": null, "optional": true }, { - "name": "last_price", + "name": "quick_ratio", "type": "float", - "description": "The last traded price.", + "description": "Quick ratio.", "default": null, "optional": true }, { - "name": "year_high", + "name": "gross_margin", "type": "float", - "description": "The one-year high of the price.", + "description": "Gross margin, as a normalized percent.", "default": null, "optional": true }, { - "name": "year_low", + "name": "ebit_margin", "type": "float", - "description": "The one-year low of the price.", + "description": "EBIT margin, as a normalized percent.", "default": null, "optional": true }, { - "name": "volume_avg", - "type": "int", - "description": "Average daily trading volume.", + "name": "profit_margin", + "type": "float", + "description": "Profit margin, as a normalized percent.", "default": null, "optional": true }, { - "name": "annualized_dividend_amount", + "name": "eps", "type": "float", - "description": "The annualized dividend payment based on the most recent regular dividend payment.", + "description": "Basic earnings per share.", "default": null, "optional": true }, { - "name": "beta", + "name": "eps_growth", "type": "float", - "description": "Beta of the stock relative to the market.", + "description": "EPS growth, as a normalized percent.", "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "id", - "type": "str", - "description": "Intrinio ID for the company.", + "name": "revenue_growth", + "type": "float", + "description": "Revenue growth, as a normalized percent.", "default": null, "optional": true }, { - "name": "thea_enabled", - "type": "bool", - "description": "Whether the company has been enabled for Thea.", + "name": "ebitda_growth", + "type": "float", + "description": "EBITDA growth, as a normalized percent.", "default": null, "optional": true - } - ], - "tmx": [ + }, { - "name": "email", - "type": "str", - "description": "The email of the company.", + "name": "ebit_growth", + "type": "float", + "description": "EBIT growth, as a normalized percent.", "default": null, "optional": true }, { - "name": "issue_type", - "type": "str", - "description": "The issuance type of the asset.", + "name": "net_income_growth", + "type": "float", + "description": "Net income growth, as a normalized percent.", "default": null, "optional": true }, { - "name": "shares_outstanding", - "type": "int", - "description": "The number of listed shares outstanding.", + "name": "free_cash_flow_to_firm_growth", + "type": "float", + "description": "Free cash flow to firm growth, as a normalized percent.", "default": null, "optional": true }, { - "name": "shares_escrow", - "type": "int", - "description": "The number of shares held in escrow.", + "name": "invested_capital_growth", + "type": "float", + "description": "Invested capital growth, as a normalized percent.", "default": null, "optional": true }, { - "name": "shares_total", - "type": "int", - "description": "The total number of shares outstanding from all classes.", + "name": "return_on_assets", + "type": "float", + "description": "Return on assets, as a normalized percent.", "default": null, "optional": true }, { - "name": "dividend_frequency", - "type": "str", - "description": "The dividend frequency.", + "name": "return_on_equity", + "type": "float", + "description": "Return on equity, as a normalized percent.", "default": null, "optional": true - } - ], - "yfinance": [ + }, { - "name": "exchange_timezone", - "type": "str", - "description": "The timezone of the exchange.", + "name": "return_on_invested_capital", + "type": "float", + "description": "Return on invested capital, as a normalized percent.", "default": null, "optional": true }, { - "name": "issue_type", - "type": "str", - "description": "The issuance type of the asset.", + "name": "ebitda", + "type": "int", + "description": "Earnings before interest, taxes, depreciation, and amortization.", "default": null, "optional": true }, { - "name": "currency", - "type": "str", - "description": "The currency in which the asset is traded.", + "name": "ebit", + "type": "int", + "description": "Earnings before interest and taxes.", "default": null, "optional": true }, { - "name": "market_cap", + "name": "long_term_debt", "type": "int", - "description": "The market capitalization of the asset.", + "description": "Long-term debt.", "default": null, "optional": true }, { - "name": "shares_outstanding", + "name": "total_debt", "type": "int", - "description": "The number of listed shares outstanding.", + "description": "Total debt.", "default": null, "optional": true }, { - "name": "shares_float", + "name": "total_capital", "type": "int", - "description": "The number of shares in the public float.", + "description": "The sum of long-term debt and total shareholder equity.", "default": null, "optional": true }, { - "name": "shares_implied_outstanding", + "name": "enterprise_value", "type": "int", - "description": "Implied shares outstanding of common equityassuming the conversion of all convertible subsidiary equity into common.", + "description": "Enterprise value.", "default": null, "optional": true }, { - "name": "shares_short", + "name": "free_cash_flow_to_firm", "type": "int", - "description": "The reported number of shares short.", + "description": "Free cash flow to firm.", "default": null, "optional": true }, { - "name": "dividend_yield", + "name": "altman_z_score", "type": "float", - "description": "The dividend yield of the asset, as a normalized percent.", + "description": "Altman Z-score.", "default": null, "optional": true }, { "name": "beta", "type": "float", - "description": "The beta of the asset relative to the broad market.", + "description": "Beta relative to the broad market (rolling three-year).", "default": null, "optional": true - } - ] - }, - "model": "EquityInfo" - }, - "/equity/market_snapshots": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get an updated equity market snapshot. This includes price data for thousands of stocks.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.market_snapshots(provider='fmp')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'polygon']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "dividend_yield", + "type": "float", + "description": "Dividend yield, as a normalized percent.", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "market", - "type": "Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra']", - "description": "The market to fetch data for.", - "default": "nasdaq", + "name": "earnings_yield", + "type": "float", + "description": "Earnings yield, as a normalized percent.", + "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "date", - "type": "Union[Union[date, datetime, str], str]", - "description": "The date of the data. Can be a datetime or an ISO datetime string. Historical data appears to go back to mid-June 2022. Example: '2024-03-08T12:15:00+0400'", + "name": "last_price", + "type": "float", + "description": "Last price of the stock.", "default": null, "optional": true - } - ], - "polygon": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[MarketSnapshots]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon']]", - "description": "Provider name." + "name": "year_high", + "type": "float", + "description": "52 week high", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "year_low", + "type": "float", + "description": "52 week low", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "volume_avg", + "type": "int", + "description": "Average daily volume.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "short_interest", + "type": "int", + "description": "Number of shares reported as sold short.", + "default": null, + "optional": true + }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "shares_outstanding", + "type": "int", + "description": "Weighted average shares outstanding (TTM).", + "default": null, + "optional": true }, { - "name": "open", + "name": "days_to_cover", + "type": "float", + "description": "Days to cover short interest, based on average daily volume.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "forward_pe", "type": "float", - "description": "The open price.", + "description": "Forward price-to-earnings ratio.", "default": null, "optional": true }, { - "name": "high", + "name": "peg_ratio", "type": "float", - "description": "The high price.", + "description": "PEG ratio (5-year expected).", "default": null, "optional": true }, { - "name": "low", + "name": "peg_ratio_ttm", "type": "float", - "description": "The low price.", + "description": "PEG ratio (TTM).", "default": null, "optional": true }, { - "name": "close", + "name": "eps_ttm", "type": "float", - "description": "The close price.", + "description": "Earnings per share (TTM).", "default": null, "optional": true }, { - "name": "volume", - "type": "int", - "description": "The trading volume.", + "name": "eps_forward", + "type": "float", + "description": "Forward earnings per share.", "default": null, "optional": true }, { - "name": "prev_close", + "name": "enterprise_to_ebitda", "type": "float", - "description": "The previous close price.", + "description": "Enterprise value to EBITDA ratio.", "default": null, "optional": true }, { - "name": "change", + "name": "earnings_growth", "type": "float", - "description": "The change in price from the previous close.", + "description": "Earnings growth (Year Over Year), as a normalized percent.", "default": null, "optional": true }, { - "name": "change_percent", + "name": "earnings_growth_quarterly", "type": "float", - "description": "The change in price from the previous close, as a normalized percent.", + "description": "Quarterly earnings growth (Year Over Year), as a normalized percent.", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "last_price", + "name": "revenue_per_share", "type": "float", - "description": "The last price of the stock.", + "description": "Revenue per share (TTM).", "default": null, "optional": true }, { - "name": "last_price_timestamp", - "type": "Union[date, datetime]", - "description": "The timestamp of the last price.", + "name": "revenue_growth", + "type": "float", + "description": "Revenue growth (Year Over Year), as a normalized percent.", "default": null, "optional": true }, { - "name": "ma50", + "name": "enterprise_to_revenue", "type": "float", - "description": "The 50-day moving average.", + "description": "Enterprise value to revenue ratio.", "default": null, "optional": true }, { - "name": "ma200", + "name": "cash_per_share", "type": "float", - "description": "The 200-day moving average.", + "description": "Cash per share.", "default": null, "optional": true }, { - "name": "year_high", + "name": "quick_ratio", "type": "float", - "description": "The 52-week high.", + "description": "Quick ratio.", "default": null, "optional": true }, { - "name": "year_low", + "name": "current_ratio", "type": "float", - "description": "The 52-week low.", + "description": "Current ratio.", "default": null, "optional": true }, { - "name": "volume_avg", - "type": "int", - "description": "Average daily trading volume.", + "name": "debt_to_equity", + "type": "float", + "description": "Debt-to-equity ratio.", "default": null, "optional": true }, { - "name": "market_cap", - "type": "int", - "description": "Market cap of the stock.", + "name": "gross_margin", + "type": "float", + "description": "Gross margin, as a normalized percent.", "default": null, "optional": true }, { - "name": "eps", + "name": "operating_margin", "type": "float", - "description": "Earnings per share.", + "description": "Operating margin, as a normalized percent.", "default": null, "optional": true }, { - "name": "pe", + "name": "ebitda_margin", "type": "float", - "description": "Price to earnings ratio.", + "description": "EBITDA margin, as a normalized percent.", "default": null, "optional": true }, { - "name": "shares_outstanding", - "type": "int", - "description": "Number of shares outstanding.", + "name": "profit_margin", + "type": "float", + "description": "Profit margin, as a normalized percent.", "default": null, "optional": true }, { - "name": "name", - "type": "str", - "description": "The company name associated with the symbol.", + "name": "return_on_assets", + "type": "float", + "description": "Return on assets, as a normalized percent.", "default": null, "optional": true }, { - "name": "exchange", - "type": "str", - "description": "The exchange of the stock.", + "name": "return_on_equity", + "type": "float", + "description": "Return on equity, as a normalized percent.", "default": null, "optional": true }, { - "name": "earnings_date", - "type": "Union[date, datetime]", - "description": "The upcoming earnings announcement date.", + "name": "dividend_yield", + "type": "float", + "description": "Dividend yield, as a normalized percent.", "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "last_price", + "name": "dividend_yield_5y_avg", "type": "float", - "description": "The last trade price.", + "description": "5-year average dividend yield, as a normalized percent.", "default": null, "optional": true }, { - "name": "last_size", - "type": "int", - "description": "The last trade size.", + "name": "payout_ratio", + "type": "float", + "description": "Payout ratio.", "default": null, "optional": true }, { - "name": "last_volume", - "type": "int", - "description": "The last trade volume.", + "name": "book_value", + "type": "float", + "description": "Book value per share.", "default": null, "optional": true }, { - "name": "last_trade_timestamp", - "type": "datetime", - "description": "The timestamp of the last trade.", + "name": "price_to_book", + "type": "float", + "description": "Price-to-book ratio.", "default": null, "optional": true }, { - "name": "bid_size", + "name": "enterprise_value", "type": "int", - "description": "The size of the last bid price. Bid price and size is not always available.", + "description": "Enterprise value.", "default": null, "optional": true }, { - "name": "bid_price", + "name": "overall_risk", "type": "float", - "description": "The last bid price. Bid price and size is not always available.", + "description": "Overall risk score.", "default": null, "optional": true }, { - "name": "ask_price", + "name": "audit_risk", "type": "float", - "description": "The last ask price. Ask price and size is not always available.", + "description": "Audit risk score.", "default": null, "optional": true }, { - "name": "ask_size", - "type": "int", - "description": "The size of the last ask price. Ask price and size is not always available.", + "name": "board_risk", + "type": "float", + "description": "Board risk score.", "default": null, "optional": true }, { - "name": "last_bid_timestamp", - "type": "datetime", - "description": "The timestamp of the last bid price. Bid price and size is not always available.", + "name": "compensation_risk", + "type": "float", + "description": "Compensation risk score.", "default": null, "optional": true }, { - "name": "last_ask_timestamp", - "type": "datetime", - "description": "The timestamp of the last ask price. Ask price and size is not always available.", - "default": null, - "optional": true - } - ], - "polygon": [ - { - "name": "vwap", + "name": "shareholder_rights_risk", "type": "float", - "description": "The volume weighted average price of the stock on the current trading day.", + "description": "Shareholder rights risk score.", "default": null, "optional": true }, { - "name": "prev_open", + "name": "beta", "type": "float", - "description": "The previous trading session opening price.", + "description": "Beta relative to the broad market (5-year monthly).", "default": null, "optional": true }, { - "name": "prev_high", + "name": "price_return_1y", "type": "float", - "description": "The previous trading session high price.", + "description": "One-year price return, as a normalized percent.", "default": null, "optional": true }, { - "name": "prev_low", - "type": "float", - "description": "The previous trading session low price.", + "name": "currency", + "type": "str", + "description": "Currency in which the data is presented.", "default": null, "optional": true + } + ] + }, + "model": "KeyMetrics" + }, + "/equity/fundamental/management": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get executive management team data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.management(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "prev_volume", - "type": "float", - "description": "The previous trading session volume.", - "default": null, + "name": "provider", + "type": "Literal['fmp', 'yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true + } + ], + "fmp": [], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[KeyExecutives]", + "description": "Serializable results." }, { - "name": "prev_vwap", - "type": "float", - "description": "The previous trading session VWAP.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp', 'yfinance']]", + "description": "Provider name." }, { - "name": "last_updated", - "type": "datetime", - "description": "The last time the data was updated.", + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "title", + "type": "str", + "description": "Designation of the key executive.", "default": "", "optional": false }, { - "name": "bid", - "type": "float", - "description": "The current bid price.", - "default": null, - "optional": true - }, - { - "name": "bid_size", - "type": "int", - "description": "The current bid size.", - "default": null, - "optional": true + "name": "name", + "type": "str", + "description": "Name of the key executive.", + "default": "", + "optional": false }, { - "name": "ask_size", + "name": "pay", "type": "int", - "description": "The current ask size.", - "default": null, - "optional": true - }, - { - "name": "ask", - "type": "float", - "description": "The current ask price.", + "description": "Pay of the key executive.", "default": null, "optional": true }, { - "name": "quote_timestamp", - "type": "datetime", - "description": "The timestamp of the last quote.", + "name": "currency_pay", + "type": "str", + "description": "Currency of the pay.", "default": null, "optional": true }, { - "name": "last_trade_price", - "type": "float", - "description": "The last trade price.", + "name": "gender", + "type": "str", + "description": "Gender of the key executive.", "default": null, "optional": true }, { - "name": "last_trade_size", + "name": "year_born", "type": "int", - "description": "The last trade size.", + "description": "Birth year of the key executive.", "default": null, "optional": true }, { - "name": "last_trade_conditions", - "type": "List[int]", - "description": "The last trade condition codes.", + "name": "title_since", + "type": "int", + "description": "Date the tile was held since.", "default": null, "optional": true - }, + } + ], + "fmp": [], + "yfinance": [ { - "name": "last_trade_exchange", + "name": "exercised_value", "type": "int", - "description": "The last trade exchange ID code.", + "description": "Value of shares exercised.", "default": null, "optional": true }, { - "name": "last_trade_timestamp", - "type": "datetime", - "description": "The last trade timestamp.", + "name": "unexercised_value", + "type": "int", + "description": "Value of shares not exercised.", "default": null, "optional": true } ] }, - "model": "MarketSnapshots" + "model": "KeyExecutives" }, - "/etf/discovery/gainers": { + "/equity/fundamental/management_compensation": { "deprecated": { "flag": null, "message": null }, - "description": "Get the top ETF gainers.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the top ETF gainers.\nobb.etf.discovery.gainers(provider='wsj')\n```\n\n", + "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": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", - "default": "desc", - "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 10, - "optional": true + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false }, { "name": "provider", - "type": "Literal['wsj']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'wsj' if there is no default.", - "default": "wsj", + "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 } ], - "wsj": [] + "fmp": [ + { + "name": "year", + "type": "int", + "description": "Year of the compensation.", + "default": null, + "optional": true + } + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[ETFGainers]", + "type": "List[ExecutiveCompensation]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['wsj']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -25499,159 +14909,145 @@ "optional": false }, { - "name": "name", + "name": "cik", "type": "str", - "description": "Name of the entity.", - "default": "", - "optional": false - }, - { - "name": "last_price", - "type": "float", - "description": "Last price.", - "default": "", - "optional": false + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true }, { - "name": "percent_change", - "type": "float", - "description": "Percent change.", - "default": "", - "optional": false + "name": "company_name", + "type": "str", + "description": "The name of the company.", + "default": null, + "optional": true }, { - "name": "net_change", - "type": "float", - "description": "Net change.", - "default": "", - "optional": false + "name": "industry", + "type": "str", + "description": "The industry of the company.", + "default": null, + "optional": true }, { - "name": "volume", - "type": "float", - "description": "The trading volume.", - "default": "", - "optional": false + "name": "year", + "type": "int", + "description": "Year of the compensation.", + "default": null, + "optional": true }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - } - ], - "wsj": [ - { - "name": "bluegrass_channel", + "name": "name_and_position", "type": "str", - "description": "Bluegrass channel.", + "description": "Name and position.", "default": null, "optional": true }, { - "name": "country", - "type": "str", - "description": "Country of the entity.", - "default": "", - "optional": false + "name": "salary", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Salary.", + "default": null, + "optional": true }, { - "name": "mantissa", - "type": "int", - "description": "Mantissa.", - "default": "", - "optional": false + "name": "bonus", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Bonus payments.", + "default": null, + "optional": true }, { - "name": "type", - "type": "str", - "description": "Type of the entity.", - "default": "", - "optional": false + "name": "stock_award", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Stock awards.", + "default": null, + "optional": true }, { - "name": "formatted_price", - "type": "str", - "description": "Formatted price.", - "default": "", - "optional": false + "name": "incentive_plan_compensation", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Incentive plan compensation.", + "default": null, + "optional": true }, { - "name": "formatted_volume", - "type": "str", - "description": "Formatted volume.", - "default": "", - "optional": false + "name": "all_other_compensation", + "type": "Annotated[float, Ge(ge=0)]", + "description": "All other compensation.", + "default": null, + "optional": true }, { - "name": "formatted_price_change", - "type": "str", - "description": "Formatted price change.", - "default": "", - "optional": false + "name": "total", + "type": "Annotated[float, Ge(ge=0)]", + "description": "Total compensation.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "filing_date", + "type": "date", + "description": "Date of the filing.", + "default": null, + "optional": true }, { - "name": "formatted_percent_change", - "type": "str", - "description": "Formatted percent change.", - "default": "", - "optional": false + "name": "accepted_date", + "type": "datetime", + "description": "Date the filing was accepted.", + "default": null, + "optional": true }, { "name": "url", "type": "str", - "description": "The source url.", - "default": "", - "optional": false + "description": "URL to the filing data.", + "default": null, + "optional": true } ] }, - "model": "ETFGainers" + "model": "ExecutiveCompensation" }, - "/etf/discovery/losers": { + "/equity/fundamental/overview": { "deprecated": { - "flag": null, - "message": null + "flag": true, + "message": "This endpoint is deprecated; use `/equity/profile` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.3." }, - "description": "Get the top ETF losers.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the top ETF losers.\nobb.etf.discovery.losers(provider='wsj')\n```\n\n", + "description": "Get company general business and stock data for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.overview(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", - "default": "desc", - "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 10, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { "name": "provider", - "type": "Literal['wsj']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'wsj' if there is no default.", - "default": "wsj", + "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 } ], - "wsj": [] + "fmp": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[ETFLosers]", + "type": "List[CompanyOverview]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['wsj']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -25681,310 +15077,288 @@ "optional": false }, { - "name": "name", - "type": "str", - "description": "Name of the entity.", - "default": "", - "optional": false + "name": "price", + "type": "float", + "description": "Price of the company.", + "default": null, + "optional": true }, { - "name": "last_price", + "name": "beta", "type": "float", - "description": "Last price.", - "default": "", - "optional": false + "description": "Beta of the company.", + "default": null, + "optional": true }, { - "name": "percent_change", - "type": "float", - "description": "Percent change.", - "default": "", - "optional": false + "name": "vol_avg", + "type": "int", + "description": "Volume average of the company.", + "default": null, + "optional": true }, { - "name": "net_change", - "type": "float", - "description": "Net change.", - "default": "", - "optional": false + "name": "mkt_cap", + "type": "int", + "description": "Market capitalization of the company.", + "default": null, + "optional": true }, { - "name": "volume", + "name": "last_div", "type": "float", - "description": "The trading volume.", - "default": "", - "optional": false + "description": "Last dividend of the company.", + "default": null, + "optional": true }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - } - ], - "wsj": [ - { - "name": "bluegrass_channel", + "name": "range", "type": "str", - "description": "Bluegrass channel.", + "description": "Range of the company.", "default": null, "optional": true }, { - "name": "country", - "type": "str", - "description": "Country of the entity.", - "default": "", - "optional": false + "name": "changes", + "type": "float", + "description": "Changes of the company.", + "default": null, + "optional": true }, { - "name": "mantissa", - "type": "int", - "description": "Mantissa.", - "default": "", - "optional": false + "name": "company_name", + "type": "str", + "description": "Company name of the company.", + "default": null, + "optional": true }, { - "name": "type", + "name": "currency", "type": "str", - "description": "Type of the entity.", - "default": "", - "optional": false + "description": "Currency of the company.", + "default": null, + "optional": true }, { - "name": "formatted_price", + "name": "cik", "type": "str", - "description": "Formatted price.", - "default": "", - "optional": false + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true }, { - "name": "formatted_volume", + "name": "isin", "type": "str", - "description": "Formatted volume.", - "default": "", - "optional": false + "description": "ISIN of the company.", + "default": null, + "optional": true }, { - "name": "formatted_price_change", + "name": "cusip", "type": "str", - "description": "Formatted price change.", - "default": "", - "optional": false + "description": "CUSIP of the company.", + "default": null, + "optional": true }, { - "name": "formatted_percent_change", + "name": "exchange", "type": "str", - "description": "Formatted percent change.", - "default": "", - "optional": false + "description": "Exchange of the company.", + "default": null, + "optional": true }, { - "name": "url", + "name": "exchange_short_name", "type": "str", - "description": "The source url.", - "default": "", - "optional": false - } - ] - }, - "model": "ETFLosers" - }, - "/etf/discovery/active": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the most active ETFs.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the most active ETFs.\nobb.etf.discovery.active(provider='wsj')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", - "default": "desc", + "description": "Exchange short name of the company.", + "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 10, + "name": "industry", + "type": "str", + "description": "Industry of the company.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['wsj']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'wsj' if there is no default.", - "default": "wsj", + "name": "website", + "type": "str", + "description": "Website of the company.", + "default": null, "optional": true - } - ], - "wsj": [] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[ETFActive]", - "description": "Serializable results." + "name": "description", + "type": "str", + "description": "Description of the company.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['wsj']]", - "description": "Provider name." + "name": "ceo", + "type": "str", + "description": "CEO of the company.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "sector", + "type": "str", + "description": "Sector of the company.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "country", + "type": "str", + "description": "Country of the company.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "full_time_employees", + "type": "str", + "description": "Full time employees of the company.", + "default": null, + "optional": true + }, { - "name": "symbol", + "name": "phone", "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "description": "Phone of the company.", + "default": null, + "optional": true }, { - "name": "name", + "name": "address", "type": "str", - "description": "Name of the entity.", - "default": "", - "optional": false + "description": "Address of the company.", + "default": null, + "optional": true }, { - "name": "last_price", - "type": "float", - "description": "Last price.", - "default": "", - "optional": false + "name": "city", + "type": "str", + "description": "City of the company.", + "default": null, + "optional": true }, { - "name": "percent_change", - "type": "float", - "description": "Percent change.", - "default": "", - "optional": false + "name": "state", + "type": "str", + "description": "State of the company.", + "default": null, + "optional": true }, { - "name": "net_change", - "type": "float", - "description": "Net change.", - "default": "", - "optional": false + "name": "zip", + "type": "str", + "description": "Zip of the company.", + "default": null, + "optional": true }, { - "name": "volume", + "name": "dcf_diff", "type": "float", - "description": "The trading volume.", - "default": "", - "optional": false + "description": "Discounted cash flow difference of the company.", + "default": null, + "optional": true }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - } - ], - "wsj": [ - { - "name": "country", - "type": "str", - "description": "Country of the entity.", - "default": "", - "optional": false + "name": "dcf", + "type": "float", + "description": "Discounted cash flow of the company.", + "default": null, + "optional": true }, { - "name": "mantissa", - "type": "int", - "description": "Mantissa.", - "default": "", - "optional": false + "name": "image", + "type": "str", + "description": "Image of the company.", + "default": null, + "optional": true }, { - "name": "type", - "type": "str", - "description": "Type of the entity.", - "default": "", - "optional": false + "name": "ipo_date", + "type": "date", + "description": "IPO date of the company.", + "default": null, + "optional": true }, { - "name": "formatted_price", - "type": "str", - "description": "Formatted price.", + "name": "default_image", + "type": "bool", + "description": "If the image is the default image.", "default": "", "optional": false }, { - "name": "formatted_volume", - "type": "str", - "description": "Formatted volume.", + "name": "is_etf", + "type": "bool", + "description": "If the company is an ETF.", "default": "", "optional": false }, { - "name": "formatted_price_change", - "type": "str", - "description": "Formatted price change.", + "name": "is_actively_trading", + "type": "bool", + "description": "If the company is actively trading.", "default": "", "optional": false }, { - "name": "formatted_percent_change", - "type": "str", - "description": "Formatted percent change.", + "name": "is_adr", + "type": "bool", + "description": "If the company is an ADR.", "default": "", "optional": false }, { - "name": "url", - "type": "str", - "description": "The source url.", + "name": "is_fund", + "type": "bool", + "description": "If the company is a fund.", "default": "", "optional": false } - ] + ], + "fmp": [] }, - "model": "ETFActive" + "model": "CompanyOverview" }, - "/etf/search": { + "/equity/fundamental/ratios": { "deprecated": { "flag": null, "message": null }, - "description": "Search for ETFs.\n\nAn empty query returns the full list of ETFs from the provider.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# An empty query returns the full list of ETFs from the provider.\nobb.etf.search(provider='fmp')\n# The query will return results from text-based fields containing the term.\nobb.etf.search(query='commercial real estate', provider='fmp')\n```\n\n", + "description": "Get 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": "query", + "name": "symbol", "type": "str", - "description": "Search query.", + "description": "Symbol to get data for.", "default": "", + "optional": false + }, + { + "name": "period", + "type": "str", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 12, "optional": true }, { "name": "provider", - "type": "Literal['fmp', 'intrinio', 'tmx']", + "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 @@ -25992,50 +15366,27 @@ ], "fmp": [ { - "name": "exchange", - "type": "Literal['AMEX', 'NYSE', 'NASDAQ', 'ETF', 'TSX', 'EURONEXT']", - "description": "The exchange code the ETF trades on.", - "default": null, - "optional": true - }, - { - "name": "is_active", - "type": "Literal[True, False]", - "description": "Whether the ETF is actively trading.", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm']", + "description": "Time period of the data to return.", + "default": "annual", "optional": true } ], "intrinio": [ { - "name": "exchange", - "type": "Literal['xnas', 'arcx', 'bats', 'xnys', 'bvmf', 'xshg', 'xshe', 'xhkg', 'xbom', 'xnse', 'xidx', 'tase', 'xkrx', 'xkls', 'xmex', 'xses', 'roco', 'xtai', 'xbkk', 'xist']", - "description": "Target a specific exchange by providing the MIC code.", - "default": null, - "optional": true - } - ], - "tmx": [ - { - "name": "div_freq", - "type": "Literal['monthly', 'annually', 'quarterly']", - "description": "The dividend payment frequency.", - "default": null, + "name": "period", + "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", + "description": "Time period of the data to return.", + "default": "annual", "optional": true }, { - "name": "sort_by", - "type": "Literal['nav', 'return_1m', 'return_3m', 'return_6m', 'return_1y', 'return_3y', 'return_ytd', 'beta_1y', 'volume_avg_daily', 'management_fee', 'distribution_yield', 'pb_ratio', 'pe_ratio']", - "description": "The column to sort by.", + "name": "fiscal_year", + "type": "int", + "description": "The specific fiscal year. Reports do not go beyond 2008.", "default": null, "optional": true - }, - { - "name": "use_cache", - "type": "bool", - "description": "Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours.", - "default": true, - "optional": true } ] }, @@ -26043,12 +15394,12 @@ "OBBject": [ { "name": "results", - "type": "List[EtfSearch]", + "type": "List[FinancialRatios]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'tmx']]", + "type": "Optional[Literal['fmp', 'intrinio']]", "description": "Provider name." }, { @@ -26071,649 +15422,586 @@ "data": { "standard": [ { - "name": "symbol", + "name": "period_ending", "type": "str", - "description": "Symbol representing the entity requested in the data.(ETF)", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "name", + "name": "fiscal_period", "type": "str", - "description": "Name of the ETF.", + "description": "Period of the financial ratios.", + "default": "", + "optional": false + }, + { + "name": "fiscal_year", + "type": "int", + "description": "Fiscal year.", "default": null, "optional": true } ], "fmp": [ { - "name": "market_cap", + "name": "current_ratio", "type": "float", - "description": "The market cap of the ETF.", - "default": null, - "optional": true - }, - { - "name": "sector", - "type": "str", - "description": "The sector of the ETF.", - "default": null, - "optional": true - }, - { - "name": "industry", - "type": "str", - "description": "The industry of the ETF.", + "description": "Current ratio.", "default": null, "optional": true }, { - "name": "beta", + "name": "quick_ratio", "type": "float", - "description": "The beta of the ETF.", + "description": "Quick ratio.", "default": null, "optional": true }, { - "name": "price", + "name": "cash_ratio", "type": "float", - "description": "The current price of the ETF.", + "description": "Cash ratio.", "default": null, "optional": true }, { - "name": "last_annual_dividend", + "name": "days_of_sales_outstanding", "type": "float", - "description": "The last annual dividend paid.", + "description": "Days of sales outstanding.", "default": null, "optional": true }, { - "name": "volume", + "name": "days_of_inventory_outstanding", "type": "float", - "description": "The current trading volume of the ETF.", - "default": null, - "optional": true - }, - { - "name": "exchange", - "type": "str", - "description": "The exchange code the ETF trades on.", - "default": null, - "optional": true - }, - { - "name": "exchange_name", - "type": "str", - "description": "The full name of the exchange the ETF trades on.", - "default": null, - "optional": true - }, - { - "name": "country", - "type": "str", - "description": "The country the ETF is registered in.", + "description": "Days of inventory outstanding.", "default": null, "optional": true }, { - "name": "actively_trading", - "type": "Literal[True, False]", - "description": "Whether the ETF is actively trading.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "exchange", - "type": "str", - "description": "The exchange MIC code.", + "name": "operating_cycle", + "type": "float", + "description": "Operating cycle.", "default": null, "optional": true }, { - "name": "figi_ticker", - "type": "str", - "description": "The OpenFIGI ticker.", + "name": "days_of_payables_outstanding", + "type": "float", + "description": "Days of payables outstanding.", "default": null, "optional": true }, { - "name": "ric", - "type": "str", - "description": "The Reuters Instrument Code.", + "name": "cash_conversion_cycle", + "type": "float", + "description": "Cash conversion cycle.", "default": null, "optional": true }, { - "name": "isin", - "type": "str", - "description": "The International Securities Identification Number.", + "name": "gross_profit_margin", + "type": "float", + "description": "Gross profit margin.", "default": null, "optional": true }, { - "name": "sedol", - "type": "str", - "description": "The Stock Exchange Daily Official List.", + "name": "operating_profit_margin", + "type": "float", + "description": "Operating profit margin.", "default": null, "optional": true }, { - "name": "intrinio_id", - "type": "str", - "description": "The unique Intrinio ID for the security.", - "default": null, - "optional": true - } - ], - "tmx": [ - { - "name": "short_name", - "type": "str", - "description": "The short name of the ETF.", + "name": "pretax_profit_margin", + "type": "float", + "description": "Pretax profit margin.", "default": null, "optional": true }, { - "name": "inception_date", - "type": "str", - "description": "The inception date of the ETF.", + "name": "net_profit_margin", + "type": "float", + "description": "Net profit margin.", "default": null, "optional": true }, { - "name": "issuer", - "type": "str", - "description": "The issuer of the ETF.", + "name": "effective_tax_rate", + "type": "float", + "description": "Effective tax rate.", "default": null, "optional": true }, { - "name": "investment_style", - "type": "str", - "description": "The investment style of the ETF.", + "name": "return_on_assets", + "type": "float", + "description": "Return on assets.", "default": null, "optional": true }, { - "name": "esg", - "type": "bool", - "description": "Whether the ETF qualifies as an ESG fund.", + "name": "return_on_equity", + "type": "float", + "description": "Return on equity.", "default": null, "optional": true }, { - "name": "currency", - "type": "str", - "description": "The currency of the ETF.", - "default": "", - "optional": false - }, - { - "name": "unit_price", + "name": "return_on_capital_employed", "type": "float", - "description": "The unit price of the ETF.", + "description": "Return on capital employed.", "default": null, "optional": true }, { - "name": "close", + "name": "net_income_per_ebt", "type": "float", - "description": "The closing price of the ETF.", - "default": "", - "optional": false + "description": "Net income per EBT.", + "default": null, + "optional": true }, { - "name": "prev_close", + "name": "ebt_per_ebit", "type": "float", - "description": "The previous closing price of the ETF.", + "description": "EBT per EBIT.", "default": null, "optional": true }, { - "name": "return_1m", + "name": "ebit_per_revenue", "type": "float", - "description": "The one-month return of the ETF, as a normalized percent.", + "description": "EBIT per revenue.", "default": null, "optional": true }, { - "name": "return_3m", + "name": "debt_ratio", "type": "float", - "description": "The three-month return of the ETF, as a normalized percent.", + "description": "Debt ratio.", "default": null, "optional": true }, { - "name": "return_6m", + "name": "debt_equity_ratio", "type": "float", - "description": "The six-month return of the ETF, as a normalized percent.", + "description": "Debt equity ratio.", "default": null, "optional": true }, { - "name": "return_ytd", + "name": "long_term_debt_to_capitalization", "type": "float", - "description": "The year-to-date return of the ETF, as a normalized percent.", + "description": "Long term debt to capitalization.", "default": null, "optional": true }, { - "name": "return_1y", + "name": "total_debt_to_capitalization", "type": "float", - "description": "The one-year return of the ETF, as a normalized percent.", + "description": "Total debt to capitalization.", "default": null, "optional": true }, { - "name": "beta_1y", + "name": "interest_coverage", "type": "float", - "description": "The one-year beta of the ETF, as a normalized percent.", + "description": "Interest coverage.", "default": null, "optional": true }, { - "name": "return_3y", + "name": "cash_flow_to_debt_ratio", "type": "float", - "description": "The three-year return of the ETF, as a normalized percent.", + "description": "Cash flow to debt ratio.", "default": null, "optional": true }, { - "name": "beta_3y", + "name": "company_equity_multiplier", "type": "float", - "description": "The three-year beta of the ETF, as a normalized percent.", + "description": "Company equity multiplier.", "default": null, "optional": true }, { - "name": "return_5y", + "name": "receivables_turnover", "type": "float", - "description": "The five-year return of the ETF, as a normalized percent.", + "description": "Receivables turnover.", "default": null, "optional": true }, { - "name": "beta_5y", + "name": "payables_turnover", "type": "float", - "description": "The five-year beta of the ETF, as a normalized percent.", + "description": "Payables turnover.", "default": null, "optional": true }, { - "name": "return_10y", + "name": "inventory_turnover", "type": "float", - "description": "The ten-year return of the ETF, as a normalized percent.", + "description": "Inventory turnover.", "default": null, "optional": true }, { - "name": "beta_10y", + "name": "fixed_asset_turnover", "type": "float", - "description": "The ten-year beta of the ETF.", + "description": "Fixed asset turnover.", "default": null, "optional": true }, { - "name": "beta_15y", + "name": "asset_turnover", "type": "float", - "description": "The fifteen-year beta of the ETF.", + "description": "Asset turnover.", "default": null, "optional": true }, { - "name": "return_from_inception", + "name": "operating_cash_flow_per_share", "type": "float", - "description": "The return from inception of the ETF, as a normalized percent.", + "description": "Operating cash flow per share.", "default": null, "optional": true }, { - "name": "avg_volume", - "type": "int", - "description": "The average daily volume of the ETF.", + "name": "free_cash_flow_per_share", + "type": "float", + "description": "Free cash flow per share.", "default": null, "optional": true }, { - "name": "avg_volume_30d", - "type": "int", - "description": "The 30-day average volume of the ETF.", + "name": "cash_per_share", + "type": "float", + "description": "Cash per share.", "default": null, "optional": true }, { - "name": "aum", + "name": "payout_ratio", "type": "float", - "description": "The AUM of the ETF.", + "description": "Payout ratio.", "default": null, "optional": true }, { - "name": "pe_ratio", + "name": "operating_cash_flow_sales_ratio", "type": "float", - "description": "The price-to-earnings ratio of the ETF.", + "description": "Operating cash flow sales ratio.", "default": null, "optional": true }, { - "name": "pb_ratio", + "name": "free_cash_flow_operating_cash_flow_ratio", "type": "float", - "description": "The price-to-book ratio of the ETF.", + "description": "Free cash flow operating cash flow ratio.", "default": null, "optional": true }, { - "name": "management_fee", + "name": "cash_flow_coverage_ratios", "type": "float", - "description": "The management fee of the ETF, as a normalized percent.", + "description": "Cash flow coverage ratios.", "default": null, "optional": true }, { - "name": "mer", + "name": "short_term_coverage_ratios", "type": "float", - "description": "The management expense ratio of the ETF, as a normalized percent.", + "description": "Short term coverage ratios.", "default": null, "optional": true }, { - "name": "distribution_yield", + "name": "capital_expenditure_coverage_ratio", "type": "float", - "description": "The distribution yield of the ETF, as a normalized percent.", + "description": "Capital expenditure coverage ratio.", "default": null, "optional": true }, { - "name": "dividend_frequency", - "type": "str", - "description": "The dividend payment frequency of the ETF.", + "name": "dividend_paid_and_capex_coverage_ratio", + "type": "float", + "description": "Dividend paid and capex coverage ratio.", "default": null, "optional": true - } - ] - }, - "model": "EtfSearch" - }, - "/etf/historical": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "ETF Historical Market Price.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.historical(symbol='SPY', provider='fmp')\nobb.etf.historical(symbol='SPY', provider='yfinance')\n# This function accepts multiple tickers.\nobb.etf.historical(symbol='SPY,IWM,QQQ,DJIA', provider='yfinance')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance.", - "default": "", - "optional": false }, { - "name": "interval", - "type": "str", - "description": "Time interval of the data to return.", - "default": "1d", + "name": "dividend_payout_ratio", + "type": "float", + "description": "Dividend payout ratio.", + "default": null, "optional": true }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "price_book_value_ratio", + "type": "float", + "description": "Price book value ratio.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "price_to_book_ratio", + "type": "float", + "description": "Price to book ratio.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default.", - "default": "alpha_vantage", - "optional": true - } - ], - "alpha_vantage": [ - { - "name": "interval", - "type": "Literal['1m', '5m', '15m', '30m', '60m', '1d', '1W', '1M']", - "description": "Time interval of the data to return.", - "default": "1d", + "name": "price_to_sales_ratio", + "type": "float", + "description": "Price to sales ratio.", + "default": null, "optional": true }, { - "name": "adjustment", - "type": "Literal['splits_only', 'splits_and_dividends', 'unadjusted']", - "description": "The adjustment factor to apply. 'splits_only' is not supported for intraday data.", - "default": "splits_only", + "name": "price_earnings_ratio", + "type": "float", + "description": "Price earnings ratio.", + "default": null, "optional": true }, { - "name": "extended_hours", - "type": "bool", - "description": "Include Pre and Post market data.", - "default": false, + "name": "price_to_free_cash_flows_ratio", + "type": "float", + "description": "Price to free cash flows ratio.", + "default": null, "optional": true }, { - "name": "adjusted", - "type": "bool", - "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead.", - "default": false, + "name": "price_to_operating_cash_flows_ratio", + "type": "float", + "description": "Price to operating cash flows ratio.", + "default": null, "optional": true - } - ], - "cboe": [ + }, { - "name": "interval", - "type": "Literal['1m', '1d']", - "description": "Time interval of the data to return. The most recent trading day is not including in daily historical data. Intraday data is only available for the most recent trading day at 1 minute intervals.", - "default": "1d", + "name": "price_cash_flow_ratio", + "type": "float", + "description": "Price cash flow ratio.", + "default": null, "optional": true }, { - "name": "use_cache", - "type": "bool", - "description": "When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass.", - "default": true, + "name": "price_earnings_to_growth_ratio", + "type": "float", + "description": "Price earnings to growth ratio.", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "interval", - "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", - "description": "Time interval of the data to return.", - "default": "1d", + "name": "price_sales_ratio", + "type": "float", + "description": "Price sales ratio.", + "default": null, "optional": true - } - ], - "intrinio": [ - { - "name": "symbol", - "type": "str", - "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", - "default": "", - "optional": false }, { - "name": "interval", - "type": "Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y']", - "description": "Time interval of the data to return.", - "default": "1d", + "name": "dividend_yield", + "type": "float", + "description": "Dividend yield.", + "default": null, "optional": true }, { - "name": "start_time", - "type": "datetime.time", - "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'.", + "name": "dividend_yield_percentage", + "type": "float", + "description": "Dividend yield percentage.", "default": null, "optional": true }, { - "name": "end_time", - "type": "datetime.time", - "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'.", + "name": "dividend_per_share", + "type": "float", + "description": "Dividend per share.", "default": null, "optional": true }, { - "name": "timezone", - "type": "str", - "description": "Timezone of the data, in the IANA format (Continent/City).", - "default": "America/New_York", + "name": "enterprise_value_multiple", + "type": "float", + "description": "Enterprise value multiple.", + "default": null, "optional": true }, { - "name": "source", - "type": "Literal['realtime', 'delayed', 'nasdaq_basic']", - "description": "The source of the data.", - "default": "realtime", + "name": "price_fair_value", + "type": "float", + "description": "Price fair value.", + "default": null, "optional": true } ], - "polygon": [ + "intrinio": [] + }, + "model": "FinancialRatios" + }, + "/equity/fundamental/revenue_per_geography": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the revenue geographic breakdown for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.revenue_per_geography(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.revenue_per_geography(symbol='AAPL', period='annual', structure='flat', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "interval", + "name": "symbol", "type": "str", - "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", - "default": "1d", - "optional": true - }, - { - "name": "adjustment", - "type": "Literal['splits_only', 'unadjusted']", - "description": "The adjustment factor to apply. Default is splits only.", - "default": "splits_only", - "optional": true - }, - { - "name": "extended_hours", - "type": "bool", - "description": "Include Pre and Post market data.", - "default": false, - "optional": true + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", - "default": "asc", + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return.", + "default": "annual", "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 49999, + "name": "structure", + "type": "Literal['hierarchical', 'flat']", + "description": "Structure of the returned data.", + "default": "flat", "optional": true - } - ], - "tiingo": [ + }, { - "name": "interval", - "type": "Literal['1d', '1W', '1M', '1Y']", - "description": "Time interval of the data to return.", - "default": "1d", + "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 } ], - "tmx": [ + "fmp": [] + }, + "returns": { + "OBBject": [ { - "name": "interval", - "type": "Union[Literal['1m', '2m', '5m', '15m', '30m', '60m', '1h', '1d', '1W', '1M'], str, int]", - "description": "Time interval of the data to return. Or, any integer (entered as a string) representing the number of minutes. Default is daily data. There is no extended hours data, and intraday data is limited to after April 12 2022.", - "default": "day", - "optional": true + "name": "results", + "type": "List[RevenueGeographic]", + "description": "Serializable results." }, { - "name": "adjustment", - "type": "Literal['splits_only', 'splits_and_dividends', 'unadjusted']", - "description": "The adjustment factor to apply. Only valid for daily data.", - "default": "splits_only", - "optional": true - } - ], - "tradier": [ + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, { - "name": "interval", - "type": "Literal['1m', '5m', '15m', '1d', '1W', '1M']", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "extended_hours", - "type": "bool", - "description": "Include Pre and Post market data.", - "default": false, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } - ], - "yfinance": [ + ] + }, + "data": { + "standard": [ { - "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", + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": "", + "optional": false + }, + { + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the reporting period.", + "default": null, "optional": true }, { - "name": "extended_hours", - "type": "bool", - "description": "Include Pre and Post market data.", - "default": false, + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the reporting period.", + "default": null, "optional": true }, { - "name": "include_actions", - "type": "bool", - "description": "Include dividends and stock splits in results.", - "default": true, + "name": "filing_date", + "type": "date", + "description": "The filing date of the report.", + "default": null, "optional": true }, { - "name": "adjustment", - "type": "Literal['splits_only', 'splits_and_dividends']", - "description": "The adjustment factor to apply. Default is splits only.", - "default": "splits_only", + "name": "geographic_segment", + "type": "int", + "description": "Dictionary of the revenue by geographic segment.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "RevenueGeographic" + }, + "/equity/fundamental/revenue_per_segment": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the revenue breakdown by business segment for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.revenue_per_segment(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.revenue_per_segment(symbol='AAPL', period='annual', structure='flat', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "period", + "type": "Literal['quarter', 'annual']", + "description": "Time period of the data to return.", + "default": "annual", "optional": true }, { - "name": "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, + "name": "structure", + "type": "Literal['hierarchical', 'flat']", + "description": "Structure of the returned data.", + "default": "flat", "optional": true }, { - "name": "prepost", - "type": "bool", - "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead.", - "default": false, + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true } - ] + ], + "fmp": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EtfHistorical]", + "type": "List[RevenueBusinessLine]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -26736,417 +16024,493 @@ "data": { "standard": [ { - "name": "date", - "type": "Union[date, datetime]", - "description": "The date of the data.", + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", "default": "", "optional": false }, { - "name": "open", - "type": "float", - "description": "The open price.", - "default": "", - "optional": false + "name": "fiscal_period", + "type": "str", + "description": "The fiscal period of the reporting period.", + "default": null, + "optional": true }, { - "name": "high", - "type": "float", - "description": "The high price.", - "default": "", - "optional": false + "name": "fiscal_year", + "type": "int", + "description": "The fiscal year of the reporting period.", + "default": null, + "optional": true }, { - "name": "low", - "type": "float", - "description": "The low price.", - "default": "", - "optional": false + "name": "filing_date", + "type": "date", + "description": "The filing date of the report.", + "default": null, + "optional": true }, { - "name": "close", - "type": "float", - "description": "The close price.", + "name": "business_line", + "type": "int", + "description": "Dictionary containing the revenue of the business line.", "default": "", "optional": false - }, + } + ], + "fmp": [] + }, + "model": "RevenueBusinessLine" + }, + "/equity/fundamental/filings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more. SEC\nfilings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114,\nForeign Investment Disclosures and others. The annual 10-K report is required to be\nfiled annually and includes the company's financial statements, management discussion and analysis,\nand audited financial statements.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.filings(provider='fmp')\nobb.equity.fundamental.filings(limit=100, provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "volume", - "type": "Union[float, int]", - "description": "The trading volume.", + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", "default": null, "optional": true }, { - "name": "vwap", - "type": "float", - "description": "Volume Weighted Average Price over the period.", + "name": "form_type", + "type": "str", + "description": "Filter by form type. Check the data provider for available types.", "default": null, "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 100, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true } ], - "alpha_vantage": [ + "fmp": [], + "intrinio": [ { - "name": "adj_close", - "type": "Annotated[float, Gt(gt=0)]", - "description": "The adjusted close price.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "dividend", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Dividend amount, if a dividend was paid.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "split_ratio", - "type": "Annotated[float, Ge(ge=0)]", - "description": "Split coefficient, if a split occurred.", + "name": "thea_enabled", + "type": "bool", + "description": "Return filings that have been read by Intrinio's Thea NLP.", "default": null, "optional": true } ], - "cboe": [ + "sec": [ { - "name": "calls_volume", - "type": "int", - "description": "Number of calls traded during the most recent trading period. Only valid if interval is 1m.", + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", "default": null, "optional": true }, { - "name": "puts_volume", - "type": "int", - "description": "Number of puts traded during the most recent trading period. Only valid if interval is 1m.", + "name": "form_type", + "type": "Literal['1', '1-A', '1-A POS', '1-A-W', '1-E', '1-E AD', '1-K', '1-SA', '1-U', '1-Z', '1-Z-W', '10-12B', '10-12G', '10-D', '10-K', '10-KT', '10-Q', '10-QT', '11-K', '11-KT', '13F-HR', '13F-NT', '13FCONP', '144', '15-12B', '15-12G', '15-15D', '15F-12B', '15F-12G', '15F-15D', '18-12B', '18-K', '19B-4E', '2-A', '2-AF', '2-E', '20-F', '20FR12B', '20FR12G', '24F-2NT', '25', '25-NSE', '253G1', '253G2', '253G3', '253G4', '3', '305B2', '34-12H', '4', '40-17F1', '40-17F2', '40-17G', '40-17GCS', '40-202A', '40-203A', '40-206A', '40-24B2', '40-33', '40-6B', '40-8B25', '40-8F-2', '40-APP', '40-F', '40-OIP', '40FR12B', '40FR12G', '424A', '424B1', '424B2', '424B3', '424B4', '424B5', '424B7', '424B8', '424H', '425', '485APOS', '485BPOS', '485BXT', '486APOS', '486BPOS', '486BXT', '487', '497', '497AD', '497H2', '497J', '497K', '497VPI', '497VPU', '5', '6-K', '6B NTC', '6B ORDR', '8-A12B', '8-A12G', '8-K', '8-K12B', '8-K12G3', '8-K15D5', '8-M', '8F-2 NTC', '8F-2 ORDR', '9-M', 'ABS-15G', 'ABS-EE', 'ADN-MTL', 'ADV-E', 'ADV-H-C', 'ADV-H-T', 'ADV-NR', 'ANNLRPT', 'APP NTC', 'APP ORDR', 'APP WD', 'APP WDG', 'ARS', 'ATS-N', 'ATS-N-C', 'ATS-N/UA', 'AW', 'AW WD', 'C', 'C-AR', 'C-AR-W', 'C-TR', 'C-TR-W', 'C-U', 'C-U-W', 'C-W', 'CB', 'CERT', 'CERTARCA', 'CERTBATS', 'CERTCBO', 'CERTNAS', 'CERTNYS', 'CERTPAC', 'CFPORTAL', 'CFPORTAL-W', 'CORRESP', 'CT ORDER', 'D', 'DEF 14A', 'DEF 14C', 'DEFA14A', 'DEFA14C', 'DEFC14A', 'DEFC14C', 'DEFM14A', 'DEFM14C', 'DEFN14A', 'DEFR14A', 'DEFR14C', 'DEL AM', 'DFAN14A', 'DFRN14A', 'DOS', 'DOSLTR', 'DRS', 'DRSLTR', 'DSTRBRPT', 'EFFECT', 'F-1', 'F-10', 'F-10EF', 'F-10POS', 'F-1MEF', 'F-3', 'F-3ASR', 'F-3D', 'F-3DPOS', 'F-3MEF', 'F-4', 'F-4 POS', 'F-4MEF', 'F-6', 'F-6 POS', 'F-6EF', 'F-7', 'F-7 POS', 'F-8', 'F-8 POS', 'F-80', 'F-80POS', 'F-9', 'F-9 POS', 'F-N', 'F-X', 'FOCUSN', 'FWP', 'G-405', 'G-405N', 'G-FIN', 'G-FINW', 'IRANNOTICE', 'MA', 'MA-A', 'MA-I', 'MA-W', 'MSD', 'MSDCO', 'MSDW', 'N-1', 'N-14', 'N-14 8C', 'N-14MEF', 'N-18F1', 'N-1A', 'N-2', 'N-2 POSASR', 'N-23C-2', 'N-23C3A', 'N-23C3B', 'N-23C3C', 'N-2ASR', 'N-2MEF', 'N-30B-2', 'N-30D', 'N-4', 'N-5', 'N-54A', 'N-54C', 'N-6', 'N-6F', 'N-8A', 'N-8B-2', 'N-8F', 'N-8F NTC', 'N-8F ORDR', 'N-CEN', 'N-CR', 'N-CSR', 'N-CSRS', 'N-MFP', 'N-MFP1', 'N-MFP2', 'N-PX', 'N-Q', 'N-VP', 'N-VPFS', 'NO ACT', 'NPORT-EX', 'NPORT-NP', 'NPORT-P', 'NRSRO-CE', 'NRSRO-UPD', 'NSAR-A', 'NSAR-AT', 'NSAR-B', 'NSAR-BT', 'NSAR-U', 'NT 10-D', 'NT 10-K', 'NT 10-Q', 'NT 11-K', 'NT 20-F', 'NT N-CEN', 'NT N-MFP', 'NT N-MFP1', 'NT N-MFP2', 'NT NPORT-EX', 'NT NPORT-P', 'NT-NCEN', 'NT-NCSR', 'NT-NSAR', 'NTFNCEN', 'NTFNCSR', 'NTFNSAR', 'NTN 10D', 'NTN 10K', 'NTN 10Q', 'NTN 20F', 'OIP NTC', 'OIP ORDR', 'POS 8C', 'POS AM', 'POS AMI', 'POS EX', 'POS462B', 'POS462C', 'POSASR', 'PRE 14A', 'PRE 14C', 'PREC14A', 'PREC14C', 'PREM14A', 'PREM14C', 'PREN14A', 'PRER14A', 'PRER14C', 'PRRN14A', 'PX14A6G', 'PX14A6N', 'QRTLYRPT', 'QUALIF', 'REG-NR', 'REVOKED', 'RW', 'RW WD', 'S-1', 'S-11', 'S-11MEF', 'S-1MEF', 'S-20', 'S-3', 'S-3ASR', 'S-3D', 'S-3DPOS', 'S-3MEF', 'S-4', 'S-4 POS', 'S-4EF', 'S-4MEF', 'S-6', 'S-8', 'S-8 POS', 'S-B', 'S-BMEF', 'SBSE', 'SBSE-A', 'SBSE-BD', 'SBSE-C', 'SBSE-W', 'SC 13D', 'SC 13E1', 'SC 13E3', 'SC 13G', 'SC 14D9', 'SC 14F1', 'SC 14N', 'SC TO-C', 'SC TO-I', 'SC TO-T', 'SC13E4F', 'SC14D1F', 'SC14D9C', 'SC14D9F', 'SD', 'SDR', 'SE', 'SEC ACTION', 'SEC STAFF ACTION', 'SEC STAFF LETTER', 'SF-1', 'SF-3', 'SL', 'SP 15D2', 'STOP ORDER', 'SUPPL', 'T-3', 'TA-1', 'TA-2', 'TA-W', 'TACO', 'TH', 'TTW', 'UNDER', 'UPLOAD', 'WDL-REQ', 'X-17A-5']", + "description": "Type of the SEC filing form.", "default": null, "optional": true }, { - "name": "total_options_volume", - "type": "int", - "description": "Total number of options traded during the most recent trading period. Only valid if interval is 1m.", + "name": "cik", + "type": "Union[int, str]", + "description": "Lookup filings by Central Index Key (CIK) instead of by symbol.", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "adj_close", - "type": "float", - "description": "The adjusted close price.", - "default": null, + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache. If True, cache will store for one day.", + "default": true, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[CompanyFilings]", + "description": "Serializable results." }, { - "name": "unadjusted_volume", - "type": "float", - "description": "Unadjusted volume of the symbol.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'sec']]", + "description": "Provider name." }, { - "name": "change", - "type": "float", - "description": "Change in the price from the previous close.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "change_percent", - "type": "float", - "description": "Change in the price from the previous close, as a normalized percent.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } - ], - "intrinio": [ + ] + }, + "data": { + "standard": [ { - "name": "average", - "type": "float", - "description": "Average trade price of an individual equity during the interval.", - "default": null, - "optional": true + "name": "filing_date", + "type": "date", + "description": "The date of the filing.", + "default": "", + "optional": false }, { - "name": "change", - "type": "float", - "description": "Change in the price of the symbol from the previous day.", + "name": "accepted_date", + "type": "datetime", + "description": "Accepted date of the filing.", "default": null, "optional": true }, { - "name": "change_percent", - "type": "float", - "description": "Percent change in the price of the symbol from the previous day.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "adj_open", - "type": "float", - "description": "The adjusted open price.", + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", "default": null, "optional": true }, { - "name": "adj_high", - "type": "float", - "description": "The adjusted high price.", + "name": "report_type", + "type": "str", + "description": "Type of filing.", "default": null, "optional": true }, { - "name": "adj_low", - "type": "float", - "description": "The adjusted low price.", + "name": "filing_url", + "type": "str", + "description": "URL to the filing page.", "default": null, "optional": true }, { - "name": "adj_close", - "type": "float", - "description": "The adjusted close price.", - "default": null, - "optional": true + "name": "report_url", + "type": "str", + "description": "URL to the actual report.", + "default": "", + "optional": false + } + ], + "fmp": [], + "intrinio": [ + { + "name": "id", + "type": "str", + "description": "Intrinio ID of the filing.", + "default": "", + "optional": false }, { - "name": "adj_volume", - "type": "float", - "description": "The adjusted volume.", + "name": "period_end_date", + "type": "date", + "description": "Ending date of the fiscal period for the filing.", "default": null, "optional": true }, { - "name": "fifty_two_week_high", - "type": "float", - "description": "52 week high price for the symbol.", - "default": null, - "optional": true + "name": "sec_unique_id", + "type": "str", + "description": "SEC unique ID of the filing.", + "default": "", + "optional": false }, { - "name": "fifty_two_week_low", - "type": "float", - "description": "52 week low price for the symbol.", + "name": "instance_url", + "type": "str", + "description": "URL for the XBRL filing for the report.", "default": null, "optional": true }, { - "name": "factor", - "type": "float", - "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices.", + "name": "industry_group", + "type": "str", + "description": "Industry group of the company.", + "default": "", + "optional": false + }, + { + "name": "industry_category", + "type": "str", + "description": "Industry category of the company.", + "default": "", + "optional": false + } + ], + "sec": [ + { + "name": "report_date", + "type": "date", + "description": "The date of the filing.", "default": null, "optional": true }, { - "name": "split_ratio", - "type": "float", - "description": "Ratio of the equity split, if a split occurred.", + "name": "act", + "type": "Union[int, str]", + "description": "The SEC Act number.", "default": null, "optional": true }, { - "name": "dividend", - "type": "float", - "description": "Dividend amount, if a dividend was paid.", + "name": "items", + "type": "Union[str, float]", + "description": "The SEC Item numbers.", "default": null, "optional": true }, { - "name": "close_time", - "type": "datetime", - "description": "The timestamp that represents the end of the interval span.", + "name": "primary_doc_description", + "type": "str", + "description": "The description of the primary document.", "default": null, "optional": true }, { - "name": "interval", + "name": "primary_doc", "type": "str", - "description": "The data time frequency.", + "description": "The filename of the primary document.", "default": null, "optional": true }, { - "name": "intra_period", - "type": "bool", - "description": "If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period", + "name": "accession_number", + "type": "Union[int, str]", + "description": "The accession number.", "default": null, "optional": true - } - ], - "polygon": [ + }, { - "name": "transactions", - "type": "Annotated[int, Gt(gt=0)]", - "description": "Number of transactions for the symbol in the time period.", + "name": "file_number", + "type": "Union[int, str]", + "description": "The file number.", "default": null, "optional": true - } - ], - "tiingo": [ + }, { - "name": "adj_open", - "type": "float", - "description": "The adjusted open price.", + "name": "film_number", + "type": "Union[int, str]", + "description": "The film number.", "default": null, "optional": true }, { - "name": "adj_high", - "type": "float", - "description": "The adjusted high price.", + "name": "is_inline_xbrl", + "type": "Union[int, str]", + "description": "Whether the filing is an inline XBRL filing.", "default": null, "optional": true }, { - "name": "adj_low", - "type": "float", - "description": "The adjusted low price.", + "name": "is_xbrl", + "type": "Union[int, str]", + "description": "Whether the filing is an XBRL filing.", "default": null, "optional": true }, { - "name": "adj_close", - "type": "float", - "description": "The adjusted close price.", + "name": "size", + "type": "Union[int, str]", + "description": "The size of the filing.", "default": null, "optional": true }, { - "name": "adj_volume", - "type": "float", - "description": "The adjusted volume.", + "name": "complete_submission_url", + "type": "str", + "description": "The URL to the complete filing submission.", "default": null, "optional": true }, { - "name": "split_ratio", - "type": "float", - "description": "Ratio of the equity split, if a split occurred.", - "default": null, - "optional": true + "name": "filing_detail_url", + "type": "str", + "description": "The URL to the filing details.", + "default": null, + "optional": true + } + ] + }, + "model": "CompanyFilings" + }, + "/equity/fundamental/historical_splits": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical stock splits for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_splits(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "dividend", - "type": "float", - "description": "Dividend amount, if a dividend was paid.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true } ], - "tmx": [ + "fmp": [] + }, + "returns": { + "OBBject": [ { - "name": "vwap", - "type": "float", - "description": "Volume weighted average price for the day.", - "default": null, - "optional": true + "name": "results", + "type": "List[HistoricalSplits]", + "description": "Serializable results." }, { - "name": "change", - "type": "float", - "description": "Change in price.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "change_percent", - "type": "float", - "description": "Change in price, as a normalized percentage.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "transactions", - "type": "int", - "description": "Total number of transactions recorded.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "transactions_value", - "type": "float", - "description": "Nominal value of recorded transactions.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } - ], - "tradier": [ + ] + }, + "data": { + "standard": [ { - "name": "last_price", + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "numerator", "type": "float", - "description": "The last price of the equity.", + "description": "Numerator of the split.", "default": null, "optional": true - } - ], - "yfinance": [ + }, { - "name": "split_ratio", + "name": "denominator", "type": "float", - "description": "Ratio of the equity split, if a split occurred.", + "description": "Denominator of the split.", "default": null, "optional": true }, { - "name": "dividend", - "type": "float", - "description": "Dividend amount (split-adjusted), if a dividend was paid.", + "name": "split_ratio", + "type": "str", + "description": "Split ratio.", "default": null, "optional": true } - ] + ], + "fmp": [] }, - "model": "EtfHistorical" + "model": "HistoricalSplits" }, - "/etf/info": { + "/equity/fundamental/transcript": { "deprecated": { "flag": null, "message": null }, - "description": "ETF Information Overview.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.info(symbol='SPY', provider='fmp')\n# This function accepts multiple tickers.\nobb.etf.info(symbol='SPY,IWM,QQQ,DJIA', provider='fmp')\n```\n\n", + "description": "Get 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": "Union[str, List[str]]", - "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, intrinio, tmx, yfinance.", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "year", + "type": "int", + "description": "Year of the earnings call transcript.", "default": "", "optional": false }, { "name": "provider", - "type": "Literal['fmp', 'intrinio', 'tmx', 'yfinance']", + "type": "Literal['fmp']", "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", "default": "fmp", "optional": true } ], - "fmp": [], - "intrinio": [], - "tmx": [ - { - "name": "use_cache", - "type": "bool", - "description": "Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours.", - "default": true, - "optional": true - } - ], - "yfinance": [] + "fmp": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EtfInfo]", + "type": "List[EarningsCallTranscript]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'tmx', 'yfinance']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -27171,1376 +16535,1533 @@ { "name": "symbol", "type": "str", - "description": "Symbol representing the entity requested in the data. (ETF)", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "name", - "type": "str", - "description": "Name of the ETF.", + "name": "quarter", + "type": "int", + "description": "Quarter of the earnings call transcript.", "default": "", "optional": false }, { - "name": "description", - "type": "str", - "description": "Description of the fund.", - "default": null, - "optional": true - }, - { - "name": "inception_date", - "type": "str", - "description": "Inception date of the ETF.", + "name": "year", + "type": "int", + "description": "Year of the earnings call transcript.", "default": "", "optional": false - } - ], - "fmp": [ - { - "name": "issuer", - "type": "str", - "description": "Company of the ETF.", - "default": null, - "optional": true }, { - "name": "cusip", - "type": "str", - "description": "CUSIP of the ETF.", - "default": null, - "optional": true + "name": "date", + "type": "datetime", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "isin", + "name": "content", "type": "str", - "description": "ISIN of the ETF.", - "default": null, - "optional": true - }, + "description": "Content of the earnings call transcript.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "EarningsCallTranscript" + }, + "/equity/fundamental/trailing_dividend_yield": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the 1 year trailing dividend yield for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.trailing_dividend_yield(symbol='AAPL', provider='tiingo')\nobb.equity.fundamental.trailing_dividend_yield(symbol='AAPL', limit=252, provider='tiingo')\n```\n\n", + "parameters": { + "standard": [ { - "name": "domicile", + "name": "symbol", "type": "str", - "description": "Domicile of the ETF.", - "default": null, - "optional": true + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "asset_class", - "type": "str", - "description": "Asset class of the ETF.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return. Default is 252, the number of trading days in a year.", + "default": 252, "optional": true }, { - "name": "aum", - "type": "float", - "description": "Assets under management.", - "default": null, + "name": "provider", + "type": "Literal['tiingo']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tiingo' if there is no default.", + "default": "tiingo", "optional": true - }, + } + ], + "tiingo": [] + }, + "returns": { + "OBBject": [ { - "name": "nav", - "type": "float", - "description": "Net asset value of the ETF.", - "default": null, - "optional": true + "name": "results", + "type": "List[TrailingDividendYield]", + "description": "Serializable results." }, { - "name": "nav_currency", - "type": "str", - "description": "Currency of the ETF's net asset value.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['tiingo']]", + "description": "Provider name." }, { - "name": "expense_ratio", - "type": "float", - "description": "The expense ratio, as a normalized percent.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "holdings_count", - "type": "int", - "description": "Number of holdings.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "avg_volume", - "type": "float", - "description": "Average daily trading volume.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "website", - "type": "str", - "description": "Website of the issuer.", - "default": null, - "optional": true + "name": "trailing_dividend_yield", + "type": "float", + "description": "Trailing dividend yield.", + "default": "", + "optional": false } ], - "intrinio": [ + "tiingo": [] + }, + "model": "TrailingDividendYield" + }, + "/equity/ownership/major_holders": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get data about major holders for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.major_holders(symbol='AAPL', provider='fmp')\nobb.equity.ownership.major_holders(symbol='AAPL', page=0, provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "fund_listing_date", - "type": "date", - "description": "The date on which the Exchange Traded Product (ETP) or share class of the ETP is listed on a specific exchange.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "data_change_date", - "type": "date", - "description": "The last date on which there was a change in a classifications data field for this ETF.", + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", "default": null, "optional": true }, { - "name": "etn_maturity_date", - "type": "date", - "description": "If the product is an ETN, this field identifies the maturity date for the ETN.", - "default": null, + "name": "page", + "type": "int", + "description": "Page number of the data to fetch.", + "default": 0, "optional": true }, { - "name": "is_listed", - "type": "bool", - "description": "If true, the ETF is still listed on an exchange.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ { - "name": "close_date", - "type": "date", - "description": "The date on which the ETF was de-listed if it is no longer listed.", - "default": null, - "optional": true + "name": "results", + "type": "List[EquityOwnership]", + "description": "Serializable results." }, { - "name": "exchange", - "type": "str", - "description": "The exchange Market Identifier Code (MIC).", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "isin", - "type": "str", - "description": "International Securities Identification Number (ISIN).", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "ric", - "type": "str", - "description": "Reuters Instrument Code (RIC).", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "sedol", - "type": "str", - "description": "Stock Exchange Daily Official List (SEDOL).", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "figi_symbol", - "type": "str", - "description": "Financial Instrument Global Identifier (FIGI) symbol.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "share_class_figi", - "type": "str", - "description": "Financial Instrument Global Identifier (FIGI).", - "default": null, - "optional": true + "name": "cik", + "type": "int", + "description": "Central Index Key (CIK) for the requested entity.", + "default": "", + "optional": false }, { - "name": "firstbridge_id", - "type": "str", - "description": "The FirstBridge unique identifier for the Exchange Traded Fund (ETF).", - "default": null, - "optional": true + "name": "filing_date", + "type": "date", + "description": "Filing date of the stock ownership.", + "default": "", + "optional": false }, { - "name": "firstbridge_parent_id", + "name": "investor_name", "type": "str", - "description": "The FirstBridge unique identifier for the parent Exchange Traded Fund (ETF), if applicable.", - "default": null, - "optional": true + "description": "Investor name of the stock ownership.", + "default": "", + "optional": false }, { - "name": "intrinio_id", + "name": "symbol", "type": "str", - "description": "Intrinio unique identifier for the security.", - "default": null, - "optional": true + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "intraday_nav_symbol", + "name": "security_name", "type": "str", - "description": "Intraday Net Asset Value (NAV) symbol.", - "default": null, - "optional": true + "description": "Security name of the stock ownership.", + "default": "", + "optional": false }, { - "name": "primary_symbol", + "name": "type_of_security", "type": "str", - "description": "The primary ticker field is used for Exchange Traded Products (ETPs) that have multiple listings and share classes. If an ETP has multiple listings or share classes, the same primary ticker is assigned to all the listings and share classes.", - "default": null, - "optional": true + "description": "Type of security of the stock ownership.", + "default": "", + "optional": false }, { - "name": "etp_structure_type", + "name": "security_cusip", "type": "str", - "description": "Classifies Exchange Traded Products (ETPs) into very broad categories based on its legal structure.", - "default": null, - "optional": true + "description": "Security cusip of the stock ownership.", + "default": "", + "optional": false }, { - "name": "legal_structure", + "name": "shares_type", "type": "str", - "description": "Legal structure of the fund.", - "default": null, - "optional": true + "description": "Shares type of the stock ownership.", + "default": "", + "optional": false }, { - "name": "issuer", + "name": "put_call_share", "type": "str", - "description": "Issuer of the ETF.", - "default": null, - "optional": true + "description": "Put call share of the stock ownership.", + "default": "", + "optional": false }, { - "name": "etn_issuing_bank", + "name": "investment_discretion", "type": "str", - "description": "If the product is an Exchange Traded Note (ETN), this field identifies the issuing bank.", - "default": null, - "optional": true + "description": "Investment discretion of the stock ownership.", + "default": "", + "optional": false }, { - "name": "fund_family", + "name": "industry_title", "type": "str", - "description": "This field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor.", - "default": null, - "optional": true + "description": "Industry title of the stock ownership.", + "default": "", + "optional": false }, { - "name": "investment_style", - "type": "str", - "description": "Investment style of the ETF.", - "default": null, - "optional": true + "name": "weight", + "type": "float", + "description": "Weight of the stock ownership.", + "default": "", + "optional": false }, { - "name": "derivatives_based", - "type": "str", - "description": "This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio.", - "default": null, - "optional": true + "name": "last_weight", + "type": "float", + "description": "Last weight of the stock ownership.", + "default": "", + "optional": false }, { - "name": "income_category", - "type": "str", - "description": "Identifies if an Exchange Traded Fund (ETF) falls into a category that is specifically designed to provide a high yield or income", - "default": null, - "optional": true + "name": "change_in_weight", + "type": "float", + "description": "Change in weight of the stock ownership.", + "default": "", + "optional": false }, { - "name": "asset_class", - "type": "str", - "description": "Captures the underlying nature of the securities in the Exchanged Traded Product (ETP).", - "default": null, - "optional": true + "name": "change_in_weight_percentage", + "type": "float", + "description": "Change in weight percentage of the stock ownership.", + "default": "", + "optional": false }, { - "name": "other_asset_types", - "type": "str", - "description": "If 'asset_class' field is classified as 'Other Asset Types' this field captures the specific category of the underlying assets.", - "default": null, - "optional": true + "name": "market_value", + "type": "int", + "description": "Market value of the stock ownership.", + "default": "", + "optional": false }, { - "name": "single_category_designation", - "type": "str", - "description": "This categorization is created for those users who want every ETF to be 'forced' into a single bucket, so that the assets for all categories will always sum to the total market.", - "default": null, - "optional": true + "name": "last_market_value", + "type": "int", + "description": "Last market value of the stock ownership.", + "default": "", + "optional": false }, { - "name": "beta_type", - "type": "str", - "description": "This field identifies whether an ETF provides 'Traditional' beta exposure or 'Smart' beta exposure. ETFs that are active (i.e. non-indexed), leveraged / inverse or have a proprietary quant model (i.e. that don't provide indexed exposure to a targeted factor) are classified separately.", - "default": null, - "optional": true + "name": "change_in_market_value", + "type": "int", + "description": "Change in market value of the stock ownership.", + "default": "", + "optional": false }, { - "name": "beta_details", - "type": "str", - "description": "This field provides further detail within the traditional and smart beta categories.", - "default": null, - "optional": true + "name": "change_in_market_value_percentage", + "type": "float", + "description": "Change in market value percentage of the stock ownership.", + "default": "", + "optional": false }, { - "name": "market_cap_range", - "type": "str", - "description": "Equity ETFs are classified as falling into categories based on the description of their investment strategy in the prospectus. Examples ('Mega Cap', 'Large Cap', 'Mid Cap', etc.)", - "default": null, - "optional": true + "name": "shares_number", + "type": "int", + "description": "Shares number of the stock ownership.", + "default": "", + "optional": false }, { - "name": "market_cap_weighting_type", - "type": "str", - "description": "For ETFs that take the value 'Market Cap Weighted' in the 'index_weighting_scheme' field, this field provides detail on the market cap weighting type.", - "default": null, - "optional": true + "name": "last_shares_number", + "type": "int", + "description": "Last shares number of the stock ownership.", + "default": "", + "optional": false }, { - "name": "index_weighting_scheme", - "type": "str", - "description": "For ETFs that track an underlying index, this field provides detail on the index weighting type.", - "default": null, - "optional": true + "name": "change_in_shares_number", + "type": "float", + "description": "Change in shares number of the stock ownership.", + "default": "", + "optional": false }, { - "name": "index_linked", - "type": "str", - "description": "This field identifies whether an ETF is index linked or active.", - "default": null, - "optional": true + "name": "change_in_shares_number_percentage", + "type": "float", + "description": "Change in shares number percentage of the stock ownership.", + "default": "", + "optional": false }, { - "name": "index_name", - "type": "str", - "description": "This field identifies the name of the underlying index tracked by the ETF, if applicable.", - "default": null, - "optional": true + "name": "quarter_end_price", + "type": "float", + "description": "Quarter end price of the stock ownership.", + "default": "", + "optional": false }, { - "name": "index_symbol", - "type": "str", - "description": "This field identifies the OpenFIGI ticker for the Index underlying the ETF.", - "default": null, - "optional": true + "name": "avg_price_paid", + "type": "float", + "description": "Average price paid of the stock ownership.", + "default": "", + "optional": false }, { - "name": "parent_index", - "type": "str", - "description": "This field identifies the name of the parent index, which represents the broader universe from which the index underlying the ETF is created, if applicable.", - "default": null, - "optional": true + "name": "is_new", + "type": "bool", + "description": "Is the stock ownership new.", + "default": "", + "optional": false }, { - "name": "index_family", - "type": "str", - "description": "This field identifies the index family to which the index underlying the ETF belongs. The index family is represented as categorized by the index provider.", - "default": null, - "optional": true + "name": "is_sold_out", + "type": "bool", + "description": "Is the stock ownership sold out.", + "default": "", + "optional": false }, { - "name": "broader_index_family", - "type": "str", - "description": "This field identifies the broader index family to which the index underlying the ETF belongs. The broader index family is represented as categorized by the index provider.", - "default": null, - "optional": true + "name": "ownership", + "type": "float", + "description": "How much is the ownership.", + "default": "", + "optional": false }, { - "name": "index_provider", - "type": "str", - "description": "This field identifies the Index provider for the index underlying the ETF, if applicable.", - "default": null, - "optional": true + "name": "last_ownership", + "type": "float", + "description": "Last ownership amount.", + "default": "", + "optional": false }, { - "name": "index_provider_code", - "type": "str", - "description": "This field provides the First Bridge code for each Index provider, corresponding to the index underlying the ETF if applicable.", - "default": null, - "optional": true + "name": "change_in_ownership", + "type": "float", + "description": "Change in ownership amount.", + "default": "", + "optional": false }, { - "name": "replication_structure", - "type": "str", - "description": "The replication structure of the Exchange Traded Product (ETP).", - "default": null, - "optional": true + "name": "change_in_ownership_percentage", + "type": "float", + "description": "Change in ownership percentage.", + "default": "", + "optional": false }, { - "name": "growth_value_tilt", - "type": "str", - "description": "Classifies equity ETFs as either 'Growth' or Value' based on the stated style tilt in the ETF prospectus. Equity ETFs that do not have a stated style tilt are classified as 'Core / Blend'.", - "default": null, - "optional": true + "name": "holding_period", + "type": "int", + "description": "Holding period of the stock ownership.", + "default": "", + "optional": false }, { - "name": "growth_type", - "type": "str", - "description": "For ETFs that are classified as 'Growth' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their growth (style factor) scores.", - "default": null, - "optional": true + "name": "first_added", + "type": "date", + "description": "First added date of the stock ownership.", + "default": "", + "optional": false }, { - "name": "value_type", - "type": "str", - "description": "For ETFs that are classified as 'Value' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their value (style factor) scores.", - "default": null, - "optional": true + "name": "performance", + "type": "float", + "description": "Performance of the stock ownership.", + "default": "", + "optional": false }, { - "name": "sector", - "type": "str", - "description": "For equity ETFs that aim to provide targeted exposure to a sector or industry, this field identifies the Sector that it provides the exposure to.", - "default": null, - "optional": true + "name": "performance_percentage", + "type": "float", + "description": "Performance percentage of the stock ownership.", + "default": "", + "optional": false }, { - "name": "industry", - "type": "str", - "description": "For equity ETFs that aim to provide targeted exposure to an industry, this field identifies the Industry that it provides the exposure to.", - "default": null, - "optional": true + "name": "last_performance", + "type": "float", + "description": "Last performance of the stock ownership.", + "default": "", + "optional": false }, { - "name": "industry_group", - "type": "str", - "description": "For equity ETFs that aim to provide targeted exposure to a sub-industry, this field identifies the sub-Industry that it provides the exposure to.", - "default": null, - "optional": true + "name": "change_in_performance", + "type": "float", + "description": "Change in performance of the stock ownership.", + "default": "", + "optional": false }, { - "name": "cross_sector_theme", - "type": "str", - "description": "For equity ETFs that aim to provide targeted exposure to a specific investment theme that cuts across GICS sectors, this field identifies the specific cross-sector theme. Examples ('Agri-business', 'Natural Resources', 'Green Investing', etc.)", - "default": null, - "optional": true - }, + "name": "is_counted_for_performance", + "type": "bool", + "description": "Is the stock ownership counted for performance.", + "default": "", + "optional": false + } + ], + "fmp": [] + }, + "model": "EquityOwnership" + }, + "/equity/ownership/institutional": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get data about institutional ownership for a given company over time.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.institutional(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "natural_resources_type", + "name": "symbol", "type": "str", - "description": "For ETFs that are classified as 'Natural Resources' in the 'cross_sector_theme' field, this field provides further detail on the type of Natural Resources exposure.", - "default": null, - "optional": true + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "us_or_excludes_us", - "type": "str", - "description": "Takes the value of 'Domestic' for US exposure, 'International' for non-US exposure and 'Global' for exposure that includes all regions including the US.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "developed_emerging", - "type": "str", - "description": "This field identifies the stage of development of the markets that the ETF provides exposure to.", - "default": null, + "name": "include_current_quarter", + "type": "bool", + "description": "Include current quarter data.", + "default": false, "optional": true }, { - "name": "specialized_region", - "type": "str", - "description": "This field is populated if the ETF provides targeted exposure to a specific type of geography-based grouping that does not fall into a specific country or continent grouping. Examples ('BRIC', 'Chindia', etc.)", + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", "default": null, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[InstitutionalOwnership]", + "description": "Serializable results." }, { - "name": "continent", - "type": "str", - "description": "This field is populated if the ETF provides targeted exposure to a specific continent or country within that Continent.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "latin_america_sub_group", - "type": "str", - "description": "For ETFs that are classified as 'Latin America' in the 'continent' field, this field provides further detail on the type of regional exposure.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "europe_sub_group", - "type": "str", - "description": "For ETFs that are classified as 'Europe' in the 'continent' field, this field provides further detail on the type of regional exposure.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "asia_sub_group", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", "type": "str", - "description": "For ETFs that are classified as 'Asia' in the 'continent' field, this field provides further detail on the type of regional exposure.", - "default": null, - "optional": true + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "specific_country", + "name": "cik", "type": "str", - "description": "This field is populated if the ETF provides targeted exposure to a specific country.", + "description": "Central Index Key (CIK) for the requested entity.", "default": null, "optional": true }, { - "name": "china_listing_location", - "type": "str", - "description": "For ETFs that are classified as 'China' in the 'country' field, this field provides further detail on the type of exposure in the underlying securities.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + } + ], + "fmp": [ + { + "name": "investors_holding", + "type": "int", + "description": "Number of investors holding the stock.", + "default": "", + "optional": false }, { - "name": "us_state", - "type": "str", - "description": "Takes the value of a US state if the ETF provides targeted exposure to the municipal bonds or equities of companies.", - "default": null, - "optional": true + "name": "last_investors_holding", + "type": "int", + "description": "Number of investors holding the stock in the last quarter.", + "default": "", + "optional": false }, { - "name": "real_estate", - "type": "str", - "description": "For ETFs that provide targeted real estate exposure, this field is populated if the ETF provides targeted exposure to a specific segment of the real estate market.", - "default": null, - "optional": true + "name": "investors_holding_change", + "type": "int", + "description": "Change in the number of investors holding the stock.", + "default": "", + "optional": false }, { - "name": "fundamental_weighting_type", - "type": "str", - "description": "For ETFs that take the value 'Fundamental Weighted' in the 'index_weighting_scheme' field, this field provides detail on the fundamental weighting methodology.", + "name": "number_of_13f_shares", + "type": "int", + "description": "Number of 13F shares.", "default": null, "optional": true }, { - "name": "dividend_weighting_type", - "type": "str", - "description": "For ETFs that take the value 'Dividend Weighted' in the 'index_weighting_scheme' field, this field provides detail on the dividend weighting methodology.", + "name": "last_number_of_13f_shares", + "type": "int", + "description": "Number of 13F shares in the last quarter.", "default": null, "optional": true }, { - "name": "bond_type", - "type": "str", - "description": "For ETFs where 'asset_class_type' is 'Bonds', this field provides detail on the type of bonds held in the ETF.", + "name": "number_of_13f_shares_change", + "type": "int", + "description": "Change in the number of 13F shares.", "default": null, "optional": true }, { - "name": "government_bond_types", - "type": "str", - "description": "For bond ETFs that take the value 'Treasury & Government' in 'bond_type', this field provides detail on the exposure.", - "default": null, - "optional": true + "name": "total_invested", + "type": "float", + "description": "Total amount invested.", + "default": "", + "optional": false }, { - "name": "municipal_bond_region", - "type": "str", - "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field provides additional detail on the geographic exposure.", - "default": null, - "optional": true + "name": "last_total_invested", + "type": "float", + "description": "Total amount invested in the last quarter.", + "default": "", + "optional": false }, { - "name": "municipal_vrdo", - "type": "bool", - "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field identifies those ETFs that specifically provide exposure to Variable Rate Demand Obligations.", - "default": null, - "optional": true + "name": "total_invested_change", + "type": "float", + "description": "Change in the total amount invested.", + "default": "", + "optional": false }, { - "name": "mortgage_bond_types", - "type": "str", - "description": "For bond ETFs that take the value 'Mortgage' in 'bond_type', this field provides additional detail on the type of underlying securities.", - "default": null, - "optional": true + "name": "ownership_percent", + "type": "float", + "description": "Ownership percent.", + "default": "", + "optional": false }, { - "name": "bond_tax_status", - "type": "str", - "description": "For all US bond ETFs, this field provides additional detail on the tax treatment of the underlying securities.", - "default": null, - "optional": true + "name": "last_ownership_percent", + "type": "float", + "description": "Ownership percent in the last quarter.", + "default": "", + "optional": false }, { - "name": "credit_quality", - "type": "str", - "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific credit quality range.", - "default": null, - "optional": true + "name": "ownership_percent_change", + "type": "float", + "description": "Change in the ownership percent.", + "default": "", + "optional": false }, { - "name": "average_maturity", - "type": "str", - "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific maturity range.", - "default": null, - "optional": true + "name": "new_positions", + "type": "int", + "description": "Number of new positions.", + "default": "", + "optional": false }, { - "name": "specific_maturity_year", + "name": "last_new_positions", "type": "int", - "description": "For all bond ETFs that take the value 'Specific Maturity Year' in the 'average_maturity' field, this field specifies the calendar year.", - "default": null, - "optional": true + "description": "Number of new positions in the last quarter.", + "default": "", + "optional": false }, { - "name": "commodity_types", - "type": "str", - "description": "For ETFs where 'asset_class_type' is 'Commodities', this field provides detail on the type of commodities held in the ETF.", - "default": null, - "optional": true + "name": "new_positions_change", + "type": "int", + "description": "Change in the number of new positions.", + "default": "", + "optional": false }, { - "name": "energy_type", - "type": "str", - "description": "For ETFs where 'commodity_type' is 'Energy', this field provides detail on the type of energy exposure provided by the ETF.", - "default": null, - "optional": true + "name": "increased_positions", + "type": "int", + "description": "Number of increased positions.", + "default": "", + "optional": false }, { - "name": "agricultural_type", - "type": "str", - "description": "For ETFs where 'commodity_type' is 'Agricultural', this field provides detail on the type of agricultural exposure provided by the ETF.", - "default": null, - "optional": true + "name": "last_increased_positions", + "type": "int", + "description": "Number of increased positions in the last quarter.", + "default": "", + "optional": false }, { - "name": "livestock_type", - "type": "str", - "description": "For ETFs where 'commodity_type' is 'Livestock', this field provides detail on the type of livestock exposure provided by the ETF.", - "default": null, - "optional": true + "name": "increased_positions_change", + "type": "int", + "description": "Change in the number of increased positions.", + "default": "", + "optional": false }, { - "name": "metal_type", - "type": "str", - "description": "For ETFs where 'commodity_type' is 'Gold & Metals', this field provides detail on the type of exposure provided by the ETF.", - "default": null, - "optional": true + "name": "closed_positions", + "type": "int", + "description": "Number of closed positions.", + "default": "", + "optional": false }, { - "name": "inverse_leveraged", - "type": "str", - "description": "This field is populated if the ETF provides inverse or leveraged exposure.", - "default": null, - "optional": true + "name": "last_closed_positions", + "type": "int", + "description": "Number of closed positions in the last quarter.", + "default": "", + "optional": false }, { - "name": "target_date_multi_asset_type", - "type": "str", - "description": "For ETFs where 'asset_class_type' is 'Target Date / MultiAsset', this field provides detail on the type of commodities held in the ETF.", - "default": null, - "optional": true + "name": "closed_positions_change", + "type": "int", + "description": "Change in the number of closed positions.", + "default": "", + "optional": false }, { - "name": "currency_pair", - "type": "str", - "description": "This field is populated if the ETF's strategy involves providing exposure to the movements of a currency or involves hedging currency exposure.", - "default": null, - "optional": true + "name": "reduced_positions", + "type": "int", + "description": "Number of reduced positions.", + "default": "", + "optional": false }, { - "name": "social_environmental_type", - "type": "str", - "description": "This field is populated if the ETF's strategy involves providing exposure to a specific social or environmental theme.", - "default": null, - "optional": true + "name": "last_reduced_positions", + "type": "int", + "description": "Number of reduced positions in the last quarter.", + "default": "", + "optional": false }, { - "name": "clean_energy_type", - "type": "str", - "description": "This field is populated if the ETF has a value of 'Clean Energy' in the 'social_environmental_type' field.", - "default": null, - "optional": true + "name": "reduced_positions_change", + "type": "int", + "description": "Change in the number of reduced positions.", + "default": "", + "optional": false }, { - "name": "dividend_type", - "type": "str", - "description": "This field is populated if the ETF has an intended investment objective of holding dividend-oriented stocks as stated in the prospectus.", - "default": null, - "optional": true + "name": "total_calls", + "type": "int", + "description": "Total number of call options contracts traded for Apple Inc. on the specified date.", + "default": "", + "optional": false }, { - "name": "regular_dividend_payor_type", - "type": "str", - "description": "This field is populated if the ETF has a value of'Dividend - Regular Payors' in the 'dividend_type' field.", - "default": null, - "optional": true + "name": "last_total_calls", + "type": "int", + "description": "Total number of call options contracts traded for Apple Inc. on the previous reporting date.", + "default": "", + "optional": false }, { - "name": "quant_strategies_type", - "type": "str", - "description": "This field is populated if the ETF has either an index-linked or active strategy that is based on a proprietary quantitative strategy.", - "default": null, - "optional": true + "name": "total_calls_change", + "type": "int", + "description": "Change in the total number of call options contracts traded between the current and previous reporting dates.", + "default": "", + "optional": false }, { - "name": "other_quant_models", - "type": "str", - "description": "For ETFs where 'quant_strategies_type' is 'Other Quant Model', this field provides the name of the specific proprietary quant model used as the underlying strategy for the ETF.", - "default": null, - "optional": true + "name": "total_puts", + "type": "int", + "description": "Total number of put options contracts traded for Apple Inc. on the specified date.", + "default": "", + "optional": false }, { - "name": "hedge_fund_type", - "type": "str", - "description": "For ETFs where 'other_asset_types' is 'Hedge Fund Replication', this field provides detail on the type of hedge fund replication strategy.", - "default": null, - "optional": true + "name": "last_total_puts", + "type": "int", + "description": "Total number of put options contracts traded for Apple Inc. on the previous reporting date.", + "default": "", + "optional": false }, { - "name": "excludes_financials", - "type": "bool", - "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold financials stocks, based on the funds intended objective.", - "default": null, - "optional": true + "name": "total_puts_change", + "type": "int", + "description": "Change in the total number of put options contracts traded between the current and previous reporting dates.", + "default": "", + "optional": false }, { - "name": "excludes_technology", - "type": "bool", - "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold technology stocks, based on the funds intended objective.", - "default": null, - "optional": true + "name": "put_call_ratio", + "type": "float", + "description": "Put-call ratio, which is the ratio of the total number of put options to call options traded on the specified date.", + "default": "", + "optional": false }, { - "name": "holds_only_nyse_stocks", - "type": "bool", - "description": "If true, the ETF is an equity ETF and holds only stocks listed on NYSE.", - "default": null, - "optional": true + "name": "last_put_call_ratio", + "type": "float", + "description": "Put-call ratio on the previous reporting date.", + "default": "", + "optional": false }, { - "name": "holds_only_nasdaq_stocks", - "type": "bool", - "description": "If true, the ETF is an equity ETF and holds only stocks listed on Nasdaq.", - "default": null, - "optional": true + "name": "put_call_ratio_change", + "type": "float", + "description": "Change in the put-call ratio between the current and previous reporting dates.", + "default": "", + "optional": false + } + ] + }, + "model": "InstitutionalOwnership" + }, + "/equity/ownership/insider_trading": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get data about trading by a company's management team and board of directors.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.insider_trading(symbol='AAPL', provider='fmp')\nobb.equity.ownership.insider_trading(symbol='AAPL', limit=500, provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false }, { - "name": "holds_mlp", - "type": "bool", - "description": "If true, the ETF's investment objective explicitly specifies that it holds MLPs as an intended part of its investment strategy.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 500, "optional": true }, { - "name": "holds_preferred_stock", - "type": "bool", - "description": "If true, the ETF's investment objective explicitly specifies that it holds preferred stock as an intended part of its investment strategy.", - "default": null, + "name": "provider", + "type": "Literal['fmp', 'intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "holds_closed_end_funds", - "type": "bool", - "description": "If true, the ETF's investment objective explicitly specifies that it holds closed end funds as an intended part of its investment strategy.", + "name": "transaction_type", + "type": "Literal[None, 'award', 'conversion', 'return', 'expire_short', 'in_kind', 'gift', 'expire_long', 'discretionary', 'other', 'small', 'exempt', 'otm', 'purchase', 'sale', 'tender', 'will', 'itm', 'trust']", + "description": "Type of the transaction.", "default": null, "optional": true + } + ], + "intrinio": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": "", + "optional": false }, { - "name": "holds_adr", - "type": "bool", - "description": "If true, he ETF's investment objective explicitly specifies that it holds American Depositary Receipts (ADRs) as an intended part of its investment strategy.", - "default": null, - "optional": true + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": "", + "optional": false }, { - "name": "laddered", - "type": "bool", - "description": "For bond ETFs, this field identifies those ETFs that specifically hold bonds in a laddered structure, where the bonds are scheduled to mature in an annual, sequential structure.", + "name": "ownership_type", + "type": "Literal['D', 'I']", + "description": "Type of ownership.", "default": null, "optional": true }, { - "name": "zero_coupon", - "type": "bool", - "description": "For bond ETFs, this field identifies those ETFs that specifically hold zero coupon Treasury Bills.", - "default": null, + "name": "sort_by", + "type": "Literal['filing_date', 'updated_on']", + "description": "Field to sort by.", + "default": "updated_on", "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[InsiderTrading]", + "description": "Serializable results." }, { - "name": "floating_rate", - "type": "bool", - "description": "For bond ETFs, this field identifies those ETFs that specifically hold floating rate bonds.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio']]", + "description": "Provider name." }, { - "name": "build_america_bonds", - "type": "bool", - "description": "For municipal bond ETFs, this field identifies those ETFs that specifically hold Build America Bonds.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "dynamic_futures_roll", - "type": "bool", - "description": "If the product holds futures contracts, this field identifies those products where the roll strategy is dynamic (rather than entirely rules based), so as to minimize roll costs.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "currency_hedged", - "type": "bool", - "description": "This field is populated if the ETF's strategy involves hedging currency exposure.", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "includes_short_exposure", - "type": "bool", - "description": "This field is populated if the ETF has short exposure in any of its holdings e.g. in a long/short or inverse ETF.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "ucits", - "type": "bool", - "description": "If true, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant", + "name": "company_cik", + "type": "Union[int, str]", + "description": "CIK number of the company.", "default": null, "optional": true }, { - "name": "registered_countries", - "type": "str", - "description": "The list of countries where the ETF is legally registered for sale. This may differ from where the ETF is domiciled or traded, particularly in Europe.", + "name": "filing_date", + "type": "Union[date, datetime]", + "description": "Filing date of the trade.", "default": null, "optional": true }, { - "name": "issuer_country", - "type": "str", - "description": "2 letter ISO country code for the country where the issuer is located.", + "name": "transaction_date", + "type": "date", + "description": "Date of the transaction.", "default": null, "optional": true }, { - "name": "domicile", - "type": "str", - "description": "2 letter ISO country code for the country where the ETP is domiciled.", + "name": "owner_cik", + "type": "Union[int, str]", + "description": "Reporting individual's CIK.", "default": null, "optional": true }, { - "name": "listing_country", + "name": "owner_name", "type": "str", - "description": "2 letter ISO country code for the country of the primary listing.", + "description": "Name of the reporting individual.", "default": null, "optional": true }, { - "name": "listing_region", + "name": "owner_title", "type": "str", - "description": "Geographic region in the country of the primary listing falls.", + "description": "The title held by the reporting individual.", "default": null, "optional": true }, { - "name": "bond_currency_denomination", + "name": "transaction_type", "type": "str", - "description": "For all bond ETFs, this field provides additional detail on the currency denomination of the underlying securities.", + "description": "Type of transaction being reported.", "default": null, "optional": true }, { - "name": "base_currency", + "name": "acquisition_or_disposition", "type": "str", - "description": "Base currency in which NAV is reported.", + "description": "Acquisition or disposition of the shares.", "default": null, "optional": true }, { - "name": "listing_currency", + "name": "security_type", "type": "str", - "description": "Listing currency of the Exchange Traded Product (ETP) in which it is traded. Reported using the 3-digit ISO currency code.", + "description": "The type of security transacted.", "default": null, "optional": true }, { - "name": "number_of_holdings", - "type": "int", - "description": "The number of holdings in the ETF.", + "name": "securities_owned", + "type": "float", + "description": "Number of securities owned by the reporting individual.", "default": null, "optional": true }, { - "name": "month_end_assets", + "name": "securities_transacted", "type": "float", - "description": "Net assets in millions of dollars as of the most recent month end.", + "description": "Number of securities transacted by the reporting individual.", "default": null, "optional": true }, { - "name": "net_expense_ratio", + "name": "transaction_price", "type": "float", - "description": "Gross expense net of Fee Waivers, as a percentage of net assets as published by the ETF issuer.", + "description": "The price of the transaction.", "default": null, "optional": true }, { - "name": "etf_portfolio_turnover", - "type": "float", - "description": "The percentage of positions turned over in the last 12 months.", + "name": "filing_url", + "type": "str", + "description": "Link to the filing.", "default": null, "optional": true } ], - "tmx": [ - { - "name": "description", - "type": "str", - "description": "The description of the ETF.", - "default": null, - "optional": true - }, + "fmp": [ { - "name": "issuer", + "name": "form_type", "type": "str", - "description": "The issuer of the ETF.", - "default": null, - "optional": true - }, + "description": "Form type of the insider trading.", + "default": "", + "optional": false + } + ], + "intrinio": [ { - "name": "investment_style", + "name": "filing_url", "type": "str", - "description": "The investment style of the ETF.", - "default": null, - "optional": true - }, - { - "name": "esg", - "type": "bool", - "description": "Whether the ETF qualifies as an ESG fund.", + "description": "URL of the filing.", "default": null, "optional": true }, { - "name": "currency", + "name": "company_name", "type": "str", - "description": "The currency of the ETF.", + "description": "Name of the company.", "default": "", "optional": false }, { - "name": "unit_price", + "name": "conversion_exercise_price", "type": "float", - "description": "The unit price of the ETF.", + "description": "Conversion/Exercise price of the shares.", "default": null, "optional": true }, { - "name": "close", - "type": "float", - "description": "The closing price of the ETF.", - "default": "", - "optional": false - }, - { - "name": "prev_close", - "type": "float", - "description": "The previous closing price of the ETF.", + "name": "deemed_execution_date", + "type": "date", + "description": "Deemed execution date of the trade.", "default": null, "optional": true }, { - "name": "return_1m", - "type": "float", - "description": "The one-month return of the ETF, as a normalized percent", + "name": "exercise_date", + "type": "date", + "description": "Exercise date of the trade.", "default": null, "optional": true }, { - "name": "return_3m", - "type": "float", - "description": "The three-month return of the ETF, as a normalized percent.", + "name": "expiration_date", + "type": "date", + "description": "Expiration date of the derivative.", "default": null, "optional": true }, { - "name": "return_6m", - "type": "float", - "description": "The six-month return of the ETF, as a normalized percent.", + "name": "underlying_security_title", + "type": "str", + "description": "Name of the underlying non-derivative security related to this derivative transaction.", "default": null, "optional": true }, { - "name": "return_ytd", - "type": "float", - "description": "The year-to-date return of the ETF, as a normalized percent.", + "name": "underlying_shares", + "type": "Union[int, float]", + "description": "Number of underlying shares related to this derivative transaction.", "default": null, "optional": true }, { - "name": "return_1y", - "type": "float", - "description": "The one-year return of the ETF, as a normalized percent.", + "name": "nature_of_ownership", + "type": "str", + "description": "Nature of ownership of the insider trading.", "default": null, "optional": true }, { - "name": "return_3y", - "type": "float", - "description": "The three-year return of the ETF, as a normalized percent.", + "name": "director", + "type": "bool", + "description": "Whether the owner is a director.", "default": null, "optional": true }, { - "name": "return_5y", - "type": "float", - "description": "The five-year return of the ETF, as a normalized percent.", + "name": "officer", + "type": "bool", + "description": "Whether the owner is an officer.", "default": null, "optional": true }, { - "name": "return_10y", - "type": "float", - "description": "The ten-year return of the ETF, as a normalized percent.", + "name": "ten_percent_owner", + "type": "bool", + "description": "Whether the owner is a 10% owner.", "default": null, "optional": true }, { - "name": "return_from_inception", - "type": "float", - "description": "The return from inception of the ETF, as a normalized percent.", + "name": "other_relation", + "type": "bool", + "description": "Whether the owner is having another relation.", "default": null, "optional": true }, { - "name": "avg_volume", - "type": "int", - "description": "The average daily volume of the ETF.", + "name": "derivative_transaction", + "type": "bool", + "description": "Whether the owner is having a derivative transaction.", "default": null, "optional": true }, { - "name": "avg_volume_30d", + "name": "report_line_number", "type": "int", - "description": "The 30-day average volume of the ETF.", + "description": "Report line number of the insider trading.", "default": null, "optional": true + } + ] + }, + "model": "InsiderTrading" + }, + "/equity/ownership/share_statistics": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get data about share float for a given company.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.share_statistics(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": "", + "optional": false }, { - "name": "aum", - "type": "float", - "description": "The AUM of the ETF.", - "default": null, + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true + } + ], + "fmp": [], + "intrinio": [], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[ShareStatistics]", + "description": "Serializable results." }, { - "name": "pe_ratio", - "type": "float", - "description": "The price-to-earnings ratio of the ETF.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "pb_ratio", - "type": "float", - "description": "The price-to-book ratio of the ETF.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": null, "optional": true }, { - "name": "management_fee", + "name": "free_float", "type": "float", - "description": "The management fee of the ETF, as a normalized percent.", + "description": "Percentage of unrestricted shares of a publicly-traded company.", "default": null, "optional": true }, { - "name": "mer", + "name": "float_shares", "type": "float", - "description": "The management expense ratio of the ETF, as a normalized percent.", + "description": "Number of shares available for trading by the general public.", "default": null, "optional": true }, { - "name": "distribution_yield", + "name": "outstanding_shares", "type": "float", - "description": "The distribution yield of the ETF, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "dividend_frequency", - "type": "str", - "description": "The dividend payment frequency of the ETF.", + "description": "Total number of shares of a publicly-traded company.", "default": null, "optional": true }, { - "name": "website", + "name": "source", "type": "str", - "description": "The website of the ETF.", + "description": "Source of the received data.", "default": null, "optional": true } ], - "yfinance": [ - { - "name": "fund_type", - "type": "str", - "description": "The legal type of fund.", - "default": null, - "optional": true - }, + "fmp": [], + "intrinio": [ { - "name": "fund_family", - "type": "str", - "description": "The fund family.", + "name": "adjusted_outstanding_shares", + "type": "float", + "description": "Total number of shares of a publicly-traded company, adjusted for splits.", "default": null, "optional": true }, { - "name": "category", - "type": "str", - "description": "The fund category.", + "name": "public_float", + "type": "float", + "description": "Aggregate market value of the shares of a publicly-traded company.", "default": null, "optional": true - }, + } + ], + "yfinance": [ { - "name": "exchange", - "type": "str", - "description": "The exchange the fund is listed on.", + "name": "implied_shares_outstanding", + "type": "int", + "description": "Implied Shares Outstanding of common equity, assuming the conversion of all convertible subsidiary equity into common.", "default": null, "optional": true }, { - "name": "exchange_timezone", - "type": "str", - "description": "The timezone of the exchange.", + "name": "short_interest", + "type": "int", + "description": "Number of shares that are reported short.", "default": null, "optional": true }, { - "name": "currency", - "type": "str", - "description": "The currency in which the fund is listed.", + "name": "short_percent_of_float", + "type": "float", + "description": "Percentage of shares that are reported short, as a normalized percent.", "default": null, "optional": true }, { - "name": "nav_price", + "name": "days_to_cover", "type": "float", - "description": "The net asset value per unit of the fund.", + "description": "Number of days to repurchase the shares as a ratio of average daily volume", "default": null, "optional": true }, { - "name": "total_assets", + "name": "short_interest_prev_month", "type": "int", - "description": "The total value of assets held by the fund.", + "description": "Number of shares that were reported short in the previous month.", "default": null, "optional": true }, { - "name": "trailing_pe", - "type": "float", - "description": "The trailing twelve month P/E ratio of the fund's assets.", + "name": "short_interest_prev_date", + "type": "date", + "description": "Date of the previous month's report.", "default": null, "optional": true }, { - "name": "dividend_yield", + "name": "insider_ownership", "type": "float", - "description": "The dividend yield of the fund, as a normalized percent.", + "description": "Percentage of shares held by insiders, as a normalized percent.", "default": null, "optional": true }, { - "name": "dividend_rate_ttm", + "name": "institution_ownership", "type": "float", - "description": "The trailing twelve month annual dividend rate of the fund, in currency units.", + "description": "Percentage of shares held by institutions, as a normalized percent.", "default": null, "optional": true }, { - "name": "dividend_yield_ttm", + "name": "institution_float_ownership", "type": "float", - "description": "The trailing twelve month annual dividend yield of the fund, as a normalized percent.", + "description": "Percentage of float held by institutions, as a normalized percent.", "default": null, "optional": true }, { - "name": "year_high", - "type": "float", - "description": "The fifty-two week high price.", + "name": "institutions_count", + "type": "int", + "description": "Number of institutions holding shares.", "default": null, "optional": true - }, + } + ] + }, + "model": "ShareStatistics" + }, + "/equity/ownership/form_13f": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the form 13F.\n\nThe Securities and Exchange Commission's (SEC) Form 13F is a quarterly report\nthat is required to be filed by all institutional investment managers with at least\n$100 million in assets under management.\nManagers are required to file Form 13F within 45 days after the last day of the calendar quarter.\nMost funds wait until the end of this period in order to conceal\ntheir investment strategy from competitors and the public.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.form_13f(symbol='NVDA', provider='sec')\n# Enter a date (calendar quarter ending) for a specific report.\nobb.equity.ownership.form_13f(symbol='BRK-A', date='2016-09-30', provider='sec')\n# Example finding Michael Burry's filings.\ncik = obb.regulators.sec.institutions_search(\"Scion Asset Management\").results[0].cik\n# Use the `limit` parameter to return N number of reports from the most recent.\nobb.equity.ownership.form_13f(cik, limit=2).to_df()\n```\n\n", + "parameters": { + "standard": [ { - "name": "year_low", - "type": "float", - "description": "The fifty-two week low price.", - "default": null, - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. A CIK or Symbol can be used.", + "default": "", + "optional": false }, { - "name": "ma_50d", - "type": "float", - "description": "50-day moving average price.", + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported.", "default": null, "optional": true }, { - "name": "ma_200d", - "type": "float", - "description": "200-day moving average price.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter.", + "default": 1, "optional": true }, { - "name": "return_ytd", - "type": "float", - "description": "The year-to-date return of the fund, as a normalized percent.", - "default": null, + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", "optional": true - }, + } + ], + "sec": [] + }, + "returns": { + "OBBject": [ { - "name": "return_3y_avg", - "type": "float", - "description": "The three year average return of the fund, as a normalized percent.", - "default": null, - "optional": true + "name": "results", + "type": "List[Form13FHR]", + "description": "Serializable results." }, { - "name": "return_5y_avg", - "type": "float", - "description": "The five year average return of the fund, as a normalized percent.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['sec']]", + "description": "Provider name." }, { - "name": "beta_3y_avg", - "type": "float", - "description": "The three year average beta of the fund.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "volume_avg", - "type": "float", - "description": "The average daily trading volume of the fund.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "volume_avg_10d", - "type": "float", - "description": "The average daily trading volume of the fund over the past ten days.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end-of-quarter date of the filing.", + "default": "", + "optional": false }, { - "name": "bid", - "type": "float", - "description": "The current bid price.", - "default": null, - "optional": true + "name": "issuer", + "type": "str", + "description": "The name of the issuer.", + "default": "", + "optional": false }, { - "name": "bid_size", - "type": "float", - "description": "The current bid size.", - "default": null, - "optional": true + "name": "cusip", + "type": "str", + "description": "The CUSIP of the security.", + "default": "", + "optional": false }, { - "name": "ask", - "type": "float", - "description": "The current ask price.", - "default": null, - "optional": true + "name": "asset_class", + "type": "str", + "description": "The title of the asset class for the security.", + "default": "", + "optional": false }, { - "name": "ask_size", - "type": "float", - "description": "The current ask size.", + "name": "security_type", + "type": "Literal['SH', 'PRN']", + "description": "The total number of shares of the class of security or the principal amount of such class. 'SH' for shares. 'PRN' for principal amount. Convertible debt securities are reported as 'PRN'.", "default": null, "optional": true }, { - "name": "open", - "type": "float", - "description": "The open price of the most recent trading session.", + "name": "option_type", + "type": "Literal['call', 'put']", + "description": "Defined when the holdings being reported are put or call options. Only long positions are reported.", "default": null, "optional": true }, { - "name": "high", - "type": "float", - "description": "The highest price of the most recent trading session.", + "name": "voting_authority_sole", + "type": "int", + "description": "The number of shares for which the Manager exercises sole voting authority (none).", "default": null, "optional": true }, { - "name": "low", - "type": "float", - "description": "The lowest price of the most recent trading session.", + "name": "voting_authority_shared", + "type": "int", + "description": "The number of shares for which the Manager exercises a defined shared voting authority (none).", "default": null, "optional": true }, { - "name": "volume", + "name": "voting_authority_other", "type": "int", - "description": "The trading volume of the most recent trading session.", + "description": "The number of shares for which the Manager exercises other shared voting authority (none).", "default": null, "optional": true }, { - "name": "prev_close", + "name": "principal_amount", + "type": "int", + "description": "The total number of shares of the class of security or the principal amount of such class. Only long positions are reported", + "default": "", + "optional": false + }, + { + "name": "value", + "type": "int", + "description": "The fair market value of the holding of the particular class of security. The value reported for options is the fair market value of the underlying security with respect to the number of shares controlled. Values are rounded to the nearest US dollar and use the closing price of the last trading day of the calendar year or quarter.", + "default": "", + "optional": false + } + ], + "sec": [ + { + "name": "weight", "type": "float", - "description": "The previous closing price.", - "default": null, - "optional": true + "description": "The weight of the security relative to the market value of all securities in the filing , as a normalized percent.", + "default": "", + "optional": false } ] }, - "model": "EtfInfo" + "model": "Form13FHR" }, - "/etf/sectors": { + "/equity/price/quote": { "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", + "description": "Get the latest quote for a given stock. Quote includes price, volume, and other data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.quote(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for. (ETF)", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": "", "optional": false }, { "name": "provider", - "type": "Literal['fmp', 'tmx']", + "type": "Literal['fmp', 'intrinio', 'yfinance']", "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", "default": "fmp", "optional": true } ], "fmp": [], - "tmx": [ + "intrinio": [ { - "name": "use_cache", - "type": "bool", - "description": "Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours.", - "default": true, + "name": "symbol", + "type": "str", + "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", + "default": "", + "optional": false + }, + { + "name": "source", + "type": "Literal['iex', 'bats', 'bats_delayed', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed', 'intrinio_mx', 'intrinio_mx_plus', 'delayed_sip']", + "description": "Source of the data.", + "default": "iex", "optional": true } - ] + ], + "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EtfSectors]", + "type": "List[EquityQuote]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'tmx']]", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", "description": "Provider name." }, { @@ -28563,547 +18084,748 @@ "data": { "standard": [ { - "name": "sector", + "name": "symbol", "type": "str", - "description": "Sector of exposure.", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "weight", + "name": "asset_type", + "type": "str", + "description": "Type of asset - i.e, stock, ETF, etc.", + "default": null, + "optional": true + }, + { + "name": "name", + "type": "str", + "description": "Name of the company or asset.", + "default": null, + "optional": true + }, + { + "name": "exchange", + "type": "str", + "description": "The name or symbol of the venue where the data is from.", + "default": null, + "optional": true + }, + { + "name": "bid", "type": "float", - "description": "Exposure of the ETF to the sector in normalized percentage points.", - "default": "", - "optional": false - } - ], - "fmp": [], - "tmx": [] - }, - "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": [ + "description": "Price of the top bid order.", + "default": null, + "optional": true + }, { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, tmx.", - "default": "", - "optional": false + "name": "bid_size", + "type": "int", + "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'tmx']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "bid_exchange", + "type": "str", + "description": "The specific trading venue where the purchase order was placed.", + "default": null, "optional": true - } - ], - "fmp": [], - "tmx": [ + }, { - "name": "use_cache", - "type": "bool", - "description": "Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours.", - "default": true, + "name": "ask", + "type": "float", + "description": "Price of the top ask order.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[EtfCountries]", - "description": "Serializable results." + "name": "ask_size", + "type": "int", + "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fmp', 'tmx']]", - "description": "Provider name." + "name": "ask_exchange", + "type": "str", + "description": "The specific trading venue where the sale order was placed.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "quote_conditions", + "type": "Union[str, int, List[str], List[int]]", + "description": "Conditions or condition codes applicable to the quote.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "quote_indicators", + "type": "Union[str, int, List[str], List[int]]", + "description": "Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "sales_conditions", + "type": "Union[str, int, List[str], List[int]]", + "description": "Conditions or condition codes applicable to the sale.", + "default": null, + "optional": true + }, { - "name": "country", + "name": "sequence_number", + "type": "int", + "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11).", + "default": null, + "optional": true + }, + { + "name": "market_center", "type": "str", - "description": "The country of the exposure. Corresponding values are normalized percentage points.", - "default": "", - "optional": false - } - ], - "fmp": [], - "tmx": [] - }, - "model": "EtfCountries" - }, - "/etf/price_performance": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Price performance as a return, over different periods.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.price_performance(symbol='QQQ', provider='fmp')\nobb.etf.price_performance(symbol='SPY,QQQ,IWM,DJIA', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ + "description": "The ID of the UTP participant that originated the message.", + "default": null, + "optional": true + }, { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio.", - "default": "", - "optional": false + "name": "participant_timestamp", + "type": "datetime", + "description": "Timestamp for when the quote was generated by the exchange.", + "default": null, + "optional": true + }, + { + "name": "trf_timestamp", + "type": "datetime", + "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message.", + "default": null, + "optional": true + }, + { + "name": "sip_timestamp", + "type": "datetime", + "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange.", + "default": null, + "optional": true + }, + { + "name": "last_price", + "type": "float", + "description": "Price of the last trade.", + "default": null, + "optional": true + }, + { + "name": "last_tick", + "type": "str", + "description": "Whether the last sale was an up or down tick.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Literal['finviz', 'fmp', 'intrinio']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default.", - "default": "finviz", + "name": "last_size", + "type": "int", + "description": "Size of the last trade.", + "default": null, "optional": true - } - ], - "finviz": [], - "fmp": [], - "intrinio": [ + }, { - "name": "return_type", - "type": "Literal['trailing', 'calendar']", - "description": "The type of returns to return, a trailing or calendar window.", - "default": "trailing", + "name": "last_timestamp", + "type": "datetime", + "description": "Date and Time when the last price was recorded.", + "default": null, "optional": true }, { - "name": "adjustment", - "type": "Literal['splits_only', 'splits_and_dividends']", - "description": "The adjustment factor, 'splits_only' will return pure price performance.", - "default": "splits_and_dividends", + "name": "open", + "type": "float", + "description": "The open price.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EtfPricePerformance]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['finviz', 'fmp', 'intrinio']]", - "description": "Provider name." + "name": "high", + "type": "float", + "description": "The high price.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "low", + "type": "float", + "description": "The low price.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "volume", + "type": "Union[int, float]", + "description": "The trading volume.", + "default": null, + "optional": true + }, { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "exchange_volume", + "type": "Union[int, float]", + "description": "Volume of shares exchanged during the trading day on the specific exchange.", "default": null, "optional": true }, { - "name": "one_day", + "name": "prev_close", "type": "float", - "description": "One-day return.", + "description": "The previous close price.", "default": null, "optional": true }, { - "name": "wtd", + "name": "change", "type": "float", - "description": "Week to date return.", + "description": "Change in price from previous close.", "default": null, "optional": true }, { - "name": "one_week", + "name": "change_percent", "type": "float", - "description": "One-week return.", + "description": "Change in price as a normalized percentage.", "default": null, "optional": true }, { - "name": "mtd", + "name": "year_high", "type": "float", - "description": "Month to date return.", + "description": "The one year high (52W High).", "default": null, "optional": true }, { - "name": "one_month", + "name": "year_low", "type": "float", - "description": "One-month return.", + "description": "The one year low (52W Low).", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "qtd", + "name": "price_avg50", "type": "float", - "description": "Quarter to date return.", + "description": "50 day moving average price.", "default": null, "optional": true }, { - "name": "three_month", + "name": "price_avg200", "type": "float", - "description": "Three-month return.", + "description": "200 day moving average price.", "default": null, "optional": true }, { - "name": "six_month", + "name": "avg_volume", + "type": "int", + "description": "Average volume over the last 10 trading days.", + "default": null, + "optional": true + }, + { + "name": "market_cap", "type": "float", - "description": "Six-month return.", + "description": "Market cap of the company.", "default": null, "optional": true }, { - "name": "ytd", + "name": "shares_outstanding", + "type": "int", + "description": "Number of shares outstanding.", + "default": null, + "optional": true + }, + { + "name": "eps", "type": "float", - "description": "Year to date return.", + "description": "Earnings per share.", "default": null, "optional": true }, { - "name": "one_year", + "name": "pe", "type": "float", - "description": "One-year return.", + "description": "Price earnings ratio.", "default": null, "optional": true }, { - "name": "two_year", + "name": "earnings_announcement", + "type": "datetime", + "description": "Upcoming earnings announcement date.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "is_darkpool", + "type": "bool", + "description": "Whether or not the current trade is from a darkpool.", + "default": null, + "optional": true + }, + { + "name": "source", + "type": "str", + "description": "Source of the Intrinio data.", + "default": null, + "optional": true + }, + { + "name": "updated_on", + "type": "datetime", + "description": "Date and Time when the data was last updated.", + "default": "", + "optional": false + }, + { + "name": "security", + "type": "IntrinioSecurity", + "description": "Security details related to the quote.", + "default": null, + "optional": true + } + ], + "yfinance": [ + { + "name": "ma_50d", "type": "float", - "description": "Two-year return.", + "description": "50-day moving average price.", "default": null, "optional": true }, { - "name": "three_year", + "name": "ma_200d", "type": "float", - "description": "Three-year return.", + "description": "200-day moving average price.", "default": null, "optional": true }, { - "name": "four_year", + "name": "volume_average", "type": "float", - "description": "Four-year", + "description": "Average daily trading volume.", "default": null, "optional": true }, { - "name": "five_year", + "name": "volume_average_10d", "type": "float", - "description": "Five-year return.", + "description": "Average daily trading volume in the last 10 days.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency of the price.", + "default": null, + "optional": true + } + ] + }, + "model": "EquityQuote" + }, + "/equity/price/nbbo": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the National Best Bid and Offer for a given stock.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.nbbo(symbol='AAPL', provider='polygon')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['polygon']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'polygon' if there is no default.", + "default": "polygon", + "optional": true + } + ], + "polygon": [ + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return. Up to ten million records will be returned. Pagination occurs in groups of 50,000. Remaining limit values will always return 50,000 more records unless it is the last page. High volume tickers will require multiple max requests for a single day's NBBO records. Expect stocks, like SPY, to approach 1GB in size, per day, as a raw CSV. Splitting large requests into chunks is recommended for full-day requests of high-volume symbols.", + "default": 50000, + "optional": true + }, + { + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for. Use bracketed the timestamp parameters to specify exact time ranges.", + "default": null, + "optional": true + }, + { + "name": "timestamp_lt", + "type": "Union[datetime, str]", + "description": "Query by datetime, less than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", + "default": null, + "optional": true + }, + { + "name": "timestamp_gt", + "type": "Union[datetime, str]", + "description": "Query by datetime, greater than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", "default": null, "optional": true }, { - "name": "ten_year", - "type": "float", - "description": "Ten-year return.", + "name": "timestamp_lte", + "type": "Union[datetime, str]", + "description": "Query by datetime, less than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", "default": null, "optional": true }, { - "name": "max", - "type": "float", - "description": "Return from the beginning of the time series.", + "name": "timestamp_gte", + "type": "Union[datetime, str]", + "description": "Query by datetime, greater than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", "default": null, "optional": true } - ], - "finviz": [ + ] + }, + "returns": { + "OBBject": [ { - "name": "symbol", - "type": "str", - "description": "The ticker symbol.", - "default": null, - "optional": true + "name": "results", + "type": "List[EquityNBBO]", + "description": "Serializable results." }, { - "name": "volatility_week", - "type": "float", - "description": "One-week realized volatility, as a normalized percent.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['polygon']]", + "description": "Provider name." }, { - "name": "volatility_month", - "type": "float", - "description": "One-month realized volatility, as a normalized percent.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "price", - "type": "float", - "description": "Last Price.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "volume", - "type": "float", - "description": "Current volume.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "ask_exchange", + "type": "str", + "description": "The exchange ID for the ask.", + "default": "", + "optional": false }, { - "name": "average_volume", + "name": "ask", "type": "float", - "description": "Average daily volume.", - "default": null, - "optional": true + "description": "The last ask price.", + "default": "", + "optional": false }, { - "name": "relative_volume", - "type": "float", - "description": "Relative volume as a ratio of current volume to average volume.", - "default": null, - "optional": true + "name": "ask_size", + "type": "int", + "description": "The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price.", + "default": "", + "optional": false + }, + { + "name": "bid_size", + "type": "int", + "description": "The bid size in round lots.", + "default": "", + "optional": false }, { - "name": "analyst_recommendation", + "name": "bid", "type": "float", - "description": "The analyst consensus, on a scale of 1-5 where 1 is a buy and 5 is a sell.", - "default": null, - "optional": true - } - ], - "fmp": [ + "description": "The last bid price.", + "default": "", + "optional": false + }, { - "name": "symbol", + "name": "bid_exchange", "type": "str", - "description": "The ticker symbol.", + "description": "The exchange ID for the bid.", "default": "", "optional": false } ], - "intrinio": [ + "polygon": [ { - "name": "max_annualized", - "type": "float", - "description": "Annualized rate of return from inception.", + "name": "tape", + "type": "str", + "description": "The exchange tape.", "default": null, "optional": true }, { - "name": "volatility_one_year", - "type": "float", - "description": "Trailing one-year annualized volatility.", + "name": "conditions", + "type": "Union[str, List[int], List[str]]", + "description": "A list of condition codes.", "default": null, "optional": true }, { - "name": "volatility_three_year", - "type": "float", - "description": "Trailing three-year annualized volatility.", + "name": "indicators", + "type": "List[int]", + "description": "A list of indicator codes.", "default": null, "optional": true }, { - "name": "volatility_five_year", - "type": "float", - "description": "Trailing five-year annualized volatility.", + "name": "sequence_num", + "type": "int", + "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11)", "default": null, "optional": true }, { - "name": "volume", - "type": "int", - "description": "The trading volume.", + "name": "participant_timestamp", + "type": "datetime", + "description": "The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.", "default": null, "optional": true }, { - "name": "volume_avg_30", - "type": "float", - "description": "The one-month average daily volume.", + "name": "sip_timestamp", + "type": "datetime", + "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it.", "default": null, "optional": true }, { - "name": "volume_avg_90", - "type": "float", - "description": "The three-month average daily volume.", + "name": "trf_timestamp", + "type": "datetime", + "description": "The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this quote.", "default": null, "optional": true + } + ] + }, + "model": "EquityNBBO" + }, + "/equity/price/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical price data for a given stock. This includes open, high, low, close, and volume.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.historical(symbol='AAPL', provider='fmp')\nobb.equity.price.historical(symbol='AAPL', interval='1d', provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", + "default": "", + "optional": false }, { - "name": "volume_avg_180", - "type": "float", - "description": "The six-month average daily volume.", - "default": null, + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", "optional": true }, { - "name": "beta", - "type": "float", - "description": "Beta compared to the S&P 500.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "nav", - "type": "float", - "description": "Net asset value per share.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "year_high", - "type": "float", - "description": "The 52-week high price.", - "default": null, + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", "optional": true + } + ], + "intrinio": [ + { + "name": "symbol", + "type": "str", + "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", + "default": "", + "optional": false }, { - "name": "year_low", - "type": "float", - "description": "The 52-week low price.", - "default": null, + "name": "interval", + "type": "Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y']", + "description": "Time interval of the data to return.", + "default": "1d", "optional": true }, { - "name": "market_cap", - "type": "float", - "description": "The market capitalization.", + "name": "start_time", + "type": "datetime.time", + "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'.", "default": null, "optional": true }, { - "name": "shares_outstanding", - "type": "int", - "description": "The number of shares outstanding.", + "name": "end_time", + "type": "datetime.time", + "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'.", "default": null, "optional": true }, { - "name": "updated", - "type": "date", - "description": "The date of the data.", - "default": null, + "name": "timezone", + "type": "str", + "description": "Timezone of the data, in the IANA format (Continent/City).", + "default": "America/New_York", + "optional": true + }, + { + "name": "source", + "type": "Literal['realtime', 'delayed', 'nasdaq_basic']", + "description": "The source of the data.", + "default": "realtime", "optional": true } - ] - }, - "model": "EtfPricePerformance" - }, - "/etf/holdings": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the holdings for an individual ETF.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings(symbol='XLK', provider='fmp')\n# Including a date (FMP, SEC) will return the holdings as per NPORT-P filings.\nobb.etf.holdings(symbol='XLK', date=2022-03-31, provider='fmp')\n# The same data can be returned from the SEC directly.\nobb.etf.holdings(symbol='XLK', date=2022-03-31, provider='sec')\n```\n\n", - "parameters": { - "standard": [ + ], + "polygon": [ { - "name": "symbol", + "name": "interval", "type": "str", - "description": "Symbol to get data for. (ETF)", - "default": "", - "optional": false + "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", + "default": "1d", + "optional": true }, { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'sec', 'tmx']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "adjustment", + "type": "Literal['splits_only', 'unadjusted']", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", "optional": true - } - ], - "fmp": [ + }, { - "name": "date", - "type": "Union[Union[str, date], str]", - "description": "A specific date to get data for. Entering a date will attempt to return the NPORT-P filing for the entered date. This needs to be _exactly_ the date of the filing. Use the holdings_date command/endpoint to find available filing dates for the ETF.", - "default": null, + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": false, "optional": true }, { - "name": "cik", - "type": "str", - "description": "The CIK of the filing entity. Overrides symbol.", - "default": null, + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", + "default": "asc", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 49999, "optional": true } ], - "intrinio": [ + "tiingo": [ { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", - "default": null, + "name": "interval", + "type": "Literal['1d', '1W', '1M', '1Y']", + "description": "Time interval of the data to return.", + "default": "1d", "optional": true } ], - "sec": [ + "yfinance": [ { - "name": "date", - "type": "Union[Union[str, date], str]", - "description": "A specific date to get data for. The date represents the period ending. The date entered will return the closest filing.", - "default": null, + "name": "interval", + "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", + "description": "Time interval of the data to return.", + "default": "1d", "optional": true }, { - "name": "use_cache", + "name": "extended_hours", "type": "bool", - "description": "Whether or not to use cache for the request.", - "default": true, + "description": "Include Pre and Post market data.", + "default": false, "optional": true - } - ], - "tmx": [ + }, { - "name": "use_cache", + "name": "include_actions", "type": "bool", - "description": "Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours.", + "description": "Include dividends and stock splits in results.", "default": true, "optional": true + }, + { + "name": "adjustment", + "type": "Literal['splits_only', 'splits_and_dividends']", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", + "optional": true + }, + { + "name": "adjusted", + "type": "bool", + "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead.", + "default": false, + "optional": true + }, + { + "name": "prepost", + "type": "bool", + "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead.", + "default": false, + "optional": true } ] }, @@ -29111,12 +18833,12 @@ "OBBject": [ { "name": "results", - "type": "List[EtfHoldings]", + "type": "List[EquityHistorical]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'sec', 'tmx']]", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']]", "description": "Provider name." }, { @@ -29139,943 +18861,1050 @@ "data": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data. (ETF)", - "default": null, - "optional": true - }, - { - "name": "name", - "type": "str", - "description": "Name of the ETF holding.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "lei", - "type": "str", - "description": "The LEI of the holding.", - "default": null, - "optional": true - }, - { - "name": "title", - "type": "str", - "description": "The title of the holding.", - "default": null, - "optional": true - }, - { - "name": "cusip", - "type": "str", - "description": "The CUSIP of the holding.", - "default": null, - "optional": true - }, - { - "name": "isin", - "type": "str", - "description": "The ISIN of the holding.", - "default": null, - "optional": true - }, - { - "name": "balance", - "type": "int", - "description": "The balance of the holding, in shares or units.", - "default": null, - "optional": true - }, - { - "name": "units", - "type": "Union[str, float]", - "description": "The type of units.", - "default": null, - "optional": true - }, - { - "name": "currency", - "type": "str", - "description": "The currency of the holding.", - "default": null, - "optional": true + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "value", + "name": "open", "type": "float", - "description": "The value of the holding, in dollars.", - "default": null, - "optional": true + "description": "The open price.", + "default": "", + "optional": false }, { - "name": "weight", + "name": "high", "type": "float", - "description": "The weight of the holding, as a normalized percent.", - "default": null, - "optional": true - }, - { - "name": "payoff_profile", - "type": "str", - "description": "The payoff profile of the holding.", - "default": null, - "optional": true - }, - { - "name": "asset_category", - "type": "str", - "description": "The asset category of the holding.", - "default": null, - "optional": true - }, - { - "name": "issuer_category", - "type": "str", - "description": "The issuer category of the holding.", - "default": null, - "optional": true - }, - { - "name": "country", - "type": "str", - "description": "The country of the holding.", - "default": null, - "optional": true + "description": "The high price.", + "default": "", + "optional": false }, { - "name": "is_restricted", - "type": "str", - "description": "Whether the holding is restricted.", - "default": null, - "optional": true + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false }, { - "name": "fair_value_level", - "type": "int", - "description": "The fair value level of the holding.", - "default": null, - "optional": true + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false }, { - "name": "is_cash_collateral", - "type": "str", - "description": "Whether the holding is cash collateral.", + "name": "volume", + "type": "Union[int, float]", + "description": "The trading volume.", "default": null, "optional": true }, { - "name": "is_non_cash_collateral", - "type": "str", - "description": "Whether the holding is non-cash collateral.", + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "is_loan_by_fund", - "type": "str", - "description": "Whether the holding is loan by fund.", + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", "default": null, "optional": true }, { - "name": "cik", - "type": "str", - "description": "The CIK of the filing.", + "name": "unadjusted_volume", + "type": "float", + "description": "Unadjusted volume of the symbol.", "default": null, "optional": true }, { - "name": "acceptance_datetime", - "type": "str", - "description": "The acceptance datetime of the filing.", + "name": "change", + "type": "float", + "description": "Change in the price from the previous close.", "default": null, "optional": true }, { - "name": "updated", - "type": "Union[date, datetime]", - "description": "The date the data was updated.", + "name": "change_percent", + "type": "float", + "description": "Change in the price from the previous close, as a normalized percent.", "default": null, "optional": true } ], "intrinio": [ { - "name": "name", - "type": "str", - "description": "The common name for the holding.", - "default": null, - "optional": true - }, - { - "name": "security_type", - "type": "str", - "description": "The type of instrument for this holding. Examples(Bond='BOND', Equity='EQUI')", + "name": "average", + "type": "float", + "description": "Average trade price of an individual equity during the interval.", "default": null, "optional": true }, { - "name": "isin", - "type": "str", - "description": "The International Securities Identification Number.", + "name": "change", + "type": "float", + "description": "Change in the price of the symbol from the previous day.", "default": null, "optional": true }, { - "name": "ric", - "type": "str", - "description": "The Reuters Instrument Code.", + "name": "change_percent", + "type": "float", + "description": "Percent change in the price of the symbol from the previous day.", "default": null, "optional": true }, { - "name": "sedol", - "type": "str", - "description": "The Stock Exchange Daily Official List.", + "name": "adj_open", + "type": "float", + "description": "The adjusted open price.", "default": null, "optional": true }, { - "name": "share_class_figi", - "type": "str", - "description": "The OpenFIGI symbol for the holding.", + "name": "adj_high", + "type": "float", + "description": "The adjusted high price.", "default": null, "optional": true }, { - "name": "country", - "type": "str", - "description": "The country or region of the holding.", + "name": "adj_low", + "type": "float", + "description": "The adjusted low price.", "default": null, "optional": true }, { - "name": "maturity_date", - "type": "date", - "description": "The maturity date for the debt security, if available.", + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", "default": null, "optional": true }, { - "name": "contract_expiry_date", - "type": "date", - "description": "Expiry date for the futures contract held, if available.", + "name": "adj_volume", + "type": "float", + "description": "The adjusted volume.", "default": null, "optional": true }, { - "name": "coupon", + "name": "fifty_two_week_high", "type": "float", - "description": "The coupon rate of the debt security, if available.", + "description": "52 week high price for the symbol.", "default": null, "optional": true }, { - "name": "balance", - "type": "Union[int, float]", - "description": "The number of units of the security held, if available.", + "name": "fifty_two_week_low", + "type": "float", + "description": "52 week low price for the symbol.", "default": null, "optional": true }, { - "name": "unit", - "type": "str", - "description": "The units of the 'balance' field.", + "name": "factor", + "type": "float", + "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices.", "default": null, "optional": true }, { - "name": "units_per_share", + "name": "split_ratio", "type": "float", - "description": "Number of units of the security held per share outstanding of the ETF, if available.", + "description": "Ratio of the equity split, if a split occurred.", "default": null, "optional": true }, { - "name": "face_value", + "name": "dividend", "type": "float", - "description": "The face value of the debt security, if available.", + "description": "Dividend amount, if a dividend was paid.", "default": null, "optional": true }, { - "name": "derivatives_value", - "type": "float", - "description": "The notional value of derivatives contracts held.", + "name": "close_time", + "type": "datetime", + "description": "The timestamp that represents the end of the interval span.", "default": null, "optional": true }, { - "name": "value", - "type": "float", - "description": "The market value of the holding, on the 'as_of' date.", + "name": "interval", + "type": "str", + "description": "The data time frequency.", "default": null, "optional": true }, { - "name": "weight", - "type": "float", - "description": "The weight of the holding, as a normalized percent.", + "name": "intra_period", + "type": "bool", + "description": "If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period", "default": null, "optional": true - }, + } + ], + "polygon": [ { - "name": "updated", - "type": "date", - "description": "The 'as_of' date for the holding.", + "name": "transactions", + "type": "Annotated[int, Gt(gt=0)]", + "description": "Number of transactions for the symbol in the time period.", "default": null, "optional": true } ], - "sec": [ + "tiingo": [ { - "name": "lei", - "type": "str", - "description": "The LEI of the holding.", + "name": "adj_open", + "type": "float", + "description": "The adjusted open price.", "default": null, "optional": true }, { - "name": "cusip", - "type": "str", - "description": "The CUSIP of the holding.", + "name": "adj_high", + "type": "float", + "description": "The adjusted high price.", "default": null, "optional": true }, { - "name": "isin", - "type": "str", - "description": "The ISIN of the holding.", + "name": "adj_low", + "type": "float", + "description": "The adjusted low price.", "default": null, "optional": true }, { - "name": "other_id", - "type": "str", - "description": "Internal identifier for the holding.", + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", "default": null, "optional": true }, { - "name": "balance", + "name": "adj_volume", "type": "float", - "description": "The balance of the holding.", + "description": "The adjusted volume.", "default": null, "optional": true }, { - "name": "weight", + "name": "split_ratio", "type": "float", - "description": "The weight of the holding in ETF in %.", + "description": "Ratio of the equity split, if a split occurred.", "default": null, "optional": true }, { - "name": "value", + "name": "dividend", "type": "float", - "description": "The value of the holding in USD.", + "description": "Dividend amount, if a dividend was paid.", "default": null, "optional": true - }, + } + ], + "yfinance": [ { - "name": "payoff_profile", - "type": "str", - "description": "The payoff profile of the holding.", + "name": "split_ratio", + "type": "float", + "description": "Ratio of the equity split, if a split occurred.", "default": null, "optional": true }, { - "name": "units", - "type": "Union[str, float]", - "description": "The units of the holding.", + "name": "dividend", + "type": "float", + "description": "Dividend amount (split-adjusted), if a dividend was paid.", "default": null, "optional": true + } + ] + }, + "model": "EquityHistorical" + }, + "/equity/price/performance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get price performance data for a given stock. This includes price changes for different time periods.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.performance(symbol='AAPL', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[PricePerformance]", + "description": "Serializable results." }, { - "name": "currency", + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", "type": "str", - "description": "The currency of the holding.", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "asset_category", - "type": "str", - "description": "The asset category of the holding.", + "name": "one_day", + "type": "float", + "description": "One-day return.", "default": null, "optional": true }, { - "name": "issuer_category", - "type": "str", - "description": "The issuer category of the holding.", + "name": "wtd", + "type": "float", + "description": "Week to date return.", "default": null, "optional": true }, { - "name": "country", - "type": "str", - "description": "The country of the holding.", + "name": "one_week", + "type": "float", + "description": "One-week return.", "default": null, "optional": true }, { - "name": "is_restricted", - "type": "str", - "description": "Whether the holding is restricted.", + "name": "mtd", + "type": "float", + "description": "Month to date return.", "default": null, "optional": true }, { - "name": "fair_value_level", - "type": "int", - "description": "The fair value level of the holding.", + "name": "one_month", + "type": "float", + "description": "One-month return.", "default": null, "optional": true }, { - "name": "is_cash_collateral", - "type": "str", - "description": "Whether the holding is cash collateral.", + "name": "qtd", + "type": "float", + "description": "Quarter to date return.", "default": null, "optional": true }, { - "name": "is_non_cash_collateral", - "type": "str", - "description": "Whether the holding is non-cash collateral.", + "name": "three_month", + "type": "float", + "description": "Three-month return.", "default": null, "optional": true }, { - "name": "is_loan_by_fund", - "type": "str", - "description": "Whether the holding is loan by fund.", + "name": "six_month", + "type": "float", + "description": "Six-month return.", "default": null, "optional": true }, { - "name": "loan_value", + "name": "ytd", "type": "float", - "description": "The loan value of the holding.", + "description": "Year to date return.", "default": null, "optional": true }, { - "name": "issuer_conditional", - "type": "str", - "description": "The issuer conditions of the holding.", + "name": "one_year", + "type": "float", + "description": "One-year return.", "default": null, "optional": true }, { - "name": "asset_conditional", - "type": "str", - "description": "The asset conditions of the holding.", + "name": "two_year", + "type": "float", + "description": "Two-year return.", "default": null, "optional": true }, { - "name": "maturity_date", - "type": "date", - "description": "The maturity date of the debt security.", + "name": "three_year", + "type": "float", + "description": "Three-year return.", "default": null, "optional": true }, { - "name": "coupon_kind", - "type": "str", - "description": "The type of coupon for the debt security.", + "name": "four_year", + "type": "float", + "description": "Four-year", "default": null, "optional": true }, { - "name": "rate_type", - "type": "str", - "description": "The type of rate for the debt security, floating or fixed.", + "name": "five_year", + "type": "float", + "description": "Five-year return.", "default": null, "optional": true }, { - "name": "annualized_return", + "name": "ten_year", "type": "float", - "description": "The annualized return on the debt security.", + "description": "Ten-year return.", "default": null, "optional": true }, { - "name": "is_default", - "type": "str", - "description": "If the debt security is defaulted.", + "name": "max", + "type": "float", + "description": "Return from the beginning of the time series.", "default": null, "optional": true - }, + } + ], + "fmp": [ { - "name": "in_arrears", + "name": "symbol", "type": "str", - "description": "If the debt security is in arrears.", - "default": null, - "optional": true - }, + "description": "The ticker symbol.", + "default": "", + "optional": false + } + ] + }, + "model": "PricePerformance" + }, + "/equity/shorts/fails_to_deliver": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get reported Fail-to-deliver (FTD) data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.shorts.fails_to_deliver(symbol='AAPL', provider='sec')\n```\n\n", + "parameters": { + "standard": [ { - "name": "is_paid_kind", + "name": "symbol", "type": "str", - "description": "If the debt security payments are paid in kind.", - "default": null, + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, + { + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", + "optional": true + } + ], + "sec": [ + { + "name": "limit", + "type": "int", + "description": "Limit the number of reports to parse, from most recent. Approximately 24 reports per year, going back to 2009.", + "default": 24, "optional": true }, { - "name": "derivative_category", - "type": "str", - "description": "The derivative category of the holding.", - "default": null, + "name": "skip_reports", + "type": "int", + "description": "Skip N number of reports from current. A value of 1 will skip the most recent report.", + "default": 0, "optional": true }, { - "name": "counterparty", - "type": "str", - "description": "The counterparty of the derivative.", - "default": null, + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache for the request, default is True. Each reporting period is a separate URL, new reports will be added to the cache.", + "default": true, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityFTD]", + "description": "Serializable results." }, { - "name": "underlying_name", - "type": "str", - "description": "The name of the underlying asset associated with the derivative.", + "name": "provider", + "type": "Optional[Literal['sec']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "settlement_date", + "type": "date", + "description": "The settlement date of the fail.", "default": null, "optional": true }, { - "name": "option_type", + "name": "symbol", "type": "str", - "description": "The type of option.", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "derivative_payoff", + "name": "cusip", "type": "str", - "description": "The payoff profile of the derivative.", + "description": "CUSIP of the Security.", "default": null, "optional": true }, { - "name": "expiry_date", - "type": "date", - "description": "The expiry or termination date of the derivative.", + "name": "quantity", + "type": "int", + "description": "The number of fails on that settlement date.", "default": null, "optional": true }, { - "name": "exercise_price", + "name": "price", "type": "float", - "description": "The exercise price of the option.", + "description": "The price at the previous closing price from the settlement date.", "default": null, "optional": true }, { - "name": "exercise_currency", + "name": "description", "type": "str", - "description": "The currency of the option exercise price.", + "description": "The description of the Security.", "default": null, "optional": true - }, + } + ], + "sec": [] + }, + "model": "EquityFTD" + }, + "/equity/search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search for stock symbol, CIK, LEI, or company name.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.search(provider='intrinio')\n```\n\n", + "parameters": { + "standard": [ { - "name": "shares_per_contract", - "type": "float", - "description": "The number of shares per contract.", - "default": null, + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", "optional": true }, { - "name": "delta", - "type": "Union[str, float]", - "description": "The delta of the option.", - "default": null, + "name": "is_symbol", + "type": "bool", + "description": "Whether to search by ticker symbol.", + "default": false, "optional": true }, { - "name": "rate_type_rec", - "type": "str", - "description": "The type of rate for receivable portion of the swap.", - "default": null, + "name": "use_cache", + "type": "bool", + "description": "Whether to use the cache or not.", + "default": true, "optional": true }, { - "name": "receive_currency", - "type": "str", - "description": "The receive currency of the swap.", - "default": null, + "name": "provider", + "type": "Literal['intrinio', 'sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.", + "default": "intrinio", + "optional": true + } + ], + "intrinio": [ + { + "name": "active", + "type": "bool", + "description": "When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded.", + "default": true, "optional": true }, { - "name": "upfront_receive", - "type": "float", - "description": "The upfront amount received of the swap.", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10000, "optional": true - }, + } + ], + "sec": [ { - "name": "floating_rate_index_rec", - "type": "str", - "description": "The floating rate index for receivable portion of the swap.", - "default": null, + "name": "is_fund", + "type": "bool", + "description": "Whether to direct the search to the list of mutual funds and ETFs.", + "default": false, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquitySearch]", + "description": "Serializable results." }, { - "name": "floating_rate_spread_rec", - "type": "float", - "description": "The floating rate spread for reveivable portion of the swap.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['intrinio', 'sec']]", + "description": "Provider name." }, { - "name": "rate_tenor_rec", - "type": "str", - "description": "The rate tenor for receivable portion of the swap.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "rate_tenor_unit_rec", - "type": "Union[int, str]", - "description": "The rate tenor unit for receivable portion of the swap.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "reset_date_rec", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", "type": "str", - "description": "The reset date for receivable portion of the swap.", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "reset_date_unit_rec", - "type": "Union[int, str]", - "description": "The reset date unit for receivable portion of the swap.", + "name": "name", + "type": "str", + "description": "Name of the company.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "rate_type_pmnt", + "name": "cik", "type": "str", - "description": "The type of rate for payment portion of the swap.", - "default": null, - "optional": true + "description": "", + "default": "", + "optional": false }, { - "name": "payment_currency", + "name": "lei", "type": "str", - "description": "The payment currency of the swap.", - "default": null, - "optional": true + "description": "The Legal Entity Identifier (LEI) of the company.", + "default": "", + "optional": false }, { - "name": "upfront_payment", - "type": "float", - "description": "The upfront amount received of the swap.", - "default": null, - "optional": true - }, + "name": "intrinio_id", + "type": "str", + "description": "The Intrinio ID of the company.", + "default": "", + "optional": false + } + ], + "sec": [ { - "name": "floating_rate_index_pmnt", + "name": "cik", "type": "str", - "description": "The floating rate index for payment portion of the swap.", - "default": null, + "description": "Central Index Key", + "default": "", + "optional": false + } + ] + }, + "model": "EquitySearch" + }, + "/equity/screener": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Screen for companies meeting various criteria.\n\nThese criteria include market cap, price, beta, volume, and dividend yield.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.screener(provider='fmp')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "floating_rate_spread_pmnt", - "type": "float", - "description": "The floating rate spread for payment portion of the swap.", + "name": "mktcap_min", + "type": "int", + "description": "Filter by market cap greater than this value.", "default": null, "optional": true }, { - "name": "rate_tenor_pmnt", - "type": "str", - "description": "The rate tenor for payment portion of the swap.", + "name": "mktcap_max", + "type": "int", + "description": "Filter by market cap less than this value.", "default": null, "optional": true }, { - "name": "rate_tenor_unit_pmnt", - "type": "Union[int, str]", - "description": "The rate tenor unit for payment portion of the swap.", + "name": "price_min", + "type": "float", + "description": "Filter by price greater than this value.", "default": null, "optional": true }, { - "name": "reset_date_pmnt", - "type": "str", - "description": "The reset date for payment portion of the swap.", + "name": "price_max", + "type": "float", + "description": "Filter by price less than this value.", "default": null, "optional": true }, { - "name": "reset_date_unit_pmnt", - "type": "Union[int, str]", - "description": "The reset date unit for payment portion of the swap.", + "name": "beta_min", + "type": "float", + "description": "Filter by a beta greater than this value.", "default": null, "optional": true }, { - "name": "repo_type", - "type": "str", - "description": "The type of repo.", + "name": "beta_max", + "type": "float", + "description": "Filter by a beta less than this value.", "default": null, "optional": true }, { - "name": "is_cleared", - "type": "str", - "description": "If the repo is cleared.", + "name": "volume_min", + "type": "int", + "description": "Filter by volume greater than this value.", "default": null, "optional": true }, { - "name": "is_tri_party", - "type": "str", - "description": "If the repo is tri party.", + "name": "volume_max", + "type": "int", + "description": "Filter by volume less than this value.", "default": null, "optional": true }, { - "name": "principal_amount", + "name": "dividend_min", "type": "float", - "description": "The principal amount of the repo.", + "description": "Filter by dividend amount greater than this value.", "default": null, "optional": true }, { - "name": "principal_currency", - "type": "str", - "description": "The currency of the principal amount.", + "name": "dividend_max", + "type": "float", + "description": "Filter by dividend amount less than this value.", "default": null, "optional": true }, { - "name": "collateral_type", - "type": "str", - "description": "The collateral type of the repo.", - "default": null, + "name": "is_etf", + "type": "bool", + "description": "If true, returns only ETFs.", + "default": false, "optional": true }, { - "name": "collateral_amount", - "type": "float", - "description": "The collateral amount of the repo.", - "default": null, + "name": "is_active", + "type": "bool", + "description": "If false, returns only inactive tickers.", + "default": true, "optional": true }, { - "name": "collateral_currency", - "type": "str", - "description": "The currency of the collateral amount.", + "name": "sector", + "type": "Literal['Consumer Cyclical', 'Energy', 'Technology', 'Industrials', 'Financial Services', 'Basic Materials', 'Communication Services', 'Consumer Defensive', 'Healthcare', 'Real Estate', 'Utilities', 'Industrial Goods', 'Financial', 'Services', 'Conglomerates']", + "description": "Filter by sector.", "default": null, "optional": true }, { - "name": "exchange_currency", + "name": "industry", "type": "str", - "description": "The currency of the exchange rate.", + "description": "Filter by industry.", "default": null, "optional": true }, { - "name": "exchange_rate", - "type": "float", - "description": "The exchange rate.", + "name": "country", + "type": "str", + "description": "Filter by country, as a two-letter country code.", "default": null, "optional": true }, { - "name": "currency_sold", - "type": "str", - "description": "The currency sold in a Forward Derivative.", + "name": "exchange", + "type": "Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra']", + "description": "Filter by exchange.", "default": null, "optional": true }, { - "name": "currency_amount_sold", - "type": "float", - "description": "The amount of currency sold in a Forward Derivative.", - "default": null, + "name": "limit", + "type": "int", + "description": "Limit the number of results to return.", + "default": 50000, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[EquityScreener]", + "description": "Serializable results." }, { - "name": "currency_bought", - "type": "str", - "description": "The currency bought in a Forward Derivative.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "currency_amount_bought", - "type": "float", - "description": "The amount of currency bought in a Forward Derivative.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "notional_amount", - "type": "float", - "description": "The notional amount of the derivative.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "notional_currency", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", "type": "str", - "description": "The currency of the derivative's notional amount.", - "default": null, - "optional": true + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false }, { - "name": "unrealized_gain", - "type": "float", - "description": "The unrealized gain or loss on the derivative.", - "default": null, - "optional": true + "name": "name", + "type": "str", + "description": "Name of the company.", + "default": "", + "optional": false } ], - "tmx": [ + "fmp": [ { - "name": "symbol", - "type": "str", - "description": "The ticker symbol of the asset.", + "name": "market_cap", + "type": "int", + "description": "The market cap of ticker.", "default": null, "optional": true }, { - "name": "name", + "name": "sector", "type": "str", - "description": "The name of the asset.", + "description": "The sector the ticker belongs to.", "default": null, "optional": true }, { - "name": "weight", - "type": "float", - "description": "The weight of the asset in the portfolio, as a normalized percentage.", + "name": "industry", + "type": "str", + "description": "The industry ticker belongs to.", "default": null, "optional": true }, { - "name": "shares", - "type": "Union[int, str]", - "description": "The value of the assets under management.", + "name": "beta", + "type": "float", + "description": "The beta of the ETF.", "default": null, "optional": true }, { - "name": "market_value", - "type": "Union[str, float]", - "description": "The market value of the holding.", + "name": "price", + "type": "float", + "description": "The current price.", "default": null, "optional": true }, { - "name": "currency", - "type": "str", - "description": "The currency of the holding.", - "default": "", - "optional": false - }, - { - "name": "share_percentage", + "name": "last_annual_dividend", "type": "float", - "description": "The share percentage of the holding, as a normalized percentage.", + "description": "The last annual amount dividend paid.", "default": null, "optional": true }, { - "name": "share_change", - "type": "Union[str, float]", - "description": "The change in shares of the holding.", + "name": "volume", + "type": "int", + "description": "The current trading volume.", "default": null, "optional": true }, { - "name": "country", + "name": "exchange", "type": "str", - "description": "The country of the holding.", + "description": "The exchange code the asset trades on.", "default": null, "optional": true }, { - "name": "exchange", + "name": "exchange_name", "type": "str", - "description": "The exchange code of the holding.", + "description": "The full name of the primary exchange.", "default": null, "optional": true }, { - "name": "type_id", + "name": "country", "type": "str", - "description": "The holding type ID of the asset.", + "description": "The two-letter country abbreviation where the head office is located.", "default": null, "optional": true }, { - "name": "fund_id", - "type": "str", - "description": "The fund ID of the asset.", + "name": "is_etf", + "type": "Literal[True, False]", + "description": "Whether the ticker is an ETF.", + "default": null, + "optional": true + }, + { + "name": "actively_trading", + "type": "Literal[True, False]", + "description": "Whether the ETF is actively trading.", "default": null, "optional": true } ] }, - "model": "EtfHoldings" + "model": "EquityScreener" }, - "/etf/holdings_date": { + "/equity/profile": { "deprecated": { "flag": null, "message": null }, - "description": "Use this function to get the holdings dates, if available.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings_date(symbol='XLK', provider='fmp')\n```\n\n", + "description": "Get general information about a company. This includes company name, industry, sector and price data.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.profile(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", - "type": "str", - "description": "Symbol to get data for. (ETF)", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": "", "optional": false }, { "name": "provider", - "type": "Literal['fmp']", + "type": "Literal['fmp', 'intrinio', 'yfinance']", "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", "default": "fmp", "optional": true } ], - "fmp": [ - { - "name": "cik", - "type": "str", - "description": "The CIK of the filing entity. Overrides symbol.", - "default": null, - "optional": true - } - ] + "fmp": [], + "intrinio": [], + "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[EtfHoldingsDate]", + "type": "List[EquityInfo]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fmp']]", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", "description": "Provider name." }, { @@ -30096,530 +19925,505 @@ ] }, "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - } - ], - "fmp": [] - }, - "model": "EtfHoldingsDate" - }, - "/etf/holdings_performance": { - "deprecated": { - "flag": true, - "message": "This endpoint is deprecated; pass a list of holdings symbols directly to `/equity/price/performance` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.2." - }, - "description": "Get the recent price performance of each ticker held in the ETF.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings_performance(symbol='XLK', provider='fmp')\n```\n\n", - "parameters": { "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "name", + "type": "str", + "description": "Common name of the company.", + "default": null, "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[EtfHoldingsPerformance]", - "description": "Serializable results." + "name": "cik", + "type": "str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "cusip", + "type": "str", + "description": "CUSIP identifier for the company.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "isin", + "type": "str", + "description": "International Securities Identification Number.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "lei", + "type": "str", + "description": "Legal Entity Identifier assigned to the company.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "legal_name", + "type": "str", + "description": "Official legal name of the company.", + "default": null, + "optional": true + }, + { + "name": "stock_exchange", + "type": "str", + "description": "Stock exchange where the company is traded.", + "default": null, + "optional": true + }, + { + "name": "sic", + "type": "int", + "description": "Standard Industrial Classification code for the company.", + "default": null, + "optional": true + }, + { + "name": "short_description", + "type": "str", + "description": "Short description of the company.", + "default": null, + "optional": true + }, + { + "name": "long_description", + "type": "str", + "description": "Long description of the company.", + "default": null, + "optional": true + }, + { + "name": "ceo", + "type": "str", + "description": "Chief Executive Officer of the company.", + "default": null, + "optional": true + }, + { + "name": "company_url", + "type": "str", + "description": "URL of the company's website.", + "default": null, + "optional": true + }, { - "name": "symbol", + "name": "business_address", "type": "str", - "description": "Symbol representing the entity requested in the data.", + "description": "Address of the company's headquarters.", "default": null, "optional": true }, { - "name": "one_day", - "type": "float", - "description": "One-day return.", + "name": "mailing_address", + "type": "str", + "description": "Mailing address of the company.", "default": null, "optional": true }, { - "name": "wtd", - "type": "float", - "description": "Week to date return.", + "name": "business_phone_no", + "type": "str", + "description": "Phone number of the company's headquarters.", "default": null, "optional": true }, { - "name": "one_week", - "type": "float", - "description": "One-week return.", + "name": "hq_address1", + "type": "str", + "description": "Address of the company's headquarters.", "default": null, "optional": true }, { - "name": "mtd", - "type": "float", - "description": "Month to date return.", + "name": "hq_address2", + "type": "str", + "description": "Address of the company's headquarters.", "default": null, "optional": true }, { - "name": "one_month", - "type": "float", - "description": "One-month return.", + "name": "hq_address_city", + "type": "str", + "description": "City of the company's headquarters.", "default": null, "optional": true }, { - "name": "qtd", - "type": "float", - "description": "Quarter to date return.", + "name": "hq_address_postal_code", + "type": "str", + "description": "Zip code of the company's headquarters.", "default": null, "optional": true }, { - "name": "three_month", - "type": "float", - "description": "Three-month return.", + "name": "hq_state", + "type": "str", + "description": "State of the company's headquarters.", "default": null, "optional": true }, { - "name": "six_month", - "type": "float", - "description": "Six-month return.", + "name": "hq_country", + "type": "str", + "description": "Country of the company's headquarters.", "default": null, "optional": true }, { - "name": "ytd", - "type": "float", - "description": "Year to date return.", + "name": "inc_state", + "type": "str", + "description": "State in which the company is incorporated.", "default": null, "optional": true }, { - "name": "one_year", - "type": "float", - "description": "One-year return.", + "name": "inc_country", + "type": "str", + "description": "Country in which the company is incorporated.", "default": null, "optional": true }, { - "name": "two_year", - "type": "float", - "description": "Two-year return.", + "name": "employees", + "type": "int", + "description": "Number of employees working for the company.", "default": null, "optional": true }, { - "name": "three_year", - "type": "float", - "description": "Three-year return.", + "name": "entity_legal_form", + "type": "str", + "description": "Legal form of the company.", "default": null, "optional": true }, { - "name": "four_year", - "type": "float", - "description": "Four-year", + "name": "entity_status", + "type": "str", + "description": "Status of the company.", "default": null, "optional": true }, { - "name": "five_year", - "type": "float", - "description": "Five-year return.", + "name": "latest_filing_date", + "type": "date", + "description": "Date of the company's latest filing.", "default": null, "optional": true }, { - "name": "ten_year", - "type": "float", - "description": "Ten-year return.", + "name": "irs_number", + "type": "str", + "description": "IRS number assigned to the company.", "default": null, "optional": true }, { - "name": "max", - "type": "float", - "description": "Return from the beginning of the time series.", + "name": "sector", + "type": "str", + "description": "Sector in which the company operates.", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "symbol", + "name": "industry_category", "type": "str", - "description": "The ticker symbol.", - "default": "", - "optional": false - } - ] - }, - "model": "EtfHoldingsPerformance" - }, - "/etf/equity_exposure": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the exposure to ETFs for a specific stock.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.equity_exposure(symbol='MSFT', provider='fmp')\n# This function accepts multiple tickers.\nobb.etf.equity_exposure(symbol='MSFT,AAPL', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ + "description": "Category of industry in which the company operates.", + "default": null, + "optional": true + }, { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp.", - "default": "", - "optional": false + "name": "industry_group", + "type": "str", + "description": "Group of industry in which the company operates.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", + "name": "template", + "type": "str", + "description": "Template used to standardize the company's financial statements.", + "default": null, "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[EtfEquityExposure]", - "description": "Serializable results." + "name": "standardized_active", + "type": "bool", + "description": "Whether the company is active or not.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." + "name": "first_fundamental_date", + "type": "date", + "description": "Date of the company's first fundamental.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "last_fundamental_date", + "type": "date", + "description": "Date of the company's last fundamental.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "first_stock_price_date", + "type": "date", + "description": "Date of the company's first stock price.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "last_stock_price_date", + "type": "date", + "description": "Date of the company's last stock price.", + "default": null, + "optional": true } - ] - }, - "data": { - "standard": [ + ], + "fmp": [ { - "name": "equity_symbol", - "type": "str", - "description": "The symbol of the equity requested.", + "name": "is_etf", + "type": "bool", + "description": "If the symbol is an ETF.", "default": "", "optional": false }, { - "name": "etf_symbol", - "type": "str", - "description": "The symbol of the ETF with exposure to the requested equity.", + "name": "is_actively_trading", + "type": "bool", + "description": "If the company is actively trading.", "default": "", "optional": false }, { - "name": "shares", - "type": "float", - "description": "The number of shares held in the ETF.", - "default": null, - "optional": true + "name": "is_adr", + "type": "bool", + "description": "If the stock is an ADR.", + "default": "", + "optional": false }, { - "name": "weight", - "type": "float", - "description": "The weight of the equity in the ETF, as a normalized percent.", - "default": null, - "optional": true + "name": "is_fund", + "type": "bool", + "description": "If the company is a fund.", + "default": "", + "optional": false }, { - "name": "market_value", - "type": "Union[int, float]", - "description": "The market value of the equity position in the ETF.", + "name": "image", + "type": "str", + "description": "Image of the company.", "default": null, "optional": true - } - ], - "fmp": [] - }, - "model": "EtfEquityExposure" - }, - "/fixedincome/rate/ameribor": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Ameribor.\n\nAmeribor (short for the American interbank offered rate) is a benchmark interest rate that reflects the true cost of\nshort-term interbank borrowing. This rate is based on transactions in overnight unsecured loans conducted on the\nAmerican Financial Exchange (AFX).", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.ameribor(provider='fred')\nobb.fixedincome.rate.ameribor(parameter=30_day_ma, provider='fred')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "currency", + "type": "str", + "description": "Currency in which the stock is traded.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "market_cap", + "type": "int", + "description": "Market capitalization of the company.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "name": "last_price", + "type": "float", + "description": "The last traded price.", + "default": null, "optional": true - } - ], - "fred": [ + }, { - "name": "parameter", - "type": "Literal['overnight', 'term_30', 'term_90', '1_week_term_structure', '1_month_term_structure', '3_month_term_structure', '6_month_term_structure', '1_year_term_structure', '2_year_term_structure', '30_day_ma', '90_day_ma']", - "description": "Period of AMERIBOR rate.", - "default": "overnight", + "name": "year_high", + "type": "float", + "description": "The one-year high of the price.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[AMERIBOR]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." + "name": "year_low", + "type": "float", + "description": "The one-year low of the price.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "volume_avg", + "type": "int", + "description": "Average daily trading volume.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "annualized_dividend_amount", + "type": "float", + "description": "The annualized dividend payment based on the most recent regular dividend payment.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "beta", + "type": "float", + "description": "Beta of the stock relative to the market.", + "default": null, + "optional": true } - ] - }, - "data": { - "standard": [ + ], + "intrinio": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "id", + "type": "str", + "description": "Intrinio ID for the company.", + "default": null, + "optional": true }, { - "name": "rate", - "type": "float", - "description": "AMERIBOR rate.", - "default": "", - "optional": false + "name": "thea_enabled", + "type": "bool", + "description": "Whether the company has been enabled for Thea.", + "default": null, + "optional": true } ], - "fred": [] - }, - "model": "AMERIBOR" - }, - "/fixedincome/rate/sonia": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Sterling Overnight Index Average.\n\nSONIA (Sterling Overnight Index Average) is an important interest rate benchmark. SONIA is based on actual\ntransactions and reflects the average of the interest rates that banks pay to borrow sterling overnight from other\nfinancial institutions and other institutional investors.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.sonia(provider='fred')\nobb.fixedincome.rate.sonia(parameter=total_nominal_value, provider='fred')\n```\n\n", - "parameters": { - "standard": [ + "yfinance": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "exchange_timezone", + "type": "str", + "description": "The timezone of the exchange.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "issue_type", + "type": "str", + "description": "The issuance type of the asset.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "name": "currency", + "type": "str", + "description": "The currency in which the asset is traded.", + "default": null, "optional": true - } - ], - "fred": [ + }, { - "name": "parameter", - "type": "Literal['rate', 'index', '10th_percentile', '25th_percentile', '75th_percentile', '90th_percentile', 'total_nominal_value']", - "description": "Period of SONIA rate.", - "default": "rate", + "name": "market_cap", + "type": "int", + "description": "The market capitalization of the asset.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[SONIA]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." + "name": "shares_outstanding", + "type": "int", + "description": "The number of listed shares outstanding.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "shares_float", + "type": "int", + "description": "The number of shares in the public float.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "shares_implied_outstanding", + "type": "int", + "description": "Implied shares outstanding of common equityassuming the conversion of all convertible subsidiary equity into common.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "shares_short", + "type": "int", + "description": "The reported number of shares short.", + "default": null, + "optional": true + }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "dividend_yield", + "type": "float", + "description": "The dividend yield of the asset, as a normalized percent.", + "default": null, + "optional": true }, { - "name": "rate", + "name": "beta", "type": "float", - "description": "SONIA rate.", - "default": "", - "optional": false + "description": "The beta of the asset relative to the broad market.", + "default": null, + "optional": true } - ], - "fred": [] + ] }, - "model": "SONIA" + "model": "EquityInfo" }, - "/fixedincome/rate/iorb": { + "/equity/market_snapshots": { "deprecated": { "flag": null, "message": null }, - "description": "Interest on Reserve Balances.\n\nGet Interest Rate on Reserve Balances data A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.iorb(provider='fred')\n```\n\n", + "description": "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": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [ { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, + "name": "market", + "type": "Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra']", + "description": "The market to fetch data for.", + "default": "nasdaq", "optional": true - }, + } + ], + "intrinio": [ { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "name": "date", + "type": "Union[Union[date, datetime, str], str]", + "description": "The date of the data. Can be a datetime or an ISO datetime string. Historical data appears to go back to mid-June 2022. Example: '2024-03-08T12:15:00+0400'", + "default": null, "optional": true } ], - "fred": [] + "polygon": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[IORB]", + "type": "List[MarketSnapshots]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fred']]", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon']]", "description": "Provider name." }, { @@ -30642,454 +20446,411 @@ "data": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "rate", + "name": "open", "type": "float", - "description": "IORB rate.", - "default": "", - "optional": false - } - ], - "fred": [] - }, - "model": "IORB" - }, - "/fixedincome/rate/effr": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Fed Funds Rate.\n\nGet Effective Federal Funds Rate data. A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.effr(provider='fred')\nobb.fixedincome.rate.effr(parameter=daily, provider='fred')\n```\n\n", - "parameters": { - "standard": [ + "description": "The open price.", + "default": null, + "optional": true + }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "high", + "type": "float", + "description": "The high price.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "low", + "type": "float", + "description": "The low price.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['federal_reserve', 'fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default.", - "default": "federal_reserve", + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, "optional": true - } - ], - "federal_reserve": [], - "fred": [ + }, { - "name": "parameter", - "type": "Literal['monthly', 'daily', 'weekly', 'daily_excl_weekend', 'annual', 'biweekly', 'volume']", - "description": "Period of FED rate.", - "default": "weekly", + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[FEDFUNDS]", - "description": "Serializable results." + "name": "prev_close", + "type": "float", + "description": "The previous close price.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['federal_reserve', 'fred']]", - "description": "Provider name." + "name": "change", + "type": "float", + "description": "The change in price from the previous close.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "change_percent", + "type": "float", + "description": "The change in price from the previous close, as a normalized percent.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "last_price", + "type": "float", + "description": "The last price of the stock.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "last_price_timestamp", + "type": "Union[date, datetime]", + "description": "The timestamp of the last price.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "ma50", + "type": "float", + "description": "The 50-day moving average.", + "default": null, + "optional": true + }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "ma200", + "type": "float", + "description": "The 200-day moving average.", + "default": null, + "optional": true }, { - "name": "rate", + "name": "year_high", "type": "float", - "description": "FED rate.", - "default": "", - "optional": false - } - ], - "federal_reserve": [], - "fred": [] - }, - "model": "FEDFUNDS" - }, - "/fixedincome/rate/effr_forecast": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Fed Funds Rate Projections.\n\nThe projections for the federal funds rate are the value of the midpoint of the\nprojected appropriate target range for the federal funds rate or the projected\nappropriate target level for the federal funds rate at the end of the specified\ncalendar year or over the longer run.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.effr_forecast(provider='fred')\nobb.fixedincome.rate.effr_forecast(long_run=True, provider='fred')\n```\n\n", - "parameters": { - "standard": [ + "description": "The 52-week high.", + "default": null, + "optional": true + }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "name": "year_low", + "type": "float", + "description": "The 52-week low.", + "default": null, "optional": true - } - ], - "fred": [ + }, { - "name": "long_run", - "type": "bool", - "description": "Flag to show long run projections", - "default": false, + "name": "volume_avg", + "type": "int", + "description": "Average daily trading volume.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[PROJECTIONS]", - "description": "Serializable results." + "name": "market_cap", + "type": "int", + "description": "Market cap of the stock.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." + "name": "eps", + "type": "float", + "description": "Earnings per share.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "pe", + "type": "float", + "description": "Price to earnings ratio.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "shares_outstanding", + "type": "int", + "description": "Number of shares outstanding.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "name", + "type": "str", + "description": "The company name associated with the symbol.", + "default": null, + "optional": true + }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "exchange", + "type": "str", + "description": "The exchange of the stock.", + "default": null, + "optional": true }, { - "name": "range_high", - "type": "float", - "description": "High projection of rates.", - "default": "", - "optional": false + "name": "earnings_date", + "type": "Union[date, datetime]", + "description": "The upcoming earnings announcement date.", + "default": null, + "optional": true + } + ], + "intrinio": [ + { + "name": "last_price", + "type": "float", + "description": "The last trade price.", + "default": null, + "optional": true }, { - "name": "central_tendency_high", - "type": "float", - "description": "Central tendency of high projection of rates.", - "default": "", - "optional": false + "name": "last_size", + "type": "int", + "description": "The last trade size.", + "default": null, + "optional": true }, { - "name": "median", - "type": "float", - "description": "Median projection of rates.", - "default": "", - "optional": false + "name": "last_volume", + "type": "int", + "description": "The last trade volume.", + "default": null, + "optional": true }, { - "name": "range_midpoint", - "type": "float", - "description": "Midpoint projection of rates.", - "default": "", - "optional": false + "name": "last_trade_timestamp", + "type": "datetime", + "description": "The timestamp of the last trade.", + "default": null, + "optional": true }, { - "name": "central_tendency_midpoint", - "type": "float", - "description": "Central tendency of midpoint projection of rates.", - "default": "", - "optional": false + "name": "bid_size", + "type": "int", + "description": "The size of the last bid price. Bid price and size is not always available.", + "default": null, + "optional": true }, { - "name": "range_low", + "name": "bid_price", "type": "float", - "description": "Low projection of rates.", - "default": "", - "optional": false + "description": "The last bid price. Bid price and size is not always available.", + "default": null, + "optional": true }, { - "name": "central_tendency_low", + "name": "ask_price", "type": "float", - "description": "Central tendency of low projection of rates.", - "default": "", - "optional": false - } - ], - "fred": [] - }, - "model": "PROJECTIONS" - }, - "/fixedincome/rate/estr": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Euro Short-Term Rate.\n\nThe euro short-term rate (\u20acSTR) reflects the wholesale euro unsecured overnight borrowing costs of banks located in\nthe euro area. The \u20acSTR is published on each TARGET2 business day based on transactions conducted and settled on\nthe previous TARGET2 business day (the reporting date \u201cT\u201d) with a maturity date of T+1 which are deemed to have been\nexecuted at arm\u2019s length and thus reflect market rates in an unbiased way.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.estr(provider='fred')\nobb.fixedincome.rate.estr(parameter=number_of_active_banks, provider='fred')\n```\n\n", - "parameters": { - "standard": [ + "description": "The last ask price. Ask price and size is not always available.", + "default": null, + "optional": true + }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "ask_size", + "type": "int", + "description": "The size of the last ask price. Ask price and size is not always available.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "last_bid_timestamp", + "type": "datetime", + "description": "The timestamp of the last bid price. Bid price and size is not always available.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "name": "last_ask_timestamp", + "type": "datetime", + "description": "The timestamp of the last ask price. Ask price and size is not always available.", + "default": null, "optional": true } ], - "fred": [ + "polygon": [ { - "name": "parameter", - "type": "Literal['volume_weighted_trimmed_mean_rate', 'number_of_transactions', 'number_of_active_banks', 'total_volume', 'share_of_volume_of_the_5_largest_active_banks', 'rate_at_75th_percentile_of_volume', 'rate_at_25th_percentile_of_volume']", - "description": "Period of ESTR rate.", - "default": "volume_weighted_trimmed_mean_rate", + "name": "vwap", + "type": "float", + "description": "The volume weighted average price of the stock on the current trading day.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[ESTR]", - "description": "Serializable results." + "name": "prev_open", + "type": "float", + "description": "The previous trading session opening price.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." + "name": "prev_high", + "type": "float", + "description": "The previous trading session high price.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "prev_low", + "type": "float", + "description": "The previous trading session low price.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "prev_volume", + "type": "float", + "description": "The previous trading session volume.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "prev_vwap", + "type": "float", + "description": "The previous trading session VWAP.", + "default": null, + "optional": true + }, { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "last_updated", + "type": "datetime", + "description": "The last time the data was updated.", "default": "", "optional": false }, { - "name": "rate", + "name": "bid", "type": "float", - "description": "ESTR rate.", - "default": "", - "optional": false - } - ], - "fred": [] - }, - "model": "ESTR" - }, - "/fixedincome/rate/ecb": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "European Central Bank Interest Rates.\n\nThe Governing Council of the ECB sets the key interest rates for the euro area:\n\n- The interest rate on the main refinancing operations (MRO), which provide\nthe bulk of liquidity to the banking system.\n- The rate on the deposit facility, which banks may use to make overnight deposits with the Eurosystem.\n- The rate on the marginal lending facility, which offers overnight credit to banks from the Eurosystem.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.ecb(provider='fred')\nobb.fixedincome.rate.ecb(interest_rate_type='refinancing', provider='fred')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "description": "The current bid price.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "bid_size", + "type": "int", + "description": "The current bid size.", "default": null, "optional": true }, { - "name": "interest_rate_type", - "type": "Literal['deposit', 'lending', 'refinancing']", - "description": "The type of interest rate.", - "default": "lending", + "name": "ask_size", + "type": "int", + "description": "The current ask size.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "name": "ask", + "type": "float", + "description": "The current ask price.", + "default": null, "optional": true - } - ], - "fred": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EuropeanCentralBankInterestRates]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." + "name": "quote_timestamp", + "type": "datetime", + "description": "The timestamp of the last quote.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "last_trade_price", + "type": "float", + "description": "The last trade price.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "last_trade_size", + "type": "int", + "description": "The last trade size.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "last_trade_conditions", + "type": "List[int]", + "description": "The last trade condition codes.", + "default": null, + "optional": true + }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "last_trade_exchange", + "type": "int", + "description": "The last trade exchange ID code.", + "default": null, + "optional": true }, { - "name": "rate", - "type": "float", - "description": "European Central Bank Interest Rate.", - "default": "", - "optional": false + "name": "last_trade_timestamp", + "type": "datetime", + "description": "The last trade timestamp.", + "default": null, + "optional": true } - ], - "fred": [] + ] }, - "model": "EuropeanCentralBankInterestRates" + "model": "MarketSnapshots" }, - "/fixedincome/rate/dpcredit": { + "/etf/search": { "deprecated": { "flag": null, "message": null }, - "description": "Discount Window Primary Credit Rate.\n\nA bank rate is the interest rate a nation's central bank charges to its domestic banks to borrow money.\nThe rates central banks charge are set to stabilize the economy.\nIn the United States, the Federal Reserve System's Board of Governors set the bank rate,\nalso known as the discount rate.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.dpcredit(provider='fred')\nobb.fixedincome.rate.dpcredit(start_date='2023-02-01', end_date='2023-05-01', provider='fred')\n```\n\n", + "description": "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": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, + "name": "query", + "type": "str", + "description": "Search query.", + "default": "", "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "provider", + "type": "Literal['fmp', 'intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true + } + ], + "fmp": [ + { + "name": "exchange", + "type": "Literal['AMEX', 'NYSE', 'NASDAQ', 'ETF', 'TSX', 'EURONEXT']", + "description": "The exchange code the ETF trades on.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "name": "is_active", + "type": "Literal[True, False]", + "description": "Whether the ETF is actively trading.", + "default": null, "optional": true } ], - "fred": [ + "intrinio": [ { - "name": "parameter", - "type": "Literal['daily_excl_weekend', 'monthly', 'weekly', 'daily', 'annual']", - "description": "FRED series ID of DWPCR data.", - "default": "daily_excl_weekend", + "name": "exchange", + "type": "Literal['xnas', 'arcx', 'bats', 'xnys', 'bvmf', 'xshg', 'xshe', 'xhkg', 'xbom', 'xnse', 'xidx', 'tase', 'xkrx', 'xkls', 'xmex', 'xses', 'roco', 'xtai', 'xbkk', 'xist']", + "description": "Target a specific exchange by providing the MIC code.", + "default": null, "optional": true } ] @@ -31098,12 +20859,12 @@ "OBBject": [ { "name": "results", - "type": "List[DiscountWindowPrimaryCreditRate]", + "type": "List[EtfSearch]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fred']]", + "type": "Optional[Literal['fmp', 'intrinio']]", "description": "Provider name." }, { @@ -31126,123 +20887,169 @@ "data": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.(ETF)", "default": "", "optional": false }, { - "name": "rate", - "type": "float", - "description": "Discount Window Primary Credit Rate.", - "default": "", - "optional": false + "name": "name", + "type": "str", + "description": "Name of the ETF.", + "default": null, + "optional": true } ], - "fred": [] - }, - "model": "DiscountWindowPrimaryCreditRate" - }, - "/fixedincome/spreads/tcm": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Treasury Constant Maturity.\n\nGet data for 10-Year Treasury Constant Maturity Minus Selected Treasury Constant Maturity.\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S.\nTreasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.tcm(provider='fred')\nobb.fixedincome.spreads.tcm(maturity='2y', provider='fred')\n```\n\n", - "parameters": { - "standard": [ + "fmp": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "market_cap", + "type": "float", + "description": "The market cap of the ETF.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "sector", + "type": "str", + "description": "The sector of the ETF.", "default": null, "optional": true }, { - "name": "maturity", - "type": "Literal['3m', '2y']", - "description": "The maturity", - "default": "3m", + "name": "industry", + "type": "str", + "description": "The industry of the ETF.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "name": "beta", + "type": "float", + "description": "The beta of the ETF.", + "default": null, "optional": true - } - ], - "fred": [] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[TreasuryConstantMaturity]", - "description": "Serializable results." + "name": "price", + "type": "float", + "description": "The current price of the ETF.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." + "name": "last_annual_dividend", + "type": "float", + "description": "The last annual dividend paid.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "volume", + "type": "float", + "description": "The current trading volume of the ETF.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "exchange", + "type": "str", + "description": "The exchange code the ETF trades on.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "exchange_name", + "type": "str", + "description": "The full name of the exchange the ETF trades on.", + "default": null, + "optional": true + }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "country", + "type": "str", + "description": "The country the ETF is registered in.", + "default": null, + "optional": true }, { - "name": "rate", - "type": "float", - "description": "TreasuryConstantMaturity Rate.", - "default": "", - "optional": false + "name": "actively_trading", + "type": "Literal[True, False]", + "description": "Whether the ETF is actively trading.", + "default": null, + "optional": true } ], - "fred": [] + "intrinio": [ + { + "name": "exchange", + "type": "str", + "description": "The exchange MIC code.", + "default": null, + "optional": true + }, + { + "name": "figi_ticker", + "type": "str", + "description": "The OpenFIGI ticker.", + "default": null, + "optional": true + }, + { + "name": "ric", + "type": "str", + "description": "The Reuters Instrument Code.", + "default": null, + "optional": true + }, + { + "name": "isin", + "type": "str", + "description": "The International Securities Identification Number.", + "default": null, + "optional": true + }, + { + "name": "sedol", + "type": "str", + "description": "The Stock Exchange Daily Official List.", + "default": null, + "optional": true + }, + { + "name": "intrinio_id", + "type": "str", + "description": "The unique Intrinio ID for the security.", + "default": null, + "optional": true + } + ] }, - "model": "TreasuryConstantMaturity" + "model": "EtfSearch" }, - "/fixedincome/spreads/tcm_effr": { + "/etf/historical": { "deprecated": { "flag": null, "message": null }, - "description": "Select Treasury Constant Maturity.\n\nGet data for Selected Treasury Constant Maturity Minus Federal Funds Rate\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S.\nTreasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.tcm_effr(provider='fred')\nobb.fixedincome.spreads.tcm_effr(maturity='10y', provider='fred')\n```\n\n", + "description": "ETF Historical Market Price.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.historical(symbol='SPY', provider='fmp')\nobb.etf.historical(symbol='SPY', provider='yfinance')\n# This function accepts multiple tickers.\nobb.etf.historical(symbol='SPY,IWM,QQQ,DJIA', provider='yfinance')\n```\n\n", "parameters": { "standard": [ + { + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", + "default": "", + "optional": false + }, + { + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, { "name": "start_date", "type": "Union[date, str]", @@ -31257,206 +21064,168 @@ "default": null, "optional": true }, - { - "name": "maturity", - "type": "Literal['10y', '5y', '1y', '6m', '3m']", - "description": "The maturity", - "default": "10y", - "optional": true - }, { "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "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 } ], - "fred": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[SelectedTreasuryConstantMaturity]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, + "fmp": [ { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true } - ] - }, - "data": { - "standard": [ + ], + "intrinio": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "symbol", + "type": "str", + "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", "default": "", "optional": false }, { - "name": "rate", - "type": "float", - "description": "Selected Treasury Constant Maturity Rate.", - "default": "", - "optional": false - } - ], - "fred": [] - }, - "model": "SelectedTreasuryConstantMaturity" - }, - "/fixedincome/spreads/treasury_effr": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Select Treasury Bill.\n\nGet Selected Treasury Bill Minus Federal Funds Rate.\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of\nauctioned U.S. Treasuries.\nThe value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.treasury_effr(provider='fred')\nobb.fixedincome.spreads.treasury_effr(maturity='6m', provider='fred')\n```\n\n", - "parameters": { - "standard": [ + "name": "interval", + "type": "Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "start_time", + "type": "datetime.time", + "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "end_time", + "type": "datetime.time", + "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'.", "default": null, "optional": true }, { - "name": "maturity", - "type": "Literal['3m', '6m']", - "description": "The maturity", - "default": "3m", + "name": "timezone", + "type": "str", + "description": "Timezone of the data, in the IANA format (Continent/City).", + "default": "America/New_York", "optional": true }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "name": "source", + "type": "Literal['realtime', 'delayed', 'nasdaq_basic']", + "description": "The source of the data.", + "default": "realtime", "optional": true } ], - "fred": [] - }, - "returns": { - "OBBject": [ + "polygon": [ { - "name": "results", - "type": "List[SelectedTreasuryBill]", - "description": "Serializable results." + "name": "interval", + "type": "str", + "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", + "default": "1d", + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." + "name": "adjustment", + "type": "Literal['splits_only', 'unadjusted']", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "extended_hours", + "type": "bool", + "description": "Include Pre and Post market data.", + "default": false, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", + "default": "asc", + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 49999, + "optional": true } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, + ], + "tiingo": [ { - "name": "rate", - "type": "float", - "description": "SelectedTreasuryBill Rate.", - "default": "", - "optional": false + "name": "interval", + "type": "Literal['1d', '1W', '1M', '1Y']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true } ], - "fred": [] - }, - "model": "SelectedTreasuryBill" - }, - "/fixedincome/government/us_yield_curve": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "US Yield Curve. Get United States yield curve.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.us_yield_curve(provider='fred')\nobb.fixedincome.government.us_yield_curve(inflation_adjusted=True, provider='fred')\n```\n\n", - "parameters": { - "standard": [ + "yfinance": [ { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for. Defaults to the most recent FRED entry.", - "default": null, + "name": "interval", + "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", + "description": "Time interval of the data to return.", + "default": "1d", "optional": true }, { - "name": "inflation_adjusted", + "name": "extended_hours", "type": "bool", - "description": "Get inflation adjusted rates.", + "description": "Include Pre and Post market data.", "default": false, "optional": true }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "name": "include_actions", + "type": "bool", + "description": "Include dividends and stock splits in results.", + "default": true, + "optional": true + }, + { + "name": "adjustment", + "type": "Literal['splits_only', 'splits_and_dividends']", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", + "optional": true + }, + { + "name": "adjusted", + "type": "bool", + "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead.", + "default": false, + "optional": true + }, + { + "name": "prepost", + "type": "bool", + "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead.", + "default": false, "optional": true } - ], - "fred": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[USYieldCurve]", + "type": "List[EtfHistorical]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fred']]", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']]", "description": "Provider name." }, { @@ -31479,355 +21248,316 @@ "data": { "standard": [ { - "name": "maturity", + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "open", "type": "float", - "description": "Maturity of the treasury rate in years.", + "description": "The open price.", "default": "", "optional": false }, { - "name": "rate", + "name": "high", "type": "float", - "description": "Associated rate given in decimal form (0.05 is 5%)", + "description": "The high price.", "default": "", "optional": false - } - ], - "fred": [] - }, - "model": "USYieldCurve" - }, - "/fixedincome/government/eu_yield_curve": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Euro Area Yield Curve.\n\nGets euro area yield curve data from ECB.\n\nThe graphic depiction of the relationship between the yield on bonds of the same credit quality but different\nmaturities is known as the yield curve. In the past, most market participants have constructed yield curves from\nthe observations of prices and yields in the Treasury market. Two reasons account for this tendency. First,\nTreasury securities are viewed as free of default risk, and differences in creditworthiness do not affect yield\nestimates. Second, as the most active bond market, the Treasury market offers the fewest problems of illiquidity\nor infrequent trading. The key function of the Treasury yield curve is to serve as a benchmark for pricing bonds\nand setting yields in other sectors of the debt market.\n\nIt is clear that the market\u2019s expectations of future rate changes are one important determinant of the\nyield-curve shape. For example, a steeply upward-sloping curve may indicate market expectations of near-term Fed\ntightening or of rising inflation. However, it may be too restrictive to assume that the yield differences across\nbonds with different maturities only reflect the market\u2019s rate expectations. The well-known pure expectations\nhypothesis has such an extreme implication. The pure expectations hypothesis asserts that all government bonds\nhave the same near-term expected return (as the nominally riskless short-term bond) because the return-seeking\nactivity of risk-neutral traders removes all expected return differentials across bonds.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.eu_yield_curve(provider='ecb')\nobb.fixedincome.government.eu_yield_curve(yield_curve_type=spot_rate, provider='ecb')\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", + "name": "low", + "type": "float", + "description": "The low price.", + "default": "", + "optional": false + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": "", + "optional": false + }, + { + "name": "volume", + "type": "Union[int, float]", + "description": "The trading volume.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['ecb']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'ecb' if there is no default.", - "default": "ecb", + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": null, "optional": true } ], - "ecb": [ + "fmp": [ { - "name": "rating", - "type": "Literal['aaa', 'all_ratings']", - "description": "The rating type, either 'aaa' or 'all_ratings'.", - "default": "aaa", + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": null, "optional": true }, { - "name": "yield_curve_type", - "type": "Literal['spot_rate', 'instantaneous_forward', 'par_yield']", - "description": "The yield curve type.", - "default": "spot_rate", + "name": "unadjusted_volume", + "type": "float", + "description": "Unadjusted volume of the symbol.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[EUYieldCurve]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['ecb']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "maturity", + "name": "change", "type": "float", - "description": "Maturity, in years.", + "description": "Change in the price from the previous close.", "default": null, "optional": true }, { - "name": "rate", + "name": "change_percent", "type": "float", - "description": "Yield curve rate, as a normalized percent.", + "description": "Change in the price from the previous close, as a normalized percent.", "default": null, "optional": true } ], - "ecb": [] - }, - "model": "EUYieldCurve" - }, - "/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": [ + "intrinio": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "average", + "type": "float", + "description": "Average trade price of an individual equity during the interval.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "change", + "type": "float", + "description": "Change in the price of the symbol from the previous day.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['federal_reserve', 'fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default.", - "default": "federal_reserve", + "name": "change_percent", + "type": "float", + "description": "Percent change in the price of the symbol from the previous day.", + "default": null, "optional": true - } - ], - "federal_reserve": [], - "fmp": [] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[TreasuryRates]", - "description": "Serializable results." + "name": "adj_open", + "type": "float", + "description": "The adjusted open price.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['federal_reserve', 'fmp']]", - "description": "Provider name." + "name": "adj_high", + "type": "float", + "description": "The adjusted high price.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "adj_low", + "type": "float", + "description": "The adjusted low price.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "adj_close", + "type": "float", + "description": "The adjusted close price.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "adj_volume", + "type": "float", + "description": "The adjusted volume.", + "default": null, + "optional": true + }, { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "fifty_two_week_high", + "type": "float", + "description": "52 week high price for the symbol.", + "default": null, + "optional": true }, { - "name": "week_4", + "name": "fifty_two_week_low", "type": "float", - "description": "4 week Treasury bills rate (secondary market).", + "description": "52 week low price for the symbol.", "default": null, "optional": true }, { - "name": "month_1", + "name": "factor", "type": "float", - "description": "1 month Treasury rate.", + "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices.", "default": null, "optional": true }, { - "name": "month_2", + "name": "split_ratio", "type": "float", - "description": "2 month Treasury rate.", + "description": "Ratio of the equity split, if a split occurred.", "default": null, "optional": true }, { - "name": "month_3", + "name": "dividend", "type": "float", - "description": "3 month Treasury rate.", + "description": "Dividend amount, if a dividend was paid.", "default": null, "optional": true }, { - "name": "month_6", + "name": "close_time", + "type": "datetime", + "description": "The timestamp that represents the end of the interval span.", + "default": null, + "optional": true + }, + { + "name": "interval", + "type": "str", + "description": "The data time frequency.", + "default": null, + "optional": true + }, + { + "name": "intra_period", + "type": "bool", + "description": "If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "transactions", + "type": "Annotated[int, Gt(gt=0)]", + "description": "Number of transactions for the symbol in the time period.", + "default": null, + "optional": true + } + ], + "tiingo": [ + { + "name": "adj_open", "type": "float", - "description": "6 month Treasury rate.", + "description": "The adjusted open price.", "default": null, "optional": true }, { - "name": "year_1", + "name": "adj_high", "type": "float", - "description": "1 year Treasury rate.", + "description": "The adjusted high price.", "default": null, "optional": true }, { - "name": "year_2", + "name": "adj_low", "type": "float", - "description": "2 year Treasury rate.", + "description": "The adjusted low price.", "default": null, "optional": true }, { - "name": "year_3", + "name": "adj_close", "type": "float", - "description": "3 year Treasury rate.", + "description": "The adjusted close price.", "default": null, "optional": true }, { - "name": "year_5", + "name": "adj_volume", "type": "float", - "description": "5 year Treasury rate.", + "description": "The adjusted volume.", "default": null, "optional": true }, { - "name": "year_7", + "name": "split_ratio", "type": "float", - "description": "7 year Treasury rate.", + "description": "Ratio of the equity split, if a split occurred.", "default": null, "optional": true }, { - "name": "year_10", + "name": "dividend", "type": "float", - "description": "10 year Treasury rate.", + "description": "Dividend amount, if a dividend was paid.", "default": null, "optional": true - }, + } + ], + "yfinance": [ { - "name": "year_20", + "name": "split_ratio", "type": "float", - "description": "20 year Treasury rate.", + "description": "Ratio of the equity split, if a split occurred.", "default": null, "optional": true }, { - "name": "year_30", + "name": "dividend", "type": "float", - "description": "30 year Treasury rate.", + "description": "Dividend amount (split-adjusted), if a dividend was paid.", "default": null, "optional": true } - ], - "federal_reserve": [], - "fmp": [] + ] }, - "model": "TreasuryRates" + "model": "EtfHistorical" }, - "/fixedincome/government/treasury_auctions": { + "/etf/info": { "deprecated": { "flag": null, "message": null }, - "description": "Government Treasury Auctions.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.treasury_auctions(provider='government_us')\nobb.fixedincome.government.treasury_auctions(security_type='Bill', start_date='2022-01-01', end_date='2023-01-01', provider='government_us')\n```\n\n", + "description": "ETF Information Overview.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.info(symbol='SPY', provider='fmp')\n# This function accepts multiple tickers.\nobb.etf.info(symbol='SPY,IWM,QQQ,DJIA', provider='fmp')\n```\n\n", "parameters": { "standard": [ { - "name": "security_type", - "type": "Literal['Bill', 'Note', 'Bond', 'CMB', 'TIPS', 'FRN']", - "description": "Used to only return securities of a particular type.", - "default": null, - "optional": true - }, - { - "name": "cusip", - "type": "str", - "description": "Filter securities by CUSIP.", - "default": null, - "optional": true - }, - { - "name": "page_size", - "type": "int", - "description": "Maximum number of results to return; you must also include pagenum when using pagesize.", - "default": null, - "optional": true - }, - { - "name": "page_num", - "type": "int", - "description": "The first page number to display results for; used in combination with page size.", - "default": null, - "optional": true - }, - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format. The default is 90 days ago.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format. The default is today.", - "default": null, - "optional": true + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, intrinio, yfinance.", + "default": "", + "optional": false }, { "name": "provider", - "type": "Literal['government_us']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'government_us' if there is no default.", - "default": "government_us", + "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 } ], - "government_us": [] + "fmp": [], + "intrinio": [], + "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[TreasuryAuctions]", + "type": "List[EtfInfo]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['government_us']]", + "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", "description": "Provider name." }, { @@ -31850,1358 +21580,1178 @@ "data": { "standard": [ { - "name": "cusip", + "name": "symbol", "type": "str", - "description": "CUSIP of the Security.", + "description": "Symbol representing the entity requested in the data. (ETF)", "default": "", "optional": false }, { - "name": "issue_date", - "type": "date", - "description": "The issue date of the security.", + "name": "name", + "type": "str", + "description": "Name of the ETF.", "default": "", "optional": false }, { - "name": "security_type", - "type": "Literal['Bill', 'Note', 'Bond', 'CMB', 'TIPS', 'FRN']", - "description": "The type of security.", - "default": "", - "optional": false + "name": "description", + "type": "str", + "description": "Description of the fund.", + "default": null, + "optional": true }, { - "name": "security_term", + "name": "inception_date", "type": "str", - "description": "The term of the security.", + "description": "Inception date of the ETF.", "default": "", "optional": false + } + ], + "fmp": [ + { + "name": "issuer", + "type": "str", + "description": "Company of the ETF.", + "default": null, + "optional": true }, { - "name": "maturity_date", - "type": "date", - "description": "The maturity date of the security.", - "default": "", - "optional": false + "name": "cusip", + "type": "str", + "description": "CUSIP of the ETF.", + "default": null, + "optional": true }, { - "name": "interest_rate", - "type": "float", - "description": "The interest rate of the security.", + "name": "isin", + "type": "str", + "description": "ISIN of the ETF.", + "default": null, + "optional": true + }, + { + "name": "domicile", + "type": "str", + "description": "Domicile of the ETF.", + "default": null, + "optional": true + }, + { + "name": "asset_class", + "type": "str", + "description": "Asset class of the ETF.", "default": null, "optional": true }, { - "name": "cpi_on_issue_date", + "name": "aum", "type": "float", - "description": "Reference CPI rate on the issue date of the security.", + "description": "Assets under management.", "default": null, "optional": true }, { - "name": "cpi_on_dated_date", + "name": "nav", "type": "float", - "description": "Reference CPI rate on the dated date of the security.", + "description": "Net asset value of the ETF.", "default": null, "optional": true }, { - "name": "announcement_date", - "type": "date", - "description": "The announcement date of the security.", + "name": "nav_currency", + "type": "str", + "description": "Currency of the ETF's net asset value.", "default": null, "optional": true }, { - "name": "auction_date", - "type": "date", - "description": "The auction date of the security.", + "name": "expense_ratio", + "type": "float", + "description": "The expense ratio, as a normalized percent.", "default": null, "optional": true }, { - "name": "auction_date_year", + "name": "holdings_count", "type": "int", - "description": "The auction date year of the security.", + "description": "Number of holdings.", "default": null, "optional": true }, { - "name": "dated_date", - "type": "date", - "description": "The dated date of the security.", + "name": "avg_volume", + "type": "float", + "description": "Average daily trading volume.", "default": null, "optional": true }, { - "name": "first_payment_date", - "type": "date", - "description": "The first payment date of the security.", + "name": "website", + "type": "str", + "description": "Website of the issuer.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "accrued_interest_per_100", - "type": "float", - "description": "Accrued interest per $100.", + "name": "fund_listing_date", + "type": "date", + "description": "The date on which the Exchange Traded Product (ETP) or share class of the ETP is listed on a specific exchange.", "default": null, "optional": true }, { - "name": "accrued_interest_per_1000", - "type": "float", - "description": "Accrued interest per $1000.", + "name": "data_change_date", + "type": "date", + "description": "The last date on which there was a change in a classifications data field for this ETF.", "default": null, "optional": true }, { - "name": "adjusted_accrued_interest_per_100", - "type": "float", - "description": "Adjusted accrued interest per $100.", + "name": "etn_maturity_date", + "type": "date", + "description": "If the product is an ETN, this field identifies the maturity date for the ETN.", "default": null, "optional": true }, { - "name": "adjusted_accrued_interest_per_1000", - "type": "float", - "description": "Adjusted accrued interest per $1000.", + "name": "is_listed", + "type": "bool", + "description": "If true, the ETF is still listed on an exchange.", "default": null, "optional": true }, { - "name": "adjusted_price", - "type": "float", - "description": "Adjusted price.", + "name": "close_date", + "type": "date", + "description": "The date on which the ETF was de-listed if it is no longer listed.", "default": null, "optional": true }, { - "name": "allocation_percentage", - "type": "float", - "description": "Allocation percentage, as normalized percentage points.", + "name": "exchange", + "type": "str", + "description": "The exchange Market Identifier Code (MIC).", "default": null, "optional": true }, { - "name": "allocation_percentage_decimals", - "type": "float", - "description": "The number of decimals in the Allocation percentage.", + "name": "isin", + "type": "str", + "description": "International Securities Identification Number (ISIN).", "default": null, "optional": true }, { - "name": "announced_cusip", + "name": "ric", "type": "str", - "description": "The announced CUSIP of the security.", + "description": "Reuters Instrument Code (RIC).", "default": null, "optional": true }, { - "name": "auction_format", + "name": "sedol", "type": "str", - "description": "The auction format of the security.", + "description": "Stock Exchange Daily Official List (SEDOL).", "default": null, "optional": true }, { - "name": "avg_median_discount_rate", - "type": "float", - "description": "The average median discount rate of the security.", + "name": "figi_symbol", + "type": "str", + "description": "Financial Instrument Global Identifier (FIGI) symbol.", "default": null, "optional": true }, { - "name": "avg_median_investment_rate", - "type": "float", - "description": "The average median investment rate of the security.", + "name": "share_class_figi", + "type": "str", + "description": "Financial Instrument Global Identifier (FIGI).", "default": null, "optional": true }, { - "name": "avg_median_price", - "type": "float", - "description": "The average median price paid for the security.", + "name": "firstbridge_id", + "type": "str", + "description": "The FirstBridge unique identifier for the Exchange Traded Fund (ETF).", "default": null, "optional": true }, { - "name": "avg_median_discount_margin", - "type": "float", - "description": "The average median discount margin of the security.", + "name": "firstbridge_parent_id", + "type": "str", + "description": "The FirstBridge unique identifier for the parent Exchange Traded Fund (ETF), if applicable.", "default": null, "optional": true }, { - "name": "avg_median_yield", - "type": "float", - "description": "The average median yield of the security.", + "name": "intrinio_id", + "type": "str", + "description": "Intrinio unique identifier for the security.", "default": null, "optional": true }, { - "name": "back_dated", - "type": "Literal['Yes', 'No']", - "description": "Whether the security is back dated.", + "name": "intraday_nav_symbol", + "type": "str", + "description": "Intraday Net Asset Value (NAV) symbol.", "default": null, "optional": true }, { - "name": "back_dated_date", - "type": "date", - "description": "The back dated date of the security.", + "name": "primary_symbol", + "type": "str", + "description": "The primary ticker field is used for Exchange Traded Products (ETPs) that have multiple listings and share classes. If an ETP has multiple listings or share classes, the same primary ticker is assigned to all the listings and share classes.", "default": null, "optional": true }, { - "name": "bid_to_cover_ratio", - "type": "float", - "description": "The bid to cover ratio of the security.", + "name": "etp_structure_type", + "type": "str", + "description": "Classifies Exchange Traded Products (ETPs) into very broad categories based on its legal structure.", "default": null, "optional": true }, { - "name": "call_date", - "type": "date", - "description": "The call date of the security.", + "name": "legal_structure", + "type": "str", + "description": "Legal structure of the fund.", "default": null, "optional": true }, { - "name": "callable", - "type": "Literal['Yes', 'No']", - "description": "Whether the security is callable.", + "name": "issuer", + "type": "str", + "description": "Issuer of the ETF.", "default": null, "optional": true }, { - "name": "called_date", - "type": "date", - "description": "The called date of the security.", + "name": "etn_issuing_bank", + "type": "str", + "description": "If the product is an Exchange Traded Note (ETN), this field identifies the issuing bank.", "default": null, "optional": true }, { - "name": "cash_management_bill", - "type": "Literal['Yes', 'No']", - "description": "Whether the security is a cash management bill.", + "name": "fund_family", + "type": "str", + "description": "This field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor.", "default": null, "optional": true }, { - "name": "closing_time_competitive", + "name": "investment_style", "type": "str", - "description": "The closing time for competitive bids on the security.", + "description": "Investment style of the ETF.", "default": null, "optional": true }, { - "name": "closing_time_non_competitive", + "name": "derivatives_based", "type": "str", - "description": "The closing time for non-competitive bids on the security.", + "description": "This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio.", "default": null, "optional": true }, { - "name": "competitive_accepted", - "type": "int", - "description": "The accepted value for competitive bids on the security.", + "name": "income_category", + "type": "str", + "description": "Identifies if an Exchange Traded Fund (ETF) falls into a category that is specifically designed to provide a high yield or income", "default": null, "optional": true }, { - "name": "competitive_accepted_decimals", - "type": "int", - "description": "The number of decimals in the Competitive Accepted.", + "name": "asset_class", + "type": "str", + "description": "Captures the underlying nature of the securities in the Exchanged Traded Product (ETP).", "default": null, "optional": true }, { - "name": "competitive_tendered", - "type": "int", - "description": "The tendered value for competitive bids on the security.", + "name": "other_asset_types", + "type": "str", + "description": "If 'asset_class' field is classified as 'Other Asset Types' this field captures the specific category of the underlying assets.", "default": null, "optional": true }, { - "name": "competitive_tenders_accepted", - "type": "Literal['Yes', 'No']", - "description": "Whether competitive tenders are accepted on the security.", + "name": "single_category_designation", + "type": "str", + "description": "This categorization is created for those users who want every ETF to be 'forced' into a single bucket, so that the assets for all categories will always sum to the total market.", "default": null, "optional": true }, { - "name": "corp_us_cusip", + "name": "beta_type", "type": "str", - "description": "The CUSIP of the security.", + "description": "This field identifies whether an ETF provides 'Traditional' beta exposure or 'Smart' beta exposure. ETFs that are active (i.e. non-indexed), leveraged / inverse or have a proprietary quant model (i.e. that don't provide indexed exposure to a targeted factor) are classified separately.", "default": null, "optional": true }, { - "name": "cpi_base_reference_period", + "name": "beta_details", "type": "str", - "description": "The CPI base reference period of the security.", + "description": "This field provides further detail within the traditional and smart beta categories.", "default": null, "optional": true }, { - "name": "currently_outstanding", - "type": "int", - "description": "The currently outstanding value on the security.", + "name": "market_cap_range", + "type": "str", + "description": "Equity ETFs are classified as falling into categories based on the description of their investment strategy in the prospectus. Examples ('Mega Cap', 'Large Cap', 'Mid Cap', etc.)", "default": null, "optional": true }, { - "name": "direct_bidder_accepted", - "type": "int", - "description": "The accepted value from direct bidders on the security.", + "name": "market_cap_weighting_type", + "type": "str", + "description": "For ETFs that take the value 'Market Cap Weighted' in the 'index_weighting_scheme' field, this field provides detail on the market cap weighting type.", "default": null, "optional": true }, { - "name": "direct_bidder_tendered", - "type": "int", - "description": "The tendered value from direct bidders on the security.", + "name": "index_weighting_scheme", + "type": "str", + "description": "For ETFs that track an underlying index, this field provides detail on the index weighting type.", "default": null, "optional": true }, { - "name": "est_amount_of_publicly_held_maturing_security", - "type": "int", - "description": "The estimated amount of publicly held maturing securities on the security.", + "name": "index_linked", + "type": "str", + "description": "This field identifies whether an ETF is index linked or active.", "default": null, "optional": true }, { - "name": "fima_included", - "type": "Literal['Yes', 'No']", - "description": "Whether the security is included in the FIMA (Foreign and International Money Authorities).", + "name": "index_name", + "type": "str", + "description": "This field identifies the name of the underlying index tracked by the ETF, if applicable.", "default": null, "optional": true }, { - "name": "fima_non_competitive_accepted", - "type": "int", - "description": "The non-competitive accepted value on the security from FIMAs.", + "name": "index_symbol", + "type": "str", + "description": "This field identifies the OpenFIGI ticker for the Index underlying the ETF.", "default": null, "optional": true }, { - "name": "fima_non_competitive_tendered", - "type": "int", - "description": "The non-competitive tendered value on the security from FIMAs.", + "name": "parent_index", + "type": "str", + "description": "This field identifies the name of the parent index, which represents the broader universe from which the index underlying the ETF is created, if applicable.", "default": null, "optional": true }, { - "name": "first_interest_period", + "name": "index_family", "type": "str", - "description": "The first interest period of the security.", + "description": "This field identifies the index family to which the index underlying the ETF belongs. The index family is represented as categorized by the index provider.", "default": null, "optional": true }, { - "name": "first_interest_payment_date", - "type": "date", - "description": "The first interest payment date of the security.", + "name": "broader_index_family", + "type": "str", + "description": "This field identifies the broader index family to which the index underlying the ETF belongs. The broader index family is represented as categorized by the index provider.", "default": null, "optional": true }, { - "name": "floating_rate", - "type": "Literal['Yes', 'No']", - "description": "Whether the security is a floating rate.", + "name": "index_provider", + "type": "str", + "description": "This field identifies the Index provider for the index underlying the ETF, if applicable.", "default": null, "optional": true }, { - "name": "frn_index_determination_date", - "type": "date", - "description": "The FRN index determination date of the security.", + "name": "index_provider_code", + "type": "str", + "description": "This field provides the First Bridge code for each Index provider, corresponding to the index underlying the ETF if applicable.", "default": null, "optional": true }, { - "name": "frn_index_determination_rate", - "type": "float", - "description": "The FRN index determination rate of the security.", + "name": "replication_structure", + "type": "str", + "description": "The replication structure of the Exchange Traded Product (ETP).", "default": null, "optional": true }, { - "name": "high_discount_rate", - "type": "float", - "description": "The high discount rate of the security.", + "name": "growth_value_tilt", + "type": "str", + "description": "Classifies equity ETFs as either 'Growth' or Value' based on the stated style tilt in the ETF prospectus. Equity ETFs that do not have a stated style tilt are classified as 'Core / Blend'.", "default": null, "optional": true }, { - "name": "high_investment_rate", - "type": "float", - "description": "The high investment rate of the security.", + "name": "growth_type", + "type": "str", + "description": "For ETFs that are classified as 'Growth' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their growth (style factor) scores.", "default": null, "optional": true }, { - "name": "high_price", - "type": "float", - "description": "The high price of the security at auction.", + "name": "value_type", + "type": "str", + "description": "For ETFs that are classified as 'Value' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their value (style factor) scores.", "default": null, "optional": true }, { - "name": "high_discount_margin", - "type": "float", - "description": "The high discount margin of the security.", + "name": "sector", + "type": "str", + "description": "For equity ETFs that aim to provide targeted exposure to a sector or industry, this field identifies the Sector that it provides the exposure to.", "default": null, "optional": true }, { - "name": "high_yield", - "type": "float", - "description": "The high yield of the security at auction.", + "name": "industry", + "type": "str", + "description": "For equity ETFs that aim to provide targeted exposure to an industry, this field identifies the Industry that it provides the exposure to.", "default": null, "optional": true }, { - "name": "index_ratio_on_issue_date", - "type": "float", - "description": "The index ratio on the issue date of the security.", + "name": "industry_group", + "type": "str", + "description": "For equity ETFs that aim to provide targeted exposure to a sub-industry, this field identifies the sub-Industry that it provides the exposure to.", "default": null, "optional": true }, { - "name": "indirect_bidder_accepted", - "type": "int", - "description": "The accepted value from indirect bidders on the security.", + "name": "cross_sector_theme", + "type": "str", + "description": "For equity ETFs that aim to provide targeted exposure to a specific investment theme that cuts across GICS sectors, this field identifies the specific cross-sector theme. Examples ('Agri-business', 'Natural Resources', 'Green Investing', etc.)", "default": null, "optional": true }, { - "name": "indirect_bidder_tendered", - "type": "int", - "description": "The tendered value from indirect bidders on the security.", + "name": "natural_resources_type", + "type": "str", + "description": "For ETFs that are classified as 'Natural Resources' in the 'cross_sector_theme' field, this field provides further detail on the type of Natural Resources exposure.", "default": null, "optional": true }, { - "name": "interest_payment_frequency", + "name": "us_or_excludes_us", "type": "str", - "description": "The interest payment frequency of the security.", + "description": "Takes the value of 'Domestic' for US exposure, 'International' for non-US exposure and 'Global' for exposure that includes all regions including the US.", "default": null, "optional": true }, { - "name": "low_discount_rate", - "type": "float", - "description": "The low discount rate of the security.", + "name": "developed_emerging", + "type": "str", + "description": "This field identifies the stage of development of the markets that the ETF provides exposure to.", "default": null, "optional": true }, { - "name": "low_investment_rate", - "type": "float", - "description": "The low investment rate of the security.", + "name": "specialized_region", + "type": "str", + "description": "This field is populated if the ETF provides targeted exposure to a specific type of geography-based grouping that does not fall into a specific country or continent grouping. Examples ('BRIC', 'Chindia', etc.)", "default": null, "optional": true }, { - "name": "low_price", - "type": "float", - "description": "The low price of the security at auction.", + "name": "continent", + "type": "str", + "description": "This field is populated if the ETF provides targeted exposure to a specific continent or country within that Continent.", "default": null, "optional": true }, { - "name": "low_discount_margin", - "type": "float", - "description": "The low discount margin of the security.", + "name": "latin_america_sub_group", + "type": "str", + "description": "For ETFs that are classified as 'Latin America' in the 'continent' field, this field provides further detail on the type of regional exposure.", "default": null, "optional": true }, { - "name": "low_yield", - "type": "float", - "description": "The low yield of the security at auction.", + "name": "europe_sub_group", + "type": "str", + "description": "For ETFs that are classified as 'Europe' in the 'continent' field, this field provides further detail on the type of regional exposure.", "default": null, "optional": true }, { - "name": "maturing_date", - "type": "date", - "description": "The maturing date of the security.", + "name": "asia_sub_group", + "type": "str", + "description": "For ETFs that are classified as 'Asia' in the 'continent' field, this field provides further detail on the type of regional exposure.", "default": null, "optional": true }, { - "name": "max_competitive_award", - "type": "int", - "description": "The maximum competitive award at auction.", + "name": "specific_country", + "type": "str", + "description": "This field is populated if the ETF provides targeted exposure to a specific country.", "default": null, "optional": true }, { - "name": "max_non_competitive_award", - "type": "int", - "description": "The maximum non-competitive award at auction.", + "name": "china_listing_location", + "type": "str", + "description": "For ETFs that are classified as 'China' in the 'country' field, this field provides further detail on the type of exposure in the underlying securities.", "default": null, "optional": true }, { - "name": "max_single_bid", - "type": "int", - "description": "The maximum single bid at auction.", + "name": "us_state", + "type": "str", + "description": "Takes the value of a US state if the ETF provides targeted exposure to the municipal bonds or equities of companies.", "default": null, "optional": true }, { - "name": "min_bid_amount", - "type": "int", - "description": "The minimum bid amount at auction.", + "name": "real_estate", + "type": "str", + "description": "For ETFs that provide targeted real estate exposure, this field is populated if the ETF provides targeted exposure to a specific segment of the real estate market.", "default": null, "optional": true }, { - "name": "min_strip_amount", - "type": "int", - "description": "The minimum strip amount at auction.", + "name": "fundamental_weighting_type", + "type": "str", + "description": "For ETFs that take the value 'Fundamental Weighted' in the 'index_weighting_scheme' field, this field provides detail on the fundamental weighting methodology.", "default": null, "optional": true }, { - "name": "min_to_issue", - "type": "int", - "description": "The minimum to issue at auction.", + "name": "dividend_weighting_type", + "type": "str", + "description": "For ETFs that take the value 'Dividend Weighted' in the 'index_weighting_scheme' field, this field provides detail on the dividend weighting methodology.", "default": null, "optional": true }, { - "name": "multiples_to_bid", - "type": "int", - "description": "The multiples to bid at auction.", + "name": "bond_type", + "type": "str", + "description": "For ETFs where 'asset_class_type' is 'Bonds', this field provides detail on the type of bonds held in the ETF.", "default": null, "optional": true }, { - "name": "multiples_to_issue", - "type": "int", - "description": "The multiples to issue at auction.", + "name": "government_bond_types", + "type": "str", + "description": "For bond ETFs that take the value 'Treasury & Government' in 'bond_type', this field provides detail on the exposure.", "default": null, "optional": true }, { - "name": "nlp_exclusion_amount", - "type": "int", - "description": "The NLP exclusion amount at auction.", + "name": "municipal_bond_region", + "type": "str", + "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field provides additional detail on the geographic exposure.", "default": null, "optional": true }, { - "name": "nlp_reporting_threshold", - "type": "int", - "description": "The NLP reporting threshold at auction.", + "name": "municipal_vrdo", + "type": "bool", + "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field identifies those ETFs that specifically provide exposure to Variable Rate Demand Obligations.", "default": null, "optional": true }, { - "name": "non_competitive_accepted", - "type": "int", - "description": "The accepted value from non-competitive bidders on the security.", + "name": "mortgage_bond_types", + "type": "str", + "description": "For bond ETFs that take the value 'Mortgage' in 'bond_type', this field provides additional detail on the type of underlying securities.", "default": null, "optional": true }, { - "name": "non_competitive_tenders_accepted", - "type": "Literal['Yes', 'No']", - "description": "Whether or not the auction accepted non-competitive tenders.", + "name": "bond_tax_status", + "type": "str", + "description": "For all US bond ETFs, this field provides additional detail on the tax treatment of the underlying securities.", "default": null, "optional": true }, { - "name": "offering_amount", - "type": "int", - "description": "The offering amount at auction.", + "name": "credit_quality", + "type": "str", + "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific credit quality range.", "default": null, "optional": true }, { - "name": "original_cusip", + "name": "average_maturity", "type": "str", - "description": "The original CUSIP of the security.", + "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific maturity range.", "default": null, "optional": true }, { - "name": "original_dated_date", - "type": "date", - "description": "The original dated date of the security.", + "name": "specific_maturity_year", + "type": "int", + "description": "For all bond ETFs that take the value 'Specific Maturity Year' in the 'average_maturity' field, this field specifies the calendar year.", "default": null, "optional": true }, { - "name": "original_issue_date", - "type": "date", - "description": "The original issue date of the security.", + "name": "commodity_types", + "type": "str", + "description": "For ETFs where 'asset_class_type' is 'Commodities', this field provides detail on the type of commodities held in the ETF.", "default": null, "optional": true }, { - "name": "original_security_term", + "name": "energy_type", "type": "str", - "description": "The original term of the security.", + "description": "For ETFs where 'commodity_type' is 'Energy', this field provides detail on the type of energy exposure provided by the ETF.", "default": null, "optional": true }, { - "name": "pdf_announcement", + "name": "agricultural_type", "type": "str", - "description": "The PDF filename for the announcement of the security.", + "description": "For ETFs where 'commodity_type' is 'Agricultural', this field provides detail on the type of agricultural exposure provided by the ETF.", "default": null, "optional": true }, { - "name": "pdf_competitive_results", + "name": "livestock_type", "type": "str", - "description": "The PDF filename for the competitive results of the security.", + "description": "For ETFs where 'commodity_type' is 'Livestock', this field provides detail on the type of livestock exposure provided by the ETF.", "default": null, "optional": true }, { - "name": "pdf_non_competitive_results", + "name": "metal_type", "type": "str", - "description": "The PDF filename for the non-competitive results of the security.", + "description": "For ETFs where 'commodity_type' is 'Gold & Metals', this field provides detail on the type of exposure provided by the ETF.", "default": null, "optional": true }, { - "name": "pdf_special_announcement", + "name": "inverse_leveraged", "type": "str", - "description": "The PDF filename for the special announcements.", + "description": "This field is populated if the ETF provides inverse or leveraged exposure.", "default": null, "optional": true }, { - "name": "price_per_100", - "type": "float", - "description": "The price per 100 of the security.", + "name": "target_date_multi_asset_type", + "type": "str", + "description": "For ETFs where 'asset_class_type' is 'Target Date / MultiAsset', this field provides detail on the type of commodities held in the ETF.", "default": null, "optional": true }, { - "name": "primary_dealer_accepted", - "type": "int", - "description": "The primary dealer accepted value on the security.", + "name": "currency_pair", + "type": "str", + "description": "This field is populated if the ETF's strategy involves providing exposure to the movements of a currency or involves hedging currency exposure.", "default": null, "optional": true }, { - "name": "primary_dealer_tendered", - "type": "int", - "description": "The primary dealer tendered value on the security.", + "name": "social_environmental_type", + "type": "str", + "description": "This field is populated if the ETF's strategy involves providing exposure to a specific social or environmental theme.", "default": null, "optional": true }, { - "name": "reopening", - "type": "Literal['Yes', 'No']", - "description": "Whether or not the auction was reopened.", + "name": "clean_energy_type", + "type": "str", + "description": "This field is populated if the ETF has a value of 'Clean Energy' in the 'social_environmental_type' field.", "default": null, "optional": true }, { - "name": "security_term_day_month", + "name": "dividend_type", "type": "str", - "description": "The security term in days or months.", + "description": "This field is populated if the ETF has an intended investment objective of holding dividend-oriented stocks as stated in the prospectus.", "default": null, "optional": true }, { - "name": "security_term_week_year", + "name": "regular_dividend_payor_type", "type": "str", - "description": "The security term in weeks or years.", + "description": "This field is populated if the ETF has a value of'Dividend - Regular Payors' in the 'dividend_type' field.", "default": null, "optional": true }, { - "name": "series", + "name": "quant_strategies_type", "type": "str", - "description": "The series name of the security.", + "description": "This field is populated if the ETF has either an index-linked or active strategy that is based on a proprietary quantitative strategy.", "default": null, "optional": true }, { - "name": "soma_accepted", - "type": "int", - "description": "The SOMA accepted value on the security.", + "name": "other_quant_models", + "type": "str", + "description": "For ETFs where 'quant_strategies_type' is 'Other Quant Model', this field provides the name of the specific proprietary quant model used as the underlying strategy for the ETF.", "default": null, "optional": true }, { - "name": "soma_holdings", - "type": "int", - "description": "The SOMA holdings on the security.", + "name": "hedge_fund_type", + "type": "str", + "description": "For ETFs where 'other_asset_types' is 'Hedge Fund Replication', this field provides detail on the type of hedge fund replication strategy.", "default": null, "optional": true }, { - "name": "soma_included", - "type": "Literal['Yes', 'No']", - "description": "Whether or not the SOMA (System Open Market Account) was included on the security.", + "name": "excludes_financials", + "type": "bool", + "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold financials stocks, based on the funds intended objective.", "default": null, "optional": true }, { - "name": "soma_tendered", - "type": "int", - "description": "The SOMA tendered value on the security.", + "name": "excludes_technology", + "type": "bool", + "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold technology stocks, based on the funds intended objective.", "default": null, "optional": true }, { - "name": "spread", - "type": "float", - "description": "The spread on the security.", + "name": "holds_only_nyse_stocks", + "type": "bool", + "description": "If true, the ETF is an equity ETF and holds only stocks listed on NYSE.", "default": null, "optional": true }, { - "name": "standard_payment_per_1000", - "type": "float", - "description": "The standard payment per 1000 of the security.", + "name": "holds_only_nasdaq_stocks", + "type": "bool", + "description": "If true, the ETF is an equity ETF and holds only stocks listed on Nasdaq.", "default": null, "optional": true }, { - "name": "strippable", - "type": "Literal['Yes', 'No']", - "description": "Whether or not the security is strippable.", + "name": "holds_mlp", + "type": "bool", + "description": "If true, the ETF's investment objective explicitly specifies that it holds MLPs as an intended part of its investment strategy.", "default": null, "optional": true }, { - "name": "term", - "type": "str", - "description": "The term of the security.", + "name": "holds_preferred_stock", + "type": "bool", + "description": "If true, the ETF's investment objective explicitly specifies that it holds preferred stock as an intended part of its investment strategy.", "default": null, "optional": true }, { - "name": "tiin_conversion_factor_per_1000", - "type": "float", - "description": "The TIIN conversion factor per 1000 of the security.", + "name": "holds_closed_end_funds", + "type": "bool", + "description": "If true, the ETF's investment objective explicitly specifies that it holds closed end funds as an intended part of its investment strategy.", "default": null, "optional": true }, { - "name": "tips", - "type": "Literal['Yes', 'No']", - "description": "Whether or not the security is TIPS.", + "name": "holds_adr", + "type": "bool", + "description": "If true, he ETF's investment objective explicitly specifies that it holds American Depositary Receipts (ADRs) as an intended part of its investment strategy.", "default": null, "optional": true }, { - "name": "total_accepted", - "type": "int", - "description": "The total accepted value at auction.", + "name": "laddered", + "type": "bool", + "description": "For bond ETFs, this field identifies those ETFs that specifically hold bonds in a laddered structure, where the bonds are scheduled to mature in an annual, sequential structure.", "default": null, "optional": true }, { - "name": "total_tendered", - "type": "int", - "description": "The total tendered value at auction.", + "name": "zero_coupon", + "type": "bool", + "description": "For bond ETFs, this field identifies those ETFs that specifically hold zero coupon Treasury Bills.", "default": null, "optional": true }, { - "name": "treasury_retail_accepted", - "type": "int", - "description": "The accepted value on the security from retail.", + "name": "floating_rate", + "type": "bool", + "description": "For bond ETFs, this field identifies those ETFs that specifically hold floating rate bonds.", "default": null, "optional": true }, { - "name": "treasury_retail_tenders_accepted", - "type": "Literal['Yes', 'No']", - "description": "Whether or not the tender offers from retail are accepted", + "name": "build_america_bonds", + "type": "bool", + "description": "For municipal bond ETFs, this field identifies those ETFs that specifically hold Build America Bonds.", "default": null, "optional": true }, { - "name": "type", - "type": "str", - "description": "The type of issuance. This might be different than the security type.", + "name": "dynamic_futures_roll", + "type": "bool", + "description": "If the product holds futures contracts, this field identifies those products where the roll strategy is dynamic (rather than entirely rules based), so as to minimize roll costs.", "default": null, "optional": true }, { - "name": "unadjusted_accrued_interest_per_1000", - "type": "float", - "description": "The unadjusted accrued interest per 1000 of the security.", + "name": "currency_hedged", + "type": "bool", + "description": "This field is populated if the ETF's strategy involves hedging currency exposure.", "default": null, "optional": true }, { - "name": "unadjusted_price", - "type": "float", - "description": "The unadjusted price of the security.", + "name": "includes_short_exposure", + "type": "bool", + "description": "This field is populated if the ETF has short exposure in any of its holdings e.g. in a long/short or inverse ETF.", "default": null, "optional": true }, { - "name": "updated_timestamp", - "type": "datetime", - "description": "The updated timestamp of the security.", + "name": "ucits", + "type": "bool", + "description": "If true, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant", "default": null, "optional": true }, { - "name": "xml_announcement", + "name": "registered_countries", "type": "str", - "description": "The XML filename for the announcement of the security.", + "description": "The list of countries where the ETF is legally registered for sale. This may differ from where the ETF is domiciled or traded, particularly in Europe.", "default": null, "optional": true }, { - "name": "xml_competitive_results", + "name": "issuer_country", "type": "str", - "description": "The XML filename for the competitive results of the security.", + "description": "2 letter ISO country code for the country where the issuer is located.", "default": null, "optional": true }, { - "name": "xml_special_announcement", + "name": "domicile", "type": "str", - "description": "The XML filename for special announcements.", + "description": "2 letter ISO country code for the country where the ETP is domiciled.", "default": null, "optional": true }, { - "name": "tint_cusip1", + "name": "listing_country", "type": "str", - "description": "Tint CUSIP 1.", + "description": "2 letter ISO country code for the country of the primary listing.", "default": null, "optional": true }, { - "name": "tint_cusip2", + "name": "listing_region", "type": "str", - "description": "Tint CUSIP 2.", - "default": null, - "optional": true - } - ], - "government_us": [] - }, - "model": "TreasuryAuctions" - }, - "/fixedincome/government/treasury_prices": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Government Treasury Prices by date.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.treasury_prices(provider='government_us')\nobb.fixedincome.government.treasury_prices(date='2019-02-05', provider='government_us')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for. Defaults to the last business day.", + "description": "Geographic region in the country of the primary listing falls.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['government_us', 'tmx']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'government_us' if there is no default.", - "default": "government_us", - "optional": true - } - ], - "government_us": [ - { - "name": "cusip", + "name": "bond_currency_denomination", "type": "str", - "description": "Filter by CUSIP.", + "description": "For all bond ETFs, this field provides additional detail on the currency denomination of the underlying securities.", "default": null, "optional": true }, { - "name": "security_type", - "type": "Literal['bill', 'note', 'bond', 'tips', 'frn']", - "description": "Filter by security type.", + "name": "base_currency", + "type": "str", + "description": "Base currency in which NAV is reported.", "default": null, "optional": true - } - ], - "tmx": [ - { - "name": "govt_type", - "type": "Literal['federal', 'provincial', 'municipal']", - "description": "The level of government issuer.", - "default": "federal", - "optional": true }, { - "name": "issue_date_min", - "type": "date", - "description": "Filter by the minimum original issue date.", + "name": "listing_currency", + "type": "str", + "description": "Listing currency of the Exchange Traded Product (ETP) in which it is traded. Reported using the 3-digit ISO currency code.", "default": null, "optional": true }, { - "name": "issue_date_max", - "type": "date", - "description": "Filter by the maximum original issue date.", + "name": "number_of_holdings", + "type": "int", + "description": "The number of holdings in the ETF.", "default": null, "optional": true }, { - "name": "last_traded_min", - "type": "date", - "description": "Filter by the minimum last trade date.", + "name": "month_end_assets", + "type": "float", + "description": "Net assets in millions of dollars as of the most recent month end.", "default": null, "optional": true }, { - "name": "maturity_date_min", - "type": "date", - "description": "Filter by the minimum maturity date.", + "name": "net_expense_ratio", + "type": "float", + "description": "Gross expense net of Fee Waivers, as a percentage of net assets as published by the ETF issuer.", "default": null, "optional": true }, { - "name": "maturity_date_max", - "type": "date", - "description": "Filter by the maximum maturity date.", + "name": "etf_portfolio_turnover", + "type": "float", + "description": "The percentage of positions turned over in the last 12 months.", "default": null, "optional": true - }, - { - "name": "use_cache", - "type": "bool", - "description": "All bond data is sourced from a single JSON file that is updated daily. The file is cached for one day to eliminate downloading more than once. Caching will significantly speed up subsequent queries. To bypass, set to False.", - "default": true, - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[TreasuryPrices]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['government_us', 'tmx']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." } - ] - }, - "data": { - "standard": [ + ], + "yfinance": [ { - "name": "issuer_name", + "name": "fund_type", "type": "str", - "description": "Name of the issuing entity.", + "description": "The legal type of fund.", "default": null, "optional": true }, { - "name": "cusip", + "name": "fund_family", "type": "str", - "description": "CUSIP of the security.", + "description": "The fund family.", "default": null, "optional": true }, { - "name": "isin", + "name": "category", "type": "str", - "description": "ISIN of the security.", + "description": "The fund category.", "default": null, "optional": true }, { - "name": "security_type", + "name": "exchange", "type": "str", - "description": "The type of Treasury security - i.e., Bill, Note, Bond, TIPS, FRN.", + "description": "The exchange the fund is listed on.", "default": null, "optional": true }, { - "name": "issue_date", - "type": "date", - "description": "The original issue date of the security.", + "name": "exchange_timezone", + "type": "str", + "description": "The timezone of the exchange.", "default": null, "optional": true }, { - "name": "maturity_date", - "type": "date", - "description": "The maturity date of the security.", + "name": "currency", + "type": "str", + "description": "The currency in which the fund is listed.", "default": null, "optional": true }, { - "name": "call_date", - "type": "date", - "description": "The call date of the security.", + "name": "nav_price", + "type": "float", + "description": "The net asset value per unit of the fund.", "default": null, "optional": true }, { - "name": "bid", - "type": "float", - "description": "The bid price of the security.", + "name": "total_assets", + "type": "int", + "description": "The total value of assets held by the fund.", "default": null, "optional": true }, { - "name": "offer", + "name": "trailing_pe", "type": "float", - "description": "The offer price of the security.", + "description": "The trailing twelve month P/E ratio of the fund's assets.", "default": null, "optional": true }, { - "name": "eod_price", + "name": "dividend_yield", "type": "float", - "description": "The end-of-day price of the security.", + "description": "The dividend yield of the fund, as a normalized percent.", "default": null, "optional": true }, { - "name": "last_traded_date", - "type": "date", - "description": "The last trade date of the security.", + "name": "dividend_rate_ttm", + "type": "float", + "description": "The trailing twelve month annual dividend rate of the fund, in currency units.", "default": null, "optional": true }, { - "name": "total_trades", - "type": "int", - "description": "Total number of trades on the last traded date.", + "name": "dividend_yield_ttm", + "type": "float", + "description": "The trailing twelve month annual dividend yield of the fund, as a normalized percent.", "default": null, "optional": true }, { - "name": "last_price", + "name": "year_high", "type": "float", - "description": "The last price of the security.", + "description": "The fifty-two week high price.", "default": null, "optional": true }, { - "name": "highest_price", + "name": "year_low", "type": "float", - "description": "The highest price for the bond on the last traded date.", + "description": "The fifty-two week low price.", "default": null, "optional": true }, { - "name": "lowest_price", + "name": "ma_50d", "type": "float", - "description": "The lowest price for the bond on the last traded date.", + "description": "50-day moving average price.", "default": null, "optional": true }, { - "name": "rate", + "name": "ma_200d", "type": "float", - "description": "The annualized interest rate or coupon of the security.", + "description": "200-day moving average price.", "default": null, "optional": true }, { - "name": "ytm", + "name": "return_ytd", "type": "float", - "description": "Yield to maturity (YTM) is the rate of return anticipated on a bond if it is held until the maturity date. It takes into account the current market price, par value, coupon rate and time to maturity. It is assumed that all coupons are reinvested at the same rate.", - "default": null, - "optional": true - } - ], - "government_us": [], - "tmx": [] - }, - "model": "TreasuryPrices" - }, - "/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.", + "description": "The year-to-date return of the fund, as a normalized percent.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "return_3y_avg", + "type": "float", + "description": "The three year average return of the fund, as a normalized percent.", "default": null, "optional": true }, { - "name": "index_type", - "type": "Literal['yield', 'yield_to_worst', 'total_return', 'spread']", - "description": "The type of series.", - "default": "yield", - "optional": true - }, - { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", - "optional": true - } - ], - "fred": [ - { - "name": "category", - "type": "Literal['all', 'duration', 'eur', 'usd']", - "description": "The type of category.", - "default": "all", - "optional": true - }, - { - "name": "area", - "type": "Literal['asia', 'emea', 'eu', 'ex_g10', 'latin_america', 'us']", - "description": "The type of area.", - "default": "us", - "optional": true - }, - { - "name": "grade", - "type": "Literal['a', 'aa', 'aaa', 'b', 'bb', 'bbb', 'ccc', 'crossover', 'high_grade', 'high_yield', 'non_financial', 'non_sovereign', 'private_sector', 'public_sector']", - "description": "The type of grade.", - "default": "non_sovereign", - "optional": true - }, - { - "name": "options", - "type": "bool", - "description": "Whether to include options in the results.", - "default": false, - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[ICEBofA]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "return_5y_avg", + "type": "float", + "description": "The five year average return of the fund, as a normalized percent.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "beta_3y_avg", + "type": "float", + "description": "The three year average beta of the fund.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "volume_avg", + "type": "float", + "description": "The average daily trading volume of the fund.", + "default": null, + "optional": true }, { - "name": "rate", + "name": "volume_avg_10d", "type": "float", - "description": "ICE BofA US Corporate Bond Indices Rate.", - "default": "", - "optional": false - } - ], - "fred": [] - }, - "model": "ICEBofA" - }, - "/fixedincome/corporate/moody": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Moody Corporate Bond Index.\n\nMoody's Aaa and Baa are investment bonds that acts as an index of\nthe performance of all bonds given an Aaa or Baa rating by Moody's Investors Service respectively.\nThese corporate bonds often are used in macroeconomics as an alternative to the federal ten-year\nTreasury Bill as an indicator of the interest rate.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.corporate.moody(provider='fred')\nobb.fixedincome.corporate.moody(index_type='baa', provider='fred')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "description": "The average daily trading volume of the fund over the past ten days.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "bid", + "type": "float", + "description": "The current bid price.", "default": null, "optional": true }, { - "name": "index_type", - "type": "Literal['aaa', 'baa']", - "description": "The type of series.", - "default": "aaa", + "name": "bid_size", + "type": "float", + "description": "The current bid size.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "name": "ask", + "type": "float", + "description": "The current ask price.", + "default": null, "optional": true - } - ], - "fred": [ + }, { - "name": "spread", - "type": "Literal['treasury', 'fed_funds']", - "description": "The type of spread.", + "name": "ask_size", + "type": "float", + "description": "The current ask size.", "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[MoodyCorporateBondIndex]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." + "name": "open", + "type": "float", + "description": "The open price of the most recent trading session.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "high", + "type": "float", + "description": "The highest price of the most recent trading session.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "low", + "type": "float", + "description": "The lowest price of the most recent trading session.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "volume", + "type": "int", + "description": "The trading volume of the most recent trading session.", + "default": null, + "optional": true }, { - "name": "rate", + "name": "prev_close", "type": "float", - "description": "Moody Corporate Bond Index Rate.", - "default": "", - "optional": false + "description": "The previous closing price.", + "default": null, + "optional": true } - ], - "fred": [] + ] }, - "model": "MoodyCorporateBondIndex" + "model": "EtfInfo" }, - "/fixedincome/corporate/hqm": { + "/etf/sectors": { "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", + "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": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", - "default": null, - "optional": true - }, - { - "name": "yield_curve", - "type": "Literal['spot', 'par']", - "description": "The yield curve type.", - "default": "spot", - "optional": true + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false }, { "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true } ], - "fred": [] + "fmp": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[HighQualityMarketCorporateBond]", + "type": "List[EtfSectors]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fred']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -33224,103 +22774,60 @@ "data": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "rate", - "type": "float", - "description": "HighQualityMarketCorporateBond Rate.", - "default": "", - "optional": false - }, - { - "name": "maturity", + "name": "sector", "type": "str", - "description": "Maturity.", + "description": "Sector of exposure.", "default": "", "optional": false }, { - "name": "yield_curve", - "type": "Literal['spot', 'par']", - "description": "The yield curve type.", + "name": "weight", + "type": "float", + "description": "Exposure of the ETF to the sector in normalized percentage points.", "default": "", "optional": false } ], - "fred": [ - { - "name": "series_id", - "type": "str", - "description": "FRED series id.", - "default": "", - "optional": false - } - ] + "fmp": [] }, - "model": "HighQualityMarketCorporateBond" + "model": "EtfSectors" }, - "/fixedincome/corporate/spot_rates": { + "/etf/countries": { "deprecated": { "flag": null, "message": null - }, - "description": "Spot Rates.\n\nThe spot rates for any maturity is the yield on a bond that provides a single payment at that maturity.\nThis is a zero coupon bond.\nBecause each spot rate pertains to a single cashflow, it is the relevant interest rate\nconcept for discounting a pension liability at the same maturity.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.corporate.spot_rates(provider='fred')\nobb.fixedincome.corporate.spot_rates(maturity='10,20,30,50', provider='fred')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "maturity", - "type": "Union[Union[float, str], List[Union[float, str]]]", - "description": "Maturities in years. Multiple items allowed for provider(s): fred.", - "default": 10.0, - "optional": true - }, + }, + "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": "category", + "name": "symbol", "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 + "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false }, { "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true } ], - "fred": [] + "fmp": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[SpotRate]", + "type": "List[EtfCountries]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fred']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -33343,88 +22850,69 @@ "data": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "rate", - "type": "float", - "description": "Spot Rate.", + "name": "country", + "type": "str", + "description": "The country of the exposure. Corresponding values are normalized percentage points.", "default": "", "optional": false } ], - "fred": [] + "fmp": [] }, - "model": "SpotRate" + "model": "EtfCountries" }, - "/fixedincome/corporate/commercial_paper": { + "/etf/price_performance": { "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", + "description": "Price performance as a return, over different periods.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.price_performance(symbol='QQQ', provider='fmp')\nobb.etf.price_performance(symbol='SPY,QQQ,IWM,DJIA', provider='fmp')\n```\n\n", "parameters": { "standard": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "maturity", - "type": "Literal['overnight', '7d', '15d', '30d', '60d', '90d']", - "description": "The maturity.", - "default": "30d", - "optional": true + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", + "default": "", + "optional": false }, { - "name": "category", - "type": "Literal['asset_backed', 'financial', 'nonfinancial']", - "description": "The category.", - "default": "financial", + "name": "provider", + "type": "Literal['fmp', 'intrinio']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true - }, + } + ], + "fmp": [], + "intrinio": [ { - "name": "grade", - "type": "Literal['aa', 'a2_p2']", - "description": "The grade.", - "default": "aa", + "name": "return_type", + "type": "Literal['trailing', 'calendar']", + "description": "The type of returns to return, a trailing or calendar window.", + "default": "trailing", "optional": true }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "name": "adjustment", + "type": "Literal['splits_only', 'splits_and_dividends']", + "description": "The adjustment factor, 'splits_only' will return pure price performance.", + "default": "splits_and_dividends", "optional": true } - ], - "fred": [] + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[CommercialPaper]", + "type": "List[EtfPricePerformance]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['fred']]", + "type": "Optional[Literal['fmp', 'intrinio']]", "description": "Provider name." }, { @@ -33447,144 +22935,305 @@ "data": { "standard": [ { - "name": "date", - "type": "date", - "description": "The date of the data.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true + }, + { + "name": "one_day", + "type": "float", + "description": "One-day return.", + "default": null, + "optional": true + }, + { + "name": "wtd", + "type": "float", + "description": "Week to date return.", + "default": null, + "optional": true + }, + { + "name": "one_week", + "type": "float", + "description": "One-week return.", + "default": null, + "optional": true + }, + { + "name": "mtd", + "type": "float", + "description": "Month to date return.", + "default": null, + "optional": true + }, + { + "name": "one_month", + "type": "float", + "description": "One-month return.", + "default": null, + "optional": true + }, + { + "name": "qtd", + "type": "float", + "description": "Quarter to date return.", + "default": null, + "optional": true + }, + { + "name": "three_month", + "type": "float", + "description": "Three-month return.", + "default": null, + "optional": true + }, + { + "name": "six_month", + "type": "float", + "description": "Six-month return.", + "default": null, + "optional": true + }, + { + "name": "ytd", + "type": "float", + "description": "Year to date return.", + "default": null, + "optional": true + }, + { + "name": "one_year", + "type": "float", + "description": "One-year return.", + "default": null, + "optional": true + }, + { + "name": "two_year", + "type": "float", + "description": "Two-year return.", + "default": null, + "optional": true + }, + { + "name": "three_year", + "type": "float", + "description": "Three-year return.", + "default": null, + "optional": true + }, + { + "name": "four_year", + "type": "float", + "description": "Four-year", + "default": null, + "optional": true + }, + { + "name": "five_year", + "type": "float", + "description": "Five-year return.", + "default": null, + "optional": true + }, + { + "name": "ten_year", + "type": "float", + "description": "Ten-year return.", + "default": null, + "optional": true + }, + { + "name": "max", + "type": "float", + "description": "Return from the beginning of the time series.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", "default": "", "optional": false + } + ], + "intrinio": [ + { + "name": "max_annualized", + "type": "float", + "description": "Annualized rate of return from inception.", + "default": null, + "optional": true + }, + { + "name": "volatility_one_year", + "type": "float", + "description": "Trailing one-year annualized volatility.", + "default": null, + "optional": true + }, + { + "name": "volatility_three_year", + "type": "float", + "description": "Trailing three-year annualized volatility.", + "default": null, + "optional": true }, { - "name": "rate", + "name": "volatility_five_year", "type": "float", - "description": "Commercial Paper Rate.", - "default": "", - "optional": false - } - ], - "fred": [] - }, - "model": "CommercialPaper" - }, - "/fixedincome/corporate/bond_prices": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Corporate Bond Prices.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.corporate.bond_prices(provider='tmx')\n```\n\n", - "parameters": { - "standard": [ + "description": "Trailing five-year annualized volatility.", + "default": null, + "optional": true + }, { - "name": "country", - "type": "str", - "description": "The country to get data. Matches partial name.", + "name": "volume", + "type": "int", + "description": "The trading volume.", "default": null, "optional": true }, { - "name": "issuer_name", - "type": "str", - "description": "Name of the issuer. Returns partial matches and is case insensitive.", + "name": "volume_avg_30", + "type": "float", + "description": "The one-month average daily volume.", "default": null, "optional": true }, { - "name": "isin", - "type": "Union[List, str]", - "description": "International Securities Identification Number(s) of the bond(s).", + "name": "volume_avg_90", + "type": "float", + "description": "The three-month average daily volume.", "default": null, "optional": true }, { - "name": "lei", - "type": "str", - "description": "Legal Entity Identifier of the issuing entity.", + "name": "volume_avg_180", + "type": "float", + "description": "The six-month average daily volume.", "default": null, "optional": true }, { - "name": "currency", - "type": "Union[List, str]", - "description": "Currency of the bond. Formatted as the 3-letter ISO 4217 code (e.g. GBP, EUR, USD).", + "name": "beta", + "type": "float", + "description": "Beta compared to the S&P 500.", "default": null, "optional": true }, { - "name": "coupon_min", + "name": "nav", "type": "float", - "description": "Minimum coupon rate of the bond.", + "description": "Net asset value per share.", "default": null, "optional": true }, { - "name": "coupon_max", + "name": "year_high", "type": "float", - "description": "Maximum coupon rate of the bond.", + "description": "The 52-week high price.", "default": null, "optional": true }, { - "name": "issued_amount_min", - "type": "int", - "description": "Minimum issued amount of the bond.", + "name": "year_low", + "type": "float", + "description": "The 52-week low price.", "default": null, "optional": true }, { - "name": "issued_amount_max", - "type": "str", - "description": "Maximum issued amount of the bond.", + "name": "market_cap", + "type": "float", + "description": "The market capitalization.", "default": null, "optional": true }, { - "name": "maturity_date_min", - "type": "date", - "description": "Minimum maturity date of the bond.", + "name": "shares_outstanding", + "type": "int", + "description": "The number of shares outstanding.", "default": null, "optional": true }, { - "name": "maturity_date_max", + "name": "updated", "type": "date", - "description": "Maximum maturity date of the bond.", + "description": "The date of the data.", "default": null, "optional": true + } + ] + }, + "model": "EtfPricePerformance" + }, + "/etf/holdings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the holdings for an individual ETF.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings(symbol='XLK', provider='fmp')\n# Including a date (FMP, SEC) will return the holdings as per NPORT-P filings.\nobb.etf.holdings(symbol='XLK', date=2022-03-31, provider='fmp')\n# The same data can be returned from the SEC directly.\nobb.etf.holdings(symbol='XLK', date=2022-03-31, provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false }, { "name": "provider", - "type": "Literal['tmx']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default.", - "default": "tmx", + "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 } ], - "tmx": [ + "fmp": [ { - "name": "issue_date_min", - "type": "date", - "description": "Filter by the minimum original issue date.", + "name": "date", + "type": "Union[Union[str, date], str]", + "description": "A specific date to get data for. Entering a date will attempt to return the NPORT-P filing for the entered date. This needs to be _exactly_ the date of the filing. Use the holdings_date command/endpoint to find available filing dates for the ETF.", "default": null, "optional": true }, { - "name": "issue_date_max", - "type": "date", - "description": "Filter by the maximum original issue date.", + "name": "cik", + "type": "str", + "description": "The CIK of the filing entity. Overrides symbol.", "default": null, "optional": true - }, + } + ], + "intrinio": [ { - "name": "last_traded_min", - "type": "date", - "description": "Filter by the minimum last trade date.", + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": null, + "optional": true + } + ], + "sec": [ + { + "name": "date", + "type": "Union[Union[str, date], str]", + "description": "A specific date to get data for. The date represents the period ending. The date entered will return the closest filing.", "default": null, "optional": true }, { "name": "use_cache", "type": "bool", - "description": "All bond data is sourced from a single JSON file that is updated daily. The file is cached for one day to eliminate downloading more than once. Caching will significantly speed up subsequent queries. To bypass, set to False.", + "description": "Whether or not to use cache for the request.", "default": true, "optional": true } @@ -33594,12 +23243,12 @@ "OBBject": [ { "name": "results", - "type": "List[BondPrices]", + "type": "List[EtfHoldings]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['tmx']]", + "type": "Optional[Literal['fmp', 'intrinio', 'sec']]", "description": "Provider name." }, { @@ -33622,985 +23271,843 @@ "data": { "standard": [ { - "name": "isin", + "name": "symbol", "type": "str", - "description": "International Securities Identification Number of the bond.", + "description": "Symbol representing the entity requested in the data. (ETF)", "default": null, "optional": true }, + { + "name": "name", + "type": "str", + "description": "Name of the ETF holding.", + "default": null, + "optional": true + } + ], + "fmp": [ { "name": "lei", "type": "str", - "description": "Legal Entity Identifier of the issuing entity.", + "description": "The LEI of the holding.", "default": null, "optional": true }, { - "name": "figi", + "name": "title", "type": "str", - "description": "FIGI of the bond.", + "description": "The title of the holding.", "default": null, "optional": true }, { "name": "cusip", "type": "str", - "description": "CUSIP of the bond.", + "description": "The CUSIP of the holding.", + "default": null, + "optional": true + }, + { + "name": "isin", + "type": "str", + "description": "The ISIN of the holding.", "default": null, "optional": true }, { - "name": "coupon_rate", - "type": "float", - "description": "Coupon rate of the bond.", + "name": "balance", + "type": "int", + "description": "The balance of the holding, in shares or units.", "default": null, "optional": true - } - ], - "tmx": [ + }, { - "name": "ytm", - "type": "float", - "description": "Yield to maturity (YTM) is the rate of return anticipated on a bond if it is held until the maturity date. It takes into account the current market price, par value, coupon rate and time to maturity. It is assumed that all coupons are reinvested at the same rate. Values are returned as a normalized percent.", + "name": "units", + "type": "Union[str, float]", + "description": "The type of units.", "default": null, "optional": true }, { - "name": "price", - "type": "float", - "description": "The last price for the bond.", + "name": "currency", + "type": "str", + "description": "The currency of the holding.", "default": null, "optional": true }, { - "name": "highest_price", + "name": "value", "type": "float", - "description": "The highest price for the bond on the last traded date.", + "description": "The value of the holding, in dollars.", "default": null, "optional": true }, { - "name": "lowest_price", + "name": "weight", "type": "float", - "description": "The lowest price for the bond on the last traded date.", + "description": "The weight of the holding, as a normalized percent.", "default": null, "optional": true }, { - "name": "total_trades", - "type": "int", - "description": "Total number of trades on the last traded date.", + "name": "payoff_profile", + "type": "str", + "description": "The payoff profile of the holding.", "default": null, "optional": true }, { - "name": "last_traded_date", - "type": "date", - "description": "Last traded date of the bond.", + "name": "asset_category", + "type": "str", + "description": "The asset category of the holding.", "default": null, "optional": true }, { - "name": "maturity_date", - "type": "date", - "description": "Maturity date of the bond.", + "name": "issuer_category", + "type": "str", + "description": "The issuer category of the holding.", "default": null, "optional": true }, { - "name": "issue_date", - "type": "date", - "description": "Issue date of the bond. This is the date when the bond first accrues interest.", + "name": "country", + "type": "str", + "description": "The country of the holding.", "default": null, "optional": true }, { - "name": "issuer_name", + "name": "is_restricted", "type": "str", - "description": "Name of the issuing entity.", + "description": "Whether the holding is restricted.", "default": null, "optional": true - } - ] - }, - "model": "BondPrices" - }, - "/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.", + "name": "fair_value_level", + "type": "int", + "description": "The fair value level of the holding.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "is_cash_collateral", + "type": "str", + "description": "Whether the holding is cash collateral.", "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['fred']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", - "default": "fred", + "name": "is_non_cash_collateral", + "type": "str", + "description": "Whether the holding is non-cash collateral.", + "default": null, + "optional": true + }, + { + "name": "is_loan_by_fund", + "type": "str", + "description": "Whether the holding is loan by fund.", + "default": null, + "optional": true + }, + { + "name": "cik", + "type": "str", + "description": "The CIK of the filing.", + "default": null, + "optional": true + }, + { + "name": "acceptance_datetime", + "type": "str", + "description": "The acceptance datetime of the filing.", + "default": null, + "optional": true + }, + { + "name": "updated", + "type": "Union[date, datetime]", + "description": "The date the data was updated.", + "default": null, "optional": true } ], - "fred": [ + "intrinio": [ { - "name": "period", - "type": "Literal['overnight', '30_day', '90_day', '180_day', 'index']", - "description": "Period of SOFR rate.", - "default": "overnight", + "name": "name", + "type": "str", + "description": "The common name for the holding.", + "default": null, + "optional": true + }, + { + "name": "security_type", + "type": "str", + "description": "The type of instrument for this holding. Examples(Bond='BOND', Equity='EQUI')", + "default": null, + "optional": true + }, + { + "name": "isin", + "type": "str", + "description": "The International Securities Identification Number.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[SOFR]", - "description": "Serializable results." + "name": "ric", + "type": "str", + "description": "The Reuters Instrument Code.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['fred']]", - "description": "Provider name." + "name": "sedol", + "type": "str", + "description": "The Stock Exchange Daily Official List.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "share_class_figi", + "type": "str", + "description": "The OpenFIGI symbol for the holding.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "country", + "type": "str", + "description": "The country or region of the holding.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "maturity_date", + "type": "date", + "description": "The maturity date for the debt security, if available.", + "default": null, + "optional": true + }, { - "name": "date", + "name": "contract_expiry_date", "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false + "description": "Expiry date for the futures contract held, if available.", + "default": null, + "optional": true }, { - "name": "rate", + "name": "coupon", "type": "float", - "description": "SOFR rate.", - "default": "", - "optional": false - } - ], - "fred": [] - }, - "model": "SOFR" - }, - "/index/price/historical": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Historical Index Levels.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.price.historical(symbol='^GSPC', provider='fmp')\n# Not all providers have the same symbols.\nobb.index.price.historical(symbol='SPX', provider='intrinio')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance.", - "default": "", - "optional": false + "description": "The coupon rate of the debt security, if available.", + "default": null, + "optional": true }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "balance", + "type": "Union[int, float]", + "description": "The number of units of the security held, if available.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "unit", + "type": "str", + "description": "The units of the 'balance' field.", "default": null, "optional": true }, { - "name": "interval", - "type": "str", - "description": "Time interval of the data to return.", - "default": "1d", + "name": "units_per_share", + "type": "float", + "description": "Number of units of the security held per share outstanding of the ETF, if available.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['cboe', '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 'cboe' if there is no default.", - "default": "cboe", + "name": "face_value", + "type": "float", + "description": "The face value of the debt security, if available.", + "default": null, "optional": true - } - ], - "cboe": [ + }, { - "name": "interval", - "type": "Literal['1m', '1d']", - "description": "Time interval of the data to return. The most recent trading day is not including in daily historical data. Intraday data is only available for the most recent trading day at 1 minute intervals.", - "default": "1d", + "name": "derivatives_value", + "type": "float", + "description": "The notional value of derivatives contracts held.", + "default": null, "optional": true }, { - "name": "use_cache", - "type": "bool", - "description": "When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass.", - "default": true, + "name": "value", + "type": "float", + "description": "The market value of the holding, on the 'as_of' date.", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "interval", - "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", - "description": "Time interval of the data to return.", - "default": "1d", + "name": "weight", + "type": "float", + "description": "The weight of the holding, as a normalized percent.", + "default": null, "optional": true - } - ], - "intrinio": [ + }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 10000, + "name": "updated", + "type": "date", + "description": "The 'as_of' date for the holding.", + "default": null, "optional": true } ], - "polygon": [ + "sec": [ { - "name": "interval", + "name": "lei", "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", + "description": "The LEI of the holding.", + "default": null, "optional": true }, { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", - "default": "asc", + "name": "cusip", + "type": "str", + "description": "The CUSIP of the holding.", + "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 49999, + "name": "isin", + "type": "str", + "description": "The ISIN of the holding.", + "default": null, "optional": true - } - ], - "yfinance": [ + }, { - "name": "interval", - "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", - "description": "Time interval of the data to return.", - "default": "1d", + "name": "other_id", + "type": "str", + "description": "Internal identifier for the holding.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[IndexHistorical]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['cboe', 'fmp', 'intrinio', 'polygon', 'yfinance']]", - "description": "Provider name." + "name": "balance", + "type": "float", + "description": "The balance of the holding.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "weight", + "type": "float", + "description": "The weight of the holding in ETF in %.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "value", + "type": "float", + "description": "The value of the holding in USD.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "Union[date, datetime]", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "payoff_profile", + "type": "str", + "description": "The payoff profile of the holding.", + "default": null, + "optional": true }, { - "name": "open", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The open price.", + "name": "units", + "type": "Union[str, float]", + "description": "The units of the holding.", "default": null, "optional": true }, { - "name": "high", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The high price.", + "name": "currency", + "type": "str", + "description": "The currency of the holding.", "default": null, "optional": true }, { - "name": "low", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The low price.", + "name": "asset_category", + "type": "str", + "description": "The asset category of the holding.", "default": null, "optional": true }, { - "name": "close", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The close price.", + "name": "issuer_category", + "type": "str", + "description": "The issuer category of the holding.", "default": null, "optional": true }, { - "name": "volume", - "type": "int", - "description": "The trading volume.", + "name": "country", + "type": "str", + "description": "The country of the holding.", "default": null, "optional": true - } - ], - "cboe": [ + }, { - "name": "calls_volume", - "type": "float", - "description": "Number of calls traded during the most recent trading period. Only valid if interval is 1m.", + "name": "is_restricted", + "type": "str", + "description": "Whether the holding is restricted.", "default": null, "optional": true }, { - "name": "puts_volume", - "type": "float", - "description": "Number of puts traded during the most recent trading period. Only valid if interval is 1m.", + "name": "fair_value_level", + "type": "int", + "description": "The fair value level of the holding.", "default": null, "optional": true }, { - "name": "total_options_volume", - "type": "float", - "description": "Total number of options traded during the most recent trading period. Only valid if interval is 1m.", + "name": "is_cash_collateral", + "type": "str", + "description": "Whether the holding is cash collateral.", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "vwap", - "type": "float", - "description": "Volume Weighted Average Price over the period.", + "name": "is_non_cash_collateral", + "type": "str", + "description": "Whether the holding is non-cash collateral.", "default": null, "optional": true }, { - "name": "change", - "type": "float", - "description": "Change in the price from the previous close.", + "name": "is_loan_by_fund", + "type": "str", + "description": "Whether the holding is loan by fund.", "default": null, "optional": true }, { - "name": "change_percent", + "name": "loan_value", "type": "float", - "description": "Change in the price from the previous close, as a normalized percent.", + "description": "The loan value of the holding.", "default": null, "optional": true - } - ], - "intrinio": [], - "polygon": [ + }, { - "name": "transactions", - "type": "Annotated[int, Gt(gt=0)]", - "description": "Number of transactions for the symbol in the time period.", + "name": "issuer_conditional", + "type": "str", + "description": "The issuer conditions of the holding.", "default": null, "optional": true - } - ], - "yfinance": [] - }, - "model": "IndexHistorical" - }, - "/index/market": { - "deprecated": { - "flag": true, - "message": "This endpoint is deprecated; use `/index/price/historical` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.3." - }, - "description": "Get Historical Market Indices.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.market(symbol='^IBEX', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance.", - "default": "", - "optional": false }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "asset_conditional", + "type": "str", + "description": "The asset conditions of the holding.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", + "name": "maturity_date", + "type": "date", + "description": "The maturity date of the debt security.", "default": null, "optional": true }, { - "name": "interval", + "name": "coupon_kind", "type": "str", - "description": "Time interval of the data to return.", - "default": "1d", + "description": "The type of coupon for the debt security.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['cboe', '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 'cboe' if there is no default.", - "default": "cboe", - "optional": true - } - ], - "cboe": [ - { - "name": "interval", - "type": "Literal['1m', '1d']", - "description": "Time interval of the data to return. The most recent trading day is not including in daily historical data. Intraday data is only available for the most recent trading day at 1 minute intervals.", - "default": "1d", + "name": "rate_type", + "type": "str", + "description": "The type of rate for the debt security, floating or fixed.", + "default": null, "optional": true }, { - "name": "use_cache", - "type": "bool", - "description": "When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass.", - "default": true, - "optional": true - } - ], - "fmp": [ - { - "name": "interval", - "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - } - ], - "intrinio": [ - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 10000, + "name": "annualized_return", + "type": "float", + "description": "The annualized return on the debt security.", + "default": null, "optional": true - } - ], - "polygon": [ + }, { - "name": "interval", + "name": "is_default", "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", + "description": "If the debt security is defaulted.", + "default": null, "optional": true }, { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", - "default": "asc", + "name": "in_arrears", + "type": "str", + "description": "If the debt security is in arrears.", + "default": null, "optional": true }, { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 49999, + "name": "is_paid_kind", + "type": "str", + "description": "If the debt security payments are paid in kind.", + "default": null, "optional": true - } - ], - "yfinance": [ + }, { - "name": "interval", - "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", - "description": "Time interval of the data to return.", - "default": "1d", + "name": "derivative_category", + "type": "str", + "description": "The derivative category of the holding.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[MarketIndices]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['cboe', 'fmp', 'intrinio', 'polygon', 'yfinance']]", - "description": "Provider name." + "name": "counterparty", + "type": "str", + "description": "The counterparty of the derivative.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "underlying_name", + "type": "str", + "description": "The name of the underlying asset associated with the derivative.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "option_type", + "type": "str", + "description": "The type of option.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "Union[date, datetime]", - "description": "The date of the data.", - "default": "", - "optional": false + "name": "derivative_payoff", + "type": "str", + "description": "The payoff profile of the derivative.", + "default": null, + "optional": true }, { - "name": "open", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The open price.", + "name": "expiry_date", + "type": "date", + "description": "The expiry or termination date of the derivative.", "default": null, "optional": true }, { - "name": "high", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The high price.", + "name": "exercise_price", + "type": "float", + "description": "The exercise price of the option.", "default": null, "optional": true }, { - "name": "low", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The low price.", + "name": "exercise_currency", + "type": "str", + "description": "The currency of the option exercise price.", "default": null, "optional": true }, { - "name": "close", - "type": "Annotated[float, Strict(strict=True)]", - "description": "The close price.", + "name": "shares_per_contract", + "type": "float", + "description": "The number of shares per contract.", "default": null, "optional": true }, { - "name": "volume", - "type": "int", - "description": "The trading volume.", + "name": "delta", + "type": "Union[str, float]", + "description": "The delta of the option.", "default": null, "optional": true - } - ], - "cboe": [ + }, { - "name": "calls_volume", - "type": "float", - "description": "Number of calls traded during the most recent trading period. Only valid if interval is 1m.", + "name": "rate_type_rec", + "type": "str", + "description": "The type of rate for receivable portion of the swap.", "default": null, "optional": true }, { - "name": "puts_volume", - "type": "float", - "description": "Number of puts traded during the most recent trading period. Only valid if interval is 1m.", + "name": "receive_currency", + "type": "str", + "description": "The receive currency of the swap.", "default": null, "optional": true }, { - "name": "total_options_volume", + "name": "upfront_receive", "type": "float", - "description": "Total number of options traded during the most recent trading period. Only valid if interval is 1m.", + "description": "The upfront amount received of the swap.", "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "vwap", - "type": "float", - "description": "Volume Weighted Average Price over the period.", + "name": "floating_rate_index_rec", + "type": "str", + "description": "The floating rate index for receivable portion of the swap.", "default": null, "optional": true }, { - "name": "change", + "name": "floating_rate_spread_rec", "type": "float", - "description": "Change in the price from the previous close.", + "description": "The floating rate spread for reveivable portion of the swap.", "default": null, "optional": true }, { - "name": "change_percent", - "type": "float", - "description": "Change in the price from the previous close, as a normalized percent.", + "name": "rate_tenor_rec", + "type": "str", + "description": "The rate tenor for receivable portion of the swap.", "default": null, "optional": true - } - ], - "intrinio": [], - "polygon": [ + }, { - "name": "transactions", - "type": "Annotated[int, Gt(gt=0)]", - "description": "Number of transactions for the symbol in the time period.", + "name": "rate_tenor_unit_rec", + "type": "Union[int, str]", + "description": "The rate tenor unit for receivable portion of the swap.", "default": null, "optional": true - } - ], - "yfinance": [] - }, - "model": "MarketIndices" - }, - "/index/constituents": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get Index Constituents.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.constituents(symbol='dowjones', provider='fmp')\n# Providers other than FMP will use the ticker symbol.\nobb.index.constituents(symbol='BEP50P', provider='cboe')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false }, { - "name": "provider", - "type": "Literal['cboe', 'fmp', 'tmx']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.", - "default": "cboe", + "name": "reset_date_rec", + "type": "str", + "description": "The reset date for receivable portion of the swap.", + "default": null, "optional": true - } - ], - "cboe": [ + }, { - "name": "symbol", - "type": "Literal['BAT20P', 'BBE20P', 'BCH20P', 'BCHM30P', 'BDE40P', 'BDEM50P', 'BDES50P', 'BDK25P', 'BEP50P', 'BEPACP', 'BEPBUS', 'BEPCNC', 'BEPCONC', 'BEPCONS', 'BEPENGY', 'BEPFIN', 'BEPHLTH', 'BEPIND', 'BEPNEM', 'BEPTEC', 'BEPTEL', 'BEPUTL', 'BEPXUKP', 'BES35P', 'BEZ50P', 'BEZACP', 'BFI25P', 'BFR40P', 'BFRM20P', 'BIE20P', 'BIT40P', 'BNL25P', 'BNLM25P', 'BNO25G', 'BNORD40P', 'BPT20P', 'BSE30P', 'BUK100P', 'BUK250P', 'BUK350P', 'BUKAC', 'BUKBISP', 'BUKBUS', 'BUKCNC', 'BUKCONC', 'BUKCONS', 'BUKENGY', 'BUKFIN', 'BUKHI50P', 'BUKHLTH', 'BUKIND', 'BUKLO50P', 'BUKMINP', 'BUKNEM', 'BUKSC', 'BUKTEC', 'BUKTEL', 'BUKUTL']", - "description": "None", - "default": "BUK100P", + "name": "reset_date_unit_rec", + "type": "Union[int, str]", + "description": "The reset date unit for receivable portion of the swap.", + "default": null, "optional": true - } - ], - "fmp": [ + }, { - "name": "symbol", - "type": "Literal['dowjones', 'sp500', 'nasdaq']", - "description": "None", - "default": "dowjones", + "name": "rate_type_pmnt", + "type": "str", + "description": "The type of rate for payment portion of the swap.", + "default": null, "optional": true - } - ], - "tmx": [ + }, { - "name": "use_cache", - "type": "bool", - "description": "Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False.", - "default": true, + "name": "payment_currency", + "type": "str", + "description": "The payment currency of the swap.", + "default": null, "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[IndexConstituents]", - "description": "Serializable results." }, { - "name": "provider", - "type": "Optional[Literal['cboe', 'fmp', 'tmx']]", - "description": "Provider name." + "name": "upfront_payment", + "type": "float", + "description": "The upfront amount received of the swap.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "floating_rate_index_pmnt", + "type": "str", + "description": "The floating rate index for payment portion of the swap.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "floating_rate_spread_pmnt", + "type": "float", + "description": "The floating rate spread for payment portion of the swap.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", + "name": "rate_tenor_pmnt", "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "description": "The rate tenor for payment portion of the swap.", + "default": null, + "optional": true }, { - "name": "name", - "type": "str", - "description": "Name of the constituent company in the index.", + "name": "rate_tenor_unit_pmnt", + "type": "Union[int, str]", + "description": "The rate tenor unit for payment portion of the swap.", "default": null, "optional": true - } - ], - "cboe": [ + }, { - "name": "security_type", + "name": "reset_date_pmnt", "type": "str", - "description": "The type of security represented.", + "description": "The reset date for payment portion of the swap.", "default": null, "optional": true }, { - "name": "last_price", - "type": "float", - "description": "Last price for the symbol.", + "name": "reset_date_unit_pmnt", + "type": "Union[int, str]", + "description": "The reset date unit for payment portion of the swap.", "default": null, "optional": true }, { - "name": "open", - "type": "float", - "description": "The open price.", + "name": "repo_type", + "type": "str", + "description": "The type of repo.", "default": null, "optional": true }, { - "name": "high", - "type": "float", - "description": "The high price.", + "name": "is_cleared", + "type": "str", + "description": "If the repo is cleared.", "default": null, "optional": true }, { - "name": "low", - "type": "float", - "description": "The low price.", + "name": "is_tri_party", + "type": "str", + "description": "If the repo is tri party.", "default": null, "optional": true }, { - "name": "close", + "name": "principal_amount", "type": "float", - "description": "The close price.", + "description": "The principal amount of the repo.", "default": null, "optional": true }, { - "name": "volume", - "type": "int", - "description": "The trading volume.", + "name": "principal_currency", + "type": "str", + "description": "The currency of the principal amount.", "default": null, "optional": true }, { - "name": "prev_close", - "type": "float", - "description": "The previous close price.", + "name": "collateral_type", + "type": "str", + "description": "The collateral type of the repo.", "default": null, "optional": true }, { - "name": "change", + "name": "collateral_amount", "type": "float", - "description": "Change in price.", + "description": "The collateral amount of the repo.", "default": null, "optional": true }, { - "name": "change_percent", - "type": "float", - "description": "Change in price as a normalized percentage.", + "name": "collateral_currency", + "type": "str", + "description": "The currency of the collateral amount.", "default": null, "optional": true }, { - "name": "tick", + "name": "exchange_currency", "type": "str", - "description": "Whether the last sale was an up or down tick.", + "description": "The currency of the exchange rate.", "default": null, "optional": true }, { - "name": "last_trade_time", - "type": "datetime", - "description": "Last trade timestamp for the symbol.", + "name": "exchange_rate", + "type": "float", + "description": "The exchange rate.", "default": null, "optional": true }, { - "name": "asset_type", + "name": "currency_sold", "type": "str", - "description": "Type of asset.", + "description": "The currency sold in a Forward Derivative.", "default": null, "optional": true - } - ], - "fmp": [ - { - "name": "sector", - "type": "str", - "description": "Sector the constituent company in the index belongs to.", - "default": "", - "optional": false }, { - "name": "sub_sector", - "type": "str", - "description": "Sub-sector the constituent company in the index belongs to.", + "name": "currency_amount_sold", + "type": "float", + "description": "The amount of currency sold in a Forward Derivative.", "default": null, "optional": true }, { - "name": "headquarter", + "name": "currency_bought", "type": "str", - "description": "Location of the headquarter of the constituent company in the index.", + "description": "The currency bought in a Forward Derivative.", "default": null, "optional": true }, { - "name": "date_first_added", - "type": "Union[str, date]", - "description": "Date the constituent company was added to the index.", + "name": "currency_amount_bought", + "type": "float", + "description": "The amount of currency bought in a Forward Derivative.", "default": null, "optional": true }, { - "name": "cik", - "type": "int", - "description": "Central Index Key (CIK) for the requested entity.", + "name": "notional_amount", + "type": "float", + "description": "The notional amount of the derivative.", "default": null, "optional": true }, - { - "name": "founded", - "type": "Union[str, date]", - "description": "Founding year of the constituent company in the index.", + { + "name": "notional_currency", + "type": "str", + "description": "The currency of the derivative's notional amount.", "default": null, "optional": true - } - ], - "tmx": [ + }, { - "name": "market_value", + "name": "unrealized_gain", "type": "float", - "description": "The quoted market value of the asset.", + "description": "The unrealized gain or loss on the derivative.", "default": null, "optional": true } ] }, - "model": "IndexConstituents" + "model": "EtfHoldings" }, - "/index/snapshots": { + "/etf/holdings_date": { "deprecated": { "flag": null, "message": null }, - "description": "Index Snapshots. Current levels for all indices from a provider, grouped by `region`.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.snapshots(provider='tmx')\nobb.index.snapshots(region='us', provider='cboe')\n```\n\n", + "description": "Use this function to get the holdings dates, if available.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings_date(symbol='XLK', provider='fmp')\n```\n\n", "parameters": { "standard": [ { - "name": "region", + "name": "symbol", "type": "str", - "description": "The region of focus for the data - i.e., us, eu.", - "default": "us", - "optional": true + "description": "Symbol to get data for. (ETF)", + "default": "", + "optional": false }, { "name": "provider", - "type": "Literal['cboe', 'tmx']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.", - "default": "cboe", - "optional": true - } - ], - "cboe": [ - { - "name": "region", - "type": "Literal['us', 'eu']", - "description": "None", - "default": "us", + "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 } ], - "tmx": [ - { - "name": "region", - "type": "Literal['ca', 'us']", - "description": "None", - "default": "ca", - "optional": true - }, + "fmp": [ { - "name": "use_cache", - "type": "bool", - "description": "Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False.", - "default": true, + "name": "cik", + "type": "str", + "description": "The CIK of the filing entity. Overrides symbol.", + "default": null, "optional": true } ] @@ -34609,12 +24116,12 @@ "OBBject": [ { "name": "results", - "type": "List[IndexSnapshots]", + "type": "List[EtfHoldingsDate]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['cboe', 'tmx']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -34637,327 +24144,242 @@ "data": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false - }, - { - "name": "name", - "type": "str", - "description": "Name of the index.", - "default": null, - "optional": true - }, - { - "name": "currency", - "type": "str", - "description": "Currency of the index.", - "default": null, - "optional": true - }, - { - "name": "price", - "type": "float", - "description": "Current price of the index.", - "default": null, - "optional": true - }, - { - "name": "open", - "type": "float", - "description": "The open price.", - "default": null, - "optional": true - }, - { - "name": "high", - "type": "float", - "description": "The high price.", - "default": null, - "optional": true - }, - { - "name": "low", - "type": "float", - "description": "The low price.", - "default": null, - "optional": true - }, - { - "name": "close", - "type": "float", - "description": "The close price.", - "default": null, - "optional": true - }, - { - "name": "volume", - "type": "int", - "description": "The trading volume.", - "default": null, - "optional": true - }, - { - "name": "prev_close", - "type": "float", - "description": "The previous close price.", - "default": null, - "optional": true - }, + } + ], + "fmp": [] + }, + "model": "EtfHoldingsDate" + }, + "/etf/holdings_performance": { + "deprecated": { + "flag": true, + "message": "This endpoint is deprecated; pass a list of holdings symbols directly to `/equity/price/performance` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.2." + }, + "description": "Get the recent price performance of each ticker held in the ETF.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings_performance(symbol='XLK', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "change", - "type": "float", - "description": "Change in value of the index.", - "default": null, - "optional": true + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false }, { - "name": "change_percent", - "type": "float", - "description": "Change, in normalized percentage points, of the index.", - "default": null, + "name": "provider", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true } ], - "cboe": [ - { - "name": "open", - "type": "float", - "description": "The open price.", - "default": null, - "optional": true - }, + "fmp": [] + }, + "returns": { + "OBBject": [ { - "name": "high", - "type": "float", - "description": "The high price.", - "default": null, - "optional": true + "name": "results", + "type": "List[EtfHoldingsPerformance]", + "description": "Serializable results." }, { - "name": "low", - "type": "float", - "description": "The low price.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fmp']]", + "description": "Provider name." }, { - "name": "close", - "type": "float", - "description": "The close price.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "volume", - "type": "int", - "description": "The trading volume.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "prev_close", - "type": "float", - "description": "The previous close price.", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "change", - "type": "float", - "description": "Change in price.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true }, { - "name": "change_percent", + "name": "one_day", "type": "float", - "description": "Change in price as a normalized percentage.", + "description": "One-day return.", "default": null, "optional": true }, { - "name": "bid", + "name": "wtd", "type": "float", - "description": "Current bid price.", + "description": "Week to date return.", "default": null, "optional": true }, { - "name": "ask", + "name": "one_week", "type": "float", - "description": "Current ask price.", - "default": null, - "optional": true - }, - { - "name": "last_trade_time", - "type": "datetime", - "description": "Last trade timestamp for the symbol.", + "description": "One-week return.", "default": null, "optional": true }, { - "name": "status", - "type": "str", - "description": "Status of the market, open or closed.", - "default": null, - "optional": true - } - ], - "tmx": [ - { - "name": "year_high", + "name": "mtd", "type": "float", - "description": "The 52-week high of the index.", + "description": "Month to date return.", "default": null, "optional": true }, { - "name": "year_low", + "name": "one_month", "type": "float", - "description": "The 52-week low of the index.", + "description": "One-month return.", "default": null, "optional": true }, { - "name": "return_mtd", + "name": "qtd", "type": "float", - "description": "The month-to-date return of the index, as a normalized percent.", + "description": "Quarter to date return.", "default": null, "optional": true }, { - "name": "return_qtd", + "name": "three_month", "type": "float", - "description": "The quarter-to-date return of the index, as a normalized percent.", + "description": "Three-month return.", "default": null, "optional": true }, { - "name": "return_ytd", + "name": "six_month", "type": "float", - "description": "The year-to-date return of the index, as a normalized percent.", + "description": "Six-month return.", "default": null, "optional": true }, { - "name": "total_market_value", + "name": "ytd", "type": "float", - "description": "The total quoted market value of the index.", - "default": null, - "optional": true - }, - { - "name": "number_of_constituents", - "type": "int", - "description": "The number of constituents in the index.", + "description": "Year to date return.", "default": null, "optional": true }, { - "name": "constituent_average_market_value", + "name": "one_year", "type": "float", - "description": "The average quoted market value of the index constituents.", + "description": "One-year return.", "default": null, "optional": true }, { - "name": "constituent_median_market_value", + "name": "two_year", "type": "float", - "description": "The median quoted market value of the index constituents.", + "description": "Two-year return.", "default": null, "optional": true }, { - "name": "constituent_top10_market_value", + "name": "three_year", "type": "float", - "description": "The sum of the top 10 quoted market values of the index constituents.", + "description": "Three-year return.", "default": null, "optional": true }, { - "name": "constituent_largest_market_value", + "name": "four_year", "type": "float", - "description": "The largest quoted market value of the index constituents.", + "description": "Four-year", "default": null, "optional": true }, { - "name": "constituent_largest_weight", + "name": "five_year", "type": "float", - "description": "The largest weight of the index constituents, as a normalized percent.", + "description": "Five-year return.", "default": null, "optional": true }, { - "name": "constituent_smallest_market_value", + "name": "ten_year", "type": "float", - "description": "The smallest quoted market value of the index constituents.", + "description": "Ten-year return.", "default": null, "optional": true }, { - "name": "constituent_smallest_weight", + "name": "max", "type": "float", - "description": "The smallest weight of the index constituents, as a normalized percent.", + "description": "Return from the beginning of the time series.", "default": null, "optional": true } + ], + "fmp": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": "", + "optional": false + } ] }, - "model": "IndexSnapshots" + "model": "EtfHoldingsPerformance" }, - "/index/available": { + "/etf/equity_exposure": { "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", + "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": "provider", - "type": "Literal['cboe', 'fmp', 'tmx', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.", - "default": "cboe", - "optional": true - } - ], - "cboe": [ - { - "name": "use_cache", - "type": "bool", - "description": "When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass.", - "default": true, - "optional": true - } - ], - "fmp": [], - "tmx": [ + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp.", + "default": "", + "optional": false + }, { - "name": "use_cache", - "type": "bool", - "description": "Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False.", - "default": 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 } ], - "yfinance": [] + "fmp": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[AvailableIndices]", + "type": "List[EtfEquityExposure]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['cboe', 'fmp', 'tmx', 'yfinance']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -34980,166 +24402,82 @@ "data": { "standard": [ { - "name": "name", - "type": "str", - "description": "Name of the index.", - "default": null, - "optional": true - }, - { - "name": "currency", - "type": "str", - "description": "Currency the index is traded in.", - "default": null, - "optional": true - } - ], - "cboe": [ - { - "name": "symbol", + "name": "equity_symbol", "type": "str", - "description": "Symbol for the index.", + "description": "The symbol of the equity requested.", "default": "", "optional": false }, { - "name": "description", - "type": "str", - "description": "Description for the index. Valid only for US indices.", - "default": null, - "optional": true - }, - { - "name": "data_delay", - "type": "int", - "description": "Data delay for the index. Valid only for US indices.", - "default": null, - "optional": true - }, - { - "name": "open_time", - "type": "datetime.time", - "description": "Opening time for the index. Valid only for US indices.", - "default": null, - "optional": true - }, - { - "name": "close_time", - "type": "datetime.time", - "description": "Closing time for the index. Valid only for US indices.", - "default": null, - "optional": true - }, - { - "name": "time_zone", + "name": "etf_symbol", "type": "str", - "description": "Time zone for the index. Valid only for US indices.", - "default": null, - "optional": true + "description": "The symbol of the ETF with exposure to the requested equity.", + "default": "", + "optional": false }, { - "name": "tick_days", - "type": "str", - "description": "The trading days for the index. Valid only for US indices.", + "name": "shares", + "type": "float", + "description": "The number of shares held in the ETF.", "default": null, "optional": true }, { - "name": "tick_frequency", - "type": "str", - "description": "The frequency of the index ticks. Valid only for US indices.", + "name": "weight", + "type": "float", + "description": "The weight of the equity in the ETF, as a normalized percent.", "default": null, "optional": true }, { - "name": "tick_period", - "type": "str", - "description": "The period of the index ticks. Valid only for US indices.", + "name": "market_value", + "type": "Union[int, float]", + "description": "The market value of the equity position in the ETF.", "default": null, "optional": true } ], - "fmp": [ - { - "name": "stock_exchange", - "type": "str", - "description": "Stock exchange where the index is listed.", - "default": "", - "optional": false - }, - { - "name": "exchange_short_name", - "type": "str", - "description": "Short name of the stock exchange where the index is listed.", - "default": "", - "optional": false - } - ], - "tmx": [ - { - "name": "symbol", - "type": "str", - "description": "The ticker symbol of the index.", - "default": "", - "optional": false - } - ], - "yfinance": [ - { - "name": "code", - "type": "str", - "description": "ID code for keying the index in the OpenBB Terminal.", - "default": "", - "optional": false - }, - { - "name": "symbol", - "type": "str", - "description": "Symbol for the index.", - "default": "", - "optional": false - } - ] + "fmp": [] }, - "model": "AvailableIndices" + "model": "EtfEquityExposure" }, - "/index/search": { + "/fixedincome/rate/ameribor": { "deprecated": { "flag": null, "message": null }, - "description": "Filter indices for rows containing the query.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.search(provider='cboe')\nobb.index.search(query='SPX', provider='cboe')\n```\n\n", + "description": "Ameribor.\n\nAmeribor (short for the American interbank offered rate) is a benchmark interest rate that reflects the true cost of\nshort-term interbank borrowing. This rate is based on transactions in overnight unsecured loans conducted on the\nAmerican Financial Exchange (AFX).", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.ameribor(provider='fred')\nobb.fixedincome.rate.ameribor(parameter=30_day_ma, provider='fred')\n```\n\n", "parameters": { "standard": [ { - "name": "query", - "type": "str", - "description": "Search query.", - "default": "", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, "optional": true }, { - "name": "is_symbol", - "type": "bool", - "description": "Whether to search by ticker symbol.", - "default": false, + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, "optional": true }, { "name": "provider", - "type": "Literal['cboe']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.", - "default": "cboe", + "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 } ], - "cboe": [ + "fred": [ { - "name": "use_cache", - "type": "bool", - "description": "When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass.", - "default": 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 } ] @@ -35148,12 +24486,12 @@ "OBBject": [ { "name": "results", - "type": "List[IndexSearch]", + "type": "List[AMERIBOR]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['cboe']]", + "type": "Optional[Literal['fred']]", "description": "Provider name." }, { @@ -35176,104 +24514,33 @@ "data": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "name", - "type": "str", - "description": "Name of the index.", + "name": "rate", + "type": "float", + "description": "AMERIBOR rate.", "default": "", "optional": false } ], - "cboe": [ - { - "name": "description", - "type": "str", - "description": "Description for the index.", - "default": null, - "optional": true - }, - { - "name": "data_delay", - "type": "int", - "description": "Data delay for the index. Valid only for US indices.", - "default": null, - "optional": true - }, - { - "name": "currency", - "type": "str", - "description": "Currency for the index.", - "default": null, - "optional": true - }, - { - "name": "time_zone", - "type": "str", - "description": "Time zone for the index. Valid only for US indices.", - "default": null, - "optional": true - }, - { - "name": "open_time", - "type": "datetime.time", - "description": "Opening time for the index. Valid only for US indices.", - "default": null, - "optional": true - }, - { - "name": "close_time", - "type": "datetime.time", - "description": "Closing time for the index. Valid only for US indices.", - "default": null, - "optional": true - }, - { - "name": "tick_days", - "type": "str", - "description": "The trading days for the index. Valid only for US indices.", - "default": null, - "optional": true - }, - { - "name": "tick_frequency", - "type": "str", - "description": "Tick frequency for the index. Valid only for US indices.", - "default": null, - "optional": true - }, - { - "name": "tick_period", - "type": "str", - "description": "Tick period for the index. Valid only for US indices.", - "default": null, - "optional": true - } - ] + "fred": [] }, - "model": "IndexSearch" + "model": "AMERIBOR" }, - "/index/sp500_multiples": { + "/fixedincome/rate/sonia": { "deprecated": { "flag": null, "message": null }, - "description": "Get historical S&P 500 multiples and Shiller PE ratios.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.sp500_multiples(provider='nasdaq')\nobb.index.sp500_multiples(series_name='shiller_pe_year', provider='nasdaq')\n```\n\n", + "description": "Sterling Overnight Index Average.\n\nSONIA (Sterling Overnight Index Average) is an important interest rate benchmark. SONIA is based on actual\ntransactions and reflects the average of the interest rates that banks pay to borrow sterling overnight from other\nfinancial institutions and other institutional investors.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.sonia(provider='fred')\nobb.fixedincome.rate.sonia(parameter=total_nominal_value, provider='fred')\n```\n\n", "parameters": { "standard": [ - { - "name": "series_name", - "type": "Literal['shiller_pe_month', 'shiller_pe_year', 'pe_year', 'pe_month', 'dividend_year', 'dividend_month', 'dividend_growth_quarter', 'dividend_growth_year', 'dividend_yield_year', 'dividend_yield_month', 'earnings_year', 'earnings_month', 'earnings_growth_year', 'earnings_growth_quarter', 'real_earnings_growth_year', 'real_earnings_growth_quarter', 'earnings_yield_year', 'earnings_yield_month', 'real_price_year', 'real_price_month', 'inflation_adjusted_price_year', 'inflation_adjusted_price_month', 'sales_year', 'sales_quarter', 'sales_growth_year', 'sales_growth_quarter', 'real_sales_year', 'real_sales_quarter', 'real_sales_growth_year', 'real_sales_growth_quarter', 'price_to_sales_year', 'price_to_sales_quarter', 'price_to_book_value_year', 'price_to_book_value_quarter', 'book_value_year', 'book_value_quarter']", - "description": "The name of the series. Defaults to 'pe_month'.", - "default": "pe_month", - "optional": true - }, { "name": "start_date", "type": "Union[date, str]", @@ -35290,39 +24557,18 @@ }, { "name": "provider", - "type": "Literal['nasdaq']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default.", - "default": "nasdaq", + "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 } ], - "nasdaq": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "transform", - "type": "Literal['diff', 'rdiff', 'cumul', 'normalize']", - "description": "Transform the data as difference, percent change, cumulative, or normalize.", - "default": null, - "optional": true - }, + "fred": [ { - "name": "collapse", - "type": "Literal['daily', 'weekly', 'monthly', 'quarterly', 'annual']", - "description": "Collapse the frequency of the time series.", - "default": null, + "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 } ] @@ -35331,12 +24577,12 @@ "OBBject": [ { "name": "results", - "type": "List[SP500Multiples]", + "type": "List[SONIA]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['nasdaq']]", + "type": "Optional[Literal['fred']]", "description": "Provider name." }, { @@ -35364,56 +24610,62 @@ "description": "The date of the data.", "default": "", "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "SONIA rate.", + "default": "", + "optional": false } ], - "nasdaq": [] + "fred": [] }, - "model": "SP500Multiples" + "model": "SONIA" }, - "/index/sectors": { + "/fixedincome/rate/iorb": { "deprecated": { "flag": null, "message": null }, - "description": "Get Index Sectors. Sector weighting of an index.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.sectors(symbol='^TX60', provider='tmx')\n```\n\n", + "description": "Interest on Reserve Balances.\n\nGet Interest Rate on Reserve Balances data A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.iorb(provider='fred')\n```\n\n", "parameters": { "standard": [ { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Literal['tmx']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default.", - "default": "tmx", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, "optional": true - } - ], - "tmx": [ + }, { - "name": "use_cache", - "type": "bool", - "description": "Whether to use a cached request. All Index data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 1 day.", - "default": true, + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", "optional": true } - ] + ], + "fred": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[IndexSectors]", + "type": "List[IORB]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['tmx']]", + "type": "Optional[Literal['fred']]", "description": "Provider name." }, { @@ -35436,40 +24688,33 @@ "data": { "standard": [ { - "name": "sector", - "type": "str", - "description": "The sector name.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "weight", + "name": "rate", "type": "float", - "description": "The weight of the sector in the index.", + "description": "IORB rate.", "default": "", "optional": false } ], - "tmx": [] + "fred": [] }, - "model": "IndexSectors" + "model": "IORB" }, - "/news/world": { + "/fixedincome/rate/effr": { "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# Filter aticles by term using 'biztoc' as provider.\nobb.news.world(provider='biztoc', term=apple)\n```\n\n", + "description": "Fed Funds Rate.\n\nGet Effective Federal Funds Rate data. A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.effr(provider='fred')\nobb.fixedincome.rate.effr(parameter=daily, provider='fred')\n```\n\n", "parameters": { "standard": [ - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return. The number of articles to return.", - "default": 2500, - "optional": true - }, { "name": "start_date", "type": "Union[date, str]", @@ -35486,207 +24731,230 @@ }, { "name": "provider", - "type": "Literal['benzinga', 'biztoc', '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", + "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 } ], - "benzinga": [ - { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", - "default": null, - "optional": true - }, - { - "name": "display", - "type": "Literal['headline', 'abstract', 'full']", - "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full).", - "default": "full", - "optional": true - }, - { - "name": "updated_since", - "type": "int", - "description": "Number of seconds since the news was updated.", - "default": null, - "optional": true - }, + "federal_reserve": [], + "fred": [ { - "name": "published_since", - "type": "int", - "description": "Number of seconds since the news was published.", - "default": null, + "name": "parameter", + "type": "Literal['monthly', 'daily', 'weekly', 'daily_excl_weekend', 'annual', 'biweekly', 'volume']", + "description": "Period of FED rate.", + "default": "weekly", "optional": true - }, + } + ] + }, + "returns": { + "OBBject": [ { - "name": "sort", - "type": "Literal['id', 'created', 'updated']", - "description": "Key to sort the news by.", - "default": "created", - "optional": true + "name": "results", + "type": "List[FEDFUNDS]", + "description": "Serializable results." }, { - "name": "order", - "type": "Literal['asc', 'desc']", - "description": "Order to sort the news by.", - "default": "desc", - "optional": true + "name": "provider", + "type": "Optional[Literal['federal_reserve', 'fred']]", + "description": "Provider name." }, { - "name": "isin", - "type": "str", - "description": "The ISIN of the news to retrieve.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "cusip", - "type": "str", - "description": "The CUSIP of the news to retrieve.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "channels", - "type": "str", - "description": "Channels of the news to retrieve.", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "topics", - "type": "str", - "description": "Topics of the news to retrieve.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "authors", - "type": "str", - "description": "Authors of the news to retrieve.", - "default": null, - "optional": true - }, + "name": "rate", + "type": "float", + "description": "FED rate.", + "default": "", + "optional": false + } + ], + "federal_reserve": [], + "fred": [] + }, + "model": "FEDFUNDS" + }, + "/fixedincome/rate/effr_forecast": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fed Funds Rate Projections.\n\nThe projections for the federal funds rate are the value of the midpoint of the\nprojected appropriate target range for the federal funds rate or the projected\nappropriate target level for the federal funds rate at the end of the specified\ncalendar year or over the longer run.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.effr_forecast(provider='fred')\nobb.fixedincome.rate.effr_forecast(long_run=True, provider='fred')\n```\n\n", + "parameters": { + "standard": [ { - "name": "content_types", - "type": "str", - "description": "Content types of the news to retrieve.", - "default": null, + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", "optional": true } ], - "biztoc": [ + "fred": [ { - "name": "filter", - "type": "Literal['crypto', 'hot', 'latest', 'main', 'media', 'source', 'tag']", - "description": "Filter by type of news.", - "default": "latest", + "name": "long_run", + "type": "bool", + "description": "Flag to show long run projections", + "default": false, "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[PROJECTIONS]", + "description": "Serializable results." }, { - "name": "source", - "type": "str", - "description": "Filter by a specific publisher. Only valid when filter is set to source.", - "default": "bloomberg", - "optional": true + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "tag", - "type": "str", - "description": "Tag, topic, to filter articles by. Only valid when filter is set to tag.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "term", - "type": "str", - "description": "Search term to filter articles by. This overrides all other filters.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } - ], - "fmp": [], - "intrinio": [ + ] + }, + "data": { + "standard": [ { - "name": "source", - "type": "Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases']", - "description": "The source of the news article.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "sentiment", - "type": "Literal['positive', 'neutral', 'negative']", - "description": "Return news only from this source.", - "default": null, - "optional": true + "name": "range_high", + "type": "float", + "description": "High projection of rates.", + "default": "", + "optional": false }, { - "name": "language", - "type": "str", - "description": "Filter by language. Unsupported for yahoo source.", - "default": null, - "optional": true + "name": "central_tendency_high", + "type": "float", + "description": "Central tendency of high projection of rates.", + "default": "", + "optional": false }, { - "name": "topic", - "type": "str", - "description": "Filter by topic. Unsupported for yahoo source.", - "default": null, - "optional": true + "name": "median", + "type": "float", + "description": "Median projection of rates.", + "default": "", + "optional": false }, { - "name": "word_count_greater_than", - "type": "int", - "description": "News stories will have a word count greater than this value. Unsupported for yahoo source.", - "default": null, - "optional": true + "name": "range_midpoint", + "type": "float", + "description": "Midpoint projection of rates.", + "default": "", + "optional": false }, { - "name": "word_count_less_than", - "type": "int", - "description": "News stories will have a word count less than this value. Unsupported for yahoo source.", - "default": null, - "optional": true + "name": "central_tendency_midpoint", + "type": "float", + "description": "Central tendency of midpoint projection of rates.", + "default": "", + "optional": false }, { - "name": "is_spam", - "type": "bool", - "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source.", - "default": null, - "optional": true + "name": "range_low", + "type": "float", + "description": "Low projection of rates.", + "default": "", + "optional": false }, { - "name": "business_relevance_greater_than", + "name": "central_tendency_low", "type": "float", - "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source.", + "description": "Central tendency of low projection of rates.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "PROJECTIONS" + }, + "/fixedincome/rate/estr": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Euro Short-Term Rate.\n\nThe euro short-term rate (\u20acSTR) reflects the wholesale euro unsecured overnight borrowing costs of banks located in\nthe euro area. The \u20acSTR is published on each TARGET2 business day based on transactions conducted and settled on\nthe previous TARGET2 business day (the reporting date \u201cT\u201d) with a maturity date of T+1 which are deemed to have been\nexecuted at arm\u2019s length and thus reflect market rates in an unbiased way.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.estr(provider='fred')\nobb.fixedincome.rate.estr(parameter=number_of_active_banks, provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "business_relevance_less_than", - "type": "float", - "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true - } - ], - "tiingo": [ + }, { - "name": "offset", - "type": "int", - "description": "Page offset, used in conjunction with limit.", - "default": 0, + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", "optional": true - }, + } + ], + "fred": [ { - "name": "source", - "type": "str", - "description": "A comma-separated list of the domains requested.", - "default": null, + "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 } ] @@ -35695,12 +24963,12 @@ "OBBject": [ { "name": "results", - "type": "List[WorldNews]", + "type": "List[ESTR]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['benzinga', 'biztoc', 'fmp', 'intrinio', 'tiingo']]", + "type": "Optional[Literal['fred']]", "description": "Provider name." }, { @@ -35724,286 +24992,303 @@ "standard": [ { "name": "date", - "type": "datetime", - "description": "The date of the data. The published date of the article.", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "title", - "type": "str", - "description": "Title of the article.", + "name": "rate", + "type": "float", + "description": "ESTR rate.", "default": "", "optional": false - }, - { - "name": "images", - "type": "List[Dict[str, str]]", - "description": "Images associated with the article.", - "default": null, - "optional": true - }, - { - "name": "text", - "type": "str", - "description": "Text/body of the article.", - "default": null, - "optional": true - }, - { - "name": "url", - "type": "str", - "description": "URL to the article.", - "default": null, - "optional": true } ], - "benzinga": [ - { - "name": "id", - "type": "str", - "description": "Article ID.", - "default": "", - "optional": false - }, - { - "name": "author", - "type": "str", - "description": "Author of the news.", - "default": null, - "optional": true - }, - { - "name": "teaser", - "type": "str", - "description": "Teaser of the news.", - "default": null, - "optional": true - }, + "fred": [] + }, + "model": "ESTR" + }, + "/fixedincome/rate/ecb": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "European Central Bank Interest Rates.\n\nThe Governing Council of the ECB sets the key interest rates for the euro area:\n\n- The interest rate on the main refinancing operations (MRO), which provide\nthe bulk of liquidity to the banking system.\n- The rate on the deposit facility, which banks may use to make overnight deposits with the Eurosystem.\n- The rate on the marginal lending facility, which offers overnight credit to banks from the Eurosystem.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.ecb(provider='fred')\nobb.fixedincome.rate.ecb(interest_rate_type='refinancing', provider='fred')\n```\n\n", + "parameters": { + "standard": [ { - "name": "channels", - "type": "str", - "description": "Channels associated with the news.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "stocks", - "type": "str", - "description": "Stocks associated with the news.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "tags", - "type": "str", - "description": "Tags associated with the news.", - "default": null, + "name": "interest_rate_type", + "type": "Literal['deposit', 'lending', 'refinancing']", + "description": "The type of interest rate.", + "default": "lending", "optional": true }, { - "name": "updated", - "type": "datetime", - "description": "Updated date of the news.", - "default": null, + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", "optional": true } ], - "biztoc": [ + "fred": [] + }, + "returns": { + "OBBject": [ { - "name": "images", - "type": "Dict[str, str]", - "description": "Images for the article.", - "default": null, - "optional": true + "name": "results", + "type": "List[EuropeanCentralBankInterestRates]", + "description": "Serializable results." }, { - "name": "favicon", - "type": "str", - "description": "Icon image for the source of the article.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "tags", - "type": "List[str]", - "description": "Tags for the article.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "id", - "type": "str", - "description": "Unique Article ID.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "score", - "type": "float", - "description": "Search relevance score for the article.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } - ], - "fmp": [ + ] + }, + "data": { + "standard": [ { - "name": "site", - "type": "str", - "description": "News source.", + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "European Central Bank Interest Rate.", "default": "", "optional": false } ], - "intrinio": [ + "fred": [] + }, + "model": "EuropeanCentralBankInterestRates" + }, + "/fixedincome/rate/dpcredit": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Discount Window Primary Credit Rate.\n\nA bank rate is the interest rate a nation's central bank charges to its domestic banks to borrow money.\nThe rates central banks charge are set to stabilize the economy.\nIn the United States, the Federal Reserve System's Board of Governors set the bank rate,\nalso known as the discount rate.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.dpcredit(provider='fred')\nobb.fixedincome.rate.dpcredit(start_date='2023-02-01', end_date='2023-05-01', provider='fred')\n```\n\n", + "parameters": { + "standard": [ { - "name": "source", - "type": "str", - "description": "The source of the news article.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "summary", - "type": "str", - "description": "The summary of the news article.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "topics", - "type": "str", - "description": "The topics related to the news article.", - "default": null, + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", "optional": true - }, + } + ], + "fred": [ { - "name": "word_count", - "type": "int", - "description": "The word count of the news article.", - "default": null, + "name": "parameter", + "type": "Literal['daily_excl_weekend', 'monthly', 'weekly', 'daily', 'annual']", + "description": "FRED series ID of DWPCR data.", + "default": "daily_excl_weekend", "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[DiscountWindowPrimaryCreditRate]", + "description": "Serializable results." }, { - "name": "business_relevance", - "type": "float", - "description": "How strongly correlated the news article is to the business", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "sentiment", - "type": "str", - "description": "The sentiment of the news article - i.e, negative, positive.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "sentiment_confidence", - "type": "float", - "description": "The confidence score of the sentiment rating.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "language", - "type": "str", - "description": "The language of the news article.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "spam", - "type": "bool", - "description": "Whether the news article is spam.", + "name": "rate", + "type": "float", + "description": "Discount Window Primary Credit Rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "DiscountWindowPrimaryCreditRate" + }, + "/fixedincome/spreads/tcm": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Treasury Constant Maturity.\n\nGet data for 10-Year Treasury Constant Maturity Minus Selected Treasury Constant Maturity.\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S.\nTreasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.tcm(provider='fred')\nobb.fixedincome.spreads.tcm(maturity='2y', provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "copyright", - "type": "str", - "description": "The copyright notice of the news article.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "id", - "type": "str", - "description": "Article ID.", - "default": "", - "optional": false - }, - { - "name": "company", - "type": "IntrinioCompany", - "description": "The Intrinio Company object. Contains details company reference data.", - "default": null, + "name": "maturity", + "type": "Literal['3m', '2y']", + "description": "The maturity", + "default": "3m", "optional": true }, { - "name": "security", - "type": "IntrinioSecurity", - "description": "The Intrinio Security object. Contains the security details related to the news article.", - "default": null, + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", "optional": true } ], - "tiingo": [ + "fred": [] + }, + "returns": { + "OBBject": [ { - "name": "symbols", - "type": "str", - "description": "Ticker tagged in the fetched news.", - "default": null, - "optional": true + "name": "results", + "type": "List[TreasuryConstantMaturity]", + "description": "Serializable results." }, { - "name": "article_id", - "type": "int", - "description": "Unique ID of the news article.", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "site", - "type": "str", - "description": "News source.", - "default": "", - "optional": false + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "tags", - "type": "str", - "description": "Tags associated with the news article.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "crawl_date", - "type": "datetime", - "description": "Date the news article was crawled.", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "rate", + "type": "float", + "description": "TreasuryConstantMaturity Rate.", "default": "", "optional": false } - ] + ], + "fred": [] }, - "model": "WorldNews" + "model": "TreasuryConstantMaturity" }, - "/news/company": { + "/fixedincome/spreads/tcm_effr": { "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", + "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": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance.", - "default": null, - "optional": true - }, { "name": "start_date", "type": "Union[date, str]", @@ -36019,226 +25304,205 @@ "optional": true }, { - "name": "limit", - "type": "Annotated[int, Ge(ge=0)]", - "description": "The number of data entries to return.", - "default": 2500, + "name": "maturity", + "type": "Literal['10y', '5y', '1y', '6m', '3m']", + "description": "The maturity", + "default": "10y", "optional": true }, { "name": "provider", - "type": "Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', '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", + "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 } ], - "benzinga": [ - { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", - "default": null, - "optional": true - }, + "fred": [] + }, + "returns": { + "OBBject": [ { - "name": "display", - "type": "Literal['headline', 'abstract', 'full']", - "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full).", - "default": "full", - "optional": true + "name": "results", + "type": "List[SelectedTreasuryConstantMaturity]", + "description": "Serializable results." }, { - "name": "updated_since", - "type": "int", - "description": "Number of seconds since the news was updated.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "published_since", - "type": "int", - "description": "Number of seconds since the news was published.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "sort", - "type": "Literal['id', 'created', 'updated']", - "description": "Key to sort the news by.", - "default": "created", - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "order", - "type": "Literal['asc', 'desc']", - "description": "Order to sort the news by.", - "default": "desc", - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "isin", - "type": "str", - "description": "The company's ISIN.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "cusip", - "type": "str", - "description": "The company's CUSIP.", - "default": null, - "optional": true - }, + "name": "rate", + "type": "float", + "description": "Selected Treasury Constant Maturity Rate.", + "default": "", + "optional": false + } + ], + "fred": [] + }, + "model": "SelectedTreasuryConstantMaturity" + }, + "/fixedincome/spreads/treasury_effr": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Select Treasury Bill.\n\nGet Selected Treasury Bill Minus Federal Funds Rate.\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of\nauctioned U.S. Treasuries.\nThe value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.treasury_effr(provider='fred')\nobb.fixedincome.spreads.treasury_effr(maturity='6m', provider='fred')\n```\n\n", + "parameters": { + "standard": [ { - "name": "channels", - "type": "str", - "description": "Channels of the news to retrieve.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "topics", - "type": "str", - "description": "Topics of the news to retrieve.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "authors", - "type": "str", - "description": "Authors of the news to retrieve.", - "default": null, + "name": "maturity", + "type": "Literal['3m', '6m']", + "description": "The maturity", + "default": "3m", "optional": true }, { - "name": "content_types", - "type": "str", - "description": "Content types of the news to retrieve.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "page", - "type": "int", - "description": "Page number of the results. Use in combination with limit.", - "default": 0, + "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 } ], - "intrinio": [ - { - "name": "source", - "type": "Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases']", - "description": "The source of the news article.", - "default": null, - "optional": true - }, - { - "name": "sentiment", - "type": "Literal['positive', 'neutral', 'negative']", - "description": "Return news only from this source.", - "default": null, - "optional": true - }, + "fred": [] + }, + "returns": { + "OBBject": [ { - "name": "language", - "type": "str", - "description": "Filter by language. Unsupported for yahoo source.", - "default": null, - "optional": true + "name": "results", + "type": "List[SelectedTreasuryBill]", + "description": "Serializable results." }, { - "name": "topic", - "type": "str", - "description": "Filter by topic. Unsupported for yahoo source.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "word_count_greater_than", - "type": "int", - "description": "News stories will have a word count greater than this value. Unsupported for yahoo source.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "word_count_less_than", - "type": "int", - "description": "News stories will have a word count less than this value. Unsupported for yahoo source.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "is_spam", - "type": "bool", - "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source.", - "default": null, - "optional": true - }, + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ { - "name": "business_relevance_greater_than", - "type": "float", - "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source.", - "default": null, - "optional": true + "name": "date", + "type": "date", + "description": "The date of the data.", + "default": "", + "optional": false }, { - "name": "business_relevance_less_than", + "name": "rate", "type": "float", - "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source.", - "default": null, - "optional": true - } - ], - "polygon": [ - { - "name": "order", - "type": "Literal['asc', 'desc']", - "description": "Sort order of the articles.", - "default": "desc", - "optional": true + "description": "SelectedTreasuryBill Rate.", + "default": "", + "optional": false } ], - "tiingo": [ + "fred": [] + }, + "model": "SelectedTreasuryBill" + }, + "/fixedincome/government/us_yield_curve": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "US Yield Curve. Get United States yield curve.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.us_yield_curve(provider='fred')\nobb.fixedincome.government.us_yield_curve(inflation_adjusted=True, provider='fred')\n```\n\n", + "parameters": { + "standard": [ { - "name": "offset", - "type": "int", - "description": "Page offset, used in conjunction with limit.", - "default": 0, + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for. Defaults to the most recent FRED entry.", + "default": null, "optional": true }, { - "name": "source", - "type": "str", - "description": "A comma-separated list of the domains requested.", - "default": null, + "name": "inflation_adjusted", + "type": "bool", + "description": "Get inflation adjusted rates.", + "default": false, "optional": true - } - ], - "tmx": [ + }, { - "name": "page", - "type": "int", - "description": "The page number to start from. Use with limit.", - "default": 1, + "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 } ], - "yfinance": [] + "fred": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[CompanyNews]", + "type": "List[USYieldCurve]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'yfinance']]", + "type": "Optional[Literal['fred']]", "description": "Provider name." }, { @@ -36261,376 +25525,259 @@ "data": { "standard": [ { - "name": "date", - "type": "datetime", - "description": "The date of the data. Here it is the published date of the article.", + "name": "maturity", + "type": "float", + "description": "Maturity of the treasury rate in years.", "default": "", "optional": false }, { - "name": "title", - "type": "str", - "description": "Title of the article.", + "name": "rate", + "type": "float", + "description": "Associated rate given in decimal form (0.05 is 5%)", "default": "", "optional": false - }, + } + ], + "fred": [] + }, + "model": "USYieldCurve" + }, + "/fixedincome/government/treasury_rates": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Government Treasury Rates.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.treasury_rates(provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "text", - "type": "str", - "description": "Text/body of the article.", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "images", - "type": "List[Dict[str, str]]", - "description": "Images associated with the article.", + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", "default": null, "optional": true }, { - "name": "url", - "type": "str", - "description": "URL to the article.", - "default": "", - "optional": false - }, - { - "name": "symbols", - "type": "str", - "description": "Symbols associated with the article.", - "default": null, + "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 } ], - "benzinga": [ - { - "name": "images", - "type": "List[Dict[str, str]]", - "description": "URL to the images of the news.", - "default": null, - "optional": true - }, - { - "name": "id", - "type": "str", - "description": "Article ID.", - "default": "", - "optional": false - }, - { - "name": "author", - "type": "str", - "description": "Author of the article.", - "default": null, - "optional": true - }, + "federal_reserve": [], + "fmp": [] + }, + "returns": { + "OBBject": [ { - "name": "teaser", - "type": "str", - "description": "Teaser of the news.", - "default": null, - "optional": true + "name": "results", + "type": "List[TreasuryRates]", + "description": "Serializable results." }, { - "name": "channels", - "type": "str", - "description": "Channels associated with the news.", - "default": null, - "optional": true + "name": "provider", + "type": "Optional[Literal['federal_reserve', 'fmp']]", + "description": "Provider name." }, { - "name": "stocks", - "type": "str", - "description": "Stocks associated with the news.", - "default": null, - "optional": true + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "tags", - "type": "str", - "description": "Tags associated with the news.", - "default": null, - "optional": true + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "updated", - "type": "datetime", - "description": "Updated date of the news.", - "default": null, - "optional": true + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } - ], - "fmp": [ + ] + }, + "data": { + "standard": [ { - "name": "source", - "type": "str", - "description": "Name of the news source.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false - } - ], - "intrinio": [ - { - "name": "source", - "type": "str", - "description": "The source of the news article.", - "default": null, - "optional": true - }, - { - "name": "summary", - "type": "str", - "description": "The summary of the news article.", - "default": null, - "optional": true - }, - { - "name": "topics", - "type": "str", - "description": "The topics related to the news article.", - "default": null, - "optional": true - }, - { - "name": "word_count", - "type": "int", - "description": "The word count of the news article.", - "default": null, - "optional": true }, { - "name": "business_relevance", + "name": "week_4", "type": "float", - "description": "How strongly correlated the news article is to the business", - "default": null, - "optional": true - }, - { - "name": "sentiment", - "type": "str", - "description": "The sentiment of the news article - i.e, negative, positive.", + "description": "4 week Treasury bills rate (secondary market).", "default": null, "optional": true }, { - "name": "sentiment_confidence", + "name": "month_1", "type": "float", - "description": "The confidence score of the sentiment rating.", + "description": "1 month Treasury rate.", "default": null, "optional": true }, { - "name": "language", - "type": "str", - "description": "The language of the news article.", + "name": "month_2", + "type": "float", + "description": "2 month Treasury rate.", "default": null, "optional": true }, { - "name": "spam", - "type": "bool", - "description": "Whether the news article is spam.", + "name": "month_3", + "type": "float", + "description": "3 month Treasury rate.", "default": null, "optional": true }, { - "name": "copyright", - "type": "str", - "description": "The copyright notice of the news article.", + "name": "month_6", + "type": "float", + "description": "6 month Treasury rate.", "default": null, "optional": true }, { - "name": "id", - "type": "str", - "description": "Article ID.", - "default": "", - "optional": false - }, - { - "name": "security", - "type": "IntrinioSecurity", - "description": "The Intrinio Security object. Contains the security details related to the news article.", - "default": null, - "optional": true - } - ], - "polygon": [ - { - "name": "source", - "type": "str", - "description": "Source of the article.", + "name": "year_1", + "type": "float", + "description": "1 year Treasury rate.", "default": null, "optional": true }, { - "name": "tags", - "type": "str", - "description": "Keywords/tags in the article", + "name": "year_2", + "type": "float", + "description": "2 year Treasury rate.", "default": null, "optional": true }, { - "name": "id", - "type": "str", - "description": "Article ID.", - "default": "", - "optional": false + "name": "year_3", + "type": "float", + "description": "3 year Treasury rate.", + "default": null, + "optional": true }, { - "name": "amp_url", - "type": "str", - "description": "AMP URL.", + "name": "year_5", + "type": "float", + "description": "5 year Treasury rate.", "default": null, "optional": true }, { - "name": "publisher", - "type": "PolygonPublisher", - "description": "Publisher of the article.", - "default": "", - "optional": false - } - ], - "tiingo": [ - { - "name": "tags", - "type": "str", - "description": "Tags associated with the news article.", + "name": "year_7", + "type": "float", + "description": "7 year Treasury rate.", "default": null, "optional": true }, { - "name": "article_id", - "type": "int", - "description": "Unique ID of the news article.", - "default": "", - "optional": false + "name": "year_10", + "type": "float", + "description": "10 year Treasury rate.", + "default": null, + "optional": true }, { - "name": "source", - "type": "str", - "description": "News source.", - "default": "", - "optional": false + "name": "year_20", + "type": "float", + "description": "20 year Treasury rate.", + "default": null, + "optional": true }, { - "name": "crawl_date", - "type": "datetime", - "description": "Date the news article was crawled.", - "default": "", - "optional": false - } - ], - "tmx": [ - { - "name": "source", - "type": "str", - "description": "Source of the news.", + "name": "year_30", + "type": "float", + "description": "30 year Treasury rate.", "default": null, "optional": true } ], - "yfinance": [ - { - "name": "source", - "type": "str", - "description": "Source of the news article", - "default": "", - "optional": false - } - ] + "federal_reserve": [], + "fmp": [] }, - "model": "CompanyNews" + "model": "TreasuryRates" }, - "/quantitative/rolling/skew": { + "/fixedincome/corporate/ice_bofa": { "deprecated": { "flag": null, "message": null }, - "description": "Get Rolling Skew.\n\n Skew is a statistical measure that reveals the degree of asymmetry of a distribution around its mean.\n Positive skewness indicates a distribution with an extended tail to the right, while negative skewness shows a tail\n that stretches left. Understanding skewness can provide insights into potential biases in data and help anticipate\n the nature of future data points. It's particularly useful for identifying the likelihood of extreme outcomes in\n financial returns, enabling more informed decision-making based on the distribution's shape over a specified period.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Rolling Mean.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.rolling.skew(data=returns, target=\"close\")\nobb.quantitative.rolling.skew(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", + "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": "data", - "type": "List[Data]", - "description": "Time series data.", - "default": "", - "optional": false + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true }, { - "name": "target", - "type": "str", - "description": "Target column name.", - "default": "", - "optional": false + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true }, { - "name": "window", - "type": "PositiveInt", - "description": "Window size.", - "default": "", - "optional": false + "name": "index_type", + "type": "Literal['yield', 'yield_to_worst', 'total_return', 'spread']", + "description": "The type of series.", + "default": "yield", + "optional": true }, { - "name": "index", - "type": "str, optional", - "description": "Index column name, by default \"date\"", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[Data]", - "description": "Rolling skew." + "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 } - ] - }, - "data": {}, - "model": "" - }, - "/quantitative/rolling/variance": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the rolling variance of a target column within a given window size.\n\n Variance measures the dispersion of a set of data points around their mean. It is a key metric for\n assessing the volatility and stability of financial returns or other time series data over a specified rolling window.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Rolling Variance.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.rolling.variance(data=returns, target=\"close\", window=252)\nobb.quantitative.rolling.variance(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", - "parameters": { - "standard": [ + ], + "fred": [ { - "name": "data", - "type": "List[Data]", - "description": "The time series data as a list of data points.", - "default": "", - "optional": false + "name": "category", + "type": "Literal['all', 'duration', 'eur', 'usd']", + "description": "The type of category.", + "default": "all", + "optional": true }, { - "name": "target", - "type": "str", - "description": "The name of the column for which to calculate variance.", - "default": "", - "optional": false + "name": "area", + "type": "Literal['asia', 'emea', 'eu', 'ex_g10', 'latin_america', 'us']", + "description": "The type of area.", + "default": "us", + "optional": true }, { - "name": "window", - "type": "PositiveInt", - "description": "The number of observations used for calculating the rolling measure.", - "default": "", - "optional": 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 }, { - "name": "index", - "type": "str, optional", - "description": "The name of the index column, default is \"date\".", - "default": "", - "optional": false + "name": "options", + "type": "bool", + "description": "Whether to include options in the results.", + "default": false, + "optional": true } ] }, @@ -36638,210 +25785,97 @@ "OBBject": [ { "name": "results", - "type": "List[Data]", - "description": "An object containing the rolling variance values." - } - ] - }, - "data": {}, - "model": "" - }, - "/quantitative/rolling/stdev": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the rolling standard deviation of a target column within a given window size.\n\n Standard deviation is a measure of the amount of variation or dispersion of a set of values.\n It is widely used to assess the risk and volatility of financial returns or other time series data\n over a specified rolling window. It is the square root of the variance.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Rolling Standard Deviation.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.rolling.stdev(data=returns, target=\"close\", window=252)\nobb.quantitative.rolling.stdev(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", - "parameters": { - "standard": [ - { - "name": "data", - "type": "List[Data]", - "description": "The time series data as a list of data points.", - "default": "", - "optional": false - }, - { - "name": "target", - "type": "str", - "description": "The name of the column for which to calculate standard deviation.", - "default": "", - "optional": false - }, - { - "name": "window", - "type": "PositiveInt", - "description": "The number of observations used for calculating the rolling measure.", - "default": "", - "optional": false + "type": "List[ICEBofA]", + "description": "Serializable results." }, { - "name": "index", - "type": "str, optional", - "description": "The name of the index column, default is \"date\".", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[Data]", - "description": "An object containing the rolling standard deviation values." - } - ] - }, - "data": {}, - "model": "" - }, - "/quantitative/rolling/kurtosis": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the rolling kurtosis of a target column within a given window size.\n\n Kurtosis measures the \"tailedness\" of the probability distribution of a real-valued random variable.\n High kurtosis indicates a distribution with heavy tails (outliers), suggesting a higher risk of extreme outcomes.\n Low kurtosis indicates a distribution with lighter tails (less outliers), suggesting less risk of extreme outcomes.\n This function helps in assessing the risk of outliers in financial returns or other time series data over a specified\n rolling window.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Rolling Kurtosis.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.rolling.kurtosis(data=returns, target=\"close\", window=252)\nobb.quantitative.rolling.kurtosis(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", - "parameters": { - "standard": [ - { - "name": "data", - "type": "List[Data]", - "description": "The time series data as a list of data points.", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "target", - "type": "str", - "description": "The name of the column for which to calculate kurtosis.", - "default": "", - "optional": false + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "window", - "type": "PositiveInt", - "description": "The number of observations used for calculating the rolling measure.", - "default": "", - "optional": false + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "index", - "type": "str, optional", - "description": "The name of the index column, default is \"date\".", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[Data]", - "description": "An object containing the rolling kurtosis values." + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } ] }, - "data": {}, - "model": "" - }, - "/quantitative/rolling/quantile": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the rolling quantile of a target column within a given window size at a specified quantile percentage.\n\n Quantiles are points dividing the range of a probability distribution into intervals with equal probabilities,\n or dividing the sample in the same way. This function is useful for understanding the distribution of data\n within a specified window, allowing for analysis of trends, identification of outliers, and assessment of risk.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Rolling Quantile.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.rolling.quantile(data=returns, target=\"close\", window=252, quantile_pct=0.25)\nobb.quantitative.rolling.quantile(data=returns, target=\"close\", window=252, quantile_pct=0.75)\nobb.quantitative.rolling.quantile(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", - "parameters": { - "standard": [ - { - "name": "data", - "type": "List[Data]", - "description": "The time series data as a list of data points.", - "default": "", - "optional": false - }, - { - "name": "target", - "type": "str", - "description": "The name of the column for which to calculate the quantile.", - "default": "", - "optional": false - }, - { - "name": "window", - "type": "PositiveInt", - "description": "The number of observations used for calculating the rolling measure.", - "default": "", - "optional": false - }, + "data": { + "standard": [ { - "name": "quantile_pct", - "type": "NonNegativeFloat, optional", - "description": "The quantile percentage to calculate (e.g., 0.5 for median), default is 0.5.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "index", - "type": "str, optional", - "description": "The name of the index column, default is \"date\".", + "name": "rate", + "type": "float", + "description": "ICE BofA US Corporate Bond Indices Rate.", "default": "", "optional": false } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[Data]", - "description": "An object containing the rolling quantile values with the median." - } - ] + ], + "fred": [] }, - "data": {}, - "model": "" + "model": "ICEBofA" }, - "/quantitative/rolling/mean": { + "/fixedincome/corporate/moody": { "deprecated": { "flag": null, "message": null }, - "description": "Calculate the rolling average of a target column within a given window size.\n\n The rolling mean is a simple moving average that calculates the average of a target variable over a specified window.\n This function is widely used in financial analysis to smooth short-term fluctuations and highlight longer-term trends\n or cycles in time series data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Rolling Mean.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.rolling.mean(data=returns, target=\"close\", window=252)\nobb.quantitative.rolling.mean(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", + "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": "data", - "type": "List[Data]", - "description": "The time series data as a list of data points.", - "default": "", - "optional": false + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true }, { - "name": "target", - "type": "str", - "description": "The name of the column for which to calculate the mean.", - "default": "", - "optional": false + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true }, { - "name": "window", - "type": "PositiveInt", - "description": "The number of observations used for calculating the rolling measure.", - "default": "", - "optional": false + "name": "index_type", + "type": "Literal['aaa', 'baa']", + "description": "The type of series.", + "default": "aaa", + "optional": true }, { - "name": "index", - "type": "str, optional", - "description": "The name of the index column, default is \"date\".", - "default": "", - "optional": false + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", + "optional": true + } + ], + "fred": [ + { + "name": "spread", + "type": "Literal['treasury', 'fed_funds']", + "description": "The type of spread.", + "default": null, + "optional": true } ] }, @@ -36849,483 +25883,396 @@ "OBBject": [ { "name": "results", - "type": "List[Data]", - "description": "An object containing the rolling mean values." - } - ] - }, - "data": {}, - "model": "" - }, - "/quantitative/stats/skew": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get the skew of the data set.\n\n Skew is a statistical measure that reveals the degree of asymmetry of a distribution around its mean.\n Positive skewness indicates a distribution with an extended tail to the right, while negative skewness shows a tail\n that stretches left. Understanding skewness can provide insights into potential biases in data and help anticipate\n the nature of future data points. It's particularly useful for identifying the likelihood of extreme outcomes in\n financial returns, enabling more informed decision-making based on the distribution's shape over a specified period.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Skewness.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.stats.skew(data=returns, target=\"close\")\nobb.quantitative.stats.skew(target='close', data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", - "parameters": { - "standard": [ + "type": "List[MoodyCorporateBondIndex]", + "description": "Serializable results." + }, { - "name": "data", - "type": "List[Data]", - "description": "Time series data.", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "target", - "type": "str", - "description": "Target column name.", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, { - "name": "results", - "type": "List[Data]", - "description": "Rolling skew." + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } ] }, - "data": {}, - "model": "" - }, - "/quantitative/stats/variance": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the variance of a target column.\n\n Variance measures the dispersion of a set of data points around their mean. It is a key metric for\n assessing the volatility and stability of financial returns or other time series data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Variance.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.stats.variance(data=returns, target=\"close\")\nobb.quantitative.stats.variance(target='close', data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", - "parameters": { + "data": { "standard": [ { - "name": "data", - "type": "List[Data]", - "description": "The time series data as a list of data points.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "target", - "type": "str", - "description": "The name of the column for which to calculate variance.", + "name": "rate", + "type": "float", + "description": "Moody Corporate Bond Index Rate.", "default": "", "optional": false } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[Data]", - "description": "An object containing the rolling variance values." - } - ] + ], + "fred": [] }, - "data": {}, - "model": "" + "model": "MoodyCorporateBondIndex" }, - "/quantitative/stats/stdev": { + "/fixedincome/corporate/hqm": { "deprecated": { "flag": null, "message": null }, - "description": "Calculate the rolling standard deviation of a target column.\n\n Standard deviation is a measure of the amount of variation or dispersion of a set of values.\n It is widely used to assess the risk and volatility of financial returns or other time series data\n It is the square root of the variance.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Standard Deviation.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.stats.stdev(data=returns, target=\"close\")\nobb.quantitative.stats.stdev(target='close', data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", + "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": "data", - "type": "List[Data]", - "description": "The time series data as a list of data points.", - "default": "", - "optional": false + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": null, + "optional": true }, { - "name": "target", - "type": "str", - "description": "The name of the column for which to calculate standard deviation.", - "default": "", - "optional": false + "name": "yield_curve", + "type": "Literal['spot', 'par']", + "description": "The yield curve type.", + "default": "spot", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", + "optional": true } - ] + ], + "fred": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[Data]", - "description": "An object containing the rolling standard deviation values." - } - ] - }, - "data": {}, - "model": "" - }, - "/quantitative/stats/kurtosis": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the rolling kurtosis of a target column.\n\n Kurtosis measures the \"tailedness\" of the probability distribution of a real-valued random variable.\n High kurtosis indicates a distribution with heavy tails (outliers), suggesting a higher risk of extreme outcomes.\n Low kurtosis indicates a distribution with lighter tails (less outliers), suggesting less risk of extreme outcomes.\n This function helps in assessing the risk of outliers in financial returns or other time series data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Kurtosis.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.stats.kurtosis(data=returns, target=\"close\")\nobb.quantitative.stats.kurtosis(target='close', data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", - "parameters": { - "standard": [ + "type": "List[HighQualityMarketCorporateBond]", + "description": "Serializable results." + }, { - "name": "data", - "type": "List[Data]", - "description": "The time series data as a list of data points.", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "target", - "type": "str", - "description": "The name of the column for which to calculate kurtosis.", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, { - "name": "results", - "type": "List[Data]", - "description": "An object containing the kurtosis value" + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } ] }, - "data": {}, - "model": "" - }, - "/quantitative/stats/quantile": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the quantile of a target column at a specified quantile percentage.\n\n Quantiles are points dividing the range of a probability distribution into intervals with equal probabilities,\n or dividing the sample in the same way.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Quantile.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.stats.quantile(data=returns, target=\"close\", quantile_pct=0.75)\nobb.quantitative.stats.quantile(target='close', data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", - "parameters": { + "data": { "standard": [ { - "name": "data", - "type": "List[Data]", - "description": "The time series data as a list of data points.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "target", - "type": "str", - "description": "The name of the column for which to calculate the quantile.", + "name": "rate", + "type": "float", + "description": "HighQualityMarketCorporateBond Rate.", "default": "", "optional": false }, { - "name": "quantile_pct", - "type": "NonNegativeFloat, optional", - "description": "The quantile percentage to calculate (e.g., 0.5 for median), default is 0.5.", + "name": "maturity", + "type": "str", + "description": "Maturity.", "default": "", "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[Data]", - "description": "An object containing the rolling quantile values with the median." - } - ] - }, - "data": {}, - "model": "" - }, - "/quantitative/stats/mean": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the average of a target column.\n\n The rolling mean is a simple moving average that calculates the average of a target variable.\n This function is widely used in financial analysis to smooth short-term fluctuations and highlight longer-term trends\n or cycles in time series data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Mean.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.stats.mean(data=returns, target=\"close\")\nobb.quantitative.stats.mean(target='close', data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", - "parameters": { - "standard": [ + }, { - "name": "data", - "type": "List[Data]", - "description": "The time series data as a list of data points.", + "name": "yield_curve", + "type": "Literal['spot', 'par']", + "description": "The yield curve type.", "default": "", "optional": false - }, + } + ], + "fred": [ { - "name": "target", + "name": "series_id", "type": "str", - "description": "The name of the column for which to calculate the mean.", + "description": "FRED series id.", "default": "", "optional": false } ] }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[Data]", - "description": "An object containing the mean value." - } - ] - }, - "data": {}, - "model": "" + "model": "HighQualityMarketCorporateBond" }, - "/quantitative/performance/omega_ratio": { + "/fixedincome/corporate/spot_rates": { "deprecated": { "flag": null, "message": null }, - "description": "Calculate the Omega Ratio.\n\n The Omega Ratio is a sophisticated metric that goes beyond traditional performance measures by considering the\n probability of achieving returns above a given threshold. It offers a more nuanced view of risk and reward,\n focusing on the likelihood of success rather than just average outcomes.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Omega Ratio.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.performance.omega_ratio(data=returns, target=\"close\")\nobb.quantitative.performance.omega_ratio(target='close', data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", + "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": "data", - "type": "List[Data]", - "description": "Time series data.", - "default": "", - "optional": false + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true }, { - "name": "target", - "type": "str", - "description": "Target column name.", - "default": "", - "optional": false + "name": "maturity", + "type": "Union[Union[float, str], List[Union[float, str]]]", + "description": "Maturities in years. Multiple items allowed for provider(s): fred.", + "default": 10.0, + "optional": true }, { - "name": "threshold_start", - "type": "float, optional", - "description": "Start threshold, by default 0.0", - "default": "", - "optional": false + "name": "category", + "type": "Union[str, List[str]]", + "description": "Rate category. Options: spot_rate, par_yield. Multiple items allowed for provider(s): fred.", + "default": "spot_rate", + "optional": true }, { - "name": "threshold_end", - "type": "float, optional", - "description": "End threshold, by default 1.5", - "default": "", - "optional": false + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", + "optional": true } - ] + ], + "fred": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[OmegaModel]", - "description": "Omega ratios." - } - ] - }, - "data": {}, - "model": "" - }, - "/quantitative/performance/sharpe_ratio": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get Rolling Sharpe Ratio.\n\n This function calculates the Sharpe Ratio, a metric used to assess the return of an investment compared to its risk.\n By factoring in the risk-free rate, it helps you understand how much extra return you're getting for the extra\n volatility that you endure by holding a riskier asset. The Sharpe Ratio is essential for investors looking to\n compare the efficiency of different investments, providing a clear picture of potential rewards in relation to their\n risks over a specified period. Ideal for gauging the effectiveness of investment strategies, it offers insights into\n optimizing your portfolio for maximum return on risk.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Rolling Sharpe Ratio.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.performance.sharpe_ratio(data=returns, target=\"close\")\nobb.quantitative.performance.sharpe_ratio(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", - "parameters": { - "standard": [ + "type": "List[SpotRate]", + "description": "Serializable results." + }, { - "name": "data", - "type": "List[Data]", - "description": "Time series data.", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "target", - "type": "str", - "description": "Target column name.", - "default": "", - "optional": false + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "rfr", - "type": "float, optional", - "description": "Risk-free rate, by default 0.0", - "default": "", - "optional": false + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "window", - "type": "PositiveInt, optional", - "description": "Window size, by default 252", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "index", - "type": "str, optional", - "description": "Returns", + "name": "rate", + "type": "float", + "description": "Spot Rate.", "default": "", "optional": false } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[Data]", - "description": "Sharpe ratio." - } - ] + ], + "fred": [] }, - "data": {}, - "model": "" + "model": "SpotRate" }, - "/quantitative/performance/sortino_ratio": { + "/fixedincome/corporate/commercial_paper": { "deprecated": { "flag": null, "message": null }, - "description": "Get rolling Sortino Ratio.\n\n The Sortino Ratio enhances the evaluation of investment returns by distinguishing harmful volatility\n from total volatility. Unlike other metrics that treat all volatility as risk, this command specifically assesses\n the volatility of negative returns relative to a target or desired return.\n It's particularly useful for investors who are more concerned with downside risk than with overall volatility.\n By calculating the Sortino Ratio, investors can better understand the risk-adjusted return of their investments,\n focusing on the likelihood and impact of negative returns.\n This approach offers a more nuanced tool for portfolio optimization, especially in strategies aiming\n to minimize the downside.\n\n For method & terminology see:\n http://www.redrockcapital.com/Sortino__A__Sharper__Ratio_Red_Rock_Capital.pdf", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Rolling Sortino Ratio.\nstock_data = obb.equity.price.historical(symbol=\"TSLA\", start_date=\"2023-01-01\", provider=\"fmp\").to_df()\nreturns = stock_data[\"close\"].pct_change().dropna()\nobb.quantitative.performance.sortino_ratio(data=stock_data, target=\"close\")\nobb.quantitative.performance.sortino_ratio(data=stock_data, target=\"close\", target_return=0.01, window=126, adjusted=True)\nobb.quantitative.performance.sortino_ratio(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}])\n```\n\n", + "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": "http", - "type": "//www.redrockcapital.com/Sortino__A__Sharper__Ratio_Red_Rock_Capital.pdf", - "description": "Parameters", - "default": "", - "optional": false - }, - { - "name": "data", - "type": "List[Data]", - "description": "Time series data.", - "default": "", - "optional": false + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true }, { - "name": "target", - "type": "str", - "description": "Target column name.", - "default": "", - "optional": false + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true }, { - "name": "target_return", - "type": "float, optional", - "description": "Target return, by default 0.0", - "default": "", - "optional": false + "name": "maturity", + "type": "Literal['overnight', '7d', '15d', '30d', '60d', '90d']", + "description": "The maturity.", + "default": "30d", + "optional": true }, { - "name": "window", - "type": "PositiveInt, optional", - "description": "Window size, by default 252", - "default": "", - "optional": false + "name": "category", + "type": "Literal['asset_backed', 'financial', 'nonfinancial']", + "description": "The category.", + "default": "financial", + "optional": true }, { - "name": "adjusted", - "type": "bool, optional", - "description": "Adjust sortino ratio to compare it to sharpe ratio, by default False", - "default": "", - "optional": false + "name": "grade", + "type": "Literal['aa', 'a2_p2']", + "description": "The grade.", + "default": "aa", + "optional": true }, { - "name": "index", - "type": "str", - "description": "Index column for input data", - "default": "", - "optional": false + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", + "optional": true } - ] + ], + "fred": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[Data]", - "description": "Sortino ratio." + "type": "List[CommercialPaper]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } ] }, - "data": {}, - "model": "" - }, - "/quantitative/normality": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get Normality Statistics.\n\n - **Kurtosis**: whether the kurtosis of a sample differs from the normal distribution.\n - **Skewness**: whether the skewness of a sample differs from the normal distribution.\n - **Jarque-Bera**: whether the sample data has the skewness and kurtosis matching a normal distribution.\n - **Shapiro-Wilk**: whether a random sample comes from a normal distribution.\n - **Kolmogorov-Smirnov**: whether two underlying one-dimensional probability distributions differ.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Normality Statistics.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.quantitative.normality(data=stock_data, target='close')\nobb.quantitative.normality(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}, {'date': '2023-01-07', 'open': 128.33, 'high': 140.0, 'low': 116.67, 'close': 134.17, 'volume': 11666.67}, {'date': '2023-01-08', 'open': 125.71, 'high': 137.14, 'low': 114.29, 'close': 131.43, 'volume': 11428.57}, {'date': '2023-01-09', 'open': 123.75, 'high': 135.0, 'low': 112.5, 'close': 129.38, 'volume': 11250.0}])\n```\n\n", - "parameters": { + "data": { "standard": [ { - "name": "data", - "type": "List[Data]", - "description": "Time series data.", + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "target", - "type": "str", - "description": "Target column name.", + "name": "rate", + "type": "float", + "description": "Commercial Paper Rate.", "default": "", "optional": false } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "NormalityModel", - "description": "Normality tests summary. See qa_models.NormalityModel for details." - } - ] + ], + "fred": [] }, - "data": {}, - "model": "" + "model": "CommercialPaper" }, - "/quantitative/capm": { + "/fixedincome/sofr": { "deprecated": { "flag": null, "message": null }, - "description": "Get Capital Asset Pricing Model (CAPM).\n\n CAPM offers a streamlined way to assess the expected return on an investment while accounting for its risk relative\n to the market. It's a cornerstone of modern financial theory that helps investors understand the trade-off between\n risk and return, guiding more informed investment choices.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Capital Asset Pricing Model (CAPM).\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.quantitative.capm(data=stock_data, target='close')\nobb.quantitative.capm(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}, {'date': '2023-01-07', 'open': 128.33, 'high': 140.0, 'low': 116.67, 'close': 134.17, 'volume': 11666.67}, {'date': '2023-01-08', 'open': 125.71, 'high': 137.14, 'low': 114.29, 'close': 131.43, 'volume': 11428.57}, {'date': '2023-01-09', 'open': 123.75, 'high': 135.0, 'low': 112.5, 'close': 129.38, 'volume': 11250.0}, {'date': '2023-01-10', 'open': 122.22, 'high': 133.33, 'low': 111.11, 'close': 127.78, 'volume': 11111.11}, {'date': '2023-01-11', 'open': 121.0, 'high': 132.0, 'low': 110.0, 'close': 126.5, 'volume': 11000.0}, {'date': '2023-01-12', 'open': 120.0, 'high': 130.91, 'low': 109.09, 'close': 125.45, 'volume': 10909.09}, {'date': '2023-01-13', 'open': 119.17, 'high': 130.0, 'low': 108.33, 'close': 124.58, 'volume': 10833.33}, {'date': '2023-01-14', 'open': 118.46, 'high': 129.23, 'low': 107.69, 'close': 123.85, 'volume': 10769.23}, {'date': '2023-01-15', 'open': 117.86, 'high': 128.57, 'low': 107.14, 'close': 123.21, 'volume': 10714.29}, {'date': '2023-01-16', 'open': 117.33, 'high': 128.0, 'low': 106.67, 'close': 122.67, 'volume': 10666.67}, {'date': '2023-01-17', 'open': 116.88, 'high': 127.5, 'low': 106.25, 'close': 122.19, 'volume': 10625.0}, {'date': '2023-01-18', 'open': 116.47, 'high': 127.06, 'low': 105.88, 'close': 121.76, 'volume': 10588.24}, {'date': '2023-01-19', 'open': 116.11, 'high': 126.67, 'low': 105.56, 'close': 121.39, 'volume': 10555.56}, {'date': '2023-01-20', 'open': 115.79, 'high': 126.32, 'low': 105.26, 'close': 121.05, 'volume': 10526.32}, {'date': '2023-01-21', 'open': 115.5, 'high': 126.0, 'low': 105.0, 'close': 120.75, 'volume': 10500.0}, {'date': '2023-01-22', 'open': 115.24, 'high': 125.71, 'low': 104.76, 'close': 120.48, 'volume': 10476.19}, {'date': '2023-01-23', 'open': 115.0, 'high': 125.45, 'low': 104.55, 'close': 120.23, 'volume': 10454.55}, {'date': '2023-01-24', 'open': 114.78, 'high': 125.22, 'low': 104.35, 'close': 120.0, 'volume': 10434.78}, {'date': '2023-01-25', 'open': 114.58, 'high': 125.0, 'low': 104.17, 'close': 119.79, 'volume': 10416.67}, {'date': '2023-01-26', 'open': 114.4, 'high': 124.8, 'low': 104.0, 'close': 119.6, 'volume': 10400.0}, {'date': '2023-01-27', 'open': 114.23, 'high': 124.62, 'low': 103.85, 'close': 119.42, 'volume': 10384.62}, {'date': '2023-01-28', 'open': 114.07, 'high': 124.44, 'low': 103.7, 'close': 119.26, 'volume': 10370.37}, {'date': '2023-01-29', 'open': 113.93, 'high': 124.29, 'low': 103.57, 'close': 119.11, 'volume': 10357.14}, {'date': '2023-01-30', 'open': 113.79, 'high': 124.14, 'low': 103.45, 'close': 118.97, 'volume': 10344.83}, {'date': '2023-01-31', 'open': 113.67, 'high': 124.0, 'low': 103.33, 'close': 118.83, 'volume': 10333.33}, {'date': '2023-02-01', 'open': 113.55, 'high': 123.87, 'low': 103.23, 'close': 118.71, 'volume': 10322.58}])\n```\n\n", + "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": "data", - "type": "List[Data]", - "description": "Time series data.", - "default": "", - "optional": false + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true }, { - "name": "target", - "type": "str", - "description": "Target column name.", - "default": "", - "optional": false + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "provider", + "type": "Literal['fred']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.", + "default": "fred", + "optional": true + } + ], + "fred": [ + { + "name": "period", + "type": "Literal['overnight', '30_day', '90_day', '180_day', 'index']", + "description": "Period of SOFR rate.", + "default": "overnight", + "optional": true } ] }, @@ -37333,132 +26280,144 @@ "OBBject": [ { "name": "results", - "type": "CAPMModel", - "description": "CAPM model summary." - } - ] - }, - "data": {}, - "model": "" - }, - "/quantitative/unitroot_test": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get Unit Root Test.\n\n This function applies two renowned tests to assess whether your data series is stationary or if it contains a unit\n root, indicating it may be influenced by time-based trends or seasonality. The Augmented Dickey-Fuller (ADF) test\n helps identify the presence of a unit root, suggesting that the series could be non-stationary and potentially\n unpredictable over time. On the other hand, the Kwiatkowski-Phillips-Schmidt-Shin (KPSS) test checks for the\n stationarity of the series, where failing to reject the null hypothesis indicates a stable, stationary series.\n Together, these tests provide a comprehensive view of your data's time series properties, essential for\n accurate modeling and forecasting.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Unit Root Test.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.quantitative.unitroot_test(data=stock_data, target='close')\nobb.quantitative.unitroot_test(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", - "parameters": { - "standard": [ + "type": "List[SOFR]", + "description": "Serializable results." + }, { - "name": "data", - "type": "List[Data]", - "description": "Time series data.", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['fred']]", + "description": "Provider name." }, { - "name": "target", - "type": "str", - "description": "Target column name.", - "default": "", - "optional": false + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "fuller_reg", - "type": "Literal[\"c\", \"ct\", \"ctt\", \"nc\", \"c\"]", - "description": "Regression type for ADF test.", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "kpss_reg", - "type": "Literal[\"c\", \"ct\"]", - "description": "Regression type for KPSS test.", + "name": "rate", + "type": "float", + "description": "SOFR rate.", "default": "", "optional": false } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "UnitRootModel", - "description": "Unit root tests summary." - } - ] + ], + "fred": [] }, - "data": {}, - "model": "" + "model": "SOFR" }, - "/quantitative/summary": { + "/index/price/historical": { "deprecated": { "flag": null, "message": null }, - "description": "Get Summary Statistics.\n\n The summary that offers a snapshot of its central tendencies, variability, and distribution.\n This command calculates essential statistics, including mean, standard deviation, variance,\n and specific percentiles, to provide a detailed profile of your target column. B\n y examining these metrics, you gain insights into the data's overall behavior, helping to identify patterns,\n outliers, or anomalies. The summary table is an invaluable tool for initial data exploration,\n ensuring you have a solid foundation for further analysis or reporting.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get Summary Statistics.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.quantitative.summary(data=stock_data, target='close')\nobb.quantitative.summary(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "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": "data", - "type": "List[Data]", - "description": "Time series data.", + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, polygon, yfinance.", "default": "", "optional": false }, { - "name": "target", + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "interval", "type": "str", - "description": "Target column name.", - "default": "", - "optional": false + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true + }, + { + "name": "provider", + "type": "Literal['fmp', 'intrinio', 'polygon', 'yfinance']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", + "optional": true } - ] - }, - "returns": { - "OBBject": [ + ], + "fmp": [ { - "name": "results", - "type": "SummaryModel", - "description": "Summary table." + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true } - ] - }, - "data": {}, - "model": "" - }, - "/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": [ + ], + "intrinio": [ { - "name": "symbol", + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10000, + "optional": true + } + ], + "polygon": [ + { + "name": "interval", "type": "str", - "description": "Symbol to get data for.", - "default": "", - "optional": false + "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", + "default": "1d", + "optional": true }, { - "name": "provider", - "type": "Literal['sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", - "default": "sec", + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", + "default": "asc", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 49999, "optional": true } ], - "sec": [ + "yfinance": [ { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache for the request, default is True.", - "default": 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 } ] @@ -37467,12 +26426,12 @@ "OBBject": [ { "name": "results", - "type": "List[CikMap]", + "type": "List[IndexHistorical]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['sec']]", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", "description": "Provider name." }, { @@ -37495,137 +26454,177 @@ "data": { "standard": [ { - "name": "cik", - "type": "Union[int, str]", - "description": "Central Index Key (CIK) for the requested entity.", + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", + "default": "", + "optional": false + }, + { + "name": "open", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The open price.", + "default": null, + "optional": true + }, + { + "name": "high", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The high price.", + "default": null, + "optional": true + }, + { + "name": "low", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The low price.", + "default": null, + "optional": true + }, + { + "name": "close", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The close price.", + "default": null, + "optional": true + }, + { + "name": "volume", + "type": "int", + "description": "The trading volume.", "default": null, "optional": true } ], - "sec": [] - }, - "model": "CikMap" - }, - "/regulators/sec/institutions_search": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Search SEC-regulated institutions by name and return a list of results with CIK numbers.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.institutions_search(provider='sec')\nobb.regulators.sec.institutions_search(query='blackstone real estate', provider='sec')\n```\n\n", - "parameters": { - "standard": [ + "fmp": [ { - "name": "query", - "type": "str", - "description": "Search query.", - "default": "", + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": null, "optional": true }, { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache.", - "default": true, + "name": "change", + "type": "float", + "description": "Change in the price from the previous close.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", - "default": "sec", + "name": "change_percent", + "type": "float", + "description": "Change in the price from the previous close, as a normalized percent.", + "default": null, "optional": true } ], - "sec": [] + "intrinio": [], + "polygon": [ + { + "name": "transactions", + "type": "Annotated[int, Gt(gt=0)]", + "description": "Number of transactions for the symbol in the time period.", + "default": null, + "optional": true + } + ], + "yfinance": [] }, - "returns": { - "OBBject": [ + "model": "IndexHistorical" + }, + "/index/market": { + "deprecated": { + "flag": true, + "message": "This endpoint is deprecated; use `/index/price/historical` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.3." + }, + "description": "Get Historical Market Indices.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.market(symbol='^IBEX', provider='fmp')\n```\n\n", + "parameters": { + "standard": [ { - "name": "results", - "type": "List[InstitutionsSearch]", - "description": "Serializable results." + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, polygon, yfinance.", + "default": "", + "optional": false }, { - "name": "provider", - "type": "Optional[Literal['sec']]", - "description": "Provider name." + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "interval", + "type": "str", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "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 } - ] - }, - "data": { - "standard": [], - "sec": [ + ], + "fmp": [ { - "name": "name", - "type": "str", - "description": "The name of the institution.", - "default": null, + "name": "interval", + "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", + "description": "Time interval of the data to return.", + "default": "1d", "optional": true - }, + } + ], + "intrinio": [ { - "name": "cik", - "type": "Union[int, str]", - "description": "Central Index Key (CIK)", - "default": null, + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 10000, "optional": true } - ] - }, - "model": "InstitutionsSearch" - }, - "/regulators/sec/schema_files": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Use tool for navigating the directory of SEC XML schema files by year.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.schema_files(provider='sec')\n# Get a list of schema files.\ndata = obb.regulators.sec.schema_files().results\ndata.files[0]\n'https://xbrl.fasb.org/us-gaap/'\n# The directory structure can be navigated by constructing a URL from the 'results' list.\nurl = data.files[0]+data.files[-1]\n# The URL base will always be the 0 position in the list, feed the URL back in as a parameter.\nobb.regulators.sec.schema_files(url=url).results.files\n['https://xbrl.fasb.org/us-gaap/2024/'\n'USGAAP2024FileList.xml'\n'dis/'\n'dqcrules/'\n'ebp/'\n'elts/'\n'entire/'\n'meta/'\n'stm/'\n'us-gaap-2024.zip']\n```\n\n", - "parameters": { - "standard": [ + ], + "polygon": [ { - "name": "query", + "name": "interval", "type": "str", - "description": "Search query.", - "default": "", + "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", + "default": "1d", "optional": true }, { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache.", - "default": true, + "name": "sort", + "type": "Literal['asc', 'desc']", + "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", + "default": "asc", "optional": true }, { - "name": "provider", - "type": "Literal['sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", - "default": "sec", + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": 49999, "optional": true } ], - "sec": [ + "yfinance": [ { - "name": "url", - "type": "str", - "description": "Enter an optional URL path to fetch the next level.", - "default": null, + "name": "interval", + "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", + "description": "Time interval of the data to return.", + "default": "1d", "optional": true } ] @@ -37634,12 +26633,12 @@ "OBBject": [ { "name": "results", - "type": "List[SchemaFiles]", + "type": "List[MarketIndices]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['sec']]", + "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", "description": "Provider name." }, { @@ -37660,124 +26659,131 @@ ] }, "data": { - "standard": [], - "sec": [ - { - "name": "files", - "type": "List[str]", - "description": "Dictionary of URLs to SEC Schema Files", - "default": "", - "optional": false - } - ] - }, - "model": "SchemaFiles" - }, - "/regulators/sec/symbol_map": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Map a CIK number to a ticker symbol, leading 0s can be omitted or included.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.symbol_map(query='0000789019', provider='sec')\n```\n\n", - "parameters": { "standard": [ { - "name": "query", - "type": "str", - "description": "Search query.", + "name": "date", + "type": "Union[date, datetime]", + "description": "The date of the data.", "default": "", "optional": false }, { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache. If True, cache will store for seven days.", - "default": true, + "name": "open", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The open price.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", - "default": "sec", + "name": "high", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The high price.", + "default": null, "optional": true - } - ], - "sec": [] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[SymbolMap]", - "description": "Serializable results." + "name": "low", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The low price.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['sec']]", - "description": "Provider name." + "name": "close", + "type": "Annotated[float, Strict(strict=True)]", + "description": "The close price.", + "default": null, + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "volume", + "type": "int", + "description": "The trading volume.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "vwap", + "type": "float", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "change", + "type": "float", + "description": "Change in the price from the previous close.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." + "name": "change_percent", + "type": "float", + "description": "Change in the price from the previous close, as a normalized percent.", + "default": null, + "optional": true } - ] - }, - "data": { - "standard": [], - "sec": [ + ], + "intrinio": [], + "polygon": [ { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data.", - "default": "", - "optional": false + "name": "transactions", + "type": "Annotated[int, Gt(gt=0)]", + "description": "Number of transactions for the symbol in the time period.", + "default": null, + "optional": true } - ] + ], + "yfinance": [] }, - "model": "SymbolMap" + "model": "MarketIndices" }, - "/regulators/sec/rss_litigation": { + "/index/constituents": { "deprecated": { "flag": null, "message": null }, - "description": "Get the RSS feed that provides links to litigation releases concerning civil lawsuits brought by the Commission in federal court.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.rss_litigation(provider='sec')\n```\n\n", + "description": "Get Index Constituents.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.constituents(symbol='dowjones', provider='fmp')\n```\n\n", "parameters": { "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": "", + "optional": false + }, { "name": "provider", - "type": "Literal['sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", - "default": "sec", + "type": "Literal['fmp']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", + "default": "fmp", "optional": true } ], - "sec": [] + "fmp": [ + { + "name": "symbol", + "type": "Literal['dowjones', 'sp500', 'nasdaq']", + "description": "None", + "default": "dowjones", + "optional": true + } + ] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[RssLitigation]", + "type": "List[IndexConstituents]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['sec']]", + "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { @@ -37798,90 +26804,99 @@ ] }, "data": { - "standard": [], - "sec": [ + "standard": [ { - "name": "published", - "type": "datetime", - "description": "The date of publication.", + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false }, { - "name": "title", + "name": "name", + "type": "str", + "description": "Name of the constituent company in the index.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "sector", "type": "str", - "description": "The title of the release.", + "description": "Sector the constituent company in the index belongs to.", "default": "", "optional": false }, { - "name": "summary", + "name": "sub_sector", "type": "str", - "description": "Short summary of the release.", - "default": "", - "optional": false + "description": "Sub-sector the constituent company in the index belongs to.", + "default": null, + "optional": true }, { - "name": "id", + "name": "headquarter", "type": "str", - "description": "The identifier associated with the release.", - "default": "", - "optional": false + "description": "Location of the headquarter of the constituent company in the index.", + "default": null, + "optional": true }, { - "name": "link", - "type": "str", - "description": "URL to the release.", - "default": "", - "optional": false + "name": "date_first_added", + "type": "Union[str, date]", + "description": "Date the constituent company was added to the index.", + "default": null, + "optional": true + }, + { + "name": "cik", + "type": "int", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true + }, + { + "name": "founded", + "type": "Union[str, date]", + "description": "Founding year of the constituent company in the index.", + "default": null, + "optional": true } ] }, - "model": "RssLitigation" + "model": "IndexConstituents" }, - "/regulators/sec/sic_search": { + "/index/available": { "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", + "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": "query", - "type": "str", - "description": "Search query.", - "default": "", - "optional": true - }, - { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache.", - "default": true, - "optional": true - }, { "name": "provider", - "type": "Literal['sec']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", - "default": "sec", + "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 } ], - "sec": [] + "fmp": [], + "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[SicSearch]", + "type": "List[AvailableIndices]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['sec']]", + "type": "Optional[Literal['fmp', 'yfinance']]", "description": "Provider name." }, { @@ -37902,229 +26917,259 @@ ] }, "data": { - "standard": [], - "sec": [ + "standard": [ { - "name": "sic", - "type": "int", - "description": "Sector Industrial Code (SIC)", + "name": "name", + "type": "str", + "description": "Name of the index.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "Currency the index is traded in.", + "default": null, + "optional": true + } + ], + "fmp": [ + { + "name": "stock_exchange", + "type": "str", + "description": "Stock exchange where the index is listed.", "default": "", "optional": false }, { - "name": "industry", + "name": "exchange_short_name", "type": "str", - "description": "Industry title.", + "description": "Short name of the stock exchange where the index is listed.", + "default": "", + "optional": false + } + ], + "yfinance": [ + { + "name": "code", + "type": "str", + "description": "ID code for keying the index in the OpenBB Terminal.", "default": "", "optional": false }, { - "name": "office", + "name": "symbol", "type": "str", - "description": "Reporting office within the Corporate Finance Office", + "description": "Symbol for the index.", "default": "", "optional": false } ] }, - "model": "SicSearch" + "model": "AvailableIndices" }, - "/regulators/cftc/cot_search": { + "/news/world": { "deprecated": { "flag": null, "message": null }, - "description": "Curated Commitment of Traders Reports.\n\nSearch a list of curated Commitment of Traders Reports series information.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.cftc.cot_search(provider='nasdaq')\nobb.regulators.cftc.cot_search(query='gold', provider='nasdaq')\n```\n\n", + "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": "query", - "type": "str", - "description": "Search query.", - "default": "", + "name": "limit", + "type": "int", + "description": "The number of data entries to return. The number of articles to return.", + "default": 2500, "optional": true }, { - "name": "use_cache", - "type": "bool", - "description": "Whether or not to use cache.", - "default": true, + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, "optional": true }, { "name": "provider", - "type": "Literal['nasdaq']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default.", - "default": "nasdaq", + "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 } ], - "nasdaq": [] - }, - "returns": { - "OBBject": [ + "benzinga": [ { - "name": "results", - "type": "List[COTSearch]", - "description": "Serializable results." + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": null, + "optional": true }, { - "name": "provider", - "type": "Optional[Literal['nasdaq']]", - "description": "Provider name." + "name": "display", + "type": "Literal['headline', 'abstract', 'full']", + "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full).", + "default": "full", + "optional": true }, { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "name": "updated_since", + "type": "int", + "description": "Number of seconds since the news was updated.", + "default": null, + "optional": true }, { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." + "name": "published_since", + "type": "int", + "description": "Number of seconds since the news was published.", + "default": null, + "optional": true }, { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ + "name": "sort", + "type": "Literal['id', 'created', 'updated']", + "description": "Key to sort the news by.", + "default": "created", + "optional": true + }, { - "name": "code", + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order to sort the news by.", + "default": "desc", + "optional": true + }, + { + "name": "isin", "type": "str", - "description": "CFTC Code of the report.", - "default": "", - "optional": false + "description": "The ISIN of the news to retrieve.", + "default": null, + "optional": true }, { - "name": "name", + "name": "cusip", "type": "str", - "description": "Name of the underlying asset.", - "default": "", - "optional": false + "description": "The CUSIP of the news to retrieve.", + "default": null, + "optional": true }, { - "name": "category", + "name": "channels", "type": "str", - "description": "Category of the underlying asset.", + "description": "Channels of the news to retrieve.", "default": null, "optional": true }, { - "name": "subcategory", + "name": "topics", "type": "str", - "description": "Subcategory of the underlying asset.", + "description": "Topics of the news to retrieve.", "default": null, "optional": true }, { - "name": "units", + "name": "authors", "type": "str", - "description": "The units for one contract.", + "description": "Authors of the news to retrieve.", "default": null, "optional": true }, { - "name": "symbol", + "name": "content_types", "type": "str", - "description": "Symbol representing the entity requested in the data.", + "description": "Content types of the news to retrieve.", "default": null, "optional": true } ], - "nasdaq": [] - }, - "model": "COTSearch" - }, - "/regulators/cftc/cot": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get Commitment of Traders Reports.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.cftc.cot(provider='nasdaq')\n# Get the Commitment of Traders Report for Gold.\nobb.regulators.cftc.cot(id='GC=F', provider='nasdaq')\n# Enter the report ID by the Nasdaq Data Link Code.\nobb.regulators.cftc.cot(id='088691', provider='nasdaq')\n# Get the report for futures only.\nobb.regulators.cftc.cot(id='088691', data_type=F, provider='nasdaq')\n```\n\n", - "parameters": { - "standard": [ + "fmp": [], + "intrinio": [ { - "name": "id", - "type": "str", - "description": "The series ID string for the report. Default report is Two-Year Treasury Note Futures.", - "default": "042601", + "name": "source", + "type": "Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases']", + "description": "The source of the news article.", + "default": null, "optional": true }, { - "name": "provider", - "type": "Literal['nasdaq']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default.", - "default": "nasdaq", + "name": "sentiment", + "type": "Literal['positive', 'neutral', 'negative']", + "description": "Return news only from this source.", + "default": null, "optional": true - } - ], - "nasdaq": [ + }, { - "name": "id", + "name": "language", "type": "str", - "description": "CFTC series ID. Use search_cot() to find the ID. IDs not listed in the curated list, but are published on the Nasdaq Data Link website, are valid. Certain symbols, such as 'ES=F', or exact names are also valid. Default report is Two-Year Treasury Note Futures.", - "default": "042601", + "description": "Filter by language. Unsupported for yahoo source.", + "default": null, "optional": true }, { - "name": "data_type", - "type": "Literal['F', 'FO', 'CITS']", - "description": "The type of data to reuturn. Default is 'FO'. F = Futures only FO = Futures and Options CITS = Commodity Index Trader Supplemental. Only valid for commodities.", - "default": "FO", + "name": "topic", + "type": "str", + "description": "Filter by topic. Unsupported for yahoo source.", + "default": null, "optional": true }, { - "name": "legacy_format", - "type": "bool", - "description": "Returns the legacy format of report. Default is False.", - "default": false, + "name": "word_count_greater_than", + "type": "int", + "description": "News stories will have a word count greater than this value. Unsupported for yahoo source.", + "default": null, "optional": true }, { - "name": "report_type", - "type": "Literal['ALL', 'CHG', 'OLD', 'OTR']", - "description": "The type of report to return. Default is 'ALL'. ALL = All CHG = Change in Positions OLD = Old Crop Years OTR = Other Crop Years", - "default": "ALL", + "name": "word_count_less_than", + "type": "int", + "description": "News stories will have a word count less than this value. Unsupported for yahoo source.", + "default": null, "optional": true }, { - "name": "measure", - "type": "Literal['CR', 'NT', 'OI', 'CHG']", - "description": "The measure to return. Default is None. CR = Concentration Ratios NT = Number of Traders OI = Percent of Open Interest CHG = Change in Positions. Only valid when data_type is 'CITS'.", + "name": "is_spam", + "type": "bool", + "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source.", "default": null, "optional": true }, { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "business_relevance_greater_than", + "type": "float", + "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source.", "default": null, "optional": true }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "business_relevance_less_than", + "type": "float", + "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source.", "default": null, "optional": true - }, + } + ], + "tiingo": [ { - "name": "transform", - "type": "Literal['diff', 'rdiff', 'cumul', 'normalize']", - "description": "Transform the data as difference, percent change, cumulative, or normalize.", - "default": null, + "name": "offset", + "type": "int", + "description": "Page offset, used in conjunction with limit.", + "default": 0, "optional": true }, { - "name": "collapse", - "type": "Literal['daily', 'weekly', 'monthly', 'quarterly', 'annual']", - "description": "Collapse the frequency of the time series.", + "name": "source", + "type": "str", + "description": "A comma-separated list of the domains requested.", "default": null, "optional": true } @@ -38134,12 +27179,12 @@ "OBBject": [ { "name": "results", - "type": "List[COT]", + "type": "List[WorldNews]", "description": "Serializable results." }, { "name": "provider", - "type": "Optional[Literal['nasdaq']]", + "type": "Optional[Literal['benzinga', 'fmp', 'intrinio', 'tiingo']]", "description": "Provider name." }, { @@ -38163,1157 +27208,802 @@ "standard": [ { "name": "date", - "type": "date", - "description": "The date of the data.", - "default": "", - "optional": false - } - ], - "nasdaq": [] - }, - "model": "COT" - }, - "/technical/relative_rotation": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the Relative Strength Ratio and Relative Strength Momentum for a group of symbols against a benchmark.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Calculate the Relative Strength Ratio and Relative Strength Momentum for a group of symbols against a benchmark.\nstock_data = obb.equity.price.historical(symbol='AAPL,MSFT,GOOGL,META,AMZN,TSLA,SPY', start_date='2022-01-01', provider='yfinance')\nrr_data = obb.technical.relative_rotation(data=stock_data.results, benchmark='SPY')\nrs_ratios = rr_data.results.rs_ratios\nrs_momentum = rr_data.results.rs_momentum\n# When the assets are not traded 252 days per year,adjust the momentum and volatility periods accordingly.\ncrypto_data = obb.crypto.price.historical( symbol='BTCUSD,ETHUSD,SOLUSD', start_date='2021-01-01', provider='yfinance')\nrr_data = obb.technical.relative_rotation(data=crypto_data.results, benchmark='BTCUSD', long_period=365, short_period=30, window=30, trading_periods=365)\n```\n\n", - "parameters": { - "standard": [ - { - "name": "data", - "type": "list[Data]", - "description": "The data to be used for the relative rotation calculations.", + "type": "datetime", + "description": "The date of the data. The published date of the article.", "default": "", "optional": false }, { - "name": "benchmark", + "name": "title", "type": "str", - "description": "The symbol to be used as the benchmark.", - "default": "", - "optional": false - }, - { - "name": "study", - "type": "Literal[price, volume, volatility]", - "description": "The data point for the calculations. If 'price', the closing price will be used.", - "default": "", - "optional": false - }, - { - "name": "long_period", - "type": "int, optional", - "description": "The length of the long period for momentum calculation, by default 252.", - "default": "", - "optional": false - }, - { - "name": "short_period", - "type": "int, optional", - "description": "The length of the short period for momentum calculation, by default 21.", - "default": "", - "optional": false - }, - { - "name": "window", - "type": "int, optional", - "description": "The length of window for the standard deviation calculation, by default 21.", - "default": "", - "optional": false - }, - { - "name": "trading_periods", - "type": "int, optional", - "description": "The number of trading periods per year, for the standard deviation calculation, by default 252.", - "default": "", - "optional": false - }, - { - "name": "chart_params", - "type": "dict[str, Any], optional", - "description": "Additional parameters to pass when `chart=True` and the `openbb-charting` extension is installed.", - "default": "", - "optional": false - }, - { - "name": "date", - "type": "str, optional", - "description": "A target end date within the data to use for the chart, by default is the last date in the data.", - "default": "", - "optional": false - }, - { - "name": "show_tails", - "type": "bool", - "description": "Show the tails on the chart, by default True.", + "description": "Title of the article.", "default": "", "optional": false }, { - "name": "tail_periods", - "type": "int", - "description": "Number of periods to show in the tails, by default 16.", - "default": "", - "optional": false + "name": "images", + "type": "List[Dict[str, str]]", + "description": "Images associated with the article.", + "default": null, + "optional": true }, { - "name": "tail_interval", - "type": "Literal[day, week, month]", - "description": "Interval to show the tails, by default 'week'.", - "default": "", - "optional": false + "name": "text", + "type": "str", + "description": "Text/body of the article.", + "default": null, + "optional": true }, { - "name": "title", - "type": "str, optional", - "description": "Title of the chart.", - "default": "", - "optional": false - }, + "name": "url", + "type": "str", + "description": "URL to the article.", + "default": null, + "optional": true + } + ], + "benzinga": [ { - "name": "results", - "type": "RelativeRotationData", - "description": "symbols : list[str]:", + "name": "id", + "type": "str", + "description": "Article ID.", "default": "", "optional": false }, { - "name": "benchmark", + "name": "author", "type": "str", - "description": "The benchmark symbol.", - "default": "", - "optional": false + "description": "Author of the news.", + "default": null, + "optional": true }, { - "name": "study", - "type": "Literal[price, volume, volatility]", - "description": "The data point for the selected.", - "default": "", - "optional": false + "name": "teaser", + "type": "str", + "description": "Teaser of the news.", + "default": null, + "optional": true }, { - "name": "long_period", - "type": "int", - "description": "The length of the long period for momentum calculation, as entered by the user.", - "default": "", - "optional": false + "name": "channels", + "type": "str", + "description": "Channels associated with the news.", + "default": null, + "optional": true }, { - "name": "short_period", - "type": "int", - "description": "The length of the short period for momentum calculation, as entered by the user.", - "default": "", - "optional": false + "name": "stocks", + "type": "str", + "description": "Stocks associated with the news.", + "default": null, + "optional": true }, { - "name": "window", - "type": "int", - "description": "The length of window for the standard deviation calculation.", - "default": "", - "optional": false + "name": "tags", + "type": "str", + "description": "Tags associated with the news.", + "default": null, + "optional": true }, { - "name": "trading_periods", - "type": "int", - "description": "The number of trading periods per year, for the standard deviation calculation.", - "default": "", - "optional": false - }, + "name": "updated", + "type": "datetime", + "description": "Updated date of the news.", + "default": null, + "optional": true + } + ], + "fmp": [ { - "name": "start_date", + "name": "site", "type": "str", - "description": "The start date of the data after adjusting the length of the data for the calculations.", + "description": "News source.", "default": "", "optional": false - }, + } + ], + "intrinio": [ { - "name": "end_date", + "name": "source", "type": "str", - "description": "The end date of the data.", - "default": "", - "optional": false - }, - { - "name": "symbols_data", - "type": "list[Data]", - "description": "The data representing the selected 'study' for each symbol.", - "default": "", - "optional": false + "description": "The source of the news article.", + "default": null, + "optional": true }, { - "name": "benchmark_data", - "type": "list[Data]", - "description": "The data representing the selected 'study' for the benchmark.", - "default": "", - "optional": false + "name": "summary", + "type": "str", + "description": "The summary of the news article.", + "default": null, + "optional": true }, { - "name": "rs_ratios", - "type": "list[Data]", - "description": "The normalized relative strength ratios data.", - "default": "", - "optional": false + "name": "topics", + "type": "str", + "description": "The topics related to the news article.", + "default": null, + "optional": true }, { - "name": "rs_momentum", - "type": "list[Data]", - "description": "The normalized relative strength momentum data.", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "RelativeRotationData", - "description": "results : RelativeRotationData" - } - ] - }, - "data": {}, - "model": "" - }, - "/technical/atr": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the Average True Range.\n\n Used to measure volatility, especially volatility caused by gaps or limit moves.\n The ATR metric helps understand how much the values in your data change on average,\n giving insights into the stability or unpredictability during a certain period.\n It's particularly useful for spotting trends of increase or decrease in variations,\n without getting into technical trading details.\n The method considers not just the day-to-day changes but also accounts for any\n sudden jumps or drops, ensuring you get a comprehensive view of movement.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Average True Range.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\natr_data = obb.technical.atr(data=stock_data.results)\nobb.technical.atr(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", - "parameters": { - "standard": [ - { - "name": "data", - "type": "List[Data]", - "description": "List of data to apply the indicator to.", - "default": "", - "optional": false + "name": "word_count", + "type": "int", + "description": "The word count of the news article.", + "default": null, + "optional": true }, { - "name": "index", - "type": "str, optional", - "description": "Index column name, by default \"date\"", - "default": "", - "optional": false + "name": "business_relevance", + "type": "float", + "description": "How strongly correlated the news article is to the business", + "default": null, + "optional": true }, { - "name": "length", - "type": "PositiveInt, optional", - "description": "It's period, by default 14", - "default": "", - "optional": false + "name": "sentiment", + "type": "str", + "description": "The sentiment of the news article - i.e, negative, positive.", + "default": null, + "optional": true }, { - "name": "mamode", - "type": "Literal[\"rma\", \"ema\", \"sma\", \"wma\"], optional", - "description": "Moving average mode, by default \"rma\"", - "default": "", - "optional": false + "name": "sentiment_confidence", + "type": "float", + "description": "The confidence score of the sentiment rating.", + "default": null, + "optional": true }, { - "name": "drift", - "type": "NonNegativeInt, optional", - "description": "The difference period, by default 1", - "default": "", - "optional": false + "name": "language", + "type": "str", + "description": "The language of the news article.", + "default": null, + "optional": true }, { - "name": "offset", - "type": "int, optional", - "description": "How many periods to offset the result, by default 0", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[Data]", - "description": "List of data with the indicator applied." - } - ] - }, - "data": {}, - "model": "" - }, - "/technical/fib": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Create Fibonacci Retracement Levels.\n\n This method draws from a classic technique to pinpoint significant price levels\n that often indicate where the market might find support or resistance.\n It's a tool used to gauge potential turning points in the data by applying a\n mathematical approach rooted in nature's patterns. Is used to get insights into\n where prices could head next, based on historical movements.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Bollinger Band Width.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nfib_data = obb.technical.fib(data=stock_data.results, period=120)\nobb.technical.fib(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", - "parameters": { - "standard": [ - { - "name": "data", - "type": "List[Data]", - "description": "List of data to apply the indicator to.", - "default": "", - "optional": false + "name": "spam", + "type": "bool", + "description": "Whether the news article is spam.", + "default": null, + "optional": true }, { - "name": "index", - "type": "str, optional", - "description": "Index column name, by default \"date\"", - "default": "", - "optional": false + "name": "copyright", + "type": "str", + "description": "The copyright notice of the news article.", + "default": null, + "optional": true }, { - "name": "period", - "type": "PositiveInt, optional", - "description": "Period to calculate the indicator, by default 120", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[Data]", - "description": "List of data with the indicator applied." - } - ] - }, - "data": {}, - "model": "" - }, - "/technical/obv": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the On Balance Volume (OBV).\n\n Is a cumulative total of the up and down volume. When the close is higher than the\n previous close, the volume is added to the running total, and when the close is\n lower than the previous close, the volume is subtracted from the running total.\n\n To interpret the OBV, look for the OBV to move with the price or precede price moves.\n If the price moves before the OBV, then it is a non-confirmed move. A series of rising peaks,\n or falling troughs, in the OBV indicates a strong trend. If the OBV is flat, then the market\n is not trending.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the On Balance Volume (OBV).\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nobv_data = obb.technical.obv(data=stock_data.results, offset=0)\nobb.technical.obv(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", - "parameters": { - "standard": [ - { - "name": "data", - "type": "List[Data]", - "description": "List of data to apply the indicator to.", + "name": "id", + "type": "str", + "description": "Article ID.", "default": "", "optional": false }, { - "name": "index", - "type": "str, optional", - "description": "Index column name, by default \"date\"", - "default": "", - "optional": false + "name": "company", + "type": "IntrinioCompany", + "description": "The Intrinio Company object. Contains details company reference data.", + "default": null, + "optional": true }, { - "name": "offset", - "type": "int, optional", - "description": "How many periods to offset the result, by default 0.", - "default": "", - "optional": false + "name": "security", + "type": "IntrinioSecurity", + "description": "The Intrinio Security object. Contains the security details related to the news article.", + "default": null, + "optional": true } - ] - }, - "returns": { - "OBBject": [ + ], + "tiingo": [ { - "name": "results", - "type": "List[Data]", - "description": "List of data with the indicator applied." - } - ] - }, - "data": {}, - "model": "" - }, - "/technical/fisher": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Perform the Fisher Transform.\n\n A technical indicator created by John F. Ehlers that converts prices into a Gaussian\n normal distribution. The indicator highlights when prices have moved to an extreme,\n based on recent prices.\n This may help in spotting turning points in the price of an asset. It also helps\n show the trend and isolate the price waves within a trend.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Perform the Fisher Transform.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nfisher_data = obb.technical.fisher(data=stock_data.results, length=14, signal=1)\nobb.technical.fisher(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", - "parameters": { - "standard": [ + "name": "symbols", + "type": "str", + "description": "Ticker tagged in the fetched news.", + "default": null, + "optional": true + }, { - "name": "data", - "type": "List[Data]", - "description": "List of data to apply the indicator to.", + "name": "article_id", + "type": "int", + "description": "Unique ID of the news article.", "default": "", "optional": false }, { - "name": "index", - "type": "str, optional", - "description": "Index column name, by default \"date\"", + "name": "site", + "type": "str", + "description": "News source.", "default": "", "optional": false }, { - "name": "length", - "type": "PositiveInt, optional", - "description": "Fisher period, by default 14", - "default": "", - "optional": false + "name": "tags", + "type": "str", + "description": "Tags associated with the news article.", + "default": null, + "optional": true }, { - "name": "signal", - "type": "PositiveInt, optional", - "description": "Fisher Signal period, by default 1", + "name": "crawl_date", + "type": "datetime", + "description": "Date the news article was crawled.", "default": "", "optional": false } ] }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[Data]", - "description": "List of data with the indicator applied." - } - ] - }, - "data": {}, - "model": "" + "model": "WorldNews" }, - "/technical/adosc": { + "/news/company": { "deprecated": { "flag": null, "message": null }, - "description": "Calculate the Accumulation/Distribution Oscillator.\n\n Also known as the Chaikin Oscillator.\n\n Essentially a momentum indicator, but of the Accumulation-Distribution line\n rather than merely price. It looks at both the strength of price moves and the\n underlying buying and selling pressure during a given time period. The oscillator\n reading above zero indicates net buying pressure, while one below zero registers\n net selling pressure. Divergence between the indicator and pure price moves are\n the most common signals from the indicator, and often flag market turning points.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Accumulation/Distribution Oscillator.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nadosc_data = obb.technical.adosc(data=stock_data.results, fast=3, slow=10, offset=0)\nobb.technical.adosc(fast=2, slow=4, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "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": "data", - "type": "List[Data]", - "description": "List of data to be used for the calculation.", - "default": "", - "optional": false + "name": "symbol", + "type": "Union[str, List[str]]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, yfinance.", + "default": null, + "optional": true }, { - "name": "fast", - "type": "PositiveInt, optional", - "description": "Number of periods to be used for the fast calculation, by default 3.", - "default": "", - "optional": false + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true }, { - "name": "slow", - "type": "PositiveInt, optional", - "description": "Number of periods to be used for the slow calculation, by default 10.", - "default": "", - "optional": false + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true }, { - "name": "offset", - "type": "int, optional", - "description": "Offset to be used for the calculation, by default 0.", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ + "name": "limit", + "type": "Annotated[int, Ge(ge=0)]", + "description": "The number of data entries to return.", + "default": 2500, + "optional": true + }, { - "name": "results", - "type": "List[Data]", - "description": "The calculated data." + "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 } - ] - }, - "data": {}, - "model": "" - }, - "/technical/bbands": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the Bollinger Bands.\n\n Consist of three lines. The middle band is a simple moving average (generally 20\n periods) of the typical price (TP). The upper and lower bands are F standard\n deviations (generally 2) above and below the middle band.\n The bands widen and narrow when the volatility of the price is higher or lower,\n respectively.\n\n Bollinger Bands do not, in themselves, generate buy or sell signals;\n they are an indicator of overbought or oversold conditions. When the price is near the\n upper or lower band it indicates that a reversal may be imminent. The middle band\n becomes a support or resistance level. The upper and lower bands can also be\n interpreted as price targets. When the price bounces off of the lower band and crosses\n the middle band, then the upper band becomes the price target.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Chande Momentum Oscillator.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nbbands_data = obb.technical.bbands(data=stock_data.results, target='close', length=50, std=2, mamode='sma')\nobb.technical.bbands(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", - "parameters": { - "standard": [ + ], + "benzinga": [ { - "name": "data", - "type": "List[Data]", - "description": "List of data to be used for the calculation.", - "default": "", - "optional": false + "name": "date", + "type": "Union[date, str]", + "description": "A specific date to get data for.", + "default": null, + "optional": true }, { - "name": "target", - "type": "str", - "description": "Target column name.", - "default": "", - "optional": 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 }, { - "name": "index", - "type": "str, optional", - "description": "Index column name to use with `data`, by default \"date\".", - "default": "", - "optional": false + "name": "updated_since", + "type": "int", + "description": "Number of seconds since the news was updated.", + "default": null, + "optional": true }, { - "name": "length", - "type": "int, optional", - "description": "Number of periods to be used for the calculation, by default 50.", - "default": "", - "optional": false + "name": "published_since", + "type": "int", + "description": "Number of seconds since the news was published.", + "default": null, + "optional": true }, { - "name": "std", - "type": "NonNegativeFloat, optional", - "description": "Standard deviation to be used for the calculation, by default 2.", - "default": "", - "optional": false + "name": "sort", + "type": "Literal['id', 'created', 'updated']", + "description": "Key to sort the news by.", + "default": "created", + "optional": true }, { - "name": "mamode", - "type": "Literal[\"sma\", \"ema\", \"wma\", \"rma\"], optional", - "description": "Moving average mode to be used for the calculation, by default \"sma\".", - "default": "", - "optional": false + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Order to sort the news by.", + "default": "desc", + "optional": true }, { - "name": "offset", - "type": "int, optional", - "description": "Offset to be used for the calculation, by default 0.", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[Data]", - "description": "The calculated data." - } - ] - }, - "data": {}, - "model": "" - }, - "/technical/zlma": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the zero lag exponential moving average (ZLEMA).\n\n Created by John Ehlers and Ric Way. The idea is do a\n regular exponential moving average (EMA) calculation but\n on a de-lagged data instead of doing it on the regular data.\n Data is de-lagged by removing the data from \"lag\" days ago\n thus removing (or attempting to) the cumulative effect of\n the moving average.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Chande Momentum Oscillator.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nzlma_data = obb.technical.zlma(data=stock_data.results, target='close', length=50, offset=0)\nobb.technical.zlma(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", - "parameters": { - "standard": [ + "name": "isin", + "type": "str", + "description": "The company's ISIN.", + "default": null, + "optional": true + }, { - "name": "data", - "type": "List[Data]", - "description": "List of data to be used for the calculation.", - "default": "", - "optional": false + "name": "cusip", + "type": "str", + "description": "The company's CUSIP.", + "default": null, + "optional": true }, { - "name": "target", + "name": "channels", "type": "str", - "description": "Target column name.", - "default": "", - "optional": false + "description": "Channels of the news to retrieve.", + "default": null, + "optional": true }, { - "name": "index", - "type": "str, optional", - "description": "Index column name to use with `data`, by default \"date\".", - "default": "", - "optional": false + "name": "topics", + "type": "str", + "description": "Topics of the news to retrieve.", + "default": null, + "optional": true }, { - "name": "length", - "type": "int, optional", - "description": "Number of periods to be used for the calculation, by default 50.", - "default": "", - "optional": false + "name": "authors", + "type": "str", + "description": "Authors of the news to retrieve.", + "default": null, + "optional": true }, { - "name": "offset", - "type": "int, optional", - "description": "Offset to be used for the calculation, by default 0.", - "default": "", - "optional": false + "name": "content_types", + "type": "str", + "description": "Content types of the news to retrieve.", + "default": null, + "optional": true } - ] - }, - "returns": { - "OBBject": [ + ], + "fmp": [ { - "name": "results", - "type": "List[Data]", - "description": "The calculated data." + "name": "page", + "type": "int", + "description": "Page number of the results. Use in combination with limit.", + "default": 0, + "optional": true } - ] - }, - "data": {}, - "model": "" - }, - "/technical/aroon": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the Aroon Indicator.\n\n The word aroon is Sanskrit for \"dawn's early light.\" The Aroon\n indicator attempts to show when a new trend is dawning. The indicator consists\n of two lines (Up and Down) that measure how long it has been since the highest\n high/lowest low has occurred within an n period range.\n\n When the Aroon Up is staying between 70 and 100 then it indicates an upward trend.\n When the Aroon Down is staying between 70 and 100 then it indicates an downward trend.\n A strong upward trend is indicated when the Aroon Up is above 70 while the Aroon Down is below 30.\n Likewise, a strong downward trend is indicated when the Aroon Down is above 70 while\n the Aroon Up is below 30. Also look for crossovers. When the Aroon Down crosses above\n the Aroon Up, it indicates a weakening of the upward trend (and vice versa).", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Chande Momentum Oscillator.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\naaron_data = obb.technical.aroon(data=stock_data.results, length=25, scalar=100)\nobb.technical.aroon(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", - "parameters": { - "standard": [ - { - "name": "data", - "type": "List[Data]", - "description": "List of data to be used for the calculation.", - "default": "", - "optional": false - }, + ], + "intrinio": [ { - "name": "index", - "type": "str, optional", - "description": "Index column name to use with `data`, by default \"date\".", - "default": "", - "optional": false + "name": "source", + "type": "Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases']", + "description": "The source of the news article.", + "default": null, + "optional": true }, { - "name": "length", - "type": "int, optional", - "description": "Number of periods to be used for the calculation, by default 25.", - "default": "", - "optional": false + "name": "sentiment", + "type": "Literal['positive', 'neutral', 'negative']", + "description": "Return news only from this source.", + "default": null, + "optional": true }, { - "name": "scalar", - "type": "float, optional", - "description": "Scalar to be used for the calculation, by default 100.", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[Data]", - "description": "The calculated data." - } - ] - }, - "data": {}, - "model": "" - }, - "/technical/sma": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the Simple Moving Average (SMA).\n\n Moving Averages are used to smooth the data in an array to\n help eliminate noise and identify trends. The Simple Moving Average is literally\n the simplest form of a moving average. Each output value is the average of the\n previous n values. In a Simple Moving Average, each value in the time period carries\n equal weight, and values outside of the time period are not included in the average.\n This makes it less responsive to recent changes in the data, which can be useful for\n filtering out those changes.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Chande Momentum Oscillator.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nsma_data = obb.technical.sma(data=stock_data.results, target='close', length=50, offset=0)\nobb.technical.sma(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", - "parameters": { - "standard": [ - { - "name": "data", - "type": "List[Data]", - "description": "List of data to be used for the calculation.", - "default": "", - "optional": false + "name": "language", + "type": "str", + "description": "Filter by language. Unsupported for yahoo source.", + "default": null, + "optional": true }, { - "name": "target", + "name": "topic", "type": "str", - "description": "Target column name.", - "default": "", - "optional": false + "description": "Filter by topic. Unsupported for yahoo source.", + "default": null, + "optional": true }, { - "name": "index", - "type": "str, optional", - "description": "Index column name to use with `data`, by default \"date\".", - "default": "", - "optional": false + "name": "word_count_greater_than", + "type": "int", + "description": "News stories will have a word count greater than this value. Unsupported for yahoo source.", + "default": null, + "optional": true }, { - "name": "length", - "type": "int, optional", - "description": "Number of periods to be used for the calculation, by default 50.", - "default": "", - "optional": false + "name": "word_count_less_than", + "type": "int", + "description": "News stories will have a word count less than this value. Unsupported for yahoo source.", + "default": null, + "optional": true }, { - "name": "offset", - "type": "int, optional", - "description": "Offset from the current period, by default 0.", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[Data]", - "description": "The calculated data." - } - ] - }, - "data": {}, - "model": "" - }, - "/technical/demark": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the Demark sequential indicator.\n\n This indicator offers a strategic way to spot potential reversals in market trends.\n It's designed to highlight moments when the current trend may be running out of steam,\n suggesting a possible shift in direction. By focusing on specific patterns in price movements, it provides\n valuable insights for making informed decisions on future changes and identifies trend exhaustion points\n with precision.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Demark Sequential Indicator.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\ndemark_data = obb.technical.demark(data=stock_data.results, offset=0)\nobb.technical.demark(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", - "parameters": { - "standard": [ - { - "name": "data", - "type": "List[Data]", - "description": "List of data to be used for the calculation.", - "default": "", - "optional": false + "name": "is_spam", + "type": "bool", + "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source.", + "default": null, + "optional": true }, { - "name": "index", - "type": "str, optional", - "description": "Index column name to use with `data`, by default \"date\".", - "default": "", - "optional": false + "name": "business_relevance_greater_than", + "type": "float", + "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source.", + "default": null, + "optional": true }, { - "name": "target", - "type": "str, optional", - "description": "Target column name, by default \"close\".", - "default": "", - "optional": false - }, + "name": "business_relevance_less_than", + "type": "float", + "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source.", + "default": null, + "optional": true + } + ], + "polygon": [ { - "name": "show_all", - "type": "bool, optional", - "description": "Show 1 - 13. If set to False, show 6 - 9", - "default": "", - "optional": false - }, + "name": "order", + "type": "Literal['asc', 'desc']", + "description": "Sort order of the articles.", + "default": "desc", + "optional": true + } + ], + "tiingo": [ { - "name": "asint", - "type": "bool, optional", - "description": "If True, fill NAs with 0 and change type to int, by default True.", - "default": "", - "optional": false + "name": "offset", + "type": "int", + "description": "Page offset, used in conjunction with limit.", + "default": 0, + "optional": true }, { - "name": "offset", - "type": "int, optional", - "description": "How many periods to offset the result", - "default": "", - "optional": false + "name": "source", + "type": "str", + "description": "A comma-separated list of the domains requested.", + "default": null, + "optional": true } - ] + ], + "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[Data]", - "description": "The calculated data." - } - ] - }, - "data": {}, - "model": "" - }, - "/technical/vwap": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the Volume Weighted Average Price (VWAP).\n\n Measures the average typical price by volume.\n It is typically used with intraday charts to identify general direction.\n It helps to understand the true average price factoring in the volume of transactions,\n and serves as a benchmark for assessing the market's direction over short periods, such as a single trading day.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Volume Weighted Average Price (VWAP).\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nvwap_data = obb.technical.vwap(data=stock_data.results, anchor='D', offset=0)\nobb.technical.vwap(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", - "parameters": { - "standard": [ - { - "name": "data", - "type": "List[Data]", - "description": "List of data to be used for the calculation.", - "default": "", - "optional": false + "type": "List[CompanyNews]", + "description": "Serializable results." }, { - "name": "index", - "type": "str, optional", - "description": "Index column name to use with `data`, by default \"date\".", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']]", + "description": "Provider name." }, { - "name": "anchor", - "type": "str, optional", - "description": "Anchor period to use for the calculation, by default \"D\".", - "default": "", - "optional": false + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "https", - "type": "//pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#timeseries-offset-aliases", - "description": "offset : int, optional", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, { - "name": "results", - "type": "List[Data]", - "description": "The calculated data." + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } ] }, - "data": {}, - "model": "" - }, - "/technical/macd": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the Moving Average Convergence Divergence (MACD).\n\n Difference between two Exponential Moving Averages. The Signal line is an\n Exponential Moving Average of the MACD.\n\n The MACD signals trend changes and indicates the start of new trend direction.\n High values indicate overbought conditions, low values indicate oversold conditions.\n Divergence with the price indicates an end to the current trend, especially if the\n MACD is at extreme high or low values. When the MACD line crosses above the\n signal line a buy signal is generated. When the MACD crosses below the signal line a\n sell signal is generated. To confirm the signal, the MACD should be above zero for a buy,\n and below zero for a sell.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Moving Average Convergence Divergence (MACD).\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nmacd_data = obb.technical.macd(data=stock_data.results, target='close', fast=12, slow=26, signal=9)\n# Example with mock data.\nobb.technical.macd(fast=2, slow=3, signal=1, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", - "parameters": { + "data": { "standard": [ { - "name": "data", - "type": "List[Data]", - "description": "List of data to be used for the calculation.", + "name": "date", + "type": "datetime", + "description": "The date of the data. Here it is the published date of the article.", + "default": "", + "optional": false + }, + { + "name": "title", + "type": "str", + "description": "Title of the article.", "default": "", "optional": false }, { - "name": "target", + "name": "text", "type": "str", - "description": "Target column name.", - "default": "", - "optional": false + "description": "Text/body of the article.", + "default": null, + "optional": true }, { - "name": "fast", - "type": "int, optional", - "description": "Number of periods for the fast EMA, by default 12.", - "default": "", - "optional": false + "name": "images", + "type": "List[Dict[str, str]]", + "description": "Images associated with the article.", + "default": null, + "optional": true }, { - "name": "slow", - "type": "int, optional", - "description": "Number of periods for the slow EMA, by default 26.", + "name": "url", + "type": "str", + "description": "URL to the article.", "default": "", "optional": false }, { - "name": "signal", - "type": "int, optional", - "description": "Number of periods for the signal EMA, by default 9.", - "default": "", - "optional": false + "name": "symbols", + "type": "str", + "description": "Symbols associated with the article.", + "default": null, + "optional": true } - ] - }, - "returns": { - "OBBject": [ + ], + "benzinga": [ { - "name": "results", - "type": "List[Data]", - "description": "The calculated data." - } - ] - }, - "data": {}, - "model": "" - }, - "/technical/hma": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the Hull Moving Average (HMA).\n\n Solves the age old dilemma of making a moving average more responsive to current\n price activity whilst maintaining curve smoothness.\n In fact the HMA almost eliminates lag altogether and manages to improve smoothing\n at the same time.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Calculate HMA with historical stock data.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nhma_data = obb.technical.hma(data=stock_data.results, target='close', length=50, offset=0)\n```\n\n", - "parameters": { - "standard": [ + "name": "images", + "type": "List[Dict[str, str]]", + "description": "URL to the images of the news.", + "default": null, + "optional": true + }, { - "name": "data", - "type": "List[Data]", - "description": "List of data to be used for the calculation.", + "name": "id", + "type": "str", + "description": "Article ID.", "default": "", "optional": false }, { - "name": "target", + "name": "author", "type": "str", - "description": "Target column name.", - "default": "", - "optional": false + "description": "Author of the article.", + "default": null, + "optional": true }, { - "name": "index", - "type": "str, optional", - "description": "Index column name to use with `data`, by default \"date\".", - "default": "", - "optional": false + "name": "teaser", + "type": "str", + "description": "Teaser of the news.", + "default": null, + "optional": true }, { - "name": "length", - "type": "int, optional", - "description": "Number of periods for the HMA, by default 50.", - "default": "", - "optional": false + "name": "channels", + "type": "str", + "description": "Channels associated with the news.", + "default": null, + "optional": true }, { - "name": "offset", - "type": "int, optional", - "description": "Offset of the HMA, by default 0.", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ + "name": "stocks", + "type": "str", + "description": "Stocks associated with the news.", + "default": null, + "optional": true + }, { - "name": "results", - "type": "List[Data]", - "description": "The calculated data." + "name": "tags", + "type": "str", + "description": "Tags associated with the news.", + "default": null, + "optional": true + }, + { + "name": "updated", + "type": "datetime", + "description": "Updated date of the news.", + "default": null, + "optional": true } - ] - }, - "data": {}, - "model": "" - }, - "/technical/donchian": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the Donchian Channels.\n\n Three lines generated by moving average calculations that comprise an indicator\n formed by upper and lower bands around a midrange or median band. The upper band\n marks the highest price of a security over N periods while the lower band\n marks the lowest price of a security over N periods. The area\n between the upper and lower bands represents the Donchian Channel.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Donchian Channels.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\ndonchian_data = obb.technical.donchian(data=stock_data.results, lower_length=20, upper_length=20, offset=0)\nobb.technical.donchian(lower_length=1, upper_length=3, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", - "parameters": { - "standard": [ + ], + "fmp": [ { - "name": "data", - "type": "List[Data]", - "description": "List of data to be used for the calculation.", + "name": "source", + "type": "str", + "description": "Name of the news source.", "default": "", "optional": false + } + ], + "intrinio": [ + { + "name": "source", + "type": "str", + "description": "The source of the news article.", + "default": null, + "optional": true }, { - "name": "index", - "type": "str, optional", - "description": "Index column name to use with `data`, by default \"date\".", - "default": "", - "optional": false + "name": "summary", + "type": "str", + "description": "The summary of the news article.", + "default": null, + "optional": true }, { - "name": "lower_length", - "type": "PositiveInt, optional", - "description": "Number of periods for the lower band, by default 20.", - "default": "", - "optional": false + "name": "topics", + "type": "str", + "description": "The topics related to the news article.", + "default": null, + "optional": true }, { - "name": "upper_length", - "type": "PositiveInt, optional", - "description": "Number of periods for the upper band, by default 20.", - "default": "", - "optional": false + "name": "word_count", + "type": "int", + "description": "The word count of the news article.", + "default": null, + "optional": true }, { - "name": "offset", - "type": "int, optional", - "description": "Offset of the Donchian Channel, by default 0.", - "default": "", - "optional": false - } - ] - }, - "returns": { - "OBBject": [ + "name": "business_relevance", + "type": "float", + "description": "How strongly correlated the news article is to the business", + "default": null, + "optional": true + }, { - "name": "results", - "type": "List[Data]", - "description": "The calculated data." - } - ] - }, - "data": {}, - "model": "" - }, - "/technical/ichimoku": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the Ichimoku Cloud.\n\n Also known as Ichimoku Kinko Hyo, is a versatile indicator that defines support and\n resistance, identifies trend direction, gauges momentum and provides trading\n signals. Ichimoku Kinko Hyo translates into \"one look equilibrium chart\". With\n one look, chartists can identify the trend and look for potential signals within\n that trend.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Ichimoku Cloud.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nichimoku_data = obb.technical.ichimoku(data=stock_data.results, conversion=9, base=26, lookahead=False)\n```\n\n", - "parameters": { - "standard": [ + "name": "sentiment", + "type": "str", + "description": "The sentiment of the news article - i.e, negative, positive.", + "default": null, + "optional": true + }, { - "name": "data", - "type": "List[Data]", - "description": "List of data to be used for the calculation.", - "default": "", - "optional": false + "name": "sentiment_confidence", + "type": "float", + "description": "The confidence score of the sentiment rating.", + "default": null, + "optional": true }, { - "name": "index", - "type": "str, optional", - "description": "Index column name to use with `data`, by default \"date\".", - "default": "", - "optional": false + "name": "language", + "type": "str", + "description": "The language of the news article.", + "default": null, + "optional": true }, { - "name": "conversion", - "type": "PositiveInt, optional", - "description": "Number of periods for the conversion line, by default 9.", - "default": "", - "optional": false + "name": "spam", + "type": "bool", + "description": "Whether the news article is spam.", + "default": null, + "optional": true }, { - "name": "base", - "type": "PositiveInt, optional", - "description": "Number of periods for the base line, by default 26.", - "default": "", - "optional": false + "name": "copyright", + "type": "str", + "description": "The copyright notice of the news article.", + "default": null, + "optional": true }, { - "name": "lagging", - "type": "PositiveInt, optional", - "description": "Number of periods for the lagging span, by default 52.", + "name": "id", + "type": "str", + "description": "Article ID.", "default": "", "optional": false }, { - "name": "offset", - "type": "PositiveInt, optional", - "description": "Number of periods for the offset, by default 26.", - "default": "", - "optional": false + "name": "security", + "type": "IntrinioSecurity", + "description": "The Intrinio Security object. Contains the security details related to the news article.", + "default": null, + "optional": true + } + ], + "polygon": [ + { + "name": "source", + "type": "str", + "description": "Source of the article.", + "default": null, + "optional": true + }, + { + "name": "tags", + "type": "str", + "description": "Keywords/tags in the article", + "default": null, + "optional": true }, { - "name": "lookahead", - "type": "bool, optional", - "description": "drops the Chikou Span Column to prevent potential data leak", + "name": "id", + "type": "str", + "description": "Article ID.", "default": "", "optional": false - } - ] - }, - "returns": { - "OBBject": [ + }, { - "name": "results", - "type": "List[Data]", - "description": "The calculated data." - } - ] - }, - "data": {}, - "model": "" - }, - "/technical/clenow": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the Clenow Volatility Adjusted Momentum.\n\n The Clenow Volatility Adjusted Momentum is a sophisticated approach to understanding market momentum with a twist.\n It adjusts for volatility, offering a clearer picture of true momentum by considering how price movements are\n influenced by their volatility over a set period. It helps in identifying stronger, more reliable trends.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Clenow Volatility Adjusted Momentum.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nclenow_data = obb.technical.clenow(data=stock_data.results, period=90)\nobb.technical.clenow(period=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", - "parameters": { - "standard": [ + "name": "amp_url", + "type": "str", + "description": "AMP URL.", + "default": null, + "optional": true + }, { - "name": "data", - "type": "List[Data]", - "description": "List of data to be used for the calculation.", + "name": "publisher", + "type": "PolygonPublisher", + "description": "Publisher of the article.", "default": "", "optional": false + } + ], + "tiingo": [ + { + "name": "tags", + "type": "str", + "description": "Tags associated with the news article.", + "default": null, + "optional": true }, { - "name": "index", - "type": "str, optional", - "description": "Index column name to use with `data`, by default \"date\".", + "name": "article_id", + "type": "int", + "description": "Unique ID of the news article.", "default": "", "optional": false }, { - "name": "target", - "type": "str, optional", - "description": "Target column name, by default \"close\".", + "name": "source", + "type": "str", + "description": "News source.", "default": "", "optional": false }, { - "name": "period", - "type": "PositiveInt, optional", - "description": "Number of periods for the momentum, by default 90.", + "name": "crawl_date", + "type": "datetime", + "description": "Date the news article was crawled.", "default": "", "optional": false } - ] - }, - "returns": { - "OBBject": [ + ], + "yfinance": [ { - "name": "results", - "type": "List[Data]", - "description": "The calculated data." + "name": "source", + "type": "str", + "description": "Source of the news article", + "default": "", + "optional": false } ] }, - "data": {}, - "model": "" + "model": "CompanyNews" }, - "/technical/ad": { + "/regulators/sec/cik_map": { "deprecated": { "flag": null, "message": null }, - "description": "Calculate the Accumulation/Distribution Line.\n\n Similar to the On Balance Volume (OBV).\n Sums the volume times +1/-1 based on whether the close is higher than the previous\n close. The Accumulation/Distribution indicator, however multiplies the volume by the\n close location value (CLV). The CLV is based on the movement of the issue within a\n single bar and can be +1, -1 or zero.\n\n\n The Accumulation/Distribution Line is interpreted by looking for a divergence in\n the direction of the indicator relative to price. If the Accumulation/Distribution\n Line is trending upward it indicates that the price may follow. Also, if the\n Accumulation/Distribution Line becomes flat while the price is still rising (or falling)\n then it signals an impending flattening of the price.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Accumulation/Distribution Line.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nad_data = obb.technical.ad(data=stock_data.results, offset=0)\nobb.technical.ad(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "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": "data", - "type": "List[Data]", - "description": "List of data to be used for the calculation.", + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", "default": "", "optional": false }, { - "name": "index", - "type": "str, optional", - "description": "Index column name to use with `data`, by default \"date\".", - "default": "", - "optional": false - }, + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", + "optional": true + } + ], + "sec": [ { - "name": "offset", - "type": "int, optional", - "description": "Offset of the AD, by default 0.", - "default": "", - "optional": false + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache for the request, default is True.", + "default": true, + "optional": true } ] }, @@ -39321,548 +28011,470 @@ "OBBject": [ { "name": "results", - "type": "List[Data]", - "description": "The calculated data." - } - ] - }, - "data": {}, - "model": "" - }, - "/technical/adx": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the Average Directional Index (ADX).\n\n The ADX is a Welles Wilder style moving average of the Directional Movement Index (DX).\n The values range from 0 to 100, but rarely get above 60. To interpret the ADX, consider\n a high number to be a strong trend, and a low number, a weak trend.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Average Directional Index (ADX).\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nadx_data = obb.technical.adx(data=stock_data.results, length=50, scalar=100.0, drift=1)\nobb.technical.adx(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", - "parameters": { - "standard": [ - { - "name": "data", - "type": "List[Data]", - "description": "List of data to be used for the calculation.", - "default": "", - "optional": false + "type": "List[CikMap]", + "description": "Serializable results." }, { - "name": "index", - "type": "str, optional", - "description": "Index column name to use with `data`, by default \"date\".", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['sec']]", + "description": "Provider name." }, { - "name": "length", - "type": "int, optional", - "description": "Number of periods for the ADX, by default 50.", - "default": "", - "optional": false + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "scalar", - "type": "float, optional", - "description": "Scalar value for the ADX, by default 100.0.", - "default": "", - "optional": false + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "drift", - "type": "int, optional", - "description": "Drift value for the ADX, by default 1.", - "default": "", - "optional": false + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } ] }, - "returns": { - "OBBject": [ + "data": { + "standard": [ { - "name": "results", - "type": "List[Data]", - "description": "The calculated data." + "name": "cik", + "type": "Union[int, str]", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true } - ] + ], + "sec": [] }, - "data": {}, - "model": "" + "model": "CikMap" }, - "/technical/wma": { + "/regulators/sec/institutions_search": { "deprecated": { "flag": null, "message": null }, - "description": "Calculate the Weighted Moving Average (WMA).\n\n A Weighted Moving Average puts more weight on recent data and less on past data.\n This is done by multiplying each bar's price by a weighting factor. Because of its\n unique calculation, WMA will follow prices more closely than a corresponding Simple\n Moving Average.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Average True Range (ATR).\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nwma_data = obb.technical.wma(data=stock_data.results, target='close', length=50, offset=0)\nobb.technical.wma(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "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": "data", - "type": "List[Data]", - "description": "The data to use for the calculation.", - "default": "", - "optional": false - }, - { - "name": "target", + "name": "query", "type": "str", - "description": "Target column name.", - "default": "", - "optional": false - }, - { - "name": "index", - "type": "str, optional", - "description": "Index column name to use with `data`, by default \"date\".", + "description": "Search query.", "default": "", - "optional": false + "optional": true }, { - "name": "length", - "type": "int, optional", - "description": "The length of the WMA, by default 50.", - "default": "", - "optional": false + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache.", + "default": true, + "optional": true }, { - "name": "offset", - "type": "int, optional", - "description": "The offset of the WMA, by default 0.", - "default": "", - "optional": false + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", + "optional": true } - ] + ], + "sec": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[Data]", - "description": "The WMA data." - } - ] - }, - "data": {}, - "model": "" - }, - "/technical/cci": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the Commodity Channel Index (CCI).\n\n The CCI is designed to detect beginning and ending market trends.\n The range of 100 to -100 is the normal trading range. CCI values outside of this\n range indicate overbought or oversold conditions. You can also look for price\n divergence in the CCI. If the price is making new highs, and the CCI is not,\n then a price correction is likely.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Commodity Channel Index (CCI).\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\ncci_data = obb.technical.cci(data=stock_data.results, length=14, scalar=0.015)\nobb.technical.cci(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", - "parameters": { - "standard": [ + "type": "List[InstitutionsSearch]", + "description": "Serializable results." + }, { - "name": "data", - "type": "List[Data]", - "description": "The data to use for the CCI calculation.", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['sec']]", + "description": "Provider name." }, { - "name": "index", - "type": "str, optional", - "description": "Index column name to use with `data`, by default \"date\".", - "default": "", - "optional": false + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "length", - "type": "PositiveInt, optional", - "description": "The length of the CCI, by default 14.", - "default": "", - "optional": false + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "scalar", - "type": "PositiveFloat, optional", - "description": "The scalar of the CCI, by default 0.015.", - "default": "", - "optional": false + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } ] }, - "returns": { - "OBBject": [ + "data": { + "standard": [], + "sec": [ { - "name": "results", - "type": "List[Data]", - "description": "The CCI data." + "name": "name", + "type": "str", + "description": "The name of the institution.", + "default": null, + "optional": true + }, + { + "name": "cik", + "type": "Union[int, str]", + "description": "Central Index Key (CIK)", + "default": null, + "optional": true } ] }, - "data": {}, - "model": "" + "model": "InstitutionsSearch" }, - "/technical/rsi": { + "/regulators/sec/schema_files": { "deprecated": { "flag": null, "message": null }, - "description": "Calculate the Relative Strength Index (RSI).\n\n RSI calculates a ratio of the recent upward price movements to the absolute price\n movement. The RSI ranges from 0 to 100.\n The RSI is interpreted as an overbought/oversold indicator when\n the value is over 70/below 30. You can also look for divergence with price. If\n the price is making new highs/lows, and the RSI is not, it indicates a reversal.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Relative Strength Index (RSI).\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nrsi_data = obb.technical.rsi(data=stock_data.results, target='close', length=14, scalar=100.0, drift=1)\nobb.technical.rsi(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "description": "Use tool for navigating the directory of SEC XML schema files by year.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.schema_files(provider='sec')\n# Get a list of schema files.\ndata = obb.regulators.sec.schema_files().results\ndata.files[0]\n'https://xbrl.fasb.org/us-gaap/'\n# The directory structure can be navigated by constructing a URL from the 'results' list.\nurl = data.files[0]+data.files[-1]\n# The URL base will always be the 0 position in the list, feed the URL back in as a parameter.\nobb.regulators.sec.schema_files(url=url).results.files\n['https://xbrl.fasb.org/us-gaap/2024/'\n'USGAAP2024FileList.xml'\n'dis/'\n'dqcrules/'\n'ebp/'\n'elts/'\n'entire/'\n'meta/'\n'stm/'\n'us-gaap-2024.zip']\n```\n\n", "parameters": { "standard": [ { - "name": "data", - "type": "List[Data]", - "description": "The data to use for the RSI calculation.", + "name": "query", + "type": "str", + "description": "Search query.", "default": "", - "optional": false + "optional": true }, { - "name": "target", + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache.", + "default": true, + "optional": true + }, + { + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", + "optional": true + } + ], + "sec": [ + { + "name": "url", "type": "str", - "description": "Target column name.", - "default": "", - "optional": false + "description": "Enter an optional URL path to fetch the next level.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[SchemaFiles]", + "description": "Serializable results." }, { - "name": "index", - "type": "str, optional", - "description": "Index column name to use with `data`, by default \"date\"", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['sec']]", + "description": "Provider name." }, { - "name": "length", - "type": "int, optional", - "description": "The length of the RSI, by default 14", - "default": "", - "optional": false + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "scalar", - "type": "float, optional", - "description": "The scalar to use for the RSI, by default 100.0", - "default": "", - "optional": false + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "drift", - "type": "int, optional", - "description": "The drift to use for the RSI, by default 1", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "files", + "type": "List[str]", + "description": "Dictionary of URLs to SEC Schema Files", "default": "", "optional": false } ] }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[Data]", - "description": "The RSI data." - } - ] - }, - "data": {}, - "model": "" + "model": "SchemaFiles" }, - "/technical/stoch": { + "/regulators/sec/symbol_map": { "deprecated": { "flag": null, "message": null }, - "description": "Calculate the Stochastic Oscillator.\n\n The Stochastic Oscillator measures where the close is in relation\n to the recent trading range. The values range from zero to 100. %D values over 75\n indicate an overbought condition; values under 25 indicate an oversold condition.\n When the Fast %D crosses above the Slow %D, it is a buy signal; when it crosses\n below, it is a sell signal. The Raw %K is generally considered too erratic to use\n for crossover signals.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Stochastic Oscillator.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nstoch_data = obb.technical.stoch(data=stock_data.results, fast_k_period=14, slow_d_period=3, slow_k_period=3)\n```\n\n", + "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": "data", - "type": "List[Data]", - "description": "The data to use for the Stochastic Oscillator calculation.", + "name": "query", + "type": "str", + "description": "Search query.", "default": "", "optional": false }, { - "name": "index", - "type": "str, optional", - "description": "Index column name to use with `data`, by default \"date\".", - "default": "", - "optional": false + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache. If True, cache will store for seven days.", + "default": true, + "optional": true }, { - "name": "fast_k_period", - "type": "NonNegativeInt, optional", - "description": "The fast %K period, by default 14.", - "default": "", - "optional": false + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", + "optional": true + } + ], + "sec": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[SymbolMap]", + "description": "Serializable results." }, { - "name": "slow_d_period", - "type": "NonNegativeInt, optional", - "description": "The slow %D period, by default 3.", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['sec']]", + "description": "Provider name." }, { - "name": "slow_k_period", - "type": "NonNegativeInt, optional", - "description": "The slow %K period, by default 3.", - "default": "", - "optional": false + "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." } ] }, - "returns": { - "OBBject": [ + "data": { + "standard": [], + "sec": [ { - "name": "results", - "type": "List[Data]", - "description": "The Stochastic Oscillator data." + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": "", + "optional": false } ] }, - "data": {}, - "model": "" + "model": "SymbolMap" }, - "/technical/kc": { + "/regulators/sec/rss_litigation": { "deprecated": { "flag": null, "message": null }, - "description": "Calculate the Keltner Channels.\n\n Keltner Channels are volatility-based bands that are placed\n on either side of an asset's price and can aid in determining\n the direction of a trend.The Keltner channel uses the average\n true range (ATR) or volatility, with breaks above or below the top\n and bottom barriers signaling a continuation.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Keltner Channels.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nkc_data = obb.technical.kc(data=stock_data.results, length=20, scalar=20, mamode='ema', offset=0)\nobb.technical.kc(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "description": "Get the RSS feed that provides links to litigation releases concerning civil lawsuits brought by the Commission in federal court.", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.rss_litigation(provider='sec')\n```\n\n", "parameters": { "standard": [ { - "name": "data", - "type": "List[Data]", - "description": "The data to use for the Keltner Channels calculation.", - "default": "", - "optional": false + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", + "optional": true + } + ], + "sec": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "List[RssLitigation]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "Optional[Literal['sec']]", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "index", - "type": "str, optional", - "description": "Index column name to use with `data`, by default \"date\"", + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "published", + "type": "datetime", + "description": "The date of publication.", "default": "", "optional": false }, { - "name": "length", - "type": "PositiveInt, optional", - "description": "The length of the Keltner Channels, by default 20", + "name": "title", + "type": "str", + "description": "The title of the release.", "default": "", "optional": false }, { - "name": "scalar", - "type": "PositiveFloat, optional", - "description": "The scalar to use for the Keltner Channels, by default 20", + "name": "summary", + "type": "str", + "description": "Short summary of the release.", "default": "", "optional": false }, { - "name": "mamode", - "type": "Literal[\"ema\", \"sma\", \"wma\", \"hma\", \"zlma\"], optional", - "description": "The moving average mode to use for the Keltner Channels, by default \"ema\"", + "name": "id", + "type": "str", + "description": "The identifier associated with the release.", "default": "", "optional": false }, { - "name": "offset", - "type": "NonNegativeInt, optional", - "description": "The offset to use for the Keltner Channels, by default 0", + "name": "link", + "type": "str", + "description": "URL to the release.", "default": "", "optional": false } ] }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[Data]", - "description": "The Keltner Channels data." - } - ] - }, - "data": {}, - "model": "" + "model": "RssLitigation" }, - "/technical/cg": { + "/regulators/sec/sic_search": { "deprecated": { "flag": null, "message": null }, - "description": "Calculate the Center of Gravity.\n\n The Center of Gravity indicator, in short, is used to anticipate future price movements\n and to trade on price reversals as soon as they happen. However, just like other oscillators,\n the COG indicator returns the best results in range-bound markets and should be avoided when\n the price is trending. Traders who use it will be able to closely speculate the upcoming\n price change of the asset.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Center of Gravity (CG).\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\ncg_data = obb.technical.cg(data=stock_data.results, length=14)\nobb.technical.cg(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "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": "data", - "type": "List[Data]", - "description": "The data to use for the COG calculation.", + "name": "query", + "type": "str", + "description": "Search query.", "default": "", - "optional": false + "optional": true }, { - "name": "index", - "type": "str, optional", - "description": "Index column name to use with `data`, by default \"date\"", - "default": "", - "optional": false + "name": "use_cache", + "type": "bool", + "description": "Whether or not to use cache.", + "default": true, + "optional": true }, { - "name": "length", - "type": "PositiveInt, optional", - "description": "The length of the COG, by default 14", - "default": "", - "optional": false + "name": "provider", + "type": "Literal['sec']", + "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default.", + "default": "sec", + "optional": true } - ] + ], + "sec": [] }, "returns": { "OBBject": [ { "name": "results", - "type": "List[Data]", - "description": "The COG data." - } - ] - }, - "data": {}, - "model": "" - }, - "/technical/cones": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the realized volatility quantiles over rolling windows of time.\n\n The cones indicator is designed to map out the ebb and flow of price movements through a detailed analysis of\n volatility quantiles. By examining the range of volatility within specific time frames, it offers a nuanced view of\n market behavior, highlighting periods of stability and turbulence.\n\n The model for calculating volatility is selectable and can be one of the following:\n - Standard deviation\n - Parkinson\n - Garman-Klass\n - Hodges-Tompkins\n - Rogers-Satchell\n - Yang-Zhang\n\n Read more about it in the model parameter description.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Realized Volatility Cones.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='yfinance')\ncones_data = obb.technical.cones(data=stock_data.results, lower_q=0.25, upper_q=0.75, model='std')\nobb.technical.cones(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", - "parameters": { - "standard": [ - { - "name": "data", - "type": "List[Data]", - "description": "The data to use for the calculation.", - "default": "", - "optional": false - }, - { - "name": "index", - "type": "str, optional", - "description": "Index column name to use with `data`, by default \"date\"", - "default": "", - "optional": false - }, - { - "name": "lower_q", - "type": "float, optional", - "description": "The lower quantile value for calculations", - "default": "", - "optional": false + "type": "List[SicSearch]", + "description": "Serializable results." }, { - "name": "upper_q", - "type": "float, optional", - "description": "The upper quantile value for calculations", - "default": "", - "optional": false + "name": "provider", + "type": "Optional[Literal['sec']]", + "description": "Provider name." }, { - "name": "model", - "type": "Literal[\"std\", \"parkinson\", \"garman_klass\", \"hodges_tompkins\", \"rogers_satchell\", \"yang_zhang\"], optional", - "description": "The model used to calculate realized volatility", - "default": "", - "optional": false + "name": "warnings", + "type": "Optional[List[Warning_]]", + "description": "List of warnings." }, { - "name": "is_crypto", - "type": "bool, optional", - "description": "Whether the data is crypto or not. If True, volatility is calculated for 365 days instead of 252", - "default": "", - "optional": false + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." }, { - "name": "trading_periods", - "type": "Optional[int] [default: 252]", - "description": "Number of trading periods in a year.", - "default": "", - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[Data]", - "description": "The cones data." + "name": "extra", + "type": "Dict[str, Any]", + "description": "Extra info." } ] }, - "data": {}, - "model": "" - }, - "/technical/ema": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Calculate the Exponential Moving Average (EMA).\n\n EMA is a cumulative calculation, including all data. Past values have\n a diminishing contribution to the average, while more recent values have a greater\n contribution. This method allows the moving average to be more responsive to changes\n in the data.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the Exponential Moving Average (EMA).\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp')\nema_data = obb.technical.ema(data=stock_data.results, target='close', length=50, offset=0)\nobb.technical.ema(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", - "parameters": { - "standard": [ + "data": { + "standard": [], + "sec": [ { - "name": "data", - "type": "List[Data]", - "description": "The data to use for the calculation.", + "name": "sic", + "type": "int", + "description": "Sector Industrial Code (SIC)", "default": "", "optional": false }, { - "name": "target", + "name": "industry", "type": "str", - "description": "Target column name.", - "default": "", - "optional": false - }, - { - "name": "index", - "type": "str, optional", - "description": "Index column name to use with `data`, by default \"date\"", - "default": "", - "optional": false - }, - { - "name": "length", - "type": "int, optional", - "description": "The length of the calculation, by default 50.", + "description": "Industry title.", "default": "", "optional": false }, { - "name": "offset", - "type": "int, optional", - "description": "The offset of the calculation, by default 0.", + "name": "office", + "type": "str", + "description": "Reporting office within the Corporate Finance Office", "default": "", "optional": false } ] }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[Data]", - "description": "The calculated data." - } - ] - }, - "data": {}, - "model": "" + "model": "SicSearch" } }, "routers": { - "/commodity": { - "description": "Commodity market data." - }, "/crypto": { "description": "Cryptocurrency market data." }, @@ -39872,9 +28484,6 @@ "/derivatives": { "description": "Derivatives market data." }, - "/econometrics": { - "description": "Econometrics analysis tools." - }, "/economy": { "description": "Economic data." }, @@ -39893,14 +28502,8 @@ "/news": { "description": "Financial market news data." }, - "/quantitative": { - "description": "Quantitative analysis tools." - }, "/regulators": { "description": "Financial market regulators data." - }, - "/technical": { - "description": "Technical Analysis tools." } } } \ No newline at end of file From 3d608ba8d8909141ad94c3b464e444a2d05d0815 Mon Sep 17 00:00:00 2001 From: hjoaquim Date: Mon, 13 May 2024 09:56:07 +0100 Subject: [PATCH 5/9] unnecessary line break removed --- cli/openbb_cli/controllers/cli_controller.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cli/openbb_cli/controllers/cli_controller.py b/cli/openbb_cli/controllers/cli_controller.py index 45bd9441f656..2a98389067b6 100644 --- a/cli/openbb_cli/controllers/cli_controller.py +++ b/cli/openbb_cli/controllers/cli_controller.py @@ -477,7 +477,7 @@ def call_exe(self, other_args: List[str]): except FileNotFoundError: session.console.print( - f"[red]File '{routine_path}' doesn't exist.[/red]\n" + f"[red]File '{routine_path}' doesn't exist.[/red]" ) return From 5a21e95050fd9dabdcfe6cb6e3e618ddc0aa9357 Mon Sep 17 00:00:00 2001 From: hjoaquim Date: Mon, 13 May 2024 12:35:46 +0100 Subject: [PATCH 6/9] better handling of obbjects before printing/table/chart also fixes the sheet_name issue when writing to excel --- .../argparse_translator/obbject_registry.py | 4 +- .../controllers/base_platform_controller.py | 90 ++++++++++--------- 2 files changed, 52 insertions(+), 42 deletions(-) diff --git a/cli/openbb_cli/argparse_translator/obbject_registry.py b/cli/openbb_cli/argparse_translator/obbject_registry.py index 1c4cbf80dd9d..e1c73fd0c127 100644 --- a/cli/openbb_cli/argparse_translator/obbject_registry.py +++ b/cli/openbb_cli/argparse_translator/obbject_registry.py @@ -18,12 +18,14 @@ def _contains_obbject(uuid: str, obbjects: List[OBBject]) -> bool: """Check if obbject with uuid is in the registry.""" return any(obbject.id == uuid for obbject in obbjects) - def register(self, obbject: OBBject): + def register(self, obbject: OBBject) -> bool: """Designed to add an OBBject instance to the registry.""" if isinstance(obbject, OBBject) and not self._contains_obbject( obbject.id, self._obbjects ): self._obbjects.append(obbject) + return True + return False def get(self, idx: int) -> OBBject: """Return the obbject at index idx.""" diff --git a/cli/openbb_cli/controllers/base_platform_controller.py b/cli/openbb_cli/controllers/base_platform_controller.py index c154baa56cd0..b6d2baa6d82a 100644 --- a/cli/openbb_cli/controllers/base_platform_controller.py +++ b/cli/openbb_cli/controllers/base_platform_controller.py @@ -153,54 +153,63 @@ def method(self, other_args: List[str], translator=translator): ns_parser = self._intersect_data_processing_commands(ns_parser) obbject = translator.execute_func(parsed_args=ns_parser) - df: pd.DataFrame = None + df: pd.DataFrame = pd.DataFrame() fig: OpenBBFigure = None title = f"{self.PATH}{translator.func.__name__}" if obbject: - if session.max_obbjects_exceeded(): - session.obbject_registry.remove() - - # use the obbject to store the command so we can display it later on results - obbject.extra["command"] = f"{title} {' '.join(other_args)}" - - session.obbject_registry.register(obbject) - # we need to force to re-link so that the new obbject - # is immediately available for data processing commands - self._link_obbject_to_data_processing_commands() - # also update the completer - self.update_completer(self.choices_default) - - if session.settings.SHOW_MSG_OBBJECT_REGISTRY and isinstance( - obbject, OBBject - ): - session.console.print("Added OBBject to registry.") - - if hasattr(ns_parser, "chart") and ns_parser.chart: - obbject.show() - fig = obbject.chart.fig - if hasattr(obbject, "to_dataframe"): + + if isinstance(obbject, OBBject) and obbject.results: + if session.max_obbjects_exceeded(): + session.obbject_registry.remove() + session.console.print( + "[yellow]Maximum number of OBBjects reached. The oldest entry was removed.[yellow]" + ) + + # use the obbject to store the command so we can display it later on results + obbject.extra["command"] = f"{title} {' '.join(other_args)}" + + register_result = session.obbject_registry.register(obbject) + + # we need to force to re-link so that the new obbject + # is immediately available for data processing commands + self._link_obbject_to_data_processing_commands() + # also update the completer + self.update_completer(self.choices_default) + + if ( + session.settings.SHOW_MSG_OBBJECT_REGISTRY + and register_result + ): + session.console.print("Added OBBject to registry.") + + if hasattr(ns_parser, "chart") and ns_parser.chart: + obbject.show() + fig = obbject.chart.fig + else: + if isinstance(df.columns, pd.RangeIndex): + df.columns = [str(i) for i in df.columns] + + print_rich_table(df=df, show_index=True, title=title) + df = obbject.to_dataframe() + elif isinstance(obbject, dict): df = pd.DataFrame.from_dict(obbject, orient="index") - else: - df = None + print_rich_table(df=df, show_index=True, title=title) - elif hasattr(obbject, "to_dataframe"): - df = obbject.to_dataframe() - if isinstance(df.columns, pd.RangeIndex): - df.columns = [str(i) for i in df.columns] - print_rich_table(df=df, show_index=True, title=title) + elif not isinstance(obbject, OBBject): + session.console.print(obbject) - elif isinstance(obbject, dict): - df = pd.DataFrame.from_dict(obbject, orient="index") - print_rich_table(df=df, show_index=True, title=title) + if ( + hasattr(ns_parser, "export") + and ns_parser.export + and not df.empty + ): + if sheet_name := getattr(ns_parser, "sheet_name", None): + if isinstance(sheet_name, list): + sheet_name = sheet_name[0] - elif obbject: - session.console.print(obbject) - - if hasattr(ns_parser, "export") and ns_parser.export: - sheet_name = getattr(ns_parser, "sheet_name", None) export_data( export_type=",".join(ns_parser.export), dir_path=os.path.dirname(os.path.abspath(__file__)), @@ -209,10 +218,9 @@ def method(self, other_args: List[str], translator=translator): sheet_name=sheet_name, figure=fig, ) - - if session.max_obbjects_exceeded(): + elif hasattr(ns_parser, "export") and ns_parser.export and df.empty: session.console.print( - "[yellow]\nMaximum number of OBBjects reached. The oldest entry was removed.[yellow]" + "[yellow]No data to export. Please make sure to run a command that generates data first.[/yellow]" ) except Exception as e: From a5d577d2260136135f4856953f23a84f2d4ca38e Mon Sep 17 00:00:00 2001 From: hjoaquim Date: Mon, 13 May 2024 12:50:17 +0100 Subject: [PATCH 7/9] fix linting; also, dataframe creation in the right place --- .../controllers/base_platform_controller.py | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/cli/openbb_cli/controllers/base_platform_controller.py b/cli/openbb_cli/controllers/base_platform_controller.py index b6d2baa6d82a..6b9584e5dabd 100644 --- a/cli/openbb_cli/controllers/base_platform_controller.py +++ b/cli/openbb_cli/controllers/base_platform_controller.py @@ -183,6 +183,10 @@ def method(self, other_args: List[str], translator=translator): ): session.console.print("Added OBBject to registry.") + # making the dataframe available + # either for printing or exporting (or both) + df = obbject.to_dataframe() + if hasattr(ns_parser, "chart") and ns_parser.chart: obbject.show() fig = obbject.chart.fig @@ -192,8 +196,6 @@ def method(self, other_args: List[str], translator=translator): print_rich_table(df=df, show_index=True, title=title) - df = obbject.to_dataframe() - elif isinstance(obbject, dict): df = pd.DataFrame.from_dict(obbject, orient="index") print_rich_table(df=df, show_index=True, title=title) @@ -206,9 +208,10 @@ def method(self, other_args: List[str], translator=translator): and ns_parser.export and not df.empty ): - if sheet_name := getattr(ns_parser, "sheet_name", None): - if isinstance(sheet_name, list): - sheet_name = sheet_name[0] + if hasattr(ns_parser, "sheet_name") and isinstance( + ns_parser.sheet_name, list + ): + sheet_name = ns_parser.sheet_name[0] export_data( export_type=",".join(ns_parser.export), @@ -219,9 +222,7 @@ def method(self, other_args: List[str], translator=translator): figure=fig, ) elif hasattr(ns_parser, "export") and ns_parser.export and df.empty: - session.console.print( - "[yellow]No data to export. Please make sure to run a command that generates data first.[/yellow]" - ) + session.console.print("[yellow]No data to export.[/yellow]") except Exception as e: session.console.print(f"[red]{e}[/]\n") From 45bfac29bb22540e524d24c6c6f0a73f381cab1d Mon Sep 17 00:00:00 2001 From: hjoaquim Date: Tue, 14 May 2024 01:12:17 +0100 Subject: [PATCH 8/9] proper handling of sheet name --- cli/openbb_cli/controllers/base_platform_controller.py | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/cli/openbb_cli/controllers/base_platform_controller.py b/cli/openbb_cli/controllers/base_platform_controller.py index 6b9584e5dabd..27c6516a838a 100644 --- a/cli/openbb_cli/controllers/base_platform_controller.py +++ b/cli/openbb_cli/controllers/base_platform_controller.py @@ -189,7 +189,7 @@ def method(self, other_args: List[str], translator=translator): if hasattr(ns_parser, "chart") and ns_parser.chart: obbject.show() - fig = obbject.chart.fig + fig = obbject.chart.fig if obbject.chart else None else: if isinstance(df.columns, pd.RangeIndex): df.columns = [str(i) for i in df.columns] @@ -208,10 +208,9 @@ def method(self, other_args: List[str], translator=translator): and ns_parser.export and not df.empty ): - if hasattr(ns_parser, "sheet_name") and isinstance( - ns_parser.sheet_name, list - ): - sheet_name = ns_parser.sheet_name[0] + sheet_name = getattr(ns_parser, "sheet_name", None) + if sheet_name and isinstance(sheet_name, list): + sheet_name = sheet_name[0] export_data( export_type=",".join(ns_parser.export), From 955d19c5580c1ac1c7232a6427aad0e02a541831 Mon Sep 17 00:00:00 2001 From: hjoaquim Date: Tue, 14 May 2024 01:19:57 +0100 Subject: [PATCH 9/9] orient to columns instead --- cli/openbb_cli/controllers/base_platform_controller.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cli/openbb_cli/controllers/base_platform_controller.py b/cli/openbb_cli/controllers/base_platform_controller.py index 27c6516a838a..8ac12f4ed569 100644 --- a/cli/openbb_cli/controllers/base_platform_controller.py +++ b/cli/openbb_cli/controllers/base_platform_controller.py @@ -197,7 +197,7 @@ def method(self, other_args: List[str], translator=translator): print_rich_table(df=df, show_index=True, title=title) elif isinstance(obbject, dict): - df = pd.DataFrame.from_dict(obbject, orient="index") + df = pd.DataFrame.from_dict(obbject, orient="columns") print_rich_table(df=df, show_index=True, title=title) elif not isinstance(obbject, OBBject):