Documentation Powered by Redocly

OKAPI API (2022-04 / Curiosity)

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": {
    }
}

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.

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[ items non-empty ]

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

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).

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.

propulsion_type
string
Default: "continuous"
Enum: "impulsive" "continuous"
accepted_collision_probability
number [ 0 .. 1 ]
Default: 0.0001

Accepted collision probability

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
string
Default: "short_term_and_long_term"
Value: "short_term_and_long_term"

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

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.

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,
  • "propulsion_type": "continuous",
  • "accepted_collision_probability": 0.0001,
  • "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": "short_term_and_long_term",
  • "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": {
    },
  • "notification_verbosity": "observe"
}

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,
  • "in_sun_constraint": true,
  • "min_time_in_sun": 900,
  • "symmetric_manoeuvres": false,
  • "propulsion_type": "continuous",
  • "accepted_collision_probability": 0.0001,
  • "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": "short_term_and_long_term",
  • "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": {
    },
  • "notification_verbosity": "observe"
}

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,
  • "in_sun_constraint": true,
  • "min_time_in_sun": 900,
  • "symmetric_manoeuvres": false,
  • "propulsion_type": "continuous",
  • "accepted_collision_probability": 0.0001,
  • "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": "short_term_and_long_term",
  • "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": {
    },
  • "notification_verbosity": "observe"
}

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[ items non-empty ]

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

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).

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.

propulsion_type
string
Default: "continuous"
Enum: "impulsive" "continuous"
accepted_collision_probability
number [ 0 .. 1 ]
Default: 0.0001

Accepted collision probability

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
string
Default: "short_term_and_long_term"
Value: "short_term_and_long_term"

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

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.

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,
  • "propulsion_type": "continuous",
  • "accepted_collision_probability": 0.0001,
  • "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": "short_term_and_long_term",
  • "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": {
    },
  • "notification_verbosity": "observe"
}

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,
  • "in_sun_constraint": true,
  • "min_time_in_sun": 900,
  • "symmetric_manoeuvres": false,
  • "propulsion_type": "continuous",
  • "accepted_collision_probability": 0.0001,
  • "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": "short_term_and_long_term",
  • "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": {
    },
  • "notification_verbosity": "observe"
}

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,
  • "in_sun_constraint": true,
  • "min_time_in_sun": 900,
  • "symmetric_manoeuvres": false,
  • "propulsion_type": "continuous",
  • "accepted_collision_probability": 0.0001,
  • "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": "short_term_and_long_term",
  • "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": {
    },
  • "notification_verbosity": "observe"
}

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
}

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

Set the field to sort by.

tcaStart
string

ISO date string for start of date-filtering.

tcaEnd
string

ISO date string for end of date-filtering.

sandbox
boolean

Enable or disable sandbox responses.

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

Filter results by criticality.

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

Exclude fields from result to reduce payload and complexity.

Responses

Response samples

Content type
application/json
{
  • "elements": [
    ],
  • "has_more": true,
  • "total_count": 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
sandbox
boolean

Enable or disable sandbox responses.

Responses

Response samples

Content type
application/json
{
  • "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": [
    ]
}

Get graphs 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

limit
number [ 1 .. 1000 ]
Default: 10

The limit of risk predictions returned in the response.

start
string <date-time>

The creation date of the prediction to start the limit from.

Responses

Response samples

Content type
application/json
{
  • "elements": [
    ],
  • "totalCount": 0,
  • "next": "string",
  • "previous": "string"
}

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 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.

Responses

Request samples

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

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": {
    }
}

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": {
    }
}

Correlate observed object with catalog object

Submits a request for an observation correlation.

Request Body schema: application/json

Observation, sensor definition, correlation settings

required
object (GenericSimpleObservation)

A genric simple observation.

required
object (GenericGroundLocation)

A genric ground location.

object (GenericCorrelationSettings)

GenericCorrelationSettings

Responses

Request samples

Content type
application/json
{
  • "observation": {
    },
  • "location": {
    },
  • "correlation_settings": {
    }
}

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 (ObjectId)

Object identifier with the option of using OKAPI Id, NORAD Id or DISCOS Id.

object (GenericOrbitDeterminationOrbit)

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

required
object (GenericMeasurements)

Generic measurements encapsulated as strings.

Array of objects (GenericSensorSystem) [ items ]
object (GenericOrbitDeterminationSettings)

Generic orbit determination settings

object (GenericSharedPropagationSettings)

Generic propagator settings as used by multiple propagators.

Responses

Request samples

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

Response samples

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

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": {
    }
}

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 an arbitrary orbit propagator with different orbit formats: Opm, a simple state vector or TLE.

required
object (GenericGroundLocation)

A genric 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 an arbitrary orbit propagator with different orbit formats: Opm, a simple state vector or TLE.

required
object (GenericGroundLocation)

A genric 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 an arbitrary orbit propagator with different orbit formats: Opm, a simple state vector or TLE.

required
object (GenericGroundLocation)

A genric 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 an arbitrary orbit propagator with different orbit formats: Opm, a simple state vector or TLE.

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 Orekit's numerical propagator

Submits a propagation request with Orekit's numerical 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 an arbitrary orbit propagator with different orbit formats: Opm, a simple state vector or TLE.

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 an arbitrary orbit propagator with different orbit formats: Opm, a simple state vector or TLE.

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 an arbitrary orbit propagator with different orbit formats: Opm, a simple state vector or TLE.

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": {
    }
}

Rerieve 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": {
    },
  • "status": {
    }
}

Rerieve 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": {
    },
  • "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.

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": {
    }
}

Rerieve NEPTUNE propgation result as CCSDS OEM

Retrieve the propagation result as a CCSDS formated OEM. Covariances are currently not avaiable, but will come 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
}

Rerieve NEPTUNE propgation result as CCSDS OEM

Retrieve the propagation result as a CCSDS formated OEM. Covariances are currently not avaiable, but will come 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
}

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 Orekit propgation result as CCSDS OEM

Retrieve the propagation result as a CCSDS formated OEM. Covariances are currently not avaiable, but will come 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
}

Rerieve Orekit propgation result as CCSDS OEM

Retrieve the propagation result as a CCSDS formated OEM. Covariances are currently not avaiable, but will come 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 Orekit 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
}

Rerieve Orekit 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 Orekit 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 Orekit 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
}

Get your saved TDMs.

Get your saved TDMs.

Responses

Response samples

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

Add a TDM to your saved TDMs.

Add a TDM to your saved TDMs.

Request Body schema: application/json

TDM to add

required
object

Responses

Request samples

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

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
{
  • "correlations": [
    ],
  • "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.

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.

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": "string",
  • "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"
}