1 of 1

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.

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:

Technical Specification

API Reference

OS NGD API – Features landing page

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

Response

Ordnance Survey National Geographic Database API – Features landing page.

Body

titlestring

descriptionstring

linksarray of Link (object)

hrefstring (url)

relstring

typestring

titlestring

Request

Response

OS NGD API – Features conformance page

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

Response

Ordnance Survey National Geographic Database API – Features conformance page.

Body

conformsToarray of string

itemsstring

Request

Response

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

All Ordnance Survey National Geographic Database feature collections.

Body

linksarray of Link (object)

hrefstring (url)

relstring

typestring

titlestring

crsarray of enum

itemsenum

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

collectionsarray of CollectionResponse (object)

idstring

titlestring

descriptionstring

crsarray of enum

itemsenum

storageCrsenum

itemTypestring

extentExtent (object)

spatialSpatialExtent (object)

bboxarray of array of number (double)

itemsnumber (double)

crsstring

temporalTemporalExtent (object)

intervalarray of array of string

itemsstring

trsstring

linksarray of Link (object)

hrefstring (url)

relstring

typestring

titlestring

Request

Response

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

A single Ordnance Survey National Geographic Database feature collection.

Body

idstring

titlestring

descriptionstring

crsarray of enum

itemsenum

storageCrsenum

itemTypestring

extentExtent (object)

spatialSpatialExtent (object)

bboxarray of array of number (double)

itemsnumber (double)

crsstring

temporalTemporalExtent (object)

intervalarray of array of string

itemsstring

trsstring

linksarray of Link (object)

hrefstring (url)

relstring

typestring

titlestring

Request

Response

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"

Response

Schema for an Ordnance Survey National Geographic Database feature collection.

Body

Other propertiesobject

Request

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"

Response

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

Body

$schemastring

$idstring

typestring

titlestring

descriptionstring

propertiesobject

Other propertiesQueryable (object)

titlestring

typestring

formatstring

maxLengthinteger (int32)

patternstring

descriptionstring

hierarchystring

parentstring

childstring

minItemsinteger (int32)

maxItemsinteger (int32)

itemsQueryable (object)

Circular reference to Queryable (object) ↩

enumarray of string

itemsstring

Request

Response

Retrieve features in the feature collection

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

Authorization

Path parameters

collectionId*enum

A known collection ID.

Example: "bld-fts-building-1"

Query parameters

bboxarray of number

The optional bbox parameter specifies a supported bounding box. Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four comma-separated numbers: Lower left corner, coordinate axis 1 (e.g. min x axis) Lower left corner, coordinate axis 2 (e.g. min y axis) Upper right corner, coordinate axis 1 (e.g. max x axis) Upper right corner, coordinate axis 2 (e.g. max y axis)The default coordinate reference system of the values is WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter bbox-crs.

itemsnumber

bbox-crsenum

The coordinate reference system of the bbox parameter. It must be a 2D coordinate reference system supported by the collection. Default is WGS84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84).

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/4326http://www.opengis.net/def/crs/EPSG/0/3857

crsenum

The coordinate reference system of the response geometries. It must be a coordinate reference system supported by the collection. Default is WGS84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84).

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/4326http://www.opengis.net/def/crs/EPSG/0/3857http://www.opengis.net/def/crs/EPSG/0/7405

datetimestring

Either a local date, a date-time with UTC time zone (Z) or an open or closed interval. Open ranges in time intervals at the start or end are supported using a double-dot (..) or an empty string for the start/end. Date and time expressions adhere to RFC 3339. Examples:A date-time: '2021-12-12T23:20:50Z'A closed interval: '2021-12-12T00:00:00Z/2021-12-18T12:31:12Z'Open intervals: '2021-12-12T00:00:00Z/..' or '../2021-12-18T12:31:12Z'An interval until now: '2018-02-12T00:00:00Z/..' or '2018-02-12T00:00:00Z/'Selects features that have a temporal property that intersects the value of the parameter.

Example: "2018-02-12T00:00:00Z/.."

limitinteger

The optional limit parameter limits the number of items that are presented in the response document. Minimum = 1. Maximum = 100. Default = 100.

offsetinteger

The optional offset parameter skips past the specified number of features in the collection. Minimum = 0. Default = 0.

filterstring

The optional filter parameter is a filter expression in CQL format which is applied when retrieving resources to determine which resources are included in a result set.

filter-crsenum

Specify which of the supported CRSs to use to encode geometric values in a filter expression. It must be a 2D coordinate reference system supported by the collection. Default is WGS84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84).

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/4326http://www.opengis.net/def/crs/EPSG/0/3857

filter-langenum

The optional filter-lang parameter is the specific language used for the filter parameter. Default = cql-text

cql-text

Response

A list of features in a feature collection.

Body

typestring

linksarray of Link (object)

hrefstring (url)

relstring

typestring

titlestring

timeStampstring (date-time)

featuresarray of Feature (object)

idstring

typestring

geometryGeometry (object)

typestring

coordinatesarray of Coordinate (object)

xnumber (double)

ynumber (double)

propertiesobject

Other propertiesobject

Request

Response

Retrieve a feature from the feature collection

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

Authorization

Path parameters

collectionId*enum

A known collection ID.

Example: "bld-fts-building-1"

featureId*string

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

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

Query parameters

