Help: COVE API User's Guide: Utilities

Utilities is a collection of calculators to provide users with a means of estimating various parameters of interest about CEOS satellite missions. There are two collections of calculators in utilities repeating orbit and swath calculators. Repeating orbit calculators available are ground track interval, period/velocity, and sun synchronous orbit. Swath calculators available are incidence to pointing, fov from swath width, swath width from fov, swath from incidence, and swath/off-nadir.

Revisits Calculator throttle limits:
  • GET: 120 requests per minute

Repeating Orbit

 

Ground Track Interval

Request Method: GET
 
Request URL:
https://ceos-cove.org/en/api/v1_2/utilities/repeating_orbit/ground_track_interval/
 
URL Parameters:
Parameter Name Data Type Required Description
altitude Float Yes Range: 200 to 1500
days_to_repeat Float Yes Greater than 0
latitude Float Yes Range: 0 to 90
revs_to_repeat Float No
Greater than 0;
Calculated if not provided.
 
Response Examples:
{
"altitude": 800.0,
"days_to_repeat": 16.0,
"latitude": 0.0,
"revs_to_repeat": 228.0,
"fundamental_interval_deg_long": 25.2632,
"fundamental_interval_km": 2812.3,
"subinterval_deg_long": 1.5789,
"subinterval_km": 175.8
}
 

Period/Velocity

Request Method: GET
 
Request URL:
https://ceos-cove.org/en/api/v1_2/utilities/repeating_orbit/period_velocity/
 
URL Parameters:
Parameter Name Data Type Required Description
altitude Float Yes Range: 200 to 1500
 
Response Examples:
{
"altitude": 800.0,
"period": 100.87,
"velocity": 7.45
}
 

Sun Synchronous Orbit

Request Method: GET
 
Request URL:
https://ceos-cove.org/en/api/v1_2/utilities/repeating_orbit/sun_synchronous_orbit/
 
URL Parameters:
Parameter Name Data Type Required Description
altitude Float Yes Range: 200 to 1500
revs_to_repeat Float Yes
Greater than 0;
Calculated if not provided.
days_to_repeat Float No Greater than 0
 
Response Examples:
{
"altitude": 800.0,
"revs_to_repeat": 16.0,
"days_to_repeat": 1.0,
"estimated_altitude": 268.1315,
"estimated_inclination": 96.5607
}
 

Swath Calculator

 

Incidence To Pointing

Request Method: GET
 
Request URL:
https://ceos-cove.org/en/api/v1_2/utilities/repeating_orbit/incidence_to_pointing/
 
URL Parameters:
Parameter Name Data Type Required Description
altitude Float Yes Range: 200 to 1500
incidence_angle Float Yes Range: 0 to 90
 
Response Examples:
{
"altitude": 800.0,
"incidence_angle": 15.0,
"off_nadir_angle": 13.3
}
 

FOV from Swath Width

Request Method: GET
 
Request URL:
https://ceos-cove.org/en/api/v1_2/utilities/repeating_orbit/fov_from_swath_width/
 
URL Parameters:
Parameter Name Data Type Required Description
altitude Float Yes Range: 200 to 1500
swath_width Float Yes Greater than 0
 
Response Examples:
{
"altitude": 800.0,
"swath_width": 210.9,
"fov": 15.0,
"half_fov": 7.5
}
 

Swath Width from FOV

Request Method: GET
 
Request URL:
https://ceos-cove.org/en/api/v1_2/utilities/repeating_orbit/swath_width_from_fov/
 
URL Parameters:
Parameter Name Data Type Required Description
altitude Float Yes Range: 200 to 1500
fov Float Yes Range: 0 to 140
 
Response Examples:
{
"altitude": 400.0,
"swath_width": 105.4,
"fov": 15.0,
"half_fov": 7.5
}
 
Failed Response Examples:
{"status": 400, "message": "math domain error"}
 

