WMTS

API test authentication

The Open API block allows you to test OS APIs directly from the page with example data and parameters. To use this feature, you will need to add your API Key or OAuth2 token to the authentication field.

For help generating an API Key or OAuth2 token, please see the Getting started with an API project or OAuth2 documentation.

Access and download data for a specific tile

get

Authorizations

api-key & api-key-header & oauth2

keystringRequired

keystringRequired

OAuth2clientCredentialsRequired

Token URL:

Query parameters

layerstring · enumRequired

The tile set layer that will be requested.

Possible values:

tileMatrixSetstring · enumRequired

The identifier of the tile matrix set.

Possible values:

tileMatrixstringRequired

The identifier of the tile matrix within the specified tile matrix set.

tileRowintegerRequired

The row index of the tile.

tileColintegerRequired

The column index of the tile.

servicestring · enumRequired

The service that is being accessed.

Possible values:

requeststring · enumRequired

The type of request being made. If a GetCapabilities request is being made, the other parameters are not required other than authentication.

Possible values:

stylestring · enumRequired

Taken from the Identifier of the chosen Layer's Style property

Possible values:

versionstring · enumOptional

The version number of the service.

Possible values:

heightintegerOptional

The Height of the tile.

widthintegerOptional

The Width of the tile.

outputformatstring · enumOptional

The format of the returned tile.

Possible values:

Responses

200

Tile image retrieved successfully

image/png

ServiceMetadata

Retrieves Service Metadata for OS Maps API when request parameter is 'GetCapabilities'

application/json

get

/wmts

HTTPcURLJavaScriptPython

GET /maps/raster/v1/wmts?layer=Road_27700&tileMatrixSet=EPSG%3A27700&tileMatrix=text&tileRow=1&tileCol=1&service=wmts&request=GetCapabilities&style=default HTTP/1.1
Host: api.os.uk
key: YOUR_API_KEY
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Example Request

https://api.os.uk/maps/raster/v1/wmts?service=WMTS&request=GetTile&version=2.0.0&style=default&layer=Outdoor_27700&tileMatrixSet=EPSG:27700&tileMatrix=7&tileRow=489&tileCol=323&key=INSERT_API_KEY