Glossary API

Choose data offerings from the glossary using the API.


Overview

The glossary provides information on UP42 data offerings. It helps you create tasking or catalog orders.

Collections serve as the higher-level category, containing one or more data products related to the actual configuration of data available for ordering.

Collections

Collections are geospatial datasets available for ordering.

You can retrieve collections in one of the following ways:

Collection integration values

Integration values indicate mandatory ordering steps, available actions, and mandatory or optional operations for a given collection.

Mandatory ordering steps

Integration values for mandatory ordering steps have the REQUIRED suffix.

Integration valueDescription
ACCESS_APPROVAL_REQUIREDThis collection is restricted and requires an access request.
FEASIBILITY_STUDY_REQUIREDThis collection requires a feasibility study to be conducted.
QUOTATION_REQUIRED

The ordering process for this collection includes a price quotation.

Available actions

Integration values for available actions have the AVAILABLE suffix.

Integration valueDescription
SAMPLE_DATA_AVAILABLEThis collection has sample data.
SEARCH_AVAILABLEThis collection allows for a catalog search.
PRICE_ESTIMATION_AVAILABLEThis collection allows for automatic price estimation.
QUICKLOOK_AVAILABLEThis collection has quicklooks, that is, previews of full scenes on a basemap.
TASKING_OPPORTUNITIES_AVAILABLE

This collection has tasking opportunities, that is, potential time intervals when sensors of a selected collection pass over your AOI.

THUMBNAIL_AVAILABLEThis collection has thumbnails, that is, small, light-weighted previews of full scenes.

Mandatory or optional operations

Integration values for either mandatory or optional operations have the MAY_BE_REQUIRED suffix.

Integration valueDescription
FEASIBILITY_STUDY_MAY_BE_REQUIREDThis collection might require a feasibility study for ordering.

Data products

Data products are a type of imagery with a specific geometric and radiometric processing level and file format. All collections have different data products corresponding to their technical specifications.

You can retrieve data products in one of the following ways:

  • To get a list of all data products, call the Get data products endpoint.
  • To get a specific data product, call the Get a data product endpoint with the data product name as the path parameter.

To create a tasking or a catalog order, you’ll need a data product ID.

Providers

Providers are organizations that offer geospatial data by producing or hosting it:

  • Producers

    Organizations that initially acquire and process the source data. Data acquired by a producer can be distributed to various hosts.

  • Hosts

    Organizations that offer access to data acquired by a producer.

You can retrieve providers in one of the following ways:

  • To get a list of all providers, call the Get providers endpoint.
  • To get a specific provider, call the Get a provider endpoint with the provider name as the path parameter.

Last updated: