Sign in

v1

latestOpenAPI 3.0.02026-08-0455133277.1 KB
Catalog

Search all catalogs

Search all catalogs owned by the workspace

post/v0/catalogs/search

Request body

bboxnumber[]

Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four numbers:

Lower left: (Latitude 1, Longitude1) Upper right: (Latitude 2, Longitude 2) The coordinate reference system of the values is WGS84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter bbox-crs.

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

collectionsstring[]

Array of Collection IDs to include in the search for items. Only Item objects in one of the provided collections will be searched.

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.

idsstring[]
item_idsstring[]

STAC Item IDs as present in the archives API

limitinteger
offsetinteger
order_idsstring[]
order_item_idsstring[]
queryobject

a query object to search/filter according to the properites of the stac-item

"query": {
   "cloudcover": {
       "gt": 0,
       "lt": 10
   },
   "bands": {
       "eq": [
           "RGB",
           "B001",
           "B002"
       ]
   }
  }
sort_byobject[]

a sortby object to sort the items by the properties of the stac-item "sortby": [ { "field": "properties->>'datetime'", "direction": "desc" } ]

Example request

{
  "bbox": [
    160.6,
    -55.95,
    -170,
    -25.89
  ],
  "datetime": "2020-04-05T11:56:49.865Z/2023-06-05T11:56:49.865Z",
  "ids": [
    "47435e2b-d8c4-41ff-9de9-2be3bfc92276"
  ],
  "intersects": {
    "type": "Polygon"
  },
  "item_ids": [
    "TD1_2024_ABC"
  ],
  "limit": 50,
  "offset": 50,
  "order_ids": [
    "57435e2b-d8c4-41ff-9de9-2be3bfc92277"
  ],
  "order_item_ids": [
    "57435e2b-d8c4-41ff-9de9-2be3bfc92278"
  ]
}

Response

OK

Example response

{
  "catalogs": [
    {
      "area": 100,
      "bandset_id": "47435e2b-d8c4-41ff-9de9-2be3bfc92277",
      "created_at": "2024-05-27T06:50:20.056549Z",
      "created_by": "0d7b3c5e-3b2a-4e77-bedb-5e0d2257cdb6",
      "details": {
        "geometry": {
          "type": "Polygon"
        }
      },
      "id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276",
      "org_id": "e31ab6f8-d359-4c6a-83c6-bfa322 29bb01",
      "task_id": "ef8195b7-5ca6-4aca-a3fc-df6ffd58892d",
      "updated_at": "2024-05-27T06:50:20.056549Z",
      "updated_by": "0ada9483-e3ed-4f31-8a69-372686966451"
    }
  ],
  "pagination": {
    "limit": 10,
    "total": 100
  }
}