Tile request

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

zinteger · int32Required

Zoom level

yinteger · int32Required

Y coordinate

xinteger · int32Required

X coordinate

Query parameters

srsstring · enumOptional

The Spatial Reference System for the service.

Default: 27700Possible values:

Responses

200

Tile data retrieved successfully

application/octet-stream

Responsestring · binary

get

/vts/tile/{z}/{y}/{x}.pbf

HTTPcURLJavaScriptPython

GET /maps/vector/v1/vts/tile/{z}/{y}/{x}.pbf HTTP/1.1
Host: api.os.uk
key: YOUR_API_KEY
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Tile data retrieved successfully

binary

Access and download data for a specific tile from a data overlay

get

Authorizations

api-key & api-key-header & oauth2

keystringRequired

keystringRequired

OAuth2clientCredentialsRequired

Token URL:

Path parameters

layer-namestring · enumRequired

The name of the data overlay.

Possible values:

zinteger · int32Required

Zoom level

yinteger · int32Required

Y coordinate

xinteger · int32Required

X coordinate

Query parameters

srsstring · enumOptional

The Spatial Reference System for the service.

Default: 27700Possible values:

Responses

200

Tile data retrieved successfully

application/octet-stream

Responsestring · binary

get

/vts/{layer-name}/tile/{z}/{y}/{x}.pbf

HTTPcURLJavaScriptPython

GET /maps/vector/v1/vts/{layer-name}/tile/{z}/{y}/{x}.pbf HTTP/1.1
Host: api.os.uk
key: YOUR_API_KEY
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Tile data retrieved successfully

binary