Sign in

v2

latestSwagger 2.02026-07-131451441001.2 KB
Tiles for STAC Items

Item Bbox

Create an image from part of a STAC item dataset (bounding box crop).

get/data/mosaic/collections/{collectionId}/items/{itemId}/bbox/{minx},{miny},{maxx},{maxy}.{format}

Path parameters

collectionIdstring required

STAC Collection Identifier

itemIdstring required

STAC Item Identifier

minxnumber float required

Bounding box min X

minynumber float required

Bounding box min Y

maxxnumber float required

Bounding box max X

maxynumber float required

Bounding box max Y

formatstring required

Output format for the tile or image (e.g., png, jpeg, webp)

Query parameters

api-versionstring required

The API version to use for this operation.

bidxinteger[]

Dataset band indexes

assetsstring[]

Asset's names.

expressionstring

Band math expression between assets

asset_bidxstring[]

Per asset band indexes (coma separated indexes, e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image")

asset_as_bandboolean

Asset as Band

nodatastring

Overwrite internal Nodata value

unscaleboolean

Apply internal Scale or Offset

reproject'nearest' | 'bilinear' | 'cubic' | 'cubic_spline' | 'lanczos' | 'average' | 'mode' | 'max' | 'min' | 'med' | 'q1' | 'q3' | 'sum' | 'rms'

WarpKernel resampling algorithm (only used when doing re-projection). Defaults to nearest.

algorithm'hillshade' | 'contours' | 'normalizedIndex' | 'terrarium' | 'terrainrgb' | 'slope' | 'cast' | 'ceil' | 'floor' | 'min' | 'max' | 'median' | 'mean' | 'std' | 'var'

Terrain algorithm name

algorithm_paramsstring

Terrain algorithm parameters

color_formulastring

rio-color formula (info: https://github.com/mapbox/rio-color)

coord_crsstring

Coordinate Reference System of the input coords. Default to epsg:4326.

dst_crsstring

Output Coordinate Reference System.

resampling'nearest' | 'bilinear' | 'cubic' | 'cubic_spline' | 'lanczos' | 'average' | 'mode' | 'gauss' | 'rms'

Resampling method.

max_sizeinteger

Image output size limit if width and height limits are not set.

heightinteger

Height in pixels for the output image

widthinteger

Width in pixels for the output image

rescalestring[]

comma (',') delimited Min,Max range. Can set multiple time for multiple bands.

colormap_name'accent' | 'accent_r' | 'afmhot' | 'afmhot_r' | 'ai4g-lulc' | 'alos-fnf' | 'alos-palsar-mask' | 'autumn' | 'autumn_r' | 'binary' | 'binary_r' | 'blues' | 'blues_r' | 'bone' | 'bone_r' | 'brbg' | 'brbg_r' | 'brg' | 'brg_r' | 'bugn' | 'bugn_r' | 'bupu' | 'bupu_r' | 'bwr' | 'bwr_r' | 'c-cap' | 'cfastie' | 'chesapeake-lc-13' | 'chesapeake-lc-7' | 'chesapeake-lu' | 'chloris-biomass' | 'cividis' | 'cividis_r' | 'cmrmap' | 'cmrmap_r' | 'cool' | 'cool_r' | 'coolwarm' | 'coolwarm_r' | 'copper' | 'copper_r' | 'cubehelix' | 'cubehelix_r' | 'dark2' | 'dark2_r' | 'drcog-lulc' | 'esa-cci-lc' | 'esa-worldcover' | 'flag' | 'flag_r' | 'gap-lulc' | 'gist_earth' | 'gist_earth_r' | 'gist_gray' | 'gist_gray_r' | 'gist_heat' | 'gist_heat_r' | 'gist_ncar' | 'gist_ncar_r' | 'gist_rainbow' | 'gist_rainbow_r' | 'gist_stern' | 'gist_stern_r' | 'gist_yarg' | 'gist_yarg_r' | 'gnbu' | 'gnbu_r' | 'gnuplot' | 'gnuplot2' | 'gnuplot2_r' | 'gnuplot_r' | 'gray' | 'gray_r' | 'greens' | 'greens_r' | 'greys' | 'greys_r' | 'hot' | 'hot_r' | 'hsv' | 'hsv_r' | 'inferno' | 'inferno_r' | 'io-bii' | 'io-lulc' | 'io-lulc-9-class' | 'jet' | 'jet_r' | 'jrc-change' | 'jrc-extent' | 'jrc-occurrence' | 'jrc-recurrence' | 'jrc-seasonality' | 'jrc-transitions' | 'lidar-classification' | 'lidar-hag' | 'lidar-hag-alternative' | 'lidar-intensity' | 'lidar-returns' | 'magma' | 'magma_r' | 'modis-10A1' | 'modis-10A2' | 'modis-13A1|Q1' | 'modis-14A1|A2' | 'modis-15A2H|A3H' | 'modis-16A3GF-ET' | 'modis-16A3GF-PET' | 'modis-17A2H|A2HGF' | 'modis-17A3HGF' | 'modis-64A1' | 'mtbs-severity' | 'nipy_spectral' | 'nipy_spectral_r' | 'nrcan-lulc' | 'ocean' | 'ocean_r' | 'oranges' | 'oranges_r' | 'orrd' | 'orrd_r' | 'paired' | 'paired_r' | 'pastel1' | 'pastel1_r' | 'pastel2' | 'pastel2_r' | 'pink' | 'pink_r' | 'piyg' | 'piyg_r' | 'plasma' | 'plasma_r' | 'prgn' | 'prgn_r' | 'prism' | 'prism_r' | 'pubu' | 'pubu_r' | 'pubugn' | 'pubugn_r' | 'puor' | 'puor_r' | 'purd' | 'purd_r' | 'purples' | 'purples_r' | 'qpe' | 'rainbow' | 'rainbow_r' | 'rdbu' | 'rdbu_r' | 'rdgy' | 'rdgy_r' | 'rdpu' | 'rdpu_r' | 'rdylbu' | 'rdylbu_r' | 'rdylgn' | 'rdylgn_r' | 'reds' | 'reds_r' | 'rplumbo' | 'schwarzwald' | 'seismic' | 'seismic_r' | 'set1' | 'set1_r' | 'set2' | 'set2_r' | 'set3' | 'set3_r' | 'spectral' | 'spectral_r' | 'spring' | 'spring_r' | 'summer' | 'summer_r' | 'tab10' | 'tab10_r' | 'tab20' | 'tab20_r' | 'tab20b' | 'tab20b_r' | 'tab20c' | 'tab20c_r' | 'terrain' | 'terrain_r' | 'twilight' | 'twilight_r' | 'twilight_shifted' | 'twilight_shifted_r' | 'usda-cdl' | 'usda-cdl-corn' | 'usda-cdl-cotton' | 'usda-cdl-soybeans' | 'usda-cdl-wheat' | 'usgs-lcmap' | 'viirs-10a1' | 'viirs-13a1' | 'viirs-14a1' | 'viirs-15a2H' | 'viridis' | 'viridis_r' | 'winter' | 'winter_r' | 'wistia' | 'wistia_r' | 'ylgn' | 'ylgn_r' | 'ylgnbu' | 'ylgnbu_r' | 'ylorbr' | 'ylorbr_r' | 'ylorrd' | 'ylorrd_r' | 'algae' | 'algae_r' | 'amp' | 'amp_r' | 'balance' | 'balance_r' | 'curl' | 'curl_r' | 'deep' | 'deep_r' | 'delta' | 'delta_r' | 'dense' | 'dense_r' | 'diff' | 'diff_r' | 'haline' | 'haline_r' | 'ice' | 'ice_r' | 'matter' | 'matter_r' | 'oxy' | 'oxy_r' | 'phase' | 'phase_r' | 'rain' | 'rain_r' | 'solar' | 'solar_r' | 'speed' | 'speed_r' | 'tarn' | 'tarn_r' | 'tempo' | 'tempo_r' | 'thermal' | 'thermal_r' | 'topo' | 'topo_r' | 'turbid' | 'turbid_r' | 'turbo' | 'turbo_r'

Colormap name

colormapstring

JSON encoded custom Colormap

return_maskboolean

Add mask to the output data.

subdataset_namestring

The name of a subdataset within the asset.

subdataset_bandsinteger[]

The index of a subdataset band within the asset.

crsstring

Coordinate Reference System.

datetimestring

Datetime to use for subsetting the asset.

selstring[]

Xarray Indexing using dimension names {dimension}={value}.

sel_method'nearest' | 'linear' | 'bilinear' | 'cubic' | 'cubic_spline' | 'lanczos' | 'area' | 'mode'

Xarray indexing method to use for inexact matches.

Response

Return an image.

string binary required