GET
/
v0
/
aois
List all AOIs
curl --request GET \
  --url https://api.pixxel.space/v0/aois \
  --header 'Authorization: <api-key>'
{
  "aois": [
    {
      "aoi_id": "e9767554-550e-4464-a677-b8cf096073ab",
      "name": "AOI-Bangalore",
      "description": "This AOI contains images related to Bangalore",
      "lens_satellite_id": "ce5dcc14-8291-4b0c-a278-8c05ec426d22",
      "project_id": "ce5dcc14-8291-4b0c-a278-8c05ec426d18",
      "images": {},
      "eo_bands": [
        "B01",
        "B02",
        "B03"
      ],
      "geometry": {
        "coordinates": [
          [
            [
              123
            ]
          ]
        ],
        "type": "<string>"
      },
      "progress": 100,
      "status": "success",
      "is_favourite": false,
      "created_at": "2022-11-14 12:55:49.125928+00:00",
      "updated_at": "2022-11-14 12:55:49.125928+00:00",
      "user_id": "user-123456",
      "area_in_sq_m": 123456.78,
      "centroid": [
        77.55,
        12.95
      ]
    }
  ],
  "pagination": {
    "total": 100,
    "offset": 0,
    "limit": 10
  }
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
offset
integer
default:0

Offset for pagination

​
limit
integer
default:10

Limit for pagination

​
satellite_name
string

Filter by satellite name

​
created_at
string

Filter by creation date

​
updated_at
string

Filter by update date

​
aoi_id
string

Filter by AOI ID

​
aoi_name
string

Filter by AOI name

​
project_ids
string

Filter by project IDs (comma separated)

Response

200
application/json

OK

The response is of type object.