Get item

GET

archives

collections

{cid}

items

{id}

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

{
  "assets": {},
  "bbox": [
    "172.91173669923782",
    "1.3438851951615003",
    "172.95469614953714",
    "1.3690476620161975"
  ],
  "collection": "simple-collection_2",
  "geometry": {
    "coordinates": [
      [
        [
          123
        ]
      ]
    ],
    "type": "Point"
  },
  "id": "20201211_223832_CS25",
  "links": [
    {
      "href": "https://example.com",
      "rel": "self",
      "title": "Example Link Title",
      "type": "application/json"
    }
  ],
  "properties": {
    "constellation": "Sentinel",
    "created": "2022-01-01T10:00:00Z",
    "datetime": "2022-06-15T12:00:00Z",
    "description": "Example description of the dataset",
    "enddatetime": "2022-12-31T23:59:59Z",
    "eo:cloud_cover": 23.5,
    "gsd": 10,
    "instruments": [
      "MSI",
      " TIRS"
    ],
    "license": "CC-BY-4.0",
    "mission": "Sentinel Mission",
    "platform": "Sentinel-2",
    "proj:epsg": 4326,
    "proj:reflectance_addition_factor": 0,
    "proj:reflectance_scaling_factor": 0.0001,
    "proj:shape": [
      10980,
      10980
    ],
    "proj:transform": [
      0,
      10,
      500000,
      0,
      -10,
      1000000
    ],
    "rd:anomalous_pixels": 0.01,
    "rd:earth_sun_distance": 1,
    "rd:product_level": "Level-2A",
    "rd:sat_id": "SAT-123",
    "rd:type": "Reflectance",
    "sci:doi": "10.1234/sci_doi",
    "startdatetime": "2022-01-01T00:00:00Z",
    "title": "Example Title",
    "updated": "2022-06-01T10:00:00Z",
    "view:altitude": 700,
    "view:off_nadir": 5,
    "view:satellite_look_angle": 30,
    "view:scene_center_lat": 12.3456,
    "view:scene_center_lon": -76.5432,
    "view:sun_azimuth": 135,
    "view:sun_elevation": 45
  },
  "stac_extensions": [
    "https://stac-extensions.github.io/eo/v1.0.0/schema.json",
    "https://stac-extensions.github.io/projection/v1.0.0/schema.json",
    "https://stac-extensions.github.io/view/v1.0.0/schema.json"
  ],
  "stac_version": "1.0.0",
  "type": "Feature"
}

Authorizations

Authorization

string

header

required

Path Parameters

cid

string

required

Collection ID

string

required

Item ID

Response

200

application/json

string

required

The unique identifier of the item

Example:

"20201211_223832_CS25"

assets

object

The assets of the item

assets.{key}

object

assets.{key}.eo:bands

object[]

The bands of the asset

assets.{key}.href

string

The HREF of the asset

Example:

"https://example.com/asset.tif"

assets.{key}.roles

string[]

The roles of the asset (e.g., "data", "metadata")

Example:

["data", "metadata"]

assets.{key}.title

string

A human-readable title for the asset

Example:

"Example Asset Title"

assets.{key}.type

string

The MIME type of the asset

Example:

"image/tiff"

bbox

string[]

The bounding box of the item

Example:

[
  "172.91173669923782",
  "1.3438851951615003",
  "172.95469614953714",
  "1.3690476620161975"
]

collection

string

The collection the item belongs to // The date and time the item was last updated

Example:

"simple-collection_2"

geometry

object

The geometry of the item

links

object[]

The links of the item

properties

object

The properties of the item

properties.constellation

string

The constellation name

Example:

"Sentinel"

properties.created

string

The date and time the item was created

Example:

"2022-01-01T10:00:00Z"

properties.datetime

string

Example:

"2022-06-15T12:00:00Z"

properties.description

string

A description of the item

Example:

"Example description of the dataset"

properties.enddatetime

string

Example:

"2022-12-31T23:59:59Z"

properties.eo:cloud_cover

number

The percentage of the image covered by clouds

Example:

23.5

properties.gsd

number

The ground sample distance in meters

Example:

10

properties.instruments

string[]

The instruments used

Example:

["MSI", " TIRS"]

properties.license

string

The license of the item

Example:

"CC-BY-4.0"

properties.mission

string

The mission name

Example:

"Sentinel Mission"

properties.platform

string

The platform name

Example:

"Sentinel-2"

properties.proj:epsg

integer

The EPSG code of the projection

Example:

4326

properties.proj:reflectance_addition_factor

number

The addition factor for reflectance values

Example:

0

properties.proj:reflectance_scaling_factor

