Render V2 - Get Map Tile

Applies to: see pricing tiers.

The Get Map Tiles API allows users to request map tiles in vector or raster formats typically to be integrated into a map control or SDK. Some example tiles that can be requested are Azure Maps road tiles, real-time Weather Radar tiles or the map tiles created using Azure Maps Creator. By default, Azure Maps uses vector tiles for its web map control (Web SDK) and Android SDK.

GET https://atlas.microsoft.com/map/tile?api-version=2022-08-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}
GET https://atlas.microsoft.com/map/tile?api-version=2022-08-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}&timeStamp={timeStamp}&tileSize={tileSize}&language={language}&view={view}

URI Parameters

Name In Required Type Description
api-version
query True
  • string

Version number of Azure Maps API. Current version is 2022-08-01

tilesetId
query True

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 tilesetId for tilesets created using Azure Maps Creator are generated through the Tileset Create API. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.

x
query True
  • integer
int32

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

Please see Zoom Levels and Tile Grid for details.

y
query True
  • integer
int32

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

Please see Zoom Levels and Tile Grid for details.

zoom
query True
  • integer
int32

Zoom level for the desired tile.

Please see Zoom Levels and Tile Grid for details.

language
query
  • string

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.

tileSize
query

The size of the returned map tile in pixels.

timeStamp
query
  • string
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.
view
query

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 have different views of such regions, and the View parameter allows your application to comply with the view required by the country 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 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.

Request Header

Name Required Type Description
x-ms-client-id
  • string

Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following articles for guidance.

Responses

Name Type Description
200 OK
  • object

The tile returned from a successful API call.

Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

Headers

  • Content-Type: string
Other Status Codes

An unexpected error occurred.

Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

Security

AADToken

These are the Azure Active Directory OAuth2 Flows. When paired with Azure role-based access control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.

To implement scenarios, we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.

Notes

  • This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API.

The Authorization URL is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. * The Azure role-based access control is configured from the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs. * Usage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.

  • Currently, Azure Active Directory v1.0 or v2.0 supports Work, School, and Guests but does not support Personal accounts.

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

Scopes

Name Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

This is a shared key that is provisioned when creating an Azure Maps resource through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.

With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.

For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.

Type: apiKey
In: header

SAS Token

This is a shared access signature token is created from the List SAS operation on the Azure Maps resource through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.

With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.

For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the Map account resource to limit rendering abuse and regularly renew the SAS Token.

Type: apiKey
In: header

Examples

Successful Tile Request

Sample Request

GET https://atlas.microsoft.com/map/tile?api-version=2022-08-01&tilesetId=microsoft.base&zoom=6&x=10&y=22

Sample Response

Content-Type: application/vnd.mapbox-vector-tile
"binary image string"

Definitions

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

LocalizedMapView

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 have different views of such regions, and the View parameter allows your application to comply with the view required by the country 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 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.

MapTileSize

The size of the returned map tile in pixels.

TilesetID

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 tilesetId for tilesets created using Azure Maps Creator are generated through the Tileset Create API. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info
  • object

The additional info.

type
  • string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

The error additional info.

code
  • string

The error code.

details

The error details.

message
  • string

The error message.

target
  • string

The error target.

ErrorResponse

Error response

Name Type Description
error

The error object.

LocalizedMapView

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 have different views of such regions, and the View parameter allows your application to comply with the view required by the country 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 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.

Name Type Description
AE
  • string

United Arab Emirates (Arabic View)

AR
  • string

Argentina (Argentinian View)

Auto
  • string

Return the map data based on the IP address of the request.

BH
  • string

Bahrain (Arabic View)

IN
  • string

India (Indian View)

IQ
  • string

Iraq (Arabic View)

JO
  • string

Jordan (Arabic View)

KW
  • string

Kuwait (Arabic View)

LB
  • string

Lebanon (Arabic View)

MA
  • string

Morocco (Moroccan View)

OM
  • string

Oman (Arabic View)

PK
  • string

Pakistan (Pakistani View)

PS
  • string

Palestinian Authority (Arabic View)

QA
  • string

Qatar (Arabic View)

SA
  • string

Saudi Arabia (Arabic View)

SY
  • string

Syria (Arabic View)

Unified
  • string

Unified View (Others)

YE
  • string

Yemen (Arabic View)

MapTileSize

The size of the returned map tile in pixels.

Name Type Description
256
  • string

Return a 256 by 256 pixel tile.

512
  • string

Return a 512 by 512 pixel tile.

TilesetID

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 tilesetId for tilesets created using Azure Maps Creator are generated through the Tileset Create API. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.

Name Type Description
microsoft.base
  • string

