IN41A-1478: HTTP-based Search and Ordering Using
ECHO’s REST and OpenSearch APIs
Authors: Katie Baynes (kathleen.baynes@nasa.gov), Dan Pilone (dan@element84.com), Jason Gilman (jason@element84.com),
Doug Newman (douglas.j.newman@nasa.gov), Andrew Mitchell (andrew.e.mitchell@nasa.gov)
What is ECHO?
NASA’s Earth Observing System ClearingHOuse (ECHO) acts as
the core metadata repository for NASA’s Earth Observing
System Data and Information Systems data centers, providing
a centralized mechanism for metadata and data discovery and
retrieval. ECHO has recently made strides to restructure its
API; allowing data partners to streamline and synchronize
their metadata ingest using RESTful web services as well as
providing an ESIP-compliant OpenSearch implementation.
How Can I Use It?
ECHO Facts
•
•
•
•
•
•
•
•
RESTful API
Example Granule Search Invocation:
curl –ig “https://api.echo.nasa.gov/catalog-rest/echo_catalog/granules?
platform[]=CALIPSO”
Example Collection Search Invocation:
curl –ig “https://api-test.echo.nasa.gov/catalog-rest/echo_catalog/
datasets.xml?polygon=5.273,33.724,15.82,
9.796,51.68,1.406,73.477,30.145,43.242,40.447,5.273,33.724”
ECHO and OpenSearch
ECHO’s RESTful Data Discovery allows users to filter
collections and granules based on keywords, spatial and
temporal extent platforms, instruments, processing
level, campaign, and many other fields. It also allows for
the filtering of granules by collection-specific attributes.
Client developers can programmatically sort and page
through both collection and granule results and may
retrieve metadata in multiple formats including:
•ECHO10
•ISO19115 (preliminary)
•JSON
•Atom (+FROST)
•csv (granules only)
Client Data Retrieval
ECHO and REST
Reverb
REST API
Mirador
Giovanni
…
ESIP
Direct
OpenSearch
Clients
• Searching
• Ordering
ECHO Catalog
•
Visualizing a
Polygon Search
Multi-format Retrieval
• ECHO10
• ISO 19115
ECHO’s REST API can also support search via
GCMD Science Keywords and provides
ordering capabilities from some providers
OpenSearch
cURL these links
for OSDDs!
OpenSearch Description Documents (OSDDs):
https://api.echo.nasa.gov/echo-esip/echo-esip-dataset.xml
https://api.echo.nasa.gov/echo-esip/echo-esip-granule.xml
ESIP Federated Search, based on the OpenSearch
convention, is a simple framework for doing a
federated query among participating members for
Earth science data. ECHO provides standardsbased access to its public catalog through an
implementation of OpenSearch.
ECHO supports both the georss and time
extensions as well as providing ECHO-specific
extensions for fields such as line, point, instrument
and provider name.
Example Granule Search Invocation:
Why REST?
•Scalable
•Fault-tolerant
•Recoverable
•Secure
•Loosely coupled
•Ease of client development
curl "https://api.echo.nasa.gov/echo-esip/search/granule.atom?
clientId=esip-html-client&
shortName=MOD02QKM&versionId=5&
dataCenter=LAADS&
boundingBox=-180.0%2C-90.0%2C180.0%2C90.0&
startTime=2002-05-04T03A00-04%3A00&
endTime=2009-05-04T00%3A00%3A00-04%3A00&
numberOfResults=10&cursor=0"
https://api.echo.nasa.gov/catalog-rest/catalog-docs/index.html
3000+ Available Collections
Over 100 million Granules
34 million ECHO hosted Browse Images
2TB Data Index Covers Petabytes of Data
60K+ registered users, utilizing EOSDIS URS
13 Active Data Partners
Several Clients in Test & Evaluation
LANCE Near Real Time Data
Documentation and Support
HTML View
OpenSearch
•
http://earthdata.nasa.gov/echo
•
http://earthdata.nasa.gov/library/echo-rest-search-guide
•
http://wiki.esipfed.org/index.php/FederatedSearchConvention
•
http://earthdata.nasa.gov/data/data-tools/data-catalog/
•
echo@echo.nasa.gov
ECHO/NASA POC: andrew.e.mitchell@nasa.gov