Swath From Incidence

Request Method: GET
 
Request URL:
https://ceos-cove.org/en/api/v1_2/utilities/repeating_orbit/swath_from_incidence/
 
URL Parameters:
Parameter Name Data Type Required Description
altitude Float Yes Range: 200 to 1500
min_incidence_angle Float Yes Range: 0 to 90
max_incidence_angle Float Yes Range: 0 to 90
 
Response Examples:
{
"altitude": 800.0,
"min_incidence_angle": 0.0,
"max_incidence_angle": 16.0,
"off_nadir_angle": 7.09,
"fov": 14.177,
"half_fov": 7.088,
"swath_width": 202.94
}
 

Swath/Off-Nadir

Request Method: GET
 
Request URL:
https://ceos-cove.org/en/api/v1_2/utilities/repeating_orbit/swath_off_nadir/
 
URL Parameters:
Parameter Name Data Type Required Description
altitude Float Yes Range: 200 to 1500
off_nadir_angle Float Yes Range: 0 to 90
fov Float Yes Range: 0 to 90
 
Response Examples:
{
"altitude": 800.0,
"off_nadir_angle": 25.0,
"fov": 5.0,
"swath_width": 88.93
}
 

Example API requests using curl

Calculator: Repeating Orbit: Ground Track Interval:
curl -H "Accept: application/json; indent=4" -u username:password https://ceos-cove.org/en/api/utilities/repeating_orbit/ground_track_interval/?altitude=<ALTITUDE>&days_to_repeat=<DAYS TO REPEAT>&latitude=<LATITUDE>&revs_to_repeat=<REVOLUTIONS TO REPEAT>
 
Calculator: Repeating Orbit: Period/Velocity:
curl -H "Accept: application/json; indent=4" -u username:password https://ceos-cove.org/en/api/utilities/repeating_orbit/period_velocity/?altitude=<ALTITUDE>
 
Calculator: Repeating Orbit: Sun Synchronous Orbit:
curl -H "Accept: application/json; indent=4" -u username:password https://ceos-cove.org/en/api/utilities/repeating_orbit/sun_synchronous_orbit/?altitude=<ALTITUDE>&revs_to_repeat=<REVOLUTIONS TO REPEAT>&days_to_repeat=<DAYS TO REPEAT>
 
Calculator: Swath Calculator: Incidence To Pointing:
curl -H "Accept: application/json; indent=4" -u username:password https://ceos-cove.org/en/api/utilities/swath_calculator/incidence_to_pointing/?altitude=<ALTITUDE>&incidence_angle=<INCIDENCE ANGLE>
 
Calculator: Swath Calculator: FOV From Swath Width:
curl -H "Accept: application/json; indent=4" -u username:password https://ceos-cove.org/en/api/utilities/swath_calculator/fov_from_swath_width/?altitude=<ALTITUDE>&swath_width=<SWATH WIDTH>
 
Calculator: Swath Calculator: Swath Width From FOV:
curl -H "Accept: application/json; indent=4" -u username:password https://ceos-cove.org/en/api/utilities/swath_calculator/swath_width_from_fov/?altitude=<ALTITUDE>&fov=<FOV>
 
Calculator: Swath Calculator: Swath From Incidence:
curl -H "Accept: application/json; indent=4" -u username:password https://ceos-cove.org/en/api/utilities/swath_calculator/swath_from_incidence/?altitude=<ALTITUDE>&min_incidence_angle=<MINIMUM INCIDENCE ANGLE>&max_incidence_angle=<MAXIMUM INCIDENCE ANGLE>
 
Calculator: Swath Calculator: Swath/Off-Nadir:
curl -H "Accept: application/json; indent=4" -u username:password https://ceos-cove.org/en/api/utilities/swath_calculator/swath_off_nadir/?altitude=<ALTITUDE>&off_nadir_angle=<OFF-NADIR ANGLE>&fov=<FOV>