Language
WorldDEM API
  1. WorldDEM - API
    1. Request a price
    2. Place an order
    3. Check order status
    4. Download the data

WorldDEM - API

The API enables the download of WorldDEM data in 3 easy steps. The API is provided as HTTP REST API and is using GeoJSON.


  1. Request a price (optional)
    1. send order description with API /price/ endpoint
    2. response contains price information about the requested data
  2. Place an order
    1. send order description with API /orders/ endpoint
    2. send fixed price information or price limits along with the request (optional)
    3. response contains confirmation and download link
  3. Download the data

1. Request a price

When requesting a price you must provide the following parameters.

kindDescribes the order format
itemsObject containing one or multiple orders
items.itemTypeDescribes the source of the data (e.g. WorldDEM or WorldDEM4Ortho)
items.aoiContains the AOI the price is requested for

The endpoint to get a price for a WorldDEM order:

API Endpointhttps://sar.api.oneatlas.airbus.com/v1/elevation/price
REST verbPOST
AuthenticationJWT Token
API ReferenceSAR API

The only and mandatory parameter is a JSON payload following this schema:

{
  "kind": "order.item",
  "title": "WorldDEM Test",
  "items": [
    {
      "crsCode": "urn:ogc:def:crs:EPSG::4326",
      "itemFormat": "GeoTIFF",
      "itemType": "dem.wddsm",
      "aoi": {
        "type": "Polygon",
        "coordinates": [
          [ [9.3, 47.7], [9.4, 47.7], [9.4, 47.65], [9.3, 47.7] ]
        ]
      }
    }
  ]
}

Below is an example of the call:

curl -X POST \
  'https://sar.api.oneatlas.airbus.com/v1/elevation/price' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json'
  -d '{
  "kind": "order.item",
  "title": "WorldDEM Test",
  "items": [
    {
      "crsCode": "urn:ogc:def:crs:EPSG::4326",
      "itemFormat": "GeoTIFF",
      "itemType": "dem.wddsm",
      "aoi": {
        "type": "Polygon",
        "coordinates": [
          [ [9.3, 47.7], [9.4, 47.7], [9.4, 47.65], [9.3, 47.7] ]
        ]
      }
    }
  ]
}'
Not available
Not available

The response is shown below:

{
    "kind": "order.item",
    "title": "WorldDEM Test",
    "items": [
        {
            "crsCode": "urn:ogc:def:crs:EPSG::4326",
            "itemFormat": "GeoTIFF",
            "itemType": "dem.wddsm",
            "aoi": {
                "type": "Polygon",
                "coordinates": [
                    [ [9.3, 47.7], [9.4, 47.7], [9.4, 47.65], [9.3, 47.7] ]
                ]
            },
            "areaKm2": 20.85,
            "billableAreaKm2": 20.85,
            "price": {
                "amountUnit": "EUR",
                "amount": 79.86,
                "amountPerKm2": 3.83
            }
        }
    ],
    "price": {
        "amountUnit": "EUR",
        "amount": 79.86
    },
    "areaKm2": 20.85,
    "billableAreaKm2": 20.85,
    "orderable": true
}

2. Place an order

When placing an order you must provide the following parameters.

kindDescribes the order format
itemsObject containing one or multiple orders
items.itemTypeDescribes the source of the data (e.g. WorldDEM or WorldDEM4Ortho)
items.aoiContains the AOI the price is requested for

The endpoint to place a WorldDEM order:

API Endpointhttps://sar.api.oneatlas.airbus.com/v1/elevation/orders
REST verbPOST
AuthenticationJWT Token
API ReferenceSAR API

The only and mandatory parameter is a JSON payload following this schema:

{
  "kind": "order.item",
  "title": "WorldDEM Test",
  "items": [
    {
      "crsCode": "urn:ogc:def:crs:EPSG::4326",
      "itemFormat": "GeoTIFF",
      "itemType": "dem.wddsm",
      "aoi": {
        "type": "Polygon",
        "coordinates": [
          [ [9.3, 47.7], [9.4, 47.7], [9.4, 47.65], [9.3, 47.7] ]
        ]
      },
      "price": {
        "amountUnit": "EUR",
        "amount": 83.4
      },
      "areaKm2": 20.85,
      "billableAreaKm2": 15.23
    }
  ],
  "areaKm2": 20.85,
  "billableAreaKm2": 15.23,
  "price": {
    "amountUnit": "EUR",
    "amount": 83.4
  },
  "orderable": true
}

