Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetMapTile

Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.

The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).

Request Syntax


GET /maps/v0/maps/MapName/tiles/Z/X/Y?key=Key HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Key

The optional API key to authorize the request.

Length Constraints: Minimum length of 0. Maximum length of 1000.

MapName

The map resource to retrieve the map tiles from.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[-._\w]+$

Required: Yes

X

The X axis value for the map tile.

Pattern: \d+

Required: Yes

Y

The Y axis value for the map tile.

Pattern: \d+

Required: Yes

Z

The zoom value for the map tile.

Pattern: \d+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Cache-Control: CacheControl
Content-Type: ContentType

Blob

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following HTTP headers.

CacheControl: The HTTP Cache-Control directive for the value.
ContentType: The map tile's content type. For example, application/vnd.mapbox-vector-tile.

The response returns the following as the HTTP body.

Blob: Contains Mapbox Vector Tile (MVT) data.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

HTTP Status Code: 403

InternalServerException

The request has failed to process because of an unknown server error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource that you've entered was not found in your AWS account.

HTTP Status Code: 404

ThrottlingException

The request was denied because of request throttling.

HTTP Status Code: 429

ValidationException

The input failed to meet the constraints specified by the AWS service.

HTTP Status Code: 400