summaryrefslogtreecommitdiffstats
path: root/website/content/excel/openapi.json
diff options
context:
space:
mode:
Diffstat (limited to 'website/content/excel/openapi.json')
-rw-r--r--website/content/excel/openapi.json15151
1 files changed, 11295 insertions, 3856 deletions
diff --git a/website/content/excel/openapi.json b/website/content/excel/openapi.json
index 3406f7eb77e..c434db86d9f 100644
--- a/website/content/excel/openapi.json
+++ b/website/content/excel/openapi.json
@@ -2,7 +2,7 @@
"openapi": "3.1.0",
"info": {
"title": "OpenBB Platform API",
- "description": "This is the OpenBB Platform API.",
+ "description": "Investment research for everyone, anywhere.",
"termsOfService": "http://example.com/terms/",
"contact": {
"name": "OpenBB Team",
@@ -13,7 +13,7 @@
"name": "MIT",
"url": "https://github.com/OpenBB-finance/OpenBB/blob/develop/LICENSE"
},
- "version": "4.1.6"
+ "version": "4.2.1"
},
"paths": {
"/api/v1/crypto/price/historical": {
@@ -50,10 +50,12 @@
"schema": {
"type": "string",
"description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed for provider(s): fmp, polygon.",
- "multiple_items_allowed": [
- "fmp",
- "polygon"
- ],
+ "fmp": {
+ "multiple_items_allowed": true
+ },
+ "polygon": {
+ "multiple_items_allowed": true
+ },
"title": "Symbol"
},
"description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed for provider(s): fmp, polygon."
@@ -377,10 +379,12 @@
"schema": {
"type": "string",
"description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed for provider(s): fmp, polygon.",
- "multiple_items_allowed": [
- "fmp",
- "polygon"
- ],
+ "fmp": {
+ "multiple_items_allowed": true
+ },
+ "polygon": {
+ "multiple_items_allowed": true
+ },
"title": "Symbol"
},
"description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed for provider(s): fmp, polygon."
@@ -588,153 +592,22 @@
}
},
{
- "name": "symbol",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "polygon",
- "description": "Symbol of the pair to search. (provider: polygon)"
- },
- "description": "Symbol of the pair to search. (provider: polygon)"
- },
- {
- "name": "date",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "date"
- },
- {
- "type": "null"
- }
- ],
- "title": "polygon",
- "description": "A specific date to get data for. (provider: polygon)"
- },
- "description": "A specific date to get data for. (provider: polygon)"
- },
- {
- "name": "search",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "polygon",
- "description": "Search for terms within the ticker and/or company name. (provider: polygon)",
- "default": ""
- },
- "description": "Search for terms within the ticker and/or company name. (provider: polygon)"
- },
- {
- "name": "active",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "polygon",
- "description": "Specify if the tickers returned should be actively traded on the queried date. (provider: polygon)",
- "default": true
- },
- "description": "Specify if the tickers returned should be actively traded on the queried date. (provider: polygon)"
- },
- {
- "name": "order",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "enum": [
- "asc",
- "desc"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "polygon",
- "description": "Order data by ascending or descending. (provider: polygon)",
- "default": "asc"
- },
- "description": "Order data by ascending or descending. (provider: polygon)"
- },
- {
- "name": "sort",
+ "name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
- "enum": [
- "ticker",
- "name",
- "market",
- "locale",
- "currency_symbol",
- "currency_name",
- "base_currency_symbol",
- "base_currency_name",
- "last_updated_utc",
- "delisted_utc"
- ],
"type": "string"
},
{
"type": "null"
}
],
- "title": "polygon",
- "description": "Sort field used for ordering. (provider: polygon)",
- "default": ""
- },
- "description": "Sort field used for ordering. (provider: polygon)"
- },
- {
- "name": "limit",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "integer",
- "exclusiveMinimum": 0
- },
- {
- "type": "null"
- }
- ],
- "title": "polygon",
- "description": "The number of data entries to return. (provider: polygon)",
- "default": 1000
+ "description": "Query to search for currency pairs.",
+ "title": "Query"
},
- "description": "The number of data entries to return. (provider: polygon)"
+ "description": "Query to search for currency pairs."
}
],
"responses": {
@@ -787,35 +660,25 @@
{
"scope": "api",
"parameters": {
- "provider": "intrinio"
+ "provider": "fmp"
},
- "provider": "intrinio"
+ "provider": "fmp"
},
{
"scope": "api",
- "description": "Search for 'EURUSD' currency pair using 'intrinio' as provider.",
+ "description": "Search for 'EUR' currency pair using 'intrinio' as provider.",
"parameters": {
"provider": "intrinio",
- "symbol": "EURUSD"
+ "query": "EUR"
},
"provider": "intrinio"
},
{
"scope": "api",
- "description": "Search for actively traded currency pairs on the queried date using 'polygon' as provider.",
- "parameters": {
- "provider": "polygon",
- "date": "2024-01-02",
- "active": 1.0
- },
- "provider": "polygon"
- },
- {
- "scope": "api",
"description": "Search for terms using 'polygon' as provider.",
"parameters": {
"provider": "polygon",
- "search": "Euro zone"
+ "query": "EUR"
},
"provider": "polygon"
}
@@ -828,7 +691,7 @@
"currency"
],
"summary": "Reference Rates",
- "description": "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.",
+ "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.",
"operationId": "currency_reference_rates",
"security": [
{
@@ -925,14 +788,13 @@
{
"name": "provider",
"in": "query",
- "required": false,
+ "required": true,
"schema": {
"enum": [
- "fmp"
+ "fmp",
+ "polygon"
],
- "const": "fmp",
"type": "string",
- "default": "fmp",
"title": "Provider"
}
},
@@ -942,14 +804,17 @@
"required": false,
"schema": {
"type": "string",
- "description": "The base currency symbol. Multiple comma separated items allowed for provider(s): fmp.",
- "multiple_items_allowed": [
- "fmp"
- ],
+ "description": "The base currency symbol. Multiple comma separated items allowed for provider(s): fmp, polygon.",
+ "fmp": {
+ "multiple_items_allowed": true
+ },
+ "polygon": {
+ "multiple_items_allowed": true
+ },
"default": "usd",
"title": "Base"
},
- "description": "The base currency symbol. Multiple comma separated items allowed for provider(s): fmp."
+ "description": "The base currency symbol. Multiple comma separated items allowed for provider(s): fmp, polygon."
},
{
"name": "quote_type",
@@ -974,15 +839,15 @@
"schema": {
"anyOf": [
{
+ "type": "string"
+ },
+ {
"type": "array",
"items": {
"type": "string"
}
},
{
- "type": "string"
- },
- {
"type": "null"
}
],
@@ -1324,10 +1189,10 @@
"schema": {
"anyOf": [
{
- "type": "number"
+ "type": "integer"
},
{
- "type": "integer"
+ "type": "number"
},
{
"type": "null"
@@ -1345,10 +1210,10 @@
"schema": {
"anyOf": [
{
- "type": "number"
+ "type": "integer"
},
{
- "type": "integer"
+ "type": "number"
},
{
"type": "null"
@@ -1438,6 +1303,7 @@
{
"scope": "api",
"parameters": {
+ "symbol": "TSLA",
"provider": "intrinio"
},
"provider": "intrinio"
@@ -1460,7 +1326,7 @@
"economy"
],
"summary": "Forecast",
- "description": "Forecasted GDP Data.",
+ "description": "Get Forecasted GDP Data.",
"operationId": "economy_gdp_forecast",
"security": [
{
@@ -1693,7 +1559,7 @@
"economy"
],
"summary": "Nominal",
- "description": "Nominal GDP Data.",
+ "description": "Get Nominal GDP Data.",
"operationId": "economy_gdp_nominal",
"security": [
{
@@ -1900,7 +1766,7 @@
"economy"
],
"summary": "Real",
- "description": "Real GDP Data.",
+ "description": "Get Real GDP Data.",
"operationId": "economy_gdp_real",
"security": [
{
@@ -2193,9 +2059,208 @@
],
"title": "tradingeconomics",
"description": "Country of the event. Multiple comma separated items allowed. (provider: tradingeconomics)",
- "multiple_items_allowed": [
- "tradingeconomics"
- ]
+ "choices": [
+ "afghanistan",
+ "albania",
+ "algeria",
+ "andorra",
+ "angola",
+ "antigua_and_barbuda",
+ "argentina",
+ "armenia",
+ "aruba",
+ "australia",
+ "austria",
+ "azerbaijan",
+ "bahamas",
+ "bahrain",
+ "bangladesh",
+ "barbados",
+ "belarus",
+ "belgium",
+ "belize",
+ "benin",
+ "bermuda",
+ "bhutan",
+ "bolivia",
+ "bosnia_and_herzegovina",
+ "botswana",
+ "brazil",
+ "brunei",
+ "bulgaria",
+ "burkina_faso",
+ "burundi",
+ "cambodia",
+ "cameroon",
+ "canada",
+ "cape_verde",
+ "cayman_islands",
+ "central_african_republic",
+ "chad",
+ "chile",
+ "china",
+ "colombia",
+ "comoros",
+ "congo",
+ "costa_rica",
+ "croatia",
+ "cuba",
+ "cyprus",
+ "czech_republic",
+ "denmark",
+ "djibouti",
+ "dominica",
+ "dominican_republic",
+ "east_timor",
+ "ecuador",
+ "egypt",
+ "el_salvador",
+ "equatorial_guinea",
+ "eritrea",
+ "estonia",
+ "ethiopia",
+ "euro_area",
+ "faroe_islands",
+ "fiji",
+ "finland",
+ "france",
+ "gabon",
+ "gambia",
+ "georgia",
+ "germany",
+ "ghana",
+ "greece",
+ "grenada",
+ "guatemala",
+ "guinea",
+ "guinea_bissau",
+ "guyana",
+ "haiti",
+ "honduras",
+ "hong_kong",
+ "hungary",
+ "iceland",
+ "india",
+ "indonesia",
+ "iran",
+ "iraq",
+ "ireland",
+ "isle_of_man",
+ "israel",
+ "italy",
+ "ivory_coast",
+ "jamaica",
+ "japan",
+ "jordan",
+ "kazakhstan",
+ "kenya",
+ "kiribati",
+ "kosovo",
+ "kuwait",
+ "kyrgyzstan",
+ "laos",
+ "latvia",
+ "lebanon",
+ "lesotho",
+ "liberia",
+ "libya",
+ "liechtenstein",
+ "lithuania",
+ "luxembourg",
+ "macao",
+ "madagascar",
+ "malawi",
+ "malaysia",
+ "maldives",
+ "mali",
+ "malta",
+ "mauritania",
+ "mauritius",
+ "mexico",
+ "moldova",
+ "monaco",
+ "mongolia",
+ "montenegro",
+ "morocco",
+ "mozambique",
+ "myanmar",
+ "namibia",
+ "nepal",
+ "netherlands",
+ "new_caledonia",
+ "new_zealand",
+ "nicaragua",
+ "niger",
+ "nigeria",
+ "north_korea",
+ "north_macedonia",
+ "norway",
+ "oman",
+ "pakistan",
+ "palestine",
+ "panama",
+ "papua_new_guinea",
+ "paraguay",
+ "peru",
+ "philippines",
+ "poland",
+ "portugal",
+ "puerto_rico",
+ "qatar",
+ "republic_of_the_congo",
+ "romania",
+ "russia",
+ "rwanda",
+ "samoa",
+ "sao_tome_and_principe",
+ "saudi_arabia",
+ "senegal",
+ "serbia",
+ "seychelles",
+ "sierra_leone",
+ "singapore",
+ "slovakia",
+ "slovenia",
+ "solomon_islands",
+ "somalia",
+ "south_africa",
+ "south_korea",
+ "south_sudan",
+ "spain",
+ "sri_lanka",
+ "sudan",
+ "suriname",
+ "swaziland",
+ "sweden",
+ "switzerland",
+ "syria",
+ "taiwan",
+ "tajikistan",
+ "tanzania",
+ "thailand",
+ "togo",
+ "tonga",
+ "trinidad_and_tobago",
+ "tunisia",
+ "turkey",
+ "turkmenistan",
+ "uganda",
+ "ukraine",
+ "united_arab_emirates",
+ "united_kingdom",
+ "united_states",
+ "uruguay",
+ "uzbekistan",
+ "vanuatu",
+ "venezuela",
+ "vietnam",
+ "yemen",
+ "zambia",
+ "zimbabwe"
+ ],
+ "tradingeconomics": {
+ "multiple_items_allowed": true
+ }
},
"description": "Country of the event. Multiple comma separated items allowed. (provider: tradingeconomics)"
},
@@ -2207,9 +2272,9 @@
"anyOf": [
{
"enum": [
- "Low",
- "Medium",
- "High"
+ "low",
+ "medium",
+ "high"
],
"type": "string"
},
@@ -2218,7 +2283,12 @@
}
],
"title": "tradingeconomics",
- "description": "Importance of the event. (provider: tradingeconomics)"
+ "description": "Importance of the event. (provider: tradingeconomics)",
+ "choices": [
+ "low",
+ "medium",
+ "high"
+ ]
},
"description": "Importance of the event. (provider: tradingeconomics)"
},
@@ -2230,7 +2300,7 @@
"anyOf": [
{
"enum": [
- "interest rate",
+ "interest_rate",
"inflation",
"bonds",
"consumer",
@@ -2251,9 +2321,48 @@
}
],
"title": "tradingeconomics",
- "description": "Grouping of events (provider: tradingeconomics)"
+ "description": "Grouping of events. (provider: tradingeconomics)",
+ "choices": [
+ "interest_rate",
+ "inflation",
+ "bonds",
+ "consumer",
+ "gdp",
+ "government",
+ "housing",
+ "labour",
+ "markets",
+ "money",
+ "prices",
+ "trade",
+ "business"
+ ]
+ },
+ "description": "Grouping of events. (provider: tradingeconomics)"
+ },
+ {
+ "name": "calendar_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "tradingeconomics",
+ "description": "Get events by TradingEconomics Calendar ID. Multiple comma separated items allowed. (provider: tradingeconomics)",
+ "tradingeconomics": {
+ "multiple_items_allowed": true
+ }
},
- "description": "Grouping of events (provider: tradingeconomics)"
+ "description": "Get events by TradingEconomics Calendar ID. Multiple comma separated items allowed. (provider: tradingeconomics)"
}
],
"responses": {
@@ -2329,7 +2438,7 @@
"economy"
],
"summary": "Cpi",
- "description": "Consumer Price Index (CPI). Returns either the rescaled index value, or a rate of change (inflation).",
+ "description": "Get Consumer Price Index (CPI).\n\nReturns either the rescaled index value, or a rate of change (inflation).",
"operationId": "economy_cpi",
"security": [
{
@@ -2409,9 +2518,9 @@
"united_kingdom",
"united_states"
],
- "multiple_items_allowed": [
- "fred"
- ],
+ "fred": {
+ "multiple_items_allowed": true
+ },
"title": "Country"
},
"description": "The country to get data. Multiple comma separated items allowed for provider(s): fred."
@@ -2575,7 +2684,7 @@
"economy"
],
"summary": "Risk Premium",
- "description": "Market Risk Premium by country.",
+ "description": "Get Market Risk Premium by country.",
"operationId": "economy_risk_premium",
"security": [
{
@@ -2672,14 +2781,13 @@
{
"name": "provider",
"in": "query",
- "required": false,
+ "required": true,
"schema": {
"enum": [
- "ecb"
+ "ecb",
+ "fred"
],
- "const": "ecb",
"type": "string",
- "default": "ecb",
"title": "Provider"
}
},
@@ -2725,25 +2833,121 @@
"in": "query",
"required": false,
"schema": {
- "enum": [
- "brazil",
- "canada",
- "china",
- "eu_ex_euro_area",
- "eu_institutions",
- "india",
- "japan",
- "russia",
- "switzerland",
- "united_kingdom",
- "united_states",
- "total",
- null
+ "anyOf": [
+ {
+ "enum": [
+ "brazil",
+ "canada",
+ "china",
+ "eu_ex_euro_area",
+ "eu_institutions",
+ "india",
+ "japan",
+ "russia",
+ "switzerland",
+ "united_kingdom",
+ "united_states",
+ "total",
+ null
+ ]
+ },
+ {
+ "enum": [
+ "argentina",
+ "australia",
+ "austria",
+ "belgium",
+ "brazil",
+ "canada",
+ "chile",
+ "china",
+ "colombia",
+ "costa_rica",
+ "czechia",
+ "denmark",
+ "estonia",
+ "finland",
+ "france",
+ "germany",
+ "greece",
+ "hungary",
+ "iceland",
+ "india",
+ "indonesia",
+ "ireland",
+ "israel",
+ "italy",
+ "japan",
+ "korea",
+ "latvia",
+ "lithuania",
+ "luxembourg",
+ "mexico",
+ "netherlands",
+ "new_zealand",
+ "norway",
+ "poland",
+ "portugal",
+ "russia",
+ "saudi_arabia",
+ "slovak_republic",
+ "slovenia",
+ "south_africa",
+ "spain",
+ "sweden",
+ "switzerland",
+ "turkey",
+ "united_kingdom",
+ "united_states",
+ "g7",
+ "g20"
+ ],
+ "type": "string"
+ }
],
- "title": "ecb",
- "description": "The country/region of the data. This parameter will override the 'report_type' parameter. (provider: ecb)"
+ "title": "ecb,fred",
+ "description": "The country/region of the data. This parameter will override the 'report_type' parameter. (provider: ecb);\n The country to get data. Enter as a 3-letter ISO country code, default is USA. (provider: fred)",
+ "choices": "argentina,australia,austria,belgium,brazil,canada,chile,china,colombia,costa_rica,czechia,denmark,estonia,finland,france,germany,greece,hungary,iceland,india,indonesia,ireland,israel,italy,japan,korea,latvia,lithuania,luxembourg,mexico,netherlands,new_zealand,norway,poland,portugal,russia,saudi_arabia,slovak_republic,slovenia,south_africa,spain,sweden,switzerland,turkey,united_kingdom,united_states,g7,g20"
},
- "description": "The country/region of the data. This parameter will override the 'report_type' parameter. (provider: ecb)"
+ "description": "The country/region of the data. This parameter will override the 'report_type' parameter. (provider: ecb);\n The country to get data. Enter as a 3-letter ISO country code, default is USA. (provider: fred)"
+ },
+ {
+ "name": "start_date",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "fred",
+ "description": "Start date of the data, in YYYY-MM-DD format. (provider: fred)"
+ },
+ "description": "Start date of the data, in YYYY-MM-DD format. (provider: fred)"
+ },
+ {
+ "name": "end_date",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "fred",
+ "description": "End date of the data, in YYYY-MM-DD format. (provider: fred)"
+ },
+ "description": "End date of the data, in YYYY-MM-DD format. (provider: fred)"
}
],
"responses": {
@@ -2796,6 +3000,21 @@
{
"scope": "api",
"parameters": {
+ "provider": "fred"