diff options
Diffstat (limited to 'openbb_platform/openbb/assets/reference.json')
-rw-r--r-- | openbb_platform/openbb/assets/reference.json | 2801 |
1 files changed, 2127 insertions, 674 deletions
diff --git a/openbb_platform/openbb/assets/reference.json b/openbb_platform/openbb/assets/reference.json index 61835911e88..bb5ee238f37 100644 --- a/openbb_platform/openbb/assets/reference.json +++ b/openbb_platform/openbb/assets/reference.json @@ -1,36 +1,36 @@ { - "openbb": "4.2.1", + "openbb": "4.2.2", "info": { "title": "OpenBB Platform (Python)", "description": "Investment research for everyone, anywhere.", - "core": "1.2.3", + "core": "1.2.4", "extensions": { "openbb_core_extension": [ - "commodity@1.1.1", - "crypto@1.2.1", - "currency@1.2.1", - "derivatives@1.2.1", - "economy@1.2.1", - "equity@1.2.1", - "etf@1.2.1", - "fixedincome@1.2.1", - "index@1.2.1", - "news@1.2.1", - "regulators@1.2.1" + "commodity@1.1.2", + "crypto@1.2.2", + "currency@1.2.2", + "derivatives@1.2.2", + "economy@1.2.2", + "equity@1.2.2", + "etf@1.2.2", + "fixedincome@1.2.2", + "index@1.2.2", + "news@1.2.2", + "regulators@1.2.2" ], "openbb_provider_extension": [ - "benzinga@1.2.1", - "econdb@1.1.1", - "federal_reserve@1.2.1", - "fmp@1.2.1", - "fred@1.2.1", - "intrinio@1.2.1", - "oecd@1.2.1", - "polygon@1.2.1", - "sec@1.2.1", - "tiingo@1.2.1", - "tradingeconomics@1.2.1", - "yfinance@1.2.1" + "benzinga@1.2.2", + "econdb@1.1.2", + "federal_reserve@1.2.2", + "fmp@1.2.2", + "fred@1.2.2", + "intrinio@1.2.2", + "oecd@1.2.2", + "polygon@1.2.2", + "sec@1.2.2", + "tiingo@1.2.2", + "tradingeconomics@1.2.2", + "yfinance@1.2.2" ], "openbb_obbject_extension": [] } @@ -72,8 +72,8 @@ { "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", + "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, m, p.", + "default": null, "optional": true } ], @@ -308,8 +308,8 @@ { "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": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, m, p.", + "default": null, "optional": true } ], @@ -428,8 +428,8 @@ { "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", + "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, m, p.", + "default": null, "optional": true } ], @@ -639,8 +639,8 @@ { "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", + "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, m, p.", + "default": null, "optional": true } ], @@ -845,8 +845,8 @@ { "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", + "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, m, p.", + "default": null, "optional": true } ], @@ -1199,9 +1199,9 @@ }, { "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['intrinio', 'yfinance']", + "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: i, n, t, r, i, n, i, o.", + "default": null, "optional": true } ], @@ -1214,7 +1214,8 @@ "optional": true, "choices": null } - ] + ], + "yfinance": [] }, "returns": { "OBBject": [ @@ -1225,7 +1226,7 @@ }, { "name": "provider", - "type": "Optional[Literal['intrinio']]", + "type": "Optional[Literal['intrinio', 'yfinance']]", "description": "Provider name." }, { @@ -1601,6 +1602,32 @@ "optional": true, "choices": null } + ], + "yfinance": [ + { + "name": "dte", + "type": "int", + "description": "Days to expiration.", + "default": null, + "optional": true, + "choices": null + }, + { + "name": "in_the_money", + "type": "bool", + "description": "Whether the option is in the money.", + "default": null, + "optional": true, + "choices": null + }, + { + "name": "last_trade_timestamp", + "type": "datetime", + "description": "Timestamp for when the option was last traded.", + "default": null, + "optional": true, + "choices": null + } ] }, "model": "OptionsChains" @@ -1625,8 +1652,8 @@ { "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", + "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: i, n, t, r, i, n, i, o.", + "default": null, "optional": true } ], @@ -1866,8 +1893,8 @@ { "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", + "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: y, f, i, n, a, n, c, e.", + "default": null, "optional": true } ], @@ -1994,8 +2021,8 @@ { "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", + "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: y, f, i, n, a, n, c, e.", + "default": null, "optional": true } ], @@ -2097,8 +2124,8 @@ { "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", + "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: o, e, c, d.", + "default": null, "optional": true } ], @@ -2201,8 +2228,8 @@ { "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", + "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: o, e, c, d.", + "default": null, "optional": true } ], @@ -2305,15 +2332,15 @@ { "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", + "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: o, e, c, d.", + "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']", + "type": "Literal['G20', 'G7', 'argentina', 'australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'colombia', 'costa_rica', 'croatia', 'czech_republic', 'denmark', 'estonia', 'euro_area_20', '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, @@ -2401,8 +2428,8 @@ { "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", + "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, m, p.", + "default": null, "optional": true } ], @@ -2911,15 +2938,80 @@ "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", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.cpi(country='japan,china,turkey', provider='fred')\n# Use the `transform` parameter to define the reference period for the change in values. Default is YoY.\nobb.economy.cpi(country='united_states,united_kingdom', transform='period', 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, + "description": "The country to get data. Multiple items allowed for provider(s): fred, oecd.", + "default": "united_states", + "optional": true, + "choices": null + }, + { + "name": "transform", + "type": "Literal['index', 'yoy', 'period']", + "description": "Transformation of the CPI data. Period represents the change since previous. Defaults to change from one year ago (yoy).", + "default": "yoy", + "optional": true, + "choices": [ + "index", + "yoy", + "period" + ] + }, + { + "name": "frequency", + "type": "Literal['annual', 'quarter', 'monthly']", + "description": "The frequency of the data.", + "default": "monthly", + "optional": true, + "choices": [ + "annual", + "quarter", + "monthly" + ] + }, + { + "name": "harmonized", + "type": "bool", + "description": "If true, returns harmonized data.", + "default": false, + "optional": true, + "choices": null + }, + { + "name": "start_date", + "type": "Union[date, str]", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": null + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": null + }, + { + "name": "provider", + "type": "Literal['fred', 'oecd']", + "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, r, e, d.", + "default": null, + "optional": true + } + ], + "fred": [ + { + "name": "country", + "type": "str", + "description": "The country to get data.", + "default": "united_states", + "optional": true, "choices": [ "australia", "austria", @@ -2971,56 +3063,111 @@ "united_kingdom", "united_states" ] - }, - { - "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, - "choices": null - }, - { - "name": "frequency", - "type": "Literal['monthly', 'quarter', 'annual']", - "description": "The frequency of the data. Options: `monthly`, `quarter`, and `annual`.", - "default": "monthly", - "optional": true, - "choices": null - }, - { - "name": "harmonized", - "type": "bool", - "description": "Whether you wish to obtain harmonized data.", - "default": false, - "optional": true, - "choices": null - }, + } + ], + "oecd": [ { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, + "name": "country", + "type": "str", + "description": "Country to get CPI for. This is the list of OECD supported countries", + "default": "united_states", "optional": true, - "choices": null + "choices": [ + "G20", + "G7", + "argentina", + "australia", + "austria", + "belgium", + "brazil", + "canada", + "chile", + "china", + "colombia", + "costa_rica", + "czech_republic", + "denmark", + "estonia", + "euro_area_20", + "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", + "russia", + "saudi_arabia", + "slovak_republic", + "slovenia", + "south_africa", + "spain", + "sweden", + "switzerland", + "turkey", + "united_kingdom", + "united_states", + "all" + ] }, { - "name": "end_date", - "type": "Union[date, str]", - "description": "End date of the data, in YYYY-MM-DD format.", - "default": null, + "name": "expenditure", + "type": "Literal['total', 'all', 'actual_rentals', 'alcoholic_beverages_tobacco_narcotics', 'all_non_food_non_energy', 'clothing_footwear', 'communication', 'education', 'electricity_gas_other_fuels', 'energy', 'overall_excl_energy_food_alcohol_tobacco', 'food_non_alcoholic_beverages', 'fuels_lubricants_personal', 'furniture_household_equipment', 'goods', 'housing', 'housing_excluding_rentals', 'housing_water_electricity_gas', 'health', 'imputed_rentals', 'maintenance_repair_dwelling', 'miscellaneous_goods_services', 'recreation_culture', 'residuals', 'restaurants_hotels', 'services_less_housing', 'services_less_house_excl_rentals', 'services', 'transport', 'water_supply_other_services']", + "description": "Expenditure component of CPI.", + "default": "total", "optional": true, - "choices": 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 + "choices": [ + "total", + "food_non_alcoholic_beverages", + "alcoholic_beverages_tobacco_narcotics", + "clothing_footwear", + "housing_water_electricity_gas", + "furniture_household_equipment", + "health", + "transport", + "communication", + "recreation_culture", + "education", + "restaurants_hotels", + "miscellaneous_goods_services", + "energy", + "goods", + "housing", + "housing_excluding_rentals", + "all_non_food_non_energy", + "services_less_housing", + "services_less_house_excl_rentals", + "services", + "overall_excl_energy_food_alcohol_tobacco", + "residuals", + "fuels_lubricants_personal", + "actual_rentals", + "imputed_rentals", + "maintenance_repair_dwelling", + "water_supply_other_services", + "electricity_gas_other_fuels", + "all" + ] } - ], - "fred": [] + ] }, "returns": { "OBBject": [ @@ -3031,7 +3178,7 @@ }, { "name": "provider", - "type": "Optional[Literal['fred']]", + "type": "Optional[Literal['fred', 'oecd']]", "description": "Provider name." }, { @@ -3060,9 +3207,35 @@ "default": "", "optional": false, "choices": null + }, + { + "name": "country", + "type": "str", + "description": "None", + "default": "", + "optional": false, + "choices": null + }, + { + "name": "value", + "type": "float", + "description": "CPI index value or period change.", + "default": "", + "optional": false, + "choices": null } ], - "fred": [] + "fred": [], + "oecd": [ + { + "name": "expenditure", + "type": "str", + "description": "Expenditure component of CPI.", + "default": "", + "optional": false, + "choices": null + } + ] }, "model": "ConsumerPriceIndex" }, @@ -3078,8 +3251,8 @@ { "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": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, m, p.", + "default": null, "optional": true } ], @@ -3165,8 +3338,8 @@ { "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", + "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, r, e, d.", + "default": null, "optional": true } ], @@ -3421,8 +3594,8 @@ { "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", + "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, r, e, d.", + "default": null, "optional": true } ], @@ -3742,8 +3915,8 @@ { "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", + "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, r, e, d.", + "default": null, "optional": true } ], @@ -3890,8 +4063,8 @@ { "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", + "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, e, d, e, r, a, l, _, r, e, s, e, r, v, e.", + "default": null, "optional": true } ], @@ -4003,10 +4176,30 @@ "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", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.unemployment(provider='oecd')\nobb.economy.unemployment(country='all', frequency='quarter', provider='oecd')\n# Demographics for the statistics are selected with the `age` parameter.\nobb.economy.unemployment(country='all', frequency='quarter', age=25-54, 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): oecd.", + "default": "united_states", + "optional": true, + "choices": null + }, + { + "name": "frequency", + "type": "Literal['monthly', 'quarter', 'annual']", + "description": "The frequency of the data.", + "default": "monthly", + "optional": true, + "choices": [ + "monthly", + "quarter", + "annual" + ] + }, + { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", @@ -4025,19 +4218,65 @@ { "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.", - |