---
title: "Search all catalogs"
method: POST
path: "/v0/catalogs/search"
tags: ["Catalog"]
---

# Search all catalogs

`POST /v0/catalogs/search`

Search all catalogs owned by the workspace

## Request body

- ClerkOriginalCatalogFilter
  - `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: (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
  - `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.
  - `ids` string[]
  - `intersects` ClerkGeometry
    - `coordinates` array[]
      - array[]
        - number[]
    - `type` string
  - `item_ids` string[] — STAC Item IDs as present in the archives API
  - `limit` integer
  - `offset` integer
  - `order_ids` string[]
  - `order_item_ids` string[]
  - `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`

OK

- ClerkSearchCatalogsResponse
  - `catalogs` ClerkCatalog[]
    - `area` number — area of the catalog in sq. km
    - `bandset_id` string — id of the bandset present in the catalog
    - `created_at` string — timestamp of the creation of the catalog
    - `created_by` string — uuid of the user who created the catalog
    - `delivery_status` 'UNSPECIFIED' | 'CREATED' | 'FAILED' | 'IN_PROGRESS' | 'SUCCESS'
    - `details` ClerkSTACItem
      - `assets` object
      - `bbox` number[] — bounding box of the STAC item
      - `collection` string
      - `geometry` ClerkGeometry
        - `coordinates` array[]
          - array[]
            - number[]
        - `type` string
      - `id` string — id of the STAC item, also referred as item_id
      - `links` ClerkLink[]
        - `href` string
        - `rel` string
        - `title` string
        - `type` string
      - `properties` ClerkProperties
        - `constellation` string — name of the constellation
        - `created` string — timestamp of the creation of the image
        - `datetime` string — timestamp of the image
        - `eo:cloud_cover` number — cloud cover percentage
        - `gsd` integer — ground sample distance
        - `instruments` string[] — list of instruments
        - `platform` string — name of the platform
        - `proj:epsg` integer — EPSG code of the projection
        - `proj:shape` integer[] — shape of the projection
        - `proj:transform` number[] — transform of the projection
        - `proj:wkt2` string — WKT2 of the projection
        - `sat:orbit_state` string — orbit state of the satellite
        - `sat:relative_orbit` integer — relative orbit number of the satellite
        - `sci:doi` string — DOI of the scientific publication
        - `updated` string — timestamp of the last update of the image
        - `view:off_nadir` number — off nadir angle of the satellite
        - `view:satellite_look_angle` number — look angle of the satellite
        - `view:sun_azimuth` number — azimuth angle of the sun
        - `view:sun_elevation` number — elevation angle of the sun
      - `stac_extensions` unknown[] — list of extensions used in the STAC item
        - unknown
      - `stac_version` string — version of the STAC standard used
      - `type` string — type of the STAC item
    - `id` string — id of the catalog
    - `org_id` string — id of the workspace to which the catalog belongs
    - `task_id` string — id of the task, whose catalog this resource tracks
    - `updated_at` string — timestamp of the last update of the catalog
    - `updated_by` string — uuid of the user who last updated the catalog
  - `pagination` CommonPagination
    - `limit` integer
    - `offset` integer
    - `total` integer

## Other responses

- `400` — Bad Request
- `500` — Internal Server Error

---

[API](https://skmtc.net/pixxel/apis/stargate.md) · [All operations](https://skmtc.net/pixxel/apis/stargate/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pixxel/stargate/revisions/b501e2ca5a9d/schema)
