Principles of ORaaS API
ORaas is a set of web services for flight dynamics computations based on the open source library Orekit.
In the menu, click on a group to access to the documentation of each web service.
The available services are listed below.
You can get help on how to use a REST API in our start guide.
ORaaS uses configuration data which are published by Orekit. They can be downloaded there. Please note that a delay may be necessary before a new version is taken into account.
Format of the requests
For most of the services, required parameters and algorithm configuration are organized in a single parameter called "json".
JSON is a way to structure objects in sets of key/values pairs. Further details about this format can be found there.
For each request, the JSON schema is documented in a dedicated page where the request object is displayed in two views:
As flight dynamics computations require precise configuration, each field has to be named precisely. To help your when writing your request, ORaaS may generate a skeleton with the name of each parameter. You can get it from the help page.
You can also download the java classes used to parse a request (see our start guide).
Units and formats
The decimal separator for the numbers is the point symbol, the digits are not grouped.
Angles have to be expressed in radians.
Distances have to be expressed in meters.
Azimuth angles origin is the North direction at local point, they are counted clockwise, i.e positive towards the East.
ORaaS expects frames to be designed by their Orekit name. Their list is returned by these dedicated web services: /enums/frame-name, /enums/ecef-frame-name or /enums/eci-frame-name. More information can be found there.
ORaaS demos and tools can help you to choose a frame and get its name: go to the Frame Converter and click the button "..." at the right of the input. A popup is displayed where you select the frame and its available options (IERS date conventions and EOP interpolation).
Orbit determination services
Orbit determination feature allows to estimate orbital parameters by fitting measurements. A request consists in:
As the computation requires several successive iterations, it could take several minutes (depending on your run configuration). That is the reason why the algorithm is run asynchronously by ORaaS.
When a request is received for a New Run, the configuration is checked and an identifier is returned. This id has to be stored and sent, along with your identification key, for any further request concerning the run:
A web socket is available to get feedback as your run progresses. Once connected, you will get messages at the end of each iteration of the orbit determination.
The service Runs List returns the identifiers of the runs existing on ORaaS server which are associated to your key.
Please note that, currently, runs data may be erased from the ORaaS server for maintenance purpose.
List of the ORaaS services