Description

This API provides the following capabilities for clients.

  • Search STAC.
  • Download the catalog assets.

This API is designed on top of the following specifications.

AxelGlobe

The AxelGlobe is an Earth Observation Platform.

Conformance

Search STAC items with simple filtering.

Retrieve Items matching filters. Intended as a shorthand API for simple queries.

Authorizations:
main_auth
query Parameters
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):

  • Lower left corner, coordinate axis 1
  • Lower left corner, coordinate axis 2
  • Minimum value, coordinate axis 3 (optional)
  • Upper right corner, coordinate axis 1
  • Upper right corner, coordinate axis 2
  • Maximum value, coordinate axis 3 (optional)

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 [160.6, -55.95, -170, -25.89] and in a query as bbox=160.6,-55.95,-170,-25.89.

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:

  • A date-time: "2018-02-12T23:20:50Z"
  • A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
  • Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"

Only features that have a temporal property that intersects the value of datetime are selected.

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.

Responses

Response samples

Content type
application/geo+json
{}

GRUS-1

get queryables response of grus-1 collection

Get queryable response of grus-1 collection to understand what kind of queryables are supported.

Authorizations:
main_authapi_key

Responses

Response samples

Content type
application/json
{
  • "$id": "${server.url}/catalogs/axelglobe/collections/grus-1/queryables",
  • "type": "object",
  • "title": "The queryables resource for the grus-1 collection",
  • "additionalProperties": false,
  • "properties": {
    }
}