Skip to main content

Module maxar_platform.discovery

Discovery API

Discovery is Maxar's data catalog. Since it implements STAC API, this SDK uses pystac_client for access.

For search, open a catalog or subcatalog to get a STAC client.

from maxar_platform.discovery import open_catalog
open_catalog() # returns the root catalog, or pass a subcatalog name like "imagery"
results = stac_api_client.search(...)

Reference

https://developers.maxar.com/docs/discovery/

https://pystac-client.readthedocs.io/en/latest/usage.html#itemsearch

Variables

stac_api_client : A pre-configured pystac-client instance ready to search the root catalog.

Attributes
----------
area_based_calc : Bool
Toggles area-based calculations, default is False

Reference
---------
https://pystac-client.readthedocs.io/en/latest/api.html#collection-client

Functions

open_catalog(catalog=None) : Open a pystac_client connection to a Discovery catalog

Parameters
----------
catalog : str, default None
Catalog or subcatalog name to open, i.e. "imagery". If omitted the root catalog is used.

Returns
-------
pystac_client.Client
A Client object, configured to use Maxar authentication and area-based calculations

Reference
---------
https://pystac-client.readthedocs.io/en/latest/api.html#collection-client