API docs by Redocly

OKAPI API (2024-11 / twentieth-one-man-cannot-summon-the-future)

Download OpenAPI specification:Download

E-mail: contact@okapiorbits.space

API to access the OKAPI SST services

developers

Operations available to developers

Orbit stream

An endpoint to deliver objects to cesium orbit view.

Responses

Response samples

Content type
application/json
{
  • "status": {
    }
}

An endpoint to get tles based on query parameters.

An endpoint to get tles based on query parameters.

query Parameters
page
integer >= 1
Default: 1

Page number

limit
integer [ 1 .. 10000 ]
Default: 1000

Number of records per page

originator
string
Enum: "18 SPCS" "EON" "OKAPI:ORBITS" "18 spcs" "eon" "OKAPI:Orbits"

Originator name

format
string
Default: "JSON"
Enum: "JSON" "BATCH" "json" "batch"

Output format either in batch or json format

latest
boolean
Default: false

A boolean which indicates whether all or the latest tles are queried

start
string <date-time> (IsoDateTime) ^([1-9][0-9]{3})-((01|03|05|07|08|10|12)-(0[1...
Example: start=2014-12-31T23:59:59.124Z

Earliest CREATION_DATE

stop
string <date-time> (IsoDateTime) ^([1-9][0-9]{3})-((01|03|05|07|08|10|12)-(0[1...
Example: stop=2014-12-31T23:59:59.124Z

Latest CREATION_DATE

norad_id
integer <int32> (NoradId)

NORAD_CAT_ID filter

cospar_id
string

The cospar_id filter from which the norad_id filter can be derived

orbit_type
string
Enum: "GEO" "geo" "IGO" "igo" "EGO" "ego" "NSO" "nso" "GTO" "gto" "MEO" "meo" "GHO" "gho" "LEO" "leo" "HAO" "hao" "MGO" "mgo" "HEO" "heo"

GEO: Geostationary Orbit| IGO: Inclined Geosynchronous Orbit| EGO: Extended Geostationary Orbit| NSO: Navigation Satellites Orbit| GTO: GEO Transfer Orbit| MEO: Medium Earth Orbit| GHO: GEO-superGEO Crossing Orbits| LEO: Low Earth Orbit| HAO: High Altitude Earth Orbit| MGO: MEO-GEO Crossing Orbits| HEO: Highly Eccentric Earth Orbit

object

inclination filter

object

period filter

object

eccentricity filter

object

periapsis filter

object

apoapsis filter

object

semimajoraxis filter

Responses

Response samples

Content type
application/json
Example
{
  • "object": "list",
  • "elements": [
    ]
}

Check the status of the API

A simple endpoint to check if the API is up and running.

Responses

Response samples

Content type
application/json
{
  • "status": {
    }
}

Check the status of the API

A simple endpoint to check if the API is up and running.

Responses

Response samples

Content type
application/json
{
  • "ok": "string"
}

Get own satellites

Get own satellites from the collection in the platform.

query Parameters
sandbox
boolean

Enable or disable sandbox responses.

page
integer [ 1 .. 2147483647 ]
Default: 1

Page number

limit
integer [ 1 .. 10000 ]
Default: 20

Number of records per page

Responses

Response samples

Content type
application/json
{
  • "elements": [
    ]
}

Add a satellite

Add a satellite to the collection in the platform.

query Parameters
sandbox
boolean

Enable or disable sandbox responses.

Request Body schema: application/json

Satellite to add

satellite_id
required
string (Uuid) ^[a-f0-9]{8}(-[a-f0-9]{4}){4}[a-f0-9]{8}$

A Universally-Unique Identifier, as used by OKAPI:Orbits

name
required
string

Name of this satellite or the class of satellites this satellite functions as representative

info
string <= 512 characters

Space for detailed information or notes about this satellite.

norad_ids
required
Array of integers non-empty [ items [ 1 .. 999999999 ] ]

NORAD IDs of satellites this satellite definition stands for. If only one satellite is defined, this array contains the NORAD ID of that satellite.

area
number <double> [ 0 .. 1000 ]
Default: 0.01

The satellite's collision cross section, in m^2

drag_area
number <double> [ 0 .. 1000 ]

The satellite's drag area, in m^2

mass
number <double> [ 0 .. 100000 ]
Default: 1.3

in kg

thrust_uncertainty
number <double> >= 0
Default: 0

Relative thrust uncertainty / - e.g. 5 percent is expressed as 0.05

thrust_pointing_uncertainty
number <double> [ 0 .. 5400 ]
Default: 0

Uncertainty in pointing the thrust / arc seconds

thrust_output
number <double> >= 0
Default: 0

Thrust output, in Newton. Note that you can enter values like 1.1e-8 or 0.0001

max_thrust_duration
number <double> >= 0
Default: 1

The maximum duration the thruster can operate at a time in Seconds

min_thrust_duration
number <double> >= 0

The minimum duration the thruster can operate at a time in Seconds

thrust_duration_step_size
number <float> >= 1e-8

The smallest increment of the thrust duration value, that the thrust duration must be rounded to. The user can opt for this to take care of their thrust unit's resolution.

in_sun_constraint
boolean
Default: false

Enables the requirement of a satellite being in the Sun during thruster activation. If symmetric manoeuvres are enabled, as well, symmetric manoeuvres are not created.

min_time_in_sun
number <double> >= 0

Makes sure that the generated manoeuvre will be performed after the satellite being in the Sun for a minimum amount of time (in Seconds).

min_time_until_eclipse
number <double> >= 0

The minimum time between a maneuver ignition and the start of eclipse, in seconds

constrain_entire_maneuver
boolean
Default: false

Constrain the entire maneuver to occur within the admissible time region when the sunlit or maneuver window constraints are defined. If false, only the maneuver start time will be constrained.

symmetric_manoeuvres
boolean
Default: false

Enables to distribute the thrust on opposite sides of the orbits, e.g. to keep the eccentricity constant. If the in-sun constraint is enabled, as well, symmetric manoeuvres are not created.

use_ground_station_passes
boolean

Enables to use ground station passes and calculate maneuvers to provide enough time for situation assessment and maneuver generationn till next planned ground station pass.

use_offset_cdm_and_earliest_maneuver
boolean
Default: true

Enables use of the parameter for offset between cdm insertion epoch and earliest maneuver epoch.

offset_cdm_and_earliest_maneuver
number <double> >= 0
Default: 25200

Time offset between CDM insertion epoch and earliest possible epoch for CAM (in seconds).

use_min_time_till_pass
boolean

Enables use of the parameter to consider minimum time between cdm insertion epoch and next ground station pass.

min_time_till_pass
number >= 0
Default: 3600

Minimum time required between CDM insertion epoch and the upcoming ground station pass (in seconds).

propulsion_type
string
Default: "continuous"
Enum: "impulsive" "continuous"
enable_accepted_collision_probability_limit_recommendation
boolean
Default: true

Enable the use of accepted collision probability limit

accepted_collision_probability
number [ 0 .. 1 ]
Default: 0.0001

Accepted collision probability

enable_miss_distance_recommendation
boolean
Default: true

Enable the use of miss distance

accepted_minimum_distance
number [ 0 .. 500 ]
Default: 1

Accepted minimum distance, in km

use_ai_risk_prediction
boolean
Default: false

Use OKAPI AI for risk prediction

space_track_status
required
string
Enum: "sharing_agreement_signed" "satellite_registered" "space_track_account_exists" "no_space_track_account" "dont_know" "other"

Please state your current relationship with SpaceTrack / 18 SPCS concerning this satellite

space_track_status_other
string

If you select "other" for "space_track_status", describe your current relationship here

space_track_company_name
string

If you select "sharing_agreement_signed", "satellite_registered" or "space_track_account_exists" for "space_track_status", state the company name used at SpaceTrack here. By default, this is the company name you are using at OKAPI.

space_track_poc_name
string

If you select "sharing_agreement_signed", "satellite_registered" or "space_track_account_exists" for "space_track_status", state the Point-of-Contact name used at SpaceTrack here. By default, this is the address you are using at OKAPI.

space_track_poc_address
string

If you select "sharing_agreement_signed", "satellite_registered" or "space_track_account_exists" for "space_track_status", state the Point-of-Contact address used at SpaceTrack here. By default, this is the address you are using at OKAPI.

space_track_login
string <email>

If you select "sharing_agreement_signed", "satellite_registered" or "space_track_account_exists" for "space_track_status", state the login used at SpaceTrack here. By default, this is the mail address you are using at OKAPI.

active
boolean
Default: false

Active status of this satellite. Indicates if screening is currently activated for this satellite definition. Is set automatically by OKAPI. Immutable by clients.

maneuver_strategy
Array of strings
Default: ["short_term","long_term"]
Items Enum: "long_term" "short_term" "drag"

Preferred collision avoidance maneuver strategy for this satellite

send_mail_notifications
boolean
Default: false

Send notifications to email address associated with the satellite

send_slack_notifications
boolean
Default: false

Send notifications to Slack. Webhook needs to be provided separately

send_teams_notifications
boolean
Default: false

Send notifications to Teams. Webhook needs to be provided separately

slack_webhook
string

URL of the Slack webhook

teams_webhook
string

URL of the Teams webhook

teams_workflow
string

URL of the Teams workflow

object (GnssSensor)

A GNSS sensor of a satellite, including settings on orbit determination and propagation

notification_verbosity
string
Default: "observe"
Enum: "observe" "critical"

If notifications are activated for this satellite, defines how critical a conjunction must be at the very least to be notified about it.

object (DragManeuverSettings)

DragManeuverSettings

max_semi_major_axis_increase
number >= 0.0001

The maximum acceptable increase to the orbit semi-major-axis, in km

max_semi_major_axis_decrease
number <= -0.0001

The maximum acceptable decrease to the orbit semi-major-axis, in km

max_firings
integer >= 1

The maximum number of propulsive maneuver ignitions

hbr_model_id
string

Reference UUID of the document in the hbr_models collection. Should be of type UUID when custom serializers/deserializers are used for satellites

maneuver_direction
Array of strings (ManeuverDirectionSetting)
Default: ["auto"]
Items Enum: "auto" "prograde" "retrograde"

The thrust direction

use_hbr_lookup_table
boolean
Default: false

Flag to use hard-body radius lookup table resulting from a given attitude of the body. It stores HBR values for different azimuth/elevation pairs.

covariance_table_id
string (Uuid) ^[a-f0-9]{8}(-[a-f0-9]{4}){4}[a-f0-9]{8}$

A Universally-Unique Identifier, as used by OKAPI:Orbits

object (SatelliteNeighborhood)

Neighborhood for satellite

target_sma
number >= 6478

The desired orbit semi-major-axis [km]

target_inclination
number >= 0

The desired orbit inclination [deg]

max_delta_radial
number >= 0

The maximum radial deviation from the nominal trajectory, assessed up to the TCA offset epoch [km]

max_delta_along_track
number >= 0

The maximum along-track deviation from the nominal trajectory, in km, assessed up to the TCA offset epoch

max_delta_cross_track
number >= 0

The maximum cross-track deviation from the nominal trajectory, assessed up to the TCA offset epoch [km]

ground_track_time_offset
number >= 0

The desired time offset for the ground-track station keeping from TCA to TCA + dt

control_box_time_offset
number >= 0

The desired time offset for the control-box station keeping from TCA to TCA + dt

Responses

Request samples

Content type
application/json
{
  • "satellite_id": "550e8400-e29b-11d4-a716-446655440000",
  • "name": "Sputnik Test Group",
  • "info": "One satellite to rule them all, one satellite to find them; One satellite to bring them all and in the space bind them.",
  • "norad_ids": [
    ],
  • "area": 0.01,
  • "drag_area": 0.01,
  • "mass": 1.3,
  • "thrust_uncertainty": 0.01,
  • "thrust_pointing_uncertainty": 120,
  • "thrust_output": 1.1e-8,
  • "max_thrust_duration": 600,
  • "min_thrust_duration": 1,
  • "thrust_duration_step_size": 2,
  • "in_sun_constraint": true,
  • "min_time_in_sun": 900,
  • "min_time_until_eclipse": 600,
  • "constrain_entire_maneuver": true,
  • "symmetric_manoeuvres": false,
  • "use_ground_station_passes": false,
  • "use_offset_cdm_and_earliest_maneuver": true,
  • "offset_cdm_and_earliest_maneuver": 25200,
  • "use_min_time_till_pass": true,
  • "min_time_till_pass": 900,
  • "propulsion_type": "continuous",
  • "enable_accepted_collision_probability_limit_recommendation": true,
  • "accepted_collision_probability": 0.0001,
  • "enable_miss_distance_recommendation": true,
  • "accepted_minimum_distance": 0.5,
  • "use_ai_risk_prediction": false,
  • "space_track_status": "satellite_registered",
  • "space_track_status_other": "string",
  • "space_track_company_name": "OKAPI:Orbits GmbH",
  • "space_track_poc_name": "Max Musterman",
  • "space_track_poc_address": "Examplestreet 32, 34562 Examplecity, Germany",
  • "space_track_login": "example@someprovider.com",
  • "active": true,
  • "maneuver_strategy": [
    ],
  • "send_mail_notifications": true,
  • "send_slack_notifications": false,
  • "send_teams_notifications": true,
  • "slack_webhook": "https://hooks.slack.com/services/REST-OF-URL",
  • "teams_webhook": "https://outlook.office.com/webhook/REST-OF-URL",
  • "teams_workflow": "https://outlook.office.com/webhook/REST-OF-URL",
  • "gnss_sensor": {
    },
  • "notification_verbosity": "observe",
  • "drag_maneuver_settings": {
    },
  • "max_semi_major_axis_increase": 0.1,
  • "max_semi_major_axis_decrease": -0.1,
  • "max_firings": 5,
  • "hbr_model_id": "string",
  • "maneuver_direction": [
    ],
  • "use_hbr_lookup_table": true,
  • "covariance_table_id": "550e8400-e29b-11d4-a716-446655440000",
  • "neighborhood": {
    },
  • "target_sma": 6478,
  • "target_inclination": 0,
  • "max_delta_radial": 0,
  • "max_delta_along_track": 0,
  • "max_delta_cross_track": 0,
  • "ground_track_time_offset": 0,
  • "control_box_time_offset": 0
}

Response samples

Content type
application/json
{
  • "satellite_id": "550e8400-e29b-11d4-a716-446655440000",
  • "name": "Sputnik Test Group",
  • "info": "One satellite to rule them all, one satellite to find them; One satellite to bring them all and in the space bind them.",
  • "norad_ids": [
    ],
  • "area": 0.01,
  • "drag_area": 0.01,
  • "mass": 1.3,
  • "thrust_uncertainty": 0.01,
  • "thrust_pointing_uncertainty": 120,
  • "thrust_output": 1.1e-8,
  • "max_thrust_duration": 600,
  • "min_thrust_duration": 1,
  • "thrust_duration_step_size": 2,
  • "in_sun_constraint": true,
  • "min_time_in_sun": 900,
  • "min_time_until_eclipse": 600,
  • "constrain_entire_maneuver": true,
  • "symmetric_manoeuvres": false,
  • "use_ground_station_passes": false,
  • "use_offset_cdm_and_earliest_maneuver": true,
  • "offset_cdm_and_earliest_maneuver": 25200,
  • "use_min_time_till_pass": true,
  • "min_time_till_pass": 900,
  • "propulsion_type": "continuous",
  • "enable_accepted_collision_probability_limit_recommendation": true,
  • "accepted_collision_probability": 0.0001,
  • "enable_miss_distance_recommendation": true,
  • "accepted_minimum_distance": 0.5,
  • "use_ai_risk_prediction": false,
  • "space_track_status": "satellite_registered",
  • "space_track_status_other": "string",
  • "space_track_company_name": "OKAPI:Orbits GmbH",
  • "space_track_poc_name": "Max Musterman",
  • "space_track_poc_address": "Examplestreet 32, 34562 Examplecity, Germany",
  • "space_track_login": "example@someprovider.com",
  • "active": true,
  • "maneuver_strategy": [
    ],
  • "send_mail_notifications": true,
  • "send_slack_notifications": false,
  • "send_teams_notifications": true,
  • "slack_webhook": "https://hooks.slack.com/services/REST-OF-URL",
  • "teams_webhook": "https://outlook.office.com/webhook/REST-OF-URL",
  • "teams_workflow": "https://outlook.office.com/webhook/REST-OF-URL",
  • "gnss_sensor": {
    },
  • "notification_verbosity": "observe",
  • "drag_maneuver_settings": {
    },
  • "max_semi_major_axis_increase": 0.1,
  • "max_semi_major_axis_decrease": -0.1,
  • "max_firings": 5,
  • "hbr_model_id": "string",
  • "maneuver_direction": [
    ],
  • "use_hbr_lookup_table": true,
  • "covariance_table_id": "550e8400-e29b-11d4-a716-446655440000",
  • "neighborhood": {
    },
  • "target_sma": 6478,
  • "target_inclination": 0,
  • "max_delta_radial": 0,
  • "max_delta_along_track": 0,
  • "max_delta_cross_track": 0,
  • "ground_track_time_offset": 0,
  • "control_box_time_offset": 0
}

Delete a satellite

Remove a satellite from the collection in the platform.

path Parameters
satellite_id
required
string

ID of satellite

Responses

Response samples

Content type
application/json
{
  • "satellite_id": "550e8400-e29b-11d4-a716-446655440000",
  • "name": "Sputnik Test Group",
  • "info": "One satellite to rule them all, one satellite to find them; One satellite to bring them all and in the space bind them.",
  • "norad_ids": [
    ],
  • "area": 0.01,
  • "drag_area": 0.01,
  • "mass": 1.3,
  • "thrust_uncertainty": 0.01,
  • "thrust_pointing_uncertainty": 120,
  • "thrust_output": 1.1e-8,
  • "max_thrust_duration": 600,
  • "min_thrust_duration": 1,
  • "thrust_duration_step_size": 2,
  • "in_sun_constraint": true,
  • "min_time_in_sun": 900,
  • "min_time_until_eclipse": 600,
  • "constrain_entire_maneuver": true,
  • "symmetric_manoeuvres": false,
  • "use_ground_station_passes": false,
  • "use_offset_cdm_and_earliest_maneuver": true,
  • "offset_cdm_and_earliest_maneuver": 25200,
  • "use_min_time_till_pass": true,
  • "min_time_till_pass": 900,
  • "propulsion_type": "continuous",
  • "enable_accepted_collision_probability_limit_recommendation": true,
  • "accepted_collision_probability": 0.0001,
  • "enable_miss_distance_recommendation": true,
  • "accepted_minimum_distance": 0.5,
  • "use_ai_risk_prediction": false,
  • "space_track_status": "satellite_registered",
  • "space_track_status_other": "string",
  • "space_track_company_name": "OKAPI:Orbits GmbH",
  • "space_track_poc_name": "Max Musterman",
  • "space_track_poc_address": "Examplestreet 32, 34562 Examplecity, Germany",
  • "space_track_login": "example@someprovider.com",
  • "active": true,
  • "maneuver_strategy": [
    ],
  • "send_mail_notifications": true,
  • "send_slack_notifications": false,
  • "send_teams_notifications": true,
  • "slack_webhook": "https://hooks.slack.com/services/REST-OF-URL",
  • "teams_webhook": "https://outlook.office.com/webhook/REST-OF-URL",
  • "teams_workflow": "https://outlook.office.com/webhook/REST-OF-URL",
  • "gnss_sensor": {
    },
  • "notification_verbosity": "observe",
  • "drag_maneuver_settings": {
    },
  • "max_semi_major_axis_increase": 0.1,
  • "max_semi_major_axis_decrease": -0.1,
  • "max_firings": 5,
  • "hbr_model_id": "string",
  • "maneuver_direction": [
    ],
  • "use_hbr_lookup_table": true,
  • "covariance_table_id": "550e8400-e29b-11d4-a716-446655440000",
  • "neighborhood": {
    },
  • "target_sma": 6478,
  • "target_inclination": 0,
  • "max_delta_radial": 0,
  • "max_delta_along_track": 0,
  • "max_delta_cross_track": 0,
  • "ground_track_time_offset": 0,
  • "control_box_time_offset": 0
}

Replace/change a satellite

Replace/change a satellite in the collection of the platform.

path Parameters
satellite_id
required
string

ID of satellite

Request Body schema: application/json

Satellite to replace the current one with.

satellite_id
required
string (Uuid) ^[a-f0-9]{8}(-[a-f0-9]{4}){4}[a-f0-9]{8}$

A Universally-Unique Identifier, as used by OKAPI:Orbits

name
required
string

Name of this satellite or the class of satellites this satellite functions as representative

info
string <= 512 characters

Space for detailed information or notes about this satellite.

norad_ids
required
Array of integers non-empty [ items [ 1 .. 999999999 ] ]

NORAD IDs of satellites this satellite definition stands for. If only one satellite is defined, this array contains the NORAD ID of that satellite.

area
number <double> [ 0 .. 1000 ]
Default: 0.01

The satellite's collision cross section, in m^2

drag_area
number <double> [ 0 .. 1000 ]

The satellite's drag area, in m^2

mass
number <double> [ 0 .. 100000 ]
Default: 1.3

in kg

thrust_uncertainty
number <double> >= 0
Default: 0

Relative thrust uncertainty / - e.g. 5 percent is expressed as 0.05

thrust_pointing_uncertainty
number <double> [ 0 .. 5400 ]
Default: 0

Uncertainty in pointing the thrust / arc seconds

thrust_output
number <double> >= 0
Default: 0

Thrust output, in Newton. Note that you can enter values like 1.1e-8 or 0.0001

max_thrust_duration
number <double> >= 0
Default: 1

The maximum duration the thruster can operate at a time in Seconds

min_thrust_duration
number <double> >= 0

The minimum duration the thruster can operate at a time in Seconds

thrust_duration_step_size
number <float> >= 1e-8

The smallest increment of the thrust duration value, that the thrust duration must be rounded to. The user can opt for this to take care of their thrust unit's resolution.

in_sun_constraint
boolean
Default: false

Enables the requirement of a satellite being in the Sun during thruster activation. If symmetric manoeuvres are enabled, as well, symmetric manoeuvres are not created.

min_time_in_sun
number <double> >= 0

Makes sure that the generated manoeuvre will be performed after the satellite being in the Sun for a minimum amount of time (in Seconds).

min_time_until_eclipse
number <double> >= 0

The minimum time between a maneuver ignition and the start of eclipse, in seconds

constrain_entire_maneuver
boolean
Default: false

Constrain the entire maneuver to occur within the admissible time region when the sunlit or maneuver window constraints are defined. If false, only the maneuver start time will be constrained.

symmetric_manoeuvres
boolean
Default: false

Enables to distribute the thrust on opposite sides of the orbits, e.g. to keep the eccentricity constant. If the in-sun constraint is enabled, as well, symmetric manoeuvres are not created.

use_ground_station_passes
boolean

Enables to use ground station passes and calculate maneuvers to provide enough time for situation assessment and maneuver generationn till next planned ground station pass.

use_offset_cdm_and_earliest_maneuver
boolean
Default: true

Enables use of the parameter for offset between cdm insertion epoch and earliest maneuver epoch.

offset_cdm_and_earliest_maneuver
number <double> >= 0
Default: 25200

Time offset between CDM insertion epoch and earliest possible epoch for CAM (in seconds).

use_min_time_till_pass
boolean

Enables use of the parameter to consider minimum time between cdm insertion epoch and next ground station pass.

min_time_till_pass
number >= 0
Default: 3600

Minimum time required between CDM insertion epoch and the upcoming ground station pass (in seconds).

propulsion_type
string
Default: "continuous"
Enum: "impulsive" "continuous"
enable_accepted_collision_probability_limit_recommendation
boolean
Default: true

Enable the use of accepted collision probability limit

accepted_collision_probability
number [ 0 .. 1 ]
Default: 0.0001

Accepted collision probability

enable_miss_distance_recommendation
boolean
Default: true

Enable the use of miss distance

accepted_minimum_distance
number [ 0 .. 500 ]
Default: 1

Accepted minimum distance, in km

use_ai_risk_prediction
boolean
Default: false

Use OKAPI AI for risk prediction

space_track_status
required
string
Enum: "sharing_agreement_signed" "satellite_registered" "space_track_account_exists" "no_space_track_account" "dont_know" "other"

Please state your current relationship with SpaceTrack / 18 SPCS concerning this satellite

space_track_status_other
string

If you select "other" for "space_track_status", describe your current relationship here

space_track_company_name
string

If you select "sharing_agreement_signed", "satellite_registered" or "space_track_account_exists" for "space_track_status", state the company name used at SpaceTrack here. By default, this is the company name you are using at OKAPI.

space_track_poc_name
string

If you select "sharing_agreement_signed", "satellite_registered" or "space_track_account_exists" for "space_track_status", state the Point-of-Contact name used at SpaceTrack here. By default, this is the address you are using at OKAPI.

space_track_poc_address
string

If you select "sharing_agreement_signed", "satellite_registered" or "space_track_account_exists" for "space_track_status", state the Point-of-Contact address used at SpaceTrack here. By default, this is the address you are using at OKAPI.

space_track_login
string <email>

If you select "sharing_agreement_signed", "satellite_registered" or "space_track_account_exists" for "space_track_status", state the login used at SpaceTrack here. By default, this is the mail address you are using at OKAPI.

active
boolean
Default: false

Active status of this satellite. Indicates if screening is currently activated for this satellite definition. Is set automatically by OKAPI. Immutable by clients.

maneuver_strategy
Array of strings
Default: ["short_term","long_term"]
Items Enum: "long_term" "short_term" "drag"

Preferred collision avoidance maneuver strategy for this satellite

send_mail_notifications
boolean
Default: false

Send notifications to email address associated with the satellite

send_slack_notifications
boolean
Default: false

Send notifications to Slack. Webhook needs to be provided separately

send_teams_notifications
boolean
Default: false

Send notifications to Teams. Webhook needs to be provided separately

slack_webhook
string

URL of the Slack webhook

teams_webhook
string

URL of the Teams webhook

teams_workflow
string

URL of the Teams workflow

object (GnssSensor)

A GNSS sensor of a satellite, including settings on orbit determination and propagation

notification_verbosity
string
Default: "observe"
Enum: "observe" "critical"

If notifications are activated for this satellite, defines how critical a conjunction must be at the very least to be notified about it.

object (DragManeuverSettings)

DragManeuverSettings

max_semi_major_axis_increase
number >= 0.0001

The maximum acceptable increase to the orbit semi-major-axis, in km

max_semi_major_axis_decrease
number <= -0.0001

The maximum acceptable decrease to the orbit semi-major-axis, in km

max_firings
integer >= 1

The maximum number of propulsive maneuver ignitions

hbr_model_id
string

Reference UUID of the document in the hbr_models collection. Should be of type UUID when custom serializers/deserializers are used for satellites

maneuver_direction
Array of strings (ManeuverDirectionSetting)
Default: ["auto"]
Items Enum: "auto" "prograde" "retrograde"

The thrust direction

use_hbr_lookup_table
boolean
Default: false

Flag to use hard-body radius lookup table resulting from a given attitude of the body. It stores HBR values for different azimuth/elevation pairs.

covariance_table_id
string (Uuid) ^[a-f0-9]{8}(-[a-f0-9]{4}){4}[a-f0-9]{8}$

A Universally-Unique Identifier, as used by OKAPI:Orbits

object (SatelliteNeighborhood)

Neighborhood for satellite

target_sma
number >= 6478

The desired orbit semi-major-axis [km]

target_inclination
number >= 0

The desired orbit inclination [deg]

max_delta_radial
number >= 0

The maximum radial deviation from the nominal trajectory, assessed up to the TCA offset epoch [km]

max_delta_along_track
number >= 0

The maximum along-track deviation from the nominal trajectory, in km, assessed up to the TCA offset epoch

max_delta_cross_track
number >= 0

The maximum cross-track deviation from the nominal trajectory, assessed up to the TCA offset epoch [km]

ground_track_time_offset
number >= 0

The desired time offset for the ground-track station keeping from TCA to TCA + dt

control_box_time_offset
number >= 0

The desired time offset for the control-box station keeping from TCA to TCA + dt

Responses

Request samples

Content type
application/json
{
  • "satellite_id": "550e8400-e29b-11d4-a716-446655440000",
  • "name": "Sputnik Test Group",
  • "info": "One satellite to rule them all, one satellite to find them; One satellite to bring them all and in the space bind them.",
  • "norad_ids": [
    ],
  • "area": 0.01,
  • "drag_area": 0.01,
  • "mass": 1.3,
  • "thrust_uncertainty": 0.01,
  • "thrust_pointing_uncertainty": 120,
  • "thrust_output": 1.1e-8,
  • "max_thrust_duration": 600,
  • "min_thrust_duration": 1,
  • "thrust_duration_step_size": 2,
  • "in_sun_constraint": true,
  • "min_time_in_sun": 900,
  • "min_time_until_eclipse": 600,
  • "constrain_entire_maneuver": true,
  • "symmetric_manoeuvres": false,
  • "use_ground_station_passes": false,
  • "use_offset_cdm_and_earliest_maneuver": true,
  • "offset_cdm_and_earliest_maneuver": 25200,
  • "use_min_time_till_pass": true,
  • "min_time_till_pass": 900,
  • "propulsion_type": "continuous",
  • "enable_accepted_collision_probability_limit_recommendation": true,
  • "accepted_collision_probability": 0.0001,
  • "enable_miss_distance_recommendation": true,
  • "accepted_minimum_distance": 0.5,
  • "use_ai_risk_prediction": false,
  • "space_track_status": "satellite_registered",
  • "space_track_status_other": "string",
  • "space_track_company_name": "OKAPI:Orbits GmbH",
  • "space_track_poc_name": "Max Musterman",
  • "space_track_poc_address": "Examplestreet 32, 34562 Examplecity, Germany",
  • "space_track_login": "example@someprovider.com",
  • "active": true,
  • "maneuver_strategy": [
    ],
  • "send_mail_notifications": true,
  • "send_slack_notifications": false,
  • "send_teams_notifications": true,
  • "slack_webhook": "https://hooks.slack.com/services/REST-OF-URL",
  • "teams_webhook": "https://outlook.office.com/webhook/REST-OF-URL",
  • "teams_workflow": "https://outlook.office.com/webhook/REST-OF-URL",
  • "gnss_sensor": {
    },
  • "notification_verbosity": "observe",
  • "drag_maneuver_settings": {
    },
  • "max_semi_major_axis_increase": 0.1,
  • "max_semi_major_axis_decrease": -0.1,
  • "max_firings": 5,
  • "hbr_model_id": "string",
  • "maneuver_direction": [
    ],
  • "use_hbr_lookup_table": true,
  • "covariance_table_id": "550e8400-e29b-11d4-a716-446655440000",
  • "neighborhood": {
    },
  • "target_sma": 6478,
  • "target_inclination": 0,
  • "max_delta_radial": 0,
  • "max_delta_along_track": 0,
  • "max_delta_cross_track": 0,
  • "ground_track_time_offset": 0,
  • "control_box_time_offset": 0
}

Response samples

Content type
application/json
{
  • "satellite_id": "550e8400-e29b-11d4-a716-446655440000",
  • "name": "Sputnik Test Group",
  • "info": "One satellite to rule them all, one satellite to find them; One satellite to bring them all and in the space bind them.",
  • "norad_ids": [
    ],
  • "area": 0.01,
  • "drag_area": 0.01,
  • "mass": 1.3,
  • "thrust_uncertainty": 0.01,
  • "thrust_pointing_uncertainty": 120,
  • "thrust_output": 1.1e-8,
  • "max_thrust_duration": 600,
  • "min_thrust_duration": 1,
  • "thrust_duration_step_size": 2,
  • "in_sun_constraint": true,
  • "min_time_in_sun": 900,
  • "min_time_until_eclipse": 600,
  • "constrain_entire_maneuver": true,
  • "symmetric_manoeuvres": false,
  • "use_ground_station_passes": false,
  • "use_offset_cdm_and_earliest_maneuver": true,
  • "offset_cdm_and_earliest_maneuver": 25200,
  • "use_min_time_till_pass": true,
  • "min_time_till_pass": 900,
  • "propulsion_type": "continuous",
  • "enable_accepted_collision_probability_limit_recommendation": true,
  • "accepted_collision_probability": 0.0001,
  • "enable_miss_distance_recommendation": true,
  • "accepted_minimum_distance": 0.5,
  • "use_ai_risk_prediction": false,
  • "space_track_status": "satellite_registered",
  • "space_track_status_other": "string",
  • "space_track_company_name": "OKAPI:Orbits GmbH",
  • "space_track_poc_name": "Max Musterman",
  • "space_track_poc_address": "Examplestreet 32, 34562 Examplecity, Germany",
  • "space_track_login": "example@someprovider.com",
  • "active": true,
  • "maneuver_strategy": [
    ],
  • "send_mail_notifications": true,
  • "send_slack_notifications": false,
  • "send_teams_notifications": true,
  • "slack_webhook": "https://hooks.slack.com/services/REST-OF-URL",
  • "teams_webhook": "https://outlook.office.com/webhook/REST-OF-URL",
  • "teams_workflow": "https://outlook.office.com/webhook/REST-OF-URL",
  • "gnss_sensor": {
    },
  • "notification_verbosity": "observe",
  • "drag_maneuver_settings": {
    },
  • "max_semi_major_axis_increase": 0.1,
  • "max_semi_major_axis_decrease": -0.1,
  • "max_firings": 5,
  • "hbr_model_id": "string",
  • "maneuver_direction": [
    ],
  • "use_hbr_lookup_table": true,
  • "covariance_table_id": "550e8400-e29b-11d4-a716-446655440000",
  • "neighborhood": {
    },
  • "target_sma": 6478,
  • "target_inclination": 0,
  • "max_delta_radial": 0,
  • "max_delta_along_track": 0,
  • "max_delta_cross_track": 0,
  • "ground_track_time_offset": 0,
  • "control_box_time_offset": 0
}

Update a satellite

Update settings of a satellite in the collection of the platform.

path Parameters
satellite_id
required
string

ID of satellite

Request Body schema: application/json

Satellite to update.

satellite_id
string (Uuid) ^[a-f0-9]{8}(-[a-f0-9]{4}){4}[a-f0-9]{8}$

A Universally-Unique Identifier, as used by OKAPI:Orbits

name
string

Name of this satellite or the class of satellites this satellite functions as representative

info
string <= 512 characters

Space for detailed information or notes about this satellite.

norad_ids
Array of integers non-empty [ items [ 1 .. 999999999 ] ]

NORAD IDs of satellites this satellite definition stands for. If only one satellite is defined, this array contains the NORAD ID of that satellite.

area
number <double> [ 0 .. 1000 ]

The satellite's collision cross section, in m^2

drag_area
number <double> [ 0 .. 1000 ]

The satellite's drag area, in m^2

mass
number <double> [ 0 .. 100000 ]

in kg

thrust_uncertainty
number <double> >= 0

Relative thrust uncertainty / - e.g. 5 percent is expressed as 0.05

thrust_pointing_uncertainty
number <double> [ 0 .. 5400 ]

Uncertainty in pointing the thrust / arc seconds

thrust_output
number <double> >= 0

Thrust output, in Newton. Note that you can enter values like 1.1e-8 or 0.0001

max_thrust_duration
number <double> >= 0

The maximum duration the thruster can operate at a time in Seconds

min_thrust_duration
number <double> >= 0

The minimum duration the thruster can operate at a time in Seconds

in_sun_constraint
boolean

Enables the requirement of a satellite being in the Sun during thruster activation. If symmetric manoeuvres are enabled, as well, symmetric manoeuvres are not created.

min_time_in_sun
number <double> >= 0

Makes sure that the generated manoeuvre will be performed after the satellite being in the Sun for a minimum amount of time (in Seconds).

symmetric_manoeuvres
boolean

Enables to distribute the thrust on opposite sides of the orbits, e.g. to keep the eccentricity constant. If the in-sun constraint is enabled, as well, symmetric manoeuvres are not created.

use_ground_station_passes
boolean

Enables to use ground station passes and calculate maneuvers to provide enough time for situation assessment and maneuver generationn till next planned ground station pass.

use_offset_cdm_and_earliest_maneuver
boolean

Enables use of the parameter for offset between cdm insertion epoch and earliest maneuver epoch.

offset_cdm_and_earliest_maneuver
number <double> >= 0

Time offset between CDM insertion epoch and earliest possible epoch for CAM (in seconds).

use_min_time_till_pass
boolean

Enables use of the parameter to consider minimum time between cdm insertion epoch and next ground station pass.

min_time_till_pass
number >= 0

Minimum time required between CDM insertion epoch and the upcoming ground station pass (in seconds).

propulsion_type
string
Enum: "impulsive" "continuous"
enable_accepted_collision_probability_limit_recommendation
boolean

Enable the use of accepted collision probability limit

accepted_collision_probability
number [ 0 .. 1 ]

Accepted collision probability

enable_miss_distance_recommendation
boolean

Enable the use of miss distance

accepted_minimum_distance
number [ 0 .. 500 ]

Accepted minimum distance, in km

use_ai_risk_prediction
boolean

Use OKAPI AI for risk prediction

space_track_status
string
Enum: "sharing_agreement_signed" "satellite_registered" "space_track_account_exists" "no_space_track_account" "dont_know" "other"

Please state your current relationship with SpaceTrack / 18 SPCS concerning this satellite

space_track_status_other
string

If you select "other" for "space_track_status", describe your current relationship here

space_track_company_name
string

If you select "sharing_agreement_signed", "satellite_registered" or "space_track_account_exists" for "space_track_status", state the company name used at SpaceTrack here. By default, this is the company name you are using at OKAPI.

space_track_poc_name
string

If you select "sharing_agreement_signed", "satellite_registered" or "space_track_account_exists" for "space_track_status", state the Point-of-Contact name used at SpaceTrack here. By default, this is the address you are using at OKAPI.

space_track_poc_address
string

If you select "sharing_agreement_signed", "satellite_registered" or "space_track_account_exists" for "space_track_status", state the Point-of-Contact address used at SpaceTrack here. By default, this is the address you are using at OKAPI.

space_track_login
string <email>

If you select "sharing_agreement_signed", "satellite_registered" or "space_track_account_exists" for "space_track_status", state the login used at SpaceTrack here. By default, this is the mail address you are using at OKAPI.

active
boolean

Active status of this satellite. Indicates if screening is currently activated for this satellite definition. Is set automatically by OKAPI. Immutable by clients.

maneuver_strategy
Array of strings
Items Enum: "long_term" "short_term" "drag"

Preferred collision avoidance maneuver strategy for this satellite

send_mail_notifications
boolean

Send notifications to email address associated with the satellite

send_slack_notifications
boolean

Send notifications to Slack. Webhook needs to be provided separately

send_teams_notifications
boolean

Send notifications to Teams. Webhook needs to be provided separately

slack_webhook
string or null

URL of the Slack webhook

teams_webhook
string or null

URL of the Teams webhook

object (GnssSensor)

A GNSS sensor of a satellite, including settings on orbit determination and propagation

object (DragManeuverSettings)

DragManeuverSettings

notification_verbosity
string
Enum: "observe" "critical"

If notifications are activated for this satellite, defines how critical a conjunction must be at the very least to be notified about it.

maneuver_direction
Array of strings (ManeuverDirectionSetting)
Items Enum: "auto" "prograde" "retrograde"

The thrust direction

object (SatelliteNeighborhood)

Neighborhood for satellite

Responses

Request samples

Content type
application/json
{
  • "satellite_id": "550e8400-e29b-11d4-a716-446655440000",
  • "name": "Sputnik Test Group",
  • "info": "One satellite to rule them all, one satellite to find them; One satellite to bring them all and in the space bind them.",
  • "norad_ids": [
    ],
  • "area": 0.01,
  • "drag_area": 0.01,
  • "mass": 1.3,
  • "thrust_uncertainty": 0.01,
  • "thrust_pointing_uncertainty": 120,
  • "thrust_output": 1.1e-8,
  • "max_thrust_duration": 600,
  • "min_thrust_duration": 1,
  • "in_sun_constraint": true,
  • "min_time_in_sun": 900,
  • "symmetric_manoeuvres": false,
  • "use_ground_station_passes": false,
  • "use_offset_cdm_and_earliest_maneuver": true,
  • "offset_cdm_and_earliest_maneuver": 25200,
  • "use_min_time_till_pass": true,
  • "min_time_till_pass": 900,
  • "propulsion_type": "continuous",
  • "enable_accepted_collision_probability_limit_recommendation": true,
  • "accepted_collision_probability": 0.0001,
  • "enable_miss_distance_recommendation": true,
  • "accepted_minimum_distance": 0.5,
  • "use_ai_risk_prediction": false,
  • "space_track_status": "satellite_registered",
  • "space_track_status_other": "string",
  • "space_track_company_name": "OKAPI:Orbits GmbH",
  • "space_track_poc_name": "Max Musterman",
  • "space_track_poc_address": "Examplestreet 32, 34562 Examplecity, Germany",
  • "space_track_login": "example@someprovider.com",
  • "active": true,
  • "maneuver_strategy": [
    ],
  • "send_mail_notifications": true,
  • "send_slack_notifications": false,
  • "send_teams_notifications": true,
  • "slack_webhook": "https://hooks.slack.com/services/REST-OF-URL",
  • "teams_webhook": "https://outlook.office.com/webhook/REST-OF-URL",
  • "gnss_sensor": {
    },
  • "drag_maneuver_settings": {
    },
  • "notification_verbosity": "observe",
  • "maneuver_direction": [
    ],
  • "neighborhood": {
    }
}

Response samples

Content type
application/json
{
  • "satellite_id": "550e8400-e29b-11d4-a716-446655440000",
  • "name": "Sputnik Test Group",
  • "info": "One satellite to rule them all, one satellite to find them; One satellite to bring them all and in the space bind them.",
  • "norad_ids": [
    ],
  • "area": 0.01,
  • "drag_area": 0.01,
  • "mass": 1.3,
  • "thrust_uncertainty": 0.01,
  • "thrust_pointing_uncertainty": 120,
  • "thrust_output": 1.1e-8,
  • "max_thrust_duration": 600,
  • "min_thrust_duration": 1,
  • "thrust_duration_step_size": 2,
  • "in_sun_constraint": true,
  • "min_time_in_sun": 900,
  • "min_time_until_eclipse": 600,
  • "constrain_entire_maneuver": true,
  • "symmetric_manoeuvres": false,
  • "use_ground_station_passes": false,
  • "use_offset_cdm_and_earliest_maneuver": true,
  • "offset_cdm_and_earliest_maneuver": 25200,
  • "use_min_time_till_pass": true,
  • "min_time_till_pass": 900,
  • "propulsion_type": "continuous",
  • "enable_accepted_collision_probability_limit_recommendation": true,
  • "accepted_collision_probability": 0.0001,
  • "enable_miss_distance_recommendation": true,
  • "accepted_minimum_distance": 0.5,
  • "use_ai_risk_prediction": false,
  • "space_track_status": "satellite_registered",
  • "space_track_status_other": "string",
  • "space_track_company_name": "OKAPI:Orbits GmbH",
  • "space_track_poc_name": "Max Musterman",
  • "space_track_poc_address": "Examplestreet 32, 34562 Examplecity, Germany",
  • "space_track_login": "example@someprovider.com",
  • "active": true,
  • "maneuver_strategy": [
    ],
  • "send_mail_notifications": true,
  • "send_slack_notifications": false,
  • "send_teams_notifications": true,
  • "slack_webhook": "https://hooks.slack.com/services/REST-OF-URL",
  • "teams_webhook": "https://outlook.office.com/webhook/REST-OF-URL",
  • "teams_workflow": "https://outlook.office.com/webhook/REST-OF-URL",
  • "gnss_sensor": {
    },
  • "notification_verbosity": "observe",
  • "drag_maneuver_settings": {
    },
  • "max_semi_major_axis_increase": 0.1,
  • "max_semi_major_axis_decrease": -0.1,
  • "max_firings": 5,
  • "hbr_model_id": "string",
  • "maneuver_direction": [
    ],
  • "use_hbr_lookup_table": true,
  • "covariance_table_id": "550e8400-e29b-11d4-a716-446655440000",
  • "neighborhood": {
    },
  • "target_sma": 6478,
  • "target_inclination": 0,
  • "max_delta_radial": 0,
  • "max_delta_along_track": 0,
  • "max_delta_cross_track": 0,
  • "ground_track_time_offset": 0,
  • "control_box_time_offset": 0
}

Get a specific satellite

Retrieve a specific satellite identified by the id.

path Parameters
satellite_id
required
string

ID of satellite

query Parameters
sandbox
boolean

Enable or disable sandbox responses.

Responses

Response samples

Content type
application/json
{
  • "satellite_id": "550e8400-e29b-11d4-a716-446655440000",
  • "name": "Sputnik Test Group",
  • "info": "One satellite to rule them all, one satellite to find them; One satellite to bring them all and in the space bind them.",
  • "norad_ids": [
    ],
  • "area": 0.01,
  • "drag_area": 0.01,
  • "mass": 1.3,
  • "thrust_uncertainty": 0.01,
  • "thrust_pointing_uncertainty": 120,
  • "thrust_output": 1.1e-8,
  • "max_thrust_duration": 600,
  • "min_thrust_duration": 1,
  • "thrust_duration_step_size": 2,
  • "in_sun_constraint": true,
  • "min_time_in_sun": 900,
  • "min_time_until_eclipse": 600,
  • "constrain_entire_maneuver": true,
  • "symmetric_manoeuvres": false,
  • "use_ground_station_passes": false,
  • "use_offset_cdm_and_earliest_maneuver": true,
  • "offset_cdm_and_earliest_maneuver": 25200,
  • "use_min_time_till_pass": true,
  • "min_time_till_pass": 900,
  • "propulsion_type": "continuous",
  • "enable_accepted_collision_probability_limit_recommendation": true,
  • "accepted_collision_probability": 0.0001,
  • "enable_miss_distance_recommendation": true,
  • "accepted_minimum_distance": 0.5,
  • "use_ai_risk_prediction": false,
  • "space_track_status": "satellite_registered",
  • "space_track_status_other": "string",
  • "space_track_company_name": "OKAPI:Orbits GmbH",
  • "space_track_poc_name": "Max Musterman",
  • "space_track_poc_address": "Examplestreet 32, 34562 Examplecity, Germany",
  • "space_track_login": "example@someprovider.com",
  • "active": true,
  • "maneuver_strategy": [
    ],
  • "send_mail_notifications": true,
  • "send_slack_notifications": false,
  • "send_teams_notifications": true,
  • "slack_webhook": "https://hooks.slack.com/services/REST-OF-URL",
  • "teams_webhook": "https://outlook.office.com/webhook/REST-OF-URL",
  • "teams_workflow": "https://outlook.office.com/webhook/REST-OF-URL",
  • "gnss_sensor": {
    },
  • "notification_verbosity": "observe",
  • "drag_maneuver_settings": {
    },
  • "max_semi_major_axis_increase": 0.1,
  • "max_semi_major_axis_decrease": -0.1,
  • "max_firings": 5,
  • "hbr_model_id": "string",
  • "maneuver_direction": [
    ],
  • "use_hbr_lookup_table": true,
  • "covariance_table_id": "550e8400-e29b-11d4-a716-446655440000",
  • "neighborhood": {
    },
  • "target_sma": 6478,
  • "target_inclination": 0,
  • "max_delta_radial": 0,
  • "max_delta_along_track": 0,
  • "max_delta_cross_track": 0,
  • "ground_track_time_offset": 0,
  • "control_box_time_offset": 0
}

Get oems for satellite

Retrieve OEMS for a specific satellite identified by the id.

path Parameters
satellite_id
required
string

ID of satellite

Responses

Response samples

Content type
application/json
{
  • "elements": [
    ],
  • "has_more": true,
  • "total_count": 0
}

An endpoint to return a list of all neighborhoods that are associated with the requested satellite

An endpoint to return a list of all neighborhoods that are associated with the requested satellite

query Parameters
string or object

A filter for retrieving accessible neighborhoods by TCA

number or object

A filter for retrieving acessible neighborhoods by miss_distance

number or object

A filter for retrieving accessible neighborhoods by miss_distance_r

number or object

A filter for retrieving accessible neighborhoods by miss_distance_t

number or object

A filter for retrieving accessible neighborhoods by miss_distance_n

Responses

Response samples

Content type
application/json
{
  • "elements": [
    ],
  • "object": "list"
}

Get conjunctions for current user

Get conjunctions for current user

query Parameters
limit
integer [ 1 .. 100 ]

Set this parameter to limit the count of items returned in a single response.

page
integer [ 1 .. 1000 ]

Set the page to go through the list of paginated conjunctions.

sort
string
Default: "-tca"
Example: sort=-tca

Set the field to sort by.

object

Filter the returned conjunctions by miss distance.

number or object

Filter the returned conjunctions by miss distance.

number or object

Filter the returned conjunctions by miss distance.

criticality
Array of strings (Criticality)
Items Enum: "non_critical" "observe" "critical"
Example: criticality=non_critical

Filter results by criticality.

q
string <= 255 characters

Search by fulltext for conjunction id, satellite name and secondary object. Also recognizes parts of the string. Case-insensitive.

include
Array of strings

The fields to be include from the conjunctions collection separated by a comma cast as an array

exclude
Array of strings
Items Enum: "newest_risk_estimation" "newest_risk_prediction"

Exclude fields from result to reduce payload and complexity.

sandbox
boolean

Enable or disable sandbox responses.

Responses

Response samples

Content type
application/json
{
  • "elements": [
    ],
  • "has_more": true,
  • "total_count": 0,
  • "miss_distance": 0.135,
  • "collision_probability": 0.00001,
  • "tca": "2014-12-31T23:59:59.124Z",
  • "use_ai_risk_prediction": true,
  • "criticality_level": 0
}

Get a specific conjunction

Retrieve a specific conjunction identified by the id.

path Parameters
conjunction_id
required
string

ID of conjunction

query Parameters
exclude
Array of strings

Field names to exclude and retrieve a sleeker response.

sandbox
boolean

Enable or disable sandbox responses.

Responses

Response samples

Content type
application/json
{
  • "conjunction_id": "550e8400-e29b-11d4-a716-446655440000",
  • "sat1_norad_id": 0,
  • "sat2_norad_id": 0,
  • "sat1_name": "string",
  • "sat2_name": "string",
  • "criticality": "non_critical",
  • "criticality_source": "risk_estimation",
  • "newest_risk_estimation": {
    },
  • "newest_risk_prediction": {
    }
}

List risk estimations of a specific conjunction

Retrieves a filterable list of all risk estimations related to a specific conjunction.

path Parameters
conjunction_id
required
string

ID of conjunction

query Parameters
sandbox
boolean

Enable or disable sandbox responses.

Responses

Response samples

Content type
application/json
{
  • "object": "string",
  • "data": [
    ]
}

List risk predictions of a specific conjunction

Retrieves a filterable list of all risk predictions related to a specific conjunction.

path Parameters
conjunction_id
required
string

ID of conjunction

query Parameters
sandbox
boolean

Enable or disable sandbox responses.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get CDMs that belong to the specified conjunction

Get CDMs that belong to the specified conjunction

path Parameters
conjunction_id
required
string

ID of conjunction

query Parameters
sort
string

The sort key which the cdms will be sorted on. If the sort key is prefixed with - the cdms are sorted in the decreasing order on this key . Otherwise, the cdms are sorted in the increasing order on this key.

include
Array of strings

The fields to be include from the cdms belonging to specified conjunction separated by a comma cast as an array

sandbox
boolean

Enable or disable sandbox responses.

Responses

Response samples

Content type
application/json
{
  • "object": "list",
  • "elements": [
    ]
}

Get maneuver evaluations

Get maneuver for the specified conjunction and evaluations thereof

path Parameters
conjunction_id
required
string

ID of conjunction

query Parameters
sandbox
boolean

Enable or disable sandbox responses.

Responses

Response samples

Content type
application/json
{
  • "elements": [
    ]
}

List risk predictions of a specific conjunction

Retrieves a filterable list of all risk predictions related to a specific conjunction.

path Parameters
conjunction_id
required
string

ID of conjunction

query Parameters
sandbox
boolean

Enable or disable sandbox responses.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get risk estimation graph for conjunction

Get the pre-processed graph history data to display different metrics about a conjunction.

path Parameters
conjunction_id
required
string

ID of conjunction

query Parameters
sandbox
boolean

Should sandbox data be returned

Responses

Response samples

Content type
application/json
{
  • "elements": [
    ]
}

Get risk estimation graph for conjunction

Get the pre-processed graph history data to display different metrics about a conjunction.

path Parameters
conjunction_id
required
string

ID of conjunction

query Parameters
sandbox
boolean

Should sandbox data be returned

Responses

Response samples

Content type
application/json
{
  • "elements": [
    ]
}

Add a new maneuver plan

Upload a new maneuver plan to a satellite. It will fail if the new plan overlaps with an existing one. In this case invalidate the old one or request with a force=true query parameter.

query Parameters
force
boolean
Default: false

Auto-invalidates existing phases overlapping the new one and allows you to push overlapping phases.

Request Body schema: application/json
satellite_id
string (satellite_id)

Referencing the satellite_id key in the satellite collection. The plan is for the referenced satellite.

Array of objects (phases)

The list of maneuvers contained in this plan. Sorted by start date.

Responses

Request samples

Content type
application/json
{
  • "satellite_id": "string",
  • "phases": [
    ]
}

Response samples

Content type
application/json
{
  • "maneuver_plan_id": "string",
  • "satellite_id": "string",
  • "user_id": "string",
  • "start_epoch": "2014-12-31T23:59:59.124Z",
  • "end_epoch": "2014-12-31T23:59:59.124Z",
  • "valid": true,
  • "phases": [
    ]
}

List all maneuver phases

Provides a filterable list of all accessible maneuver phases across all satellites.

query Parameters
page
integer [ 1 .. 2147483647 ]
Default: 1

Page number

limit
integer [ 1 .. 1000 ]
Default: 20

Number of records per page

Responses

Response samples

Content type
application/json
{
  • "elements": [
    ],
  • "has_more": true,
  • "total_count": 0
}

Add ground station passes of multiple satellites

Add a multiple ground station passes to the platform DB.

Request Body schema: application/json

Ground station passes to add

required
Array of objects (GroundStationPasses)

Responses

Request samples

Content type
application/json
{
  • "elements": [
    ]
}

Response samples

Content type
application/json
{
  • "elements": [
    ]
}

Get own ground station passes

Get own ground station passes from the collection in the platform.

query Parameters
start
string

ISO date string for start of date-filtering.

stop
string

ISO date string for end of date-filtering.

objectId
string

The object Id, e.g. NORAD ID

name
string

Spacecraft name

page
integer [ 1 .. 2147483647 ]
Default: 1

Page number

limit
integer [ 1 .. 1000 ]
Default: 20

Number of records per page

Responses

Response samples

Content type
application/json
{
  • "elements": [
    ]
}

An endpoint to get stored logs.

An endpoint to get a list of all logs matching the query parameters.

query Parameters
page
integer [ 1 .. 2147483647 ]
Default: 1

Page number

limit
integer [ 1 .. 1000 ]
Default: 20

Number of records per page

request_id
string

Filter logs by request_id

job
string
Enum: "determine-orbit" "maintain-catalogue" "add-ephemerides"

Filter logs by job name

object
oem_id
string (Uuid) ^[a-f0-9]{8}(-[a-f0-9]{4}){4}[a-f0-9]{8}$
Example: oem_id=550e8400-e29b-11d4-a716-446655440000

Filter logs by oem_id

omm_id
string (Uuid) ^[a-f0-9]{8}(-[a-f0-9]{4}){4}[a-f0-9]{8}$
Example: omm_id=550e8400-e29b-11d4-a716-446655440000

Filter logs by omm_id

tdm_id
string (Uuid) ^[a-f0-9]{8}(-[a-f0-9]{4}){4}[a-f0-9]{8}$
Example: tdm_id=550e8400-e29b-11d4-a716-446655440000

Filter logs by tdm_id

od_group_id
string (Uuid) ^[a-f0-9]{8}(-[a-f0-9]{4}){4}[a-f0-9]{8}$
Example: od_group_id=550e8400-e29b-11d4-a716-446655440000

Filter logs by od_group_id

latest
boolean

Retrieve latest log

Responses

Response samples

Content type
application/json
{
  • "object": "list",
  • "elements": [
    ]
}

An endpoint to get a specific log.

An endpoint to get a specific log.

path Parameters
log_id
required
string

ID of log

Responses

Response samples

Content type
application/json
{
  • "object": "list",
  • "elements": [
    ]
}

Calculate uncertainties

Calculate uncertainties based on a given epoch.

query Parameters
epoch
string <date-time> (IsoDateTime) ^([1-9][0-9]{3})-((01|03|05|07|08|10|12)-(0[1...
Example: epoch=2014-12-31T23:59:59.124Z

Define the epoch to calculate the uncertainties. By default, it is now.

limit
integer [ 1 .. 100000000000 ]
Default: 1000

Set this parameter to limit the count of items returned in a single response.

page
integer [ 1 .. 999999999 ]
Default: 1

Set the page to go through the list of paginated uncertainties.

norad_id
Array of numbers[ items <= 999999999 ]

A list norad ids or a single value to filter the results for specific satellites.

cospar_id
Array of strings

A list of cospar_id in the space objects map

sort
Array of strings
Default: ["-sum"]
Items Enum: "sum" "+sum" "-sum" "rtn.r" "+rtn.r" "-rtn.r" "rtn.t" "+rtn.t" "-rtn.t" "rtn.n" "+rtn.n" "-rtn.n"
Example: sort=-sum

Set the field or fields to sort by. Prefix the field name with + or - to specify ascending or descending order. Default is ascending (+).

Responses

Response samples

Content type
application/json
{
  • "object": "list",
  • "elements": [
    ],
  • "has_more": true,
  • "total_count": 1,
  • "filtered_count": 0
}

An endpoint to get health status of the system.

An endpoint to get health status of the system.

path Parameters
service_name
required
string

Service Name

Responses

Response samples

Content type
application/json
{
  • "status": "healthy",
  • "code": 0
}

An endpoint to filter omms based on query params.

An endpoint to filter omms based on query params.

query Parameters
object

TODO

page
integer >= 1
Default: 1

page number

limit
integer [ 0 .. 1000 ]
Default: 100

number of records per page

originator
string
Enum: "18 SPCS" "EON" "OKAPI:ORBITS" "18 spcs" "eon" "OKAPI:Orbits"

Originator name

latest
boolean
Default: false

A boolean which indicates if all or only latest omms are queried

start
string <date-time> (IsoDateTime) ^([1-9][0-9]{3})-((01|03|05|07|08|10|12)-(0[1...
Example: start=2014-12-31T23:59:59.124Z

Earliest CREATION_DATE

stop
string <date-time> (IsoDateTime) ^([1-9][0-9]{3})-((01|03|05|07|08|10|12)-(0[1...
Example: stop=2014-12-31T23:59:59.124Z

Latest CREATION_DATE

norad_id
number

NORAD_CAT_ID filter

cospar_id
string

The cospar_id filter from which the norad_id filter can be derived

orbit_type
string
Enum: "GEO" "geo" "IGO" "igo" "EGO" "ego" "NSO" "nso" "GTO" "gto" "MEO" "meo" "GHO" "gho" "LEO" "leo" "HAO" "hao" "MGO" "mgo" "HEO" "heo"

GEO: Geostationary Orbit| IGO: Inclined Geosynchronous Orbit| EGO: Extended Geostationary Orbit| NSO: Navigation Satellites Orbit| GTO: GEO Transfer Orbit| MEO: Medium Earth Orbit| GHO: GEO-superGEO Crossing Orbits| LEO: Low Earth Orbit| HAO: High Altitude Earth Orbit| MGO: MEO-GEO Crossing Orbits| HEO: Highly Eccentric Earth Orbit

object

inclination filter

object

period filter

object

eccentricity filter

object

periapsis filter

object

apoapsis filter

object

semimajoraxis filter

Responses

Response samples

Content type
application/json
{
  • "object": "list",
  • "elements": [
    ]
}

Add ephemerides so that they can be used, e.g., for orbit determination.

Submits a request for converting and saving the provided ephemerides.

Request Body schema: application/json
required
object (GenericEphemerides)

A generic container for different types of ephemerides.

use_status
string (UseStatus)
Default: "operational"
Enum: "operational" "tentative" "discarded"

Describes how the data is used.

screen_conjunctions
boolean
Default: false
object (ScreeningVolume)

Defines a spherical threshold needed for the close approach check as radii of an ellipsoidal screening volume in satellite centered coordinates (RTN).

Responses

Request samples

Content type
application/json
{
  • "ephemerides": {
    },
  • "use_status": "operational",
  • "screen_conjunctions": false,
  • "screening_volume": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Retrieve results for adding ephemerides.

Tells you if everything went fine during conversion/adding of epehemerides.

path Parameters
request_id
required
string

Request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "status": {
    }
}

Retrieve results for adding ephemerides.

Tells you if everything went fine during conversion/adding of epehemerides.

path Parameters
request_id
required
string

Request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "status": {
    }
}

Retrieve results as CCSDS OEM for adding ephemerides.

Tells you if everything went fine during conversion/adding of epehemerides.

path Parameters
request_id
required
string

Request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "status": {
    },
  • "orbit": {
    },
  • "oem_id": "string",
  • "omm_id": "string"
}

Retrieve results as CCSDS OEM for adding ephemerides.

Tells you if everything went fine during conversion/adding of epehemerides.

path Parameters
request_id
required
string

Request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "status": {
    },
  • "orbit": {
    },
  • "oem_id": "string",
  • "omm_id": "string"
}

Correlate observed object with catalog object

Submits a request for an observation correlation.

Request Body schema: application/json

Measurements, sensor definition, correlation settings

required
object (MeasurementsForCorrelation)

Measurements encapsulated as TDMs for correlation.

required
object (SensorSystem)

A sensor system

required
object (CorrelateTrackToObjectSettings)

Settings to tune the track-to-object correlation

Responses

Request samples

Content type
application/json
"../examples/CorrelateTrackToObjectRequestDataExample.json"

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

An endpoint to get CDMs and optionally sort them if a sort key is passed as a query parameter.

An endpoint to get CDMs and optionally sort them if a sort key is passed as a query parameter.

query Parameters
page
integer [ 1 .. 2147483647 ]
Default: 1

Page number

limit
integer [ 1 .. 1000 ]
Default: 20

Number of records per page

sort
string

The sort key which the CDMs will be sorted on. If the sort key is prefixed with - the CDMs are sorted in the decreasing order on this key . Otherwise, the CDMs are sorted in the increasing order on this key.

sat1_object_designator
integer [ 1 .. 99999 ]

A filter to retrieve CDMs by sat1_object_designator.

sat2_object_designator
integer [ 1 .. 99999 ]

A filter to retrieve CDMs by sat2_object_designator.

object
object

A filter to retrieve CDMs by relative_position_r.

object

A filter to retrieve CDMs by relative_position_t.

object

A filter to retrieve CDMs by relative_position_n.

object

A filter to retrieve CDMs by time_to_tca.

exclude
Array of strings

The fields to be excluded from the CDMs collection separated by a comma cast as an array

include
Array of strings

The fields to be include from the CDMs collection separated by a comma cast as an array

Responses

Response samples

Content type
application/json
{
  • "object": "list",
  • "elements": [
    ]
}

An endpoint to upload CDMs for processing.

An endpoint to upload CDMs for processing (e.g. risk estimation). The CDMs submitted should adhere to the format specified in the CCSDS Blue Book with the OBJECT_DESIGNATOR set to the satellite NORAD ID (https://public.ccsds.org/Pubs/508x0b1e2s.pdf). When CDMs are provided in KVN format, certain leniencies in formatting are permitted. Firstly, comments within the CDM need not be restricted to the beginning of a section and can appear anywhere within that section. Secondly, a CDM with a SCREEN_VOLUME_FRAME of 'RIC' will be accepted, however, will be replaced by 'RTN' for CCSDS compliance. It is also permissible to submit CDMs with the user satellite as the secondary object. For these CDMs, a mirrored version will be created and uploaded with the user satellite as the primary object and the close approach geometry centered on it.

Request Body schema: application/json

CCSDS CDM you want to upload for risk assessment

One of
format
required
string
Enum: "kvn" "xml"
content
required
string

Responses

Request samples

Content type
application/json
{
  • "format": "json",
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Perform orbit determination using the Weighted Least Squares approach

Submits a request for the statistical orbit determination with the weighted least squares approach using NEPTUNE as the underlying propagator.

Request Body schema: application/json

Initial state as either simple state vector (GCRF) or CCSDS OPM, measurements as JSON converted CCSDS TDM (mind the extra end point for the conversion), sensor definition and optional settings for the WLS and the NEPTUNE propagator

object (GenericOrbitDeterminationOrbit)

A generic state vector as used within the orbit determination process e.g. for the initial state.

required
Array of objects (GenericMeasurements)

Measurements to be used in the OD. They are linked with sensor system properties based on name. All measurements must be of the same format type.

Array of objects (GenericSensorSystem)
object (GenericOrbitDeterminationSettings)

Generic orbit determination settings

object (GenericSharedPropagationSettings)

Generic propagator settings as used by multiple propagators.

object (GenericManeuverPlanForOrbitDetermination)

Maneuver plans that need to be taken into account in the orbit determination process

Responses

Request samples

Content type
application/json
{
  • "orbit": {
    },
  • "measurements": [
    ],
  • "sensor_systems": [
    ],
  • "orbit_determination_settings": {
    },
  • "propagation_settings": {
    },
  • "maneuver_plans": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Estimate change in Covariance from planned measurements

Submits a request for a covariance estimation.

Request Body schema: application/json

Orbit of observed satellite, sensors, and planned measruements

object (GenericPropagationOrbit)

A part of a request to execute an orbit propagation with a specific orbit propagator. Propagation with SGP4 supports TLE input, propagation with Neptune supports state vectors and OPMs (in KVN or JSON format).

Array of objects (GenericMeasurementSlot)
Array of objects (GenericSensorSystem)
object (GenericOrbitDeterminationSettings)

Generic orbit determination settings

object (GenericSharedPropagationSettings)

Generic propagator settings as used by multiple propagators.

object (Satellite)

A satellite. It may define exactly one satellite or may be the representative of a satellite class, i.e. more than one satellite of similar design.

Responses

Request samples

Content type
application/json
{
  • "orbit": {
    },
  • "measurements": [
    ],
  • "sensor_systems": [
    ],
  • "orbit_determination_settings": {
    },
  • "propagation_settings": {
    },
  • "satellite": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Get orbit accuracy improvement information

Get orbit accuracy improvement information by request_id

path Parameters
request_id
required
string

ID of request

Responses

Response samples

Content type
application/json
{
  • "object": "list",
  • "elements": [
    ]
}

Request a `Alfano 2005` collision risk estimation.

Request a collision risk estimation based on the Alfano 2005 as mentioned in the sanaregistry and as described in Alfano, S., 2005. A numerical implementation of spherical object collision probability. Journal of the Astronautical Sciences 53, 103–109 Submit a JSON formatted CDM retrieved from Space-Track to re-evaluate the risk using this method. Optionally, the cross sectional area of either of the respective objects can be overriden in order to refine the result.

Request Body schema: application/json

A CDM in JSON format, which contains the description of the collision partners, including their state vectors, related uncertainties and object properties. Please note that only the current CCDSDS CDM version 1.0 is supported.

required
object (GenericConjunction)

A generic conjunction of type SpaceTrack CDM.

object (GenericRiskEstimationOverrides)

Generic CDM overrides.

object (GenericRiskSettings)

Generic risk settings.

Responses

Request samples

Content type
application/json
{
  • "conjunction": {
    },
  • "overrides": {
    },
  • "risk_settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Request a `Alfriend Akella` collision risk estimation.

Request a collision risk estimation based on the Alfriend Akella as described in Space Debris – Models and Risk Analysis by Klinkrad on p. 224, Eq. 8.30. Submit a JSON formatted CDM retrieved from Space-Track to re-evaluate the risk using this method. Optionally, the cross sectional area of either of the respective objects can be overriden in order to refine the result.

Request Body schema: application/json

A CDM in JSON format, which contains the description of the collision partners, including their state vectors, related uncertainties and object properties. Please note that only the current CCDSDS CDM version 1.0 is supported.

required
object (GenericConjunction)

A generic conjunction of type SpaceTrack CDM.

object (GenericRiskEstimationOverrides)

Generic CDM overrides.

object (GenericRiskSettings)

Generic risk settings.

Responses

Request samples

Content type
application/json
{
  • "conjunction": {
    },
  • "overrides": {
    },
  • "risk_settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Request a collision risk estimation based on all available algorithms.

Request a collision risk estimation using all methods available (Maximum Probability, Foster-1992, Chan-1997, Alfriend-1999, etc.). Submit a JSON formatted CDM retrieved from Space-Track to re-evaluate the risk using this method. Optionally, the cross sectional area of either of the respective objects can be overriden in order to refine the result.

Request Body schema: application/json

A CDM in JSON format, which contains the description of the collision partners, including their state vectors, related uncertainties and object properties. Please note that only the current CCDSDS CDM version 1.0 is supported.

required
object (GenericConjunction)

A generic conjunction of type SpaceTrack CDM.

object (GenericRiskEstimationOverrides)

Generic CDM overrides.

object (GenericRiskSettings)

Generic risk settings.

Responses

Request samples

Content type
application/json
{
  • "conjunction": {
    },
  • "overrides": {
    },
  • "risk_settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Request a `Chan 1997` collision risk estimation.

Request a collision risk estimation based on the Chan 1992 as mentioned in the sanaregistry and described in Chan, K. “Collision Probability Analyses for Earth Orbiting Satellites.” In Space Cooperation into the 21st Century':'' 7th AAS/JRS/CSA Symposium, International Space Conference of Pacific-Basin Societies (ISCOPS; formerly PISSTA) (July 15-18, 1997, Nagasaki, Japan), edited by Peter M. Bainum, et al., 1033-1048. Advances in the Astronautical Sciences Series 96. San Diego, California':'' Univelt, 1997. Submit a JSON formatted CDM retrieved from Space-Track to re-evaluate the risk using this method. Optionally, the cross sectional area of either of the respective objects can be overriden in order to refine the result.

Request Body schema: application/json

A CDM in JSON format, which contains the description of the collision partners, including their state vectors, related uncertainties and object properties. Please note that only the current CCDSDS CDM version 1.0 is supported.

required
object (GenericConjunction)

A generic conjunction of type SpaceTrack CDM.

object (GenericRiskEstimationOverrides)

Generic CDM overrides.

object (GenericRiskSettings)

Generic risk settings.

Responses

Request samples

Content type
application/json
{
  • "conjunction": {
    },
  • "overrides": {
    },
  • "risk_settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Request a `Foster 1992` collision risk estimation.

Request a collision risk estimation based on the Foster 1992 as mentioned in the sanaregistry and described in Foster, J.L., and Estes, H.S., A Parametric Analysis of Orbital Debris Collision Probability and Maneuver Rate for Space Vehicles. NASA/JSC-25898. Houston, Texas':' NASA Johnson Space Flight Center, August 1992. Submit a JSON formatted CDM retrieved from Space-Track to re-evaluate the risk using this method. Optionally, the cross sectional area of either of the respective objects can be overriden in order to refine the result.

Request Body schema: application/json

A CDM in JSON format, which contains the description of the collision partners, including their state vectors, related uncertainties and object properties. Please note that only the current CCDSDS CDM version 1.0 is supported.

required
object (GenericConjunction)

A generic conjunction of type SpaceTrack CDM.

object (GenericRiskEstimationOverrides)

Generic CDM overrides.

object (GenericRiskSettings)

Generic risk settings.

Responses

Request samples

Content type
application/json
{
  • "conjunction": {
    },
  • "overrides": {
    },
  • "risk_settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Request a `Maximum Probability` collision risk estimation.

Request a collision risk estimation based on the Maximum Probability method by Alfriend & Akella as described in Space Debris – Models and Risk Analysis by Klinkrad on p. 226, Eq. 8.36. Submit a JSON formatted CDM retrieved from Space-Track to re-evaluate the risk using this method. Optionally, the cross sectional area of either of the respective objects can be overriden in order to refine the result.

Request Body schema: application/json

A CDM in JSON format, which contains the description of the collision partners, including their state vectors, related uncertainties and object properties. Please note that only the current CCDSDS CDM version 1.0 is supported.

required
object (GenericConjunction)

A generic conjunction of type SpaceTrack CDM.

object (GenericRiskEstimationOverrides)

Generic CDM overrides.

object (GenericRiskSettings)

Generic risk settings.

Responses

Request samples

Content type
application/json
{
  • "conjunction": {
    },
  • "overrides": {
    },
  • "risk_settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Request a `Monte Carlo` collision risk estimation.

Request a collision risk estimation based on a Monte Carlo approach. Submit a JSON formatted CDM retrieved from Space-Track to re-evaluate the risk using this method. Optionally, the cross sectional area of either of the respective objects can be overriden in order to refine the result.

Request Body schema: application/json

A CDM in JSON format, which contains the description of the collision partners, including their state vectors, related uncertainties and object properties. Please note that only the current CCDSDS CDM version 1.0 is supported.

required
object (GenericConjunction)

A generic conjunction of type SpaceTrack CDM.

object (GenericRiskEstimationOverrides)

Generic CDM overrides.

object (GenericRiskSettings)

Generic risk settings.

Responses

Request samples

Content type
application/json
{
  • "conjunction": {
    },
  • "overrides": {
    },
  • "risk_settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Request a `Patera 2001` collision risk estimation.

Request a collision risk estimation based on the Patera 2001 as mentioned in the sanaregistry and as described in Patera, R. "General method for calculating satellite collision probability." Submit a JSON formatted CDM retrieved from Space-Track to re-evaluate the risk using this method. Optionally, the cross sectional area of either of the respective objects can be overriden in order to refine the result.

Request Body schema: application/json

A CDM in JSON format, which contains the description of the collision partners, including their state vectors, related uncertainties and object properties. Please note that only the current CCDSDS CDM version 1.0 is supported.

required
object (GenericConjunction)

A generic conjunction of type SpaceTrack CDM.

object (GenericRiskEstimationOverrides)

Generic CDM overrides.

object (GenericRiskSettings)

Generic risk settings.

Responses

Request samples

Content type
application/json
{
  • "conjunction": {
    },
  • "overrides": {
    },
  • "risk_settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Request a `Patera 2003` collision risk estimation.

Request a collision risk estimation based on the Patera 2003 for low velocity encoounters as mentioned in the sanaregistry and as described in Patera, R. P., “Satellite Collision Probability for Nonlinear Relative Motion,” AIAA Journal of Guidance, Control, and Dynamics, Volume 26, Number 5, September-October 2003, pp. 728-733. Submit a JSON formatted CDM retrieved from Space-Track to re-evaluate the risk using this method. Optionally, the cross sectional area of either of the respective objects can be overriden in order to refine the result.

Request Body schema: application/json

A CDM in JSON format, which contains the description of the collision partners, including their state vectors, related uncertainties and object properties. Please note that only the current CCDSDS CDM version 1.0 is supported.

required
object (GenericConjunction)

A generic conjunction of type SpaceTrack CDM.

object (GenericRiskEstimationOverrides)

Generic CDM overrides.

object (GenericRiskSettings)

Generic risk settings.

Responses

Request samples

Content type
application/json
{
  • "conjunction": {
    },
  • "overrides": {
    },
  • "risk_settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Request a `Alfano 2005` collision risk trend.

Request a collision risk prediction based on the Alfano 2005 as mentioned in the sanaregistry and as described in Alfano, S., 2005. A numerical implementation of spherical object collision probability. Journal of the Astronautical Sciences 53, 103–109 Submit a JSON formatted CDM retrieved from Space-Track to re-evaluate the risk using this method. Optionally, the cross sectional area of either of the respective objects can be overriden in order to refine the result. This produces a risk trend anticipating how the covariances are going to shrink and assuming that the objects' miss distance and velocities remain constant until TCA.

Request Body schema: application/json

A CDM in JSON format, which contains the description of the collision partners, including their state vectors, related uncertainties and object properties. Please note that only the current CCDSDS CDM version 1.0 is supported.

required
object (GenericConjunction)

A generic conjunction of type SpaceTrack CDM.

object (GenericRiskPredictionOverrides)

Generic risk prediction overrides.

object (GenericRiskSettings)

Generic risk settings.

Responses

Request samples

Content type
application/json
{
  • "conjunction": {
    },
  • "overrides": {
    },
  • "risk_settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Request a `Alfriend Akella` collision risk trend.

Request a collision risk prediction based on the Alfriend Akella as described in Space Debris – Models and Risk Analysis by Klinkrad on p. 224, Eq. 8.30. Submit a JSON formatted CDM retrieved from Space-Track to re-evaluate the risk using this method. Optionally, the cross sectional area of either of the respective objects can be overriden in order to refine the result. This produces a risk trend anticipating how the covariances are going to shrink and assuming that the objects' miss distance and velocities remain constant until TCA.

Request Body schema: application/json

A CDM in JSON format, which contains the description of the collision partners, including their state vectors, related uncertainties and object properties. Please note that only the current CCDSDS CDM version 1.0 is supported.

required
object (GenericConjunction)

A generic conjunction of type SpaceTrack CDM.

object (GenericRiskPredictionOverrides)

Generic risk prediction overrides.

object (GenericRiskSettings)

Generic risk settings.

Responses

Request samples

Content type
application/json
{
  • "conjunction": {
    },
  • "overrides": {
    },
  • "risk_settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Request a `Chan 1997` collision risk trend.

Request a collision risk prediction based on the Chan 1997 as mentioned in the sanaregistry and described in Chan, K. “Collision Probability Analyses for Earth Orbiting Satellites.” In Space Cooperation into the 21st Century':'' 7th AAS/JRS/CSA Symposium, International Space Conference of Pacific-Basin Societies (ISCOPS; formerly PISSTA) (July 15-18, 1997, Nagasaki, Japan), edited by Peter M. Bainum, et al., 1033-1048. Advances in the Astronautical Sciences Series 96. San Diego, California':'' Univelt, 1997. Submit a JSON formatted CDM retrieved from Space-Track to re-evaluate the risk using this method. Optionally, the cross sectional area of either of the respective objects can be overriden in order to refine the result. This produces a risk trend anticipating how the covariances are going to shrink and assuming that the objects' miss distance and velocities remain constant until TCA.

Request Body schema: application/json

A CDM in JSON format, which contains the description of the collision partners, including their state vectors, related uncertainties and object properties. Please note that only the current CCDSDS CDM version 1.0 is supported.

required
object (GenericConjunction)

A generic conjunction of type SpaceTrack CDM.

object (GenericRiskPredictionOverrides)

Generic risk prediction overrides.

object (GenericRiskSettings)

Generic risk settings.

Responses

Request samples

Content type
application/json
{
  • "conjunction": {
    },
  • "overrides": {
    },
  • "risk_settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Request a `Foster 1992` collision risk trend.

Request a collision risk prediction based on the Foster 1992 as mentioned in the sanaregistry and described in Foster, J.L., and Estes, H.S., A Parametric Analysis of Orbital Debris Collision Probability and Maneuver Rate for Space Vehicles. NASA/JSC-25898. Houston, Texas':' NASA Johnson Space Flight Center, August 1992. Submit a JSON formatted CDM retrieved from Space-Track to re-evaluate the risk using this method. Optionally, the cross sectional area of either of the respective objects can be overriden in order to refine the result. This produces a risk trend anticipating how the covariances are going to shrink and assuming that the objects' miss distance and velocities remain constant until TCA.

Request Body schema: application/json

A CDM in JSON format, which contains the description of the collision partners, including their state vectors, related uncertainties and object properties. Please note that only the current CCDSDS CDM version 1.0 is supported.

required
object (GenericConjunction)

A generic conjunction of type SpaceTrack CDM.

object (GenericRiskPredictionOverrides)

Generic risk prediction overrides.

object (GenericRiskSettings)

Generic risk settings.

Responses

Request samples

Content type
application/json
{
  • "conjunction": {
    },
  • "overrides": {
    },
  • "risk_settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Request a `Maximum Probability` collision risk trend.

Request a collision risk prediction based on the Maximum Probability based on the Maximum Probability method by Alfriend & Akella as described in Space Debris – Models and Risk Analysis by Klinkrad on p. 226, Eq. 8.36. Submit a JSON formatted CDM retrieved from Space-Track to re-evaluate the risk using this method. Optionally, the cross sectional area of either of the respective objects can be overriden in order to refine the result. This produces a risk trend anticipating how the covariances are going to shrink and assuming that the objects' miss distance and velocities remain constant until TCA.

Request Body schema: application/json

A CDM in JSON format, which contains the description of the collision partners, including their state vectors, related uncertainties and object properties. Please note that only the current CCDSDS CDM version 1.0 is supported.

required
object (GenericConjunction)

A generic conjunction of type SpaceTrack CDM.

object (GenericRiskPredictionOverrides)

Generic risk prediction overrides.

object (GenericRiskSettings)

Generic risk settings.

Responses

Request samples

Content type
application/json
{
  • "conjunction": {
    },
  • "overrides": {
    },
  • "risk_settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Request a `Monte Carlo` collision risk trend.

Request a collision risk prediction based on a Monte Carlo approach. Optionally, the cross sectional area of either of the respective objects can be overriden in order to refine the result. This produces a risk trend anticipating how the covariances are going to shrink and assuming that the objects' miss distance and velocities remain constant until TCA.

Request Body schema: application/json

A CDM in JSON format, which contains the description of the collision partners, including their state vectors, related uncertainties and object properties. Please note that only the current CCDSDS CDM version 1.0 is supported.

required
object (GenericConjunction)

A generic conjunction of type SpaceTrack CDM.

object (GenericRiskPredictionOverrides)

Generic risk prediction overrides.

object (GenericRiskSettings)

Generic risk settings.

Responses

Request samples

Content type
application/json
{
  • "conjunction": {
    },
  • "overrides": {
    },
  • "risk_settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Request a `Patera 2001` collision risk trend.

Request a collision risk prediction based on the Patera 2001 as mentioned in the sanaregistry and as described in Patera, R. "General method for calculating satellite collision probability." Submit a JSON formatted CDM retrieved from Space-Track to re-evaluate the risk using this method. Optionally, the cross sectional area of either of the respective objects can be overriden in order to refine the result. This produces a risk trend anticipating how the covariances are going to shrink and assuming that the objects' miss distance and velocities remain constant until TCA.

Request Body schema: application/json

A CDM in JSON format, which contains the description of the collision partners, including their state vectors, related uncertainties and object properties. Please note that only the current CCDSDS CDM version 1.0 is supported.

required
object (GenericConjunction)

A generic conjunction of type SpaceTrack CDM.

object (GenericRiskPredictionOverrides)

Generic risk prediction overrides.

object (GenericRiskSettings)

Generic risk settings.

Responses

Request samples

Content type
application/json
{
  • "conjunction": {
    },
  • "overrides": {
    },
  • "risk_settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Request a `Patera 2003` collision risk trend.

Request a collision risk prediction based on the Patera 2003 as mentioned in the sanaregistry and as described in Patera, R. P., “Satellite Collision Probability for Nonlinear Relative Motion,” AIAA Journal of Guidance, Control, and Dynamics, Volume 26, Number 5, September-October 2003, pp. 728-733. Submit a JSON formatted CDM retrieved from Space-Track to re-evaluate the risk using this method. Optionally, the cross sectional area of either of the respective objects can be overriden in order to refine the result. This produces a risk trend anticipating how the covariances are going to shrink and assuming that the objects' miss distance and velocities remain constant until TCA.

Request Body schema: application/json

A CDM in JSON format, which contains the description of the collision partners, including their state vectors, related uncertainties and object properties. Please note that only the current CCDSDS CDM version 1.0 is supported.

required
object (GenericConjunction)

A generic conjunction of type SpaceTrack CDM.

object (GenericRiskPredictionOverrides)

Generic risk prediction overrides.

object (GenericRiskSettings)

Generic risk settings.

Responses

Request samples

Content type
application/json
{
  • "conjunction": {
    },
  • "overrides": {
    },
  • "risk_settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Request a risk trend using all methods available in simple format.

Request a collision risk prediction based on all available methods. Optionally, the cross sectional area of either of the respective objects can be overriden in order to refine the result. This produces a risk trend anticipating how the covariances are going to shrink and assuming that the objects' miss distance and velocities remain constant until TCA.

Request Body schema: application/json

A CDM in JSON format, which contains the description of the collision partners, including their state vectors, related uncertainties and object properties. Please note that only the current CCDSDS CDM version 1.0 is supported.

required
object (GenericConjunction)

A generic conjunction of type SpaceTrack CDM.

object (GenericRiskPredictionOverrides)

Generic risk prediction overrides.

object (GenericRiskSettings)

Generic risk settings.

Responses

Request samples

Content type
application/json
{
  • "conjunction": {
    },
  • "overrides": {
    },
  • "risk_settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Generate maneuver with NEPTUNE

Submits a request for a maneuver generation using the sophisticated numerical propagator NEPTUNE.

Request Body schema: application/json

Initial state as either simple state vector (J2000 ECI) or CCSDS OPM, sensor definition, prediction window

conjunction_id
string (Uuid) ^[a-f0-9]{8}(-[a-f0-9]{4}){4}[a-f0-9]{8}$

A Universally-Unique Identifier, as used by OKAPI:Orbits

object (ManueverConstraints)

Maneuver Constraints

object (SharedPropagationSettings)

Shared propagator settings valid for different numerical propagators (e.g. NEPTUNE and Orekit)

Responses

Request samples

Content type
application/json
{
  • "conjunction_id": "550e8400-e29b-11d4-a716-446655440000",
  • "maneuver_constraints": {
    },
  • "expert_settings_propagation": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Pass prediction with NEPTUNE

Submits a request for a pass prediction using the sophisticated numerical propagator NEPTUNE.

Request Body schema: application/json

Initial state as either simple state vector (J2000 ECI) or CCSDS OPM, sensor definition, prediction window

required
object (GenericPropagationOrbit)

A part of a request to execute an orbit propagation with a specific orbit propagator. Propagation with SGP4 supports TLE input, propagation with Neptune supports state vectors and OPMs (in KVN or JSON format).

required
GenericGroundLocation (object) or GenericGroundLocation (object) (GenericGroundLocation)

A generic ground location.

required
object (GenericTimeWindow)

A time window with start and end epoch as needed in the pass prediction service request.

object (GenericSharedPropagationSettings)

Generic propagator settings as used by multiple propagators.

object (GenericSensorSimulationSettings)

Generic sensor simulation settings as used e.g. within the pass prediction service.

Responses

Request samples

Content type
application/json
{
  • "orbit": {
    },
  • "ground_location": {
    },
  • "time_window": {
    },
  • "settings": {
    },
  • "sensor_simulation_settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Pass prediction with Orekit's numerical propagator

Submits a request for a pass prediction using Orekit's numerical propagator.

Request Body schema: application/json

Initial state as either simple state vector (J2000 ECI) or CCSDS OPM, sensor definition, prediction window

required
object (GenericPropagationOrbit)

A part of a request to execute an orbit propagation with a specific orbit propagator. Propagation with SGP4 supports TLE input, propagation with Neptune supports state vectors and OPMs (in KVN or JSON format).

required
GenericGroundLocation (object) or GenericGroundLocation (object) (GenericGroundLocation)

A generic ground location.

required
object (GenericTimeWindow)

A time window with start and end epoch as needed in the pass prediction service request.

object (GenericSharedPropagationSettings)

Generic propagator settings as used by multiple propagators.

object (GenericSensorSimulationSettings)

Generic sensor simulation settings as used e.g. within the pass prediction service.

Responses

Request samples

Content type
application/json
{
  • "orbit": {
    },
  • "ground_location": {
    },
  • "time_window": {
    },
  • "settings": {
    },
  • "sensor_simulation_settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Pass prediction with SGP4

Submits a request for a pass prediction using the SGP4 propagator.

Request Body schema: application/json

Initial ephemeris as TLE, sensor definition, prediction window

required
object (GenericPropagationOrbit)

A part of a request to execute an orbit propagation with a specific orbit propagator. Propagation with SGP4 supports TLE input, propagation with Neptune supports state vectors and OPMs (in KVN or JSON format).

required
GenericGroundLocation (object) or GenericGroundLocation (object) (GenericGroundLocation)

A generic ground location.

required
object (GenericTimeWindow)

A time window with start and end epoch as needed in the pass prediction service request.

object (GenericSharedPropagationSettings)

Generic propagator settings as used by multiple propagators.

object (GenericSensorSimulationSettings)

Generic sensor simulation settings as used e.g. within the pass prediction service.

Responses

Request samples

Content type
application/json
{
  • "orbit": {
    },
  • "ground_location": {
    },
  • "time_window": {
    },
  • "settings": {
    },
  • "sensor_simulation_settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Pass prediction from OEMs in collection

Submits a request for a pass prediction using the OEM propagator.

Request Body schema: application/json

Ephemeris from OEMs, sensor definition, prediction window

required
object (GenericPropagationOrbit)

A part of a request to execute an orbit propagation with a specific orbit propagator. Propagation with SGP4 supports TLE input, propagation with Neptune supports state vectors and OPMs (in KVN or JSON format).

required
GenericGroundLocation (object) or GenericGroundLocation (object) (GenericGroundLocation)

A generic ground location.

required
object (GenericTimeWindow)

A time window with start and end epoch as needed in the pass prediction service request.

object (GenericSharedPropagationSettings)

Generic propagator settings as used by multiple propagators.

object (GenericSensorSimulationSettings)

Generic sensor simulation settings as used e.g. within the pass prediction service.

Responses

Request samples

Content type
application/json
{
  • "orbit": {
    },
  • "ground_location": {
    },
  • "time_window": {
    },
  • "settings": {
    },
  • "sensor_simulation_settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Propagate an orbit using NEPTUNE

Submits a propagation request with the numerical NEPTUNE propagator, where the initial state is given as either simple state vector as simple json or CCSDS. When the propagator configuration is missing, default values are assumed. Note: When using OPM, the drag area is (currently) used as only surface during propagation. Furthermore, OPM fields from the standard not mentioned here can be provided but won't be evaluated. If at least one covariance value together with the definition of its reference frame are given, the covariance is propagated. If no frame is given, an error is returned. If no covariance is given, it will not be propagated.

Request Body schema: application/json

Initial state as either simple state vector (J2000 ECI) or CCSDS OPM

required
object (GenericPropagationOrbit)

A part of a request to execute an orbit propagation with a specific orbit propagator. Propagation with SGP4 supports TLE input, propagation with Neptune supports state vectors and OPMs (in KVN or JSON format).

required
object (GenericPropagationSettings)

Generic orbit propagation settings.

Responses

Request samples

Content type
application/json
{
  • "orbit": {
    },
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Propagate an orbit using SGP4

Submits a propagation request with the analytical SGP4 theory, where the initial state is given in TLE format.

Request Body schema: application/json

initial state as TLE

required
object (GenericPropagationOrbit)

A part of a request to execute an orbit propagation with a specific orbit propagator. Propagation with SGP4 supports TLE input, propagation with Neptune supports state vectors and OPMs (in KVN or JSON format).

required
object (GenericPropagationSettings)

Generic orbit propagation settings.

Responses

Request samples

Content type
application/json
{
  • "orbit": {
    },
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Checks an orbit (incl. maneuvers) for close approaches

Submits a request for an orbit check using the sophisticated numerical propagator NEPTUNE.

Request Body schema: application/json

Initial state as either simple state vector (J2000 ECI) or CCSDS OPM

required
object (GenericPropagationOrbit)

A part of a request to execute an orbit propagation with a specific orbit propagator. Propagation with SGP4 supports TLE input, propagation with Neptune supports state vectors and OPMs (in KVN or JSON format).

object (GenericScreeningVolume)

Generic screening volume.

object (GenericPropagationSettings)

Generic orbit propagation settings.

Responses

Request samples

Content type
application/json
{
  • "orbit": {
    },
  • "screening_volume": {
    },
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Starts a maneuver execution analysis.

Confirms whether a commanded maneuver for a given satellite has been performed.

Request Body schema: application/json

Initial state as CCSDS OPM with maneuver information and thresholds used in the analysis.

allowed_range_residuals_standard_deviation_factor
number >= 0
Default: 10

Allowed standard deviation factor between predicted and observed range measurmenets for assumed successful maneuver (e.g. 3.0 in relation to uncertainties from measurement noise and propagation uncertainties) in km

allowed_range_residuals_standard_deviation
number >= 0
Default: 1

Allowed standard deviation between predicted and observed range measurements for assumed successful maneuver in km

allowed_angle_residuals_standard_deviation_factor
number >= 0
Default: 10

Allowed standard deviation between predicted and observed measurmenets (e.g. delta RA, Decl) for assumed successful maneuver (e.g. 3.0 in relation to uncertainties from measurement noise and propagation uncertainties) in deg

allowed_angle_residuals_standard_deviation
number >= 0
Default: 0.0005

Allowed standard deviation between predicted and observed measurmenets (e.g. delta RA, Decl) for assumed successful maneuver in deg

required
object (CcsdsOpm)

Defintition of the CCSDS OPM, with one header, meta data and data section.

object (GenericPropagationSettings)

Generic orbit propagation settings.

Responses

Request samples

Content type
application/json
{
  • "allowed_range_residuals_standard_deviation_factor": 10,
  • "allowed_range_residuals_standard_deviation": 1,
  • "allowed_angle_residuals_standard_deviation_factor": 10,
  • "allowed_angle_residuals_standard_deviation": 0.0005,
  • "orbit": {
    },
  • "propagation_settings": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "c526ce06-38e8-41f3-87c3-83fbe0b4f6b",
  • "status": {
    }
}

Retrieve status of uploaded CDM

Retrieve the status of the uploaded CDM (either successful and will be processed further, or failed)

path Parameters
request_id
required
string

Request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "cdm_id": "550e8400-e29b-11d4-a716-446655440000",
  • "status": {
    }
}

Retrieve orbit determination result as simple state vector

Retrieve the json formatted osculating state vector.

path Parameters
request_id
required
string

Request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "od_result": {
    },
  • "tracklet_ids": [
    ],
  • "status": {
    },
  • "maneuver_plans": [
    ]
}

Retrieve orbit determination result as simple state vector

Retrieve the json formatted osculating state vector.

path Parameters
request_id
required
string

Request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "od_result": {
    },
  • "tracklet_ids": [
    ],
  • "status": {
    },
  • "maneuver_plans": [
    ]
}

Retrieve generate manuever result as simple state vector

Retrieve the json formatted osculating state vector.

path Parameters
request_id
required
string

Request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "cam_result_data": [
    ],
  • "status": {
    },
  • "db_sat_in_sun": true,
  • "db_sat_min_time_in_sun": 900,
  • "db_sat_min_time_until_eclipse": 600,
  • "db_sat_constrain_entire_maneuver": true,
  • "db_sat_use_ground_station_passes": false,
  • "db_sat_use_offset_cdm_and_earliest_maneuver": true,
  • "db_sat_offset_cdm_and_earliest_maneuver": 25200,
  • "db_sat_use_min_time_till_pass": true,
  • "db_sat_min_time_till_pass": 900,
  • "db_sat_min_thrust_duration": 1,
  • "db_sat_max_thrust_duration": 600,
  • "db_sat_thrust_duration_step_size": 2,
  • "db_sat_thrust_output": 1.1e-8,
  • "db_sat_enable_accepted_collision_probability_limit_recommendation": true,
  • "db_sat_enable_miss_distance_recommendation": true,
  • "db_sat_drag_area": 0.01,
  • "db_sat_max_semi_major_axis_decrease": -0.1,
  • "db_sat_max_semi_major_axis_increase": 0.1,
  • "db_sat_max_firings": 5,
  • "db_sat_drag_maneuver_settings": {
    },
  • "db_sat_maneuver_direction": [
    ],
  • "maneuver_constraints": {
    }
}

Rerieve generate maneuver result as simple state vector

Retrieve the json formatted osculating state vector.

path Parameters
request_id
required
string

Request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "cam_result_data": [
    ],
  • "status": {
    },
  • "db_sat_in_sun": true,
  • "db_sat_min_time_in_sun": 900,
  • "db_sat_min_time_until_eclipse": 600,
  • "db_sat_constrain_entire_maneuver": true,
  • "db_sat_use_ground_station_passes": false,
  • "db_sat_use_offset_cdm_and_earliest_maneuver": true,
  • "db_sat_offset_cdm_and_earliest_maneuver": 25200,
  • "db_sat_use_min_time_till_pass": true,
  • "db_sat_min_time_till_pass": 900,
  • "db_sat_min_thrust_duration": 1,
  • "db_sat_max_thrust_duration": 600,
  • "db_sat_thrust_duration_step_size": 2,
  • "db_sat_thrust_output": 1.1e-8,
  • "db_sat_enable_accepted_collision_probability_limit_recommendation": true,
  • "db_sat_enable_miss_distance_recommendation": true,
  • "db_sat_drag_area": 0.01,
  • "db_sat_max_semi_major_axis_decrease": -0.1,
  • "db_sat_max_semi_major_axis_increase": 0.1,
  • "db_sat_max_firings": 5,
  • "db_sat_drag_maneuver_settings": {
    },
  • "db_sat_maneuver_direction": [
    ],
  • "maneuver_constraints": {
    }
}

Retrieve result of a `Alfano 2005` risk estimation in simple format.

Retrieve result of a Alfano 2005 risk estimation in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "risk_estimations": [
    ],
  • "status": {
    }
}

Retrieve result of a `Alfano 2005` risk estimation in simple format.

Retrieve result of a Alfano 2005 risk estimation in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "risk_estimations": [
    ],
  • "status": {
    }
}

Retrieve result of a `Alfriend Akella` risk estimation in simple format.

Retrieve result of a Alfriend Akella risk estimation in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "risk_estimations": [
    ],
  • "status": {
    }
}

Retrieve result of a `Alfriend Akella` risk estimation in simple format.

Retrieve result of a Alfriend Akella risk estimation in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "risk_estimations": [
    ],
  • "status": {
    }
}

Retrieve result of a CDM Risk Estimation request using all methods available in simple format.

Retrieve result of a CDM Risk Estimation request using all methods available in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "risk_estimations": [
    ],
  • "status": {
    }
}

Retrieve result of a CDM Risk Estimation request using all methods available in simple format.

Retrieve result of a CDM Risk Estimation request using all methods available in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "risk_estimations": [
    ],
  • "status": {
    }
}

Retrieve result of a `Chan 1997` risk estimation in simple format.

Retrieve result of a Chan 1997 risk estimation in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "risk_estimations": [
    ],
  • "status": {
    }
}

Retrieve result of a `Chan 1997` risk estimation in simple format.

Retrieve result of a Chan 1997 risk estimation in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "risk_estimations": [
    ],
  • "status": {
    }
}

Retrieve result of a `Foster 1992` risk estimation in simple format.

Retrieve result of a Foster 1992 risk estimation in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "risk_estimations": [
    ],
  • "status": {
    }
}

Retrieve result of a `Foster 1992` risk estimation in simple format.

Retrieve result of a Foster 1992 risk estimation in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "risk_estimations": [
    ],
  • "status": {
    }
}

Retrieve result of a `Maximum Probability` risk estimation in simple format.

Retrieve result of a Maximum Probability risk estimation in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "risk_estimations": [
    ],
  • "status": {
    }
}

Retrieve result of a `Maximum Probability` risk estimation in simple format.

Retrieve result of a Maximum Probability risk estimation in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "risk_estimations": [
    ],
  • "status": {
    }
}

Retrieve result of a `Monte-Carlo` risk estimation in simple format.

Retrieve result of a Monte-Carlo risk estimation in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "risk_estimations": [
    ],
  • "status": {
    }
}

Retrieve result of a `Monte-Carlo` risk estimation in simple format.

Retrieve result of a Monte-Carlo risk estimation in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "risk_estimations": [
    ],
  • "status": {
    }
}

Retrieve result of a `Patera 2001` risk estimation in simple format.

Retrieve result of a Patera 2001 risk estimation in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "risk_estimations": [
    ],
  • "status": {
    }
}

Retrieve result of a `Patera 2001` risk estimation in simple format.

Retrieve result of a Patera 2001 risk estimation in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "risk_estimations": [
    ],
  • "status": {
    }
}

Retrieve result of a `Patera 2003` risk estimation in simple format.

Retrieve result of a Patera 2003 risk estimation for low velocity encounters in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "risk_estimations": [
    ],
  • "status": {
    }
}

Retrieve result of a `Patera 2003` risk estimation in simple format.

Retrieve result of a Patera 2003 risk estimation in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "risk_estimations": [
    ],
  • "status": {
    }
}

Retrieve result of a `Alfano 2005` predicted risk trend in simple format.

Retrieve result of a Alfano 2005 predicted risk trend in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "risk_predictions": [
    ],
  • "status": {
    }
}

Retrieve result of a `Alfano 2005` predicted risk trend in simple format.

Retrieve result of a Alfano 2005 predicted risk trend in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "risk_predictions": [
    ],
  • "status": {
    }
}

Retrieve result of a `Alfriend & Akella` predicted risk trend in simple format.

Retrieve result of a Alfriend & Akella predicted risk trend in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "risk_predictions": [
    ],
  • "status": {
    }
}

Retrieve result of a `Alfriend & Akella` predicted risk trend in simple format.

Retrieve result of a Alfriend & Akella predicted risk trend in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "risk_predictions": [
    ],
  • "status": {
    }
}

Retrieve result of a `Chan 1997` predicted risk trend in simple format.

Retrieve result of a Chan 1997 predicted risk trend in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "risk_predictions": [
    ],
  • "status": {
    }
}

Retrieve result of a `Chan 1997` predicted risk trend in simple format.

Retrieve result of a Chan 1997 predicted risk trend in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "risk_predictions": [
    ],
  • "status": {
    }
}

Retrieve result of a `Foster 1992` predicted risk trend in simple format.

Retrieve result of a Foster 1992 predicted risk trend in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "risk_predictions": [
    ],
  • "status": {
    }
}

Retrieve result of a `Foster 1992` predicted risk trend in simple format.

Retrieve result of a Foster 1992 predicted risk trend in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "risk_predictions": [
    ],
  • "status": {
    }
}

Retrieve result of a `Maximum Probability` predicted risk trend in simple format.

Retrieve result of a Maximum Probability predicted risk trend in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "risk_predictions": [
    ],
  • "status": {
    }
}

Retrieve result of a `Maximum Probability` predicted risk trend in simple format.

Retrieve result of a Maximum Probability predicted risk trend in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "risk_predictions": [
    ],
  • "status": {
    }
}

Retrieve result of a `Monte Carlo` predicted risk trend in simple format.

Retrieve result of a Monte Carlo predicted risk trend in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "risk_predictions": [
    ],
  • "status": {
    }
}

Retrieve result of a `Monte Carlo` predicted risk trend in simple format.

Retrieve result of a Monte Carlo predicted risk trend in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "risk_predictions": [
    ],
  • "status": {
    }
}

Retrieve result of a `Patera 2001` predicted risk trend in simple format.

Retrieve result of a Patera 2001 predicted risk trend in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "risk_predictions": [
    ],
  • "status": {
    }
}

Retrieve result of a `Patera 2001` predicted risk trend in simple format.

Retrieve result of a Patera 2001 predicted risk trend in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "risk_predictions": [
    ],
  • "status": {
    }
}

Retrieve result of a `Patera 2003` predicted risk trend in simple format.

Retrieve result of a Patera 2003 predicted risk trend in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "risk_predictions": [
    ],
  • "status": {
    }
}

Retrieve result of a `Patera 2003` predicted risk trend in simple format.

Retrieve result of a Patera 2003 predicted risk trend in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "risk_predictions": [
    ],
  • "status": {
    }
}

Retrieve the risk trend of an `all methods` request in simple format.

Retrieve the risk trend of an all methods request in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "risk_predictions": [
    ],
  • "status": {
    }
}

Retrieve the risk trend of an `all methods` request in simple format.

Retrieve the risk trend of an all methods request in simple format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "risk_predictions": [
    ],
  • "status": {
    }
}

Retrieve a tracking file of a pass prediction.

Retrieve NEPTUNE pass prediction result in simple format with azimuth / elevation angles. You will get a tracking file with different arrays of values per pass.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "passes": [
    ],
  • "status": {
    },
  • "result_part_id": 0,
  • "next_result_part_foreseen": true
}

