Skip to main content

Search Sub-Catalog STAC items with filtering.

POST 
/catalogs/:subCatalogId/search

Retrieve items matching filters in a sub-catalog.

Request​

Path Parameters

    subCatalogId stringrequired

    Identifier (name) of a specific collection

Body

    bbox number[]

    Possible values: >= 4, <= 6

    Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (elevation or depth):

    • Lower left corner, coordinate axis 1

    • Lower left corner, coordinate axis 2

    • Lower left corner, coordinate axis 3 (optional)

    • Upper right corner, coordinate axis 1

    • Upper right corner, coordinate axis 2

    • Upper right corner, coordinate axis 3 (optional)

    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.

    datetime datetime

    An object representing a date+time based filter.

    intersects object

    Only returns items that intersect with the provided polygon.

    oneOf
    type stringrequired

    Possible values: [Point]

    coordinates number[]required

    Possible values: >= 2

    bbox number[]

    Possible values: >= 4

    collections string[]

    Only returns the collections specified

    ids string[]

    Filter on a set of item IDs.

    limit limit

    Possible values: >= 1 and <= 100

    Default value: 10

    Only returns maximum number of results (page size)

    next next

    Token indicating the next page of results to return.

    filter object

    A cql2-json filter expression for filtering items

    where where

    (Deprecated in favor of filter) SQL-style WHERE clause for filtering on STAC item properties

    sortby sortby

    An array of property names, prefixed by either "+" for ascending or "-" for descending. If no prefix is provided, "+" is assumed. Currently only two properties are supported: datetime and id.

    orderby orderby

    (Deprecated in favor of sortby) SQL-style ORDER BY clause. The only properties results can be ordered by are "id" and "datetime". You can use ASC and DESC modifiers on each column.

    area-based-calc boolean

    Return area-based calculations in search results.

Responses​

A feature collection.

Response Headers
  • X-Maxar-RequestId any
Schema
    type stringrequired

    Possible values: [FeatureCollection]

    features object[]required
  • Array [
    • id itemIdrequired

    Provider identifier, a unique ID, potentially a link to a file.

    collection collectionIdrequired

    Collection ID

    bbox number[]required

    Possible values: >= 4, <= 6

    Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (elevation or depth):

    • Lower left corner, coordinate axis 1

    • Lower left corner, coordinate axis 2

    • Lower left corner, coordinate axis 3 (optional)

    • Upper right corner, coordinate axis 1

    • Upper right corner, coordinate axis 2

    • Upper right corner, coordinate axis 3 (optional)

    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.

    geometry objectrequired
    type itemTyperequired

    Possible values: [Feature]

    The GeoJSON type

    properties objectrequired

    provides the core metatdata fields plus extensions

    links object[]required
  • Array [
    • href urlrequired
    rel stringrequired
    type string
    title string
  • ]
    • assets objectrequired
    property name* object
    href urlrequired

    Link to the asset object

    title string

    Displayed title

    description string

    Multi-line description to explain the asset.

    CommonMark 0.29 syntax MAY be used for rich text representation.

    type string

    Media type of the asset

    roles string[]

    Purposes of the asset

  • ]
    • links object[]

    An array of links. Can be used for pagination, e.g. by providing a link with the next relation type.

  • Array [
    • href urlrequired
    rel stringrequired
    method string
    merge boolean
    body object
    page number
    limit number
  • ]
Loading...