Tiles

Raster Tile

get
Path parameters
dataset_version_idstringRequired
zintegerRequired
xintegerRequired
yintegerRequired
formatstring · enumRequiredPossible values:
Query parameters
api_keystringRequired
variablesstring[]Optional

List of variable names to retrieve. Use one variable for single-band visualization or exactly three variables for RGB visualization

Default: []
colormap_nameany ofOptional

Name of the colormap to apply to the data (only for single-band visualization)

string · enumOptionalPossible values:
or
nullOptional
reverse_colormapbooleanOptional

Whether to reverse the colormap (only for single-band visualization)

Default: false
losslessany ofOptional

Whether to use lossless compression to return the image data.

Support depends on the image format:

  • WEBP: lossless and lossy
  • PNG: lossless
  • JPEG: lossy

Defaults to true for PNG and WEBP formats, and false for JPEG.

booleanOptional
or
nullOptional
dimidxany ofOptional

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

string[]Optional
or
nullOptional
rescaleany ofOptional

Rescale values in format 'min,max'. Can be specified multiple times for multiple variables. If there is only one pair, it will be used for all variables. Can either be a single pair, or a pair for each variable.

string[]Optional
or
nullOptional
color_binany ofOptional

value:color pair, specified multiple times, in order (only for single-band visualization). Value must be a number, color any HTML color value (red, #FF0000, etc.).Values below each threshold are assigned the given color, in-order.

string[]Optional
or
nullOptional
nodataany ofOptional

Nodata values in format 'variable_name:value1,value2,...'. Can be specified multiple times for multiple variables. Each value should be a float or int.

string[]Optional
or
nullOptional
threshold_minany ofOptional

Minimum threshold values. Can be specified multiple times for multiple variables. If there is only one value, it will be used for all variables. Can either be a single value, or a value for each variable.

string[]Optional
or
nullOptional
threshold_maxany ofOptional

Maximum threshold values. Can be specified multiple times for multiple variables. If there is only one value, it will be used for all variables. Can either be a single value, or a value for each variable.

string[]Optional
or
nullOptional
Responses
200
Successful Response
application/json
Responseany
get
GET /v1/raster/{dataset_version_id}/tiles/{z}/{x}/{y}.{format}?api_key=text HTTP/1.1
Host: 
Accept: */*

No content

Vector Tile

get
Path parameters
dataset_version_idstringRequired
zintegerRequired
xintegerRequired
yintegerRequired
Query parameters
api_keystringRequired
Responses
200
Successful Response
application/json
Responseany
get
GET /v1/vector/{dataset_version_id}/tiles/{z}/{x}/{y}.mvt?api_key=text HTTP/1.1
Host: 
Accept: */*

No content