Get a catalog

GET

catalogs

{id}

curl --request GET \
  --url https://api.pixxel.space/v0/catalogs/{id} \
  --header 'Authorization: <api-key>'

{
  "area": 100,
  "bandset_id": "47435e2b-d8c4-41ff-9de9-2be3bfc92277",
  "created_at": "2024-05-27T06:50:20.056549Z",
  "created_by": "e31ab6f8-d359-4c6a-83c6-bfa32229bb01",
  "delivery_status": "SUCCESSFUL",
  "details": {
    "assets": {},
    "bbox": [
      123
    ],
    "collection": "<string>",
    "geometry": {
      "coordinates": [
        [
          [
            123
          ]
        ]
      ],
      "type": "Polygon"
    },
    "id": "<string>",
    "links": [
      {
        "href": "<string>",
        "rel": "<string>",
        "title": "<string>",
        "type": "<string>"
      }
    ],
    "properties": {
      "constellation": "<string>",
      "created": "<string>",
      "datetime": "<string>",
      "eo:cloud_cover": 123,
      "gsd": 123,
      "instruments": [
        "<string>"
      ],
      "platform": "<string>",
      "proj:epsg": 123,
      "proj:shape": [
        123
      ],
      "proj:transform": [
        123
      ],
      "proj:wkt2": "<string>",
      "sat:orbit_state": "<string>",
      "sat:relative_orbit": 123,
      "sci:doi": "<string>",
      "updated": "<string>",
      "view:off_nadir": 123,
      "view:satellite_look_angle": 123,
      "view:sun_azimuth": 123,
      "view:sun_elevation": 123
    },
    "stac_extensions": [
      "<any>"
    ],
    "stac_version": "<string>",
    "type": "<string>"
  },
  "id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276",
  "org_id": "e31ab6f8-d359-4c6a-83c6-bfa322 29bb01",
  "task_id": "e31ab6f8-d359-4c6a-83c6-bfa32229bb01",
  "updated_at": "2024-05-27T06:50:20.056549Z",
  "updated_by": "e31ab6f8-d359-4c6a-83c6-bfa32229bb01"
}

Authorizations

Authorization

string

header

required

Path Parameters

string

required

Catalog ID

Response

200

application/json

area

number

area of the catalog in sq. km

Example:

100

bandset_id

string

id of the bandset present in the catalog

Example:

"47435e2b-d8c4-41ff-9de9-2be3bfc92277"

created_at

string

timestamp of the creation of the catalog

Example:

"2024-05-27T06:50:20.056549Z"

created_by

string

uuid of the user who created the catalog

Example:

"e31ab6f8-d359-4c6a-83c6-bfa32229bb01"

delivery_status

enum<string>

status of the delivery of the catalog, in case automated delivery was enabled

Available options:

UNSPECIFIED,

CREATED,

FAILED,

IN_PROGRESS,

SUCCESS

Example:

"SUCCESSFUL"

details

object

STAC item info of the catalog

details.assets

object

details.bbox

number[]

bounding box of the STAC item

details.collection

string

details.geometry

object

details.id

string

id of the STAC item, also referred as item_id

details.links

object[]

details.properties

object

details.stac_extensions

any[]

list of extensions used in the STAC item

details.stac_version

string

version of the STAC standard used

details.type

string

type of the STAC item

string

id of the catalog

Example:

"47435e2b-d8c4-41ff-9de9-2be3bfc92276"

org_id

string

id of the organization to which the catalog belongs

Example:

"e31ab6f8-d359-4c6a-83c6-bfa322 29bb01"

task_id

string

id of the task, whose catalog this resource tracks

Example:

"e31ab6f8-d359-4c6a-83c6-bfa32229bb01"

updated_at

string

timestamp of the last update of the catalog

Example:

"2024-05-27T06:50:20.056549Z"

updated_by

string

uuid of the user who last updated the catalog

Example:

"e31ab6f8-d359-4c6a-83c6-bfa32229bb01"

List all orderItemsList of all order-items in the organization, the response is paginated.

curl --request GET \
  --url https://api.pixxel.space/v0/catalogs/{id} \
  --header 'Authorization: <api-key>'

{
  "area": 100,
  "bandset_id": "47435e2b-d8c4-41ff-9de9-2be3bfc92277",
  "created_at": "2024-05-27T06:50:20.056549Z",
  "created_by": "e31ab6f8-d359-4c6a-83c6-bfa32229bb01",
  "delivery_status": "SUCCESSFUL",
  "details": {
    "assets": {},
    "bbox": [
      123
    ],
    "collection": "<string>",
    "geometry": {
      "coordinates": [
        [
          [
            123
          ]
        ]
      ],
      "type": "Polygon"
    },
    "id": "<string>",
    "links": [
      {
        "href": "<string>",
        "rel": "<string>",
        "title": "<string>",
        "type": "<string>"
      }
    ],
    "properties": {
      "constellation": "<string>",
      "created": "<string>",
      "datetime": "<string>",
      "eo:cloud_cover": 123,
      "gsd": 123,
      "instruments": [
        "<string>"
      ],
      "platform": "<string>",
      "proj:epsg": 123,
      "proj:shape": [
        123
      ],
      "proj:transform": [
        123
      ],
      "proj:wkt2": "<string>",
      "sat:orbit_state": "<string>",
      "sat:relative_orbit": 123,
      "sci:doi": "<string>",
      "updated": "<string>",
      "view:off_nadir": 123,
      "view:satellite_look_angle": 123,
      "view:sun_azimuth": 123,
      "view:sun_elevation": 123
    },
    "stac_extensions": [
      "<any>"
    ],
    "stac_version": "<string>",
    "type": "<string>"
  },
  "id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276",
  "org_id": "e31ab6f8-d359-4c6a-83c6-bfa322 29bb01",
  "task_id": "e31ab6f8-d359-4c6a-83c6-bfa32229bb01",
  "updated_at": "2024-05-27T06:50:20.056549Z",
  "updated_by": "e31ab6f8-d359-4c6a-83c6-bfa32229bb01"
}

external

Archives

Bandset

Catalog

Order

Project

Report

Stores

Authorizations

Path Parameters

Response