GLOBE API

 

The GLOBE API has been built to support developers who would like to retrieve GLOBE data from a programmatic interface.  The API provides fast access to GLOBE data through a variety of API calls including the ability to find data by protocol, date, latitude/longitude, country and more.  Each API call is associated with a unique URL and combination of variables.  
 
API interface button
 


Usage

1) Review the list of API calls to find the one that most closely aligns with your needs.
 
2) Click the "GET" button to see the available options.
 
3) Click "Try it out" to test an API call.
a. We recommend when using "Try it out" to set the "sample" value to "TRUE".  This returns a limited number of responses (10), so you can quickly validate the call format.
b. Data can be returned in either the GeoJSON format (geojson=TRUE), or a custom GLOBE JSON format (geojson=false).
c. Note - the custom JSON format returns the total number of records which will be returned if the full query runs.  If you want to determine how many records will be returned with a given call, set geojson=FALSE and sample=TRUE.  This will use the custom JSON format response whose first line will give the total records, without actually performing the full query.
 
4) You can use the Curl or Request URL to understand the format of the call, and programmatically modify that call as needed. For example, change sample=TRUE to sample=FALSE to return all results.   Below is an example of the direct https call to the api for all aerosols data between 1/1/2010 and 1/1/2012. Note sample=FALSE will return all data instead of the sample.
 
https://api.globe.gov/search/v1/measurement/protocol/measureddate/?protocols=aerosols&startdate=2010-01-01&enddate=2012-01-02&geojson=FALSE&sample=FALSE
 
5) We recommend that you do NOT use the "Try it out" option to return large datasets. Instead - use the "Request URL" result to receive large data sets. 
 
6) We currently limit the total amount of data returned to 1,000,000 records. You may need to modify your call if you are trying to return more than 1,000,000 records (ie by modifying the date range).
 
7) On the top right corner of the interface, you will see a pulldown for public-api which is the default, and a public-dev-api which provides lower level information such as a list of all countries, all places, last published date etc.
 
 
The following screenshots provide samples of the API page.

 

Get measurements by protocol and measured date range:

 

“Try it Out” sample for measurements by protocol and measured at date range

Request URL for aerosols query:

https://api.globe.gov/search/v1/measurement/protocol/measureddate/?protocols=aerosols&startdate=2010-10-01&enddate=2018-11-16&geojson=TRUE&sample=TRUE