Skip to main content

List Items in a Sub-Catalog's collection

GET 
/catalogs/:subCatalogId/collections/:collectionId/items

List items that are in a collection. The same query parameters may be used as those in the /search endpoint, except for "collections" since the collection to search is part of the URL path.

Request​

Path Parameters

    subCatalogId stringrequired

    Identifier (name) of a specific collection

    collectionId stringrequired

    Identifier (name) of a specific collection

    Examples:

    Example: wv01

Query Parameters

    bbox string

    Bounding box in format "west,south,east,north" in WGS84 decimal degrees. When performing a spatial search specify either of the parameters "bbox" of "intesects", but not both.

    Example: -105,40,-104,41
    datetime string

    Date range filter in format "start-date/end-date" or "exact-datetime"

    Example: 2015-01-01T00:00:00Z/2016-01-01T00:00:00Z
    ids string

    Comma-separated list of STAC item IDs to return. The items returned are still subject to whatever other search filters are specified.

    Example: 1020010079424900,1030010021410300,4b63bf80-74a9-4884-8d26-cd322cce8a61-inv
    intersects string

    GeoJSON geometry to search by. Only STAC items whose geometries intersect this geometry are selected. When performing a spatial search specify either of the parameters "bbox" of "intesects", but not both.

    Example: {"type":"Polygon","coordinates":[[[-105,39],[-103,39],[-103,41],[-104,41],[-104,40],[-105,40],[-105,39]]]}
    filter string

    A cql2-text filter expression for filtering items. You can filter on any property inside a STAC item's "properties" object.

    While STAC items have a "datetime" property you should use the search operation's "datetime" parameter for searching by it, and not use the "filter" parameter for searching by datetime.

    Examples:

    Example: eo:cloud_cover < 20

    where string

    (Deprecated in favor of filter) SQL-style WHERE clause for filtering STAC items by properties. You can filter on any property inside a STAC item's "properties" object.

    While STAC items have a "datetime" property you should use the search operation's "datetime" parameter for searching by it, and not use the "where" parameter for searching by datetime.

    Examples:

    Example: eo:cloud_cover < 20

    sortby string

    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.

    Examples:

    Example: id

    orderby string

    (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. If not specified then orderby defaults to "datetime DESC, id ASC".

    Examples:

    Example: id

    limit integer

    Maximum number of items to return

    Example: 10
    page integer

    Page number to retrieve. First page is numbered 1.

    Example: 2

Responses​

Query successful

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
    type string
    title string
  • ]
Loading...