Retrieve a tracking file of a pass prediction.

Retrieve NEPTUNE pass prediction result in simple format with azimuth / elevation angles. You will get a tracking file with different arrays of values per pass.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "passes": [
    ],
  • "status": {
    },
  • "result_part_id": 0,
  • "next_result_part_foreseen": true
}

Retrieve a tracking file of a pass prediction.

Retrieve NEPTUNE pass prediction result in summary format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "pass_summaries": [
    ],
  • "status": {
    }
}

Retrieve a tracking file of a pass prediction.

Retrieve NEPTUNE pass prediction result in summary format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "pass_summaries": [
    ],
  • "status": {
    }
}

Retrieve a tracking file of a pass prediction.

Retrieve Orekit pass prediction result in simple format with azimuth / elevation angles. You will get a tracking file with different arrays of values per pass.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "passes": [
    ],
  • "status": {
    },
  • "result_part_id": 0,
  • "next_result_part_foreseen": true
}

Retrieve a tracking file of a pass prediction.

Retrieve Orekit pass prediction result in simple format with azimuth / elevation angles. You will get a tracking file with different arrays of values per pass.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "passes": [
    ],
  • "status": {
    },
  • "result_part_id": 0,
  • "next_result_part_foreseen": true
}

Retrieve a tracking file of a pass prediction.

