Language
OneAtlas Data Guide
Order an Individual Product
Ordering an individual product will provide you a chance to select an OneAtlas data Living Library image, clip it to your AOI, process it using your custom parameters and get delivered in your workspace. Once delivered, you will be able to download or stream the resulting product.
Note: When ordering a product your AOI must be between 0.1km² and 400km² for PHR (Pleiades) products or between 0.1km² and 3600km² for SPOT products.
When retrieving the price or ordering a product there will be parameters that you need to specify for the API to calculate the correct price. The same parameters will need to be specified when you place your order. This section will guide you through the available parameters for our Ordering API.
Two processing levels are available:
| Processing levels | Description |
|---|---|
| Bundle | one Panchromatic image + the Multispectral (Blue, Green, Red and Near Infrared) bands delivered separately |
| Pan-sharpened | merging the Panchromatic with the full set of colour Blue, Green, Red and Near Infrared bands |
In addition, there are other production options that must be specified are the image format of the output product and its projection. These parameters are mandatory to process the product and may impact the price calculation.
Two images formats are currently available:
| Image Format | Description |
|---|---|
| image/jp2 | The format of the delivered image will be JPEG 2000 |
| image/geotiff | The format of the delivered image will be Cloud Optimized Geotiff |
Multiple EPSG’s are available:
| Image Format | Description |
|---|---|
| EPSG:4326 | Geodetic coordinate system for World using Uses simple Equirectangular projection |
| EPSG:326[01-60] | WGS 84 north zones |
| EPSG:327[01-60] | WGS 84 south zones |
Two radiometric processing types are available:
| Radiometric Processing | Description |
|---|---|
| REFLECTANCE | Sensor calibration and systematic atmospheric effects are effectivley used to radiometrically correct the image. |
| DISPLAY | Former OVR (Optimized Visual Rendering). 8-bit pixel coding is requested which appears lighter. |
Calculate Price for an Individual Product
When calculating the price of an individual product you must specify certain parameters. The JSON structure to provide has the form:
{
"kind": "order.data.gb.product",
"products": [
{
"crsCode": "urn:ogc:def:crs:EPSG::4326",
"productType": "pansharpened",
"radiometricProcessing": "DISPLAY",
"aoi": {
"type": "Polygon",
"coordinates": [
[
[
1.4089965820312502,
43.59829500262717
],
[
1.4089965820312502,
43.63408731864001
],
[
1.5078735351562496,
43.63408731864001
],
[
1.5078735351562496,
43.59829500262717
],
[
1.4089965820312502,
43.59829500262717
]
]
]
},
"id": "3f33d1b8-ec54-433b-9808-107cee523637",
"imageFormat": "image/jp2"
}
]
}
To calculate the price of a product the following endpoint must be used:
| API Endpoint | /api/v1/prices |
| REST verb | POST |
| Authentication | JWT Token |
| API Reference | Order API |
Below is an example of a call:
curl -X POST \
https://data.api.oneatlas.airbus.com/api/v1/prices \
-H 'Authorization: Bearer <access_token>' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
-d '{"kind": "order.data.gb.product",
"products": [
{
"crsCode": "urn:ogc:def:crs:EPSG::4326",
"productType": "pansharpened",
"radiometricProcessing": "DISPLAY",
"aoi": {
"type": "Polygon",
"coordinates": [
[
[
1.4089965820312502,
43.59829500262717
],
[
1.4089965820312502,
43.63408731864001
],
[
1.5078735351562496,
43.63408731864001
],
[
1.5078735351562496,
43.59829500262717
],
[
1.4089965820312502,
43.59829500262717
]
]
]
},
"id": "3f33d1b8-ec54-433b-9808-107cee523637",
"imageFormat": "image/jp2"
}
]
}'
var data = JSON.stringify({
"kind": "order.product",
"products": [
{
"productType": "bundle",
"radiometricProcessing": "REFLECTANCE",
"imageFormat": "image/jp2",
"crsCode": "urn:ogc:def:crs:EPSG::4326",
"id": "db234757-415e-45ea-91fe-b4a3430d9262",
"aoi": {
"type": "Polygon",
"coordinates": [
[
[
133.0892544400306,
-25.87101100509336
],
[
133.1536981096795,
-25.87132836142507
],
[
133.153641115244,
-25.92385213283325
],
[
133.0892077568722,
-25.92358780411442
],
[
133.0892544400306,
-25.87101100509336
]
]
]
}
}
]
});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://data.api.oneatlas.airbus.com/api/v1/prices");
xhr.setRequestHeader("Authorization", "Bearer <access_token>");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);
import requests
url = "https://data.api.oneatlas.airbus.com/api/v1/prices"
payload = "{ \"kind\": \"order.product\",\n \"products\": [\n {\n \"productType\": \"bundle\",\n \"radiometricProcessing\": \"REFLECTANCE\",\n \"imageFormat\": \"image/jp2\",\n \"crsCode\": \"urn:ogc:def:crs:EPSG::4326\",\n \"id\": \"db234757-415e-45ea-91fe-b4a3430d9262\",\n \"aoi\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n 133.0892544400306,\n -25.87101100509336\n ],\n [\n 133.1536981096795,\n -25.87132836142507\n ],\n [\n 133.153641115244,\n -25.92385213283325\n ],\n [\n 133.0892077568722,\n -25.92358780411442\n ],\n [\n 133.0892544400306,\n -25.87101100509336\n ]\n\n ]\n ]\n }\n }\n ]\n\n }"
headers = {
'Authorization': "Bearer <access_token>",
'Content-Type': "application/json"
}
response = requests.request("POST", url, data=payload, headers=headers)
print(response.text)
Note: Your
kindmust beorder.data.gb.productif you have a GB subscription ororder.productif you have a tiles subscription.
Here is a snippet of the response showing the price:
{
"payload": {
"kind": "order.data.gb.product",
"products": [
{
"crsCode": "urn:ogc:def:crs:EPSG::4326",
"productType": "pansharpened",
"radiometricProcessing": "DISPLAY",
"aoi": {
"type": "Polygon",
"coordinates": [
[
[
1.4089965820312502,
43.59829500262717
],
[
1.4089965820312502,
43.63408731864001
],
[
1.5078735351562496,
43.63408731864001
],
[
1.5078735351562496,
43.59829500262717
],
[
1.4089965820312502,
43.59829500262717
]
]
]
},
"id": "3f33d1b8-ec54-433b-9808-107cee523637",
"imageFormat": "image/jp2"
}
]
},
"deliveries": [
{
"datas": {
"aoi": {
"type": "Polygon",
"coordinates": [
[
[
1.4089965820312502,
43.59829500262717
],
[
1.4089965820312502,
43.63408731864001
],
[
1.5078735351562496,
43.63408731864001
],
[
1.5078735351562496,
43.59829500262717
],
[
1.4089965820312502,
43.59829500262717
]
]
]
},
"productType": "pansharpened",
"radiometricProcessing": "DISPLAY",
"imageFormat": "image/jp2",
"crsCode": "urn:ogc:def:crs:EPSG::4326",
"id": "3f33d1b8-ec54-433b-9808-107cee523637",
"sourceId": "DS_PHR1A_202002051111310_FR1_PX_E001N43_0615_01711"
},
"id": "3f33d1b8-ec54-433b-9808-107cee523637",
"amount": 196266,
"amountUnit": "kB",
"isAmountEstimated": "true",
"areaKm2": 31.75
}
],
"price": {
"credits": 196266,
"amount": 196266,
"isAmountEstimated": "true",
"areaKm2": 31.75,
"amountUnit": "kB"
},
"feasibility": "automatic",
"orderable": "ok"
}
The response provides information regarding the number of credits that will be decrease from the customer account when the order will be placed.
Place an Order for an Individual Product
Once you calculated the price of an individual product, you can place the order for true. If you are ready to proceed, then the following endpoint must be used:
| API Endpoint | /api/v1/orders |
| REST verb | POST |
| Authentication | JWT Token |
| API Reference | Order API |
The JSON structure to use is equivalent to the structure used to calculate the price:
{
"kind": "order.data.gb.product",
"products": [
{
"crsCode": "urn:ogc:def:crs:EPSG::4326",
"productType": "pansharpened",
"radiometricProcessing": "DISPLAY",
"aoi": {
"type": "Polygon",
"coordinates": [
...
}
}
]
}
Below is an example of a call:
curl -X POST \
https://data.api.oneatlas.airbus.com/api/v1/orders \
-H 'Authorization: Bearer <access_token>' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
-d '{
"kind": "order.data.gb.product",
"products": [
{
"crsCode": "urn:ogc:def:crs:EPSG::4326",
"productType": "pansharpened",
"radiometricProcessing": "DISPLAY",
"aoi": {
"type": "Polygon",
"coordinates": [
[
[
1.436290740966797,
43.6013406641502
],
[
1.436290740966797,
43.606064242322475
],
[
1.4414405822753906,
43.606064242322475
],
[
1.4414405822753906,
43.6013406641502
],
[
1.436290740966797,
43.6013406641502
]
]
]
},
"id": "3f33d1b8-ec54-433b-9808-107cee523637",
"imageFormat": "image/jp2"
}
]
}'
var data = JSON.stringify({
"kind": "order.data.gb.product",
"products": [
{
"crsCode": "urn:ogc:def:crs:EPSG::4326",
"productType": "pansharpened",
"radiometricProcessing": "DISPLAY",
"aoi": {
"type": "Polygon",
"coordinates": [
[
[
1.436290740966797,
43.6013406641502
],
[
1.436290740966797,
43.606064242322475
],
[
1.4414405822753906,
43.606064242322475
],
[
1.4414405822753906,
43.6013406641502
],
[
1.436290740966797,
43.6013406641502
]
]
]
},
"id": "3f33d1b8-ec54-433b-9808-107cee523637",
"imageFormat": "image/jp2"
}
]
});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://data.api.oneatlas.airbus.com/api/v1/orders");
xhr.setRequestHeader("Authorization", "Bearer <access_token>");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);
import requests
url = "https://data.api.oneatlas.airbus.com/api/v1/orders"
payload = "{\n \"kind\": \"order.data.gb.product\",\n \"products\": [\n {\n \"crsCode\": \"urn:ogc:def:crs:EPSG::4326\",\n \"productType\": \"pansharpened\",\n \"radiometricProcessing\": \"DISPLAY\",\n \"aoi\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n 1.436290740966797,\n 43.6013406641502\n ],\n [\n 1.436290740966797,\n 43.606064242322475\n ],\n [\n 1.4414405822753906,\n 43.606064242322475\n ],\n [\n 1.4414405822753906,\n 43.6013406641502\n ],\n [\n 1.436290740966797,\n 43.6013406641502\n ]\n ]\n ]\n },\n \"id\": \"3f33d1b8-ec54-433b-9808-107cee523637\",\n \"imageFormat\": \"image/jp2\"\n }\n ]\n}"
headers = {
'Authorization': "Bearer <access_token>",
'Content-Type': "application/json"
}
response = requests.request("POST", url, data=payload, headers=headers)
print(response.text)
Note: Your
kindmust beorder.data.gb.productif you have a GB subscription ororder.productif you have a tiles subscription.
Here you can see the initial response with status ordered.
{
"_links": {
"self": {
"href": "https://data.api.oneatlas.airbus.com/api/v1/orders/fc77c5e2-bcb4-4375-9924-4632e1363930"
},
"cancel": {
"href": "https://data.api.oneatlas.airbus.com/api/v1/orders/fc77c5e2-bcb4-4375-9924-4632e1363930/cancel"
},
"contract": {
"href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/ff731b8d-5637-40aa-89ad-daa736613714"
},
"payments": {
"href": "https://data.api.oneatlas.airbus.com/api/v1/orders/fc77c5e2-bcb4-4375-9924-4632e1363930/payments"
},
"deliveries": {
"href": "https://data.api.oneatlas.airbus.com/api/v1/orders/fc77c5e2-bcb4-4375-9924-4632e1363930/deliveries"
},
"subscription": {
"href": "https://data.api.oneatlas.airbus.com/api/v1/subscriptions/8fe89b39-9745-40b1-9a1f-5ce98aba2b13"
}
},
"id": "fc77c5e2-bcb4-4375-9924-4632e1363930",
"kind": "order.data.gb.product",
"service": "data",
"createdAt": "2020-02-12T10:05:34.548855+00:00",
"createdBy": "9915b46a-cddd-48e0-49e0-1cc1ddaea356",
"status": "ordered",
"contractId": "ff731b8d-5637-40aa-89ad-daa736613714",
"isAmountEstimated": "true",
"price": 2342,
"amount": 2342,
"amountUnit": "kB",
"payload": {
"kind": "order.data.gb.product",
"products": [
{
"crsCode": "urn:ogc:def:crs:EPSG::4326",
"productType": "pansharpened",
"radiometricProcessing": "DISPLAY",
"aoi": {
"type": "Polygon",
"coordinates": [
[
[
1.436290740966797,
43.6013406641502
],
[
1.436290740966797,
43.606064242322475
],
[
1.4414405822753906,
43.606064242322475
],
[
1.4414405822753906,
43.6013406641502
],
[
1.436290740966797,
43.6013406641502
]
]
]
},
"id": "3f33d1b8-ec54-433b-9808-107cee523637",
"imageFormat": "image/jp2"
}
]
},
"deliveries": [
{
"_links": {
"self": {
"href": "https://data.api.oneatlas.airbus.com/api/v1/deliveries/3d2cefe6-a633-4616-b46d-8ff7e5322dc4"
},
"contract": {
"href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/ff731b8d-5637-40aa-89ad-daa736613714"
}
},
"id": "3d2cefe6-a633-4616-b46d-8ff7e5322dc4",
"kind": "delivery.data.product",
"service": "data",
"createdAt": "2020-02-12T10:05:34.790364+00:00",
"status": "processing",
"isAmountEstimated": "true",
"price": 2342,
"amount": 2342,
"amountUnit": "kB",
"area": "0.22",
"unit": "km2",
"datas": {
"crsCode": "urn:ogc:def:crs:EPSG::4326",
"productType": "pansharpened",
"radiometricProcessing": "DISPLAY",
"aoi": {
"type": "Polygon",
"coordinates": [
[
[
1.436290740966797,
43.6013406641502
],
[
1.436290740966797,
43.606064242322475
],
[
1.4414405822753906,
43.606064242322475
],
[
1.4414405822753906,
43.6013406641502
],
[
1.436290740966797,
43.6013406641502
]
]
]
},
"id": "3f33d1b8-ec54-433b-9808-107cee523637",
"imageFormat": "image/jp2",
"sourceId": "DS_PHR1A_202002051111310_FR1_PX_E001N43_0615_01711",
"sensor": "PHR",
"segmentFootprint": {
"coordinates": [
[
[
1.272993564948617,
43.70597223691254
],
[
1.272188952114393,
43.51567564797212
],
[
1.569379361494543,
43.49472194422071
],
[
1.56943762506104,
43.68743396405859
],
[
1.272993564948617,
43.70597223691254
]
]
],
"type": "Polygon"
},
"processingLevel": "SENSOR",
"areaKm2": 0.22
},
"updatedAt": "2020-02-12T10:05:35.448096+00:00"
}
]
}
Within a few minutes your status will changed from ordered to delivered.
View Order Status
The /orders endpoint can be used to retrieve the status of your orders:
| API Endpoint | /api/v1/orders |
| REST verb | GET |
| Authentication | JWT Token |
| API Reference | Order API |
Here below is an example of a call:
curl -X GET "https://data.api.oneatlas.airbus.com/api/v1/orders" \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache"
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = false;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://data.api.oneatlas.airbus.com/api/v1/orders");
xhr.setRequestHeader("Authorization", "Bearer <access_token>");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Cache-Control", "no-cache");
xhr.send(data);
import requests
url = "https://data.api.oneatlas.airbus.com/api/v1/orders"
headers = {
'Authorization': "Bearer <access_token>",
'Content-Type': "application/json",
'Cache-Control': "no-cache",
}
response = requests.request("GET", url, headers=headers)
print(response.text)
A filter could be associated to this request to display orders that have a specific status. Available statuses for orders are the following ones:
| Status | Description |
|---|---|
| error | An error occurred during the production process. |
| delivered | The products have been produced and available in your private workspace. |
| ordered | The products have just been ordered and will be processed; the production is in progress. |
| rejected | The order has been rejected, insufficient balance. |
Also, it is possible to filter per product kind, two kinds being available:
| Kind | Description |
|---|---|
| order.data.gb.product | Individual image product |
| order.analytics-toolbox.archive | Individual Analytics Toolbox product |
If there are a lot of results to list, there’s a pagination mechanism to limit the number of results. If you want to activate it, the itemsPerPage parameter can be used.
For example, listing the first order delivered could be requested by using the following:
curl -X GET "https://data.api.oneatlas.airbus.com/api/v1/orders?status=delivered&kind=order.subscription.streaming&page=1&itemsPerPage=1" \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache"
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = false;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://data.api.oneatlas.airbus.com/api/v1/orders??status=delivered&itemsPerPage=1");
xhr.setRequestHeader("Authorization", "Bearer <access_token>");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Cache-Control", "no-cache");
xhr.send(data);
Not available
And the associated response:
{
"startIndex": 0,
"totalResults": 500,
"countLimitReached": true,
"itemsPerPage": 1,
"items": [
{
"_links": {
"self": {
"href": "https://data.api.oneatlas.airbus.com/api/v1/orders/c7d0301b-188b-4476-8ccb-19882bfe0c6a"
},
"cancel": {
"href": "https://data.api.oneatlas.airbus.com/api/v1/orders/c7d0301b-188b-4476-8ccb-19882bfe0c6a/cancel"
},
"contract": {
"href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/ff731b8d-5637-40aa-89ad-daa736613714"
},
"payments": {
"href": "https://data.api.oneatlas.airbus.com/api/v1/orders/c7d0301b-188b-4476-8ccb-19882bfe0c6a/payments"
},
"deliveries": {
"href": "https://data.api.oneatlas.airbus.com/api/v1/orders/c7d0301b-188b-4476-8ccb-19882bfe0c6a/deliveries"
},
"subscription": {
"href": "https://data.api.oneatlas.airbus.com/api/v1/subscriptions/8fe89b39-9745-40b1-9a1f-5ce98aba2b13"
}
},
"id": "c7d0301b-188b-4476-8ccb-19882bfe0c6a",
"kind": "order.data.gb.product",
"service": "data",
"createdAt": "2020-02-18T14:52:23.706942+00:00",
"createdBy": "3b3af8c8-3fde-4ad5-26fa-a28f6464e067",
"status": "delivered",
"contractId": "ff731b8d-5637-40aa-89ad-daa736613714",
"isAmountEstimated": "false",
"price": 2049,
"amount": 2049,
"amountUnit": "kB",
"estimatedAmount": 2665,
"payload": {
"kind": "order.data.gb.product",
"products": [
{
"crsCode": "urn:ogc:def:crs:EPSG::4326",
"productType": "pansharpened",
"radiometricProcessing": "DISPLAY",
"aoi": {
"type": "Polygon",
"coordinates": [
[
[
4.705066680908203,
50.86576445831801
],
[
4.705066680908203,
50.869271906986995
],
[
4.714937210083009,
50.869271906986995
],
[
4.714937210083009,
50.86576445831801
],
[
4.705066680908203,
50.86576445831801
]
]
]
},
"id": "ce6b6688-0400-43cc-99d6-b0e6fe1cdc46",
"imageFormat": "image/jp2"
}
]
},
"deliveries": [
{
"_links": {
"self": {
"href": "https://data.api.oneatlas.airbus.com/api/v1/deliveries/f96b2b86-d0da-4e3f-8dde-31ecfbaa49f6"
},
"contract": {
"href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/ff731b8d-5637-40aa-89ad-daa736613714"
},
"catalogUrl": {
"href": "https://search.foundation.api.oneatlas.airbus.com/api/v1/opensearch?id=ba5e3b48-3bc7-4438-8153-552bf6c6c3e2"
},
"catalogItem": {
"href": "https://search.foundation.api.oneatlas.airbus.com/api/v1/opensearch?id=ba5e3b48-3bc7-4438-8153-552bf6c6c3e2"
},
"download": {
"href": "https://access.foundation.api.oneatlas.airbus.com/api/v1/items/ba5e3b48-3bc7-4438-8153-552bf6c6c3e2/download"
},
"payment": {
"href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/ff731b8d-5637-40aa-89ad-daa736613714/payments/25fa3352-d739-44c1-85e4-170eba7e8400"
}
},
"id": "f96b2b86-d0da-4e3f-8dde-31ecfbaa49f6",
"kind": "delivery.data.product",
"service": "data",
"createdAt": "2020-02-18T14:52:23.906018+00:00",
"status": "delivered",
"isAmountEstimated": "false",
"price": 2049,
"amount": 2049,
"estimatedAmount": 2665,
"amountUnit": "kB",
"area": "0.27",
"unit": "km2",
"datas": {
"crsCode": "urn:ogc:def:crs:EPSG::4326",
"productType": "pansharpened",
"radiometricProcessing": "DISPLAY",
"aoi": {
"type": "Polygon",
"coordinates": [
[
[
4.705066680908203,
50.86576445831801
],
[
4.705066680908203,
50.869271906986995
],
[
4.714937210083009,
50.869271906986995
],
[
4.714937210083009,
50.86576445831801
],
[
4.705066680908203,
50.86576445831801
]
]
]
},
"id": "ce6b6688-0400-43cc-99d6-b0e6fe1cdc46",
"imageFormat": "image/jp2",
"sourceId": "DS_PHR1A_201705111101521_FR1_PX_E004N50_0923_01783",
"sensor": "PHR",
"segmentFootprint": {
"coordinates": [
[
[
4.590889548726914,
51.01415297509098
],
[
4.905543929335252,
51.0226354352714
],
[
4.905286153735808,
50.833949505459
],
[
4.590360936603221,
50.82714044986403
],
[
4.590889548726914,
51.01415297509098
]
]
],
"type": "Polygon"
},
"processingLevel": "SENSOR",
"areaKm2": 0.27
},
"updatedAt": "2020-02-18T14:54:40.909548+00:00",
"deliveredAt": "2020-02-18T14:54:40.909548+00:00"
}
]
}
]
}
© Airbus Defence and Space 2018. All rights reserved. Privacy Policy | Legal Information