GBDX

Get the S3 Location for a Product

This tutorial shows how to get the S3 location for a 1B image product that has been delivered to the GBDX platform.

Last Updated: April 11, 2019

Overview

The /orders/v2/location endpoint lets you find the location of a DigitalGlobe acquisition without placing an order. Send a request to this endpoint with the catalog IDs in the query string.

Quickstart Examples

GBDXtools Example

This example shows requesting the data location for a catalog ID.

Request Example


from gbdxtools import Interface
gbdx = Interface()

is_del = gbdx.catalog.get_data_location("104001001BA7C400")
print(is_del)

Response Example

If the image is available, the full s3 location will be returned. For example,

s3://receiving-dgcs-tdgplatform-com/059073528010_01_003

If the image is not available, it will return a status of Not Delivered.

API Example

Request Example

Make a GET request to

https://geobigdata.io/orders/v2/location?acquisitionIds=["CATID1", "CATID2"]

You can list up to 100 catalog IDs in a single query.

JSON Response Example


    {
      "acquisitions": [
        {
          "acquisition_id": "CATID1",
          "state": "delivered",
          "location": "s3://bucket/prefix"
        },
        {
          "acquisition_id": "CATID2",
          "state": "not_found",
          "location": "not_delivered"
        }
      ]
    }

Each catalog ID in the request will be listed in the JSON response body with a "state" and a "location."

ElementDescription
acquisition-idThis is the catalog ID for the image.
stateFor each catalog ID, a state of either "not_found" or "delivered" will be returned. A state of "not_found" means the catalog ID has not been delivered yet.
locationIf the acquisition has been delivered, the s3 bucket location will be returned. If it hasn't been delivered, the location will be "not_delivered."

Note: This API endpoint returns the image location and delivery status only. It does not return order information or order status.

Updated about a year ago

Get the S3 Location for a Product


This tutorial shows how to get the S3 location for a 1B image product that has been delivered to the GBDX platform.

Last Updated: April 11, 2019

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.