STAC collections

Get information about the STAC collections in your storage.


Overview

A STAC collection is an UP42 asset you received after a completed order. An order can produce multiple STAC collections. A STAC collection contains different storage characteristics — for example, a geospatial collection name, a producer name, a corresponding UP42 asset ID.

For more information on STAC collections, see Intro to STAC and STAC Collection Specification.

See STAC collections in your storage

To get a list of all STAC collections in your storage, call the /v2/assets/stac/collections endpoint.

Request

Query parameterOverview
workspace_idstring
The workspace ID.
limitinteger
The number of STAC collections on a results page.
tokenstring
Search for previous (prev:{ID}) or next (next:{ID}) STAC collections from the results page.

Response


See response example

JSON

    {
  "links": [
    {
      "href": "https://api.up42.com/v2/assets/stac/",
      "rel": "root",
      "type": "application/json"
    },
    {
      "href": "https://api.up42.com/v2/assets/stac/",
      "rel": "parent",
      "type": "application/json"
    },
    {
      "href": "https://api.up42.com/v2/assets/stac/collections",
      "rel": "self",
      "type": "application/json"
    },
    {
      "href": "http://api.up42.com/v2/assets/stac/collections?token=next:7bd5184f-156f-4527-95c8-ef418519dea2",
      "rel": "next",
      "type": "application/json",
      "method": "GET"
    }
  ],
  "collections": [
    {
      "assets": {
        "2pqblro9_LIVPowerlink3ABPLST_SO22034994_145_01_DS_PHR1A_202208080011285_FR1_PX_E150S28_1213_06338.zip": {
          "href": "https://api.up42.com/v2/assets/6072a0ee-0fff-4755-9cc7-660711de9b35",
          "title": "Original Delivery",
          "type": "application/zip",
          "roles": ["data", "original"]
        }
      },
      "links": [
        {
          "href": "https://api.up42.com/v2/assets/stac/collections/e562d0ea-ce0c-4a76-b142-e6b00d3c3b8b",
          "rel": "self",
          "type": "application/json"
        },
        {
          "href": "https://api.up42.com/v2/assets/stac/",
          "rel": "parent",
          "type": "application/json"
        },
        {
          "href": "https://api.up42.com/v2/assets/stac/collections/e562d0ea-ce0c-4a76-b142-e6b00d3c3b8b/items",
          "rel": "items",
          "type": "application/geo+json"
        },
        {
          "href": "https://api.up42.com/v2/assets/stac/",
          "rel": "root",
          "type": "application/json"
        }
      ],
      "stac_extensions": [
        "https://api.up42.com/stac-extensions/up42-system/v1.0.0/schema.json",
        "https://api.up42.com/stac-extensions/up42-order/v1.0.0/schema.json",
        "https://api.up42.com/stac-extensions/up42-user/v1.0.0/schema.json",
        "https://api.up42.com/stac-extensions/up42-product/v1.0.0/schema.json"
      ],
      "title": "DS_PHR1A_202210261023104_FR1_PX_E013N52_0614_01724",
      "description": "Very high-resolution 50cm Pleiades images acquired daily on a global basis. The datasets are available starting from 2012.",
      "license": "proprietary",
      "providers": [
        {
          "name": "AIRBUS DS GEO",
          "roles": ["producer"],
          "url": "http://www.geo-airbusds.com/"
        },
        {
          "name": "AIRBUS DS GEO",
          "roles": ["processor"],
          "url": "http://www.geo-airbusds.com/"
        }
      ],
      "extent": {
        "spatial": {
          "bbox": [[52.4911111111112, 13.4025555555556, 52.4941111111112, 13.4111666666667]]
        },
        "temporal": {
          "interval": [["2021-05-31T09:51:52.100000Z", "2021-05-31T09:51:52.100000Z"]]
        }
      },
      "stac_version": "1.0.0",
      "id": "e562d0ea-ce0c-4a76-b142-e6b00d3c3b8b",
      "keywords": ["berlin", "optical"],
      "type": "Collection",
      "up42-order:host_id": "1f18c290-fcf4-4005-b4f8-4134df62437a",
      "up42-order:id": "b4326bfb-9f00-4759-aac0-dd336499a688",
      "up42-order:status": "CREATED",
      "up42-product:collection_name": "spot",
      "up42-product:data_type": "raster",
      "up42-product:product_id": "81703427-a6ad-4c5d-8691-a87ff1239e35",
      "up42-product:modality": "multispectral",
      "up42-system:source": "USER",
      "up42-system:offline": false,
      "up42-system:workspace_id": "7d1cf222-1fa7-468c-a93a-3e3188875997",
      "up42-system:account_id": "8cd5de7b-82e2-4625-b094-d5392f1cf780",
      "up42-system:asset_id": "f9e1c7cf-c14a-47f4-9e7c-cdb2d7e019c4",
      "up42-user:title": "Multispectral SPOT AOI #1",
      "up42-user:tags": ["order b4326bfb"]
    }
  ]
}
  

ParameterOverview
linksarray of objects
A list of links related to the current endpoint. Use to navigate through objects.
collectionsarray of objects
A list of STAC collections in your storage.