Retrieve Orekit pass prediction result in summary format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "pass_summaries": [
    ],
  • "status": {
    }
}

Retrieve a tracking file of a pass prediction.

Retrieve Orekit pass prediction result in summary format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "pass_summaries": [
    ],
  • "status": {
    }
}

Retrieve a tracking file of a pass prediction.

Retrieve SGP4 pass prediction result in simple format with azimuth / elevation angles. You will get a tracking file with different arrays of values per pass.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "passes": [
    ],
  • "status": {
    },
  • "result_part_id": 0,
  • "next_result_part_foreseen": true
}

Retrieve a tracking file of a pass prediction.

Retrieve SGP4 pass prediction result in simple format with azimuth / elevation angles. You will get a tracking file with different arrays of values per pass.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "passes": [
    ],
  • "status": {
    },
  • "result_part_id": 0,
  • "next_result_part_foreseen": true
}

Retrieve a summary of a pass prediction.

Retrieve SGP4 pass prediction result in summary format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "pass_summaries": [
    ],
  • "status": {
    }
}

Retrieve a summary of a pass prediction.

Retrieve SGP4 pass prediction result in summary format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "pass_summaries": [
    ],
  • "status": {
    }
}

Retrieve a tracking file of a pass prediction.

Retrieve pass prediction based on OEMs in simple format with azimuth / elevation angles. You will get a tracking file with different arrays of values per pass.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "passes": [
    ],
  • "status": {
    },
  • "result_part_id": 0,
  • "next_result_part_foreseen": true
}