A base map is a standard map that displays roads, natural and artificial features along with the labels for those features in a vector tile.

Supports zoom levels 0 through 22. Format: vector (pbf).

microsoft.base.darkgrey
  • string

All layers with our dark grey style.

Supports zoom levels 0 through 22. Format: raster (png).

microsoft.base.hybrid
  • string

Displays road, boundary and label data in a vector tile.

Supports zoom levels 0 through 22. Format: vector (pbf).

microsoft.base.hybrid.darkgrey
  • string

Road, boundary and label data in our dark grey style.

Supports zoom levels 0 through 22. Format: raster (png).

microsoft.base.hybrid.road
  • string

Road, boundary and label data in our main style.

Supports zoom levels 0 through 22. Format: raster (png).

microsoft.base.labels
  • string

Displays labels for roads, natural and artificial features in a vector tile.

Supports zoom levels 0 through 22. Format: vector (pbf).

microsoft.base.labels.darkgrey
  • string

Label data in our dark grey style.

Supports zoom levels 0 through 22. Format: raster (png).

microsoft.base.labels.road
  • string

Label data in our main style.

Supports zoom levels 0 through 22. Format: raster (png).

microsoft.base.road
  • string

All layers with our main style.

Supports zoom levels 0 through 22. Format: raster (png).

microsoft.dem
  • string

Digital Elevation Model tiles. The tiles are in the GeoTIFF format with a single 32-bit floating point band. The tiles cover the whole landmass of Earth. Some small islands (e.g., atolls) might not be represented accurately.

  • The vertical unit for measurement of elevation height is meters. An elevation value of -32767.0 is used for points that have no data value, most often returned where there isn't landmass (i.e. water).
  • The horizontal reference datum is the World Geodetic System 1984 (WGS84-G1150) and the vertical reference datum is the Earth Gravitational Model 2008 (EGM2008).
  • Tiles are 258x258 pixel squares rather than the standard 256 x 256. This is done to allow for accurate interpolation of values at the tile edges. As such adjacent tiles overlap by 1 pixel along all edges.
  • Tile data comes from the Airbus WorldDEM4Ortho product. Urban areas are approximately leveled down to ground level. All other areas are represented by the object surface level (e.g., trees).

Supports zoom level 13 only. Format: raster (tiff).

microsoft.dem.contours
  • string

Digital elevation contour line tiles. Compared to the microsoft.dem option, these tiles are in vector format and intended for visualization purpose. The tiles cover the whole landmass of Earth. Some small islands (e.g., atolls) might not be represented accurately.

  • The vertical unit for measurement of elevation height is meters.
  • The horizontal reference datum is the World Geodetic System 1984 (WGS84-G1150) and the vertical reference datum is the Earth Gravitational Model 2008 (EGM2008).
  • Tile data comes from the Airbus WorldDEM4Ortho product. Urban areas are approximately leveled down to ground level. All other areas are represented by the object surface level (e.g., trees).

Supports zoom levels 9 through 14. Format: vector (pbf).

microsoft.imagery
  • string

A combination of satellite and aerial imagery. Only available in S1 pricing SKU.

Supports zoom levels 1 through 19. Format: raster (jpeg).

microsoft.terra.main
  • string

Shaded relief and terra layers.

Supports zoom levels 0 through 6. Format: raster (png).

microsoft.traffic.absolute
  • string

absolute traffic tiles in vector

microsoft.traffic.absolute.main
  • string

absolute traffic tiles in raster in our main style.

microsoft.traffic.delay
  • string

traffic tiles in vector

microsoft.traffic.delay.main
  • string

traffic tiles in raster in our main style

microsoft.traffic.incident
  • string

incident tiles in vector

microsoft.traffic.reduced.main
  • string

reduced traffic tiles in raster in our main style

microsoft.traffic.relative
  • string

relative traffic tiles in vector

microsoft.traffic.relative.dark
  • string

relative traffic tiles in raster in our dark style.

microsoft.traffic.relative.main
  • string

relative traffic tiles in raster in our main style.

microsoft.weather.infrared.main
  • string

Weather infrared tiles. Latest Infrared Satellite images shows clouds by their temperature. Please see coverage information for Azure Maps Weather service. To learn more about the returned Satellite data, please see Weather concepts.

Supports zoom levels 0 through 15. Format: raster (png).

microsoft.weather.radar.main
  • string

Weather radar tiles. Latest weather radar images including areas of rain, snow, ice and mixed conditions. Please see coverage information for Azure Maps Weather service. To learn more about the Radar data, please see Weather concepts.

Supports zoom levels 0 through 15. Format: raster (png).