API for the ESPA ordering system.
Clone or download

README.md

espa-api build status Codecov branch

This is an API for interacting with the ESPA ordering system.

User API

The User API is public facing and available for anyone to code and interact with.
Version 1 provides the minimum functionality necessary to determine available products from a list of inputs, place orders, and view order status. There are endpoints for providing available projections, resampling methods, and output formats.

All user interactions with API functions must be accompanied by valid credentials. Accounts are managed in the USGS EROS Registration system.

The api host is https://espa.cr.usgs.gov/api.

Related Pages

Need a scene list? The USGS EROS offers two resources for finding valid scene acquisitions:
  1. USGS/EROS Inventory Service API
  2. Entire Collection of Metadata

Quick Unix Walk-through

The ESPA ordering system provides an API for users to interact with using simple HTTP communications through the programming language of their choice.

  1. To find what products ESPA can produce for a given Landsat acquisition: /available-products
  2. If the acquisition can be processed into a desired product, create a processing order request: /order
  3. When processing has completed, get the download URL while the output is still available: /item-status

For a more detailed list of User API operations, see the Available Resources List.

For a language-specific (python) example, please see an API Demo.

Support Information

This project is unsupported software provided by the U.S. Geological Survey (USGS) Earth Resources Observation and Science (EROS) Land Satellite Data Systems (LSDS) Project. For questions regarding products produced by this source code, please contact us at custserv@usgs.gov.

Disclaimer

This software is preliminary or provisional and is subject to revision. It is being provided to meet the need for timely best science. The software has not received final approval by the U.S. Geological Survey (USGS). No warranty, expressed or implied, is made by the USGS or the U.S. Government as to the functionality of the software and related material nor shall the fact of release constitute any such warranty. The software is provided on the condition that neither the USGS nor the U.S. Government shall be held liable for any damages resulting from the authorized or unauthorized use of the software.