Retrieve a tracking file of a pass prediction.

Retrieve pass prediction based on OEMs in simple format with azimuth / elevation angles. You will get a tracking file with different arrays of values per pass.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "passes": [
    ],
  • "status": {
    },
  • "result_part_id": 0,
  • "next_result_part_foreseen": true
}

Retrieve a summary of a pass prediction.

Retrieve pass prediction result based on OEMs in summary format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "pass_summaries": [
    ],
  • "status": {
    }
}

Retrieve a summary of a pass prediction.

Retrieve pass prediction result based on OEMs in summary format.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "pass_summaries": [
    ],
  • "status": {
    }
}

Rerieve NEPTUNE propgation result as CCSDS OEM

Retrieve the propagation result including covariance as a CCSDS formatted OEM. IMPORTANT: Check the messages for warnings. It is possible that the result delivered is not the final state!

path Parameters
request_id
required
string

Request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "orbit": {
    },
  • "status": {
    },
  • "result_part_id": 0,
  • "next_result_part_foreseen": true
}

Rerieve NEPTUNE propgation result as CCSDS OEM

Retrieve the propagation result including covariance as a CCSDS formatted OEM. IMPORTANT: Check the messages for warnings. It is possible that the result delivered is not the final state!

path Parameters
request_id
required
string

