build_data_url
Construct SDMX REST API data URLs for CSV, JSON, or XML downloads, using dataflow, filters, and time period parameters.
Instructions
Generate final SDMX REST API URLs for data retrieval.
Creates URLs that can be used directly to download data in various formats.
This is the final step in the SDMX query construction process.
Args:
dataflow_id: The dataflow to query
key: The data key (use build_key() to construct), or use filters instead
filters: Dictionary of dimension_id -> code (alternative to key)
start_period: Start of time range (optional)
end_period: End of time range (optional)
format_type: Output format (csv, json, xml)
agency_id: The agency (uses session endpoint if not specified)
endpoint: Optional endpoint key (e.g. "FBOS", "ECB") to target a
specific provider for this call only. Defaults to the session's
current endpoint.
Returns:
Structured result with the complete data URL and usage information
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | No | ||
| filters | No | ||
| endpoint | No | ||
| agency_id | No | ||
| end_period | No | ||
| dataflow_id | Yes | ||
| format_type | No | csv | |
| start_period | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | Yes | SDMX key used | |
| url | Yes | Complete data retrieval URL | |
| note | No | Additional notes (e.g., version resolution) | |
| usage | Yes | Instructions for using the URL | |
| format | Yes | Output format (csv, json, xml) | |
| version | Yes | Resolved dataflow version | |
| time_range | No | Time period filter if specified | |
| dataflow_id | Yes | Dataflow identifier | |
| formats_available | No | Available output formats | |
| dimension_at_observation | Yes | Observation dimension setting |