Humanitarianresponse Logo

The APIs short for ‘application programming interface’ provides a read-only access to extract both the content and standard taxonomy from the Humanitarianresponse.info so that the developers community can consume such data and produce custom information products and tools which could be specific to their needs.

The following table lists all the available APIs along with examples to demonstrate how to request the data. The data returned from those APIs is available in JSON format. To view the data returned by the APIs, we advise you to use the JSONView plugin in your browser.

Entry point for APIs

The main path to the API is http://www.humanitarianresponse.info/api/ which lists all the APIs through which the data from the Humanitarianreponse.info platform can be exposed.
 
Item Type Description Examples
Assessments content

All the assessments uploaded by operational offices in the humanitarianresponse.info are available through this API. All related data such as organization, geographic location, methodology, population type, etc. are available from the API.

Note: 'created' and 'changed' date fields provided by default with Drupal and they are stored as UNIX timestamps.

http://www.humanitarianresponse.info/api/v1.0/assessments

Clusters/Sectors (bundles) content

Clusters, sectors or working groups in HR.info are treated as bundles. Using the APIs, once can get all the active cluster or sector in operation or country office.

Note: 'created' and 'changed' date fields provided by default with Drupal and they are stored as UNIX timestamps.

All active clusters and sectors in the current emergency operations;
 
To get active sectors in all emergency operations;
Datasets content

List all the datasets form the COD/FOD registry in HR.info platform

Note: 'created' and 'changed' date fields provided by default with Drupal and they are stored as UNIX timestamps.

Disaster/Glide numbers taxonomy List all the disasters with the glide numbers fom HR.info platform. In the API we are also pulling the disaster 'ID' as primary key from ReliefWeb
List all the glide numbers for ‘current’ disasters
 
Documents content

Extract the documents such as reports, SRP, HNOs and other types from any spaces in the HR.info platform

Note: 'created' and 'changed' date fields provided by default with Drupal and they are stored as UNIX timestamps.

List all documents form HR.info 
 
Get all the documents tagged as HNOs -‘Humanitarian Needs overview' from HR.info
 
 
Get all the documents of documnet type 'Newsletter' for Philippines operation
http://www.humanitarianresponse.info/api/v1.0/documents?filter[operation...
Document Types content The content type documents uploaded by various operations offices such as situation reports, fact sheets, planning, etc. are available via APIs.

http://www.humanitarianresponse.info/api/v1.0/documents

Get all the documents tagged as ‘Strategic Response Plan’ in HR.info;
 
Get all the Situation reports for Sudan operation;
Events/Calendar content

Extract the calendar events from humanitarianresponse.info for a given operation and applying date filters.

Note: 'created' and 'changed' date fields provided by default with Drupal and they are stored as UNIX timestamps.

http://www.humanitarianresponse.info/api/v1.0/events

Get the events for the operation ‘Central African Republic’

Get the list of meetings between Dec, 2014 and Jan 2015 for operation/country Pakistan;

http://www.humanitarianresponse.info/api/v1.0/events?filter[operation]=8...

Functional Role taxonomy Functional roles are defined as taxonomy in humanitarianresponse.info platform. Based on those roles, groups such as IM working groups or GIS working groups can be formed in operation. http://www.humanitarianresponse.info/api/v1.0/functional_roles
Global Clusters taxonomy All the global standard clusters names with standard 3 letter cluster codes are available from the API

http://www.humanitarianresponse.info/api/v1.0/global_clusters/

Indicator domains taxonomy Indicators domains are defined as taxonomy in humanitarianresponse.info platform http://www.humanitarianresponse.info/api/v1.0/indicator_domains
Indicator standards taxonomy Standard indicators set by IASC standard clusters and SPHERE projects are defined as taxonomy in humanitarianresponse.info platform

http://www.humanitarianresponse.info/api/v1.0/indicator_standards

Indicator types taxonomy Indicator types such as Baseline, Outcome, Output and Process are defined as standard taxonomy in humanitarianresponse.info platform http://www.humanitarianresponse.info/api/v1.0/indicator_types
Indicator units taxonomy Units such as Population, Shelters, schools, litres, income, etc. to measure the indicator. These terms are defined as standard taxonomy in humanitarianresponse.info platform.

http://www.humanitarianresponse.info/api/v1.0/indicator_units

Indicators taxonomy Agreed standard indicators available in the Indicator Registry on the website http://www.humanitarianresponse.info/applications/ir/indicators and defined as taxonomy in humanitarianresponse.info platform. http://www.humanitarianresponse.info/api/v1.0/indicators
Infographic Types taxonomy Type of maps and infographics such as 3W, Operational presence, Funding graph, Hazard Maps, etc. These terms are defined as standard taxonomy in humanitarianresponse.info platform. http://www.humanitarianresponse.info/api/v1.0/infographic_types
Maps/Infographics content

