Technical specification

This technical specification explains the content of the OS Features API and the methods you can use to call it.

The OS Features API lets users call and interact with OS data, including the highly detailed OS MasterMap Topography Layer. It does this by exposing the data through an Open Geospatial Consortium Web Feature Service (OGC WFS).

If you are not familiar with the OS Features 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

The OS Features API exposes data through an Open Geospatial Consortium Web Feature Service (OGC WFS).

The OGC WFS accepts three types of requests:

getCapabilities

Returns a metadata document describing the WFS service provided by the server as well as valid WFS operations and parameters.

GET https://api.os.uk/features/v1/wfs?service=wfs&request=getCapabilities&key=

Required parameters: service

describleFeatureType

Returns a description of the attributes for each feature type supported by the WFS service.

GET https://api.os.uk/features/v1/wfs?service=wfs&version=2.0.0&request=DescribeFeatureType&key=

Required parameters: request, service, version, typeNames

getFeature

Returns a selection of a specific feature from the WFS including its attribute values and geometry. The maximum number of features you can call at any given time is 100.

GET https://api.os.uk/features/v1/wfs?service=wfs&version=2.0.0&request=GetFeature&typeNames=Topography_TopographicPoint&count=20&key=

Required parameters: request, service, version, typeNames

Access to features matching a given query

GEThttps://api.os.uk/features/v1/wfs

Authorization

api-key

Query parameters

Response

200

Returns a description of the attributes for each feature type supported by the WFS service.

Body

application/xmlapplication/json

typestring

Example: "FeatureCollection"

featuresarray of Feature (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.os.uk/features/v1/wfs?request=GetCapabilities&service=WFS&version=1.0.0&typeNames=DetailedPathNetwork_RouteLink', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "text",
      "geometry": {
        "type": "text",
        "coordinates": [
          {
            "x": 0,
            "y": 0
          }
        ]
      }
    }
  ]
}

Access to features matching a given query for a particular year (as an annual snapshot - taking the last full release in the calendar year)

GEThttps://api.os.uk/features/v1/wfs/archive/{year}

Authorization

api-key

Path parameters

year*string

The year being requested.

Query parameters

Response

200

Returns a description of the attributes for each feature type supported by the WFS service.

Body

application/xmlapplication/json

typestring

Example: "FeatureCollection"

featuresarray of Feature (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.os.uk/features/v1/wfs/archive/{year}?request=GetCapabilities&service=WFS&version=1.0.0&typeNames=Highways_RoadLink', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "text",
      "geometry": {
        "type": "text",
        "coordinates": [
          {
            "x": 0,
            "y": 0
          }
        ]
      }
    }
  ]
}