Skip to main content

​
Overview

The List supported satellites endpoint retrieves all satellites that are supported on Aurora. A successful request returns a list of satellites along with details like id, name, collections, bands etc. Authentication via API key is mandatory.

  • Method: GET
  • URL: /v0/satellites
  • Operation: Retrieve a list of supported satellites
  • Authentication Required: Yes

​
Authorization

You need the api key which you can get from the API tab in Workspace Settings. The api key is required in almost all the commands

Authorization: <YOUR_API_KEY>

​
Path Parameters

You don’t require any path parameters for this command.

​
Response

​
Successful Response – 200 OK

A 200 OK response from the List supported satellites endpoint indicates that the request was successful. It returns a list of satellites supported on Aurora with following fields:
FieldTypeDescription
idstringUnique identifier for the Satellite.
namestringName of the satellite.
collectionsstringDifferent set of collections available for a satellite( e.g., ["l2a", "l1c"]).
bandsarrayList of EO bands associated with the satellite (e.g., ["B01", "B02"]).
Below is the complete JSON response for listing all satellites using the List supported satellites endpoint.
200
{
    "satellites": [
        {
            "id": "string",
            "name": "string",
            "collections": [
                {
                    "id": "string",
                    "name": "string",
                    "provider": "string",
                    "rescale": [
                    ],
                    "queryables": [
                        "string",
                        "string"
                    ]
                }
            ],
            "bands": [
                {
                    "name": "string",
                    "wavelength": "number",
                    "scale": "number",
                    "spatial_resolution": "number"
                },
                {
                    "name": "string",
                    "wavelength": "number",
                    "scale": "number",
                    "spatial_resolution": "number"
                }
            ],
            "rgb_composite": {
                "blue": "string",
                "green": "string",
                "red": "string"
            }
        }
    ]
}
  • If you recieve a Not Found error (404) or the Internal Server Error (500), you will get the following response:
404 500
{
  "error": {
    "code": "string",
    "details": "any",
    "message": "string"
  }
}

​
How to use the endpoint

  1. Construct Your Request:
    Add your API key to the Authorization header.
  2. Send the Request:
    Make the GET request to https://api.pixxel.space/v0/satellites.
  3. Examine the Response:
    A successful 200 OK response returns a JSON object with a list of supported satellites and metadata. In case of errors you’ll receive a structured error message with details and status code.