Below is an example of the call:

curl -X POST \
  'https://sar.api.oneatlas.airbus.com/v1/elevation/orders' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json'
  -d '{
  "kind": "order.item",
  "title": "WorldDEM Test",
  "items": [
    {
      "crsCode": "urn:ogc:def:crs:EPSG::4326",
      "itemFormat": "GeoTIFF",
      "itemType": "dem.wddsm",
      "aoi": {
        "type": "Polygon",
        "coordinates": [
          [ [9.3, 47.7], [9.4, 47.7], [9.4, 47.65], [9.3, 47.7] ]
        ]
      },
      "price": {
        "amountUnit": "EUR",
        "amount": 83.4
      },
      "areaKm2": 20.85,
      "billableAreaKm2": 15.23
    }
  ],
  "areaKm2": 20.85,
  "billableAreaKm2": 15.23,
  "price": {
    "amountUnit": "EUR",
    "amount": 83.4
  },
  "orderable": true
}'
Not available
Not available

The response is shown below:

{
    "id": "9fabb4a3-0d02-47e9-ac1a-d092bd265300",
    "self": {
        "href": "orders/9fabb4a3-0d02-47e9-ac1a-d092bd265300"
    }
}

The results give you the id of the order.

3. Check order status

To get the most current order status, you can call the following endpoint using the id obtained above.

API Endpointhttps://sar.api.oneatlas.airbus.com/v1/elevation/orders/
REST verbGET
AuthenticationJWT Token
API ReferenceSAR API
curl -X GET \
  'https://sar.api.oneatlas.airbus.com/v1/elevation/orders/<order_id>' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Cache-Control: no-cache' 
Not available
Not available

An example response is shown below:

{
    "kind": "order.item",
    "title": "WorldDEM Test",
    "createdAt": "2022-06-06T15:04:15.314Z",
    "id": "9fabb4a3-0d02-47e9-ac1a-d092bd265300",
    "crsCode": "urn:ogc:def:crs:EPSG::4326",
    "itemFormat": "GeoTIFF",
    "itemType": "dem.wddsm",
    "aoi": {
        "type": "Polygon",
        "coordinates": [
          [ [9.3, 47.7], [9.4, 47.7], [9.4, 47.65], [9.3, 47.7] ]
        ]
    },
    "status": "ready",
    "billableAreaKm2": 15.23,
    "createdBy": "1e756a21-b4c0-4800-b0fc-4350cf97f72b",
    "_links": {
        "self": {
            "href": "/items/ec4ea73a-2c8f-4d31-bee5-97ee02b93f3d"
        },
        "items": {
            "href": "/orders"
        },
        "item": {
            "href": "/items/ec4ea73a-2c8f-4d31-bee5-97ee02b93f3d"
        },
        "orders": {
            "href": "/orders"
        },
        "order": {
            "href": "/orders/9fabb4a3-0d02-47e9-ac1a-d092bd265300"
        }
    },
    "areaKm2": 20.85,
    "price": {
        "amountUnit": "EUR",
        "amount": 79.86
    }
}

4. Download the data

When your product is at status ready you can compose a download url.

https://sar.api.oneatlas.airbus.com/v1/elevation/<order_id>/items/<item_id>/download

You send a GET request to download your WorldDEM TIF file:

curl -X GET \
  https://sar.api.oneatlas.airbus.com/v1/elevation/9fabb4a3-0d02-47e9-ac1a-d092bd265300/items/ec4ea73a-2c8f-4d31-bee5-97ee02b93f3d/download \
  -H 'Authorization: Bearer <access_token>' -o output_file.tif
Not available
Not available

Alternatively, you can call the items endpoint for your order to get a list of items and their relative download URLs.

curl -X GET \
  'https://sar.api.oneatlas.airbus.com/v1/elevation/orders/<order_id>/items' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Cache-Control: no-cache' 
Contact Us