The API endpoint is the following:
https://goadmin.ifrc.org/api/v2/country/
Variable Code | Data Type | Accept Null Value | Description | Filtering available in API |
---|---|---|---|---|
iso | str | True | ISO 3166-1 alpha-2 Country Code. Not all countries/geographical entities have an ISO related code, e.g. Aksai Chin, Africa Region. Null values represented as None. | False |
iso3 | str | True | ISO 3166-1 alpha-3 Country Code. Null values represented as None. | False |
society_url | str | True | National Society Webpage. Null values are represented as empty strings | False |
region | int | True | IFRC region associated to geographical identity. 0: Africa, 1: Americas, 2: Asia Pacific, 3: Europe, 4: Middle East and North Africa. Null values are represented as Nan | True |
key_priorities | True | False | ||
inform_score | float | False | False | |
id | int | True | Unique ID for a country in GO | False |
url_ifrc | str | False | URL for geographic entity on the IFRC website. Null values are represented as empty strings. | False |
record_type | int | False | GO type of geographical entity. 1: country,2: cluster, 3: region | True |
record_type_display | str | True | GO type record of geographical entity. | False |
bbox | dict | True | Bounding box coordinates for zooming maps to extent. Not all countries/ geographical entities have a related bbox, e.g. Aksai Chin, Bangkok | |
centroid | dict | False | Centroid coordinates for map points. Not all countries/ geographical entities have a related centroid. Null values are represented as None. | |
independent | bool | True | Id the geographical entity an independent state? Regions and country clusters are nullable. Null values are represented as None. | True |
is_depreciated | bool | False | Has the geographical entity been depreciated? e.g. replaced by an updated boundary | True |
fdrs | str | True | FDRS country code. Not all countries/ geographical entities have a related FDRS country code. Null values are represented as None. | False |
name | str | False | Geographical entity name. In the variable ‘record_type_display’ appears the types of geographical entities reported. | True |
society_name | str | True | National society name associated to geographical entity. Not all countries/ geographical entities have a related National Society name. Null values represented as empty strings. | False |
overview | str | True | Overview of the geographical entity and their activities. Most of the countries/ geographical entities do not have an associated overview. Null values represented as None. | False |
region
: You can filter the API endpoint to fetch results for a specific region. Here for example we search for results in Africa. e.g.: https://goadmin.ifrc.org/api/v2/country/?region=0
record_type
: You can filter the results for countries, clusters or region. e.g.: https://goadmin.ifrc.org/api/v2/country/?record_type=2
independent
: This filter allows to search for countries that are independent. e.g.: https://goadmin.ifrc.org/api/v2/country/?is_independent=true
is_depreciated
: This filter is used to search for depreciated geographical entity. e.g.: https://goadmin.ifrc.org/api/v2/country/?is_deprecated=true
name
: You can filter the table through a general search. e.g.: https://goadmin.ifrc.org/api/v2/country/?search=nigeria