Request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "orbit": {
    },
  • "status": {
    },
  • "result_part_id": 0,
  • "next_result_part_foreseen": true
}

Retrieve NEPTUNE propgation result as CCSDS OPM

Retrieve the propagation result as a json formatted CCSDS OPM. Covariance propagation will be available soonish. IMPORTANT: Check the messages for warnings. It is possible that the result delivered is not the final state!

path Parameters
request_id
required
string

Request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "orbit": {
    },
  • "status": {
    },
  • "result_part_id": 0,
  • "next_result_part_foreseen": true
}

Retrieve NEPTUNE propgation result as CCSDS OPM

Retrieve the propagation result as a json formatted CCSDS OPM. Covariance propagation will be available soonish. IMPORTANT: Check the messages for warnings. It is possible that the result delivered is not the final state!

path Parameters
request_id
required
string

Request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "orbit": {
    },
  • "status": {
    },
  • "result_part_id": 0,
  • "next_result_part_foreseen": true
}

Rerieve NEPTUNE propgation result as simple state vector

Retrieve the json formatted osculating state vector.

path Parameters
request_id
required
string

Request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "orbit": {
    },
  • "status": {
    },
  • "result_part_id": 0,
  • "next_result_part_foreseen": true
}

Rerieve NEPTUNE propgation result as simple state vector

