The Orders API provides endpoints for retrieving details of past orders created through the Archive and Tasking APIs, viewing their status, and downloading their delivered file resources.
The orders API consists of 3 endpoints:
List Order History
The /api/order/list endpoint returns a JSON encoded response consisting of a list of Order objects.
Each Order entry is a JSON object with the following structure:
A full reference for the structure can be found in the reference section below
The Get Order endpoint allows the return of a detailed order object, including a list of resources that are available for download.
|id||string||UUID identifying the order you wish to retrieve|
The /api/order/get endpoint returns a JSON encoded response consisting of a Detailed Order object, with the structure:
A full reference for the order structure can be found in the reference section below
NOTE: the resources array will be omitted if the order is not yet in the completed state.
Completed orders will have at least one resource available to download that provides the requested imagery and its associated metadata.
Each Resource is an object like the following:
A full reference for the resource structure can be found in the reference section below
The Get Order Resource endpoint allows the download of a resource contents.
|id||string||UUID identifying the resource you wish to retrieve, found in the Resource Object|
/api/order/resource/get endpoint will return a byte stream of the contents of the file you requested, or redirect to a path that will do so.
410 Gone HTTP status code will be returned if storage for this order has expired and the resources are no longer available.
The order object is a JSON object, that resembles:
|id||string||UUID to uniquely identify the order|
|createdAt||string||datetime the order was created at (UTC timezone)|
|updatedAt||string||datetime of the last update to the order (UTC timezone)|
|supplier||string||supplier providing the imagery|
|orderingID||string||ID used to order the imagery|
|sceneID||string||suppliers scene ID to identify the order|
|status||string||current status of the order (see below for values)|
|total||number||total price of the order in US cents|
|type||string||order type designation (archive, custom, event orders; scene v aoi orders)|
|expiration||nullable string||timestamp for order expiration (see below for details)|
|resources||array||lists the resources available for download on the order (see below)|
NOTE: the resources array will be omitted if there are no resources available for the order yet, or if the order is not complete.
The order, once created may return several different status codes to indicate its current state of completion.
|created||The order has been created and is queued for sending. This state will normally never be returned by the API|
|pending||The order has been created and is awaiting confirmation of placement from the supplier|
|processing||The order is awaiting delivery of imagery from the supplier|
|post-processing||The order is undergoing additional processing of the imagery to fulfil the order|
|complete||The order is complete and its imagery may be downloaded via the `order/resource/get` endpoint|
|manual||This status only applies to custom orders delivered under contract and will not normally appear in the API|
Orders, once complete are retained in storage for 1 month from completion/delivery. After this date the orders resources are no longer available for delivery/retrieval from the user interface or order/resource/get endpoint.
The expiration field of an order identifies the date and time after which resources will not be retrievable. The field will be a
JSON null under the following conditions:
- The order is not yet complete, expiration will start once the order is complete
- The order is from a public dataset such as the landsat or sentinel missions and will not expire
Completed orders will have at least one resource available to download that provides the requested imagery.
Each Resource has structure like the following:
|id||string||ID for the resource, used to request download of the resource|
|createdAt||string||datetime the order was created at (UTC timezone)|
|updatedAt||string||datetime of the last update to the order (UTC timezone)|
|order||string||UUID of the order to which this resource belongs|
|name||string||name of the resource (often a filename)|
|type||string||Legacy type of resource (see below)|
|format||string||MIME type of the file, such as
(see roles reference for common examples)
|roles||string||list of roles this file fills in hierarchial order from general to specific
(see below for reference)
|size||integer||File size in bytes|
|checksum||string||Checksum for the file to facilitate integrity checking.
will be in the form
At time of writing, format is either
Imagery and it’s metadata can be delivered in a variety of file formats, with the specific choice of format often varying with supplier.
format field provides details about the format a given resource file is in, in the form of a MIME type.
The following is a summary of the most common formats returned by suppliers (with a few less common but important edge cases):
|image/tiff; application=geotiff||A ‘geoTiff’, a tiff image with geographic and geo-referencing metadata attached, the most basic, and common type of imagery.|
|image/tiff; application=geotiff; profile=cloud-optimized||A ‘Cloud Optimized Geotiff’ or COG for short.
A special subcategory of ‘geotiff’ that internally has a tiling structure and an overview pyramid for easier atomic retrieval of data.
There are several proposed MIME types for COGS, this was the most recent official proposal at time of writing, unless another value is officially adopted, this will be the value used to ensure backwards compatibility.
|image/jp2||The JPEG Core 2000 image format
Has several similar features to the COG format, but less popular at this time.
|Common image formats, able to be viewed in browsers, though featuring compression that results in data loss.
Frequently used for thumbnails or similar overview data.
|application/geo+json||Official MIME for geoJSON, a JSON based notation of vector/feature data.|
This format is a special case.
This format should only be found on resources with a vector type.
As the ESRI Shapefile format consists of multiple files, to ensure they are all acquired together in a download, they are zipped together.
|application/json||JSON encoded metadata for the capture scene|
|application/xml||XML encoded metadata for the capture scene|
|text/MTL||text based MTL encoding of metadata, often seen from NASA landsat captures.|
|text/plain||Plain text file, often used for license information in a scene|
|application/pdf||A portable document format (pdf) file, often used for license information in a scene|
Legacy Resource Types
type field is a legacy of past versions of the API.
It is maintained for legacy support, new users are recommended to use the new
roles fields instead (see below).
The returned legacy types are
|img_tiff||default imagery label, geoTIF imagery for the requested area|
|img_jp2||JPEG Core 200 format imagery for the requested area|
|thumb||low resolution thumbnail imagery in jpg or similar format|
|gdal_tiff_overview||.tif.ovr file used by GDAL applications|
|meta_mtl||metadata in text-based mtl format|
|meta_json||metadata in JSON format|
|meta_xml||metadata in XML format|
|meta_bundle||bundled metadata file(s) provided by the supplier|
|geo_json||scene or order geometry data in the geoJSON format|
|geo_kml||scene or order geometry data in the Keyhole Markup Language|
|geo_shp||scene or order geometry data in a zip of a shapefile|
|license||a license/terms declaration file, usually plaintext|
NOTE: not all suppliers return data in all types, and a single imagery request may contain multiple files of the same type (i.e. multiple
img_tiff resources for different imaging bands on the satellite).
Integrity checking and checksums
Resources downloaded from the API, as with any message over the internet, may be altered or corrupted in transmission.
To aid in detecting such scenarios, a checksum is provided for all resource.
Each resources checksum consists of 2 parts, separated by a colon character (:)
The first part identifies the type of checksum, currently this is either
The second part is the base64 encoded hash of the resource body.
With this, downloaded resources can be similarly hashed and the value checked against the reported value of the resource.
Roles form a hierarchical tree describing the contents of a given resource
Roles should be read from start to end as being from least to most specific descriptor
The following details the common hierarchies of roles for most order resources:
Main product data for order.
Resources with this role are often the largest, and contain the primary data sources.
Data generally comes in 3 types
- “raster” resources are traditional pixel images
- “vector” resources are geographic features like points, polygons and features
- “structured” resources are information in machine readable data formats like JSON
At this time, primary data is only returned with the
structured are reserved for future use.
Raster data is the primary deliverable for satellite imagery orders at this time.
These roles describe the type of raster data a given resource is.
reflectance data is light reflected from the observed surface in the relevant band
Below this level roles become less hierarchical.
First describing the band(s) present in the file. If the file is a single band, the next role will be the common name for that band. If instead the resource contains multiple bands, it will have the
multi-band role, followed by the list of band common names, in the order they appear in the resource/
Using the band common name the corresponding band information can be found in the metadata file with the
Some special case “pseudo” bands exist which may be found here in custom orders. These generally correspond to some standard processed raster band such as
ndvi and similar. Despite being processing, they are included before other processing roles as they occupy a band in the file
Lastly, if there is processing of the imagery that may affect selection between several similar/related files, it is included as the final set of roles. This is generally large processing jobs which produce distinct artifacts, such as the following:
pansharpenedfor pansharpened imagery
orthorectifiedfor orthorectified imagery
radiometrically-correctedfor imagery that has undergone radiometric correction
mosaicfor cases where a mosaic has been produced from multiple source images
Example: [“data”, “raster”, “reflectance”, “multi-band”, “red”, “green”, “blue”, “nir”, “pansharpened”]
Thermal reflectance data from a thermal sensor like landsat-8’s TIRS sensor.
Example: [“data”, “raster”, “temperature”]
If the primary data format does not support internal overviews, they may be provided as a separate file identified by this role.
Example: [“data”, “raster”, “overview”]
A full resolution image of the scene in a more compact format such as JPEG or PNG. These files may have lossy compression and/or compression artifacts and not represent the true data. They are intended as summary data when needed.
Example: [“data”, “raster”, “browse”]
A low resolution overview of the whole area of interest, generally “true color” or RGB if the image is has the relevant bands.
Example: [“data”, “raster”, “thumbnail”] > “vector”
Not supported at this time, but reserved for future use.
Not supported at this time, but reserved for future use
Descriptive metadata that provides information about the primary data.
Metadata generally comes in 3 types
- “raster” resources are traditional pixel images, describing a value at each pixel location
- “vector” resources are geographic features such as the polygon within which is valid data, or where the seams of adjacent tiles are
- “structured” resources are information in machine readable data formats like JSON, such as general information about a capture; such as the date of capture, or how the scene was processed
Raster metadata often describes values for a scene that correspond to each pixel in the primary data.
such as whether each pixel is classified as being cloud cover, or the azimuth angle for each pixel.
Raster metadata files often fill multiple roles, with each band being a different piece of metadata.
As such, the subsequent roles form a list of what metadata is found in the file
i.e. a single resource may have the
water-mask roles for a roles array of
["metadata", "raster", "cloud", "cloud-shadow", "water-mask"]
Note: effort is made to ensure that the role order matches a files band order, however this may not always be the case. Please let us know if you find any discrepancies
The descriptions below describe the meaning of each role for a given pixel in this metadata file
|saturation||Indicates that the given pixel was saturated in capture, the real value is outside the measured range|
|cloud||Indicates that the given pixel has been categorized as being cloud cover|
|cloud-shadow||Indicates that the given pixel has been categorized as being shadowed by a nearby cloud|
|snow-ice||Indicates that the given pixel has been categorized as either snow or ice cover on the ground|
|land-water||Indicates whether the given pixel has been categorized to be land or water|
|terrain-shadow||Indicates that the given pixel has been categorized as being shadowed by nearby terrain|
|terrain-occlusion||Indicates that the given pixel has been categorized as being occluded by some other terrain feature.
(Generally only relevant to orthorectified scenes)
|terrain-illumination||Identifies the coefficients used for terrain illumination correction|
|incidence-angle||The incidence angle between the pixel’s ground point and the sensor|
|azimuth||The azimuth angle between the pixel’s ground point and the sensor|
|sun-azimuth||The azimuth angle between the pixel’s ground point and the sun|
|sun-elevation||The elevation angle between the pixel’s ground point and the sun|
Example: [“metadata”, “raster”, “land-water”, “cloud”, “cloud-shadow”, “snow-ice”]
Vector metadata often describes details about the imagery, such as a summary of its location, or that of the larger scene it belongs to, how the imagery was built from tiled captures, or how the delivery files themselves are tiled.
Reference vectors describe details about data location
It is followed by a role identifying what it is a reference for
Currently it may be a reference for either:
scenein which case it is the boundary for the whole source scene of the imagery, or
aoito identify the location boundary of the delivered Area Of Interest
Example: [“metadata”, “vector”, “reference”, “aoi”]
Tiling metadata files describe how multiple data files in an order relate to each other in space
If present, these are often the preferred way to load the imagery, we they can provide metadata about the scene which prevents artifacts such as color balance issues.
These will often be found as GDAL Virtual Raster Table (.vrt) files, or TILE files (.til)
Example: [“metadata”, “vector”, “tiling”]
Scene tiles describe the boundaries and tiling of source imagery that makes up a scene (such as when a satellite has multiple overlapping CCD’s)
Example: [“metadata”, “vector”, “scene-tiles”] > “structured”
Structured metadata files provide information about an order and its source scene
This information can provide more context for a scene, or information necessary to process it.
|files||An optional metadata file identifying the files in the delivery,
Most commonly used if delivering to customer storage
(generally mirroring an orders resource list)
|general||General metadata about a capture, such as date of capture, projection, averages of values like azimuth and incidence angle, etc.|
|ephemeris||Ephemeris data identifies the satellites position and velocity during imagery capture|
|angular||Angular or ‘attitude’ data about the orientation of the satellite during imagery capture|
|source||File contains data on the imagery’s source such as who produced it and how.|
|lineage||Details on the data’s lineage to delivery, who handled/processed the data, in what way, etc|
|platform||Information on the satellite/platform that captured the imagery|
|bands||Information on the spectral properties of each imaging band delivered|
|mapping||Information on how to interpret the details in the data files.
Often a subset of
|contours||When used as structured data, the contours roles refers to the
Example: [“metadata”, “structured”, “general”, “lineage”, “platform”, “bands”]
“license” is a special type, used exclusively for resources that provide either the license for data itself, or information about it.
The most common licenses are either
“custom” is a special type, used exclusively for resources that are part of a custom order, for resources which do not fall into other established roles