On Monday, 11 July from 3:00 p.m. through Wednesday, 13 July until 5:00 p.m. (USA Mountain Time), NSIDC data distribution, services, and Web site will be unavailable to accommodate a major upgrade to our data center. We apologize for any inconvenience this may cause you. Need to talk to us? You can always contact our friendly User Services Office at nsidc@nsidc.org or + 1 303.492.6199.
The OpenSearch Application Programming Interface (API) provides a simple way to discover and access NSIDC's data holdings that are hosted through Searchlight. We support two levels of the OpenSearch API: Data Set and Granule. Use the Data Set OpenSearch API to search for data sets that fulfill your search criteria, or use the Granule OpenSearch API to search for data meeting your search criteria for a particular data set.
To help you create the OpenSearch queries, choose one of the following options:
If you are familiar with OpenSearch and don't need help setting up the Data Set OpenSearch API, see our Data Set Description Document. If you are not familiar with OpenSearch and would like help, follow the directions given below.
To use the Data Set OpenSearch API, paste the following URL into the URL field of a browser, adding the appropriate values for the parameters listed in Table 1 to define your query string. The query string can contain all or any combination of the parameters listed in Table 1.
Note: The parameters loc= and bbox= can not be used together in a query. You must use only one of them per query. Also, the query string is case sensitive and the search is not a free text search, but a very structured search. The ? in the query string separates the URL from the parameters, and the & separates the variables.
http://nsidc.org/api/opensearch/1.1/dataset?searchterms={searchTerms?}&loc={geo:polygon?}&bbox={geo:box?}&dtstart={time:start?}&dtend={time:end?}
The following is an example of a query string for a Polygon Geometry query using the example variables listed in Table 1:
http://nsidc.org/api/opensearch/1.1/dataset?searchterms=Brightness Temperature&loc=10,100,20,100,20,110,10,110,10,100&dtstart=2000-01-01T00:00:00Z&dtend=2000-01-31T23:59:59Z
Figure 1 is an example of the results received from the Polygon Geometry query listed above. This particular query returned only one data set, the DMSP SSM/I-SSMIS Pathfinder Daily EASE-Grid Brightness Temperatures data set.
Figure 1. Example Results of a Polygon Geometry Query
If you want a complete listing of all the data sets distributed by Searchlight, use the following query string:
http://nsidc.org/api/opensearch/1.1/dataset
Figure 2 is an example of the results received from the all data set query listed above. Note: Currently NSIDC is only hosting 13 data sets through the OpenSearch API. However, we do plan on hosting all our data sets in the near future.
Figure 2. Example Results of an All Data Set Query
The following is an example of a query string for a Bounding Box query using the example variables listed in Table 1:
http://nsidc.org/api/opensearch/1.1/dataset?searchterms=albedo&bbo=100,10,110,20&dtstart=2000-01-01T00:00:00Z&dtend=2000-01-31T23:59:59Z
Figure 3 is an example of the results received from the Bounding Box query listed above. This particular query returned two data sets, the AVHRR Polar Pathfinder Twice-Daily 5 km EASE-Grid Composites data set and the AVHRR Polar Pathfinder Twice-Daily 25 km EASE-Grid Composites data set.
Figure 3. Example Results of a Bounding Box Query
Currently, we only support seven data sets at the granule level. Refer to Table 2. The Long Name in Table 2 is a link to the data set documentation. You can use the data set documentation to find pertinent information for your data query such as temporal coverage and spatial coverage to name just a few.
Short Name |
Long Name |
---|---|
NSIDC-0032 | DMSP SSM/I-SSMIS Pathfinder Daily EASE-Grid Brightness Temperatures |
NSIDC-0066 | AVHRR Polar Pathfinder Twice-Daily 5 km EASE-Grid Composites |
NSIDC-0218 | Greenland Ice Sheet Melt Characteristics Derived from Passive Microwave Data |
NSIDC-0301 | AMSR-E/Aqua Daily EASE-Grid Brightness Temperatures |
NSIDC-0305 | GLAS/ICESat 1 km Laser Altimetry Digital Elevation Model of Greenland |
NSIDC-0342 | Near-Real-Time DMSP SSM/I-SSMIS Pathfinder Daily EASE-Grid Brightness Temperatures |
IFLTRPT | IceBridge Mission Flight Reports |
If you are familiar with OpenSearch and don't need help using the seven APIs, see our Description Documents listed in Table 3. The Long Name in Table 3 is a link to the Description Document for that data set.
Short Name |
Long Name |
---|---|
NSIDC-0032 | DMSP SSM/I-SSMIS Pathfinder Daily EASE-Grid Brightness Temperatures |
NSIDC-0066 | AVHRR Polar Pathfinder Twice-Daily 5 km EASE-Grid Composites |
NSIDC-0218 | Greenland Ice Sheet Melt Characteristics Derived from Passive Microwave Data |
NSIDC-0301 | AMSR-E/Aqua Daily EASE-Grid Brightness Temperatures |
NSIDC-0305 | GLAS/ICESat 1 km Laser Altimetry Digital Elevation Model of Greenland |
NSIDC-0342 | Near-Real-Time DMSP SSM/I-SSMIS Pathfinder Daily EASE-Grid Brightness Temperatures |
IFLTRPT | IceBridge Mission Flight Reports |
If you are not familiar with OpenSearch and would like help, follow the directions given below.
Choose one of the following data sets that you would like to do an OpenSearch on:
To use the Granule OpenSearch API for the DMSP SSM/I-SSMIS Pathfinder Daily EASE-Grid Brightness Temperatures data set, paste the following URL into the URL field of a browser, adding the appropriate values for the parameters listed in Table 4 to define your query string. The query string can contain all or any combination of the parameters listed in Table 4.
Note: The parameters loc= and bbox= can not be used together in a query. You must use only one of them per query. Also, the query string is case sensitive and the search is not a free text search, but a very structured search. The ? in the query string separates the URL from the parameters, and the & separates the variables.
http://nsidc.org/api/opensearch/1.1/dataset/NSIDC-0032?loc={geo:polygon?}&bbox={geo:box?}&dtstart={time:start?}&dtend={time:end?}&projection={nsidc:projection?}&
variable={nsidc:variable?}&Pass={nsidc:Pass?}&Polarization={nsidc:Polarization?}&Frequency={nsidc:Frequency?}
The following is an example of a query string for a Polygon Geometry query using the example variables listed in Table 4:
http://nsidc.org/api/opensearch/1.1/dataset/NSIDC-0032?loc=10,100,20,100,20,110,10,110,10,100&dtstart=1987-09-01&dtend=1987-10-01
Figure 4 is an example of the results received from the Polygon Geometry query listed above. However, Figure 4 only shows a partial listing of the results received.
Figure 4. Partial Example Results of a Polygon Geometry Query for the NSIDC-0032 Data Set
The following is an example of a query string for a Bounding Box query using the example variables listed in Table 4:
http://nsidc.org/api/opensearch/1.1/dataset/NSIDC-0032?bbox=100,10,110,20
Figure 5 is an example of the results received from the Bounding Box query listed above. However, Figure 5 only shows a partial listing of the results received.
Figure 5. Partial Example Results of a Bounding Box Query for the NSIDC-0032 Data Set
If you want to do a query on a specific variable for this data set, use a query string similar to the following string using the variables listed in Table 4:
http://nsidc.org/api/opensearch/1.1/dataset/NSIDC-0032?variable=Brightness Temperature
Figure 6 is an example of the results received from the variable data set query listed above. However, Figure 6 only shows a partial listing of the results received.
Figure 6. Partial Example Results of a Variable Query for the NSIDC-0032 Data Set
If you want to do a temporal coverage query for this data set, use a query string similar to the following string using the variables listed in Table 4:
http://nsidc.org/api/opensearch/1.1/dataset/NSIDC-0032?dtstart=2006-09-01&dtend=2006-09-01
Figure 7 is an example of the results received from the temporal coverage query listed above. However, Figure 7 only shows a partial listing of the results received.
Figure 7. Partial Example Results of a Temporal Coverage Query for the NSIDC-0032 Data Set
To use the Granule OpenSearch API for the AVHRR Polar Pathfinder Twice-Daily 5 km EASE-Grid Composites data set, paste the following URL into the URL field of a browser, adding the appropriate values for the parameters listed in Table 5 to define your query string. The query string can contain all or any combination of the parameters listed in Table 5.
Note: The parameters loc= and bbox= can not be used together in a query. You must use only one of them per query. Also, the query string is case sensitive and the search is not a free text search, but a very structured search. The ? in the query string separates the URL from the parameters, and the & separates the variables.
http://nsidc.org/api/opensearch/1.1/dataset/NSIDC-0066?loc={geo:polygon?}&bbox={geo:box?}&dtstart={time:start?}&dtend={time:end?}&projection={nsidc:projection?}&variable={nsidc:variable?} &Channel={nsidc:Channel?}&Channel={nsidc:Channel?}&Local Time Measurement={nsidc:Local Time Measurement?}&Viewing geometry={nsidc:Viewing geometry?}
If you want to do a multiple parameter query for this data set, use a query string similar to the following string using the variables listed in Table 5:
http://nsidc.org/api/opensearch/1.1/dataset/NSIDC-0066?dtstart=1981-07-24&dtend=1981-08-24&projection=EASE-Grid Southern&variable=Reflectance&Channel=Channel 5
Figure 8 is an example of the results received from the multiple parameter query listed above. However, Figure 8 only shows a partial listing of the results received.
Figure 8. Partial Example Results of a Multiple Parameter Query for the NSIDC-0066 Data Set
To use the Granule OpenSearch API for the Greenland Ice Sheet Melt Characteristics Derived from Passive Microwave Data data set, paste the following URL into the URL field of a browser, adding the appropriate values for the parameters listed in Table 6 to define your query string. The query string can contain all or any combination of the parameters listed in Table 6.
Note: The parameters loc= and bbox= can not be used together in a query. You must use only one of them per query. Also, the query string is case sensitive and the search is not a free text search, but a very structured search. The ? in the query string separates the URL from the parameters, and the & separates the variables.
http://nsidc.org/api/opensearch/1.1/dataset/NSIDC-0218?dtstart={time:start?}&dtend={time:end?}&loc={geo:polygon?}&bbox={geo:box?}
If you want to do a temporal coverage query for this data set, use a query string similar to the following string using the variables listed in Table 6
http://nsidc.org/api/opensearch/1.1/dataset/NSIDC-0218?dtstart=1979-04-02&dtend=1979-06-02
Figure 9 is an example of the results received from the temporal coverage query listed above. However, Figure 9 only shows a partial listing of the results received.
Figure 9. Partial Example Results of a Temporal Query for the NSIDC-0218 Data Set
To use the Granule OpenSearch API for the AMSR-E/Aqua Daily EASE-Grid Brightness Temperatures data set, paste the following URL into the URL field of a browser, adding the appropriate values for the parameters listed in Table 7 to define your query string. The query string can contain all or any combination of the parameters listed in Table 7.
Note: The parameters loc= and bbox= can not be used together in a query. You must use only one of them per query. Also, the query string is case sensitive and the search is not a free text search, but a very structured search. The ? in the query string separates the URL from the parameters, and the & separates the variables.
http://nsidc.org/api/opensearch/1.1/dataset/NSIDC-0301?dtstart={time:start?}&dtend={time:end?}&projection={nsidc:projection?}&variable={nsidc:variable?}&Pass={nsidc:Pass?}&Polarization={nsidc:Polarization?}&Frequency={nsidc:Frequency?}
If you want to do a multiple parameter query for this data set, use a query string similar to the following string using the variables listed in Table 7.
http://nsidc.org/api/opensearch/1.1/dataset/NSIDC-0301?projection=EASE-Grid Northern&variable=Brightness Temperature&Pass=Descending&Polarization=Horizontal&Frequency=36.5 GHz
Figure 10 is an example of the results received from the multiple parameter query listed above. However, Figure 10 only shows a partial listing of the results received.
Figure 10. Partial Example Results of a Multiple Parameter Query for the NSIDC-0301 Data Set
To use the Granule OpenSearch API for the GLAS/ICESat 1 km Laser Altimetry Digital Elevation Model of Greenland data set, paste the following URL into the URL field of a browser, adding the appropriate values for the parameters listed in Table 8 to define your query string. The query string can contain all or any combination of the parameters listed in Table 8.
Note: The parameters loc= and bbox= can not be used together in a query. You must use only one of them per query. Also, the query string is case sensitive and the search is not a free text search, but a very structured search. The ? in the query string separates the URL from the parameters, and the & separates the variables.
http://nsidc.org/api/opensearch/1.1/dataset/NSIDC-0305?dtstart={time:start?}&dtend={time:end?}&variable={nsidc:variable?}&loc={geo:polygon?}&bbox={geo:box?}
If you want to do a multiple parameter query for this data set, use a query string similar to the following string using the variables listed in Table 8.
http://nsidc.org/api/opensearch/1.1/dataset/NSIDC-0305?dtstart=2003-02-01&dtend=2003-03-01&variable=Mean Distance
Figure 11 is an example of the results received from the multiple parameter query listed above.
Figure 11. Example Results of a Multiple Parameter Query for the NSIDC-0305 Data Set
To use the Granule OpenSearch API for the Near-Real-Time DMSP SSM/I-SSMIS Pathfinder Daily EASE-Grid Brightness Temperatures data set, paste the following URL into the URL field of a browser, adding the appropriate values for the parameters listed in Table 9 to define your query string. The query string can contain all or any combination of the parameters listed in Table 9.
Note: The parameters loc= and bbox= can not be used together in a query. You must use only one of them per query. Also, the query string is case sensitive and the search is not a free text search, but a very structured search. The ? in the query string separates the URL from the parameters, and the & separates the variables.
http://nsidc.org/api/opensearch/1.1/dataset/NSIDC-0342?dtstart={time:start?}&dtend={time:end?}&projection={nsidc:projection?}&variable={nsidc:variable?}&loc={geo:polygon?}&bbox={geo:box?}
If you want to do a multiple parameter query for this data set, use a query string similar to the following string using the variables listed in Table 9.
http://nsidc.org/api/opensearch/1.1/dataset/NSIDC-0342?projection=EASE-Grid Southern&variable=Brightness Temperature
Figure 12 is an example of the results received from the multiple parameter query listed above. However, Figure 12 only shows a partial listing of the results received.
Figure 12. Partial Example Results of a Multiple Parameter Query for the NSIDC-0342 Data Set
There are two ways to find the flight report you are looking for when using the Granule OpenSearch API for the IceBridge Mission Flight Reports. You can either enter appropriate values for the parameters listed in Table 10 to define your query string, or you can use one parameter called Measurment in your query string. By using the Measurement parameter, the user receives a full listing of all the flight reports currently stored at NSIDC. From this listing, the user can drill-down to find a specific flight report by clicking on a given data record.
Choose one of the following:
http://nsidc.org/api/opensearch/1.1/dataset/IFLTRPT/measurement
Figure 13 is an example of the results received from the Measurement query listed above. However, Figure 13 only shows a partial listing of the results received.
Figure 13. Partial Listing of the IceBridge Flight Reports
Figure 14 is an example of the results received when you click on a link in the flight report listing.
Figure 14. Flight Report Files
Note: The parameters loc= and bbox= can not be used together in a query. You must use only one of them per query. Also, the query string is case sensitive and the search is not a free text search, but a very structured search. The ? in the query string separates the URL from the parameters, and the & separates the variables.
http://nsidc.org/api/opensearch/1.1/dataset/IFLTRPT/measurement/?dtstart={time:start?}&dtend={time:end?}&loc={geo:polygon?}&bbox={geo:box?}
The following is an example of a query string for a Flight Report query using the dtstart and dtend parameters listed in Table 10:
http://nsidc.org/api/opensearch/1.1/dataset/IFLTRPT/measurement/?dtstart=2009-05-22&dtend=2009-05-23
Figure 15 is an example of the results received from the flight report query listed above.
Figure 15. Flight Report File
Figure 16 is an example of the results received when you drill-down into the flight report listing.
Figure 16. Flight Report File Drill Down