Retrieve the json formatted osculating state vector.

path Parameters
request_id
required
string

Request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "orbit": {
    },
  • "status": {
    },
  • "result_part_id": 0,
  • "next_result_part_foreseen": true
}

Rerieve SGP4 propgation result as CCSDS OMM

Retrieve the propagation result as a CCSDS formated OMM.

path Parameters
request_id
required
string

Request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "orbit": {
    },
  • "status": {
    }
}

Rerieve SGP4 propgation result as CCSDS OMM

Retrieve the propagation result as a CCSDS formated OMM.

path Parameters
request_id
required
string

Request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "orbit": {
    },
  • "status": {
    }
}

Rerieve SGP4 propgation result as simple state vector

Retrieve the json formatted osculating state vector.

path Parameters
request_id
required
string

Request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "orbit": {
    },
  • "status": {
    },
  • "result_part_id": 0,
  • "next_result_part_foreseen": true
}

Rerieve SGP4 propgation result as simple state vector

Retrieve the json formatted osculating state vector.

path Parameters
request_id
required
string

Request ID, identifying the request placed into the system.

result_part_id
required
integer

If there is more than one result for that request ID, you can get it via this parameter. Defaults to 0 which is the first result part.

Responses

Response samples

Content type
application/json
{
  • "orbit": {
    },
  • "status": {
    },
  • "result_part_id": 0,
  • "next_result_part_foreseen": true
}

