Queries

Raster Pixel Info

get

Get a single pixel value at a given pixel location.

Path parameters
dataset_version_idstringRequired
lonnumberRequired
latnumberRequired
Query parameters
api_keystringRequired
variablestringRequired

Variable to retrieve

zoomany ofOptional

Viewer's zoom level. If specified, searches for the pixel value within a small radius around the given lon/lat. Defaults to None, which means exact matching only.

integerOptional
or
nullOptional
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_idstringRequired
lonnumberRequired
latnumberRequired
dimstringRequired
Query parameters
api_keystringRequired
variablestringRequired

Variable to retrieve

zoomany ofOptional

Viewer's zoom level. If specified, searches for the pixel value within a small radius around the given lon/lat. Defaults to None, which means exact matching only.

integerOptional
or
nullOptional
pageintegerOptional

Page number. Results are limited to 500 per page. Defaults to 0.

Default: 0
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
  ],
  "page_size": 500
}

Vector Point Query

get
Path parameters
dataset_version_idstringRequired
lonnumberRequired
latnumberRequired
Query parameters
api_keystringRequired
zoomany ofOptional

Viewer's zoom level. If specified, searches for the pixel value within a small radius around the given lon/lat. Defaults to None, which means exact matching only.

integerOptional
or
nullOptional
include_area_in_square_metersbooleanOptional

Whether to include the area of the features in square meters. If this is true, the response will contain a 'area_m2' field for each feature in Mollweide projection (ESRI:54009). If 'area_m2' column already exists in the dataset, this query will fail.

Default: false
pageintegerOptional

Page number. Results are limited to 500 per page. Defaults to 0.

Default: 0
Responses
200

Successful Response

application/json
get
GET /v1/vector/{dataset_version_id}/point/{lon}/{lat}?api_key=text HTTP/1.1
Host: 
Accept: */*

{
  "feature_collection": {
    "bbox": [],
    "type": "text",
    "features": [
      {
        "bbox": [],
        "type": "text",
        "geometry": {
          "bbox": [],
          "type": "text",
          "coordinates": []
        },
        "properties": {},
        "id": 1
      }
    ]
  },
  "page_size": 500
}
PreviousTilesNextModels