Technical Specification

API Reference

OS NGD API – Features Technical Specification provides an overview of the endpoints available, as well as the parameters that can be used with each endpoint. The Technical Specification is intended to be used by customers who want to integrate with the API. Click into each endpoint to learn more.

OS NGD API – Features landing page

GEThttps://api.os.uk/features/ngd/ofa/v1/

Response

200400405406

Ordnance Survey National Geographic Database API – Features landing page.

Body

application/json

titlestring

descriptionstring

linksarray of Link (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.os.uk/features/ngd/ofa/v1/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "title": "text",
  "description": "text",
  "links": [
    {
      "href": "text",
      "rel": "text",
      "type": "text",
      "title": "text"
    }
  ]
}

OS NGD API – Features conformance page

GEThttps://api.os.uk/features/ngd/ofa/v1/conformance

Response

200400405406

Ordnance Survey National Geographic Database API – Features conformance page.

Body

application/json

conformsToarray of string

Request

JavaScriptCurlPython

const response = await fetch('https://api.os.uk/features/ngd/ofa/v1/conformance', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "conformsTo": [
    "text"
  ]
}

Get list of all OS NGD feature collections

Get a list of all the available OS NGD feature collections

GEThttps://api.os.uk/features/ngd/ofa/v1/collections

Response

200400405406

All Ordnance Survey National Geographic Database feature collections.

Body

application/json

linksarray of Link (object)

crsarray of enum

collectionsarray of CollectionResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.os.uk/features/ngd/ofa/v1/collections', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "links": [
    {
      "href": "text",
      "rel": "text",
      "type": "text",
      "title": "text"
    }
  ],
  "crs": [
    "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
  ],
  "collections": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "crs": [
        "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
      ],
      "storageCrs": "http://www.opengis.net/def/crs/OGC/1.3/CRS84",
      "itemType": "text",
      "extent": {
        "spatial": {
          "bbox": [
            [
              0
            ]
          ],
          "crs": "text"
        },
        "temporal": {
          "interval": [
            [
              "text"
            ]
          ],
          "trs": "text"
        }
      },
      "links": [
        {
          "href": "text",
          "rel": "text",
          "type": "text",
          "title": "text"
        }
      ]
    }
  ]
}

Get a single OS NGD feature collection

Get information about an OS NGD feature collection

GEThttps://api.os.uk/features/ngd/ofa/v1/collections/{collectionId}

Path parameters

collectionId*enum

A known collection ID.

Example: "bld-fts-building-1"

bld-fts-building-1bld-fts-building-2bld-fts-building-3bld-fts-buildingline-1bld-fts-buildingpart-1bld-fts-buildingpart-2gnm-fts-namedarea-1gnm-fts-namedpoint-1gnm-fts-namedroadjunction-1lnd-fts-land-1lnd-fts-land-2lnd-fts-land-3lnd-fts-landform-1lnd-fts-landformline-1lnd-fts-landformpoint-1lnd-fts-landpoint-1lus-fts-site-1lus-fts-site-2lus-fts-siteaccesslocation-1lus-fts-siteroutingpoint-1str-fts-compoundstructure-1str-fts-compoundstructure-2str-fts-fieldboundary-1str-fts-structure-1str-fts-structure-2str-fts-structure-3str-fts-structureline-1str-fts-structurepoint-1trn-fts-cartographicraildetail-1trn-fts-rail-1trn-fts-rail-2trn-fts-rail-3trn-fts-roadline-1trn-fts-roadtrackorpath-1trn-fts-roadtrackorpath-2trn-fts-roadtrackorpath-3trn-ntwk-connectinglink-1trn-ntwk-connectingnode-1trn-ntwk-ferrylink-1trn-ntwk-ferrynode-1trn-ntwk-ferryterminal-1trn-ntwk-path-1trn-ntwk-pathlink-1trn-ntwk-pathnode-1trn-ntwk-pavementlink-1trn-ntwk-railwaylink-1trn-ntwk-railwaylinkset-1trn-ntwk-railwaynode-1trn-ntwk-road-1trn-ntwk-roadjunction-1trn-ntwk-roadlink-1trn-ntwk-roadlink-2trn-ntwk-roadlink-3trn-ntwk-roadnode-1trn-ntwk-street-1trn-ntwk-tramonroad-1trn-rami-averageandindicativespeed-1trn-rami-highwaydedication-1trn-rami-maintenancearea-1trn-rami-maintenanceline-1trn-rami-maintenancepoint-1trn-rami-reinstatementarea-1trn-rami-reinstatementline-1trn-rami-reinstatementpoint-1trn-rami-restriction-1trn-rami-routinghazard-1trn-rami-routingstructure-1trn-rami-specialdesignationarea-1trn-rami-specialdesignationline-1trn-rami-specialdesignationpoint-1wtr-fts-intertidalline-1wtr-fts-tidalboundary-1wtr-fts-water-1wtr-fts-water-2wtr-fts-water-3wtr-fts-waterpoint-1wtr-ntwk-waterlink-1wtr-ntwk-waterlinkset-1wtr-ntwk-waternode-1

