POST
/
v0
/
catalogs
/
search
curl --request POST \
  --url https://api.pixxel.space/v0/catalogs/search \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "bbox": [
    3,
    4,
    5,
    6
  ],
  "collections": [
    "<string>"
  ],
  "datetime": "2020-04-05T11:56:49.865Z/2023-06-05T11:56:49.865Z",
  "ids": [
    "47435e2b-d8c4-41ff-9de9-2be3bfc92276"
  ],
  "intersects": {
    "coordinates": [
      [
        [
          123
        ]
      ]
    ],
    "type": "Polygon"
  },
  "item_ids": [
    "TD1_2024_ABC"
  ],
  "limit": 100,
  "offset": 50,
  "order_ids": [
    "57435e2b-d8c4-41ff-9de9-2be3bfc92277"
  ],
  "order_item_ids": [
    "57435e2b-d8c4-41ff-9de9-2be3bfc92278"
  ],
  "query": {},
  "sort_by": [
    {}
  ]
}'
{
  "catalogs": [
    {
      "area": 100,
      "bandset_id": "47435e2b-d8c4-41ff-9de9-2be3bfc92277",
      "created_at": "2024-05-27T06:50:20.056549Z",
      "created_by": "e31ab6f8-d359-4c6a-83c6-bfa32229bb01",
      "delivery_status": "SUCCESSFUL",
      "details": {
        "assets": {},
        "bbox": [
          123
        ],
        "collection": "<string>",
        "geometry": {
          "coordinates": [
            [
              [
                123
              ]
            ]
          ],
          "type": "Polygon"
        },
        "id": "<string>",
        "links": [
          {
            "href": "<string>",
            "rel": "<string>",
            "title": "<string>",
            "type": "<string>"
          }
        ],
        "properties": {
          "constellation": "<string>",
          "created": "<string>",
          "datetime": "<string>",
          "eo:cloud_cover": 123,
          "gsd": 123,
          "instruments": [
            "<string>"
          ],
          "platform": "<string>",
          "proj:epsg": 123,
          "proj:shape": [
            123
          ],
          "proj:transform": [
            123
          ],
          "proj:wkt2": "<string>",
          "sat:orbit_state": "<string>",
          "sat:relative_orbit": 123,
          "sci:doi": "<string>",
          "updated": "<string>",
          "view:off_nadir": 123,
          "view:satellite_look_angle": 123,
          "view:sun_azimuth": 123,
          "view:sun_elevation": 123
        },
        "stac_extensions": [
          "<any>"
        ],
        "stac_version": "<string>",
        "type": "<string>"
      },
      "id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276",
      "org_id": "e31ab6f8-d359-4c6a-83c6-bfa322 29bb01",
      "task_id": "e31ab6f8-d359-4c6a-83c6-bfa32229bb01",
      "updated_at": "2024-05-27T06:50:20.056549Z",
      "updated_by": "e31ab6f8-d359-4c6a-83c6-bfa32229bb01"
    }
  ],
  "pagination": "<any>"
}

Authorizations

​
Authorization
string
header
required

Body

application/json
Catalog filter
​
bbox
number[]

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

Lower left corner, coordinate axis 1 Lower left corner, coordinate axis 2 Upper right corner, coordinate axis 1 Upper right corner, coordinate axis 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

Example:
[3, 4, 5, 6]
​
collections
string[]

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

​
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.

Example:

"2020-04-05T11:56:49.865Z/2023-06-05T11:56:49.865Z"

​
ids
string[]
Example:
["47435e2b-d8c4-41ff-9de9-2be3bfc92276"]
​
intersects
object

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.

​
item_ids
string[]

STAC Item IDs as present in the archives API

Example:
["TD1_2024_ABC"]
​
limit
integer
default:100
Example:

100

​
offset
integer
default:0
Required range: x >= 0
Example:

50

​
order_ids
string[]
Example:
["57435e2b-d8c4-41ff-9de9-2be3bfc92277"]
​
order_item_ids
string[]
Example:
["57435e2b-d8c4-41ff-9de9-2be3bfc92278"]
​
query
object

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_by
object[]

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

Response

200
application/json
OK
​
catalogs
object[]
​
pagination
any
Previous
Get a catalog
Next