Export data
export_dataExport normalized humanitarian datasets as CSV, JSON, Markdown, or GeoJSON for download or reuse. Use it when users need filtered raw records ready to paste elsewhere.
Instructions
Export normalized records from any dataset as csv, json, markdown or geojson (geojson only makes sense with group_by set, so rows map to countries). Use this when the user wants raw data to download or paste elsewhere.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| role | No | "asylum" = people hosted IN the country; "origin" = people displaced FROM the country | |
| limit | No | Max rows (default 500) | |
| format | Yes | Serialization format | |
| locale | No | Language of the human-readable text output: "en" (default) or "ar" (Modern Standard Arabic, right-to-left). Structured JSON fields, ISO3 codes and dataset ids stay in English either way. | |
| country | No | Filter by country (name or ISO3) | |
| dataset | Yes | population | demographics | asylum-applications | asylum-decisions | context-indicators | idps | conflict-events | humanitarian-funding | food-security | |
| year_to | No | Last year of the range (default: latest available) | |
| group_by | No | Break rows down per asylum or origin country instead of aggregating | |
| year_from | No | First year of the range (default: 10 years back) | |
| include_codebook | No | Attach a codebook documenting every exported variable (meaning, unit, derivation) — ready for a paper's data appendix. Default false. | |
| include_manifest | No | Attach an extraction manifest (exact arguments, timestamp, server version, citation) for reproducibility. Default true. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| format | Yes | ||
| dataset | Yes | ||
| codebook | No | ||
| manifest | No | ||
| row_count | Yes | ||
| truncated | Yes |