SpatioTemporal Asset Catalog (STAC) API

Search

Changed on

STAC search operation.

post/stac/search

Request

  • Base URL
    {endpoint}
  • URL
    {endpoint}/stac/search
  • Auth
    OAuth 2
    Implicit: https://login.microsoftonline.com/common/oauth2/authorize
    Scopes: https://geocatalog.spatio.azure.com/.default

Query parameters

api-versionstring required

The API version to use for this operation.

sign'true' | 'false'

Whether to sign asset URLs in the response.

durationinteger

URL signature duration in minutes.

Request body

collectionsstring[]

List of collection IDs to search within.

idsstring[]

List of specific item IDs to return.

bboxnumber[]

Bounding box for spatial filtering in format [west, south, east, north].

datetimestring

Temporal filter in RFC 3339 format, can be a single time or range.

limitinteger

Maximum number of results to return.

confobject

Conf

Overrides datetime validation from the base request model.

queryobject

STAC Query

See the STAC Query Extension.

filterobject

CQL2 Filter

See the STAC Filter Extension.

filter-crsstring

Coordinate reference system for the filter.

filter-lang'cql-json' | 'cql2-json' | 'cql2-text'

Filter language to use for the filter expression.

tokenstring

Pagination token for fetching the next set of results.

Response

The request has succeeded.

typestring required

Discriminator property for StacItemOrStacItemCollection.

stac_versionstring

Stac Version

msft:_createdstring date-time

MSFT Created

msft:_updatedstring date-time

MSFT Updated

msft:short_descriptionstring

MSFT Short Description

stac_extensionsstring[]

URLs to STAC extensions implemented by this STAC resource.

Changes

  • 2025-04-30-preview28e8cb365289Revision changes
    • breaking

      removed the success response with the status

    • info

      api operation id StacSearchOperations_Create removed and replaced with StacSearch_Create

    • info

      added the new optional query request parameter duration

    • info

      added the new optional query request parameter sign

  • 2025-04-30-preview00cbc3d6d8e0Revision changes
    • warning

      deleted the query request parameter duration

    • warning

      deleted the query request parameter sign

    • info

      api operation id StacSearch_Create removed and replaced with StacSearchOperations_Create

    • info

      added the success response with the status