Examples of WorldView Data Import

The examples below include the examples of both Simple and Native search so that you can compare their interfaces even though both would usually not be used in the same workflow. Similar applies for the examples of Order products and of Order using query. To execute the requests you need to create an OAuth client as is explained here. It is named oauth in these examples.

WorldView data import

Search

Simple Search

url = "https://services.sentinel-hub.com/api/v1/dataimport/search"

query = {
  "provider": "MAXAR",
  "bounds": {
    "geometry": {
      "type": "Polygon",
      "coordinates": [
        [
          [
            15.81,
            46.70
          ],
          [
            15.84,
            46.70
          ],
          [
            15.84,
            46.72
          ],
          [
            15.81,
            46.72
          ],
          [
            15.81,
            46.70
          ]
        ]
      ]
    }
  },
  "data": [
    {
      "productBands": "4BB",
      "dataFilter": {
        "timeRange": {
          "from": "2020-11-06T00:00:00.0Z",
          "to": "2020-11-06T23:59:59.9Z"
        }
      }
    }
  ]
}

response = oauth.post(url, json=query)
response.raise_for_status()
results = response.json()

To get product ids:

item_ids = [feature["catalogID"] for feature in results["features"]]

Native Search

This native search is equivalent to the above simple search.

url = "https://services.sentinel-hub.com/api/v1/dataimport/nativesearch"

payload = {
    "provider": "MAXAR",
    "startDate": "2020-11-06",
    "endDate": "2020-11-07",
    "aoiInGeoJson": {
      "type": "Polygon",
      "coordinates": [
        [
          [
            15.81,
            46.70
          ],
          [
            15.84,
            46.70
          ],
          [
            15.84,
            46.72
          ],
          [
            15.81,
            46.72
          ],
          [
            15.81,
            46.70
          ]
        ]
      ],
      "crs": {
        "type": "name",
        "properties": {
          "name": "EPSG:4326"
        }
      }
    },
    "geometry": "true"
}


response = oauth.post(url, json=payload)
response.raise_for_status()
results = response.json()

To get product ids:

item_ids = [feature["catalogID"] for feature in results["features"]]

Thumbnail

After searching for data, you can check the thumbnail of each item by entering the item id into the url of the thumbnail request:

item_id = '1040010063790D00'
# or get it from search results: item_id = item_ids[0]
url = f"https://services.sentinel-hub.com/api/v1/dataimport/collections/MAXAR_WORLDVIEW/products/{item_id}/thumbnail"

response = oauth.get(url)

The thumbnail can be displayed in Python using:

import io
from PIL import Image

image_bytes = io.BytesIO(response.content)
Image.open(image_bytes)

Order

To order WorldView data, provider must be set to "MAXAR".

Order products

To order the import of the products, which we got as a result of search and are stored in the variable item_ids:

url = "https://services.sentinel-hub.com/api/v1/dataimport/orders"

payload = {
    "name": "My WorldView order",
    # collectionId is optional. Remove it to create a new collection.
    "collectionId": "<your WorldView collectionId>",
    "input": {
      "provider": "MAXAR",
      "bounds": {
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                15.81,
                46.70
              ],
              [
                15.84,
                46.70
              ],
              [
                15.84,
                46.72
              ],
              [
                15.81,
                46.72
              ],
              [
                15.81,
                46.70
              ]
            ]
          ]
        }
      },
      "data": [{
        "productBands": "4BB",
        "selectedImages": item_ids
      }]
  }
}

response = oauth.post(url, json=payload)
response.raise_for_status()
order = response.json()

Order using query

Another way to order data is using search query, in this case using the query from above:

url = "https://services.sentinel-hub.com/api/v1/dataimport/orders"
payload = {
    "name": "My WorldView order using query",
    # collectionId is optional. Remove it to create a new collection.
    "collectionId": "<your WorldView collectionId>",
    "input": query
}

response = oauth.post(url, json=payload)
response.raise_for_status()
order = response.json()

To extract the order id from the response:

order_id = order['id']

To extract the cost in square kilometres:

sqkm = order['sqkm']

Confirm the order

Confirming the order will subtract the ordered area in km² from your quota. To initiate import, confirm the order:

url = f"https://services.sentinel-hub.com/api/v1/dataimport/orders/{order_id}/confirm"

response = oauth.post(url)
response.raise_for_status()

Get order information

url = f"https://services.sentinel-hub.com/api/v1/dataimport/orders/{order_id}"

response = oauth.get(url)
response.raise_for_status()

order = response.json()

To extract the order status:

status = order['status']

To extract the BYOC collection ID:

collection_id = order['collectionId']

List all your orders

url = "https://services.sentinel-hub.com/api/v1/dataimport/orders"

response = oauth.get(url)
response.raise_for_status()

response.json()

Access WorldView data in a BYOC collection and process a truecolor image

This is a normal Processing API request that uses a BYOC collectionId that can be fetched from the get order information request. More examples are available here.

url = 'https://services.sentinel-hub.com/api/v1/process'

payload = {
    'input': {
        "bounds": {
          "geometry": {
            "type": "Polygon",
            "coordinates": [
              [
                [
                  15.81,
                  46.70
                ],
                [
                  15.84,
                  46.70
                ],
                [
                  15.84,
                  46.72
                ],
                [
                  15.81,
                  46.72
                ],
                [
                  15.81,
                  46.70
                ]
              ]
            ]
          }
        },
        "data": [{
            "type": "byoc-991fe3be-4d19-4d9f-9941-879da0a5c3b3",
            "dataFilter": {
                "timeRange": {
                  "from": "2020-11-06T00:00:00.0Z",
                  "to": "2020-11-06T23:59:59.9Z"
                }
            }
        }
      ]
    },
    "output": {
        "width": 512,
        "height": 512
    },
    "evalscript": """
        //VERSION=3
        function setup() {
            return {
                input: ["Red", "Green", "Blue", "dataMask"],
                output: { bands: 4 }
            };
        }
        var f = 2000;
        function evaluatePixel(sample) {
            return [sample.Red/f, sample.Green/f, sample.Blue/f, sample.dataMask];
        }
    """
  }


response = oauth.post(url, json=payload)
response.raise_for_status()