Skip to content

About the API

All of the data served and managed by the Maxar Catalog API follow the STAC specification and implements a STAC API.

STAC Item

Image title

The building block for all STAC data is the Item. It is a GeoJSON Feature object that contains metadata and STAC "Assets" which are provider owned data objects.

Example: Worldview-1 Image

This image has important metadata like when it was collected, satellite orientation, gsd, etc. The data provider can also give further downloadable data like the "thumbnail" asset. The Item has the following keys:

  • id: Identifier for the item that is unique across the entire Maxar Catalog
  • bbox: Bounding box of the asset
  • geometry: GeoJSON location of the item
  • properties: Key-value pairs of searchable metadata
  • assets: provider defined key-Asset Object pairs that point to streamable or downloadable data
  • links: Links are the fundamental component to linking related STAC objects to make the catalog crawlable. For a STAC item, you will always see at least two links: one to the collection, and another to itself.

These Items are grouped into Collections by data providers to give a way to browse and crawl related items.


STAC Collection

Image title

STAC Collections are designed to act like a folder to group a set of Items that share properties and metadata.

Example: WorldView-1 Satellite Imagery Collection

This is a STAC Collection because all Items are going to share metadata about satellite orientation, collection timestamps, gsd, etc. This collection allows clients to search through all of this vehicle's imagery.

  • id: Identifier for the collection that is unique across the entire Maxar Catalog
  • title: One-line descriptor for the collection
  • description: Multi-line description to fully explain the collection
  • providers: list of providers who either license, host, producer, or process the items in this collection
  • extent: Spatial and temporal extents of the items held in the collection
  • summaries: key-json pairs to give insight on the metadata's description and expected values in all of its items
  • links: context and info for the collection
  • assets: collection specific assets that can be downloaded or streamed



The Maxar Catalog

Image title

What

The Maxar Catalog is a deep and flat archive of collections containing data across all domains. This single access point is a great uniform way for users to discover, access, and consume collections and items that might seem tangential.

Who

  • A brand new user who is interested in discovering what products are available

  • Users who have curated the set of colletions they are interested in. This is a great destination for all users to reach as they can relax or tighten their search as needed at the same root catalog endpoint.

How

You can access our entire catalog of data through a fully functional STAC API at the /catalog endpoint. Our API Specification provides an in-depth reference for all available requests with parameters, responses, and examples. We also have a very detailed API Tutorial that provides a better client-focused overview of these requests. See the linked user example journeys for your use-case.

Example User Journeys

Example: New User

New user 1 is interested in getting up-to-date and historical satellite imagery over a specific area, but they are unfamiliar with our catalog.

Phase 1: Discovery

Goal Request Response
See what collections are available in the catalog GET https://api.content.maxar.com/catalog/collections { "collections": [ { "id": "wv01", "title": "Worldview-01", ...} ], "links": [{ "href": "https://api.content.maxar.com/catalog/collections?limit=100&page=2, "rel": "next"} ] }
Seeing there is a next page of collections, continue to page through to compile list of desired collections to search GET https://api.content.maxar.com/catalog/collections?limit=100&page=2 {"collections": [{"id": "wv02", ...}], "links": [{"rel": "next", "href": ...}]}

Phase 2: Everyday Access

Goal Request Response
Each day, they can search for satellite imagery data from these collections in the areas they care about GET https://api.content.maxar.com/catalog/search?collections=wv01,wv02&bbox=-45,-14,-40,-11 {"features": [{"title": "Maxar WV01 Image 123456789", ...}, ...]}

Example: Product or Specific Domain User

User 2 is interested in Maxar's mosaics collection to serve as a basemap. Specifically, they are inspecting certain areas and seeing about using them as an enhancement for their users.

Using the Maxar Catalog

Goal Request Response
Inspect all available recent mosaics in the areas they care about (i.e. United States) filtered by the last time they checked (i.e. June 1st, 2022) GET https://api.content.maxar.com/catalog/search?orderby=datetime+DESC&datetime=2022-06-01/..&bbox=-129.73,24.53,-66.27,49.15 {"features": [{"id": "Vivid Advanced Boston, US 2022 Q2", ...}]}

Example: Curated Collection User

User 3 is an experienced user who knows which collections they care about and can make use of the Maxar Catalog. The GET /search endpoint is the destination we hope for most users to get to. Here they can refine responses by collections, spatial polygons, datetime intervals, item metadata, and more.

Everyday Access

Goal Request Response
Use collections to filter search GET https://api.content.maxar.com/catalog/search?collections=wv01
Use datetimes to filter search GET https://api.content.maxar.com/catalog/search?datetime=2022-06-18/2022-06-19
Use item metadata to filter search GET https://api.content.maxar.com/catalog/search?where=eo:cloud_cover<10