Language
Radar Tasking & Archive - API
The API enables you to task an acquisition or search for archive imagery. The API is provided as an HTTP REST API and is using GeoJSON.
The basic workflow for placing an order is as follows.
- Task your acquisition or find suitable imagery in the archive
- For tasking: send description of acquisition to feasibility endpoint
- For archive: send description of imagery to catalogue endpoint
- Place an order
- Add suitable acquisition or imagery to your shopcart
- Patch your shopcart by providing an order purpose
- Place your order by submitting the shopcart
- Monitor your order
- Download your data from the delivery endpoint
1.1 Find your future acquisition (for tasking)
When searching for possible acquisitions for tasking you must provide the following parameters.
| AOI | Contains the AOI the feasibility is requested for |
| time | Time range for feasibility search |
| feasibilityLevel | Must have a value of “complete” |
| sensorMode | The imaging/instrument/sensor mode to use for the acquisition |
| productType | Product type for the processing of the acquisition (Available: SSC, MGD, GEC, EEC) |
| orbitType | Recommended for future acquisitions is rapid |
| Please see API Specification for further filter parameters |
The endpoint to search for future (tasking) acsquisitions:
| API Endpoint | https://sar.api.oneatlas.airbus.com/v1/sar/feasibility |
| REST verb | POST |
| Authentication | JWT Token |
| API Reference | SAR API |
The only mandatory parameter is a JSON payload following this schema:
{
"aoi": {
"type": "Polygon",
"coordinates": [[[9.346, 47.788], [9.291, 47.644], [9.538, 47.592], [9.62, 47.75], [9.511, 47.802], [9.346, 47.788]]]
},
"time": {
"from": "2022-10-14T13:28:03.569Z",
"to": "2022-10-24T13:28:03.569Z"
},
"feasibilityLevel": "complete",
"sensorMode": "SAR_SM_S",
"productType": "EEC",
"orbitType": "NRT"
}
Below is an example of the call:
curl -X POST \
'https://sar.api.oneatlas.airbus.com/v1/sar/feasibility' \
-H 'Authorization: Bearer <access_token>' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json'
-d '{
"aoi": {
"type": "Polygon",
"coordinates": [[[9.346, 47.788], [9.291, 47.644], [9.538, 47.592], [9.62, 47.75], [9.511, 47.802], [9.346, 47.788]]]
},
"time": {
"from": "2022-10-14T13:28:03.569Z",
"to": "2022-10-24T13:28:03.569Z"
},
"feasibilityLevel": "complete",
"sensorMode": "SAR_SM_S",
"productType": "EEC",
"orbitType": "NRT"
}'
Each feature contains an itemId which is needed to add the acquisition to the shopcart for order placement. The response is shown below.
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
9.9538131,
47.4980337
],
[
9.9526947,
47.5021113
],
[
9.9162488,
47.6270696
],
[
9.8795075,
47.7519972
],
[
9.8423837,
47.8768735
],
[
9.8066473,
47.9977132
],
[
9.3889616,
47.9406197
],
[
9.4256935,
47.819838
],
[
9.4648433,
47.6951461
],
[
9.502884,
47.5703346
],
[
9.5385999,
47.4451919
],
[
9.5398951,
47.4411314
],
[
9.9538131,
47.4980337
]
]
]
},
"properties": {
"acquisitionId": "TSX-1_SM_S_strip_004R_85134_A13768051_8000",
"startTime": "2022-10-21T16:59:42.136Z",
"stopTime": "2022-10-21T16:59:50.136Z",
"submissionDeadline": "2022-10-20T21:30:00Z",
"expiry": "2022-07-04T15:56:31Z",
"estimatedDownloadAvailability": "2022-10-21T17:00:00Z",
"sensorMode": "SAR_SM_S",
"polarizationChannels": "HH",
"beamId": "strip_004R",
"pathDirection": "ascending",
"lookDirection": "R",
"incidenceAngle": {
"minimum": 22.29,
"maximum": 25.56
},
"relativeOrbit": 131,
"absoluteOrbit": 85134,
"priority": "standard",
"mission": "TSX",
"satellite": "TSX-1",
"productType": "EEC",
"orbitType": "NRT",
"itemType": "future",
"acquisitionOnly": false,
"itemId": "57c91769-91e1-2f7e-2883-50a78a10b62c",
"lastUpdateTime": "2022-06-27T15:56:31Z",
"status": "feasible",
"conflicts": {
"status": "none"
},
"sensitivity": {
"status": "potential",
"missingParameters": [
"resolutionVariant"
]
}
}
}
]
}
1.2 Find archive imagery
When searching for possible archive acquisitions there are no required parameters. However, at minimum you’ll probably want to specify at least an AOI and time range.
| AOI | Contains the AOI for the search |
| time | Time range for the search |
The endpoint to search for catalogue acquisitions:
| API Endpoint | https://sar.api.oneatlas.airbus.com/v1/sar/catalogue |
| REST verb | POST |
| Authentication | JWT Token |
| API Reference | SAR API |
The only and mandatory parameter is a JSON payload following this schema:
{
"aoi": {
"type": "Polygon",
"coordinates": [
[[9.346, 47.788], [9.291, 47.644], [9.538, 47.592], [9.62, 47.75], [9.511, 47.802], [9.346, 47.788]]
]
},
"time": {
"from": "2021-10-14T13:28:03.569Z",
"to": "2021-10-29T13:28:03.569Z"
}
}
Below is an example of the call:
curl -X POST \
'https://sar.api.oneatlas.airbus.com/v1/sar/catalogue' \
-H 'Authorization: Bearer <access_token>' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json'
-d '{
"aoi": {
"type": "Polygon",
"coordinates": [
[[9.346, 47.788], [9.291, 47.644], [9.538, 47.592], [9.62, 47.75], [9.511, 47.802], [9.346, 47.788]]
]
},
"time": {
"from": "2021-10-14T13:28:03.569Z",
"to": "2021-10-29T13:28:03.569Z"
}
}'
Each feature contains an itemId which is needed to add the acquisition to the shopcart in order to order it. The response is shown below.
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
160.0763526,
56.984591
],
[
160.0631124,
57.0308927
],
[
159.928554,
57.0171956
],
[
159.9426206,
56.9709652
],
[
160.0763526,
56.984591
]
]
]
},
"properties": {
"itemId": "23d5f214-1552-c3e0-78dd-436b2ab49ab7",
"satellite": "TSX-1",
"acquisitionId": "TSX-1_HS300_S_spot_047R_2660_A14700092_740",
"startTime": "2007-12-07T06:58:36.665000Z",
"stopTime": "2007-12-07T06:58:37.405000Z",
"polarizationChannels": "HH",
"beamId": "spot_047",
"pathDirection": "ascending",
"lookDirection": "R",
"incidenceAngle": {
"minimum": 38.05,
"maximum": 38.75
},
"relativeOrbit": 155,
"absoluteOrbit": 2660,
"status": "availableInArchive",
"itemType": "catalogue",
"catalogueTime": "2022-02-12T17:41:39.855601Z",
"antennaMode": "SRA",
"datastackCount": 1,
"centerTime": "2007-12-07T06:58:37.035000Z",
"lastUpdateTime": "2022-06-27T16:54:06Z",
"mission": "TSX",
"sensorMode": "SAR_HS_S_300",
"quality": "AUTO_APPROVED",
"downlinkTime": "2007-12-07T07:17:32.000000Z",
"resolution": {
"minimum": 1.0,
"maximum": 3.5
}
}
}
]
}
2. Place an order
Placing an order is a multiple step process of adding items to your shopcart, defining a purpose, and then submitting the shopcart.
2.1 Add items to your shopcart
When adding items to your shopcart you must provide the following parameter.
| items | List containing one or more tasking or archive itemIds |
| orderOptions.productType | Product type for the processing of the acquisition |
| orderOptions.resolutionVariant | Radiometric or spatial enhancement |
| orderOptions.orbitType | Near realtime acquisition, science processing, or rapid |
| orderOptions.mapProjection | Projection of the delivered product |
| orderOptions.gainAttenuation | Processor gain attenuation |
The endpoint to add items to your shopcart:
| API Endpoint | https://sar.api.oneatlas.airbus.com/v1/sar/shopcart/addItems |
| REST verb | POST |
| Authentication | JWT Token |
| API Reference | SAR API |
The only and mandatory parameter is a JSON payload following this schema:
{
"items": [
"23d5f214-1552-c3e0-78dd-436b2ab49ab7"
],
"orderOptions": {
"productType": "EEC",
"resolutionVariant": "RE",
"orbitType": "rapid",
"mapProjection": "auto",
"gainAttenuation": 0
}
}
Below is an example of the call:
curl -X POST \
'https://sar.api.oneatlas.airbus.com/v1/sar/shopcart/addItems' \
-H 'Authorization: Bearer <access_token>' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json'
-d '{
"items": [
"23d5f214-1552-c3e0-78dd-436b2ab49ab7"
],
"orderOptions": {
"productType": "EEC",
"resolutionVariant": "RE",
"orbitType": "rapid",
"mapProjection": "auto",
"gainAttenuation": 0
}
}'
The response will contain a feature collection of the added items:
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
160.0763526,
56.984591
],
[
160.0631124,
57.0308927
],
[
159.928554,
57.0171956
],
[
159.9426206,
56.9709652
],
[
160.0763526,
56.984591
]
]
]
},
"properties": {
"itemId": "23d5f214-1552-c3e0-78dd-436b2ab49ab7",
"orderItemId": "1",
"mission": "TSX",
"acquisitionId": "TSX-1_HS300_S_spot_047R_2660_A14700092_740",
"startTime": "2007-12-07T06:58:36.665Z",
"stopTime": "2007-12-07T06:58:37.405Z",
"polarizationChannels": "HH",
"beamId": "spot_047",
"pathDirection": "ascending",
"lookDirection": "R",
"incidenceAngle": {
"minimum": 38.05,
"maximum": 38.75
},
"productType": "EEC",
"resolutionVariant": "RE",
"orbitType": "rapid",
"mapProjection": "auto",
"gainAttenuation": 0,
"relativeOrbit": 155,
"absoluteOrbit": 2660,
"status": "availableInArchive",
"itemType": "catalogue",
"price": {
"total": 2812.5,
"currency": "USD",
"unitPrice": 2812.5,
"quantity": 1.0,
"final": true
},
"lastUpdateTime": "2022-07-05T15:46:38Z",
"sensorMode": "SAR_HS_S_300"
}
}
]
}
2.2 Patch your shopcart
Your shopcart must be patched to provide a purpose.
| purpose | One of the available values documented in the API Reference. |
The endpoint to patch your shopcart:
| API Endpoint | https://sar.api.oneatlas.airbus.com/v1/sar/shopcart |
| REST verb | PATCH |
| Authentication | JWT Token |
| API Reference | SAR API |
The only and mandatory parameter is a JSON payload following this schema:
{
"purpose": "Aerospace Industry Company"
}
Below is an example of the call:
curl -X PATCH \
'https://sar.api.oneatlas.airbus.com/v1/sar/shopcart' \
-H 'Authorization: Bearer <access_token>' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json'
-d '{
"purpose": "Aerospace Industry Company"
}'
The response will return the current values that have been assigned from patching your shopcart:
{
"purpose": "Aerospace Industry Company"
}
2.3 Submit your shopcart
The final step in placing your order is to submit your shopcart. No additional payload is required for this request.
The endpoint to submit your shopcart:
| API Endpoint | https://sar.api.oneatlas.airbus.com/v1/sar/shopcart/submit |
| REST verb | POST |
| Authentication | JWT Token |
| API Reference | SAR API |
Below is an example of the call:
curl -X POST \
'https://sar.api.oneatlas.airbus.com/v1/sar/shopcart/submit' \
-H 'Authorization: Bearer <access_token>' \
-H 'Cache-Control: no-cache' \
The response will return order details including an estimated date the data will be available for download:
{
"orderId": "135758",
"purpose": "Aerospace Industry Company",
"items": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
160.0763526,
56.984591
],
[
160.0631124,
57.0308927
],
[
159.928554,
57.0171956
],
[
159.9426206,
56.9709652
],
[
160.0763526,
56.984591
]
]
]
},
"properties": {
"itemId": "23d5f214-1552-c3e0-78dd-436b2ab49ab7",
"orderItemId": "000135758_0001",
"mission": "TSX",
"acquisitionId": "TSX-1_HS300_S_spot_047R_2660_A14700092_740",
"startTime": "2007-12-07T06:58:36.665Z",
"stopTime": "2007-12-07T06:58:37.405Z",
"polarizationChannels": "HH",
"beamId": "spot_047",
"pathDirection": "ascending",
"lookDirection": "R",
"incidenceAngle": {
"minimum": 38.05,
"maximum": 38.75
},
"productType": "EEC",
"resolutionVariant": "RE",
"orbitType": "rapid",
"mapProjection": "auto",
"gainAttenuation": 0,
"relativeOrbit": 155,
"absoluteOrbit": 2660,
"status": "submitted",
"itemType": "catalogue",
"price": {
"final": true,
"total": 2812.5,
"currency": "USD",
"quantity": 1.0,
"unitPrice": 2812.5
},
"lastUpdateTime": "2022-07-05T15:56:44Z",
"sensorMode": "SAR_HS_S_300",
"estimatedDownloadAvailability": "2022-07-05T17:56:18.373Z",
"orderSubmissionTime": "2022-07-05T15:56:18.373Z"
}
}
]
}
}
3. Check order status
Your order and its current status may be monitored.
The endpoint to check your order status:
| API Endpoint | https://sar.api.oneatlas.airbus.com/v1/sar/orders |
| REST verb | GET |
| Authentication | JWT Token |
| API Reference | SAR API |
Below is an example of the call:
curl -X GET \
'https://sar.api.oneatlas.airbus.com/v1/sar/orders/<order_id>' \
-H 'Authorization: Bearer <access_token>' \
-H 'Cache-Control: no-cache' \
The response will return order details including a current status for each item.
4. Download the data
Once your order is available you will receive a delivery notification by email containing information on how to download your data via FTPS or Aspera.
© Airbus Defence and Space 2022. All rights reserved. Privacy Policy | Legal Information
Contact Us