crsenum

Response

A single feature in the feature collection.

Body

idstring

typestring

geometryGeometry (object)

typestring

coordinatesarray of Coordinate (object)

xnumber (double)

ynumber (double)

propertiesobject

Other propertiesobject

Request

Response

Use of CQL Operators

The following table documents the supported operators:

Operator Type

Supported Operators

EQUAL TO [ = ], LESS THAN [ < ], LESS THAN OR EQUAL TO [ <= ], GREATER THAN [ > ], GREATER THAN OR EQUAL TO [ >= ], ISNULL, LIKE, IN, BETWEEN

AND, OR, NOT [ <> ]

AEQUALS, ACONTAINS, ACONTAINEDBY, AOVERLAPS

OS NGD API – Features conformance page

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

Response

Ordnance Survey National Geographic Database API – Features conformance page.

Body

conformsToarray of string

itemsstring

Request

Response

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"

Response

Schema for an Ordnance Survey National Geographic Database feature collection.

Body

Other propertiesobject

Request

OS NGD API – Features landing page

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

Response

Ordnance Survey National Geographic Database API – Features landing page.

Body

titlestring

descriptionstring

linksarray of Link (object)

hrefstring (url)

relstring

typestring

titlestring

Request

Response

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

All Ordnance Survey National Geographic Database feature collections.

Body

linksarray of Link (object)

hrefstring (url)

relstring

typestring

titlestring

crsarray of enum

itemsenum

collectionsarray of CollectionResponse (object)

idstring

titlestring

descriptionstring

crsarray of enum

itemsenum

storageCrsenum

itemTypestring

extentExtent (object)

spatialSpatialExtent (object)

bboxarray of array of number (double)

itemsnumber (double)

crsstring

temporalTemporalExtent (object)

intervalarray of array of string

itemsstring

trsstring

linksarray of Link (object)

hrefstring (url)

relstring

typestring

titlestring

Request

Response

Retrieve a feature from the feature collection

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

Authorization

Path parameters

collectionId*enum

A known collection ID.

Example: "bld-fts-building-1"

featureId*string

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

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

Query parameters

crsenum

Response

A single feature in the feature collection.

Body

idstring

typestring

geometryGeometry (object)

typestring

coordinatesarray of Coordinate (object)

xnumber (double)

ynumber (double)

propertiesobject

Other propertiesobject

Request

Response

Retrieve features in the feature collection

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

Authorization

Path parameters

collectionId*enum

A known collection ID.

Example: "bld-fts-building-1"

Query parameters

bboxarray of number

itemsnumber

bbox-crsenum

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/4326http://www.opengis.net/def/crs/EPSG/0/3857

crsenum

datetimestring

Example: "2018-02-12T00:00:00Z/.."

limitinteger

The optional limit parameter limits the number of items that are presented in the response document. Minimum = 1. Maximum = 100. Default = 100.

offsetinteger

The optional offset parameter skips past the specified number of features in the collection. Minimum = 0. Default = 0.

filterstring

The optional filter parameter is a filter expression in CQL format which is applied when retrieving resources to determine which resources are included in a result set.

filter-crsenum

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/4326http://www.opengis.net/def/crs/EPSG/0/3857

filter-langenum

The optional filter-lang parameter is the specific language used for the filter parameter. Default = cql-text

cql-text

Response

A list of features in a feature collection.

Body

typestring

linksarray of Link (object)

hrefstring (url)

relstring

typestring

titlestring

timeStampstring (date-time)

featuresarray of Feature (object)

idstring

typestring

geometryGeometry (object)

typestring

coordinatesarray of Coordinate (object)

xnumber (double)

ynumber (double)

propertiesobject

Other propertiesobject

Request

Response

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"

Response

A single Ordnance Survey National Geographic Database feature collection.

Body

idstring

titlestring

descriptionstring

crsarray of enum

itemsenum

storageCrsenum

itemTypestring

extentExtent (object)

spatialSpatialExtent (object)

bboxarray of array of number (double)

itemsnumber (double)

crsstring

temporalTemporalExtent (object)

intervalarray of array of string

itemsstring

trsstring

linksarray of Link (object)

hrefstring (url)

relstring

typestring

titlestring

Request

Response

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"

Response

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

Body

$schemastring

$idstring

typestring

titlestring

descriptionstring

propertiesobject

Other propertiesQueryable (object)

titlestring

typestring

formatstring

maxLengthinteger (int32)

patternstring

descriptionstring

hierarchystring

parentstring

childstring

minItemsinteger (int32)

maxItemsinteger (int32)

itemsQueryable (object)

Circular reference to Queryable (object) ↩

enumarray of string

itemsstring

Request

Response

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

{
  "conformsTo": [
    "text"
  ]
}

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

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

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

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

{
  "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"
        }
      ]
    }
  ]
}

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

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

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

{
  "type": "text",
  "links": [
    {
      "href": "text",
      "rel": "text",
      "type": "text",
      "title": "text"
    }
  ],
  "timeStamp": "2024-11-22T05:09:42.047Z",
  "features": [
    {
      "id": "text",
      "type": "text",
      "geometry": {
        "type": "text",
        "coordinates": [
          {
            "x": 0,
            "y": 0
          }
        ]
      }
    }
  ]
}

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

{
  "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"
    }
  ]
}

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

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