Retrieve all violating objects of the screening volume.

Retrieve orbit check result in simple format with norad id, tca and delta vector.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "candidates_checked": 0,
  • "status": {
    },
  • "result_part_id": 0,
  • "next_result_part_foreseen": true
}

Retrieve the analysis report.

Retrieve analysis results in simple format with execution status and range and angles residual standard deviations.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "executed": true,
  • "range_residuals_std": 0,
  • "angle1_residuals_std": 0,
  • "angle2_residuals_std": 0,
  • "status": {
    }
}

Get your saved TDMs.

Get your saved TDMs.

query Parameters
page
integer [ 1 .. 2147483647 ]
Default: 1

Page number

limit
integer [ 1 .. 1000 ]
Default: 20

Number of records per page

object
object
cospar_id
string (CosparId) \d{4}\-?\d{3}[A-Z]{1,3}

COSPAR ID also known as international designator

norad_id
integer <int32> (NoradId)

NORAD ID

Responses

Response samples

Content type
application/json
{
  • "elements": [
    ]
}

Add a TDM to your saved TDMs. Important: only 1 sensor per TDM and only 1 tracklet per TDM! Participant 1: sensor name Participant 2: Norad Id TDM ID and TrackletID are currently interchangeable

Add a TDM to your saved TDMs. Important: only 1 sensor per TDM and only 1 tracklet per TDM! Participant 1: sensor name Participant 2: Norad Id TDM ID and TrackletID are currently interchangeable

