Disasters
Disaster records (reliefweb.int/disasters) used to group related reports and provide situational overviews (name, glide, status, country, primary_country, type, primary_type).
- Endpoint:
POSTorGET https://api.reliefweb.int/v2/disasters - Single disaster:
GET https://api.reliefweb.int/v2/disasters/{id|uuid}
Defaults
Requests to /v2/disasters default to profile=minimal and preset=minimal. Single-record requests (/v2/disasters/{id}) default to profile=default and preset=minimal. See Choose fields and presets.
Profiles
| Profile | Fields |
|---|---|
minimal |
name
|
list |
name, url, date.created, status, glide, type.name, country.name
|
suggest |
name (sets slim)
|
full |
All fields |
default |
All fields |
Add more with fields.include.
Presets
| Preset | Status filter | Sort | Default query fields |
|---|---|---|---|
minimal |
alert, current, past |
n/a | name |
latest |
alert, current, past |
date.created:desc |
name, status, glide, description, type, country |
analysis |
alert, alert-archive, archive, current, past |
n/a | name, glide, description, type, country, status |
Available fields
| Name | Description | Type | Attributes |
|---|---|---|---|
country |
Shortcut for country - defaults to country.name | string | searchable facetable exact multi common |
country.id |
Id for country used by ReliefWeb | integer | searchable facetable |
country.iso3 |
ISO 3166-1 alpha-3 code | string | searchable facetable exact |
country.name |
Name of country in English | string | searchable facetable exact |
country.primary |
Flag to indicate this is the primary country | boolean | |
country.shortname |
Short name of country where applicable, for example 'Syria' for 'Syrian Arab Republic' | string | searchable facetable exact |
current |
Deprecated | boolean | sortable facetable |
date |
Shortcut for date - defaults to date.created | object | searchable facetable |
date.changed |
Date entry modified on ReliefWeb (ISO 8601) | date | sortable facetable |
date.created |
Date entry created on ReliefWeb (ISO 8601) | date | sortable facetable |
date.event |
Date when the disaster occurred (ISO 8601) | date | sortable facetable |
description |
Description of the disaster in Markdown format | string | searchable |
description-html |
Description of the disaster in HTML format | string | |
featured |
Flag to indicate if the disaster is featured on ReliefWeb home page | boolean | sortable facetable |
glide |
Global IDEntifier number (GLIDE) of the disaster | string | searchable sortable exact |
id |
Unique id of disaster used by ReliefWeb | integer | searchable sortable |
name |
Name of the disaster | string | searchable sortable exact |
name.collation_en |
Name field for English collation-aware sorting | string | sortable |
primary_country |
Shortcut for primary country - defaults to primary_country.name | string | searchable facetable exact multi common |
primary_country.id |
Id of primary country used by ReliefWeb | integer | searchable sortable facetable |
primary_country.iso3 |
ISO 3166-1 alpha-3 code | string | searchable sortable facetable exact |
primary_country.name |
Link for more information | string | searchable sortable facetable exact |
primary_country.shortname |
Short name of country where applicable, for example 'Syria' for 'Syrian Arab Republic' | string | searchable sortable facetable exact |
primary_type |
Shortcut for primary disaster type - defaults to primary_type.name | string | searchable facetable exact multi common |
primary_type.code |
Code of the primary disaster type | string | searchable sortable facetable |
primary_type.id |
Id for primary disaster type used by ReliefWeb | integer | searchable facetable |
primary_type.name |
Name of primary disaster type | string | searchable sortable facetable exact |
profile |
defaults to profile.overview | string | searchable |
profile.appeals_response_plans |
Appeals and Response Plans for this country | array | |
profile.appeals_response_plans.active |
Array of links for current appeals and plans | array | multi |
profile.appeals_response_plans.active.image |
Current appeal or plan image | string | |
profile.appeals_response_plans.active.title |
Current appeal or plan title | string | |
profile.appeals_response_plans.active.url |
Current appeal or plan url | string | |
profile.appeals_response_plans.archive |
Array of links for archive appeals and plans | array | multi |
profile.appeals_response_plans.archive.image |
Archive appeal or plan image | string | |
profile.appeals_response_plans.archive.title |
Archive appeal or plan title | string | |
profile.appeals_response_plans.archive.url |
Archive appeal or plan url | string | |
profile.appeals_response_plans.title |
"Appeals & Response Plans" | string | |
profile.key_content |
Latest situation reports and analysis | array | |
profile.key_content.active |
Array of links for current key content for the country | array | multi |
profile.key_content.active.image |
Current key content link image | string | |
profile.key_content.active.title |
Current key content link title | string | |
profile.key_content.active.url |
Current key content link url | string | |
profile.key_content.archive |
Array of links for archive key content for the country | array | multi |
profile.key_content.archive.image |
Archive key content link image | string | |
profile.key_content.archive.title |
Archive key content link title | string | |
profile.key_content.archive.url |
Archive key content link url | string | |
profile.key_content.title |
"Key Content" | string | |
profile.overview |
Profile of the country in Markdown format | string | searchable |
profile.overview-html |
Profile of the country in HTML format | string | |
profile.useful_links |
Useful links to external sites | array | |
profile.useful_links.active |
Array of useful links | array | multi |
profile.useful_links.active.image |
Useful link image | string | |
profile.useful_links.active.title |
Useful link title | string | |
profile.useful_links.active.url |
Useful link url | string | |
profile.useful_links.title |
"Useful links" | string | |
redirects |
Previous URL aliases that redirect to this item | string | searchable |
related_glide |
Related Global IDEntifier number (GLIDE) | array | searchable exact |
status |
current', 'alert', 'past' | string | searchable facetable |
type |
Shortcut for disaster type - defaults to type.name | string | searchable facetable exact multi common |
type.code |
Code of disaster type | string | searchable sortable facetable |
type.id |
Id of disaster type used by ReliefWeb | integer | searchable facetable |
type.name |
Link for values | string | searchable facetable exact |
type.primary |
Whether disaster type is primary or not | boolean | |
url |
Canonical url | string | |
url_alias |
Friendly' url of the disaster | string | searchable |
uuid |
UUID of the document or term | string | searchable |