get_dataflow_parameters

Dataflow parameters and possible dimension values.

Returns an OBBject with either a JSON dict or markdown string under results.

Examples

from openbb import obb
# Get parameters for the 'DF_PRICES_ALL' dataflow in markdown.
obb.oecd.get_dataflow_parameters(dataflow_id='DF_PRICES_ALL', output_format='markdown')
# Get parameters for the 'DF_CLI' dataflow as JSON.
obb.oecd.get_dataflow_parameters(dataflow_id='DF_CLI', output_format='json')
# Inspect dimensions of the 'DF_QNA' dataflow.
params = obb.oecd.utils.get_dataflow_parameters('DF_QNA')
print(params.results)

Parameters

• standard

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

output_format: str
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.

---