Mosaic Collections Wmts - Get Capabilities Xml

Service:
Planetary Computer
API Version:
2026-04-15

Collection Wmts
OGC WMTS endpoint for a STAC collection.

GET {endpoint}/data/mosaic/collections/{collectionId}/WMTSCapabilities.xml?api-version=2026-04-15
With optional parameters: 
GET {endpoint}/data/mosaic/collections/{collectionId}/WMTSCapabilities.xml?api-version=2026-04-15&ids={ids}&bbox={bbox}&query={query}&sortby={sortby}&datetime={datetime}&TileMatrixSetId={TileMatrixSetId}&tile_format={tile_format}&tile_scale={tile_scale}&minzoom={minzoom}&maxzoom={maxzoom}&bidx={bidx}&assets={assets}&expression={expression}&asset_bidx={asset_bidx}&asset_as_band={asset_as_band}&nodata={nodata}&unscale={unscale}&reproject={reproject}

URI Parameters

Name In Required Type Description
collectionId
 path True

string

maxLength: 500
pattern: .*

STAC Collection Identifier
endpoint
 path True

string (uri)

GeoCatalog endpoint, e.g. https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com
api-version
 query True

string

minLength: 1

The API version to use for this operation.
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.
bbox
 query

string

Bounding box (west, south, east, north).
bidx
 query

integer[]

Dataset band indexes
datetime
 query

string

Datetime filter expression (single datetime or range using / separator).
expression
 query

string

Band math expression between assets
ids
 query

string

Array of Item ids.
maxzoom
 query

integer (int32)

Overwrite default maxzoom.
minzoom
 query

integer (int32)

Overwrite default minzoom.
nodata
 query

string

Overwrite internal Nodata value
query
 query

string

JSON query expression for filtering items.
reproject
 query

WarpKernelResampling

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

string

Sorting expression (e.g. +/-property).
tile_format
 query

TilerImageFormat

Output image type. Default is png.
tile_scale
 query

integer (int32)

Tile scale factor affecting output size. Values > 1 produce larger tiles (e.g., 1=256x256, 2=512x512).
TileMatrixSetId
 query

TileMatrixSetId

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

boolean

Apply internal Scale or Offset

Responses

Name Type Description
200 OK

file

Successful Response

Media Types: "application/xml", "application/json"
Other Status Codes

Azure.Core.Foundations.ErrorResponse

An unexpected error response.

Media Types: "application/xml", "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

MosaicCollectionsWmts_GetCapabilitiesXml

Sample request

GET {endpoint}/data/mosaic/collections/naip-atl/WMTSCapabilities.xml?api-version=2026-04-15&ids=item-id-1,item-id-2&bbox=-180,-90,180,90&query={}&sortby=-datetime

Sample response

Status code:
200 
"<?xml version=\"1.0\" encoding=\"UTF-8\"?><Capabilities/>"

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.
TileMatrixSetId

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

Standard identifier for a coordinate reference system and tiling scheme used for serving map tiles
TilerImageFormat

Image format specifier for tile and image requests
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.

TileMatrixSetId

Enumeration

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

Standard identifier for a coordinate reference system and tiling scheme used for serving map tiles

Value Description
CanadianNAD83_LCC

Canadian NAD83 Lambert Conformal Conic projection tile matrix set
EuropeanETRS89_LAEAQuad

European ETRS89 Lambert Azimuthal Equal Area Quad tile matrix set
LINZAntarticaMapTilegrid

Land Information New Zealand (LINZ) Antarctica Map tile grid matrix set
NZTM2000Quad

New Zealand Transverse Mercator 2000 Quad tile matrix set
UPSAntarcticWGS84Quad

Universal Polar Stereographic Antarctic WGS84 Quad tile matrix set
UPSArcticWGS84Quad

Universal Polar Stereographic Arctic WGS84 Quad tile matrix set
UTM31WGS84Quad

Universal Transverse Mercator Zone 31 WGS84 Quad tile matrix set
WGS1984Quad

WGS 1984 Quad tile matrix set
WebMercatorQuad

Web Mercator Quad tile matrix set
WorldCRS84Quad

World CRS84 Quad tile matrix set
WorldMercatorWGS84Quad

World Mercator WGS84 Quad tile matrix set

TilerImageFormat

Enumeration

Image format specifier for tile and image requests

Value Description
png

Portable Network Graphics format - supports transparency
npy

NumPy array format for raw data access
tif

GeoTIFF format for georeferenced raster data
jpeg

JPEG format - smaller file size but lossy compression
jpg

Alternate extension for JPEG format
jp2

JPEG 2000 format - supports both lossy and lossless compression
webp

WebP format - modern image format with good compression
pngraw

Raw PNG format for access to unprocessed data

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