Technical specification

This technical specification explains the content of the OS Maps API, and the methods that you can use to call it. If you are not familiar with the OS Maps API you may want to read the overview documentation before proceeding.

If you are not familiar with the OS Maps API please read the overview documentation before proceeding.

Core concepts

This specification does not cover core concepts that apply to all Ordnance Survey APIs.

Please read the following pages to learn more about OS API core concepts:

• Authentication

• Error codes

• Rate-limiting policy

API reference

OS Maps API is available using the Open Geospatial Consortium Web Map Tile Service (OGC WMTS) standard and as ZXY.

Access and download data for a specific tile

GEThttps://api.os.uk/maps/raster/v1/zxy/{layer}/{z}/{x}/{y}.png

Authorization

api-key

Path parameters

layer*enum

The tile set layer that will be requested.

Road_27700Road_3857Outdoor_27700Outdoor_3857Light_27700Light_3857Leisure_27700

z*integer (int32)

Zoom level

x*integer (int32)

X coordinate

y*integer (int32)

Y coordinate

Response

200

Tile image retrieved successfully

Body

image/png

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.os.uk/maps/raster/v1/zxy/{layer}/{z}/{x}/{y}.png', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Access and download data for a specific tile

GEThttps://api.os.uk/maps/raster/v1/wmts

Authorization

api-key

Query parameters

Response

200ServiceMetadata

Tile image retrieved successfully

Body

image/png

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.os.uk/maps/raster/v1/wmts?layer=Road_27700&tileMatrixSet=EPSG%3A27700&tileMatrix=text&tileRow=0&tileCol=0&service=wmts&request=GetCapabilities&style=default', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

ServiceMetadata

{
  "service": {
    "title": "text",
    "description": "text",
    "version": "text"
  },
  "operations": [
    "text"
  ],
  "tileMatrixSets": [
    "text"
  ],
  "layers": [
    "text"
  ]
}