Mosaic Searches Tile Matrix Sets Format - Get Zxy By Format

Service:

Planetary Computer

API Version:

2026-04-15

Searches Tile Tilematrixsetid Format
Create map tile (with TileMatrixSetId and format, without scale).

GET {endpoint}/data/mosaic/searches/{searchId}/tiles/{tileMatrixSetId}/{z}/{x}/{y}.{format}?api-version=2026-04-15

With optional parameters:

GET {endpoint}/data/mosaic/searches/{searchId}/tiles/{tileMatrixSetId}/{z}/{x}/{y}.{format}?api-version=2026-04-15&bidx={bidx}&assets={assets}&expression={expression}&asset_bidx={asset_bidx}&asset_as_band={asset_as_band}&nodata={nodata}&unscale={unscale}&reproject={reproject}&scan_limit={scan_limit}&items_limit={items_limit}&time_limit={time_limit}&exitwhenfull={exitwhenfull}&skipcovered={skipcovered}&subdataset_name={subdataset_name}&subdataset_bands={subdataset_bands}&crs={crs}&datetime={datetime}&sel={sel}&sel_method={sel_method}&algorithm={algorithm}&algorithm_params={algorithm_params}&scale={scale}&buffer={buffer}&color_formula={color_formula}&collection={collection}&resampling={resampling}&pixel_selection={pixel_selection}&rescale={rescale}&colormap_name={colormap_name}&colormap={colormap}&return_mask={return_mask}&padding={padding}

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string (uri)	GeoCatalog endpoint, e.g. https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com
format	path	True	string maxLength: 500 pattern: .*	Output format for the tile or image (e.g., png, jpeg, webp)
searchId	path	True	string maxLength: 500 pattern: .*	Search Id (pgSTAC Search Hash)
tileMatrixSetId	path	True	string maxLength: 500 pattern: .*	Identifier selecting one of the TileMatrixSetId supported
x	path	True	number (float)	Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix.
y	path	True	number (float)	Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix.
z	path	True	number (float)	Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.
api-version	query	True	string minLength: 1	The API version to use for this operation.
algorithm	query		TerrainAlgorithm	Terrain algorithm name
algorithm_params	query		string	Terrain algorithm parameters
asset_as_band	query		boolean	Asset as Band
asset_bidx	query		string[]	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")
assets	query		string[]	Asset's names.
bidx	query		integer[]	Dataset band indexes
buffer	query		number (float)	Buffer on each side of the given tile. It must be a multiple of 0.5. Output tilesize will be expanded to tilesize + 2 * buffer (e.g 0.5 = 257x257, 1.0 = 258x258).
collection	query		string	STAC Collection ID
color_formula	query		string	rio-color formula (info: https://github.com/mapbox/rio-color)
colormap	query		string	JSON encoded custom Colormap
colormap_name	query		ColorMapNames	Colormap name
crs	query		string	Coordinate Reference System.
datetime	query		string	Datetime to use for subsetting the asset.
exitwhenfull	query		boolean	Return as soon as the geometry is fully covered (defaults to True).
expression	query		string	Band math expression between assets
items_limit	query		integer (int32)	Return as soon as we have N items per geometry (defaults to 100).
nodata	query		string	Overwrite internal Nodata value
padding	query		integer (int32)	Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to 0.
pixel_selection	query		PixelSelection	Pixel selection method.
reproject	query		WarpKernelResampling	WarpKernel resampling algorithm (only used when doing re-projection). Defaults to nearest.
resampling	query		Resampling	Resampling method.
rescale	query		string[]	comma (',') delimited Min,Max range. Can set multiple time for multiple bands.
return_mask	query		boolean	Add mask to the output data.
scale	query		integer (int32)	Numeric scale factor for the tile. Higher values produce larger tiles
scan_limit	query		integer (int32)	Return as soon as we scan N items (defaults to 10000).
sel	query		string[]	Xarray Indexing using dimension names {dimension}={value}.
sel_method	query		SelMethod	Xarray indexing method to use for inexact matches.
skipcovered	query		boolean	Skip any items that would show up completely under the previous items (defaults to True).
subdataset_bands	query		integer[]	The index of a subdataset band within the asset.
subdataset_name	query		string	The name of a subdataset within the asset.
time_limit	query		integer (int32)	Return after N seconds to avoid long requests (defaults to 5).
unscale	query		boolean	Apply internal Scale or Offset

Responses

Name	Type	Description
200 OK	file	Return an image. Media Types: "image/png", "image/jpeg", "image/jpg", "image/webp", "image/jp2", "image/tiff; application=geotiff", "application/x-binary", "application/json"
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Media Types: "image/png", "image/jpeg", "image/jpg", "image/webp", "image/jp2", "image/tiff; application=geotiff", "application/x-binary", "application/json" Headers x-ms-error-code: string

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://geocatalog.spatio.azure.com/.default

Examples

MosaicSearchesTileMatrixSetsFormat_GetZxyByFormat

Sample request

HTTP

GET {endpoint}/data/mosaic/searches/ba13fc7947b9b585690d84ee61aaa653/tiles/WebMercatorQuad/13/2174/3282.png?api-version=2026-04-15&bidx=1&bidx=2&bidx=3&assets=image&asset_bidx=image|1,2,3&reproject=nearest&crs=epsg:4326&datetime=2024-01-01T00:00:00Z&sel=band=1&sel_method=nearest&scale=1&collection=naip-atl&padding=2

Sample response

Status code:

200

"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="

Definitions

Name	Description
Azure.Core.Foundations.Error	The error object.
Azure.Core.Foundations.ErrorResponse	A response containing error details.
Azure.Core.Foundations.InnerError	An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.
ColorMapNames	Available color maps for data visualization
PixelSelection	Identifier selecting one of the TileMatrixSetId supported (default: 'WebMercatorQuad') Represents the method used to select or compute pixels when creating composites from multiple sources
Resampling	Resampling algorithm to use when reading source raster data at different resolutions
SelMethod	Xarray indexing method to use for inexact matches
TerrainAlgorithm	Supported algorithms for terrain and index-based analysis
WarpKernelResampling	WarpKernel resampling algorithm used when doing re-projection. Defaults to nearest.

Azure.Core.Foundations.Error

Object

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

Azure.Core.Foundations.ErrorResponse

Object

A response containing error details.

Name	Type	Description
error	Azure.Core.Foundations.Error	The error object.

Azure.Core.Foundations.InnerError

Object

An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	Azure.Core.Foundations.InnerError	Inner error.

ColorMapNames

Enumeration

Available color maps for data visualization

Value	Description
accent	Accent colormap - qualitative colormap with distinct colors
accent_r	Reversed accent colormap
afmhot	Afmhot colormap - sequential black-red-yellow-white colormap
afmhot_r	Reversed afmhot colormap
ai4g-lulc	AI for Good land use/land cover colormap
alos-fnf	ALOS forest/non-forest colormap
alos-palsar-mask	ALOS PALSAR mask colormap
autumn	Autumn colormap - sequential red-orange-yellow colormap
autumn_r	Reversed autumn colormap
binary	Binary colormap - simple black and white colormap
binary_r	Reversed binary colormap
blues	Blues colormap - sequential white to dark blue
blues_r	Reversed blues colormap
bone	Bone colormap - grayscale with slight blue tint
bone_r	Reversed bone colormap
brbg	BrBG colormap - diverging brown to blue-green
brbg_r	Reversed BrBG colormap
brg	BrG colormap - diverging brown to green
brg_r	Reversed BrG colormap
bugn	BuGn colormap - sequential white to dark green
bugn_r	Reversed BuGn colormap
bupu	BuPu colormap - sequential white to dark purple
bupu_r	Reversed BuPu colormap
bwr	BWR colormap - diverging blue to red
bwr_r	Reversed BWR colormap
c-cap	C-CAP colormap - land cover classification
cfastie	Cfastie colormap - high contrast colormap
chesapeake-lc-13	Chesapeake land cover 13-class colormap
chesapeake-lc-7	Chesapeake land cover 7-class colormap
chesapeake-lu	Chesapeake land use colormap
chloris-biomass	Chloris biomass colormap
cividis	Cividis colormap - sequential yellow to blue
cividis_r	Reversed cividis colormap
cmrmap	CMRmap colormap - perceptually uniform colormap
cmrmap_r	Reversed CMRmap colormap
cool	Cool colormap - sequential cyan to magenta
cool_r	Reversed cool colormap
coolwarm	Coolwarm colormap - diverging blue to red
coolwarm_r	Reversed coolwarm colormap
copper	Copper colormap - sequential black to copper
copper_r	Reversed copper colormap
cubehelix	Cubehelix colormap - sequential black to white with hue rotation
cubehelix_r	Reversed cubehelix colormap
dark2	Dark2 colormap - qualitative colormap with distinct colors
dark2_r	Reversed dark2 colormap
drcog-lulc	DRCog land use/land cover colormap
esa-cci-lc	ESA CCI land cover colormap
esa-worldcover	ESA WorldCover colormap
flag	Flag colormap - qualitative colormap with distinct colors
flag_r	Reversed flag colormap
gap-lulc	GAP land use/land cover colormap
gist_earth	Gist_earth colormap - perceptually uniform colormap
gist_earth_r	Reversed gist_earth colormap
gist_gray	Gist_gray colormap - grayscale colormap
gist_gray_r	Reversed gist_gray colormap
gist_heat	Gist_heat colormap - sequential black-red-yellow-white colormap
gist_heat_r	Reversed gist_heat colormap
gist_ncar	Gist_ncar colormap - perceptually uniform colormap
gist_ncar_r	Reversed gist_ncar colormap
gist_rainbow	Gist_rainbow colormap - perceptually uniform colormap
gist_rainbow_r	Reversed gist_rainbow colormap
gist_stern	Gist_stern colormap - perceptually uniform colormap
gist_stern_r	Reversed gist_stern colormap
gist_yarg	Gist_yarg colormap - grayscale colormap
gist_yarg_r	Reversed gist_yarg colormap
gnbu	GnBu colormap - sequential white to dark blue-green
gnbu_r	Reversed GnBu colormap
gnuplot	Gnuplot colormap - sequential black to white with hue rotation
gnuplot2	Gnuplot2 colormap - sequential black to white with hue rotation
gnuplot2_r	Reversed gnuplot2 colormap
gnuplot_r	Reversed gnuplot colormap
gray	Gray colormap - grayscale colormap
gray_r	Reversed gray colormap
greens	Greens colormap - sequential white to dark green
greens_r	Reversed greens colormap
greys	Greys colormap - sequential white to dark gray
greys_r	Reversed greys colormap
hot	Hot colormap - sequential black-red-yellow-white colormap
hot_r	Reversed hot colormap
hsv	HSV colormap - hue-saturation-value colormap
hsv_r	Reversed HSV colormap
inferno	Inferno colormap - sequential black to yellow colormap
inferno_r	Reversed inferno colormap
io-bii	IO-BII colormap - biodiversity index colormap
io-lulc	IO-LULC colormap - land use/land cover colormap
io-lulc-9-class	IO-LULC 9-class colormap
jet	Jet colormap - sequential blue-green-yellow-red colormap
jet_r	Reversed jet colormap
jrc-change	JRC change colormap
jrc-extent	JRC extent colormap
jrc-occurrence	JRC occurrence colormap
jrc-recurrence	JRC recurrence colormap
jrc-seasonality	JRC seasonality colormap
jrc-transitions	JRC transitions colormap
lidar-classification	Lidar classification colormap
lidar-hag	Lidar height above ground colormap
lidar-hag-alternative	Alternative lidar height above ground colormap
lidar-intensity	Lidar intensity colormap
lidar-returns	Lidar returns colormap
magma	Magma colormap - sequential black to yellow colormap
magma_r	Reversed magma colormap
modis-10A1	MODIS 10A1 colormap
modis-10A2	MODIS 10A2 colormap
modis-13A1|Q1	MODIS 13A1|Q1 colormap
modis-14A1|A2	MODIS 14A1|A2 colormap
modis-15A2H|A3H	MODIS 15A2H|A3H colormap
modis-16A3GF-ET	MODIS 16A3GF-ET colormap
modis-16A3GF-PET	MODIS 16A3GF-PET colormap
modis-17A2H|A2HGF	MODIS 17A2H|A2HGF colormap
modis-17A3HGF	MODIS 17A3HGF colormap
modis-64A1	MODIS 64A1 colormap
mtbs-severity	MTBS severity colormap
nipy_spectral	Nipy_spectral colormap - perceptually uniform colormap
nipy_spectral_r	Reversed nipy_spectral colormap
nrcan-lulc	NRCAN land use/land cover colormap
ocean	Ocean colormap - sequential blue to white colormap
ocean_r	Reversed ocean colormap
oranges	Oranges colormap - sequential white to dark orange
oranges_r	Reversed oranges colormap
orrd	OrRd colormap - sequential white to dark red-orange
orrd_r	Reversed OrRd colormap
paired	Paired colormap - qualitative colormap with distinct colors
paired_r	Reversed paired colormap
pastel1	Pastel1 colormap - qualitative colormap with pastel colors
pastel1_r	Reversed pastel1 colormap
pastel2	Pastel2 colormap - qualitative colormap with pastel colors
pastel2_r	Reversed pastel2 colormap
pink	Pink colormap - sequential white to dark pink
pink_r	Reversed pink colormap
piyg	PiYG colormap - diverging pink to green
piyg_r	Reversed PiYG colormap
plasma	Plasma colormap - sequential black to yellow colormap
plasma_r	Reversed plasma colormap
prgn	PRGn colormap - diverging purple to green
prgn_r	Reversed PRGn colormap
prism	Prism colormap - qualitative colormap with distinct colors
prism_r	Reversed prism colormap
pubu	PuBu colormap - sequential white to dark blue
pubu_r	Reversed PuBu colormap
pubugn	PuBuGn colormap - sequential white to dark blue-green
pubugn_r	Reversed PuBuGn colormap
puor	PuOr colormap - diverging purple to orange
puor_r	Reversed PuOr colormap
purd	PuRd colormap - sequential white to dark purple-red
purd_r	Reversed PuRd colormap
purples	Purples colormap - sequential white to dark purple
purples_r	Reversed purples colormap
qpe	QPE colormap - qualitative colormap with distinct colors
rainbow	Rainbow colormap - qualitative colormap with distinct colors
rainbow_r	Reversed rainbow colormap
rdbu	RdBu colormap - diverging red to blue
rdbu_r	Reversed RdBu colormap
rdgy	RdGy colormap - diverging red to gray
rdgy_r	Reversed RdGy colormap
rdpu	RdPu colormap - sequential white to dark red-purple
rdpu_r	Reversed RdPu colormap
rdylbu	RdYlBu colormap - diverging red to yellow to blue
rdylbu_r	Reversed RdYlBu colormap
rdylgn	RdYlGn colormap - diverging red to yellow to green
rdylgn_r	Reversed RdYlGn colormap
reds	Reds colormap - sequential white to dark red
reds_r	Reversed reds colormap
rplumbo	Rplumbo colormap - qualitative colormap with distinct colors
schwarzwald	Schwarzwald colormap - qualitative colormap with distinct colors
seismic	Seismic colormap - diverging blue to red
seismic_r	Reversed seismic colormap
set1	Set1 colormap - qualitative colormap with distinct colors
set1_r	Reversed set1 colormap
set2	Set2 colormap - qualitative colormap with distinct colors
set2_r	Reversed set2 colormap
set3	Set3 colormap - qualitative colormap with distinct colors
set3_r	Reversed set3 colormap
spectral	Spectral colormap - diverging red to yellow to blue
spectral_r	Reversed spectral colormap
spring	Spring colormap - sequential magenta to yellow
spring_r	Reversed spring colormap
summer	Summer colormap - sequential green to yellow
summer_r	Reversed summer colormap
tab10	Tab10 colormap - qualitative colormap with distinct colors
tab10_r	Reversed tab10 colormap
tab20	Tab20 colormap - qualitative colormap with distinct colors
tab20_r	Reversed tab20 colormap
tab20b	Tab20b colormap - qualitative colormap with distinct colors
tab20b_r	Reversed tab20b colormap
tab20c	Tab20c colormap - qualitative colormap with distinct colors
tab20c_r	Reversed tab20c colormap
terrain	Terrain colormap - sequential black to white with hue rotation
terrain_r	Reversed terrain colormap
twilight	Twilight colormap - diverging blue to red
twilight_r	Reversed twilight colormap
twilight_shifted	Twilight shifted colormap - diverging blue to red
twilight_shifted_r	Reversed twilight shifted colormap
usda-cdl	USDA CDL colormap - land cover classification
usda-cdl-corn	USDA CDL corn colormap
usda-cdl-cotton	USDA CDL cotton colormap
usda-cdl-soybeans	USDA CDL soybeans colormap
usda-cdl-wheat	USDA CDL wheat colormap
usgs-lcmap	USGS LCMAP colormap
viirs-10a1	VIIRS 10A1 colormap
viirs-13a1	VIIRS 13A1 colormap
viirs-14a1	VIIRS 14A1 colormap
viirs-15a2H	VIIRS 15A2H colormap
viridis	Viridis colormap - sequential black to yellow colormap
viridis_r	Reversed viridis colormap
winter	Winter colormap - sequential blue to green
winter_r	Reversed winter colormap
wistia	Wistia colormap - sequential white to yellow
wistia_r	Reversed wistia colormap
ylgn	YlGn colormap - sequential white to dark green
ylgn_r	Reversed YlGn colormap
ylgnbu	YlGnBu colormap - sequential white to dark blue-green
ylgnbu_r	Reversed YlGnBu colormap
ylorbr	YlOrBr colormap - sequential white to dark orange-brown
ylorbr_r	Reversed YlOrBr colormap
ylorrd	YlOrRd colormap - sequential white to dark red-orange
ylorrd_r	Reversed YlOrRd colormap
algae	Algae colormap - sequential green colormap for ocean data
algae_r	Reversed algae colormap
amp	Amp colormap - sequential magenta colormap for ocean data
amp_r	Reversed amp colormap
balance	Balance colormap - diverging blue to red for ocean data
balance_r	Reversed balance colormap
curl	Curl colormap - diverging teal to red for ocean data
curl_r	Reversed curl colormap
deep	Deep colormap - sequential blue colormap for ocean data
deep_r	Reversed deep colormap
delta	Delta colormap - diverging blue to green for ocean data
delta_r	Reversed delta colormap
dense	Dense colormap - sequential purple colormap for ocean data
dense_r	Reversed dense colormap
diff	Diff colormap - diverging colormap for difference data
diff_r	Reversed diff colormap
haline	Haline colormap - sequential blue to yellow for salinity data
haline_r	Reversed haline colormap
ice	Ice colormap - sequential blue colormap for ice data
ice_r	Reversed ice colormap
matter	Matter colormap - sequential yellow to brown for ocean data
matter_r	Reversed matter colormap
oxy	Oxy colormap - diverging colormap for oxygen data
oxy_r	Reversed oxy colormap
phase	Phase colormap - circular colormap for phase data
phase_r	Reversed phase colormap
rain	Rain colormap - sequential colormap for precipitation data
rain_r	Reversed rain colormap
solar	Solar colormap - sequential colormap for solar radiation data
solar_r	Reversed solar colormap
speed	Speed colormap - sequential colormap for velocity data
speed_r	Reversed speed colormap
tarn	Tarn colormap - sequential colormap for topographic data
tarn_r	Reversed tarn colormap
tempo	Tempo colormap - sequential colormap for temporal data
tempo_r	Reversed tempo colormap
thermal	Thermal colormap - sequential colormap for temperature data
thermal_r	Reversed thermal colormap
topo	Topo colormap - sequential colormap for topographic data
topo_r	Reversed topo colormap
turbid	Turbid colormap - sequential colormap for turbidity data
turbid_r	Reversed turbid colormap
turbo	Turbo colormap - improved rainbow colormap
turbo_r	Reversed turbo colormap

PixelSelection

Enumeration

Identifier selecting one of the TileMatrixSetId supported (default: 'WebMercatorQuad')

Represents the method used to select or compute pixels when creating composites from multiple sources

Value	Description
first	Select pixel from the first available image
highest	Select pixel with the highest value
lowest	Select pixel with the lowest value
mean	Calculate mean of available pixels
median	Calculate median of available pixels
stdev	Calculate standard deviation of available pixels
lastbandlow	Select image with lowest value in the last band
lastbandhigh	Select image with highest value in the last band
count	Count available pixels across sources

Resampling

Enumeration

Resampling algorithm to use when reading source raster data at different resolutions

Value	Description
nearest	Nearest neighbor - fastest method that selects the closest pixel value
bilinear	Bilinear interpolation - calculates output values using a weighted average of 2x2 input cells
cubic	Cubic interpolation - uses a weighted average of 4x4 input cells for smoother results
cubic_spline	Cubic spline interpolation - similar to cubic but preserves edges better
lanczos	Lanczos windowed sinc resampling - high-quality with minimal artifacts
average	Average resampling - calculates the mean of all contributing pixels
mode	Mode resampling - selects the most common value from contributing pixels
gauss	Gaussian weighted resampling - applies a gaussian weighting to contributing pixels
rms	Root mean square resampling - useful for resampling error or deviation grids

SelMethod

Enumeration

Xarray indexing method to use for inexact matches

Value	Description
nearest	Nearest neighbor method
linear	Linear interpolation
bilinear	Bilinear interpolation
cubic	Cubic interpolation
cubic_spline	Cubic spline interpolation
lanczos	Lanczos interpolation
area	Area-weighted interpolation
mode	Mode (most common) value

TerrainAlgorithm

Enumeration

Supported algorithms for terrain and index-based analysis

Value	Description
hillshade	Creates hillshade visualization from elevation data
contours	Generates elevation contour lines
normalizedIndex	Calculates normalized difference index between bands
terrarium	Encodes elevation data in Mapbox Terrarium RGB format
terrainrgb	Encodes elevation data in Mapbox TerrainRGB format
slope	Calculates slope from elevation data
cast	Casts data to a different type
ceil	Rounds values up to the nearest integer
floor	Rounds values down to the nearest integer
min	Computes the minimum value across bands
max	Computes the maximum value across bands
median	Computes the median value across bands
mean	Computes the mean value across bands
std	Computes the standard deviation across bands
var	Computes the variance across bands

WarpKernelResampling

Enumeration

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

Value	Description
nearest	Nearest neighbor
bilinear	Bilinear interpolation
cubic	Cubic interpolation
cubic_spline	Cubic spline interpolation
lanczos	Lanczos windowed sinc resampling
average	Average resampling
mode	Mode resampling
max	Maximum value resampling
min	Minimum value resampling
med	Median value resampling
q1	First quartile resampling
q3	Third quartile resampling
sum	Sum resampling
rms	Root mean square resampling