diff options
Diffstat (limited to 'openbb_platform/openbb/assets/reference.json')
| -rw-r--r-- | openbb_platform/openbb/assets/reference.json | 53755 |
1 files changed, 27183 insertions, 26572 deletions
diff --git a/openbb_platform/openbb/assets/reference.json b/openbb_platform/openbb/assets/reference.json index 7b753ba76ee..8356e399770 100644 --- a/openbb_platform/openbb/assets/reference.json +++ b/openbb_platform/openbb/assets/reference.json @@ -1,26584 +1,27195 @@ { - "/crypto/price/historical": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Get historical price data for cryptocurrency pair(s) within a provider.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.crypto.price.historical(symbol='BTCUSD', provider='fmp')\nobb.crypto.price.historical(symbol='BTCUSD', start_date='2024-01-01', end_date='2024-01-31', provider='fmp')\nobb.crypto.price.historical(symbol='BTCUSD,ETHUSD', start_date='2024-01-01', end_date='2024-01-31', provider='polygon')\n# Get monthly historical prices from Yahoo Finance for Ethereum.\nobb.crypto.price.historical(symbol='ETH-USD', interval=1m, start_date='2024-01-01', end_date='2024-12-31', provider='yfinance')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", - "default": "", - "optional": false - }, - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp', 'polygon', 'tiingo', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "interval", - "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - } - ], - "polygon": [ - { - "name": "interval", - "type": "str", - "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", - "default": "1d", - "optional": true - }, - { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", - "default": "asc", - "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 49999, - "optional": true - } - ], - "tiingo": [ - { - "name": "interval", - "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - }, - { - "name": "exchanges", - "type": "List[str]", - "description": "To limit the query to a subset of exchanges e.g. ['POLONIEX', 'GDAX']", - "default": null, - "optional": true - } - ], - "yfinance": [ - { - "name": "interval", - "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[CryptoHistorical]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'polygon', 'tiingo', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "Union[date, datetime]", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "open", - "type": "float", - "description": "The open price.", - "default": "", - "optional": false - }, - { - "name": "high", - "type": "float", - "description": "The high price.", - "default": "", - "optional": false - }, - { - "name": "low", - "type": "float", - "description": "The low price.", - "default": "", - "optional": false - }, - { - "name": "close", - "type": "float", - "description": "The close price.", - "default": "", - "optional": false - }, - { - "name": "volume", - "type": "float", - "description": "The trading volume.", - "default": "", - "optional": false - }, - { - "name": "vwap", - "type": "Annotated[float, Gt(gt=0)]", - "description": "Volume Weighted Average Price over the period.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "adj_close", - "type": "float", - "description": "The adjusted close price.", - "default": null, - "optional": true - }, - { - "name": "change", - "type": "float", - "description": "Change in the price from the previous close.", - "default": null, - "optional": true - }, - { - "name": "change_percent", - "type": "float", - "description": "Change in the price from the previous close, as a normalized percent.", - "default": null, - "optional": true - } - ], - "polygon": [ - { - "name": "transactions", - "type": "Annotated[int, Gt(gt=0)]", - "description": "Number of transactions for the symbol in the time period.", - "default": null, - "optional": true - } - ], - "tiingo": [ - { - "name": "transactions", - "type": "int", - "description": "Number of transactions for the symbol in the time period.", - "default": null, - "optional": true - }, - { - "name": "volume_notional", - "type": "float", - "description": "The last size done for the asset on the specific date in the quote currency. The volume of the asset on the specific date in the quote currency.", - "default": null, - "optional": true - } - ], - "yfinance": [] - }, - "model": "CryptoHistorical" - }, - "/crypto/search": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Search available cryptocurrency pairs within a provider.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.crypto.search(provider='fmp')\nobb.crypto.search(query='BTCUSD', provider='fmp')\n```\n\n", - "parameters": { - "standard": [ - { - "name": "query", - "type": "str", - "description": "Search query.", - "default": null, - "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[CryptoSearch]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol representing the entity requested in the data. (Crypto)", - "default": "", - "optional": false - }, - { - "name": "name", - "type": "str", - "description": "Name of the crypto.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "currency", - "type": "str", - "description": "The currency the crypto trades for.", - "default": null, - "optional": true - }, - { - "name": "exchange", - "type": "str", - "description": "The exchange code the crypto trades on.", - "default": null, - "optional": true - }, - { - "name": "exchange_name", - "type": "str", - "description": "The short name of the exchange the crypto trades on.", - "default": null, - "optional": true - } - ] - }, - "model": "CryptoSearch" - }, - "/currency/price/historical": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Currency Historical Price. Currency historical data.\n\nCurrency historical prices refer to the past exchange rates of one currency against\nanother over a specific period.\nThis data provides insight into the fluctuations and trends in the foreign exchange market,\nhelping analysts, traders, and economists understand currency performance,\nevaluate economic health, and make predictions about future movements.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.currency.price.historical(symbol='EURUSD', provider='fmp')\n# Filter historical data with specific start and end date.\nobb.currency.price.historical(symbol='EURUSD', start_date='2023-01-01', end_date='2023-12-31', provider='fmp')\n# Get data with different granularity.\nobb.currency.price.historical(symbol='EURUSD', provider='polygon', interval=15m)\n```\n\n", - "parameters": { - "standard": [ - { - "name": "symbol", - "type": "Union[str, List[str]]", - "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", - "default": "", - "optional": false - }, - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, - "optional": true - }, - { - "name": "provider", - "type": "Literal['fmp', 'polygon', 'tiingo', 'yfinance']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [ - { - "name": "interval", - "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - } - ], - "polygon": [ - { - "name": "interval", - "type": "str", - "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", - "default": "1d", - "optional": true - }, - { - "name": "sort", - "type": "Literal['asc', 'desc']", - "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", - "default": "asc", - "optional": true - }, - { - "name": "limit", - "type": "int", - "description": "The number of data entries to return.", - "default": 49999, - "optional": true - } - ], - "tiingo": [ - { - "name": "interval", - "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - } - ], - "yfinance": [ - { - "name": "interval", - "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", - "description": "Time interval of the data to return.", - "default": "1d", - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[CurrencyHistorical]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'polygon', 'tiingo', 'yfinance']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "date", - "type": "Union[date, datetime]", - "description": "The date of the data.", - "default": "", - "optional": false - }, - { - "name": "open", - "type": "float", - "description": "The open price.", - "default": "", - "optional": false - }, - { - "name": "high", - "type": "float", - "description": "The high price.", - "default": "", - "optional": false - }, - { - "name": "low", - "type": "float", - "description": "The low price.", - "default": "", - "optional": false - }, - { - "name": "close", - "type": "float", - "description": "The close price.", - "default": "", - "optional": false - }, - { - "name": "volume", - "type": "float", - "description": "The trading volume.", - "default": null, - "optional": true - }, - { - "name": "vwap", - "type": "Annotated[float, Gt(gt=0)]", - "description": "Volume Weighted Average Price over the period.", - "default": null, - "optional": true - } - ], - "fmp": [ - { - "name": "adj_close", - "type": "float", - "description": "The adjusted close price.", - "default": null, - "optional": true - }, - { - "name": "change", - "type": "float", - "description": "Change in the price from the previous close.", - "default": null, - "optional": true - }, - { - "name": "change_percent", - "type": "float", - "description": "Change in the price from the previous close, as a normalized percent.", - "default": null, - "optional": true - } - ], - "polygon": [ - { - "name": "transactions", - "type": "Annotated[int, Gt(gt=0)]", - "description": "Number of transactions for the symbol in the time period.", - "default": null, - "optional": true - } - ], - "tiingo": [], - "yfinance": [] - }, - "model": "CurrencyHistorical" - }, - "/currency/search": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Currency Search.\n\nSearch available currency pairs.\nCurrency pairs are the national currencies from two countries coupled for trading on\nthe foreign exchange (FX) marketplace.\nBoth currencies will have exchange rates on which the trade will have its position basis.\nAll trading within the forex market, whether selling, buying, or trading, will take place through currency pairs.\n(ref: Investopedia)\nMajor currency pairs include pairs such as EUR/USD, USD/JPY, GBP/USD, etc.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.currency.search(provider='intrinio')\n# Search for 'EURUSD' currency pair using 'intrinio' as provider.\nobb.currency.search(provider='intrinio', symbol=EURUSD)\n# Search for actively traded currency pairs on the queried date using 'polygon' as provider.\nobb.currency.search(provider='polygon', date=2024-01-02, active=True)\n# Search for terms using 'polygon' as provider.\nobb.currency.search(provider='polygon', search=Euro zone)\n```\n\n", - "parameters": { - "standard": [ - { - "name": "provider", - "type": "Literal['fmp', 'intrinio', 'polygon']", - "description": "The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.", - "default": "fmp", - "optional": true - } - ], - "fmp": [], - "intrinio": [], - "polygon": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol of the pair to search.", - "default": null, - "optional": true - }, - { - "name": "date", - "type": "Union[date, str]", - "description": "A specific date to get data for.", - "default": null, - "optional": true - }, - { - "name": "search", - "type": "str", - "description": "Search for terms within the ticker and/or company name.", - "default": "", - "optional": true - }, - { - "name": "active", - "type": "bool", - "description": "Specify if the tickers returned should be actively traded on the queried date.", - "default": true, - "optional": true - }, - { - "name": "order", - "type": "Literal['asc', 'desc']", - "description": "Order data by ascending or descending.", - "default": "asc", - "optional": true - }, - { - "name": "sort", - "type": "Literal['ticker', 'name', 'market', 'locale', 'currency_symbol', 'currency_name', 'base_currency_symbol', 'base_currency_name', 'last_updated_utc', 'delisted_utc']", - "description": "Sort field used for ordering.", - "default": "", - "optional": true - }, - { - "name": "limit", - "type": "Annotated[int, Gt(gt=0)]", - "description": "The number of data entries to return.", - "default": 1000, - "optional": true - } - ] - }, - "returns": { - "OBBject": [ - { - "name": "results", - "type": "List[CurrencyPairs]", - "description": "Serializable results." - }, - { - "name": "provider", - "type": "Optional[Literal['fmp', 'intrinio', 'polygon']]", - "description": "Provider name." - }, - { - "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." - }, - { - "name": "chart", - "type": "Optional[Chart]", - "description": "Chart object." - }, - { - "name": "extra", - "type": "Dict[str, Any]", - "description": "Extra info." - } - ] - }, - "data": { - "standard": [ - { - "name": "name", - "type": "str", - "description": "Name of the currency pair.", - "default": "", - "optional": false - } - ], - "fmp": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol of the currency pair.", - "default": "", - "optional": false - }, - { - "name": "currency", - "type": "str", - "description": "Base currency of the currency pair.", - "default": "", - "optional": false - }, - { - "name": "stock_exchange", - "type": "str", - "description": "Stock exchange of the currency pair.", - "default": null, - "optional": true - }, - { - "name": "exchange_short_name", - "type": "str", - "description": "Short name of the stock exchange of the currency pair.", - "default": null, - "optional": true - } - ], - "intrinio": [ - { - "name": "code", - "type": "str", - "description": "Code of the currency pair.", - "default": "", - "optional": false - }, - { - "name": "base_currency", - "type": "str", - "description": "ISO 4217 currency code of the base currency.", - "default": "", - "optional": false - }, - { - "name": "quote_currency", - "type": "str", - "description": "ISO 4217 currency code of the quote currency.", - "default": "", - "optional": false - } - ], - "polygon": [ - { - "name": "market", - "type": "str", - "description": "Name of the trading market. Always 'fx'.", - "default": "", - "optional": false - }, - { - "name": "locale", - "type": "str", - "description": "Locale of the currency pair.", - "default": "", - "optional": false - }, - { - "name": "currency_symbol", - "type": "str", - "description": "The symbol of the quote currency.", - "default": null, - "optional": true - }, - { - "name": "currency_name", - "type": "str", - "description": "Name of the quote currency.", - "default": null, - "optional": true - }, - { - "name": "base_currency_symbol", - "type": "str", - "description": "The symbol of the base currency.", - "default": null, - "optional": true - }, - { - "name": "base_currency_name", - "type": "str", - "description": "Name of the base currency.", - "default": null, - "optional": true - }, - { - "name": "last_updated_utc", - "type": "datetime", - "description": "The last updated timestamp in UTC.", - "default": "", - "optional": false - }, - { - "name": "delisted_utc", - "type": "datetime", - "description": "The delisted timestamp in UTC.", - "default": null, - "optional": true - } - ] - }, - "model": "CurrencyPairs" - }, - "/currency/snapshots": { - "deprecated": { - "flag": null, - "message": null - }, - "description": "Snapshots of |