Download OpenAPI specification:Download
This page contains the documentation on how to use sentinel hub services through API calls.
Note: This documentation is not complete
Make sure to use the appropriate end-point for each of the datasets, e.g. for Landsat, Sentinel-3, etc.
Accept | string Sets response type and has priority over the type defined in the output object of the request.
Possible values are |
required | object (ProcessRequestInput) |
object (ProcessRequestOutput) | |
evalscript required | string Your evalscript. For details, click here. |
{- "input": {
- "bounds": {
- "bbox": [
- 13.822174072265625,
- 45.85080395917834,
- 14.55963134765625,
- 46.29191774991382
], - "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 14.000701904296873,
- 46.23685258143992
], - [
- 13.822174072265625,
- 46.09037664604301
], - [
- 14.113311767578125,
- 45.85080395917834
], - [
- 14.55963134765625,
- 46.038922598236
], - [
- 14.441528320312498,
- 46.28717293114449
], - [
- 14.17236328125,
- 46.29191774991382
], - [
- 14.000701904296873,
- 46.23685258143992
]
]
]
},
}, - "data": [
- {
- "type": "sentinel-2-l1c",
- "id": "string",
- "dataFilter": {
- "timeRange": {
- "from": "2018-10-01T00:00:00.000Z",
- "to": "2018-11-01T00:00:00.000Z"
}, - "mosaickingOrder": "mostRecent",
- "maxCloudCoverage": 100,
- "previewMode": "DETAIL"
}, - "processing": {
- "upsampling": "NEAREST",
- "downsampling": "NEAREST",
- "harmonizeValues": true
}
}
]
}, - "output": {
- "width": 512,
- "height": 512,
- "resx": 0,
- "resy": 0,
- "responses": [
- {
- "identifier": "<identifier>",
- "format": {
- "type": "image/png"
}
}
]
}, - "evalscript": "string"
}
This is an OpenAPI definition of the SpatioTemporal Asset Catalog API - Core specification. Any service that implements this endpoint to allow discovery of spatiotemporal assets can be considered a STAC API.
Make sure to use the appropriate end-point for each of the datasets, e.g. for Landsat, Sentinel-3, etc.
Returns the root STAC Catalog or STAC Collection that is the entry point for users to browse with STAC Browser or for search engines to crawl. This can either return a single STAC Collection or more commonly a STAC catalog.
The landing page provides links to the
API definition (link relations service-desc
and service-doc
)
and the STAC records such as collections/catalogs (link relation child
)
or items (link relation item
).
Extensions may add additional links with new relation types.
stac_version required | string (CatalogStacVersion) |
Array of Reference to a JSON Schema (string) or Reference to a core extension (string) (CatalogStacExtensions) unique | |
type required | string |
id required | string |
title | string |
description required | string |
required | Array of objects (CatalogLinks) |
conformsTo required | Array of strings A list of all conformance classes implemented by the server. In addition to the STAC-specific conformance classes, all OGC-related conformance classes listed at |
{- "type": "Catalog",
- "stac_version": "1.0.0",
- "id": "sentinel-hub",
- "title": "Sentinel Hub STAC catalog",
- "description": "STAC v1.0.0 implementation by Sentinel Hub",
- "conformsTo": [
], - "links": [
- {
- "rel": "root",
- "type": "application/json"
}, - {
- "rel": "self",
- "type": "application/json"
}, - {
- "rel": "data",
- "type": "application/json"
}, - {
- "rel": "conformance",
- "type": "application/json",
- "title": "STAC conformance classes implemented by this server"
}, - {
- "rel": "search",
- "type": "application/geo+json",
- "title": "STAC search",
- "method": "GET"
}, - {
- "rel": "search",
- "type": "application/geo+json",
- "title": "STAC search",
- "method": "POST"
}, - {
- "type": "application/schema+json"
}, - {
- "rel": "child",
- "type": "application/json",
- "title": "Sentinel 2 L1C"
}, - {
- "rel": "child",
- "type": "application/json",
- "title": "Sentinel 1 GRD"
}, - {
- "rel": "child",
- "type": "application/json",
- "title": "Sentinel 2 L2A"
}, - {
- "rel": "service-desc",
- "type": "application/vnd.oai.openapi;version=\"3.1\"",
- "title": "OpenAPI service description"
}, - {
- "rel": "service-doc",
- "type": "text/html",
- "title": "OpenAPI service documentation"
}
]
}
A list of all conformance classes specified in a standard that the server conforms to.
conformsTo required | Array of strings A list of all conformance classes implemented by the server. In addition to the STAC-specific conformance classes, all OGC-related conformance classes listed at |
{- "conformsTo": [
]
}
This is an OpenAPI definition of the SpatioTemporal Asset Catalog API - Collections specification. This is a subset of the STAC API - Features specification.
A body of Feature Collections that belong or are used together with additional links. Request may not return the full set of metadata per Feature Collection.
required | Array of objects (CatalogLinks) |
required | Array of objects (collection) |
{- "links": [
- {
- "rel": "root",
- "type": "application/json"
}, - {
- "rel": "self",
- "type": "application/json"
}, - {
- "rel": "parent",
- "type": "application/json"
}
], - "collections": [
- {
- "stac_version": "1.0.0",
- "type": "Collection",
- "id": "sentinel-2-l1c",
- "title": "Sentinel 2 L1C",
- "description": "Sentinel 2 imagery processed to level 1C",
- "sci:citation": "Modified Copernicus Sentinel data [Year]/Sentinel Hub",
- "license": "proprietary",
- "providers": [
], - "extent": {
- "spatial": {
- "bbox": [
- [
- -180,
- -56,
- 180,
- 83
]
]
}, - "temporal": {
- "interval": [
- [
- "2015-11-01T00:00:00Z",
- null
]
]
}
}, - "summaries": {
- "platform": [
- "sentinel-2a",
- "sentinel-2b"
], - "instrument": [
- "msi"
], - "constellation": [
- "sentinel-2"
], - "gsd": [
- 10
], - "eo:cloud_cover": {
- "minimum": 0,
- "maximum": 100
}, - "eo:bands": [
- {
- "name": "B01",
- "common_name": "coastal",
- "center_wavelength": 0.4427,
- "full_width_half_max": 0.021
}, - {
- "name": "B02",
- "common_name": "blue",
- "center_wavelength": 0.4924,
- "full_width_half_max": 0.066
}, - {
- "name": "B03",
- "common_name": "green",
- "center_wavelength": 0.5598,
- "full_width_half_max": 0.036
}, - {
- "name": "B04",
- "common_name": "red",
- "center_wavelength": 0.6646,
- "full_width_half_max": 0.031
}, - {
- "name": "B05",
- "center_wavelength": 0.7041,
- "full_width_half_max": 0.015
}, - {
- "name": "B06",
- "center_wavelength": 0.7405,
- "full_width_half_max": 0.015
}, - {
- "name": "B07",
- "center_wavelength": 0.7828,
- "full_width_half_max": 0.02
}, - {
- "name": "B08",
- "common_name": "nir",
- "center_wavelength": 0.8328,
- "full_width_half_max": 0.106
}, - {
- "name": "B8A",
- "common_name": "nir08",
- "center_wavelength": 0.8647,
- "full_width_half_max": 0.021
}, - {
- "name": "B09",
- "common_name": "nir09",
- "center_wavelength": 0.9451,
- "full_width_half_max": 0.02
}, - {
- "name": "B10",
- "common_name": "cirrus",
- "center_wavelength": 1.3735,
- "full_width_half_max": 0.031
}, - {
- "name": "B11",
- "common_name": "swir16",
- "center_wavelength": 1.6137,
- "full_width_half_max": 0.091
}, - {
- "name": "B12",
- "common_name": "swir22",
- "center_wavelength": 2.2024,
- "full_width_half_max": 0.175
}
]
}, - "links": [
- {
- "rel": "root",
- "type": "application/json"
}, - {
- "rel": "self",
- "type": "application/json"
}, - {
- "rel": "parent",
- "type": "application/json"
}, - {
- "type": "application/schema+json"
}, - {
- "rel": "items",
- "type": "application/geo+json"
}
]
}, - {
- "stac_version": "1.0.0",
- "type": "Collection",
- "id": "sentinel-1-grd",
- "title": "Sentinel 1 GRD",
- "description": "Sentinel 1 Ground Range Detected Imagery",
- "sci:citation": "Modified Copernicus Sentinel data [Year]/Sentinel Hub",
- "license": "proprietary",
- "providers": [
], - "extent": {
- "spatial": {
- "bbox": [
- [
- -180,
- -85,
- 180,
- 85
]
]
}, - "temporal": {
- "interval": [
- [
- "2014-10-03T00:00:00Z",
- null
]
]
}
}, - "summaries": {
- "platform": [
- "sentinel-1a",
- "sentinel-1b"
], - "instrument": [
- "c-sar"
], - "constellation": [
- "sentinel-1"
], - "sat:orbit_state": [
- "ascending",
- "descending"
], - "sar:instrument_mode": [
- "SM",
- "IW",
- "EW",
- "WV",
- "EN",
- "AN",
- "IM"
], - "sar:frequency_band": [
- "C"
], - "sar:center_frequency": [
- 5.405
], - "sar:product_type": [
- "GRD"
], - "sar:polarizations": [
- "HH",
- "HV",
- "VH",
- "VV"
], - "sar:resolution_range": [
- 9,
- 20,
- 23,
- 50,
- 52,
- 84,
- 88,
- 93
], - "sar:resolution_azimuth": [
- 9,
- 22,
- 23,
- 50,
- 51,
- 84,
- 87
], - "sar:pixel_spacing_range": [
- 3.5,
- 10,
- 25,
- 40
], - "sar:pixel_spacing_azimuth": [
- 3.5,
- 10,
- 25,
- 40
], - "s1:timeliness": [
- "NRT10m",
- "NRT1h",
- "NRT3h",
- "Fast24h",
- "Offline",
- "Reprocessing",
- "ArchNormal"
], - "s1:resolution": [
- "HIGH",
- "MEDIUM",
- "FULL"
], - "s1:polarization": [
- "SH",
- "SV",
- "DH",
- "DV",
- "HH",
- "HV",
- "VV",
- "VH"
]
}, - "links": [
- {
- "rel": "root",
- "type": "application/json"
}, - {
- "rel": "self",
- "type": "application/json"
}, - {
- "rel": "parent",
- "type": "application/json"
}, - {
- "type": "application/schema+json"
}, - {
- "rel": "items",
- "type": "application/geo+json"
}
]
}, - {
- "stac_version": "1.0.0",
- "type": "Collection",
- "id": "sentinel-2-l2a",
- "title": "Sentinel 2 L2A",
- "description": "Sentinel 2 imagery processed to level 2A",
- "sci:citation": "Modified Copernicus Sentinel data [Year]/Sentinel Hub",
- "license": "proprietary",
- "providers": [
], - "extent": {
- "spatial": {
- "bbox": [
- [
- -180,
- -56,
- 180,
- 83
]
]
}, - "temporal": {
- "interval": [
- [
- "2016-11-01T00:00:00Z",
- null
]
]
}
}, - "summaries": {
- "platform": [
- "sentinel-2a",
- "sentinel-2b"
], - "instrument": [
- "msi"
], - "constellation": [
- "sentinel-2"
], - "gsd": [
- 10
], - "eo:cloud_cover": {
- "minimum": 0,
- "maximum": 100
}, - "eo:bands": [
- {
- "name": "B01",
- "common_name": "coastal",
- "center_wavelength": 0.4427,
- "full_width_half_max": 0.021
}, - {
- "name": "B02",
- "common_name": "blue",
- "center_wavelength": 0.4924,
- "full_width_half_max": 0.066
}, - {
- "name": "B03",
- "common_name": "green",
- "center_wavelength": 0.5598,
- "full_width_half_max": 0.036
}, - {
- "name": "B04",
- "common_name": "red",
- "center_wavelength": 0.6646,
- "full_width_half_max": 0.031
}, - {
- "name": "B05",
- "center_wavelength": 0.7041,
- "full_width_half_max": 0.015
}, - {
- "name": "B06",
- "center_wavelength": 0.7405,
- "full_width_half_max": 0.015
}, - {
- "name": "B07",
- "center_wavelength": 0.7828,
- "full_width_half_max": 0.02
}, - {
- "name": "B08",
- "common_name": "nir",
- "center_wavelength": 0.8328,
- "full_width_half_max": 0.106
}, - {
- "name": "B8A",
- "common_name": "nir08",
- "center_wavelength": 0.8647,
- "full_width_half_max": 0.021
}, - {
- "name": "B09",
- "common_name": "nir09",
- "center_wavelength": 0.9451,
- "full_width_half_max": 0.02
}, - {
- "name": "B11",
- "common_name": "swir16",
- "center_wavelength": 1.6137,
- "full_width_half_max": 0.091
}, - {
- "name": "B12",
- "common_name": "swir22",
- "center_wavelength": 2.2024,
- "full_width_half_max": 0.175
}
]
}, - "links": [
- {
- "rel": "root",
- "type": "application/json"
}, - {
- "rel": "self",
- "type": "application/json"
}, - {
- "rel": "parent",
- "type": "application/json"
}, - {
- "type": "application/schema+json"
}, - {
- "rel": "items",
- "type": "application/geo+json"
}
]
}
]
}
A single Feature Collection for the given if collectionId
.
Request this endpoint to get a full list of metadata for the Feature Collection.
collectionId required | string local identifier of a collection |
stac_version required | string (CatalogStacVersion) |
Array of Reference to a JSON Schema (string) or Reference to a core extension (string) (CatalogStacExtensions) unique | |
type required | string |
id required | string identifier of the collection used, for example, in URIs |
title | string human readable title of the collection |
description required | string Detailed multi-line description to fully explain the catalog or collection. CommonMark 0.29 syntax MAY be used for rich text representation. |
keywords | Array of strings List of keywords describing the collection. |
license required | string (CatalogLicense) License(s) of the data as a SPDX
License identifier. Alternatively, use
Non-SPDX licenses SHOULD add a link to the license text with the
|
required | object (CatalogExtent) The extent of the features in the collection. In the Core only spatial and temporal extents are specified. Extensions may add additional members to represent other extents, for example, thermal or pressure ranges. The first item in the array describes the overall extent of the data. All subsequent items describe more precise extents, e.g., to identify clusters of data. Clients only interested in the overall extent will only need to access the first item in each array. |
Array of objects (CatalogProviders) A list of providers, which may include all organizations capturing or processing the data or the hosting provider. Providers should be listed in chronological order with the most recent provider being the last element of the list. | |
required | Array of objects (CatalogLinks) |
object Summaries are either a unique set of all available values or
statistics. Statistics by default only specify the range (minimum
and maximum values), but can optionally be accompanied by additional
statistical values. The range can specify the potential range of
values, but it is recommended to be as precise as possible. The set
of values must contain at least one element and it is strongly
recommended to list all values. It is recommended to list as many
properties as reasonable so that consumers get a full overview of
the Collection. Properties that are covered by the Collection
specification (e.g. |
{- "stac_version": "1.0.0",
- "type": "Collection",
- "id": "sentinel-2-l2a",
- "title": "Sentinel 2 L2A",
- "description": "Sentinel 2 imagery processed to level 2A",
- "sci:citation": "Modified Copernicus Sentinel data [Year]/Sentinel Hub",
- "license": "proprietary",
- "providers": [
], - "extent": {
- "spatial": {
- "bbox": [
- [
- -180,
- -56,
- 180,
- 83
]
]
}, - "temporal": {
- "interval": [
- [
- "2016-11-01T00:00:00Z",
- null
]
]
}
}, - "summaries": {
- "platform": [
- "sentinel-2a",
- "sentinel-2b"
], - "instrument": [
- "msi"
], - "constellation": [
- "sentinel-2"
], - "gsd": [
- 10
], - "eo:cloud_cover": {
- "minimum": 0,
- "maximum": 100
}, - "eo:bands": [
- {
- "name": "B01",
- "common_name": "coastal",
- "center_wavelength": 0.4427,
- "full_width_half_max": 0.021
}, - {
- "name": "B02",
- "common_name": "blue",
- "center_wavelength": 0.4924,
- "full_width_half_max": 0.066
}, - {
- "name": "B03",
- "common_name": "green",
- "center_wavelength": 0.5598,
- "full_width_half_max": 0.036
}, - {
- "name": "B04",
- "common_name": "red",
- "center_wavelength": 0.6646,
- "full_width_half_max": 0.031
}, - {
- "name": "B05",
- "center_wavelength": 0.7041,
- "full_width_half_max": 0.015
}, - {
- "name": "B06",
- "center_wavelength": 0.7405,
- "full_width_half_max": 0.015
}, - {
- "name": "B07",
- "center_wavelength": 0.7828,
- "full_width_half_max": 0.02
}, - {
- "name": "B08",
- "common_name": "nir",
- "center_wavelength": 0.8328,
- "full_width_half_max": 0.106
}, - {
- "name": "B8A",
- "common_name": "nir08",
- "center_wavelength": 0.8647,
- "full_width_half_max": 0.021
}, - {
- "name": "B09",
- "common_name": "nir09",
- "center_wavelength": 0.9451,
- "full_width_half_max": 0.02
}, - {
- "name": "B11",
- "common_name": "swir16",
- "center_wavelength": 1.6137,
- "full_width_half_max": 0.091
}, - {
- "name": "B12",
- "common_name": "swir22",
- "center_wavelength": 2.2024,
- "full_width_half_max": 0.175
}
]
}, - "links": [
- {
- "rel": "root",
- "type": "application/json"
}, - {
- "rel": "self",
- "type": "application/json"
}, - {
- "rel": "parent",
- "type": "application/json"
}, - {
- "type": "application/schema+json"
}, - {
- "rel": "items",
- "type": "application/geo+json"
}
]
}
This endpoint returns a list of variable terms that can be used in CQL2 expressions. The precise definition of this can be found in the OGC API - Features - Part 3: Filtering and the Common Query Language (CQL) specification.
collectionId required | string ID of Collection |
{- "type": "object",
- "title": "Queryables for Catalog STAC API",
- "description": "Queryable names for the Catalog STAC API Item Search filter.",
- "properties": {
- "eo:cloud_cover": {
- "description": "Cloud Cover",
- "type": "number",
- "minimum": 0,
- "maximum": 100
}
}, - "additionalProperties": false
}
This is an OpenAPI definition of the SpatioTemporal Asset Catalog API - Features specification. This extends OGC API - Features - Part 1: Core.
Fetch features of the feature collection with id collectionId
.
Every feature in a dataset belongs to a collection. A dataset may consist of multiple feature collections. A feature collection is often a collection of features of a similar type, based on a common schema.
collectionId required | string local identifier of a collection |
limit | integer [ 1 .. 100 ] Default: 10 The optional limit parameter recommends the number of items that should be present in the response document. If the limit parameter value is greater than advertised limit maximum, the server must return the maximum possible number of items, rather than responding with an error. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items must not be counted. Minimum = 1. Maximum = 100. Default = 10. |
Array of numbers or Array of numbers Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (height or depth):
The coordinate reference system of the values is WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84). For WGS 84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge). If the vertical axis is included, the third and the sixth number are the bottom and the top of the 3-dimensional bounding box. If a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries. | |
datetime | string Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots. Examples:
Only features that have a temporal property that intersects the value of
If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties. |
type required | string Value: "FeatureCollection" |
required | Array of objects (featureGeoJSON) |
Array of objects (CatalogLinks) | |
timeStamp | string <date-time> (CatalogFeaturesTimeStamp) This property indicates the time and date when the response was generated. |
numberReturned | integer (CatalogFeaturesNumberReturned) >= 0 The number of features in the feature collection. A server may omit this information in a response, if the information about the number of features is not known or difficult to compute. If the value is provided, the value must be identical to the number of items in the "features" array. |
{- "type": "FeatureCollection",
- "features": [
- {
- "stac_version": "1.0.0",
- "id": "S2B_MSIL2A_20201229T101329_N0214_R022_T33TUK_20201229T115442",
- "type": "Feature",
- "geometry": {
- "type": "MultiPolygon",
- "crs": {
- "type": "name",
- "properties": {
- "name": "urn:ogc:def:crs:OGC::CRS84"
}
}, - "coordinates": [
- [
- [
- [
- 12.456873618680804,
- 45.12550485074961
], - [
- 12.499663722139168,
- 44.138006014975964
], - [
- 13.153277241744092,
- 44.15044712021016
], - [
- 13.558241653952589,
- 45.144727105915536
], - [
- 12.456873618680804,
- 45.12550485074961
]
]
]
]
}, - "bbox": [
- 12.456873618680804,
- 44.138006014975964,
- 13.558241653952589,
- 45.144727105915536
], - "properties": {
- "datetime": "2020-12-29T10:18:19Z",
- "platform": "sentinel-2b",
- "instruments": [
- "msi"
], - "constellation": "sentinel-2",
- "gsd": 10,
- "eo:cloud_cover": 93.93,
- "proj:epsg": 32633,
- "proj:bbox": [
- 300000,
- 4890240,
- 409800,
- 5000040
], - "proj:geometry": {
- "type": "MultiPolygon",
- "crs": {
- "type": "name",
- "properties": {
- "name": "urn:ogc:def:crs:EPSG::32633"
}
}, - "coordinates": [
- [
- [
- [
- 300000.99988415383,
- 5000039.000148304
], - [
- 300000.99989785976,
- 4890241.000124758
], - [
- 352314.4884079728,
- 4890241.000125499
], - [
- 386653.8629171661,
- 5000039.000149397
], - [
- 300000.99988415383,
- 5000039.000148304
]
]
]
]
}
}, - "assets": {
- "data": {
- "href": "s3://sentinel-s2-l2a/tiles/33/T/UK/2020/12/29/0/",
- "title": "s3",
- "type": "inode/directory"
}
}, - "collection": "sentinel-2-l2a",
- "links": [
- {
- "rel": "root",
- "type": "application/json"
}, - {
- "rel": "self",
- "type": "application/geo+json"
}, - {
- "rel": "parent",
- "type": "application/json"
}, - {
- "rel": "collection",
- "type": "application/json"
}, - {
- "rel": "derived_from",
- "title": "scihub download"
}
]
}
], - "links": [
- {
- "rel": "root",
- "type": "application/json"
}, - {
- "rel": "self",
- "type": "application/geo+json"
}, - {
- "rel": "parent",
- "type": "application/json"
}, - {
- "rel": "next",
- "type": "application/geo+json",
- "title": "Next set of results"
}
], - "timeStamp": "2023-05-19T12:54:40.429059Z",
- "numberReturned": 1
}
Fetch the feature with id featureId
in the feature collection
with id collectionId
.
collectionId required | string local identifier of a collection |
featureId required | string local identifier of a feature |
stac_version required | string (CatalogStacVersion) |
Array of Reference to a JSON Schema (string) or Reference to a core extension (string) (CatalogStacExtensions) unique | |
id required | string (CatalogItemId) Provider identifier, a unique ID. |
bbox required | Array of numbers (CatalogBbox) [ 4 .. 6 ] items Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (elevation or depth):
The coordinate reference system of the values is WGS84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84). For WGS84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge). If a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries. Example: The bounding box of the New Zealand Exclusive Economic Zone in
WGS 84 (from 160.6°E to 170°W and from 55.95°S to 25.89°S) would be
represented in JSON as |
required | pointGeoJSON (object) or multipointGeoJSON (object) or linestringGeoJSON (object) or multilinestringGeoJSON (object) or polygonGeoJSON (object) or multipolygonGeoJSON (object) or geometrycollectionGeoJSON (object) (CatalogGeometryGeoJSON) |
type required | string (CatalogItemType) Value: "Feature" The GeoJSON type |
required | Array of objects (CatalogLinks) |
required | object (CatalogProperties) provides the core metadata fields plus extensions |
required | object (CatalogAssets) |
{- "stac_version": "1.0.0",
- "id": "S2B_MSIL2A_20201229T101329_N0214_R022_T33TUK_20201229T115442",
- "type": "Feature",
- "geometry": {
- "type": "MultiPolygon",
- "crs": {
- "type": "name",
- "properties": {
- "name": "urn:ogc:def:crs:OGC::CRS84"
}
}, - "coordinates": [
- [
- [
- [
- 12.456873618680804,
- 45.12550485074961
], - [
- 12.499663722139168,
- 44.138006014975964
], - [
- 13.153277241744092,
- 44.15044712021016
], - [
- 13.558241653952589,
- 45.144727105915536
], - [
- 12.456873618680804,
- 45.12550485074961
]
]
]
]
}, - "bbox": [
- 12.456873618680804,
- 44.138006014975964,
- 13.558241653952589,
- 45.144727105915536
], - "properties": {
- "datetime": "2020-12-29T10:18:19Z",
- "platform": "sentinel-2b",
- "instruments": [
- "msi"
], - "constellation": "sentinel-2",
- "gsd": 10,
- "eo:cloud_cover": 93.93,
- "proj:epsg": 32633,
- "proj:bbox": [
- 300000,
- 4890240,
- 409800,
- 5000040
], - "proj:geometry": {
- "type": "MultiPolygon",
- "crs": {
- "type": "name",
- "properties": {
- "name": "urn:ogc:def:crs:EPSG::32633"
}
}, - "coordinates": [
- [
- [
- [
- 300000.99988415383,
- 5000039.000148304
], - [
- 300000.99989785976,
- 4890241.000124758
], - [
- 352314.4884079728,
- 4890241.000125499
], - [
- 386653.8629171661,
- 5000039.000149397
], - [
- 300000.99988415383,
- 5000039.000148304
]
]
]
]
}
}, - "assets": {
- "data": {
- "href": "s3://sentinel-s2-l2a/tiles/33/T/UK/2020/12/29/0/",
- "title": "s3",
- "type": "inode/directory"
}
}, - "collection": "sentinel-2-l2a",
- "links": [
- {
- "rel": "root",
- "type": "application/json"
}, - {
- "rel": "self",
- "type": "application/geo+json"
}, - {
- "rel": "parent",
- "type": "application/json"
}, - {
- "rel": "collection",
- "type": "application/json"
}, - {
- "rel": "derived_from",
- "title": "scihub download"
}
]
}
This is an OpenAPI definition of the SpatioTemporal Asset Catalog API - Item Search specification.
Retrieve Items matching filters. Intended as a shorthand API for simple queries.
This method is required to implement.
If this endpoint is implemented on a server, it is required to add a
link referring to this endpoint with rel
set to search
to the
links
array in GET /
. As GET
is the default method, the method
may not be set explicitly in the link.
Array of numbers or Array of numbers Example: bbox=13,45,14,46 Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (height or depth):
The coordinate reference system of the values is WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84). For WGS 84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge). If the vertical axis is included, the third and the sixth number are the bottom and the top of the 3-dimensional bounding box. If a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries. Example: The bounding box of the New Zealand Exclusive Economic Zone in
WGS 84 (from 160.6°E to 170°W and from 55.95°S to 25.89°S) would be
represented in JSON as | |
pointGeoJSON (object) or multipointGeoJSON (object) or linestringGeoJSON (object) or multilinestringGeoJSON (object) or polygonGeoJSON (object) or multipolygonGeoJSON (object) or geometrycollectionGeoJSON (object) (geometryGeoJSON) The optional intersects parameter filters the result Items in the same was as bbox, only with a GeoJSON Geometry rather than a bbox. | |
datetime required | string Example: datetime=2020-12-10T00:00:00Z/2020-12-30T00:00:00Z Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots. Examples:
Only features that have a temporal property that intersects the value of
If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties. |
limit | integer [ 1 .. 100 ] Default: 10 Example: limit=1 The optional limit parameter recommends the number of items that should be present in the response document. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items must not be counted. Minimum = 1. Maximum = 100. Default = 10. |
ids | Array of strings (ids) Array of Item ids to return. |
collections required | Array of strings (collectionsArray) = 1 items Example: collections=sentinel-2-l2a Array of Collection IDs to include in the search for items. Only Item objects in one of the provided collections will be searched |
fields | string Example: fields=id,type,-geometry,bbox,properties,-links,-assets Extension: Fields Determines the shape of the features in the response |
filter | string (filter-cql2-text) Example: filter=eo:cloud_cover>90 Extension: Filter A CQL2 filter expression for filtering items. |
distinct | string Extension: Distinct Return distinct values of specified property. |
type required | string Value: "FeatureCollection" |
required | Array of objects (item) |
Array of objects (Link) An array of links. Can be used for pagination, e.g. by providing a link with the | |
object |
{- "type": "FeatureCollection",
- "features": [
- {
- "bbox": [
- 12.456873618680804,
- 44.138006014975964,
- 13.558241653952589,
- 45.144727105915536
], - "id": "S2B_MSIL2A_20201229T101329_N0214_R022_T33TUK_20201229T115442",
- "type": "Feature",
- "properties": {
- "proj:epsg": 32633,
- "datetime": "2020-12-29T10:18:19Z",
- "instruments": [
- "msi"
], - "constellation": "sentinel-2",
- "proj:geometry": {
- "crs": {
- "type": "name",
- "properties": {
- "name": "urn:ogc:def:crs:EPSG::32633"
}
}, - "coordinates": [
- [
- [
- [
- 300000.99988415383,
- 5000039.000148304
], - [
- 300000.99989785976,
- 4890241.000124758
], - [
- 352314.4884079728,
- 4890241.000125499
], - [
- 386653.8629171661,
- 5000039.000149397
], - [
- 300000.99988415383,
- 5000039.000148304
]
]
]
], - "type": "MultiPolygon"
}, - "eo:cloud_cover": 93.93,
- "gsd": 10,
- "proj:bbox": [
- 300000,
- 4890240,
- 409800,
- 5000040
], - "platform": "sentinel-2b"
}
}
], - "links": [
- {
- "rel": "self",
- "type": "application/geo+json"
}, - {
- "rel": "next",
- "type": "application/geo+json",
- "title": "Next set of results"
}
], - "context": {
- "next": 1,
- "limit": 1,
- "returned": 1
}
}
Retrieve items matching filters. Intended as the standard, full-featured query API.
This method is optional to implement, but recommended.
If this endpoint is implemented on a server, it is required to add a
link referring to this endpoint with rel
set to search
and method
set to POST
to the links
array in GET /
.
bbox | Array of numbers (CatalogBbox) [ 4 .. 6 ] items Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (elevation or depth):
The coordinate reference system of the values is WGS84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84). For WGS84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge). If a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries. Example: The bounding box of the New Zealand Exclusive Economic Zone in
WGS 84 (from 160.6°E to 170°W and from 55.95°S to 25.89°S) would be
represented in JSON as |
datetime required | string (CatalogItemSearchDatetimeInterval) Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots. Examples:
Only features that have a temporal property that intersects the value of
If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties. |
pointGeoJSON (object) or multipointGeoJSON (object) or linestringGeoJSON (object) or multilinestringGeoJSON (object) or polygonGeoJSON (object) or multipolygonGeoJSON (object) or geometrycollectionGeoJSON (object) (CatalogGeometryGeoJSON) | |
collections required | Array of strings (CatalogItemSearchCollectionsArray) = 1 items Array of Collection IDs to include in the search for items. Only Item objects in one of the provided collections will be searched. |
ids | Array of strings (CatalogItemSearchIds) Array of Item ids to return. |
limit | integer (CatalogItemSearchLimit) [ 1 .. 100 ] The optional limit parameter limits the number of items that are presented in the response document. If the limit parameter value is greater than advertised limit maximum, the server must return the maximum possible number of items, rather than responding with an error. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items must not be counted. Minimum = 1. Maximum = 100. Default = 10. |
object (CatalogItemSearchFieldsFields) The include and exclude members specify an array of property names that are either included or excluded from the result, respectively. If both include and exclude are specified, include takes precedence. Values should include the full JSON path of the property. | |
andExpression (object) or cql2NotExpression (object) or (comparisonPredicate (binaryComparisonPredicate (object) or isBetweenPredicate (object))) (CatalogItemSearchFilterFilterCql2Json) | |
filter-lang | string (CatalogItemSearchFilterFilterLang) Enum: "cql2-text" "cql2-json" The CQL2 filter encoding that the 'filter' value uses. |
filter-crs | string <uri> (CatalogItemSearchFilterFilterCrs) The coordinate reference system (CRS) used by spatial literals in the 'filter' value. The only value that STAC APIs must accept is 'http://www.opengis.net/def/crs/OGC/1.3/CRS84'. |
distinct | string (CatalogItemSearchDistinctDistinct) Return distinct values of specified property. |
type required | string Value: "FeatureCollection" |
required | Array of objects (item) |
Array of objects (Link) An array of links. Can be used for pagination, e.g. by providing a link with the | |
object |
{- "collections": [
- "sentinel-2-l2a"
], - "bbox": [
- 13,
- 45,
- 14,
- 46
], - "datetime": "2020-12-10T00:00:00Z/2020-12-30T00:00:00Z",
- "fields": {
- "include": [
- "id",
- "type",
- "bbox",
- "properties"
], - "exclude": [
- "geometry",
- "links",
- "assets"
]
}, - "filter": {
- "op": ">",
- "args": [
- {
- "property": "eo:cloud_cover"
}, - 90
]
}, - "filter-lang": "cql2-json",
- "limit": 1
}
{- "type": "FeatureCollection",
- "features": [
- {
- "bbox": [
- 12.456873618680804,
- 44.138006014975964,
- 13.558241653952589,
- 45.144727105915536
], - "id": "S2B_MSIL2A_20201229T101329_N0214_R022_T33TUK_20201229T115442",
- "type": "Feature",
- "properties": {
- "proj:epsg": 32633,
- "datetime": "2020-12-29T10:18:19Z",
- "instruments": [
- "msi"
], - "constellation": "sentinel-2",
- "proj:geometry": {
- "crs": {
- "type": "name",
- "properties": {
- "name": "urn:ogc:def:crs:EPSG::32633"
}
}, - "coordinates": [
- [
- [
- [
- 300000.99988415383,
- 5000039.000148304
], - [
- 300000.99989785976,
- 4890241.000124758
], - [
- 352314.4884079728,
- 4890241.000125499
], - [
- 386653.8629171661,
- 5000039.000149397
], - [
- 300000.99988415383,
- 5000039.000148304
]
]
]
], - "type": "MultiPolygon"
}, - "eo:cloud_cover": 93.93,
- "gsd": 10,
- "proj:bbox": [
- 300000,
- 4890240,
- 409800,
- 5000040
], - "platform": "sentinel-2b"
}
}
], - "links": [
- {
- "rel": "self",
- "type": "application/geo+json"
}, - {
- "rel": "next",
- "type": "application/geo+json",
- "title": "Next set of results",
- "method": "POST",
- "body": {
- "next": 1
}, - "merge": true
}
], - "context": {
- "next": 1,
- "limit": 1,
- "returned": 1
}
}
required | object (ProcessRequestInput) |
required | object (AsyncProcessRequestOutput) |
evalscript | string Your evalscript. For details, click here. Either this or |
object (ObjectStorageInfo) Reference to your evalscript stored in an object storage. For details, click here. Either this or |
id | string <UUID> UUID of the submitted request |
status | string Value: "RUNNING" Status of the request |
{- "input": {
- "bounds": {
- "bbox": [
- 13.822174072265625,
- 45.85080395917834,
- 14.55963134765625,
- 46.29191774991382
], - "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 14.000701904296873,
- 46.23685258143992
], - [
- 13.822174072265625,
- 46.09037664604301
], - [
- 14.113311767578125,
- 45.85080395917834
], - [
- 14.55963134765625,
- 46.038922598236
], - [
- 14.441528320312498,
- 46.28717293114449
], - [
- 14.17236328125,
- 46.29191774991382
], - [
- 14.000701904296873,
- 46.23685258143992
]
]
]
},
}, - "data": [
- {
- "type": "sentinel-2-l1c",
- "id": "string",
- "dataFilter": {
- "timeRange": {
- "from": "2018-10-01T00:00:00.000Z",
- "to": "2018-11-01T00:00:00.000Z"
}, - "mosaickingOrder": "mostRecent",
- "maxCloudCoverage": 100,
- "previewMode": "DETAIL"
}, - "processing": {
- "upsampling": "NEAREST",
- "downsampling": "NEAREST",
- "harmonizeValues": true
}
}
]
}, - "output": {
- "width": 512,
- "height": 512,
- "resx": 0,
- "resy": 0,
- "responses": [
- {
- "identifier": "<identifier>",
- "format": {
- "type": "image/png"
}
}
], - "delivery": {
- "s3": {
- "url": "string",
- "iamRoleARN": "string",
- "accessKey": "string",
- "secretAccessKey": "string",
- "region": "string"
}
}
}, - "evalscript": "string",
- "evalscriptReference": {
- "s3": {
- "url": "string",
- "iamRoleARN": "string",
- "accessKey": "string",
- "secretAccessKey": "string"
}
}
}
{- "id": "string",
- "status": "RUNNING"
}
The status of the request will only be returned while it's running. After completion (either succeed or failure) this endpoint will return 404.
requestId required | string <uuid> Request ID |
id | string <UUID> UUID of the submitted request |
status | string Value: "RUNNING" Status of the request |
{- "id": "string",
- "status": "RUNNING"
}
required | object (ProcessRequestForBatch) Batch processing equivalent of the Process request. |
tilingGridId | integer <int64> Deprecated This parameter was moved to tilingGrid |
object (TilingGridSettings) Tiling grid settings. | |
resolution | number <double> Deprecated This parameter was moved to tilingGrid. |
object (BatchProcessOutput) Specifies the tile output paths where the results shall be written. Required unless | |
bucketName | string Simplified alternative for specifying where the results shall be written, where only the bucket name is specified. Specifying |
object (BatchZarrParameters) Specifies Zarr creation parameters. If this parameter is specified, all outputs in processRequest must be of the type zarr/array
and neither Note: Zarr output is currently in beta release. Both the request parameters and the output are likely to change in the future. | |
description | string Optional description that can be used to keep track of requests |
id | string <uuid> Identifier |
userId | string <uuid> User that submitted the request |
accountId | string <uuid> Account that submitted the request |
created | string <date-time> Creation time of the request in ISO 8601 |
required | object (ProcessRequestForBatch) Batch processing equivalent of the Process request. |
tilingGridId | integer <int64> Deprecated This parameter was moved to tilingGrid |
object (TilingGridSettings) Tiling grid settings. | |
resolution | number <double> Deprecated This parameter was moved to tilingGrid. |
object (BatchProcessOutput) Specifies the tile output paths where the results shall be written. Required unless | |
bucketName | string Simplified alternative for specifying where the results shall be written, where only the bucket name is specified. Specifying |
object (BatchZarrParameters) Specifies Zarr creation parameters. If this parameter is specified, all outputs in processRequest must be of the type zarr/array
and neither Note: Zarr output is currently in beta release. Both the request parameters and the output are likely to change in the future. | |
description | string Optional description that can be used to keep track of requests |
valueEstimate | number <double> Estimated processing value (cost) of the request in processing units. The accuracy of the estimate depends on your request, as described in the documentation. |
tileCount | integer <int32> Number of output tiles |
tileWidthPx | integer <int32> Tile width in pixels |
tileHeightPx | integer <int32> Tile height in pixels |
userAction | string Enum: "NONE" "ANALYSE" "START" "CANCEL" Last user action on the request |
userActionUpdated | string <date-time> Time of last user action update in ISO 8601 |
status | string Enum: "CREATED" "ANALYSING" "ANALYSIS_DONE" "PROCESSING" "DONE" "PARTIAL" "FAILED" "CANCELED" Current processing status of the request |
error | string Error description for requests that were submitted but failed during analysis or processing |
{- "processRequest": {
- "input": {
- "bounds": {
- "bbox": [
- 13.822174072265625,
- 45.85080395917834,
- 14.55963134765625,
- 46.29191774991382
], - "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 14.000701904296873,
- 46.23685258143992
], - [
- 13.822174072265625,
- 46.09037664604301
], - [
- 14.113311767578125,
- 45.85080395917834
], - [
- 14.55963134765625,
- 46.038922598236
], - [
- 14.441528320312498,
- 46.28717293114449
], - [
- 14.17236328125,
- 46.29191774991382
], - [
- 14.000701904296873,
- 46.23685258143992
]
]
]
},
}, - "data": [
- {
- "type": "sentinel-2-l1c",
- "id": "string",
- "dataFilter": {
- "timeRange": {
- "from": "2018-10-01T00:00:00.000Z",
- "to": "2018-11-01T00:00:00.000Z"
}, - "mosaickingOrder": "mostRecent",
- "maxCloudCoverage": 100,
- "previewMode": "DETAIL"
}, - "processing": {
- "upsampling": "NEAREST",
- "downsampling": "NEAREST",
- "harmonizeValues": true
}
}
]
}, - "output": {
- "responses": [
- {
- "identifier": "<identifier>",
- "format": {
- "type": "image/tiff"
}
}
]
}, - "evalscript": "string"
}, - "tilingGridId": 0,
- "tilingGrid": {
- "id": 0,
- "resolution": 0,
- "bufferX": 0,
- "bufferY": 0
}, - "resolution": 0,
- "output": {
- "defaultTilePath": "string",
- "overwrite": false,
- "skipExisting": false,
- "cogOutput": false,
- "cogParameters": {
- "overviewLevels": [
- 0
], - "overviewMinSize": 0,
- "resamplingAlgorithm": "nearest",
- "blockxsize": 1024,
- "blockysize": 1024,
- "usePredictor": true
}, - "createCollection": false,
- "collectionId": null
}, - "bucketName": "string",
- "zarrOutput": {
- "path": "string",
- "group": {
- "zarr_format": 2,
- "coordinates": {
- "origin": "topLeft"
}, - "customAttributes": { }
}, - "arrayParameters": {
- "dtype": "<f4",
- "order": "C",
- "chunks": [
- 1,
- 1000,
- 1000
], - "fill_value": 0,
- "compressor": {
- "id": "blosc",
- "cname": "lz4",
- "clevel": 5,
- "shuffle": 1,
- "blocksize": 0
}
}, - "arrayOverrides": {
- "array name1": {
- "dtype": "<f4",
- "order": "C",
- "chunks": [
- 1,
- 1000,
- 1000
], - "fill_value": 0,
- "compressor": {
- "id": "blosc",
- "cname": "lz4",
- "clevel": 5,
- "shuffle": 1,
- "blocksize": 0
}, - "customAttributes": { }
}, - "array name2": {
- "dtype": "<f4",
- "order": "C",
- "chunks": [
- 1,
- 1000,
- 1000
], - "fill_value": 0,
- "compressor": {
- "id": "blosc",
- "cname": "lz4",
- "clevel": 5,
- "shuffle": 1,
- "blocksize": 0
}, - "customAttributes": { }
}
}
}, - "description": "string"
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
- "created": "2019-08-24T14:15:22Z",
- "processRequest": {
- "input": {
- "bounds": {
- "bbox": [
- 13.822174072265625,
- 45.85080395917834,
- 14.55963134765625,
- 46.29191774991382
], - "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 14.000701904296873,
- 46.23685258143992
], - [
- 13.822174072265625,
- 46.09037664604301
], - [
- 14.113311767578125,
- 45.85080395917834
], - [
- 14.55963134765625,
- 46.038922598236
], - [
- 14.441528320312498,
- 46.28717293114449
], - [
- 14.17236328125,
- 46.29191774991382
], - [
- 14.000701904296873,
- 46.23685258143992
]
]
]
},
}, - "data": [
- {
- "type": "sentinel-2-l1c",
- "id": "string",
- "dataFilter": {
- "timeRange": {
- "from": "2018-10-01T00:00:00.000Z",
- "to": "2018-11-01T00:00:00.000Z"
}, - "mosaickingOrder": "mostRecent",
- "maxCloudCoverage": 100,
- "previewMode": "DETAIL"
}, - "processing": {
- "upsampling": "NEAREST",
- "downsampling": "NEAREST",
- "harmonizeValues": true
}
}
]
}, - "output": {
- "responses": [
- {
- "identifier": "<identifier>",
- "format": {
- "type": "image/tiff"
}
}
]
}, - "evalscript": "string"
}, - "tilingGridId": 0,
- "tilingGrid": {
- "id": 0,
- "resolution": 0,
- "bufferX": 0,
- "bufferY": 0
}, - "resolution": 0,
- "output": {
- "defaultTilePath": "string",
- "overwrite": false,
- "skipExisting": false,
- "cogOutput": false,
- "cogParameters": {
- "overviewLevels": [
- 0
], - "overviewMinSize": 0,
- "resamplingAlgorithm": "nearest",
- "blockxsize": 1024,
- "blockysize": 1024,
- "usePredictor": true
}, - "createCollection": false,
- "collectionId": null
}, - "bucketName": "string",
- "zarrOutput": {
- "path": "string",
- "group": {
- "zarr_format": 2,
- "coordinates": {
- "origin": "topLeft"
}, - "customAttributes": { }
}, - "arrayParameters": {
- "dtype": "<f4",
- "order": "C",
- "chunks": [
- 1,
- 1000,
- 1000
], - "fill_value": 0,
- "compressor": {
- "id": "blosc",
- "cname": "lz4",
- "clevel": 5,
- "shuffle": 1,
- "blocksize": 0
}
}, - "arrayOverrides": {
- "array name1": {
- "dtype": "<f4",
- "order": "C",
- "chunks": [
- 1,
- 1000,
- 1000
], - "fill_value": 0,
- "compressor": {
- "id": "blosc",
- "cname": "lz4",
- "clevel": 5,
- "shuffle": 1,
- "blocksize": 0
}, - "customAttributes": { }
}, - "array name2": {
- "dtype": "<f4",
- "order": "C",
- "chunks": [
- 1,
- 1000,
- 1000
], - "fill_value": 0,
- "compressor": {
- "id": "blosc",
- "cname": "lz4",
- "clevel": 5,
- "shuffle": 1,
- "blocksize": 0
}, - "customAttributes": { }
}
}
}, - "description": "string",
- "valueEstimate": 0,
- "tileCount": 0,
- "tileWidthPx": 0,
- "tileHeightPx": 0,
- "userAction": "NONE",
- "userActionUpdated": "2019-08-24T14:15:22Z",
- "status": "CREATED",
- "error": "string"
}
collectionId | string <uuid> Filter batch process requests by the collectionId of batch collection. Omit to get all batch process requests, including those not linked to any collection. |
count | integer <int32> Upper limit to the number of items to retrieve. It cannot be larger than the endpoint-specific limit. If omitted, the endpoint-specific limit is used. For more records, use viewtoken to page through. |
viewtoken | string When total number of items is larger than count, the response contains viewtoken. This viewtoken can be used in the next request to retrieve the next page of items. |
search | string Optional search query. Either a single word to search for or multiple words separated by the |
sort | string Enum: "created" "created:desc" "status" "status:desc" Sort the batch process requests by given field. Omit for default ordering. |
Array of objects (BatchProcessRequest) | |
object (View) Links to paginate the resource |
{- "data": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
- "created": "2019-08-24T14:15:22Z",
- "processRequest": {
- "input": {
- "bounds": {
- "bbox": [
- 13.822174072265625,
- 45.85080395917834,
- 14.55963134765625,
- 46.29191774991382
], - "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 14.000701904296873,
- 46.23685258143992
], - [
- 13.822174072265625,
- 46.09037664604301
], - [
- 14.113311767578125,
- 45.85080395917834
], - [
- 14.55963134765625,
- 46.038922598236
], - [
- 14.441528320312498,
- 46.28717293114449
], - [
- 14.17236328125,
- 46.29191774991382
], - [
- 14.000701904296873,
- 46.23685258143992
]
]
]
},
}, - "data": [
- {
- "type": "sentinel-2-l1c",
- "id": "string",
- "dataFilter": {
- "timeRange": {
- "from": "2018-10-01T00:00:00.000Z",
- "to": "2018-11-01T00:00:00.000Z"
}, - "mosaickingOrder": "mostRecent",
- "maxCloudCoverage": 100,
- "previewMode": "DETAIL"
}, - "processing": {
- "upsampling": "NEAREST",
- "downsampling": "NEAREST",
- "harmonizeValues": true
}
}
]
}, - "output": {
- "responses": [
- {
- "identifier": "<identifier>",
- "format": {
- "type": "image/tiff"
}
}
]
}, - "evalscript": "string"
}, - "tilingGridId": 0,
- "tilingGrid": {
- "id": 0,
- "resolution": 0,
- "bufferX": 0,
- "bufferY": 0
}, - "resolution": 0,
- "output": {
- "defaultTilePath": "string",
- "overwrite": false,
- "skipExisting": false,
- "cogOutput": false,
- "cogParameters": {
- "overviewLevels": [
- 0
], - "overviewMinSize": 0,
- "resamplingAlgorithm": "nearest",
- "blockxsize": 1024,
- "blockysize": 1024,
- "usePredictor": true
}, - "createCollection": false,
- "collectionId": null
}, - "bucketName": "string",
- "zarrOutput": {
- "path": "string",
- "group": {
- "zarr_format": 2,
- "coordinates": {
- "origin": "topLeft"
}, - "customAttributes": { }
}, - "arrayParameters": {
- "dtype": "<f4",
- "order": "C",
- "chunks": [
- 1,
- 1000,
- 1000
], - "fill_value": 0,
- "compressor": {
- "id": "blosc",
- "cname": "lz4",
- "clevel": 5,
- "shuffle": 1,
- "blocksize": 0
}
}, - "arrayOverrides": {
- "array name1": {
- "dtype": "<f4",
- "order": "C",
- "chunks": [
- 1,
- 1000,
- 1000
], - "fill_value": 0,
- "compressor": {
- "id": "blosc",
- "cname": "lz4",
- "clevel": 5,
- "shuffle": 1,
- "blocksize": 0
}, - "customAttributes": { }
}, - "array name2": {
- "dtype": "<f4",
- "order": "C",
- "chunks": [
- 1,
- 1000,
- 1000
], - "fill_value": 0,
- "compressor": {
- "id": "blosc",
- "cname": "lz4",
- "clevel": 5,
- "shuffle": 1,
- "blocksize": 0
}, - "customAttributes": { }
}
}
}, - "description": "string",
- "valueEstimate": 0,
- "tileCount": 0,
- "tileWidthPx": 0,
- "tileHeightPx": 0,
- "userAction": "NONE",
- "userActionUpdated": "2019-08-24T14:15:22Z",
- "status": "CREATED",
- "error": "string"
}
], - "links": {
- "currentToken": "string",
- "nextToken": "string",
- "previousToken": "string",
}
}
requestId required | string <uuid> Request ID |
id | string <uuid> Identifier |
userId | string <uuid> User that submitted the request |
accountId | string <uuid> Account that submitted the request |
created | string <date-time> Creation time of the request in ISO 8601 |
required | object (ProcessRequestForBatch) Batch processing equivalent of the Process request. |
tilingGridId | integer <int64> Deprecated This parameter was moved to tilingGrid |
object (TilingGridSettings) Tiling grid settings. | |
resolution | number <double> Deprecated This parameter was moved to tilingGrid. |
object (BatchProcessOutput) Specifies the tile output paths where the results shall be written. Required unless | |
bucketName | string Simplified alternative for specifying where the results shall be written, where only the bucket name is specified. Specifying |
object (BatchZarrParameters) Specifies Zarr creation parameters. If this parameter is specified, all outputs in processRequest must be of the type zarr/array
and neither Note: Zarr output is currently in beta release. Both the request parameters and the output are likely to change in the future. | |
description | string Optional description that can be used to keep track of requests |
valueEstimate | number <double> Estimated processing value (cost) of the request in processing units. The accuracy of the estimate depends on your request, as described in the documentation. |
tileCount | integer <int32> Number of output tiles |
tileWidthPx | integer <int32> Tile width in pixels |
tileHeightPx | integer <int32> Tile height in pixels |
userAction | string Enum: "NONE" "ANALYSE" "START" "CANCEL" Last user action on the request |
userActionUpdated | string <date-time> Time of last user action update in ISO 8601 |
status | string Enum: "CREATED" "ANALYSING" "ANALYSIS_DONE" "PROCESSING" "DONE" "PARTIAL" "FAILED" "CANCELED" Current processing status of the request |
error | string Error description for requests that were submitted but failed during analysis or processing |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
- "created": "2019-08-24T14:15:22Z",
- "processRequest": {
- "input": {
- "bounds": {
- "bbox": [
- 13.822174072265625,
- 45.85080395917834,
- 14.55963134765625,
- 46.29191774991382
], - "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 14.000701904296873,
- 46.23685258143992
], - [
- 13.822174072265625,
- 46.09037664604301
], - [
- 14.113311767578125,
- 45.85080395917834
], - [
- 14.55963134765625,
- 46.038922598236
], - [
- 14.441528320312498,
- 46.28717293114449
], - [
- 14.17236328125,
- 46.29191774991382
], - [
- 14.000701904296873,
- 46.23685258143992
]
]
]
},
}, - "data": [
- {
- "type": "sentinel-2-l1c",
- "id": "string",
- "dataFilter": {
- "timeRange": {
- "from": "2018-10-01T00:00:00.000Z",
- "to": "2018-11-01T00:00:00.000Z"
}, - "mosaickingOrder": "mostRecent",
- "maxCloudCoverage": 100,
- "previewMode": "DETAIL"
}, - "processing": {
- "upsampling": "NEAREST",
- "downsampling": "NEAREST",
- "harmonizeValues": true
}
}
]
}, - "output": {
- "responses": [
- {
- "identifier": "<identifier>",
- "format": {
- "type": "image/tiff"
}
}
]
}, - "evalscript": "string"
}, - "tilingGridId": 0,
- "tilingGrid": {
- "id": 0,
- "resolution": 0,
- "bufferX": 0,
- "bufferY": 0
}, - "resolution": 0,
- "output": {
- "defaultTilePath": "string",
- "overwrite": false,
- "skipExisting": false,
- "cogOutput": false,
- "cogParameters": {
- "overviewLevels": [
- 0
], - "overviewMinSize": 0,
- "resamplingAlgorithm": "nearest",
- "blockxsize": 1024,
- "blockysize": 1024,
- "usePredictor": true
}, - "createCollection": false,
- "collectionId": null
}, - "bucketName": "string",
- "zarrOutput": {
- "path": "string",
- "group": {
- "zarr_format": 2,
- "coordinates": {
- "origin": "topLeft"
}, - "customAttributes": { }
}, - "arrayParameters": {
- "dtype": "<f4",
- "order": "C",
- "chunks": [
- 1,
- 1000,
- 1000
], - "fill_value": 0,
- "compressor": {
- "id": "blosc",
- "cname": "lz4",
- "clevel": 5,
- "shuffle": 1,
- "blocksize": 0
}
}, - "arrayOverrides": {
- "array name1": {
- "dtype": "<f4",
- "order": "C",
- "chunks": [
- 1,
- 1000,
- 1000
], - "fill_value": 0,
- "compressor": {
- "id": "blosc",
- "cname": "lz4",
- "clevel": 5,
- "shuffle": 1,
- "blocksize": 0
}, - "customAttributes": { }
}, - "array name2": {
- "dtype": "<f4",
- "order": "C",
- "chunks": [
- 1,
- 1000,
- 1000
], - "fill_value": 0,
- "compressor": {
- "id": "blosc",
- "cname": "lz4",
- "clevel": 5,
- "shuffle": 1,
- "blocksize": 0
}, - "customAttributes": { }
}
}
}, - "description": "string",
- "valueEstimate": 0,
- "tileCount": 0,
- "tileWidthPx": 0,
- "tileHeightPx": 0,
- "userAction": "NONE",
- "userActionUpdated": "2019-08-24T14:15:22Z",
- "status": "CREATED",
- "error": "string"
}
Only the requests that are not currently being processed nor waiting to be processed can be updated.
requestId required | string <uuid> Request ID |
object Modified | |
description | string Optional description that can be used to keep track of requests. If omitted, the description will not be changed. |
id | string <uuid> Identifier |
userId | string <uuid> User that submitted the request |
accountId | string <uuid> Account that submitted the request |
created | string <date-time> Creation time of the request in ISO 8601 |
required | object (ProcessRequestForBatch) Batch processing equivalent of the Process request. |
tilingGridId | integer <int64> Deprecated This parameter was moved to tilingGrid |
object (TilingGridSettings) Tiling grid settings. | |
resolution | number <double> Deprecated This parameter was moved to tilingGrid. |
object (BatchProcessOutput) Specifies the tile output paths where the results shall be written. Required unless | |
bucketName | string Simplified alternative for specifying where the results shall be written, where only the bucket name is specified. Specifying |
object (BatchZarrParameters) Specifies Zarr creation parameters. If this parameter is specified, all outputs in processRequest must be of the type zarr/array
and neither Note: Zarr output is currently in beta release. Both the request parameters and the output are likely to change in the future. | |
description | string Optional description that can be used to keep track of requests |
valueEstimate | number <double> Estimated processing value (cost) of the request in processing units. The accuracy of the estimate depends on your request, as described in the documentation. |
tileCount | integer <int32> Number of output tiles |
tileWidthPx | integer <int32> Tile width in pixels |
tileHeightPx | integer <int32> Tile height in pixels |
userAction | string Enum: "NONE" "ANALYSE" "START" "CANCEL" Last user action on the request |
userActionUpdated | string <date-time> Time of last user action update in ISO 8601 |
status | string Enum: "CREATED" "ANALYSING" "ANALYSIS_DONE" "PROCESSING" "DONE" "PARTIAL" "FAILED" "CANCELED" Current processing status of the request |
error | string Error description for requests that were submitted but failed during analysis or processing |
{- "output": {
- "collectionId": null
}, - "description": "string"
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
- "created": "2019-08-24T14:15:22Z",
- "processRequest": {
- "input": {
- "bounds": {
- "bbox": [
- 13.822174072265625,
- 45.85080395917834,
- 14.55963134765625,
- 46.29191774991382
], - "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 14.000701904296873,
- 46.23685258143992
], - [
- 13.822174072265625,
- 46.09037664604301
], - [
- 14.113311767578125,
- 45.85080395917834
], - [
- 14.55963134765625,
- 46.038922598236
], - [
- 14.441528320312498,
- 46.28717293114449
], - [
- 14.17236328125,
- 46.29191774991382
], - [
- 14.000701904296873,
- 46.23685258143992
]
]
]
},
}, - "data": [
- {
- "type": "sentinel-2-l1c",
- "id": "string",
- "dataFilter": {
- "timeRange": {
- "from": "2018-10-01T00:00:00.000Z",
- "to": "2018-11-01T00:00:00.000Z"
}, - "mosaickingOrder": "mostRecent",
- "maxCloudCoverage": 100,
- "previewMode": "DETAIL"
}, - "processing": {
- "upsampling": "NEAREST",
- "downsampling": "NEAREST",
- "harmonizeValues": true
}
}
]
}, - "output": {
- "responses": [
- {
- "identifier": "<identifier>",
- "format": {
- "type": "image/tiff"
}
}
]
}, - "evalscript": "string"
}, - "tilingGridId": 0,
- "tilingGrid": {
- "id": 0,
- "resolution": 0,
- "bufferX": 0,
- "bufferY": 0
}, - "resolution": 0,
- "output": {
- "defaultTilePath": "string",
- "overwrite": false,
- "skipExisting": false,
- "cogOutput": false,
- "cogParameters": {
- "overviewLevels": [
- 0
], - "overviewMinSize": 0,
- "resamplingAlgorithm": "nearest",
- "blockxsize": 1024,
- "blockysize": 1024,
- "usePredictor": true
}, - "createCollection": false,
- "collectionId": null
}, - "bucketName": "string",
- "zarrOutput": {
- "path": "string",
- "group": {
- "zarr_format": 2,
- "coordinates": {
- "origin": "topLeft"
}, - "customAttributes": { }
}, - "arrayParameters": {
- "dtype": "<f4",
- "order": "C",
- "chunks": [
- 1,
- 1000,
- 1000
], - "fill_value": 0,
- "compressor": {
- "id": "blosc",
- "cname": "lz4",
- "clevel": 5,
- "shuffle": 1,
- "blocksize": 0
}
}, - "arrayOverrides": {
- "array name1": {
- "dtype": "<f4",
- "order": "C",
- "chunks": [
- 1,
- 1000,
- 1000
], - "fill_value": 0,
- "compressor": {
- "id": "blosc",
- "cname": "lz4",
- "clevel": 5,
- "shuffle": 1,
- "blocksize": 0
}, - "customAttributes": { }
}, - "array name2": {
- "dtype": "<f4",
- "order": "C",
- "chunks": [
- 1,
- 1000,
- 1000
], - "fill_value": 0,
- "compressor": {
- "id": "blosc",
- "cname": "lz4",
- "clevel": 5,
- "shuffle": 1,
- "blocksize": 0
}, - "customAttributes": { }
}
}
}, - "description": "string",
- "valueEstimate": 0,
- "tileCount": 0,
- "tileWidthPx": 0,
- "tileHeightPx": 0,
- "userAction": "NONE",
- "userActionUpdated": "2019-08-24T14:15:22Z",
- "status": "CREATED",
- "error": "string"
}
Deletes a batch process request if it:
Requests that have been confirmed or are currently being processed or analysed must be canceled before deletion. Requests with processed tiles cannot be deleted.
requestId required | string <uuid> Request ID |
{- "error": {
- "status": 0,
- "reason": "string",
- "message": "string",
- "code": "COMMON_BAD_PAYLOAD",
- "errors": { }
}
}
Restart processing of failed tiles in a partially processed request
requestId required | string <uuid> Request ID |
{- "error": {
- "status": 0,
- "reason": "string",
- "message": "string",
- "code": "COMMON_BAD_PAYLOAD",
- "errors": { }
}
}
name required | string Collection name |
s3Bucket required | string S3 bucket where data will get ingested |
id | string <uuid> |
userId | string <uuid> |
accountId | string <uuid> |
name | string |
s3Bucket | string |
object | |
object (BYOCCollectionAdditionalData) | |
created | string or null The date when the collection was created. |
{- "name": "string",
- "s3Bucket": "string"
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
- "name": "string",
- "s3Bucket": "string",
- "batchData": {
- "tilingGridId": 0
}, - "additionalData": {
- "bands": {
- "band1": {
- "source": "string",
- "bandIndex": 1,
- "bitDepth": 8,
- "sampleFormat": "UINT",
- "noData": 0
}, - "band2": {
- "source": "string",
- "bandIndex": 1,
- "bitDepth": 8,
- "sampleFormat": "UINT",
- "noData": 0
}
}, - "maxMetersPerPixel": 0,
- "extent": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 0,
- 0
]
]
]
}, - "hasSensingTimes": "YES",
- "fromSensingTime": "2019-08-24T14:15:22Z",
- "toSensingTime": "2019-08-24T14:15:22Z",
- "storageIdentifier": "string"
}, - "created": "string"
}
count | integer <int32> Upper limit to the number of items to retrieve. It cannot be larger than the endpoint-specific limit. If omitted, the endpoint-specific limit is used. For more records, use viewtoken to page through. |
viewtoken | string When total number of items is larger than count, the response contains viewtoken. This viewtoken can be used in the next request to retrieve the next page of items. |
search | string Optional search query. Either a single word to search for or multiple words separated by the |
Array of objects (BatchCollection) | |
object (View) Links to paginate the resource |
{- "data": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
- "name": "string",
- "s3Bucket": "string",
- "batchData": {
- "tilingGridId": 0
}, - "additionalData": {
- "bands": {
- "band1": {
- "source": "string",
- "bandIndex": 1,
- "bitDepth": 8,
- "sampleFormat": "UINT",
- "noData": 0
}, - "band2": {
- "source": "string",
- "bandIndex": 1,
- "bitDepth": 8,
- "sampleFormat": "UINT",
- "noData": 0
}
}, - "maxMetersPerPixel": 0,
- "extent": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 0,
- 0
]
]
]
}, - "hasSensingTimes": "YES",
- "fromSensingTime": "2019-08-24T14:15:22Z",
- "toSensingTime": "2019-08-24T14:15:22Z",
- "storageIdentifier": "string"
}, - "created": "string"
}
], - "links": {
- "currentToken": "string",
- "nextToken": "string",
- "previousToken": "string",
}
}
collectionId required | string <uuid> Collection ID |
id | string <uuid> |
userId | string <uuid> |
accountId | string <uuid> |
name | string |
s3Bucket | string |
object | |
object (BYOCCollectionAdditionalData) | |
created | string or null The date when the collection was created. |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
- "name": "string",
- "s3Bucket": "string",
- "batchData": {
- "tilingGridId": 0
}, - "additionalData": {
- "bands": {
- "band1": {
- "source": "string",
- "bandIndex": 1,
- "bitDepth": 8,
- "sampleFormat": "UINT",
- "noData": 0
}, - "band2": {
- "source": "string",
- "bandIndex": 1,
- "bitDepth": 8,
- "sampleFormat": "UINT",
- "noData": 0
}
}, - "maxMetersPerPixel": 0,
- "extent": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 0,
- 0
]
]
]
}, - "hasSensingTimes": "YES",
- "fromSensingTime": "2019-08-24T14:15:22Z",
- "toSensingTime": "2019-08-24T14:15:22Z",
- "storageIdentifier": "string"
}, - "created": "string"
}
collectionId required | string <uuid> Collection ID |
name | string Collection name |
{- "name": "string"
}
{- "error": {
- "status": 0,
- "reason": "string",
- "message": "string",
- "code": "COMMON_BAD_PAYLOAD",
- "errors": { }
}
}
Deletes a batch collection if it is not being used by any batch process request,
except for possible FAILED
and CANCELED
requests.
collectionId required | string <uuid> Collection ID |
{- "error": {
- "status": 0,
- "reason": "string",
- "message": "string",
- "code": "COMMON_BAD_PAYLOAD",
- "errors": { }
}
}
requestId required | string <uuid> Request ID |
status | string Enum: "PENDING" "SCHEDULED" "QUEUED" "PROCESSING" "PROCESSED" "FAILED" Only tiles with this status will be returned. Omit to get all tiles. |
count | integer <int32> Upper limit to the number of items to retrieve. It cannot be larger than the endpoint-specific limit. If omitted, the endpoint-specific limit is used. For more records, use viewtoken to page through. |
viewtoken | string When total number of items is larger than count, the response contains viewtoken. This viewtoken can be used in the next request to retrieve the next page of items. |
Array of objects (BatchTile) | |
object (View) Links to paginate the resource |
{- "data": [
- {
- "id": 0,
- "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
- "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 0,
- 0
]
]
]
}, - "origin": {
- "type": "Point",
- "coordinates": [
- 0,
- 0
], - "crs": {
- "type": "name",
- "properties": {
- "name": "urn:ogc:def:crs:EPSG::4326"
}
}
}, - "status": "PENDING",
- "error": "string",
- "cost": 0
}
], - "links": {
- "currentToken": "string",
- "nextToken": "string",
- "previousToken": "string",
}
}
requestId required | string <uuid> Request ID |
tileId required | integer <int64> Tile ID |
id | integer <int64> Identifier |
requestId | string <uuid> ID of the request the tile belongs to |
object (Polygon) Geometry of the grid tile that this request tile corresponds to. Note that this may differ from the geometry of the tile's ouput raster due to bufferX/bufferY parameters of your request and due to reprojection from the tile's coordinate reference system to WGS84. The exact output raster geometry can be calculated from the tile's origin, width, height, and your request parameters resolution, bufferX and bufferY. | |
object (BatchTileOrigin) Coordinates of the tile origin (lower left corner) in the tile's CRS. | |
status | string Enum: "PENDING" "SCHEDULED" "QUEUED" "PROCESSING" "PROCESSED" "FAILED" Current processing status of the tile |
error | string Error description for tiles that failed during processing. |
cost | number <double> Tile processing cost (PU) |
{- "id": 0,
- "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
- "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 0,
- 0
]
]
]
}, - "origin": {
- "type": "Point",
- "coordinates": [
- 0,
- 0
], - "crs": {
- "type": "name",
- "properties": {
- "name": "urn:ogc:def:crs:EPSG::4326"
}
}
}, - "status": "PENDING",
- "error": "string",
- "cost": 0
}
count | integer <int32> Upper limit to the number of items to retrieve. It cannot be larger than the endpoint-specific limit. If omitted, the endpoint-specific limit is used. For more records, use viewtoken to page through. |
viewtoken | string When total number of items is larger than count, the response contains viewtoken. This viewtoken can be used in the next request to retrieve the next page of items. |
Array of objects (TilingGridDescriptor) | |
object (View) Links to paginate the resource |
{- "data": [
- {
- "id": 0,
- "name": "string",
- "properties": {
- "tileWidth": 0,
- "tileHeight": 0,
- "resolutions": [
- 0
], - "unit": "METRE"
}
}
], - "links": {
- "currentToken": "string",
- "nextToken": "string",
- "previousToken": "string",
}
}
id required | integer <int64> Tilinggrids ID |
id | integer <int64> Identifier |
name | string |
object (TilingGridDescriptorProperties) |
{- "id": 0,
- "name": "string",
- "properties": {
- "tileWidth": 0,
- "tileHeight": 0,
- "resolutions": [
- 0
], - "unit": "METRE"
}
}
required | object (ProcessRequestInput) |
required | object (StatisticalRequestAggregation) Specifies how data is aggregated and processed before statistics is calculated. |
object (StatisticalRequestCalculations) Define which statistics and histogram to calculate. It can be specified differently for each evalscript output. If omitted only the basic statistic (min, max, mean, stDev) will be calculated. |
Array of objects Statistics for intervals, where data is available. |
{- "input": {
- "bounds": {
- "bbox": [
- 13.822174072265625,
- 45.85080395917834,
- 14.55963134765625,
- 46.29191774991382
], - "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 14.000701904296873,
- 46.23685258143992
], - [
- 13.822174072265625,
- 46.09037664604301
], - [
- 14.113311767578125,
- 45.85080395917834
], - [
- 14.55963134765625,
- 46.038922598236
], - [
- 14.441528320312498,
- 46.28717293114449
], - [
- 14.17236328125,
- 46.29191774991382
], - [
- 14.000701904296873,
- 46.23685258143992
]
]
]
},
}, - "data": [
- {
- "type": "sentinel-2-l1c",
- "id": "string",
- "dataFilter": {
- "timeRange": {
- "from": "2018-10-01T00:00:00.000Z",
- "to": "2018-11-01T00:00:00.000Z"
}, - "mosaickingOrder": "mostRecent",
- "maxCloudCoverage": 100,
- "previewMode": "DETAIL"
}, - "processing": {
- "upsampling": "NEAREST",
- "downsampling": "NEAREST",
- "harmonizeValues": true
}
}
]
}, - "aggregation": {
- "timeRange": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}, - "aggregationInterval": {
- "of": "string",
- "lastIntervalBehavior": "SKIP"
}, - "width": 512,
- "height": 512,
- "resx": 0,
- "resy": 0,
- "evalscript": "string"
}, - "calculations": {
- "output name1": {
- "histograms": {
- "band name1": {
- "nBins": 0,
- "binWidth": 0,
- "lowEdge": 0,
- "highEdge": 0,
- "bins": [
- 0
]
}, - "band name2": {
- "nBins": 0,
- "binWidth": 0,
- "lowEdge": 0,
- "highEdge": 0,
- "bins": [
- 0
]
}
}, - "statistics": {
- "band name1": {
- "percentiles": {
- "k": [
- 1
]
}
}, - "band name2": {
- "percentiles": {
- "k": [
- 1
]
}
}
}
}, - "output name2": {
- "histograms": {
- "band name1": {
- "nBins": 0,
- "binWidth": 0,
- "lowEdge": 0,
- "highEdge": 0,
- "bins": [
- 0
]
}, - "band name2": {
- "nBins": 0,
- "binWidth": 0,
- "lowEdge": 0,
- "highEdge": 0,
- "bins": [
- 0
]
}
}, - "statistics": {
- "band name1": {
- "percentiles": {
- "k": [
- 1
]
}
}, - "band name2": {
- "percentiles": {
- "k": [
- 1
]
}
}
}
}
}
}
{- "data": [
- {
- "interval": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}, - "outputs": {
- "output name1": {
- "bands": {
- "band name1": {
- "histogram": {
- "overflow": 0,
- "underflow": 0,
- "bins": [
- {
- "lowEdge": null,
- "highEdge": null,
- "count": null
}
]
}, - "stats": {
- "min": 0,
- "max": 0,
- "mean": 0,
- "stDev": 0,
- "sampleCount": 0,
- "noDataCount": 0,
- "percentiles": {
- "percentile [0,1]1": 0,
- "percentile [0,1]2": 0
}
}
}, - "band name2": {
- "histogram": {
- "overflow": 0,
- "underflow": 0,
- "bins": [
- {
- "lowEdge": null,
- "highEdge": null,
- "count": null
}
]
}, - "stats": {
- "min": 0,
- "max": 0,
- "mean": 0,
- "stDev": 0,
- "sampleCount": 0,
- "noDataCount": 0,
- "percentiles": {
- "percentile [0,1]1": 0,
- "percentile [0,1]2": 0
}
}
}
}
}, - "output name2": {
- "bands": {
- "band name1": {
- "histogram": {
- "overflow": 0,
- "underflow": 0,
- "bins": [
- {
- "lowEdge": null,
- "highEdge": null,
- "count": null
}
]
}, - "stats": {
- "min": 0,
- "max": 0,
- "mean": 0,
- "stDev": 0,
- "sampleCount": 0,
- "noDataCount": 0,
- "percentiles": {
- "percentile [0,1]1": 0,
- "percentile [0,1]2": 0
}
}
}, - "band name2": {
- "histogram": {
- "overflow": 0,
- "underflow": 0,
- "bins": [
- {
- "lowEdge": null,
- "highEdge": null,
- "count": null
}
]
}, - "stats": {
- "min": 0,
- "max": 0,
- "mean": 0,
- "stDev": 0,
- "sampleCount": 0,
- "noDataCount": 0,
- "percentiles": {
- "percentile [0,1]1": 0,
- "percentile [0,1]2": 0
}
}
}
}
}
}, - "error": {
- "type": "BAD_REQUEST"
}
}
]
}
required | object (BatchStatisticalInput) |
required | object (BatchStatisticalRequestAggregation) Specifies how data is aggregated and processed before statistics is calculated. |
object (StatisticalRequestCalculations) Define which statistics and histogram to calculate. It can be specified differently for each evalscript output. If omitted only the basic statistic (min, max, mean, stDev) will be calculated. | |
required | object (ObjectStorageOutputInfo) Storage location where the results shall be written. |
id | string <uuid> UUID of the submitted request. |
status | string Enum: "CREATED" "ANALYSING" "ANALYSIS_DONE" "PROCESSING" "DONE" "FAILED" "STOPPED" "PARTIAL" Current processing status of the request. Must NOT be specified when creating new requests |
error | string Description of error in case the request failed. |
completionPercentage | number |
lastUpdated | string <date-time> |
costPu | number Cost of the request in processing units |
created | string <date-time> Creation time of the request |
stoppedStatusReason | string Enum: "OUT_OF_PU" "USER_ACTION" The reason for request having status STOPPED. |
object (BatchStatisticalRequest) | |
userId | string <uuid> |
userAction | string Enum: "NONE" "ANALYSE" "START" "STOP" Last user action on the request. |
userActionUpdated | string <date-time> Date of the last user action on the request |
domainAccountId | string <uuid> |
{- "input": {
- "features": {
- "s3": {
- "url": "string",
- "iamRoleARN": "string",
- "accessKey": "string",
- "secretAccessKey": "string"
}
}, - "data": [
- {
- "type": "sentinel-2-l1c",
- "id": "string",
- "dataFilter": {
- "timeRange": {
- "from": "2018-10-01T00:00:00.000Z",
- "to": "2018-11-01T00:00:00.000Z"
}, - "mosaickingOrder": "mostRecent",
- "maxCloudCoverage": 100,
- "previewMode": "DETAIL"
}, - "processing": {
- "upsampling": "NEAREST",
- "downsampling": "NEAREST",
- "harmonizeValues": true
}
}
]
}, - "aggregation": {
- "timeRange": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}, - "aggregationInterval": {
- "of": "string",
- "lastIntervalBehavior": "SKIP"
}, - "width": 512,
- "height": 512,
- "resx": 0,
- "resy": 0,
- "evalscript": "string",
- "evalscriptReference": {
- "s3": {
- "url": "string",
- "iamRoleARN": "string",
- "accessKey": "string",
- "secretAccessKey": "string"
}
}
}, - "calculations": {
- "output name1": {
- "histograms": {
- "band name1": {
- "nBins": 0,
- "binWidth": 0,
- "lowEdge": 0,
- "highEdge": 0,
- "bins": [
- 0
]
}, - "band name2": {
- "nBins": 0,
- "binWidth": 0,
- "lowEdge": 0,
- "highEdge": 0,
- "bins": [
- 0
]
}
}, - "statistics": {
- "band name1": {
- "percentiles": {
- "k": [
- 1
]
}
}, - "band name2": {
- "percentiles": {
- "k": [
- 1
]
}
}
}
}, - "output name2": {
- "histograms": {
- "band name1": {
- "nBins": 0,
- "binWidth": 0,
- "lowEdge": 0,
- "highEdge": 0,
- "bins": [
- 0
]
}, - "band name2": {
- "nBins": 0,
- "binWidth": 0,
- "lowEdge": 0,
- "highEdge": 0,
- "bins": [
- 0
]
}
}, - "statistics": {
- "band name1": {
- "percentiles": {
- "k": [
- 1
]
}
}, - "band name2": {
- "percentiles": {
- "k": [
- 1
]
}
}
}
}
}, - "output": {
- "s3": {
- "url": "string",
- "iamRoleARN": "string",
- "accessKey": "string",
- "secretAccessKey": "string",
- "region": "string"
}
}
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "status": "CREATED",
- "error": "string",
- "completionPercentage": 0,
- "lastUpdated": "2019-08-24T14:15:22Z",
- "costPu": 0,
- "created": "2019-08-24T14:15:22Z",
- "stoppedStatusReason": "OUT_OF_PU",
- "request": {
- "input": {
- "features": {
- "s3": {
- "url": "string",
- "iamRoleARN": "string",
- "accessKey": "string",
- "secretAccessKey": "string"
}
}, - "data": [
- {
- "type": "sentinel-2-l1c",
- "id": "string",
- "dataFilter": {
- "timeRange": {
- "from": "2018-10-01T00:00:00.000Z",
- "to": "2018-11-01T00:00:00.000Z"
}, - "mosaickingOrder": "mostRecent",
- "maxCloudCoverage": 100,
- "previewMode": "DETAIL"
}, - "processing": {
- "upsampling": "NEAREST",
- "downsampling": "NEAREST",
- "harmonizeValues": true
}
}
]
}, - "aggregation": {
- "timeRange": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}, - "aggregationInterval": {
- "of": "string",
- "lastIntervalBehavior": "SKIP"
}, - "width": 512,
- "height": 512,
- "resx": 0,
- "resy": 0,
- "evalscript": "string",
- "evalscriptReference": {
- "s3": {
- "url": "string",
- "iamRoleARN": "string",
- "accessKey": "string",
- "secretAccessKey": "string"
}
}
}, - "calculations": {
- "output name1": {
- "histograms": {
- "band name1": {
- "nBins": 0,
- "binWidth": 0,
- "lowEdge": 0,
- "highEdge": 0,
- "bins": [
- 0
]
}, - "band name2": {
- "nBins": 0,
- "binWidth": 0,
- "lowEdge": 0,
- "highEdge": 0,
- "bins": [
- 0
]
}
}, - "statistics": {
- "band name1": {
- "percentiles": {
- "k": [
- 1
]
}
}, - "band name2": {
- "percentiles": {
- "k": [
- 1
]
}
}
}
}, - "output name2": {
- "histograms": {
- "band name1": {
- "nBins": 0,
- "binWidth": 0,
- "lowEdge": 0,
- "highEdge": 0,
- "bins": [
- 0
]
}, - "band name2": {
- "nBins": 0,
- "binWidth": 0,
- "lowEdge": 0,
- "highEdge": 0,
- "bins": [
- 0
]
}
}, - "statistics": {
- "band name1": {
- "percentiles": {
- "k": [
- 1
]
}
}, - "band name2": {
- "percentiles": {
- "k": [
- 1
]
}
}
}
}
}, - "output": {
- "s3": {
- "url": "string",
- "iamRoleARN": "string",
- "accessKey": "string",
- "secretAccessKey": "string",
- "region": "string"
}
}
}, - "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "userAction": "NONE",
- "userActionUpdated": "2019-08-24T14:15:22Z",
- "domainAccountId": "4e1699b2-af74-455a-818d-6f1ec31a6d19"
}
count | integer <int32> Upper limit to the number of items to retrieve. It cannot be larger than the endpoint-specific limit. If omitted, the endpoint-specific limit is used. For more records, use viewtoken to page through. |
viewtoken | string When total number of items is larger than count, the response contains viewtoken. This viewtoken can be used in the next request to retrieve the next page of items. |
sort | string Enum: "created" "created:desc" "status" "status:desc" Sort the statistical batch requests by given field. Omit for default ordering. |
Array of objects (BatchStatisticsTaskDto) | |
object (View) Links to paginate the resource |
{- "data": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "status": "CREATED",
- "error": "string",
- "completionPercentage": 0,
- "lastUpdated": "2019-08-24T14:15:22Z",
- "costPu": 0,
- "created": "2019-08-24T14:15:22Z",
- "stoppedStatusReason": "OUT_OF_PU",
- "request": {
- "input": {
- "features": {
- "s3": {
- "url": "string",
- "iamRoleARN": "string",
- "accessKey": "string",
- "secretAccessKey": "string"
}
}, - "data": [
- {
- "type": "sentinel-2-l1c",
- "id": "string",
- "dataFilter": {
- "timeRange": {
- "from": "2018-10-01T00:00:00.000Z",
- "to": "2018-11-01T00:00:00.000Z"
}, - "mosaickingOrder": "mostRecent",
- "maxCloudCoverage": 100,
- "previewMode": "DETAIL"
}, - "processing": {
- "upsampling": "NEAREST",
- "downsampling": "NEAREST",
- "harmonizeValues": true
}
}
]
}, - "aggregation": {
- "timeRange": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}, - "aggregationInterval": {
- "of": "string",
- "lastIntervalBehavior": "SKIP"
}, - "width": 512,
- "height": 512,
- "resx": 0,
- "resy": 0,
- "evalscript": "string",
- "evalscriptReference":