Catalog

Browsing the Catalog

The Catalog API enables you to browse the contents of the ICEYE public catalog and to purchase specific items from the catalog.

Catalog overview

At ths beginning of the session, the client authenticates the user, receiving a temporary access token from the token server, which is used to authenticate the API calls throughout the user session.

During a typical image purchasing flow, your API client has the following series of interactions with the ICEYE system:

  1. Search catalog items — to browse the items in the catalog, the client invokes either the searchCatalogItems operation or the listCatalogItems operation, providing a variety of filter parameters to search for the images. The operation returns a list of STAC items.

  2. Purchase frames — the client enables the user to select specific frames for purchase. The client code must extract the frame IDs for the selected items and pass each frame ID to the purchaseFrame operation, accompanied by the contract ID (which determines the account used for purchasing). The order is submitted to the ICEYE ordering processing system.

  3. Get purchase status — as it typically takes some time to process the catalog order, the client checks the status by invoking the getPurchase operation. When the status transitions to closed, this indicates that the order has completed successfully and the image products are available for download.

  4. Download products — the catalog data products are made available to download over HTTPS from a preconfigured storage location.

    You also have the option of using the Delivery API to deliver data products to AWS S3 storage (for catalog items you have already purchased).