Download OpenAPI specification:Download
This API provides the following capabilities for clients.
This API is designed on top of the following specifications.
See also Conformance Classes.
See also STAC API - Item Search.
Retrieve Items matching filters. Intended as a shorthand API for simple queries.
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. 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 | 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. |
limit | integer [ 1 .. 10000 ] Default: 10 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 = 10000. Default = 10. |
collections | Array of strings (collectionsArray) Array of Collection IDs to include in the search for items. Only Item objects in one of the provided collections will be searched |
filter | string Example: filter=ag:capture_id = '52eZg9k7rPEyYQGX' AND avg(eo:cloud_cover) <= 20 The Filter requirements class defines a general parameter, filter, whose value is a filter expression to be applied when retrieving resources. This is necessary to determine which resources should be included in a result set. |
filter-lang | string Value: "cql2-text" Example: filter-lang=cql2-text Any predicate language that can be suitably expressed as the value of an HTTP query parameter may be specified as the value of the filter parameter. In order to specify that specific language that is being used, this clause defines the filter-lang parameter. |
filter-crs | string <uri-reference> For reasons discussed in the W3C/OGC Spatial Data on the Web Best Practices document, spatial coordinates by default are in the coordinate reference system WGS 84 longitude and latitude for 2D coordinates and WGS 84 longitude, latitude and ellipsoidal height in meters for 3D coordinates. For server that support geometries in other coordinate reference systems, the filter-crs parameter defined in this clause allows clients to assert which CRS is being used to encode geometric values in a filter expression. Otherwiese, the filter-crs parameter has no use. |
{- "type": "FeatureCollection",
- "features": [
- {
- "stac_version": "1.0.0",
- "type": "Feature",
- "id": "CS3-20160503_132131_05",
- "bbox": [
- -122.59750209,
- 37.48803556,
- -122.2880486,
- 37.613537207
], - "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- -122.308150179,
- 37.488035566
], - [
- -122.597502109,
- 37.538869539
], - [
- -122.576687533,
- 37.613537207
], - [
- -122.2880486,
- 37.562818007
], - [
- -122.308150179,
- 37.488035566
]
]
]
}, - "properties": {
- "datetime": "2016-05-03T13:22:30.040Z",
- "title": "A CS3 item",
- "license": "PDDL-1.0",
- "view:sun_azimuth": 168.7,
- "eo:cloud_cover": 0.12,
- "view:off_nadir": 1.4,
- "platform": "coolsat2",
- "instruments": [
- "cool_sensor_v1"
], - "eo:bands": [ ],
- "view:sun_elevation": 33.4,
- "eo:gsd": 0.512
}, - "collection": "CS3",
- "links": [
- {
- "rel": "self",
- "type": "application/geo+json"
},
], - "assets": {
- "analytic": {
- "title": "4-Band Analytic",
- "type": "image/tiff; application=geotiff; profile=cloud-optimized"
}, - "thumbnail": {
- "title": "Thumbnail",
- "type": "image/png"
}
}
}
], - "links": [
- {
- "rel": "next",
- "type": "application/geo+json",
}
], - "numberMatched": 0,
- "numberReturned": 0
}
Get queryable response of grus-1 collection to understand what kind of queryables are supported.
{- "$id": "${server.url}/catalogs/axelglobe/collections/grus-1/queryables",
- "type": "object",
- "title": "The queryables resource for the grus-1 collection",
- "additionalProperties": false,
- "properties": {
- "ag:capture_id": {
- "title": "The identifier of the AxelGlobe capture.",
- "type": "string"
}, - "eo:cloud_cover": {
- "title": "Estimate of cloud cover, in %.",
- "type": "string"
}
}
}