number

The scaling factor for reflectance values

Example:

0.0001

properties.proj:shape

integer[]

The shape of the projection

Example:

[10980, 10980]

properties.proj:transform

number[]

the affine transform coefficients

Example:

[0, 10, 500000, 0, -10, 1000000]

properties.rd:anomalous_pixels

number

The percentage of anomalous pixels

Example:

0.01

properties.rd:earth_sun_distance

number

The distance between the Earth and the Sun

Example:

1

properties.rd:product_level

string

The product level

Example:

"Level-2A"

properties.rd:sat_id

string

The satellite ID

Example:

"SAT-123"

properties.rd:type

string

The type of radiometric data

Example:

"Reflectance"

properties.sci:doi

string

The DOI of the scientific publication

Example:

"10.1234/sci_doi"

properties.startdatetime

string

Example:

"2022-01-01T00:00:00Z"

properties.title

string

The title of the item

Example:

"Example Title"

properties.updated

string

The date and time the item was last updated

Example:

"2022-06-01T10:00:00Z"

properties.view:altitude

number

The altitude of the sensor in meters

Example:

700

properties.view:off_nadir

number

The angle between the sensor and the vertical

Example:

5

properties.view:satellite_look_angle

number

The angle between the sensor and the nadir

Example:

30

properties.view:scene_center_lat

number

The latitude of the center of the scene

Example:

12.3456

properties.view:scene_center_lon

number

The longitude of the center of the scene

Example:

-76.5432

properties.view:sun_azimuth

number

The angle between the sun and the north

Example:

135

properties.view:sun_elevation

number

The angle between the sun and the horizon

Example:

45

stac_extensions

string[]

The extensions used in the item

Example:

[
  "https://stac-extensions.github.io/eo/v1.0.0/schema.json",
  "https://stac-extensions.github.io/projection/v1.0.0/schema.json",
  "https://stac-extensions.github.io/view/v1.0.0/schema.json"
]

stac_version

string

The version of the STAC specification

Example:

"1.0.0"

type

string

The type of the item

Example:

"Feature"

Search all itemsSearch for STAC items according to attributes of the item

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

{
  "assets": {},
  "bbox": [
    "172.91173669923782",
    "1.3438851951615003",
    "172.95469614953714",
    "1.3690476620161975"
  ],
  "collection": "simple-collection_2",
  "geometry": {
    "coordinates": [
      [
        [
          123
        ]
      ]
    ],
    "type": "Point"
  },
  "id": "20201211_223832_CS25",
  "links": [
    {
      "href": "https://example.com",
      "rel": "self",
      "title": "Example Link Title",
      "type": "application/json"
    }
  ],
  "properties": {
    "constellation": "Sentinel",
    "created": "2022-01-01T10:00:00Z",
    "datetime": "2022-06-15T12:00:00Z",
    "description": "Example description of the dataset",
    "enddatetime": "2022-12-31T23:59:59Z",
    "eo:cloud_cover": 23.5,
    "gsd": 10,
    "instruments": [
      "MSI",
      " TIRS"
    ],
    "license": "CC-BY-4.0",
    "mission": "Sentinel Mission",
    "platform": "Sentinel-2",
    "proj:epsg": 4326,
    "proj:reflectance_addition_factor": 0,
    "proj:reflectance_scaling_factor": 0.0001,
    "proj:shape": [
      10980,
      10980
    ],
    "proj:transform": [
      0,
      10,
      500000,
      0,
      -10,
      1000000
    ],
    "rd:anomalous_pixels": 0.01,
    "rd:earth_sun_distance": 1,
    "rd:product_level": "Level-2A",
    "rd:sat_id": "SAT-123",
    "rd:type": "Reflectance",
    "sci:doi": "10.1234/sci_doi",
    "startdatetime": "2022-01-01T00:00:00Z",
    "title": "Example Title",
    "updated": "2022-06-01T10:00:00Z",
    "view:altitude": 700,
    "view:off_nadir": 5,
    "view:satellite_look_angle": 30,
    "view:scene_center_lat": 12.3456,
    "view:scene_center_lon": -76.5432,
    "view:sun_azimuth": 135,
    "view:sun_elevation": 45
  },
  "stac_extensions": [
    "https://stac-extensions.github.io/eo/v1.0.0/schema.json",
    "https://stac-extensions.github.io/projection/v1.0.0/schema.json",
    "https://stac-extensions.github.io/view/v1.0.0/schema.json"
  ],
  "stac_version": "1.0.0",
  "type": "Feature"
}

external

Archives

Bandset

Catalog

Order

Project

Report

Stores

Authorizations

Path Parameters

Response