Find data

Search the catalog by host name

To see a list of available full scenes from the catalog, call the /catalog/hosts/{host_name}/stac/search endpoint with the host name as a path parameter.

Request

POST /catalog/hosts/{host_name}/stac/search HTTP/1.1
Host: api.up42.com
Content-Type: application/json
Authorization: Bearer {token}

Query parameter	Overview
`next`	string Search for previous (`prev:{ID}`) or next (`next:{ID}`) full scenes from the results page.

Body parameter	Overview
`bbox`	array of numbers Search for full scenes that intersect this bounding box. Use only if `intersects` isn't specified.
`datetime`	string Search for full scenes that have a temporal property that intersects the datetime value in the RFC 3339 format. You can search for a specific date and time, or for a closed or an open date interval. Express open intervals using double-dots: A timestamp: `2018-02-12T23:20:50Z` A closed interval: `2018-02-12T00:00:00Z/2018-03-18T12:31:12Z` An interval without end date: `2018-02-12T00:00:00Z/..` An interval without start date: `../2018-03-18T12:31:12Z`
`intersects`	object Geometry in GeoJSON format. Use only if `bbox` isn't specified.
`intersects.type`	string The geometry type. The allowed types: `Point` `MultiPoint` `LineString` `MultiLineString` `Polygon` `MultiPolygon`
`intersects.` `coordinates`	array of numbers The coordinates of the AOI.
`limit`	integer The number of full scenes on a results page up with a minimum value of `1` and a maximum value of `500`.
`query`	object Specify additional parameters.
`ids`	array of strings IDs of specific full scenes you want to include in search results.
`collections`	array of strings The names of the collections whose full scenes you want to include in search results.
	Additional parameters of the `query` object
`cloudCoverage`	object Search by the percentage of cloud cover.
`cloudCoverage.<operator>`	number The percentage of cloud cover. Replace `<operator>` with a comparison operator: `GT`: greater than `GTE`: greater than or equal to `LT`: less than `LTE`: less than or equal to

See request example

{
  "bbox": [6.553674, 62.191632, 6.560222, 62.195116],
  "datetime": "2019-01-01T00:00:00Z/2019-01-15T23:59:59Z",
  "limit": 100,
  "query": {
    "cloudCoverage": {
      "LTE": 90
    }
  },
  "ids": ["f6b86de1-a9ea-4322-99fe-23126d2784b6"],
  "collections": ["PHR"]
}

Response

See response example

{
  "features": [
    {
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [13.58899063, 52.72706317],
            [13.8941314, 52.73057866],
            [13.89381997, 52.4393652],
            [13.58935102, 2.43718654],
            [1.58899063, 52.72706317]
          ]
        ]
      },
      "properties": {
        "id": "5ad07b37-f6a1-4829-bc74-0fe50528b0ed",
        "acquisitionDate": "2019-03-23T10:24:03.556Z",
        "start_datetime": "2019-03-23T10:24:03.556Z",
        "end_datetime": "2019-03-25T11:11:00.556Z",
        "constellation": "PHR",
        "collection": "PHR",
        "providerName": "oneatlas",
        "cloudCoverage": 0,
        "up42:usageType": ["DATA"],
        "providerProperties": {},
        "sceneId": "DS_PHR1B_201903231024035_FR1_PX_E013N52_0915_02862",
        "resolution": 0.5,
        "deliveryTime": "MINUTES",
        "producer": "Airbus"
      },
      "bbox": [6.553674, 62.191632, 6.560222, 62.195116],
      "type": "Feature"
    }
  ],
  "links": [
    {
      "rel": "self",
      "href": "https://api.up42.dev/catalog/hosts/oneatlas/stac/search"
    }
  ],
  "type": "FeatureCollection"
}

Parameter	Overview
`features`	array of objects The features of the scene.
`links`	array of objects A list of links related to the current endpoint. Use to navigate through objects.
`links.rel`	string The type of relation of the link in `links.href` to the current endpoint.
`links.href`	string The URL of the related endpoint.
`type`	string The type of GeoJSON object. The default value is `FeatureCollection`.
	Parameters of the `features` array
`geometry`	object Geometry in GeoJSON format.
`geometry.type`	string The geometry type.
`geometry.` `coordinates`	array of numbers The coordinates of the AOI.
`properties`	object The full scene properties.
`bbox`	array of numbers The bounding box of the full scene.
`type`	string The scene type. The default value is `Feature`.
	Parameters of the `features.properties` object
`id`	string The full scene ID. Use for data ordering.
`acquisitionDate`	string The date and time when the sensor acquired the data.
`start_datetime`	string The date and time when the sensor started the acquisition process.
`end_datetime`	string The date and time when the sensor finished the acquisition process.
`constellation`	string The name of the sensor.
`collection`	string The name of the collection.
`cloudCoverage`	number The percentage of cloud cover.
`sceneId`	string The additional full scene ID. Don't use for data ordering.
`up42:usageType`	array of strings The type of usage: `DATA` `ANALYTICS`
`resolution`	number The spatial resolution, in meters.
`deliveryTime`	string The unit of data delivery time: `MINUTES` `HOURS` `DAYS`
`producer`	string The name of the producer. Data producers are companies that initially acquired and processed the source data. Data acquired by a producer can be distributed to various hosts.