Get raster

Description

Retrieves raster for a given extent

Endpoint

/path/{pathId}/raster/timestamp/{timestampId}/rasterByExtent

Method

GET

Access Level Rules

Minimum Access Level

view for visual and view+ when applyStyle is set to false

Processing Units

Minimum processing units

2

Parameters

Name
Description
Required
Default

pathId

The id of the raster layer.

true

timestampId

The id of the timestamp to get the raster for.

true

extent

A JSON with properties "xMin", "xMax", "yMin" and "yMax" denotating the bounds of the image. The bounds need to be in epsg 3857.

true

width

Integer for the width of the image in pixels. Maximum of 2048.

true

height

Integer for the height of the image in pixels. Maximum of 2048.

true

bands

Array of integers containing the bands for which to retrieve data.

false

style

An id of a style to apply or an object describing a valid style. If not given original raster values are returned. Valid object for style can be found here: https://docs.ellipsis-drive.com/developers/api-v3/path-raster/styles/add-style

false

Default null.

mask

A GeoJSON geometry of type polygon or multiPolygon in WGS84 to apply as mask.

false

Default null.

applyStyle

Boolean indicating whether to style the tile. If true a PNG is returned if false the style is ignored and a tiff file is returned instead.

false

Default true.

Last updated