Help: COVE API User's Guide: Constellations

Constellations is a subset of Coincident Calculator. Separate endpoints are associated constellations using archived or forecasted missions. Users may send requests for retrieving a constellations list or creating constellations.

Constellations throttle limits:
  • POST: 15 requests per hour
  • GET: 120 requests per hour

For use with forecasted missions

 

Retrieve forecasted constellations list

Lists all custom forecasted constellations in Coincident Calculator in COVE for the user.

Request Method: GET

Request URL:
https://ceos-cove.org/en/api/v1_2/coincident_calculator/forecasted/constellations/

URL Parameters: None

Response Example:
{
"constellations": {
"Landsat 7/8": {
"missions": [
"Landsat 7 – ETM",
"Landsat 8 – TIRS"
],
"custom_missions": []
},
"CBERS4_SatA": {
"missions": [
"CBERS-4 – MUXCam"
],
"custom_missions": [
"SatA – BeamA"
]
}
}
}
 

Create constellation

Create a constellation from existing forecasted missions and/or custom mission.

 
Task Input Parameters for Coincident Calculator (Forecasted):
Parameter Name Data Type Required Description
constellation String Yes Name of constellation
custom_missions CustomMissionsFilter[] No
Available custom missions may be found by submitting a COVE API request for the custom missions list.
 
Refer to Special Data Types for more information on CustomMissionsFilter.
missions MissionsFilter[] No
Valid missions may be found by submitting a COVE API request for the forecasted missions list.
 
Refer to Special Data Types for more information on MissionsFilter.
 
Request Data Example:
{
"name": "SatGroup",
"custom_missions": [
{
"mission”: "SatA",
"instrument": "BeamA"
}
],
"missions": [
{
"mission": "Sentinel-1A",
"instrument": "C-SAR",
"mode": "IWS"
},
],
}
 

Request Method: POST

Request URL:
https://ceos-cove.org/en/api/v1_2/coincident_calculator/forecasted/constellations/

URL Parameters: None

Response Examples:
Example successful response:
{"status": 200, "message": "Constellation created successfully"}
 
Failed Response Examples:
{"status": 400, "message": ""}
{"status": 417, "message": ""}

For use with archived missions

 

Retrieve archived constellations list

Lists all custom archived constellations in Coincident Calculator in COVE for the user.

Request Method: GET

Request URL:
https://ceos-cove.org/en/api/v1_2/coincident_calculator/archived/constellations/

URL Parameters: None

Response Example:
{
"constellations": {
"L7/8": [
"Landsat 7 – ETM",
"Landsat 8 – OLI/TIRS"
],
"S1": [
"Sentinel-1A - C-SAR – EW",
"Sentinel-1A - C-SAR – IWS",
"Sentinel-1A - C-SAR – SM",
"Sentinel-1A - C-SAR – WV",
"Sentinel-1B - C-SAR – EW",
"Sentinel-1B - C-SAR – IWS",
"Sentinel-1B - C-SAR – SM",
"Sentinel-1B - C-SAR – WV"
]
}
}
 

Create constellation

Create a constellation from existing archived missions.
 
Task Input Parameters for Coincident Calculator (Archived):
Parameter Name Data Type Required Description
constellation String Yes Name of constellation
missions MissionsFilter[] No
Valid missions may be found by submitting a COVE API request for the archived missions list.
 
Refer to Special Data Types for more information on MissionsFilter.
 
Request Data Example:
{
"name": "SatGroup",
"missions": [
{
"mission": "Sentinel-1A",
"instrument": "C-SAR",
"mode": "IWS"
},
{
"mission": "Sentinel-2A",
"instrument": "MSI",
"mode": ""
},
],
}
 

Request Method: POST

Request URL:
https://ceos-cove.org/en/api/v1_2/coincident_calculator/archived/constellations/

URL Parameters: None

Response Examples:
Example successful response:
{"status": 200, "message": "Constellation created successfully"}
 
Failed Response Examples:
{"status": 400, "message": ""}
{"status": 417, "message": ""}
 

Example API requests using curl

Request forecasted custom constellations list:
curl -H "Accept: application/json; indent=4" -u username:password https://ceos-cove.org/en/api/coincident_calculator/forecasted/constellations/
 
Create forecasted custom constellation:
curl -H "Content-Type: application/json" -X POST -u username:password -d '{"name": "SatGroup - F", "custom_missions": [], "missions": [{"mission": "Sentinel-1A", "instrument": "C-SAR", "mode": "IWS"},{"mission": "Sentinel-2A", "instrument": "MSI"}]' https://ceos-cove.org/en/api/coincident_calculator/forecasted/constellations/
 
Request archived custom constellations list:
curl -H "Accept: application/json; indent=4" -u username:password https://ceos-cove.org/en/api/coincident_calculator/archived/constellations/
 
Create archived custom constellation:
curl -H "Content-Type: application/json" -X POST -u username:password -d '{"name": "SatGroup - A", "missions": [{"mission": "Sentinel-1A", "instrument": "C-SAR", "mode": "IWS"},{"mission": "Sentinel-2A", "instrument": "MSI"}]' https://ceos-cove.org/en/api/coincident_calculator/archived/constellations/