ZXY

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:

Path parameters

layerstring · enumRequired

The tile set layer that will be requested.

Possible values:

zinteger · int32Required

Zoom level

xinteger · int32Required

X coordinate

yinteger · int32Required

Y coordinate

Responses

200

Tile image retrieved successfully

image/png

get

/zxy/{layer}/{z}/{x}/{y}.png

HTTPcURLJavaScriptPython

GET /maps/raster/v1/zxy/{layer}/{z}/{x}/{y}.png HTTP/1.1
Host: api.os.uk
key: YOUR_API_KEY
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Tile image retrieved successfully

Example Request

https://api.os.uk/maps/raster/v1/zxy/Outdoor_27700/7/323/489.png?key=INSERT_API_KEY