Collections

Get information about the UP42 collections.


Overview

Collections are geospatial datasets with tasking or archive imagery. For more information, see Tasking and catalog.

See geospatial collections

To see a list of all available geospatial collections, call the /collections endpoint.

Request

GET /collections HTTP/1.1
Host: api.up42.com
Query parameterOverview
is_integratedstring
Whether it is integrated in the UP42 API. The default value is true.

You can order non-integrated data by contacting the Operations team.

Response


See response example
{
  "data": [
    {
      "name": "capella-slc",
      "title": "Capella Space SLC",
      "description": "Capella’s satellites offer high-quality, very high resolution...",
      "type": "ARCHIVE",
      "restricted": true,
      "host": {
        "name": "capellaspace",
        "title": "Capella Space",
        "description": "Constellation of X-SAR satellites...",
        "isIntegrated": true,
        "isCommercial": true,
        "createdAt": "2021-11-02T13:09:03.676213Z",
        "updatedAt": "2022-09-14T12:28:48.018761Z"
      },
      "hostName": "capellaspace",
      "producer": {
        "name": "capella-space",
        "title": "Capella Space",
        "description": "A California-based commercial...",
        "isIntegrated": true,
        "createdAt": "2021-12-03T12:40:39.247442Z",
        "updatedAt": "2022-04-04T11:14:49.600778Z"
      },
      "producerName": "capella-space",
      "isIntegrated": true,
      "isOptical": false,
      "resolutionClass": "VERY_HIGH",
      "productType": "SAR",
      "resolutionValue": {
        "minimum": 0.5,
        "maximum": 1.2
      },
      "createdAt": "2021-12-03T12:40:39.361770Z",
      "updatedAt": "2023-03-03T00:45:07.975608Z"
    },
    {
      "name": "pneo-tasking",
      "title": "Pléiades Neo tasking",
      "description": "The Pléiades Neo quadruplets are...",
      "type": "TASKING",
      "restricted": true,
      "host": {
        "name": "oneatlas",
        "title": "OneAtlas",
        "description": "OneAtlas is the platform that provides access to the Airbus constellation of satellites.",
        "isIntegrated": true,
        "isCommercial": true,
        "createdAt": "2021-08-10T11:25:54.203814Z",
        "updatedAt": "2022-04-04T10:45:58.064559Z"
      },
      "hostName": "oneatlas",
      "producer": {
        "name": "airbus",
        "title": "Airbus",
        "description": "Airbus Intelligence operates the constellation of optical...",
        "isIntegrated": true,
        "createdAt": "2021-08-10T11:25:54.203814Z",
        "updatedAt": "2022-04-04T10:50:56.485874Z"
      },
      "producerName": "airbus",
      "isIntegrated": true,
      "isOptical": true,
      "resolutionClass": "VERY_HIGH",
      "productType": "OPTICAL",
      "resolutionValue": {
        "minimum": 0.3,
        "maximum": 1.2
      },
      "createdAt": "2021-11-02T13:09:04.140442Z",
      "updatedAt": "2023-06-08T14:06:57.208572Z"
    }
  ],
  "error": null
}

ParameterOverview
data.namestring
The name of the collection.
data.titlestring
The title of the collection.
data.descriptionstring
The description of the collection.
data.typestring
The type of the collection:
  • ARCHIVE
  • TASKING
data.restrictedboolean
Whether the collection is restricted.
data.hostobject
Information about the data host.
data.producerobject
Information about the data producer.
data.isIntegratedboolean
Whether the collection is integrated in the UP42 API.

You can order data from non-integrated collections by contacting the Operations team.
data.isOpticalboolean
Whether the collection provides optical data.
data.resolutionClassstring
The spatial resolution class:
  • VERY_HIGH
  • HIGH
  • MEDIUM
  • LOW
data.productTypestring
The type of data the collection delivers:
  • OPTICAL
  • SAR
  • ELEVATION
data.resolutionValueobject
The level of detail achievable for the collection.
data.resolutionValue.
minimum
number
The best possible resolution available for the collection, in meters.
data.resolutionValue.
maximum
number
The least detailed resolution available for the collection, in meters. The parameter is omitted if the collection has only one resolution value, specified in minimum.
data.createdAtstring
The timestamp when the the collection was created.
data.updatedAtstring
The timestamp when the the collection was updated.

See a particular collection

To see one geospatial collection, call the /collections/{collection_name} endpoint with a specific collection name as a path parameter.

Request

GET /collections/{collection_name} HTTP/1.1
Host: api.up42.com

Response

The response is an object from the /collections data array.

See response example
{
  "data": {
    "name": "pneo-tasking",
    "title": "Pléiades Neo tasking",
    "description": "The Pléiades Neo quadruplets are...",
    "type": "TASKING",
    "restricted": true,
    "host": {
      "name": "oneatlas",
      "title": "OneAtlas",
      "description": "OneAtlas is the platform that provides access to the Airbus constellation of satellites.",
      "isIntegrated": true,
      "isCommercial": true,
      "createdAt": "2021-08-10T11:25:54.203814Z",
      "updatedAt": "2022-04-04T10:45:58.064559Z"
    },
    "hostName": "oneatlas",
    "producer": {
      "name": "airbus",
      "title": "Airbus",
      "description": "Airbus Intelligence operates the constellation of optical...",
      "isIntegrated": true,
      "createdAt": "2021-08-10T11:25:54.203814Z",
      "updatedAt": "2022-04-04T10:50:56.485874Z"
    },
    "producerName": "airbus",
    "isIntegrated": true,
    "isOptical": true,
    "resolutionClass": "VERY_HIGH",
    "productType": "OPTICAL",
    "resolutionValue": {
      "minimum": 0.3,
      "maximum": 1.2
    },
    "createdAt": "2021-11-02T13:09:04.140442Z",
    "updatedAt": "2023-06-08T14:06:57.208572Z"
  },
  "error": null
}