STAC

Search STAC items with simple filtering.

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

get/search

Request

Query parameters

bboxnumber[]

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.

datetimestring

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.

limitinteger

The optional limit parameter limits the number of items that are presented 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 shall not be counted.

Minimum = 1. Maximum = 10000. Default = 10.

idsstring[]

Array of Item ids to return. All other filter parameters that further restrict the number of search results are ignored

collectionsstring[]

Array of Collection IDs to include in the search for items. Only Items in one of the provided Collections will be searched.

Array of Collection IDs to include in the search for items. Only Items in one of the provided Collections will be searched

sortbystring
Example:+id,-properties.eo:cloud_cover

An array of property names, prefixed by either "+" for ascending or "-" for descending. If no prefix is provided, "+" is assumed.

fieldsstring
Example:id,type,-geometry,bbox,properties,-links,-assets

Determines the shape of the features in the response

querystring

query for properties in items. Use the JSON form of the queryFilter in POST.

Response

A feature collection.

type'FeatureCollection' required

Example response

{
  "features": [
    {
      "stac_version": "0.9.0",
      "stac_extensions": [
        "eo",
        "view",
        "https://example.com/cs-extension/1.0/schema.json"
      ],
      "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",
        "providers": [
          {
            "name": "CoolSat",
            "roles": [
              "producer",
              "licensor"
            ],
            "url": "https://cool-sat.com/"
          }
        ],
        "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",
          "href": "http://cool-sat.com/collections/CS3/items/20160503_132130_04"
        },
        {
          "rel": "root",
          "href": "http://cool-sat.com/collections"
        },
        {
          "rel": "parent",
          "href": "http://cool-sat.com/collections/CS3"
        },
        {
          "rel": "collection",
          "href": "http://cool-sat.com/collections/CS3"
        }
      ],
      "assets": {
        "analytic": {
          "href": "http://cool-sat.com/static-catalog/CS3/20160503_132130_04/analytic.tif",
          "title": "4-Band Analytic"
        },
        "thumbnail": {
          "href": "http://cool-sat.com/static-catalog/CS3/20160503_132130_04/thumbnail.png",
          "title": "Thumbnail"
        }
      }
    }
  ],
  "links": [
    {
      "rel": "next",
      "href": "http://api.cool-sat.com/search?next=ANsXtp9mrqN0yrKWhf-y2PUpHRLQb1GT-mtxNcXou8TwkXhi1Jbk"
    }
  ],
  "context": {
    "returned": 1,
    "limit": 5,
    "matched": 314159
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.