StacSearchParameters interface

Package:
@azure/planetarycomputer

Search model. * Defines parameters for a STAC search POST request.

Properties

boundingBox

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

List of collection IDs to search within.
conformanceClass

Conf

Overrides datetime validation from the base request model.
datetime

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

Specifies which fields to include or exclude in the STAC search results.

See the STAC Fields Extension.
filter

CQL2 Filter

See the STAC Filter Extension.
filterCoordinateReferenceSystem

Coordinate reference system for the filter.
filterLang

Filter language to use for the filter expression.
ids

List of specific item IDs to return.
intersects

GeoJSON geometry for spatial filtering.
limit

Maximum number of results to return.
query

STAC Query

See the STAC Query Extension.
sortBy

Sort criteria for the search results.

See the STAC Sort Extension.
token

Pagination token for fetching the next set of results.

Property Details

boundingBox

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

boundingBox?: number[]

Property Value

number[]

collections

List of collection IDs to search within.

collections?: string[]

Property Value

string[]

conformanceClass

Conf

Overrides datetime validation from the base request model.

conformanceClass?: Record<string, any>

Property Value

Record<string, any>

datetime

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.

datetime?: string

Property Value

string

fields

Specifies which fields to include or exclude in the STAC search results.

See the STAC Fields Extension.

fields?: SearchOptionsFields[]

Property Value

SearchOptionsFields[]

filter

CQL2 Filter

See the STAC Filter Extension.

filter?: Record<string, any>

Property Value

Record<string, any>

filterCoordinateReferenceSystem

Coordinate reference system for the filter.

filterCoordinateReferenceSystem?: string

Property Value

string

filterLang

Filter language to use for the filter expression.

filterLang?: string

Property Value

string

ids

List of specific item IDs to return.

ids?: string[]

Property Value

string[]

intersects

GeoJSON geometry for spatial filtering.

intersects?: GeometryUnion

Property Value

GeometryUnion

limit

Maximum number of results to return.

limit?: number

Property Value

number

query

STAC Query

See the STAC Query Extension.

query?: Record<string, any>

Property Value

Record<string, any>

sortBy

Sort criteria for the search results.

See the STAC Sort Extension.

sortBy?: StacSortExtension[]

Property Value

StacSortExtension[]

token

Pagination token for fetching the next set of results.

token?: string

Property Value

string