get_dataflow_dimensions

Dataflow parameters and possible values.

Returns an OBBject containing either a JSON dictionary of parameters and their options, or a markdown string under the 'results' attribute.

Examples

from openbb import obb
# Get parameters for the 'CPI' dataflow.
imf_params = obb.imf.utils.get_dataflow_dimensions('CPI')
print(imf_params.results)
# Get parameters for the 'GFS_BS' dataflow in markdown format.
obb.imf_utils.get_dataflow_dimensions(dataflow_id='GFS_BS', output_format='markdown')
# Get parameters for the 'IL' dataflow in JSON format.
obb.imf_utils.get_dataflow_dimensions(dataflow_id='IL', output_format='json')

Parameters

• standard

dataflow_id: str
The IMF dataflow ID. Use list_dataflows() to see available dataflows.

output_format: Literal['json', 'markdown']
Default: json

---

Returns

results: Any

Serializable results.

provider: str

Provider name.

warnings: Optional[list[Warning_]]

list of warnings.

chart: Optional[Chart]

Chart object.

extra: dict[str, Any]

Extra info.

---