Queries

Raster Pixel Info

get

Get a single pixel value at a given pixel location.

Path parameters
dataset_version_idstring · uuidRequired

Unique identifier for the dataset version

lonnumberRequired
latnumberRequired
Query parameters
api_keyany ofRequired
stringOptional
or
nullOptional
variablestringRequired

Variable to retrieve

dimidxany ofOptional

Dimension indices in format 'dimension:index'. Can be specified multiple times for multiple dimensions.

string[]Optional
or
nullOptional
Responses
200
Successful Response
application/json
get
GET /v1/raster/{dataset_version_id}/pixels/{lon}/{lat}?api_key=text&variable=text HTTP/1.1
Host: 
Accept: */*
{
  "dimension_selection": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "value": 1
}

Raster Pixel Info Series

get

Get all pixel values for a given dimension and pixel location.

Path parameters
dataset_version_idstring · uuidRequired

Unique identifier for the dataset version

lonnumberRequired
latnumberRequired
dimstringRequired

Dimension for which all values will be returned. E.g. if dim is 'time', then all 'time' values for the given pixel and dimidx selection will be returned. dim can only be a dimension that's been optimized for, otherwise a 400 error is returned. All keys in dimidx together with dim need to specify all extra dimension of the dataset.

Query parameters
api_keyany ofRequired
stringOptional
or
nullOptional
variablestringRequired

Variable to retrieve

dimidxany ofOptional

Dimension indices in format 'dimension:index'. Can be specified multiple times for multiple dimensions.

string[]Optional
or
nullOptional
Responses
200
Successful Response
application/json
get
GET /v1/raster/{dataset_version_id}/pixels/{lon}/{lat}/{dim}?api_key=text&variable=text HTTP/1.1
Host: 
Accept: */*
{
  "dimension": "text",
  "dimension_selection": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "values": [
    1
  ]
}