Sign in
STAC Import

Stac Search

Changed on

Search items in a STAC API with spatial/temporal filters.

Accepts a credential for a protected catalog, applied to this call.

post/services/stac/search

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (password, token URL /api/auth/login)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Request body

urlstring required

STAC API root URL.

collectionsstring[] nullable

Filter by collection IDs.

bboxnumber[] nullable

Bounding box filter as [west, south, east, north].

datetime_rangestring nullable

Temporal filter in STAC datetime format (e.g. '2023-01-01/2023-12-31').

limitinteger

Maximum items to return.

tokenstring nullable

Optional auth token for a protected STAC catalog. Deprecated: use the auth object with method bearer.

max_cloud_covernumber nullable

Only items at or below this eo:cloud_cover percentage.

cloud_cover_mode'query' | 'filter' nullable

How to send max_cloud_cover: 'query' for the STAC Query extension, 'filter' for CQL2 JSON. Pick the one the catalog lists in its landing page conformsTo.

Response

Successful Response

matchedinteger nullable

Total matches (if reported by API).

returnedinteger required

Number of items in this response.

Changes

  • 8741b238840eRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status