summaryrefslogtreecommitdiffstats
path: root/openbb_platform/openbb/assets/reference.json
diff options
context:
space:
mode:
Diffstat (limited to 'openbb_platform/openbb/assets/reference.json')
-rw-r--r--openbb_platform/openbb/assets/reference.json7552
1 files changed, 5336 insertions, 2216 deletions
diff --git a/openbb_platform/openbb/assets/reference.json b/openbb_platform/openbb/assets/reference.json
index 6b304444527..bdbae0cf973 100644
--- a/openbb_platform/openbb/assets/reference.json
+++ b/openbb_platform/openbb/assets/reference.json
@@ -19,14 +19,14 @@
"name": "start_date",
"type": "Union[date, str]",
"description": "Start date of the data, in YYYY-MM-DD format.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "end_date",
"type": "Union[date, str]",
"description": "End date of the data, in YYYY-MM-DD format.",
- "default": "None",
+ "default": null,
"optional": true
},
{
@@ -65,7 +65,7 @@
"name": "limit",
"type": "int",
"description": "The number of data entries to return.",
- "default": "49999",
+ "default": 49999,
"optional": true
}
],
@@ -81,7 +81,7 @@
"name": "exchanges",
"type": "List[str]",
"description": "To limit the query to a subset of exchanges e.g. ['POLONIEX', 'GDAX']",
- "default": "None",
+ "default": null,
"optional": true
}
],
@@ -96,7 +96,33 @@
]
},
"returns": {
- "OBBject": "OBBject\n results : CryptoHistorical\n Serializable results.\n provider : Literal['fmp', 'polygon', 'tiingo', 'yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n"
+ "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": [
@@ -144,9 +170,9 @@
},
{
"name": "vwap",
- "type": "float, Gt(gt=0)",
+ "type": "Annotated[float, Gt(gt=0)]",
"description": "Volume Weighted Average Price over the period.",
- "default": "None",
+ "default": null,
"optional": true
}
],
@@ -155,30 +181,30 @@
"name": "adj_close",
"type": "float",
"description": "The adjusted close price.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "change",
"type": "float",
"description": "Change in the price from the previous close.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "change_percent",
"type": "float",
"description": "Change in the price from the previous close, as a normalized percent.",
- "default": "None",
+ "default": null,
"optional": true
}
],
"polygon": [
{
"name": "transactions",
- "type": "int, Gt(gt=0)",
+ "type": "Annotated[int, Gt(gt=0)]",
"description": "Number of transactions for the symbol in the time period.",
- "default": "None",
+ "default": null,
"optional": true
}
],
@@ -187,14 +213,14 @@
"name": "transactions",
"type": "int",
"description": "Number of transactions for the symbol in the time period.",
- "default": "None",
+ "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": "None",
+ "default": null,
"optional": true
}
],
@@ -215,7 +241,7 @@
"name": "query",
"type": "str",
"description": "Search query.",
- "default": "None",
+ "default": null,
"optional": true
},
{
@@ -229,7 +255,33 @@
"fmp": []
},
"returns": {
- "OBBject": "OBBject\n results : CryptoSearch\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n"
+ "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": [
@@ -244,7 +296,7 @@
"name": "name",
"type": "str",
"description": "Name of the crypto.",
- "default": "None",
+ "default": null,
"optional": true
}
],
@@ -253,21 +305,21 @@
"name": "currency",
"type": "str",
"description": "The currency the crypto trades for.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "exchange",
"type": "str",
"description": "The exchange code the crypto trades on.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "exchange_name",
"type": "str",
"description": "The short name of the exchange the crypto trades on.",
- "default": "None",
+ "default": null,
"optional": true
}
]
@@ -294,14 +346,14 @@
"name": "start_date",
"type": "Union[date, str]",
"description": "Start date of the data, in YYYY-MM-DD format.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "end_date",
"type": "Union[date, str]",
"description": "End date of the data, in YYYY-MM-DD format.",
- "default": "None",
+ "default": null,
"optional": true
},
{
@@ -340,7 +392,7 @@
"name": "limit",
"type": "int",
"description": "The number of data entries to return.",
- "default": "49999",
+ "default": 49999,
"optional": true
}
],
@@ -364,7 +416,33 @@
]
},
"returns": {
- "OBBject": "OBBject\n results : CurrencyHistorical\n Serializable results.\n provider : Literal['fmp', 'polygon', 'tiingo', 'yfinance']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n"
+ "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": [
@@ -407,14 +485,14 @@
"name": "volume",
"type": "float",
"description": "The trading volume.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "vwap",
- "type": "float, Gt(gt=0)",
+ "type": "Annotated[float, Gt(gt=0)]",
"description": "Volume Weighted Average Price over the period.",
- "default": "None",
+ "default": null,
"optional": true
}
],
@@ -423,30 +501,30 @@
"name": "adj_close",
"type": "float",
"description": "The adjusted close price.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "change",
"type": "float",
"description": "Change in the price from the previous close.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "change_percent",
"type": "float",
"description": "Change in the price from the previous close, as a normalized percent.",
- "default": "None",
+ "default": null,
"optional": true
}
],
"polygon": [
{
"name": "transactions",
- "type": "int, Gt(gt=0)",
+ "type": "Annotated[int, Gt(gt=0)]",
"description": "Number of transactions for the symbol in the time period.",
- "default": "None",
+ "default": null,
"optional": true
}
],
@@ -479,14 +557,14 @@
"name": "symbol",
"type": "str",
"description": "Symbol of the pair to search.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "date",
"type": "Union[date, str]",
"description": "A specific date to get data for.",
- "default": "None",
+ "default": null,
"optional": true
},
{
@@ -500,7 +578,7 @@
"name": "active",
"type": "bool",
"description": "Specify if the tickers returned should be actively traded on the queried date.",
- "default": "True",
+ "default": true,
"optional": true
},
{
@@ -519,15 +597,41 @@
},
{
"name": "limit",
- "type": "int, Gt(gt=0)",
+ "type": "Annotated[int, Gt(gt=0)]",
"description": "The number of data entries to return.",
- "default": "1000",
+ "default": 1000,
"optional": true
}
]
},
"returns": {
- "OBBject": "OBBject\n results : CurrencyPairs\n Serializable results.\n provider : Literal['fmp', 'intrinio', 'polygon']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n"
+ "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": [
@@ -558,14 +662,14 @@
"name": "stock_exchange",
"type": "str",
"description": "Stock exchange of the currency pair.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "exchange_short_name",
"type": "str",
"description": "Short name of the stock exchange of the currency pair.",
- "default": "None",
+ "default": null,
"optional": true
}
],
@@ -611,28 +715,28 @@
"name": "currency_symbol",
"type": "str",
"description": "The symbol of the quote currency.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "currency_name",
"type": "str",
"description": "Name of the quote currency.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "base_currency_symbol",
"type": "str",
"description": "The symbol of the base currency.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "base_currency_name",
"type": "str",
"description": "Name of the base currency.",
- "default": "None",
+ "default": null,
"optional": true
},
{
@@ -646,7 +750,7 @@
"name": "delisted_utc",
"type": "datetime",
"description": "The delisted timestamp in UTC.",
- "default": "None",
+ "default": null,
"optional": true
}
]
@@ -680,7 +784,7 @@
"name": "counter_currencies",
"type": "Union[str, List[str]]",
"description": "An optional list of counter currency symbols to filter for. None returns all.",
- "default": "None",
+ "default": null,
"optional": true
},
{
@@ -694,7 +798,33 @@
"fmp": []
},
"returns": {
- "OBBject": "OBBject\n results : CurrencySnapshots\n Serializable results.\n provider : Literal['fmp']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n"
+ "OBBject": [
+ {
+ "name": "results",
+ "type": "List[CurrencySnapshots]",
+ "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": [
@@ -723,42 +853,42 @@
"name": "open",
"type": "float",
"description": "The open price.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "high",
"type": "float",
"description": "The high price.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "low",
"type": "float",
"description": "The low price.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "close",
"type": "float",
"description": "The close price.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "volume",
"type": "int",
"description": "The trading volume.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "prev_close",
"type": "float",
"description": "The previous close price.",
- "default": "None",
+ "default": null,
"optional": true
}
],
@@ -767,49 +897,49 @@
"name": "change",
"type": "float",
"description": "The change in the price from the previous close.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "change_percent",
"type": "float",
"description": "The change in the price from the previous close, as a normalized percent.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "ma50",
"type": "float",
"description": "The 50-day moving average.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "ma200",
"type": "float",
"description": "The 200-day moving average.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "year_high",
"type": "float",
"description": "The 52-week high.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "year_low",
"type": "float",
"description": "The 52-week low.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "last_rate_timestamp",
"type": "datetime",
"description": "The timestamp of the last rate.",
- "default": "None",
+ "default": null,
"optional": true
}
]
@@ -845,13 +975,39 @@
"name": "date",
"type": "Union[date, str]",
"description": "The end-of-day date for options chains data.",
- "default": "None",
+ "default": null,
"optional": true
}
]
},
"returns": {
- "OBBject": "OBBject\n results : OptionsChains\n Serializable results.\n provider : Literal['intrinio']\n Provider name.\n warnings : Optional[List[Warning_]]\n List of warnings.\n chart : Optional[Chart]\n Chart object.\n extra : Dict[str, Any]\n Extra info.\n"
+ "OBBject": [
+ {
+ "name": "results",
+ "type": "List[OptionsChains]",
+ "description": "Serializable results."
+ },
+ {
+ "name": "provider",
+ "type": "Optional[Literal['intrinio']]",
+ "description": "Provider name."
+ },
+ {
+ "name": "warnings",
+ "type": "Optional[List[Warning_]]",
+ "description": "List of warnings."
+ },
+ {
+ "name": "chart",
+ "type": "Optional[Chart]",
+ "description": "Chart object."
+ },
+ {
+ "name": "extra",
+ "type": "Dict[str, Any]",
+ "description": "Extra info."
+ }
+ ]
},
"data": {
"standard": [
@@ -859,7 +1015,7 @@
"name": "symbol",
"type": "str",
"description": "Symbol representing the entity requested in the data. Here, it is the underlying symbol for the option.",
- "default": "None",
+ "default": null,
"optional": true
},
{
@@ -873,7 +1029,7 @@
"name": "eod_date",
"type": "date",
"description": "Date for which the options chains are returned.",
- "default": "None",
+ "default": null,
"optional": true
},
{
@@ -901,259 +1057,259 @@
"name": "open_interest",
"type": "int",
"description": "Open interest on the contract.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "volume",
"type": "int",
"description": "The trading volume.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "theoretical_price",
"type": "float",
"description": "Theoretical value of the option.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "last_trade_price",
"type": "float",
"description": "Last trade price of the option.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "tick",
"type": "str",
"description": "Whether the last tick was up or down in price.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "bid",
"type": "float",
"description": "Current bid price for the option.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "bid_size",
"type": "int",
"description": "Bid size for the option.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "ask",
"type": "float",
"description": "Current ask price for the option.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "ask_size",
"type": "int",
"description": "Ask size for the option.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "mark",
"type": "float",
"description": "The mid-price between the latest bid and ask.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "open",
"type": "float",
"description": "The open price.",
- "default": "None",
+ "default": null,
"optional": true
},
{
"name": "open_bid",