UNHCR reference vocabulary
unhcr_list_referenceDecode the vocabulary the unhcr_* tools take as input: countries (ISO3, ISO2, UNHCR code, names, UNHCR and UN regions), UNHCR’s regional bureaus, each dataset’s first and latest year, population-type definitions, and the asylum authority, stage, decision-level, and unit codes. Filter countries with name_contains to turn a country name into the ISO3 code that origin and asylum take.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| topic | Yes | countries: every queryable country with its codes, names, and regions. regions: UNHCR's regional bureaus. coverage: first and latest year of each dataset, plus the current nowcast month. population_types: what each population type counts and which output column carries it. asylum_codes: asylum authority, application stage, decision level, and unit codes. | |
| name_contains | No | For topic countries only: keep countries whose names, in UNHCR’s English spelling, contain every word given, ignoring case, accents, and punctuation, or whose ISO3, ISO2, or UNHCR code equals a word ("syria", "turkiye", "britain", "deu"). Words match every name variant UNHCR records, including short and formal names the output does not list. No fuzzy matching. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Present when the call failed. Absent on success. | |
| topic | No | The topic returned. | |
| notice | No | Guidance when name_contains matched nothing or does not apply to the topic. | |
| nowcast | No | Present for topic coverage: the single current-year estimate unhcr_get_population's include_nowcast returns. | |
| regions | No | Present for topic regions. | |
| coverage | No | Present for topic coverage. | |
| countries | No | Present for topic countries, sorted by name. | |
| totalCount | No | Countries returned, after any name_contains filter. | |
| asylum_codes | No | Present for topic asylum_codes. | |
| population_types | No | Present for topic population_types. |