API Decomission Notice
This version of the API is no longer supported - please upgrade to version API version 1.5

Where did this API go?

The M2M API has been migrated to a new architecture and into its own application. While much of the API functionally works the same, there are minor differences in the name of the API endpoints and their request/response fields. This new API provides much greater flexibility, more capabilities and a different versioning scheme where upgrades are promoted through a set of 3 API versions with planned, periodic, promotion of changes from one version to the next. More details can be found within the M2M 1.5 API Documentation, including a short migration guide.

M2M 1.5 - New Features and Capabilities

The new API makes use of a much more flexible architecture that has allowed many new/expanded features.

Dataset Customizations

While dataset customization is not a new concept for EarthExplorer, it is for M2M. We've provided M2M endpoints to allow users to hide datasets, hide metadata fields (except for FGDC), apply a custom metadata display order and apply custom search result ordering. You can also set your customization with the EarthExplorer interface. To use these customizations, within API endpoints that support it, simply provide a 'true' value for the 'useCustomization' field. To determine if an endpoint supports this capability, look for the 'useCustomization' field within the available request fields for each endpoint.

Metadata Types

Requests that include scene metadata can now be customized to return a specific metadata type (full results, search summary - such as what you see in the EarthExplorer search results and FGDC) for most of these requests. The primary uses of this can be found within the scene-search (called 'search' within the legacy API) and the scene-metadata (called 'metadata' within the legacy API) endpoints.

User-Defined Scene Lists

A new feature within the new API is the ability to create user-based scene lists. This allows users to discover scenes and create a list of scenes that can be used in subsequent requests without the overhead of submitting large JSON payloads in each request. This is particularly useful when users wish to build a list of data downloads or return a list of scene metadata where creating a search query may not be feasible. When users wish to interact with the API with large volumes of data, this makes the requesting and execution of these requests much more efficient and quicker to respond.

How do I transition to the new API?

Transitioning to the new API is a straight-forward process as the it uses many of the legacy API constructs. However, there are a few key differences.

* When contacting us for assistance, providing the requestId of requests in question provides our technical staff with the ability to view all necessary details about your request, including the request/response payloads, execution time and more.

Timeline for Complete Decommissioning