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.
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
Ordnance Survey National Geographic Database API – Features conformance page.
A known collection ID.
"bld-fts-building-1"
Schema for an Ordnance Survey National Geographic Database feature collection.
Ordnance Survey National Geographic Database API – Features landing page.
Get a list of all the available OS NGD feature collections
All Ordnance Survey National Geographic Database feature collections.
A known collection ID.
"bld-fts-building-1"
A feature ID which is the identifier(id) for the feature.
"11111111-1111-1111-1111-111111111111"
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).
A single feature in the feature collection.
A known collection ID.
"bld-fts-building-1"
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
.
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).
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).
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.
"2018-02-12T00:00:00Z/.."
The optional limit parameter limits the number of items that are presented in the response document. Minimum = 1. Maximum = 100. Default = 100.
The optional offset parameter skips past the specified number of features in the collection. Minimum = 0. Default = 0.
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.
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).
The optional filter-lang parameter is the specific language used for the filter parameter. Default = cql-text
A list of features in a feature collection.
Get information about an OS NGD feature collection
A known collection ID.
"bld-fts-building-1"
A single Ordnance Survey National Geographic Database feature collection.
A known collection ID.
"bld-fts-building-1"
A list of queryable attributes and their types for this feature collection.