STAC collection parameters with {prefixes}: are described in corresponding JSON schemas in collections.stac_extensions.
Parameters of the collections array
assetsobject
The UP42 asset related to the STAC collection.
assets.
<asset-name>
object
The UP42 asset data.
linksarray of objects
A list of links related to the STAC collection. Use to navigate through objects.
stac_extensionsarray of strings
A list of STAC extension URLs activated for the current endpoint. For more information, see STAC extensions.
titlestring
The title of the STAC collection. By default, title comes from the name of the UP42 asset that corresponds to the STAC collection.
descriptionstring
The description of the STAC collection.
licensestring
The STAC collection data license type. For more information on licenses, see EULAs.
providersarray of strings
A list of providers associated with the STAC collection.
extentobject
The spatiotemporal extent of the STAC collection.
extent.spatialobject
Spatial characteristics.
extent.spatial.
bbox
object
The bounding box that encloses all STAC items of the STAC collection.
extent.temporalobject
Temporal characteristics.
extent.temporal.
interval
object
The datetime interval that spans all STAC items of the STAC collection.
stac_versionstring
The UP42 STAC API version.
idstring
The ID of the STAC collection.
typestring
The type of STAC object.
keywordsarray of strings
The keywords for the STAC collection.
Parameters of the collections.assets.<asset-name> object
hrefstring
The URL of the UP42 asset.
titlestring
The UP42 asset title.
typestring
The UP42 asset data type.
rolesarray of strings
The purpose of the file. Original UP42 asset always have data and original roles.
Parameters of the collections.providers array
namestring
The name of the provider.
rolesarray of strings
The role of the provider.
urlstring
The link to the provider’s website.
Parameters of the links and collections.links arrays
hrefstring
The URL of the related endpoint.
typestring
The media type the link returns.
relstring
The type of relation of the link in links.href to the current endpoint.
bodyobject
The request body to be used with links.href to call the endpoint.
methodstring
The HTTP method to be used with links.href to call the endpoint.
titlestring
The link title.

See a particular collection

To get information about one STAC collection, call the /v2/assets/stac/collections/{collection-id} endpoint with a specific STAC collection ID as a path parameter.

Request

Response

The response is an object from the collections array.

See response example

JSON

    {
  "assets": {
    "2pqblro9_LIVPowerlink3ABPLST_SO22034994_145_01_DS_PHR1A_202208080011285_FR1_PX_E150S28_1213_06338.zip": {
      "href": "https://api.up42.com/v2/assets/6072a0ee-0fff-4755-9cc7-660711de9b35",
      "title": "Original Delivery",
      "type": "application/zip",
      "roles": ["data", "original"]
    }
  },
  "links": [
    {
      "href": "https://api.up42.com/v2/assets/stac/collections/6dd1dcb4-463b-4dcb-a958-8b0819f34fa1",
      "rel": "self",
      "type": "application/json"
    },
    {
      "href": "https://api.up42.com/v2/assets/stac/",
      "rel": "parent",
      "type": "application/json"
    },
    {
      "href": "https://api.up42.com/v2/assets/stac/collections/6dd1dcb4-463b-4dcb-a958-8b0819f34fa1/items",
      "rel": "items",
      "type": "application/geo+json"
    },
    {
      "href": "https://api.up42.com/v2/assets/stac/",
      "rel": "root",
      "type": "application/json"
    }
  ],
  "stac_extensions": [
    "https://api.up42.com/stac-extensions/up42-product/v1.0.0/schema.json",
    "https://api.up42.com/stac-extensions/up42-system/v1.0.0/schema.json",
    "https://api.up42.com/stac-extensions/up42-order/v1.0.0/schema.json",
    "https://api.up42.com/stac-extensions/up42-user/v1.0.0/schema.json"
  ],
  "title": "ORT_SPOT7_20210531_095152300_000",
  "description": "High-resolution 1.5m SPOT images acquired daily on a global basis. The datasets are available starting from 2012.",
  "license": "proprietary",
  "providers": [
    {
      "name": "AIRBUS DS GEO",
      "roles": ["producer"],
      "url": "http://www.geo-airbusds.com/"
    },
    {
      "name": "AIRBUS DS GEO",
      "roles": ["processor"],
      "url": "http://www.geo-airbusds.com/"
    }
  ],
  "extent": {
    "spatial": {
      "bbox": [[13.4025555555556, 52.4911111111112, 13.4111666666667, 52.4941111111112]]
    },
    "temporal": {
      "interval": [["2021-05-31T09:51:52.100000Z", "2021-05-31T09:51:52.100000Z"]]
    }
  },
  "stac_version": "1.0.0",
  "id": "6dd1dcb4-463b-4dcb-a958-8b0819f34fa1",
  "type": "Collection",
  "up42-user:tags": ["order b4326bfb"],
  "up42-system:source": "USER",
  "up42-user:title": "Multispectral SPOT AOI #1",
  "up42-system:workspace_id": "7d1cf222-1fa7-468c-a93a-3e3188875997",
  "up42-product:collection_name": "spot",
  "up42-order:id": "b4326bfb-9f00-4759-aac0-dd336499a688",
  "up42-order:status": "CREATED",
  "up42-product:data_type": "raster",
  "up42-order:host_id": "1f18c290-fcf4-4005-b4f8-4134df62437a",
  "up42-product:product_id": "81703427-a6ad-4c5d-8691-a87ff1239e35",
  "up42-system:account_id": "8cd5de7b-82e2-4625-b094-d5392f1cf780",
  "up42-product:modality": "multispectral",
  "up42-system:asset_id": "f9e1c7cf-c14a-47f4-9e7c-cdb2d7e019c4"
}