List visual products i.e. Maps, Infographics and dashboard uploaded by operational websites.

Note: 'created' and 'changed' date fields provided by default with Drupal and they are stored as UNIX timestamps.

Extract 3W maps form all the operational websites
http://www.humanitarianresponse.info/api/v1.0/infographics?filter[infogr...

List all the Humanitarian Dashboards for Afghanistan operation
http://www.humanitarianresponse.info/api/v1.0/infographics?filter[infogr...
Locations taxonomy

All geographic locations i.e. country names, 2-letters country code (ISO) as Pcode, coordinates (Lat, Long) and administrative levels are available via this API.

All these locations are added as taxonomy in humanitarianresponse.info platform after importing the country specific CODs.

http://www.humanitarianresponse.info/api/v1.0/locations

To get first administrative level i.e. ‘list of provinces’ for Afghanistan, use filters; for admin level 1 use “[admin_level]” and for country use “[parent]” id;
Offices content Offices are Coordination hubs within in operation/country offices and available in the humanitarianresponse.info platform as content type. http://www.humanitarianresponse.info/api/v1.0/offices
Operations content Operations are country or regional offices websites setup as sub-sites within in humanitarianresponse.info platform. For example; the interactive map in https://www.humanitarianresponse.info/operations/ is built using the operations API data.

http://www.humanitarianresponse.info/api/v1.0/operations

Get the list of all active [status set to active in the parameter] regional operations from HR.info;
Organizations taxonomy

Organizations are defined as taxonomy in humanitarianresponse.info platform.

http://www.humanitarianresponse.info/api/v1.0/organizations

To find organization by acronym e.g.SIDA;
 
To find organization by FTS IDID;
 
To get the list of donors use the filter “[type]”;
Organization Types taxonomy All organization types e.g. UN, local NGO, Donors, etc.

http://www.humanitarianresponse.info/api/v1.0/organization_types

Population Types taxonomy Population type such as children, affected population, women, men, host communities, etc. These terms are defined as standard taxonomy in humanitarianresponse.info platform.

http://www.humanitarianresponse.info/api/v1.0/population_types

To find population type ‘Refugees’;
Spaces content Spaces are the subsites within humanitarianresponse.info platform and those are available for global websites such as Gender, Gencap/ProCap, HPC, and Cross cutting issues etc.

http://www.humanitarianresponse.info/api/v1.0/spaces

To find the global space ‘Humanitarian Programme Cycle’;
Themes taxonomy All thematic areas such as Gender, Field coordination, Resilience, Governance, etc. that we use to tag content are defines as taxonomy in humanitarianresponse.info platform. http://www.humanitarianresponse.info/api/v1.0/themes

 

Advance API Parameters

Page: Using page parameter, API will return the specific page in a list query
          Example: http://www.humanitarianresponse.info/api/v1.0/organizations?page=2 will return the data in the second page.
 
Filter: Allows you to filter by specific fields and return results from the list query that match the exact condition of the filter.
          Example: List all the documents tagged as ‘Strategic Response Plan’ by applying the filter ‘document_type’.
          Note: Always put the filter value in brackets e.g. [document_type]
          You can also add an operator to the filter argument. For example, to get all documents published after Jan 1, 2015:
 
Sort: Sort the data returned from the API. To sort the given field in the list in descending order use hyphen i.e. ‘-’
          Example; Sort the organization name ‘label’ in descending order,
 
Fields: Allows you to set which fields should be returned in the results.
          Example: Get the organization name and acronym from the Organization API,
 
Range: Allows you to set how many items you need to return from the list query
          Example: Get names and acronym from the query list for only five organizations
 
Autocomplete: Allows you to retrieve results based on an autocomplete string.
          Example: Get all organizations which name starts with “United”:
          Example: Get all organizations which name contains the word “United”:

 

Example of successful API request listing five global clusters;

{
	data: 
	[
		{
		label: "Camp Coordination / Management",
		acronym: "CCM",
		homepage: "http://www.globalcccmcluster.org"
		},
		{
		label: "Early Recovery",
		acronym: "ERY",
		homepage: "http://www.earlyrecovery.info/"
		},
		{
		label: "Education",
		acronym: "EDU",
		homepage: "http://educationcluster.net/"
		}
	],
	count: 15,
	self: 
	{
	title: "Self",
	href: "http://www.humanitarianresponse.info/api/v1.0/global_clusters"
	},
	next: 
	{
	title: "Next",
	href: "http://www.humanitarianresponse.info/api/v1.0/global_clusters?fields=label%2Cacronym%2Chomepage&range=3&page=2"
	}
}

If you have any questions about the APIs, get in touch with us at help@humanitarianresponse.info.