OneAtlas Radar API is a powerful tool that allows developers to access and integrate radar satellite data into their applications and processes. By utilizing this API, users can access real-time and historical radar imagery, which can be used for a wide range of applications including agriculture, disaster management, urban planning, and security.
openapi: 3.0.3
info:
title: Airbus OneAtlas OneAtlas Radar API
version: 1.0.0
contact:
email: [email protected]
description: >-
OneAtlas Radar API is a powerful tool that allows developers to access and
integrate radar satellite data into their applications and processes. By
utilizing this API, users can access real-time and historical radar imagery,
which can be used for a wide range of applications including agriculture,
disaster management, urban planning, and security. The API provides
high-resolution radar images that can be used for monitoring changes in land
cover, detecting anomalies, and analyzing patterns over time. With OneAtlas
Radar API, users can access valuable radar data to enhance their
decision-making processes and improve their overall operational efficiency.
tags:
- name: Sar/Baskets
description: |
Handle your baskets to order SAR acquisitions.
- name: Sar/Config
description: |
Endpoint for SAR specific user configuration.
- name: Sar/Editing
description: |
Endpoint to modify an SAR acquisition.
- name: Sar/Monitoring
description: |
Monitor your ordered SAR acquisitions.
- name: Sar/Prices
description: |
Query the price of an SAR acquisition.
- name: Sar/Replication
- name: Sar/Search
description: |
Endpoint to search for possible SAR acquisitions.
- name: Sar/Shopcart
description: |
<b>Deprecated!</b> Please use baskets instead.
- name: User
description: |
Endpoint for generic user information.
servers:
- url: https://sar.api.oneatlas.airbus.com/v1
description: OneAtlas - Radar Tasking & Archive
paths:
/user/whoami:
get:
summary: Airbus OneAtlas Return Account Information of the Current User
tags:
- User
responses:
'200':
description: Basic account information
content:
application/json:
schema:
type: object
properties:
username:
type: string
description: Unique account name
example: [email protected]
pw_change_needed:
type: boolean
description: >-
This flag is set if the password has been (re)set by the
system or flagged for some other reason (e.g. if security
standards have changed). It is unrelated to the password
expiration date.
pw_expiration_date:
type: string
format: date
description: >-
If the password of this account is set to expire, this is
the end date (included) until which the password can be
used to log in without being changed
expiration_date:
type: string
format: date
nullable: true
description: End date (included) until which the user is able to log in
services:
type: array
items:
type: string
example: radar
enum:
- radar
- worlddem
- mgmt
description: The service identifier
example:
- radar
- worlddem
registration_status:
type: string
enum:
- pending
- in_progress
- completed
description: >-
This flag is only set if the account isn't fully
registered
oneatlas_username:
type: string
description: Account username in OneAtlas
example: [email protected]
'400':
description: Bad Request
content:
application/json:
schema:
required:
- code
- message
properties:
code:
type: integer
message:
type: string
'401':
description: No authentication information available
/sar/config:
get:
summary: Airbus OneAtlas Retrieve Entire Configuration
tags:
- Sar/Config
responses:
'200':
description: omnibus configuration
content:
application/json:
schema:
type: object
properties:
permissions:
type: object
properties:
acquisitionOnly:
type: boolean
leftLooking:
type: boolean
outOfFullPerformance:
type: boolean
PAZ:
type: boolean
required:
- acquisitionOnly
- leftLooking
- outOfFullPerformance
- PAZ
receivingStations:
type: array
items:
description: Downlink station to use for direct-access customers
type: string
default: NSG_POOL
example: NSG_POOL
orderTemplates:
type: array
items:
type: object
properties:
name:
type: string
description:
type: string
default:
type: boolean
'400':
description: Bad Request
content:
application/json:
schema:
type: object
required:
- error
- message
properties:
error:
type: string
pattern: ^[A-Za-z0-9]+[A-Z-a-z0-9_\-]*[A-Za-z0-9]$
message:
type: string
location:
type: string
detail:
type: string
params:
type: object
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
type: object
required:
- error
- message
properties:
error:
type: string
pattern: ^[A-Za-z0-9]+[A-Z-a-z0-9_\-]*[A-Za-z0-9]$
message:
type: string
location:
type: string
detail:
type: string
params:
type: object
'403':
description: Forbidden
content:
application/json:
schema:
type: object
required:
- error
- message
properties:
error:
type: string
pattern: ^[A-Za-z0-9]+[A-Z-a-z0-9_\-]*[A-Za-z0-9]$
message:
type: string
location:
type: string
detail:
type: string
params:
type: object
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
required:
- error
- message
properties:
error:
type: string
pattern: ^[A-Za-z0-9]+[A-Z-a-z0-9_\-]*[A-Za-z0-9]$
message:
type: string
location:
type: string
detail:
type: string
params:
type: object
'503':
description: Connection to internal service error
content:
application/json:
schema:
type: object
required:
- error
- message
properties:
error:
type: string
pattern: ^[A-Za-z0-9]+[A-Z-a-z0-9_\-]*[A-Za-z0-9]$
message:
type: string
location:
type: string
detail:
type: string
params:
type: object
/sar/config/orderTemplates:
get:
summary: Airbus OneAtlas Retrieve List of Order Templates
tags:
- Sar/Config
responses:
'200':
description: list of order templates
content:
application/json:
schema:
type: array
items:
type: object
properties:
name:
type: string
description:
type: string
default:
type: boolean
'400':
description: Bad Request
content:
application/json:
schema:
type: object
required:
- error
- message
properties:
error:
type: string
pattern: ^[A-Za-z0-9]+[A-Z-a-z0-9_\-]*[A-Za-z0-9]$
message:
type: string
location:
type: string
detail:
type: string
params:
type: object
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
type: object
required:
- error
- message
properties:
error:
type: string
pattern: ^[A-Za-z0-9]+[A-Z-a-z0-9_\-]*[A-Za-z0-9]$
message:
type: string
location:
type: string
detail:
type: string
params:
type: object
'403':
description: Forbidden
content:
application/json:
schema:
type: object
required:
- error
- message
properties:
error:
type: string
pattern: ^[A-Za-z0-9]+[A-Z-a-z0-9_\-]*[A-Za-z0-9]$
message:
type: string
location:
type: string
detail:
type: string
params:
type: object
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
required:
- error
- message
properties:
error:
type: string
pattern: ^[A-Za-z0-9]+[A-Z-a-z0-9_\-]*[A-Za-z0-9]$
message:
type: string
location:
type: string
detail:
type: string
params:
type: object
'503':
description: Connection to internal service error
content:
application/json:
schema:
type: object
required:
- error
- message
properties:
error:
type: string
pattern: ^[A-Za-z0-9]+[A-Z-a-z0-9_\-]*[A-Za-z0-9]$
message:
type: string
location:
type: string
detail:
type: string
params:
type: object
/sar/config/permissions:
get:
summary: Airbus OneAtlas Get User Permissions
tags:
- Sar/Config
responses:
'200':
description: user permissions
content:
application/json:
schema:
type: object
properties:
acquisitionOnly:
type: boolean
leftLooking:
type: boolean
outOfFullPerformance:
type: boolean
PAZ:
type: boolean
required:
- acquisitionOnly
- leftLooking
- outOfFullPerformance
- PAZ
'400':
description: Bad Request
content:
application/json:
schema:
type: object
required:
- error
- message
properties:
error:
type: string
pattern: ^[A-Za-z0-9]+[A-Z-a-z0-9_\-]*[A-Za-z0-9]$
message:
type: string
location:
type: string
detail:
type: string
params:
type: object
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
type: object
required:
- error
- message
properties:
error:
type: string
pattern: ^[A-Za-z0-9]+[A-Z-a-z0-9_\-]*[A-Za-z0-9]$
message:
type: string
location:
type: string
detail:
type: string
params:
type: object
'403':
description: Forbidden
content:
application/json:
schema:
type: object
required:
- error
- message
properties:
error:
type: string
pattern: ^[A-Za-z0-9]+[A-Z-a-z0-9_\-]*[A-Za-z0-9]$
message:
type: string
location:
type: string
detail:
type: string
params:
type: object
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
required:
- error
- message
properties:
error:
type: string
pattern: ^[A-Za-z0-9]+[A-Z-a-z0-9_\-]*[A-Za-z0-9]$
message:
type: string
location:
type: string
detail:
type: string
params:
type: object
'503':
description: Connection to internal service error
content:
application/json:
schema:
type: object
required:
- error
- message
properties:
error:
type: string
pattern: ^[A-Za-z0-9]+[A-Z-a-z0-9_\-]*[A-Za-z0-9]$
message:
type: string
location:
type: string
detail:
type: string
params:
type: object
/sar/config/receivingStations:
get:
summary: Airbus OneAtlas Get Allowed Receiving Stations
tags:
- Sar/Config
responses:
'200':
description: list of receiving stations
content:
application/json:
schema:
type: array
items:
description: Downlink station to use for direct-access customers
type: string
default: NSG_POOL
example: NSG_POOL
'400':
description: Bad Request
content:
application/json:
schema:
type: object
required:
- error
- message
properties:
error:
type: string
pattern: ^[A-Za-z0-9]+[A-Z-a-z0-9_\-]*[A-Za-z0-9]$
message:
type: string
location:
type: string
detail:
type: string
params:
type: object
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
type: object
required:
- error
- message
properties:
error:
type: string
pattern: ^[A-Za-z0-9]+[A-Z-a-z0-9_\-]*[A-Za-z0-9]$
message:
type: string
location:
type: string
detail:
type: string
params:
type: object
'403':
description: Forbidden
content:
application/json:
schema:
type: object
required:
- error
- message
properties:
error:
type: string
pattern: ^[A-Za-z0-9]+[A-Z-a-z0-9_\-]*[A-Za-z0-9]$
message:
type: string
location:
type: string
detail:
type: string
params:
type: object
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
required:
- error
- message
properties:
error:
type: string
pattern: ^[A-Za-z0-9]+[A-Z-a-z0-9_\-]*[A-Za-z0-9]$
message:
type: string
location:
type: string
detail:
type: string
params:
type: object
'503':
description: Connection to internal service error
content:
application/json:
schema:
type: object
required:
- error
- message
properties:
error:
type: string
pattern: ^[A-Za-z0-9]+[A-Z-a-z0-9_\-]*[A-Za-z0-9]$
message:
type: string
location:
type: string
detail:
type: string
params:
type: object
/sar/feasibility:
post:
summary: Airbus OneAtlas Search for Possible Acquisitions for Tasking
tags:
- Sar/Search
requestBody:
description: Search parameters
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- aoi
- time
- feasibilityLevel
- sensorMode
properties:
aoi:
oneOf:
- allOf:
- description: Polygon for feasibility search
- type: object
additionalProperties: false
required:
- type
- coordinates
properties:
type:
type: string
enum:
- Polygon
coordinates:
type: array
minLength: 1
items:
type: array
minLength: 3
items:
type: array
minLength: 2
maxLength: 2
items:
type: number
example:
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
- allOf:
- description: MultiPolygon for feasibility search
- type: object
additionalProperties: false
required:
- type
- coordinates
properties:
type:
type: string
enum:
- MultiPolygon
coordinates:
type: array
minLength: 1
items:
type: array
minLength: 1
items:
type: array
minLength: 3
items:
type: array
minLength: 2
maxLength: 2
items:
type: number
example:
type: MultiPolygon
coordinates:
- - - - 8.346
- 47.788
- - 8.291
- 47.644
- - 8.538
- 47.592
- - 8.62
- 47.75
- - 8.511
- 47.802
- - 8.346
- 47.788
- - - 9.346
- 47.788
- - 9.291
- 47.644
- - 9.538
- 47.592
- - 9.62
- 47.75
- - 9.511
- 47.802
- - 9.346
- 47.788
- allOf:
- description: Point for feasibility search
- type: object
additionalProperties: false
required:
- type
- coordinates
properties:
type:
type: string
enum:
- Point
coordinates:
type: array
minLength: 2
maxLength: 2
items:
type: number
example:
type: Point
coordinates:
- 9.346
- 47.788
time:
allOf:
- description: Time range for feasibility search
- type: object
additionalProperties: false
properties:
from:
type: string
format: date-time
example: '2021-10-14T13:28:03.569Z'
to:
type: string
format: date-time
example: '2021-10-24T13:28:03.569Z'
mission:
oneOf:
- description: Array of Satellite missions
type: array
items:
type: string
enum:
- TSX
- PAZ
default:
- TSX
- PAZ
example:
- TSX
- PAZ
- description: Satellite mission
type: string
default: all
enum:
- TSX
- PAZ
- all
priority:
description: >-
Higher priority orders have a better chance of success but
incur an additional fee
type: string
enum:
- standard
- priority
- exclusive
example: standard
feasibilityLevel:
description: Level of feasibility for the search
type: string
enum:
- simple
- complete
periodicity:
description: >-
If set a datastack search will be performed. There will be
up to 3 footprints with datastacks (grouped by groupId)
taking periodicity and occerrences into account.
type: integer
enum:
- 11
- 22
- 33
- 44
- 55
- 66
- 77
- 88
- 99
occurrences:
description: >-
If set: Number of times a scene should be acquired. This
parameter will only be used if periodicity is set and can be
used for the acquisition of datastacks.
type: integer
minimum: 2
maximum: 50
sensorMode:
description: >-
The imaging/instrument/sensor mode to use for the
acquisition
type: string
enum:
- SAR_ST_S
- SAR_HS_S
- SAR_HS_S_300
- SAR_HS_S_150
- SAR_HS_D
- SAR_HS_D_300
- SAR_HS_D_150
- SAR_SL_S
- SAR_SL_D
- SAR_SM_S
- SAR_SM_D
- SAR_SC_S
- SAR_WS_S
example: SAR_SM_S
polarizationChannels:
description: >-
The dual-polarization modes (HHVV, HHHV, VVVH) are not
available for staring spotlight or (wide) ScanSAR modes. The
polarization modes HV and VH are only available for Wide
ScanSAR acquisitions.
type: string
enum:
- HH
- VV
- HV
- VH
- HHVV
- HHHV
- VVVH
example: HH
incidenceAngle:
description: >-
Incidence angle range in degrees. Only acquisitions with an
average incidence angle in this range will be considered.
type: object
additionalProperties: false
properties:
minimum:
type: number
minimum: 10
maximum: 70
example: 30
maximum:
type: number
minimum: 10
maximum: 70
example: 50
pathDirection:
default:
- ascending
- descending
oneOf:
- description: Path or orbit direction
type: string
default: both
example: ascending
enum:
- ascending
- descending
- both
- description: Path or orbit direction
type: array
items:
type: string
enum:
- ascending
- descending
lookDirection:
description: >-
Look Direction. Left-looking acquisitions require special
authorization.
type: string
enum:
- R
- L
outOfFullPerformance:
description: >-
If set to true and the account is authorized, out of full
performance scenes will be included in the response.
type: boolean
default: false
orderTemplate:
type: string
productType:
description: >-
Product type for the processing of the acuqisition.
Mandatory on placing the order, but not for feasibility.
type: string
enum:
- SSC
- MGD
- GEC
- EEC
example: EEC
resolutionVariant:
description: >-
Radiometric or spatial enhancement. Mandatory on placing the
order, but not for feasibility.
type: string
enum:
- SE
- RE
acquisitionOnly:
description: >-
Acquisition is done and archived, but product will not be
processed and deliverd. Requires special authorization.
type: boolean
default: false
receivingStation:
description: Downlink station to use for direct-access customers
type: string
default: NSG_POOL
example: NSG_POOL
orbitType:
description: >-
# --- truncated at 32 KB (925 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/airbus-oneatlas/refs/heads/main/openapi/oneatlas-radar-api-openapi.yml