Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
AlertResource
  • /alerts
  • /alerts/{id}
  • GET POST
  • DELETE
An API for managing the alerts of newly acquired product.
AuthenticationEndpoint
  • /authentication
  • POST
End point for requesting an authorization token to access the rest of services in the API. Once you have a token set the "Authorization" header of every API query you make to "Token " + the token the value. For instance if your token is '1234567890AB', your "Authorization" header becomes "Token 1234567890AB".
RequestResource
  • /request
  • /request/{id}
  • GET
  • POST PUT
An API for managing image requests from the Long Term Archive.
SearchResource
  • /search
  • /search/products
  • /search/{id}
  • POST
  • GET
  • GET POST
An API for searching the whole catalogue (Rolling Archive and LTA) for product.
SensorResource
  • /sensors/satellites
  • GET
An API for retrieving the current list of satellites and the sensors they have available.

Data Types

JSON

type description
CancelLTARequestResponse The data received in response to a cancel alert request. No specific information is returned, only an error status and message if an error occurred.
CreateAlertRequest A request object to create an image alert on the SEDAS server. Image alerts enable an account to be notified of new imagery acquired matching a search request. Notifications of new imagery will be sent to your SEDAS registered email address.
CreateAlertResponse The data received in response to a create alert request. Returns the id of the image alert, to be used for other requests such as cancelling the alert.
CreateLTAResponse The data received in response to a create LTA request. Returns the current status (always requested) and the id of the request. The id can be used in other requests, such as cancelling the LTA request or checking the status of the request.
Credentials The credentials used for authentication. User name and password correspond to your SEDAS user credentials.
ImageAlert A request object to create an image alert on the SEDAS server. With image alerts you will be notified of new imagery acquired matching the search request parameters. Notifications are sent to your user's email address.
ImageAlertsResponse The data received in response to list alerts call on SEDAS API. Provides the user's current image alerts.
Instrument A satellite instrument.
LTARequest A Long Term Archive (LTA) request. Provides information such as status, id, download url and available until date.
Mode An instrument mode.
OPTTYPE An optical Product Type (ALL, L1C, L2A).
ORBITDIR The orbit direction (ALL, ASCENDING, DESCENDING).
ORBITDIRECTION The direction of the orbit
POLARISATION The polarisation (ALL, HH, VV, HV, VH, HH_HV, VV_VH).
Product An image scene as returned by a search.
ProductFilters A set of additional search constraints. These constraints are applied at run time when searching for suitable scenes, in addition to the sensor, AoI and period of interest. In the case of an optical search it is not necessary to set the SAR filters and viceversa. In the case of both optical and SAR search, any filter can be set or leave it as blank.
RemoveAlertResponse The data received in response to a remove alert request. It does not contain information, only an error message and status if an error occurred.
SARTYPE Synthetic-aperture radar (SAR) is a form of radar that is used to create two- or three-dimensional images of objects, such as landscapes. Possible values (ALL, SLC, GRD, OCN).
SENSOR_TYPE Sensor Type (All, Optical, SAR).
STATUS A LTA Request status.
Satellite A satellite.
SearchRequest Represents a search request with the various search fields allowed.
SearchRequestResponse The data received in response to a get search request. Provides the search request values.
SearchResponse The search response returned when submitting a search request.
SensorFilters A filter for selecting sensors.
StatusResponse A standard status response. Subclasses: CancelLTARequestResponse, CreateAlertResponse, CreateLTAResponse, ImageAlertsResponse, LTARequest, RemoveAlertResponse, SearchRequestResponse, SearchResponse
TYPE The type of product
TokenResponse The token returned when authenticating
UserInformation The user information, username.

XML

Default Namespace (schema)
type description
STATUS A LTA Request status.
cancelLTARequestResponse The data received in response to a cancel alert request. No specific information is returned, only an error status and message if an error occurred.
createAlertRequest A request object to create an image alert on the SEDAS server. Image alerts enable an account to be notified of new imagery acquired matching a search request. Notifications of new imagery will be sent to your SEDAS registered email address.
createAlertResponse The data received in response to a create alert request. Returns the id of the image alert, to be used for other requests such as cancelling the alert.
createLTAResponse The data received in response to a create LTA request. Returns the current status (always requested) and the id of the request. The id can be used in other requests, such as cancelling the LTA request or checking the status of the request.
credentials The credentials used for authentication. User name and password correspond to your SEDAS user credentials.
imageAlert A request object to create an image alert on the SEDAS server. With image alerts you will be notified of new imagery acquired matching the search request parameters. Notifications are sent to your user's email address.
imageAlertsResponse The data received in response to list alerts call on SEDAS API. Provides the user's current image alerts.
instrument A satellite instrument.
LTARequest A Long Term Archive (LTA) request. Provides information such as status, id, download url and available until date.
mode An instrument mode.
OPTTYPE An optical Product Type (ALL, L1C, L2A).
ORBITDIR The orbit direction (ALL, ASCENDING, DESCENDING).
POLARISATION The polarisation (ALL, HH, VV, HV, VH, HH_HV, VV_VH).
product An image scene as returned by a search.
ORBITDIRECTION The direction of the orbit
TYPE The type of product
productFilters A set of additional search constraints. These constraints are applied at run time when searching for suitable scenes, in addition to the sensor, AoI and period of interest. In the case of an optical search it is not necessary to set the SAR filters and viceversa. In the case of both optical and SAR search, any filter can be set or leave it as blank.
removeAlertResponse The data received in response to a remove alert request. It does not contain information, only an error message and status if an error occurred.
SARTYPE Synthetic-aperture radar (SAR) is a form of radar that is used to create two- or three-dimensional images of objects, such as landscapes. Possible values (ALL, SLC, GRD, OCN).
SENSOR_TYPE Sensor Type (All, Optical, SAR).
satellite A satellite.
searchRequest Represents a search request with the various search fields allowed.
searchRequestResponse The data received in response to a get search request. Provides the search request values.
searchResponse The search response returned when submitting a search request.
sensorFilters A filter for selecting sensors.
statusResponse A standard status response. Subclasses: CancelLTARequestResponse, CreateAlertResponse, CreateLTAResponse, ImageAlertsResponse, LTARequest, RemoveAlertResponse, SearchRequestResponse, SearchResponse
tokenResponse The token returned when authenticating