Response

200400404405406

A single Ordnance Survey National Geographic Database feature collection.

Body

application/json

idstring

titlestring

descriptionstring

crsarray of enum

storageCrsenum

http://www.opengis.net/def/crs/OGC/1.3/CRS84http://www.opengis.net/def/crs/EPSG/0/27700http://www.opengis.net/def/crs/EPSG/0/7405http://www.opengis.net/def/crs/EPSG/0/4326http://www.opengis.net/def/crs/EPSG/0/3857

itemTypestring

extentExtent (object)

linksarray of Link (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.os.uk/features/ngd/ofa/v1/collections/{collectionId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "title": "text",
  "description": "text",
  "crs": [
    "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
  ],
  "storageCrs": "http://www.opengis.net/def/crs/OGC/1.3/CRS84",
  "itemType": "text",
  "extent": {
    "spatial": {
      "bbox": [
        [
          0
        ]
      ],
      "crs": "text"
    },
    "temporal": {
      "interval": [
        [
          "text"
        ]
      ],
      "trs": "text"
    }
  },
  "links": [
    {
      "href": "text",
      "rel": "text",
      "type": "text",
      "title": "text"
    }
  ]
}

Get schema for a single OS NGD feature collection

GEThttps://api.os.uk/features/ngd/ofa/v1/collections/{collectionId}/schema

Path parameters

collectionId*enum

A known collection ID.

Example: "bld-fts-building-1"

bld-fts-building-1bld-fts-building-2bld-fts-building-3bld-fts-buildingline-1bld-fts-buildingpart-1bld-fts-buildingpart-2gnm-fts-namedarea-1gnm-fts-namedpoint-1gnm-fts-namedroadjunction-1lnd-fts-land-1lnd-fts-land-2lnd-fts-land-3lnd-fts-landform-1lnd-fts-landformline-1lnd-fts-landformpoint-1lnd-fts-landpoint-1lus-fts-site-1lus-fts-site-2lus-fts-siteaccesslocation-1lus-fts-siteroutingpoint-1str-fts-compoundstructure-1str-fts-compoundstructure-2str-fts-fieldboundary-1str-fts-structure-1str-fts-structure-2str-fts-structure-3str-fts-structureline-1str-fts-structurepoint-1trn-fts-cartographicraildetail-1trn-fts-rail-1trn-fts-rail-2trn-fts-rail-3trn-fts-roadline-1trn-fts-roadtrackorpath-1trn-fts-roadtrackorpath-2trn-fts-roadtrackorpath-3trn-ntwk-connectinglink-1trn-ntwk-connectingnode-1trn-ntwk-ferrylink-1trn-ntwk-ferrynode-1trn-ntwk-ferryterminal-1trn-ntwk-path-1trn-ntwk-pathlink-1trn-ntwk-pathnode-1trn-ntwk-pavementlink-1trn-ntwk-railwaylink-1trn-ntwk-railwaylinkset-1trn-ntwk-railwaynode-1trn-ntwk-road-1trn-ntwk-roadjunction-1trn-ntwk-roadlink-1trn-ntwk-roadlink-2trn-ntwk-roadlink-3trn-ntwk-roadnode-1trn-ntwk-street-1trn-ntwk-tramonroad-1trn-rami-averageandindicativespeed-1trn-rami-highwaydedication-1trn-rami-maintenancearea-1trn-rami-maintenanceline-1trn-rami-maintenancepoint-1trn-rami-reinstatementarea-1trn-rami-reinstatementline-1trn-rami-reinstatementpoint-1trn-rami-restriction-1trn-rami-routinghazard-1trn-rami-routingstructure-1trn-rami-specialdesignationarea-1trn-rami-specialdesignationline-1trn-rami-specialdesignationpoint-1wtr-fts-intertidalline-1wtr-fts-tidalboundary-1wtr-fts-water-1wtr-fts-water-2wtr-fts-water-3wtr-fts-waterpoint-1wtr-ntwk-waterlink-1wtr-ntwk-waterlinkset-1wtr-ntwk-waternode-1

Response

200400404405406

Schema for an Ordnance Survey National Geographic Database feature collection.

Body

*/*

Other propertiesobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.os.uk/features/ngd/ofa/v1/collections/{collectionId}/schema', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get a list of queryable attributes for this feature collection

GEThttps://api.os.uk/features/ngd/ofa/v1/collections/{collectionId}/queryables

Path parameters

collectionId*enum

A known collection ID.

Example: "bld-fts-building-1"

bld-fts-building-1bld-fts-building-2bld-fts-building-3bld-fts-buildingline-1bld-fts-buildingpart-1bld-fts-buildingpart-2gnm-fts-namedarea-1gnm-fts-namedpoint-1gnm-fts-namedroadjunction-1lnd-fts-land-1lnd-fts-land-2lnd-fts-land-3lnd-fts-landform-1lnd-fts-landformline-1lnd-fts-landformpoint-1lnd-fts-landpoint-1lus-fts-site-1lus-fts-site-2lus-fts-siteaccesslocation-1lus-fts-siteroutingpoint-1str-fts-compoundstructure-1str-fts-compoundstructure-2str-fts-fieldboundary-1str-fts-structure-1str-fts-structure-2str-fts-structure-3str-fts-structureline-1str-fts-structurepoint-1trn-fts-cartographicraildetail-1trn-fts-rail-1trn-fts-rail-2trn-fts-rail-3trn-fts-roadline-1trn-fts-roadtrackorpath-1trn-fts-roadtrackorpath-2trn-fts-roadtrackorpath-3trn-ntwk-connectinglink-1trn-ntwk-connectingnode-1trn-ntwk-ferrylink-1trn-ntwk-ferrynode-1trn-ntwk-ferryterminal-1trn-ntwk-path-1trn-ntwk-pathlink-1trn-ntwk-pathnode-1trn-ntwk-pavementlink-1trn-ntwk-railwaylink-1trn-ntwk-railwaylinkset-1trn-ntwk-railwaynode-1trn-ntwk-road-1trn-ntwk-roadjunction-1trn-ntwk-roadlink-1trn-ntwk-roadlink-2trn-ntwk-roadlink-3trn-ntwk-roadnode-1trn-ntwk-street-1trn-ntwk-tramonroad-1trn-rami-averageandindicativespeed-1trn-rami-highwaydedication-1trn-rami-maintenancearea-1trn-rami-maintenanceline-1trn-rami-maintenancepoint-1trn-rami-reinstatementarea-1trn-rami-reinstatementline-1trn-rami-reinstatementpoint-1trn-rami-restriction-1trn-rami-routinghazard-1trn-rami-routingstructure-1trn-rami-specialdesignationarea-1trn-rami-specialdesignationline-1trn-rami-specialdesignationpoint-1wtr-fts-intertidalline-1wtr-fts-tidalboundary-1wtr-fts-water-1wtr-fts-water-2wtr-fts-water-3wtr-fts-waterpoint-1wtr-ntwk-waterlink-1wtr-ntwk-waterlinkset-1wtr-ntwk-waternode-1

Response

200400404405406

A list of queryable attributes and their types for this feature collection.

Body

application/json

$schemastring

$idstring

typestring

titlestring

descriptionstring

propertiesobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.os.uk/features/ngd/ofa/v1/collections/{collectionId}/queryables', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "$schema": "text",
  "$id": "text",
  "type": "text",
  "title": "text",
  "description": "text"
}

Retrieve features in the feature collection

GEThttps://api.os.uk/features/ngd/ofa/v1/collections/{collectionId}/items

Authorization

api-key

Path parameters

collectionId*enum

A known collection ID.

Example: "bld-fts-building-1"

bld-fts-building-1bld-fts-building-2bld-fts-building-3bld-fts-buildingline-1bld-fts-buildingpart-1bld-fts-buildingpart-2gnm-fts-namedarea-1gnm-fts-namedpoint-1gnm-fts-namedroadjunction-1lnd-fts-land-1lnd-fts-land-2lnd-fts-land-3lnd-fts-landform-1lnd-fts-landformline-1lnd-fts-landformpoint-1lnd-fts-landpoint-1lus-fts-site-1lus-fts-site-2lus-fts-siteaccesslocation-1lus-fts-siteroutingpoint-1str-fts-compoundstructure-1str-fts-compoundstructure-2str-fts-fieldboundary-1str-fts-structure-1str-fts-structure-2str-fts-structure-3str-fts-structureline-1str-fts-structurepoint-1trn-fts-cartographicraildetail-1trn-fts-rail-1trn-fts-rail-2trn-fts-rail-3trn-fts-roadline-1trn-fts-roadtrackorpath-1trn-fts-roadtrackorpath-2trn-fts-roadtrackorpath-3trn-ntwk-connectinglink-1trn-ntwk-connectingnode-1trn-ntwk-ferrylink-1trn-ntwk-ferrynode-1trn-ntwk-ferryterminal-1trn-ntwk-path-1trn-ntwk-pathlink-1trn-ntwk-pathnode-1trn-ntwk-pavementlink-1trn-ntwk-railwaylink-1trn-ntwk-railwaylinkset-1trn-ntwk-railwaynode-1trn-ntwk-road-1trn-ntwk-roadjunction-1trn-ntwk-roadlink-1trn-ntwk-roadlink-2trn-ntwk-roadlink-3trn-ntwk-roadnode-1trn-ntwk-street-1trn-ntwk-tramonroad-1trn-rami-averageandindicativespeed-1trn-rami-highwaydedication-1trn-rami-maintenancearea-1trn-rami-maintenanceline-1trn-rami-maintenancepoint-1trn-rami-reinstatementarea-1trn-rami-reinstatementline-1trn-rami-reinstatementpoint-1trn-rami-restriction-1trn-rami-routinghazard-1trn-rami-routingstructure-1trn-rami-specialdesignationarea-1trn-rami-specialdesignationline-1trn-rami-specialdesignationpoint-1wtr-fts-intertidalline-1wtr-fts-tidalboundary-1wtr-fts-water-1wtr-fts-water-2wtr-fts-water-3wtr-fts-waterpoint-1wtr-ntwk-waterlink-1wtr-ntwk-waterlinkset-1wtr-ntwk-waternode-1

Query parameters

Response

200400404405406504

A list of features in a feature collection.

Body

application/geo+json

typestring

linksarray of Link (object)

timeStampstring (date-time)

featuresarray of Feature (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.os.uk/features/ngd/ofa/v1/collections/{collectionId}/items', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "type": "text",
  "links": [
    {
      "href": "text",
      "rel": "text",
      "type": "text",
      "title": "text"
    }
  ],
  "timeStamp": "2024-11-21T13:27:20.755Z",
  "features": [
    {
      "id": "text",
      "type": "text",
      "geometry": {
        "type": "text",
        "coordinates": [
          {
            "x": 0,
            "y": 0
          }
        ]
      }
    }
  ]
}

Retrieve a feature from the feature collection

GEThttps://api.os.uk/features/ngd/ofa/v1/collections/{collectionId}/items/{featureId}

Authorization

api-key

Path parameters

collectionId*enum

A known collection ID.

Example: "bld-fts-building-1"

bld-fts-building-1bld-fts-building-2bld-fts-building-3bld-fts-buildingline-1bld-fts-buildingpart-1bld-fts-buildingpart-2gnm-fts-namedarea-1gnm-fts-namedpoint-1gnm-fts-namedroadjunction-1lnd-fts-land-1lnd-fts-land-2lnd-fts-land-3lnd-fts-landform-1lnd-fts-landformline-1lnd-fts-landformpoint-1lnd-fts-landpoint-1lus-fts-site-1lus-fts-site-2lus-fts-siteaccesslocation-1lus-fts-siteroutingpoint-1str-fts-compoundstructure-1str-fts-compoundstructure-2str-fts-fieldboundary-1str-fts-structure-1str-fts-structure-2str-fts-structure-3str-fts-structureline-1str-fts-structurepoint-1trn-fts-cartographicraildetail-1trn-fts-rail-1trn-fts-rail-2trn-fts-rail-3trn-fts-roadline-1trn-fts-roadtrackorpath-1trn-fts-roadtrackorpath-2trn-fts-roadtrackorpath-3trn-ntwk-connectinglink-1trn-ntwk-connectingnode-1trn-ntwk-ferrylink-1trn-ntwk-ferrynode-1trn-ntwk-ferryterminal-1trn-ntwk-path-1trn-ntwk-pathlink-1trn-ntwk-pathnode-1trn-ntwk-pavementlink-1trn-ntwk-railwaylink-1trn-ntwk-railwaylinkset-1trn-ntwk-railwaynode-1trn-ntwk-road-1trn-ntwk-roadjunction-1trn-ntwk-roadlink-1trn-ntwk-roadlink-2trn-ntwk-roadlink-3trn-ntwk-roadnode-1trn-ntwk-street-1trn-ntwk-tramonroad-1trn-rami-averageandindicativespeed-1trn-rami-highwaydedication-1trn-rami-maintenancearea-1trn-rami-maintenanceline-1trn-rami-maintenancepoint-1trn-rami-reinstatementarea-1trn-rami-reinstatementline-1trn-rami-reinstatementpoint-1trn-rami-restriction-1trn-rami-routinghazard-1trn-rami-routingstructure-1trn-rami-specialdesignationarea-1trn-rami-specialdesignationline-1trn-rami-specialdesignationpoint-1wtr-fts-intertidalline-1wtr-fts-tidalboundary-1wtr-fts-water-1wtr-fts-water-2wtr-fts-water-3wtr-fts-waterpoint-1wtr-ntwk-waterlink-1wtr-ntwk-waterlinkset-1wtr-ntwk-waternode-1

featureId*string

A feature ID which is the identifier(id) for the feature.

Example: "11111111-1111-1111-1111-111111111111"

Query parameters

Response

200400404405406504

A single feature in the feature collection.

Body

application/geo+json

idstring

typestring

geometryGeometry (object)

propertiesobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.os.uk/features/ngd/ofa/v1/collections/{collectionId}/items/{featureId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Use of CQL Operators

The OS NGD API – Features supports a generic filter grammar called Common Query Language (CQL) for specifying enhanced filter criteria to return a subset of features. CQL is written using a familiar text-based syntax, making it more readable and better-suited for creating complex filters.

The following table documents the supported operators:

Operator Type	Supported Operators
Comparison	EQUAL TO [ = ], LESS THAN [ < ], LESS THAN OR EQUAL TO [ <= ], GREATER THAN [ > ], GREATER THAN OR EQUAL TO [ >= ], ISNULL, LIKE, IN, BETWEEN
Logical	AND, OR, NOT [ <> ]
Array	AEQUALS, ACONTAINS, ACONTAINEDBY, AOVERLAPS
Spatial	INTERSECTS