diff options
Diffstat (limited to 'openbb_platform/openbb/assets/reference.json')
| -rw-r--r-- | openbb_platform/openbb/assets/reference.json | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/openbb_platform/openbb/assets/reference.json b/openbb_platform/openbb/assets/reference.json index 94947e5c4eb..004e047344c 100644 --- a/openbb_platform/openbb/assets/reference.json +++ b/openbb_platform/openbb/assets/reference.json @@ -4108,7 +4108,7 @@ "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```\n\n", + "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": [ { @@ -4151,14 +4151,21 @@ { "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.", + "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": "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": "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.", + "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 } |