Sign in

v5

latestSwagger 2.02026-07-13914107.7 KB

Use to request map tiles in vector or raster format.

The Get Map Tiles API enables users to request map tiles in either vector or raster formats, typically for integration into a map control or SDK. Supported tile types include Azure Maps road tiles and real-time Weather Radar tiles. By default, the Azure Maps Web SDK uses vector tiles for rendering its web map control.

[!Important]

When using the Get Map Tile API, you must also call the Get Map Attribution API to retrieve the required map data attribution text.

The returned attribution must be displayed wherever tiles retrieved from Get Map Tile are rendered, including in third-party map controls or custom rendering implementations.

get/map/tile

Query parameters

api-versionstring required

The API version to use for this operation.

tilesetId'microsoft.base' | 'microsoft.base.labels' | 'microsoft.base.hybrid' | 'microsoft.terra.main' | 'microsoft.base.road' | 'microsoft.base.darkgrey' | 'microsoft.base.labels.road' | 'microsoft.base.labels.darkgrey' | 'microsoft.base.hybrid.road' | 'microsoft.base.hybrid.darkgrey' | 'microsoft.imagery' | 'microsoft.weather.radar.main' | 'microsoft.weather.infrared.main' | 'microsoft.traffic.absolute' | 'microsoft.traffic.absolute.main' | 'microsoft.traffic.relative' | 'microsoft.traffic.relative.main' | 'microsoft.traffic.relative.dark' | 'microsoft.traffic.delay' | 'microsoft.traffic.delay.main' | 'microsoft.traffic.reduced.main' | 'microsoft.traffic.incident' required

A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a tilesetId to use when making requests. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.

zoominteger required

Zoom level for the desired tile.

Please see Zoom Levels and Tile Grid for details.

xinteger required

X coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>zoom</sup> -1].

Please see Zoom Levels and Tile Grid for details.

yinteger required

Y coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>zoom</sup> -1].

Please see Zoom Levels and Tile Grid for details.

timeStampstring date-time

The desired date and time of the requested tile. This parameter must be specified in the standard date-time format (e.g. 2019-11-14T16:03:00-08:00), as defined by ISO 8601. This parameter is only supported when tilesetId parameter is set to one of the values below.

  • microsoft.weather.infrared.main: We provide tiles up to 3 hours in the past. Tiles are available in 10-minute intervals. We round the timeStamp value to the nearest 10-minute time frame.
  • microsoft.weather.radar.main: We provide tiles up to 1.5 hours in the past and up to 2 hours in the future. Tiles are available in 5-minute intervals. We round the timeStamp value to the nearest 5-minute time frame.
tileSize'256' | '512'

The size of the returned map tile in pixels.

languagestring

Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.

Please refer to Supported Languages for details.

view'AE' | 'AR' | 'BH' | 'IN' | 'IQ' | 'JO' | 'KW' | 'LB' | 'MA' | 'OM' | 'PK' | 'PS' | 'QA' | 'SA' | 'SY' | 'US' | 'YE' | 'Auto' | 'Unified'

The View parameter (also called the "user region" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions. Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country/region where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.

Please refer to Supported Views for details and to see the available Views.

Headers

x-ms-client-idstring

Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the Azure Maps management plane Account API. For more information on using Microsoft Entra ID security in Azure Maps, see Manage authentication in Azure Maps.

Response

The request has succeeded.

string byte required