Request Body schema: application/json

TDM to add

tdm_id
string (Uuid) ^[a-f0-9]{8}(-[a-f0-9]{4}){4}[a-f0-9]{8}$

A Universally-Unique Identifier, as used by OKAPI:Orbits

required
object (GenericMeasurements)

Generic measurements encapsulated as strings.

Responses

Request samples

Content type
application/json
{
  • "tdm_id": "550e8400-e29b-11d4-a716-446655440000",
  • "tdm": {
    }
}

Response samples

Content type
application/json
{
  • "tdm_id": "550e8400-e29b-11d4-a716-446655440000",
  • "tdm": {
    },
  • "inserted": "2014-12-31T23:59:59.124Z",
  • "start_epoch": "2014-12-31T23:59:59.124Z",
  • "stop_epoch": "2014-12-31T23:59:59.124Z"
}

Get a TDM.

Get a TDM.

path Parameters
tdm_id
required
string^[a-f0-9]{8}(-[a-f0-9]{4}){4}[a-f0-9]{8}$

ID of a TDM

Responses

Response samples

Content type
application/json
{
  • "tdm_id": "550e8400-e29b-11d4-a716-446655440000",
  • "tdm": {
    },
  • "inserted": "2014-12-31T23:59:59.124Z",
  • "start_epoch": "2014-12-31T23:59:59.124Z",
  • "stop_epoch": "2014-12-31T23:59:59.124Z"
}

Filter and get OEMs by start / end date and tracklet_id

Filter and get OEMs by start / end date and tracklet_id

query Parameters
object

Filtering of OEMs by sensor FOV. This data is available for sensor defined in Aether sensor-systems collection.

object

ISO date string for date-filtering. It is necessary to end this string with a "Z" for UTC

tracklet_id
string^[a-f0-9]{8}(-[a-f0-9]{4}){4}[a-f0-9]{8}$

DB Tracklet Id

is_predicted
boolean

OEMs from propagation or from orbit determination

norad_id
string

Norad Id

cospar_id
string

The cospar_id filter from which the norad_id filter can be derived

orbit_type
string
Enum: "GEO" "geo" "IGO" "igo" "EGO" "ego" "NSO" "nso" "GTO" "gto" "MEO" "meo" "GHO" "gho" "LEO" "leo" "HAO" "hao" "MGO" "mgo" "HEO" "heo"

GEO: Geostationary Orbit| IGO: Inclined Geosynchronous Orbit| EGO: Extended Geostationary Orbit| NSO: Navigation Satellites Orbit| GTO: GEO Transfer Orbit| MEO: Medium Earth Orbit| GHO: GEO-superGEO Crossing Orbits| LEO: Low Earth Orbit| HAO: High Altitude Earth Orbit| MGO: MEO-GEO Crossing Orbits| HEO: Highly Eccentric Earth Orbit

object

inclination filter

object

period filter

object

eccentricity filter

object

periapsis filter

object

apoapsis filter

page
integer [ 1 .. 2147483647 ]
Default: 1

Page number

limit
integer [ 1 .. 1000 ]
Default: 20

Number of records per page

Responses

Response samples

Content type
application/json
{
  • "elements": [
    ]
}

Get a CCSDS OEM and its meta data

Returns a CCSDS OEM as JSON and its meta data

path Parameters
oem_id
required
string^[a-f0-9]{8}(-[a-f0-9]{4}){4}[a-f0-9]{8}$

ID of an OEM

Responses

Response samples

Content type
application/json
{
  • "oem_id": "550e8400-e29b-11d4-a716-446655440000",
  • "start_epoch": "2014-12-31T23:59:59.124Z",
  • "stop_epoch": "2014-12-31T23:59:59.124Z",
  • "is_predicted": false,
  • "norad_id": 0,
  • "oem": {
    },
  • "tracklet_ids": [
    ]
}

Get your saved sensor systems.

Get your saved sensor systems.

query Parameters
limit
string

Limits the number of results retrieved. The default limit is 20, the maximum is 1000.

Responses

Response samples

Content type
application/json
{
  • "elements": [
    ]
}

Add a sensor system to your saved sensor systems.

Add a sensor system to your saved sensor systems.

Request Body schema: application/json

Sensor system to add

sensor_system_id
string (Uuid) ^[a-f0-9]{8}(-[a-f0-9]{4}){4}[a-f0-9]{8}$

A Universally-Unique Identifier, as used by OKAPI:Orbits

required
object (GenericSensorSystem)

Generic sensor system definition.

Responses

Request samples

Content type
application/json
{
  • "sensor_system_id": "550e8400-e29b-11d4-a716-446655440000",
  • "sensor_system": {
    }
}

Response samples

Content type
application/json
{
  • "sensor_system_id": "550e8400-e29b-11d4-a716-446655440000",
  • "sensor_system": {
    }
}

Get your saved sensor system.

Get your saved sensor system.

path Parameters
sensor_system_id
required
string^[a-f0-9]{8}(-[a-f0-9]{4}){4}[a-f0-9]{8}$

ID of a sensor system

Responses

Response samples

Content type
application/json
{
  • "sensor_system_id": "550e8400-e29b-11d4-a716-446655440000",
  • "sensor_system": {
    }
}

Retrieve correlated objects norad ID

Retrieve the object that is most likely to be correlated with the observation.

path Parameters
request_id
required
string

request ID, identifying the request placed into the system.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "status": {
    }
}

internal

Add new sandbox data to an endpoint

This endpoint allows you to add new sandbox data to a specific endpoint and method.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "method": "get",
  • "data": "string",
  • "endpoint": "string"
}

List all endpoints

This endpoint allows you to retrieve all endpoints in a single call.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a specific sandbox endpoint

This endpoint allows you to retrieve a specific sandbox item.

path Parameters
sandboxId
required
string

ID of satellite

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "method": "get",
  • "data": "string",
  • "endpoint": "string"
}

Update sandbox endpoint

This endpoint allows you to update an existing sandbox endpoint identified by id.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "method": "get",
  • "data": "string",
  • "endpoint": "string"
}

Create a new joyride

This endpoint allows you to create a new joyride an steps.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "url": "string",
  • "steps": [
    ]
}

Retrieve existing joyrides

This endpoint allows you retrieve details and steps from existing joyrides.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get existing joyride

This endpoint allows you retrieve details and steps from a single joyride.

path Parameters
joyrideId
required
string

ID of satellite

query Parameters
identifier
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "url": "string",
  • "steps": [
    ]
}

Update existing joyride

This endpoint allows you update details and steps of a single joyride.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "url": "string",
  • "steps": [
    ]
}

gui

Get Landing Page Catalogue starting point

Get Landing Page Catalogue starting point.

Responses

Response samples

Content type
application/json
{
  • "elements": [
    ]
}

Get Landing Page Catalogue object

Get Landing Page Catalogue object.

path Parameters
norad_id
required
integer

Norad ID

Responses

Response samples

Content type
application/json
{
  • "CCSDS_OMM_VERS": "string",
  • "COMMENT": "string",
  • "CREATION_DATE": "string",
  • "ORIGINATOR": "string",
  • "OBJECT_NAME": "string",
  • "OBJECT_ID": "string",
  • "CENTER_NAME": "string",
  • "REF_FRAME": "string",
  • "TIME_SYSTEM": "string",
  • "MEAN_ELEMENT_THEORY": "string",
  • "EPOCH": "2014-12-31T23:59:59.124Z",
  • "MEAN_MOTION": "string",
  • "ECCENTRICITY": "string",
  • "INCLINATION": "string",
  • "RA_OF_ASC_NODE": "string",
  • "ARG_OF_PERICENTER": "string",
  • "MEAN_ANOMALY": "string",
  • "EPHEMERIS_TYPE": "string",
  • "CLASSIFICATION_TYPE": "string",
  • "NORAD_CAT_ID": "string",
  • "ELEMENT_SET_NO": "string",
  • "REV_AT_EPOCH": "string",
  • "BSTAR": "string",
  • "MEAN_MOTION_DOT": "string",
  • "MEAN_MOTION_DDOT": "string",
  • "SEMIMAJOR_AXIS": "string",
  • "PERIOD": "string",
  • "APOAPSIS": "string",
  • "PERIAPSIS": "string",
  • "OBJECT_TYPE": "string",
  • "RCS_SIZE": "string",
  • "COUNTRY_CODE": "string",
  • "LAUNCH_DATE": "string",
  • "SITE": "string",
  • "DECAY_DATE": "string",
  • "DECAYED": "string",
  • "FILE": "string",
  • "GP_ID": "string",
  • "TLE_LINE0": "string",
  • "TLE_LINE1": "string",
  • "TLE_LINE2": "string"
}