1 of 11

OS NGD API – Tiles

What is OS NGD API – Tiles?

OS NGD API – Tiles offers you a vector tile service powered by the OS NGD. It provides a detailed and customisable basemap that's based on the latest to help you create stunning and interactive web maps. It can be used with most web mapping libraries, including OpenLayers, MapLibre GL JS and Leaflet. The major benefit of vector tiles is that they are optimised for use across the internet and are therefore great for building interactive web maps that allow users to zoom, pan, rotate, tilt and more.

You have a choice between using Ordnance Survey styles or creating your own. You can customise the content and style to create a professional-looking map that perfectly meets your needs, matches your branding, and pleases your customers.

OS NGD API – Tiles is available in two projections: British National Grid for Great Britain (GB) data and Web Mercator, a global coordinate system.

Benefits

Things to remember for OS NGD API – Tiles

You can:

Use it as a basemap in GIS, web or mobile applications.
View the whole of Great Britain in unrivalled detail.
Seamlessly pan, zoom, pitch and tilt the map.
Overlay your own data on the basemap to give geographic context to your data.
Trace over OS NGD (Premium Data) detailed geometries.
Customise the map style and content to create the map you need.
Access maps in different projections: British National Grid and Web Mercator.

You can't:

Retrieve all the detailed attribution from OS NGD data.
Access data from the:
- OS NGD Address Theme
- OS NGD Routing and Asset Management Information (RAMI) Collection (of the OS NGD Transport Theme)

What data is available?

What feature types are available in OS NGD API – Tiles?

Basemap (ngd-base)

The following table details the OS NGD datasets that were used to create the OS NGD API – Tiles basemap. The result is a detailed OS basemap that combines and OS NGD data.

Theme

Collection

Feature Type(s)

Find out more about the hierarchy of OS NGD data .

If you are interested in addressing information, provides a detailed view of an address and its lifecycle, giving you direct access to rich address data for geocoding, postcode searching, form-filling and much more.

Data overlays

The following table details the OS NGD datasets that can be used as overlays to the basemap to add additional information:

Attribution available in OS NGD API – Tiles

The following attribution is available as part of OS NGD API – Tiles:

The map features do not contain every OS NGD feature type, nor the complete list of attribution available within the feature types that are included; we have purposefully only selected feature types and a subset of attribution from them that are useful for visualisation as this keeps the tiles lightweight and quick to render.

Update frequency

Technical Specification

OS NGD API – Tiles 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.

Getting Started

The following pages provide an overview of how to get started using the OS NGD API – Tiles. They cover the core elements to get started in the most common and .

These pages should be used in conjunction with the more detailed pages within the and .

GIS Software

Accessing OS NGD data with OS NGD API – Tiles via GIS software

The following sub-sections provide step-by-step instructions on how to access OS NGD data via OS NGD API – Tiles in various GIS software packages:

Cadcorp SIS
QGIS

Cadcorp SIS

Accessing OS NGD data with OS NGD API – Tiles via Cadcorp SIS

The Cadcorp Spatial Information System® (Cadcorp SIS®) is an integrated family of geospatial products comprising desktop, web, and developer applications.

Cadcorp SIS Desktop connects directly to the OS Data Hub through dedicated wizards.

What you need

Cadcorp SIS (version SIS 9.1 or later).
OS NGD API – Tiles added to an API project in the OS Data Hub with an API Key. See for more information.

Instructions

These instructions are based on Cadcorp SIS Desktop version 9.1.2109.64.

In Cadcorp SIS Desktop, open an existing map or create a new one.
In the Home tab, click Add Overlay.
In the Overlay Types dialog, select Ordnance Survey (GB) > OS (GB) Data Hub, and then click Next.
In the OS (GB) Data Hub dialog:
- Select OS National Geographic Database (NGD) API - Tiles.
- API Key: Enter your API key.
- Premium / Public Sector Plan: Select this option if you have this plan.
- Save in the UI settings database (encrypted): Select this option.
- Click Next.
In the OS (GB) Data Hub NGD API - Tiles dialog, select the appropriate layer from the list of available options, and then click Finish.
The selected layer will automatically display in the map area.

QGIS

Accessing OS NGD data with OS NGD API – Tiles via QGIS

QGIS is an open GIS (Geospatial Information System) desktop application that allows you to display, interrogate, visualise and create geospatial information including from geo-centric APIs (for example, a Vector Tiles Service).

The instructions that follow demonstrate how to connect to OS NGD API – Tiles using QGIS.

What you'll need

QGIS (version 3.22.0 or later).
OS NGD API – Tiles added to an API project in the OS Data Hub with an API Key. See for more information.

Instructions

Open an existing project or create a new one.
Deselect the Render checkbox in the bottom bar, if necessary.

Navigate to Layer > Add Layer > Add Vector Tile Layer...

In Data Source Manager | Vector Tile, click the New button below the drop-down menu and select New Generic Connection...

The Vector Tiles Connection dialog that pops up requires you to input the API information you obtained in the OS Data Hub.

In the Vector Tiles Connection dialog, provide the service details of the API:

Name: Provide a name for the connection. It is good practice to name your connections in a way that makes them instantly recognisable. You can reuse this connection in the future.
URL: Copy the OS NGD API – Tiles endpoint address from the OS Data Hub and paste it into this field. Your API Key is automatically appended to this URL in the key parameter.
Min. and Max. Zoom Levels: Set these as follows based on your preferred projection:
- Web Mercator (EPSG: 3857): Min Zoom = 6; Max Zoom = 19
- British National Grid (BNG: EPSG: 27700): Min Zoom = 0; Max Zoom = 15
Style URL: Input the OS NGD API – Tiles style URL to style the tiles based on the default style for the specified OS NGD collection.
Authentication: Leave these settings at their defaults. You do not need a username or password as authentication is done through your API Key.
Other: Leave all other settings at their defaults.
Click OK.

To retrieve tiles and style them appropriately, you will need two URLs. The URLs have slight variations based on the collection ID and projection.

Here are some example URLs to retrieve the basemap (ngd-base) in Web Mercator (EPSG: 3857):

Please note: You will need to replace the /{tileMatrix}/{tileRow}/{tileCol} used in the default 'retrieve tile' URL with /{z}/{y}/{x} to be able to connect to OS NGD API – Tiles.

In Data Source Manager | Vector Tile, click Add and Close. You'll then see the map displayed in the main QGIS UI.

Libraries

Accessing OS NGD data with OS NGD API – Tiles via web mapping libraries

The following sub-sections provide step-by-step instructions on how to access OS NGD data via OS NGD API – Tiles in various web mapping libraries:

Leaflet

Accessing OS NGD API – Tiles via Leaflet

is an open-source JavaScript library for displaying interactive maps on the web or mobile. A simple and lightweight library that will enable you to display and visualise location data and build dynamic applications.

What you'll need

OS NGD API – Tiles added to an API project in the OS Data Hub with an API Key. See for more information.
A text editor like Visual Studio Code or Notepad to edit and save your HTML and JavaScript files.

Create a basic vector map

Step 1: Set up your HTML file

Create a new HTML file with a text editor (for example, Notepad, Visual Studio Code).
Add the basic HTML structure to your file with a placeholder <div> for the map.

Step 2: Insert your API Key

To enable access to OS APIs an API Key is required. Inside the <script> tag, add a variable called apiKey, replacing 'INSERT_API_KEY_HERE' with the API Key from your project.
Inside the <script> tag, add another variable called collectionIdwith the collection ID for the OS NGD API – Tiles basemap – ngd-base.

Step 3: Adding a fetch and response interceptor

We need to intercept and customise the style request, adding a tiles property to provide a correctly formatted URL and ensure authentication through the apiKey is enabled to make sure that the correct tiles are requested.
Add the following code inside the JavaScript block:

Step 4: Create a map and map view

Initialize the map object using the L.Map class to configure the vector tile layer and the mapOptions variable to define its properties – minZoom, maxZoom, maxBounds, center and zoom.

The above code creates the main map instance using the Leaflet library where you can specify various properties:

minZoom and maxZoom: Sets the minimum and maximum zoom level for the map. Users will not be able to go beyond these levels.
maxBounds: Defines the maximum bounds and restricts panning the map.
center: Sets the initial centre point of the map.
zoom: Sets the initial zoom level of the map.

What's next?

Congratulations! You've successfully created a vector map using Leaflet using OS NGD API – Tiles in a few steps.

MapLibre GL JS

Accessing OS NGD API – Tiles via MapLibre GL JS

is a free and powerful JavaScript library for displaying interactive maps on the web. It's based on Mapbox GL JS and provides a wide range of features for creating maps with custom styles, markers and interactivity.

What you'll need

OS NGD API – Tiles added to an API project in the OS Data Hub with an API Key. See for more information.
A text editor like Visual Studio Code or Notepad to edit and save your HTML and JavaScript files.

Create a basic vector map

Step 1: Set up your HTML file

Create a new HTML file with a text editor (for example, Notepad, Visual Studio Code).
Add the basic HTML structure to your file with a placeholder <div> for the map.

Step 2: Insert your API Key

To enable access to OS APIs an API Key is required. Inside the <script> tag, add a variable called apiKey, replacing 'INSERT_API_KEY_HERE' with the API Key from your project.
Inside the <script> tag, add another variable called collectionId with the collection ID for the OS NGD API – Tiles basemap – ngd-base.

Step 3: Adding a fetch and response interceptor

We need to intercept and customise the style request, adding a tiles property to provide a correctly formatted URL and ensuring authentication through the apiKey is enabled to make sure that the correct tiles are requested.
Add the following code inside the JavaScript block:

Step 4: Create a map and map view

Initialise the map object using the maplibregl.Map class to configure the vector tile layer and define its properties – container, minZoom, maxZoom, maxBounds, style, center and zoom.
Add navigation controls to the map, excluding the compass button and disabling map rotation.

The above code creates the main map instance using the MapLibre GL JS library where you can specify various properties:

container: Defines where the map should be displayed. In this instance, it is set to the ID of the <div> element.
minZoom and maxZoom: Sets the minimum and maximum zoom level for the map. Users will not be able to go beyond these levels.
maxBounds: Defines the maximum bounds and restricts panning the map.
style: Defines the style of the map, configured via a URL pointing at the default style for the 'collectionId' defined.
center: Sets the initial centre point of the map.
zoom: Sets the initial zoom level of the map.

What's next?

Congratulations! You've successfully created a vector map using MapLibre GL JS using OS NGD API – Tiles in a few steps.

OpenLayers

Accessing OS NGD API – Tiles via OpenLayers

OpenLayers is a free and open-source JavaScript library for displaying interactive maps on the web. It is a powerful tool that can be used to create a wide variety of map-based applications, from simple web maps to complex GIS applications.

OpenLayers is easy to use and can be integrated with a variety of other web development frameworks.

What you'll need

OS NGD API – Tiles added to an API project in the OS Data Hub with an API Key. See Getting started with an API project for more information.
A text editor like Visual Studio Code or Notepad to edit and save your HTML and JavaScript files.

Create a basic vector map

Step 1: Set up your HTML file

Create a new HTML file with a text editor (for example, Notepad, Visual Studio Code).
Add the basic HTML structure to your file with a placeholder <div> for the map.

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>OS NGD API – Tiles | Template (EPSG:3857) | OpenLayers</title>
    
    <!--Add the Ordnance Survey Styling-->
    <link rel="stylesheet" href="https://labs.os.uk/public/os-api-branding/v0.3.1/os-api-branding.css" />
    <script src="https://labs.os.uk/public/os-api-branding/v0.3.1/os-api-branding.js"></script>
    
    <!--Add the OpenLayers libraries-->
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/ol@v7.3.0/ol.css" />
    <script src="https://cdn.jsdelivr.net/npm/ol@v7.3.0/dist/ol.js"></script>
    <script src="https://unpkg.com/ol-mapbox-style@9.7.0/dist/olms.js"></script>
        
    <style>
        /* Set the map container size and style */
        body { margin: 0; padding: 0; }
        #map { position: absolute; top: 0; bottom: 0; width: 100%; }
    </style>
</head>
<body>
    
    <!--Create a div element to hold the map-->
    <div id="map"></div>
    
    <!--Add your Javascript code below--> 
    <script>
        // Your Javascript code will go here

    </script>

</body>
</html>

Step 2: Insert your API Key

To enable access to OS APIs an API Key is required. Inside the <script> tag, add a variable called apiKey, replacing 'INSERT_API_KEY_HERE' with the API Key from your project.
Inside the <script> tag, add another variable called collectionId with the collection ID for the OS NGD API – Tiles basemap – ngd-base.

// Set API Key and collection ID
 const apiKey = 'INSERT_API_KEY_HERE';
 
 const collectionId = 'ngd-base';

Step 3: Tile grid set up

To correctly render the vector tiles within OpenLayers, you will need to fetch the defined EPSG:3857 Tile Matrix Set and style definitions from the OS NGD API – Tiles service. The two endpoints provide information about the structure of the vector tiles and how the styles are to be applied.
A promise.all is used to process the data to ensure that both requests are completed before proceeding.
Based on the fetched Tile Matrix Set data, a tile grid is defined using the ol.tilegrid.TileGrid class. The tile grid provides information about the resolution, origin and tile sizes to handle the vector tiles correctly.
Add the following code inside the JavaScript block:

// Define the Tile Grid and style

const tmsPromise = fetch('https://api.os.uk/maps/vector/ngd/ota/v1/tilematrixsets/3857').then((response) => response .json());
const glStylePromise = fetch(`https://api.os.uk/maps/vector/ngd/ota/v1/collections/${collectionId}/styles/3857`).then((response) => response .json());

Promise.all([tmsPromise, glStylePromise]).then((values) => {
    const tms = values[0];
    const glStyle = values[1];

    const tilegrid = new ol.tilegrid.TileGrid({
        resolutions: tms.tileMatrices.map(({ cellSize }) => cellSize),
        origin: tms.tileMatrices[0].pointOfOrigin,
        tileSize: [ tms.tileMatrices[0].tileHeight, tms.tileMatrices[0].tileWidth ]
    });

Step 4: Define a vector tile layer

Define the a new vector tiles layer and source that will be used to fetch vector tiles from OS NGD API – Tiles. The ol.layer.VectorTile uses a ol.source.OGCVectorTile source to retrieve tiles from the API.
After creating the vector layer, you will need to use a style function to ensure that the Ordnance Survey styles are applied to each tile. Use the olms.applyStyle function to retrieve the style sheets available for the basemap.

// Define the vector tile layer.
    const formatMvt = new ol.format.MVT();
    formatMvt.supportedMediaTypes.push('application/octet-stream');

    const vectorTileLayer = new ol.layer.VectorTile({
        source: new ol.source.OGCVectorTile({
            url: `https://api.os.uk/maps/vector/ngd/ota/v1/collections/${collectionId}/tiles/3857?key=${apiKey}`,
            format: formatMvt,
            projection: 'EPSG:3857',
            tileGrid: tilegrid
        }),
        declutter: true
    });

// Apply a style function to the vector tile layer.
    olms.applyStyle(
        vectorTileLayer,
        glStyle,
        collectionId,
        { styleUrl: null } ,
        tilegrid.getResolutions()
    );

Step 5: Create a map and map view

Initialize the map object using the ol.map class to configure the vector tile layer and define its properties – target, layers and view.

// Initialize the map object.
    const map = new ol.Map({
        layers: [ vectorTileLayer ],
        target: 'map',
        view: new ol.View({
            projection: 'EPSG:3857',
            extent: ol.proj.transformExtent([ -10.76418, 49.528423, 1.9134116, 61.331151 ], 'EPSG:4326', 'EPSG:3857'),
            resolutions: tilegrid.getResolutions(),
            minZoom: 6,
            maxZoom: 19,
            center: ol.proj.fromLonLat([ -3.541809, 50.727589 ]),
            zoom: 17
        })
    });
});

The above code creates the main map instance using the OpenLayers library where you can specify various properties:

target: Defines where the map should be displayed. In this instance it is set to the ID of the <div> element.
layers: An array containing the layers to be added to the map.
view: Defines the initial view of the main, containing various settings such as projection, extent (the geographic bounds of the map), minimum and maximum zoom levels, centre of the map and the initial zoom level.

What's next?

Congratulations! You've successfully created a vector map using OpenLayers using OS NGD API – Tiles in a few steps.

Now you can continue to explore Ordnance Survey's code examples to learn more about advanced features and functionality, such as adding markers, pop-ups, and additional layers.

Technical Specification

Retrieve the OS NGD API – Tiles landing page for this service.

GEThttps://api.os.uk/maps/vector/ngd/ota/v1/

Response

The landing page provides links to the API definition (link relation service-desc, in this case path /api), to the Conformance declaration (path /conformance, link relation conformance), and to the Collections of geospatial data (path /collections, link relation data).

Body

titleThe title of the API.

While a title is not required, implementors are strongly advised to include one.

Example: "OS NGD API"

descriptionstring

Example: "Ordnance Survey National Geographic Database API."

attributionattribution for the API

The attribution should be short and intended for presentation to a user, for example, in a corner of a map. Parts of the text can be links to other resources if additional information is needed. The string can include HTML markup.

links*array of link (object)

href*string

Supplies the URI to a remote resource (or resource fragment).

Example: "http://data.example.com/buildingpart/123"

rel*string

The type or semantics of the relation.

Example: "alternate"

typestring

A hint indicating what the media type of the result of dereferencing the link should be.

Example: "application/geo+json"

templatedboolean

This flag set to true if the link is a URL template.

varBasestring

A base path to retrieve semantic information about the variables used in URL template.

Example: "/ogcapi/vars/"

hreflangstring

A hint indicating what the language of the result of dereferencing the link should be.

Example: "en"

titlestring

Used to label the destination of a link such that it can be used as a human-readable identifier.

Example: "Building Part"

lengthinteger

Request

Response

Retrieve the set of OS NGD API – Tiles conformance classes that are supported by this service.

GEThttps://api.os.uk/maps/vector/ngd/ota/v1/conformance

Response

The URIs of all conformance classes supported by the server

Body

conformsTo*array of string

itemsstring

Request

Response

Retrieve the list of geospatial data collections available from this service.

GEThttps://api.os.uk/maps/vector/ngd/ota/v1/collections

Response

The collections of (mostly geospatial) data available from this API. The dataset contains one or more collections. This resource provides information about and access to the collections. The response contains the list of collections. Each collection is accessible via one or more OGC API set of specifications, for which a link to relevant accessible resources, e.g. /collections/{collectionId}/(items, coverage, map, tiles...) is provided, with the corresponding relation type, as well as key information about the collection. This information includes:

a local identifier for the collection that is unique for the dataset;
a list of coordinate reference systems (CRS) in which data may be returned by the server. The first CRS is the default coordinate reference system (the default is always WGS 84 with axis order longitude/latitude);
an optional title and description for the collection;
an optional extent that can be used to provide an indication of the spatial and temporal extent of the collection - typically derived from the data;
for collections accessible via the Features or Records API, an optional indicator about the type of the items in the collection (the default value, if the indicator is not provided, is 'feature').

Body

links*array of link (object)

href*string

Supplies the URI to a remote resource (or resource fragment).

Example: "http://data.example.com/buildingpart/123"

rel*string

The type or semantics of the relation.

Example: "alternate"

typestring

A hint indicating what the media type of the result of dereferencing the link should be.

Example: "application/geo+json"

templatedboolean

This flag set to true if the link is a URL template.

varBasestring

A base path to retrieve semantic information about the variables used in URL template.

Example: "/ogcapi/vars/"

hreflangstring

A hint indicating what the language of the result of dereferencing the link should be.

Example: "en"

titlestring

Used to label the destination of a link such that it can be used as a human-readable identifier.

Example: "Building Part"

lengthinteger

collections*array of collectionInfo (object)

id*string

identifier of the collection used, for example, in URIs

Example: "buildingpart"

titlestring

human readable title of the collection

Example: "Building Part"

descriptionstring

a description of the data in the collection

Example: "Polygon feature representing a building."

links*array of link (object)

href*string

Supplies the URI to a remote resource (or resource fragment).

Example: "http://data.example.com/buildingpart/123"

rel*string

The type or semantics of the relation.

Example: "alternate"

typestring

A hint indicating what the media type of the result of dereferencing the link should be.

Example: "application/geo+json"

templatedboolean

This flag set to true if the link is a URL template.

varBasestring

A base path to retrieve semantic information about the variables used in URL template.

Example: "/ogcapi/vars/"

hreflangstring

A hint indicating what the language of the result of dereferencing the link should be.

Example: "en"

titlestring

Used to label the destination of a link such that it can be used as a human-readable identifier.

Example: "Building Part"

lengthinteger

extentExtent with Uniform Additional Dimensions Schema

The extent module only addresses spatial and temporal extents. This module extends extent by specifying how intervals and crs properties can be used to specify additional geometries.

spatialextent_spatial (object)

The spatial extent of the data in the collection.

bboxarray of array of number

One or more bounding boxes that describe the spatial extent of the dataset. In the Core only a single bounding box is supported.

Extensions may support additional areas. The first bounding box describes the overall spatial extent of the data. All subsequent bounding boxes describe more precise bounding boxes, e.g., to identify clusters of data. Clients only interested in the overall spatial extent will only need to access the first item in each array.

itemsnumber

crsenum

Coordinate reference system of the coordinates in the spatial extent (property bbox). The default reference system is WGS 84 longitude/latitude. In the Core the only other supported coordinate reference system is WGS 84 longitude/latitude/ellipsoidal height for coordinates with height. Extensions may support additional coordinate reference systems and add additional enum values.

http://www.opengis.net/def/crs/EPSG/0/3857http://www.opengis.net/def/crs/EPSG/0/3857hhttp://www.opengis.net/def/crs/OGC/1.3/CRS84http://www.opengis.net/def/crs/OGC/0/CRS84h

Request

Response

Retrieve the description of a collection available from this service.

GEThttps://api.os.uk/maps/vector/ngd/ota/v1/collections/{collectionId}

Path parameters

collectionId*AllCollections (enum)

Local identifier of a collection

ngd-baseasu-bdywtr-ctchtrn-ntwk-railway

Response

Information about a particular collection of (mostly geospatial) data available from this API. The collection is accessible via one or more OGC API set of specifications, for which a link to relevant accessible resources, e.g. /collections/{collectionId}/(items, coverage, map, tiles...) is contained in the response, with the corresponding relation type, as well as key information about the collection. This information includes:

a local identifier for the collection that is unique for the dataset;
a list of coordinate reference systems (CRS) in which data may be returned by the server. The first CRS is the default coordinate reference system (the default is always WGS 84 with axis order longitude/latitude);
an optional title and description for the collection;
an optional extent that can be used to provide an indication of the spatial and temporal extent of the collection - typically derived from the data;
for collections accessible via the Features or Records API, an optional indicator about the type of the items in the collection (the default value, if the indicator is not provided, is 'feature').

Body

id*string

identifier of the collection used, for example, in URIs

Example: "buildingpart"

titlestring

human readable title of the collection

Example: "Building Part"

descriptionstring

a description of the data in the collection

Example: "Polygon feature representing a building."

links*array of link (object)

href*string

Supplies the URI to a remote resource (or resource fragment).

Example: "http://data.example.com/buildingpart/123"

rel*string

The type or semantics of the relation.

Example: "alternate"

typestring

A hint indicating what the media type of the result of dereferencing the link should be.

Example: "application/geo+json"

templatedboolean

This flag set to true if the link is a URL template.

varBasestring

A base path to retrieve semantic information about the variables used in URL template.

Example: "/ogcapi/vars/"

hreflangstring

A hint indicating what the language of the result of dereferencing the link should be.

Example: "en"

titlestring

Used to label the destination of a link such that it can be used as a human-readable identifier.

Example: "Building Part"

lengthinteger

extentExtent with Uniform Additional Dimensions Schema

The extent module only addresses spatial and temporal extents. This module extends extent by specifying how intervals and crs properties can be used to specify additional geometries.

spatialextent_spatial (object)

The spatial extent of the data in the collection.

bboxarray of array of number

One or more bounding boxes that describe the spatial extent of the dataset. In the Core only a single bounding box is supported.

itemsnumber

crsenum

http://www.opengis.net/def/crs/EPSG/0/3857http://www.opengis.net/def/crs/EPSG/0/3857hhttp://www.opengis.net/def/crs/OGC/1.3/CRS84http://www.opengis.net/def/crs/OGC/0/CRS84h

Request

Response

Retrieve the list of available tiling schemes (tile matrix sets)

GEThttps://api.os.uk/maps/vector/ngd/ota/v1/tilematrixsets

Response

List of tile matrix sets (tiling schemes).

Body

tileMatrixSetsarray of Tile Matrix Set Item

idstring

Optional local tile matrix set identifier, e.g. for use as unspecified {tileMatrixSetId} parameter. Implementation of 'identifier'

titlestring

Title of this tile matrix set, normally used for display to a human

uristring (uri)

Reference to an official source for this tileMatrixSet

crsall of

CRS

Reference to one coordinate reference system (CRS)

links*array of link (object)

Links to related resources. A 'self' link to the tile matrix set definition is required.

href*string

Supplies the URI to a remote resource (or resource fragment).

Example: "http://data.example.com/buildingpart/123"

rel*string

The type or semantics of the relation.

Example: "alternate"

typestring

A hint indicating what the media type of the result of dereferencing the link should be.

Example: "application/geo+json"

templatedboolean

This flag set to true if the link is a URL template.

varBasestring

A base path to retrieve semantic information about the variables used in URL template.

Example: "/ogcapi/vars/"

hreflangstring

A hint indicating what the language of the result of dereferencing the link should be.

Example: "en"

titlestring

Used to label the destination of a link such that it can be used as a human-readable identifier.

Example: "Building Part"

lengthinteger

Request

Response

Retrieve the definition of the specified tiling scheme (tile matrix set)

GEThttps://api.os.uk/maps/vector/ngd/ota/v1/tilematrixsets/{tileMatrixSetId}

Path parameters

tileMatrixSetId*TileMatrixSets (enum)

Identifier for a supported TileMatrixSet

385727700

Response

tile matrix set

Body

titlestring

Title of this tile matrix set, normally used for display to a human

idstring

Tile matrix set identifier. Implementation of 'identifier'

uristring (uri)

Reference to an official source for this tileMatrixSet

orderedAxesarray of string

itemsstring

crs*all of

CRS

Reference to one coordinate reference system (CRS)

wellKnownScaleSetstring (uri)

Reference to a well-known scale set

tileMatrices*array of tileMatrix (object)

Describes scale levels and its tile matrices

id*string

Identifier selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile. Implementation of 'identifier'

scaleDenominator*number

Scale denominator of this tile matrix

cellSize*number

Cell size of this tile matrix

cornerOfOriginenum

The corner of the tile matrix (topLeft or bottomLeft) used as the origin for numbering tile rows and columns. This corner is also a corner of the (0, 0) tile.

topLeftbottomLeft

pointOfOrigin*array of number

Precise position in CRS coordinates of the corner of origin (e.g. the top-left corner) for this tile matrix. This position is also a corner of the (0, 0) tile. In previous version, this was 'topLeftCorner' and 'cornerOfOrigin' did not exist.

itemsnumber

tileWidth*number (integer)

Width of each tile of this tile matrix in pixels

tileHeight*number (integer)

Height of each tile of this tile matrix in pixels

matrixHeight*number (integer)

Width of the matrix (number of tiles in width)

matrixWidth*number (integer)

Height of the matrix (number of tiles in height)

Request

Response

Retrieve a list of available vector tilesets for the specified collection.

GEThttps://api.os.uk/maps/vector/ngd/ota/v1/collections/{collectionId}/tiles

Path parameters

collectionId*AllCollections (enum)

Local identifier of a collection

ngd-baseasu-bdywtr-ctchtrn-ntwk-railway

Response

List of available tilesets.

Body

linksarray of link (object)

href*string

Supplies the URI to a remote resource (or resource fragment).

Example: "http://data.example.com/buildingpart/123"

rel*string

The type or semantics of the relation.

Example: "alternate"

typestring

A hint indicating what the media type of the result of dereferencing the link should be.

Example: "application/geo+json"

templatedboolean

This flag set to true if the link is a URL template.

varBasestring

A base path to retrieve semantic information about the variables used in URL template.

Example: "/ogcapi/vars/"

hreflangstring

A hint indicating what the language of the result of dereferencing the link should be.

Example: "en"

titlestring

Used to label the destination of a link such that it can be used as a human-readable identifier.

Example: "Building Part"

lengthinteger

tilesets*array of Tile Set Metadata item

idstring

identifier of the tile matrix set

Example: "3857"

titlestring

A title for this tileset

dataType*all of

DataType (enum)

Type of data

mapvectorcoverage

crs*all of

CRS

Reference to one coordinate reference system (CRS)

tileMatrixSetURIstring (uri)

Reference to a Tile Matrix Set on an offical source for Tile Matrix Sets such as the OGC NA definition server (http://www.opengis.net/def/tms/). Required if the tile matrix set is registered on an open official source.

links*array of link (object)

Links to related resources. A 'self' link to the tileset as well as a 'http://www.opengis.net/def/rel/ogc/1.0/tiling-scheme' link to a definition of the TileMatrixSet are required.

href*string

Supplies the URI to a remote resource (or resource fragment).

Example: "http://data.example.com/buildingpart/123"

rel*string

The type or semantics of the relation.

Example: "alternate"

typestring

A hint indicating what the media type of the result of dereferencing the link should be.

Example: "application/geo+json"

templatedboolean

This flag set to true if the link is a URL template.

varBasestring

A base path to retrieve semantic information about the variables used in URL template.

Example: "/ogcapi/vars/"

hreflangstring

A hint indicating what the language of the result of dereferencing the link should be.

Example: "en"

titlestring

Used to label the destination of a link such that it can be used as a human-readable identifier.

Example: "Building Part"

lengthinteger

Request

Response

Retrieve the vector tileset metadata for the specified collection and tiling scheme (tile matrix set)

GEThttps://api.os.uk/maps/vector/ngd/ota/v1/collections/{collectionId}/tiles/{tileMatrixSetId}

Path parameters

collectionId*AllCollections (enum)

Local identifier of a collection

ngd-baseasu-bdywtr-ctchtrn-ntwk-railway

tileMatrixSetId*TileSets (enum)

Identifier for a supported TileMatrixSet

385727700

Response

Description of the tileset

Body

idstring

identifier of the tile matrix set

Example: "3857"

titlestring

A title for this tileset

dataType*all of

DataType (enum)

Type of data

mapvectorcoverage

crs*all of

CRS

Reference to one coordinate reference system (CRS)

tileMatrixSetURIstring (uri)

links*array of link (object)

Links to related resources. A 'self' link to the tileset as well as a 'http://www.opengis.net/def/rel/ogc/1.0/tiling-scheme' link to a definition of the TileMatrixSet are required.

href*string

Supplies the URI to a remote resource (or resource fragment).

Example: "http://data.example.com/buildingpart/123"

rel*string

The type or semantics of the relation.

Example: "alternate"

typestring

A hint indicating what the media type of the result of dereferencing the link should be.

Example: "application/geo+json"

templatedboolean

This flag set to true if the link is a URL template.

varBasestring

A base path to retrieve semantic information about the variables used in URL template.

Example: "/ogcapi/vars/"

hreflangstring

A hint indicating what the language of the result of dereferencing the link should be.

Example: "en"

titlestring

Used to label the destination of a link such that it can be used as a human-readable identifier.

Example: "Building Part"

lengthinteger

Request

Response

Retrieve a vector tile from a collection.

GEThttps://api.os.uk/maps/vector/ngd/ota/v1/collections/{collectionId}/tiles/{tileMatrixSetId}/{tileMatrix}/{tileRow}/{tileCol}

Authorization

Path parameters

tileMatrix*string

Identifier selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.

Example: "15"

tileRow*integer

Row index of the tile on the selected TileMatrix.

Example: 11179

tileCol*integer

Column index of the tile on the selected TileMatrix.

Example: 16558

collectionId*AllCollections (enum)

Local identifier of a collection

ngd-baseasu-bdywtr-ctchtrn-ntwk-railway

tileMatrixSetId*TileSets (enum)

Identifier for a supported TileMatrixSet

385727700

Response

A vector tile returned as a response.

Body

string (binary)

Request

Response

Retrieve a vector tile from a collection for Web Mercator Quad EPSG: 3857 tile matrix set.

GEThttps://api.os.uk/maps/vector/ngd/ota/v1/collections/{collectionId}/tiles/{tileMatrix}/{tileRow}/{tileCol}

Authorization

Path parameters

tileMatrix*string

Identifier selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.

Example: "15"

tileRow*integer

Row index of the tile on the selected TileMatrix.

Example: 11179

tileCol*integer

Column index of the tile on the selected TileMatrix.

Example: 16558

collectionId*AllCollections (enum)

Local identifier of a collection

ngd-baseasu-bdywtr-ctchtrn-ntwk-railway

Response

A vector tile returned as a response.

Body

string (binary)

Request

Response

Retrieve the list of styles available from this service.

GEThttps://api.os.uk/maps/vector/ngd/ota/v1/collections/{collectionId}/styles

Path parameters

collectionId*AllCollections (enum)

Local identifier of a collection

ngd-baseasu-bdywtr-ctchtrn-ntwk-railway

Response

List of available styles.

Body

linksarray of link (object)

href*string

Supplies the URI to a remote resource (or resource fragment).

Example: "http://data.example.com/buildingpart/123"

rel*string

The type or semantics of the relation.

Example: "alternate"

typestring

A hint indicating what the media type of the result of dereferencing the link should be.

Example: "application/geo+json"

templatedboolean

This flag set to true if the link is a URL template.

varBasestring

A base path to retrieve semantic information about the variables used in URL template.

Example: "/ogcapi/vars/"

hreflangstring

A hint indicating what the language of the result of dereferencing the link should be.

Example: "en"

titlestring

Used to label the destination of a link such that it can be used as a human-readable identifier.

Example: "Building Part"

lengthinteger

styles*array of style-item (object)

id*string

titlestring

links*array of link (object)

href*string

Supplies the URI to a remote resource (or resource fragment).

Example: "http://data.example.com/buildingpart/123"

rel*string

The type or semantics of the relation.

Example: "alternate"

typestring

A hint indicating what the media type of the result of dereferencing the link should be.

Example: "application/geo+json"

templatedboolean

This flag set to true if the link is a URL template.

varBasestring

A base path to retrieve semantic information about the variables used in URL template.

Example: "/ogcapi/vars/"

hreflangstring

A hint indicating what the language of the result of dereferencing the link should be.

Example: "en"

titlestring

Used to label the destination of a link such that it can be used as a human-readable identifier.

Example: "Building Part"

lengthinteger

Request

Response

Root level properties of a style specify the map's layers, tile sources and other resources, and default values for the initial camera position when not specified elsewhere.

GEThttps://api.os.uk/maps/vector/ngd/ota/v1/collections/{collectionId}/styles/{styleId}

Path parameters

collectionId*AllCollections (enum)

Local identifier of a collection

ngd-baseasu-bdywtr-ctchtrn-ntwk-railway

styleId*Styles (enum)

An identifier representing a specific style.

385727700

Response

Body

object

Request

Response

Styling resources such as fonts and sprites

GEThttps://api.os.uk/maps/vector/ngd/ota/v1/collections/{collectionId}/styles/{styleId}/{resourceBaseName}/**

Path parameters

collectionId*AllCollections (enum)

Local identifier of a collection

ngd-baseasu-bdywtr-ctchtrn-ntwk-railway

styleId*Styles (enum)

An identifier representing a specific style.

385727700

resourceBaseName*string

Styling resourece base name.

Example: "sprites"

Response

Body

object

Request

Response

MapLibre GL JS

Accessing OS NGD API – Tiles via MapLibre GL JS

What you'll need

OS NGD API – Tiles added to an API project in the OS Data Hub with an API Key. See for more information.
A text editor like Visual Studio Code or Notepad to edit and save your HTML and JavaScript files.

Create a basic vector map

Step 1: Set up your HTML file

Create a new HTML file with a text editor (for example, Notepad, Visual Studio Code).
Add the basic HTML structure to your file with a placeholder <div> for the map.

Step 2: Insert your API Key

To enable access to OS APIs an API Key is required. Inside the <script> tag, add a variable called apiKey, replacing 'INSERT_API_KEY_HERE' with the API Key from your project.
Inside the <script> tag, add another variable called collectionId with the collection ID for the OS NGD API – Tiles basemap – ngd-base.

// Set API Key and collection ID
 const apiKey = 'INSERT_API_KEY_HERE';
 
 const collectionId = 'ngd-base';

Step 3: Adding a fetch and response interceptor

We need to intercept and customise the style request, adding a tiles property to provide a correctly formatted URL and ensuring authentication through the apiKey is enabled to make sure that the correct tiles are requested.
Add the following code inside the JavaScript block:

// Modify the JSON style request incorporate a `tiles` property which lists an array of tile endpoints.
// The '&key=' HTTP query parameter is also appended to each tile endpoint to authenticate the request.
// NOTE: The {z}, {x} and {y} template values are replaced with the corresponding integers at runtime.
    
    const { fetch: originalFetch } = window;
    window.fetch = async (...args) => {
        let [ resource, config ] = args;

        let response = await originalFetch(resource, config);
        if( response.url != `https://api.os.uk/maps/vector/ngd/ota/v1/collections/${collectionId}/styles/3857` )
            return response;

        // Response interceptor.
        const json = () =>
            response.clone().json().then((data) => {
                data.sources[ collectionId ].tiles = [ `${data.sources[ collectionId ].url}/{z}/{y}/{x}?key=${apiKey}` ];
                delete data.sources[ collectionId ].url;
                return data;
            });

        response.json = json;
        return response;
    };

Step 4: Create a map and map view

Initialise the map object using the maplibregl.Map class to configure the vector tile layer and define its properties – container, minZoom, maxZoom, maxBounds, style, center and zoom.
Add navigation controls to the map, excluding the compass button and disabling map rotation.

// Initialize the map object.
    const map = new maplibregl.Map({
        container: 'map',
        minZoom: 6,
        maxZoom: 19,
        maxBounds: [ [ -8.74, 49.84 ], [ 1.96, 60.9 ] ],
        style: `https://api.os.uk/maps/vector/ngd/ota/v1/collections/${collectionId}/styles/3857`,
        center: [ -3.541809, 50.727589 ],
        zoom: 17,
        attributionControl: false
    });

    map.dragRotate.disable(); // Disable map rotation using right click + drag.
    map.touchZoomRotate.disableRotation(); // Disable map rotation using touch rotation gesture.

    // Add navigation control (excluding compass button) to the map.
    map.addControl(new maplibregl.NavigationControl({
        showCompass: false
    }));

The above code creates the main map instance using the MapLibre GL JS library where you can specify various properties:

container: Defines where the map should be displayed. In this instance, it is set to the ID of the <div> element.
minZoom and maxZoom: Sets the minimum and maximum zoom level for the map. Users will not be able to go beyond these levels.
maxBounds: Defines the maximum bounds and restricts panning the map.
style: Defines the style of the map, configured via a URL pointing at the default style for the 'collectionId' defined.
center: Sets the initial centre point of the map.
zoom: Sets the initial zoom level of the map.

What's next?

Congratulations! You've successfully created a vector map using MapLibre GL JS using OS NGD API – Tiles in a few steps.

Now you can continue to explore Ordnance Survey's to learn more about advanced features and functionality, such as adding markers, pop-ups, and additional layers.

Leaflet

Accessing OS NGD API – Tiles via Leaflet

What you'll need

OS NGD API – Tiles added to an API project in the OS Data Hub with an API Key. See for more information.
A text editor like Visual Studio Code or Notepad to edit and save your HTML and JavaScript files.

Create a basic vector map

Step 1: Set up your HTML file

Create a new HTML file with a text editor (for example, Notepad, Visual Studio Code).
Add the basic HTML structure to your file with a placeholder <div> for the map.

Step 2: Insert your API Key

To enable access to OS APIs an API Key is required. Inside the <script> tag, add a variable called apiKey, replacing 'INSERT_API_KEY_HERE' with the API Key from your project.
Inside the <script> tag, add another variable called collectionIdwith the collection ID for the OS NGD API – Tiles basemap – ngd-base.

// Set API Key and collection ID
 const apiKey = 'INSERT_API_KEY_HERE';
 
 const collectionId = 'ngd-base';

Step 3: Adding a fetch and response interceptor

We need to intercept and customise the style request, adding a tiles property to provide a correctly formatted URL and ensure authentication through the apiKey is enabled to make sure that the correct tiles are requested.
Add the following code inside the JavaScript block:

// Modify the JSON style request incorporate a `tiles` property which lists an array of tile endpoints.
// The '&key=' HTTP query parameter is also appended to each tile endpoint to authenticate the request.
// NOTE: The {z}, {x} and {y} template values are replaced with the corresponding integers at runtime.
    const { fetch: originalFetch } = window;
    window.fetch = async (...args) => {
        let [ resource, config ] = args;

        let response = await originalFetch(resource, config);
        if( response.url != `https://api.os.uk/maps/vector/ngd/ota/v1/collections/${collectionId}/styles/3857` )
            return response;

        // Response interceptor.
        const json = () =>
            response.clone().json().then((data) => {
                delete data.sources[ collectionId ].url;
                data.sources[ collectionId ].tiles = [ `https://api.os.uk/maps/vector/ngd/ota/v1/collections/${collectionId}/tiles/3857/{z}/{y}/{x}?key=${apiKey}` ];
                return data;
            });

        response.json = json;
        return response;
    };

Step 4: Create a map and map view

Initialize the map object using the L.Map class to configure the vector tile layer and the mapOptions variable to define its properties – minZoom, maxZoom, maxBounds, center and zoom.

// Initialize the map.
    const mapOptions = {
        minZoom: 7,
        maxZoom: 20,
        center: [ 50.727589, -3.541809 ],
        zoom: 18,
        maxBounds: [
            [ 49.528423, -10.76418 ],
            [ 61.331151, 1.9134116 ]
        ],
        attributionControl: false
    };

    const map = L.map('map', mapOptions);

    // Load and display vector tile layer on the map.
    const gl = L.maplibreGL({
        style: `https://api.os.uk/maps/vector/ngd/ota/v1/collections/${collectionId}/styles/3857`
    }).addTo(map);

The above code creates the main map instance using the Leaflet library where you can specify various properties:

minZoom and maxZoom: Sets the minimum and maximum zoom level for the map. Users will not be able to go beyond these levels.
maxBounds: Defines the maximum bounds and restricts panning the map.
center: Sets the initial centre point of the map.
zoom: Sets the initial zoom level of the map.

What's next?

Congratulations! You've successfully created a vector map using Leaflet using OS NGD API – Tiles in a few steps.

Now you can continue to explore Ordnance Survey's to learn more about advanced features and functionality, such as adding markers, pop-ups, and additional layers.

OpenLayers

Accessing OS NGD API – Tiles via OpenLayers

OpenLayers is easy to use and can be integrated with a variety of other web development frameworks.

What you'll need

OS NGD API – Tiles added to an API project in the OS Data Hub with an API Key. See Getting started with an API project for more information.
A text editor like Visual Studio Code or Notepad to edit and save your HTML and JavaScript files.

Create a basic vector map

Step 1: Set up your HTML file

Create a new HTML file with a text editor (for example, Notepad, Visual Studio Code).
Add the basic HTML structure to your file with a placeholder <div> for the map.

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>OS NGD API – Tiles | Template (EPSG:3857) | OpenLayers</title>
    
    <!--Add the Ordnance Survey Styling-->
    <link rel="stylesheet" href="https://labs.os.uk/public/os-api-branding/v0.3.1/os-api-branding.css" />
    <script src="https://labs.os.uk/public/os-api-branding/v0.3.1/os-api-branding.js"></script>
    
    <!--Add the OpenLayers libraries-->
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/ol@v7.3.0/ol.css" />
    <script src="https://cdn.jsdelivr.net/npm/ol@v7.3.0/dist/ol.js"></script>
    <script src="https://unpkg.com/ol-mapbox-style@9.7.0/dist/olms.js"></script>
        
    <style>
        /* Set the map container size and style */
        body { margin: 0; padding: 0; }
        #map { position: absolute; top: 0; bottom: 0; width: 100%; }
    </style>
</head>
<body>
    
    <!--Create a div element to hold the map-->
    <div id="map"></div>
    
    <!--Add your Javascript code below--> 
    <script>
        // Your Javascript code will go here

    </script>

</body>
</html>

Step 2: Insert your API Key

To enable access to OS APIs an API Key is required. Inside the <script> tag, add a variable called apiKey, replacing 'INSERT_API_KEY_HERE' with the API Key from your project.
Inside the <script> tag, add another variable called collectionId with the collection ID for the OS NGD API – Tiles basemap – ngd-base.

// Set API Key and collection ID
 const apiKey = 'INSERT_API_KEY_HERE';
 
 const collectionId = 'ngd-base';

Step 3: Tile grid set up

To correctly render the vector tiles within OpenLayers, you will need to fetch the defined EPSG:3857 Tile Matrix Set and style definitions from the OS NGD API – Tiles service. The two endpoints provide information about the structure of the vector tiles and how the styles are to be applied.
A promise.all is used to process the data to ensure that both requests are completed before proceeding.
Based on the fetched Tile Matrix Set data, a tile grid is defined using the ol.tilegrid.TileGrid class. The tile grid provides information about the resolution, origin and tile sizes to handle the vector tiles correctly.
Add the following code inside the JavaScript block:

// Define the Tile Grid and style

const tmsPromise = fetch('https://api.os.uk/maps/vector/ngd/ota/v1/tilematrixsets/3857').then((response) => response .json());
const glStylePromise = fetch(`https://api.os.uk/maps/vector/ngd/ota/v1/collections/${collectionId}/styles/3857`).then((response) => response .json());

Promise.all([tmsPromise, glStylePromise]).then((values) => {
    const tms = values[0];
    const glStyle = values[1];

    const tilegrid = new ol.tilegrid.TileGrid({
        resolutions: tms.tileMatrices.map(({ cellSize }) => cellSize),
        origin: tms.tileMatrices[0].pointOfOrigin,
        tileSize: [ tms.tileMatrices[0].tileHeight, tms.tileMatrices[0].tileWidth ]
    });

Step 4: Define a vector tile layer

Define the a new vector tiles layer and source that will be used to fetch vector tiles from OS NGD API – Tiles. The ol.layer.VectorTile uses a ol.source.OGCVectorTile source to retrieve tiles from the API.
After creating the vector layer, you will need to use a style function to ensure that the Ordnance Survey styles are applied to each tile. Use the olms.applyStyle function to retrieve the style sheets available for the basemap.

// Define the vector tile layer.
    const formatMvt = new ol.format.MVT();
    formatMvt.supportedMediaTypes.push('application/octet-stream');

    const vectorTileLayer = new ol.layer.VectorTile({
        source: new ol.source.OGCVectorTile({
            url: `https://api.os.uk/maps/vector/ngd/ota/v1/collections/${collectionId}/tiles/3857?key=${apiKey}`,
            format: formatMvt,
            projection: 'EPSG:3857',
            tileGrid: tilegrid
        }),
        declutter: true
    });

// Apply a style function to the vector tile layer.
    olms.applyStyle(
        vectorTileLayer,
        glStyle,
        collectionId,
        { styleUrl: null } ,
        tilegrid.getResolutions()
    );

Step 5: Create a map and map view

Initialize the map object using the ol.map class to configure the vector tile layer and define its properties – target, layers and view.

// Initialize the map object.
    const map = new ol.Map({
        layers: [ vectorTileLayer ],
        target: 'map',
        view: new ol.View({
            projection: 'EPSG:3857',
            extent: ol.proj.transformExtent([ -10.76418, 49.528423, 1.9134116, 61.331151 ], 'EPSG:4326', 'EPSG:3857'),
            resolutions: tilegrid.getResolutions(),
            minZoom: 6,
            maxZoom: 19,
            center: ol.proj.fromLonLat([ -3.541809, 50.727589 ]),
            zoom: 17
        })
    });
});

The above code creates the main map instance using the OpenLayers library where you can specify various properties:

target: Defines where the map should be displayed. In this instance it is set to the ID of the <div> element.
layers: An array containing the layers to be added to the map.
view: Defines the initial view of the main, containing various settings such as projection, extent (the geographic bounds of the map), minimum and maximum zoom levels, centre of the map and the initial zoom level.

What's next?

Congratulations! You've successfully created a vector map using OpenLayers using OS NGD API – Tiles in a few steps.

Now you can continue to explore Ordnance Survey's code examples to learn more about advanced features and functionality, such as adding markers, pop-ups, and additional layers.

Retrieve the list of geospatial data collections available from this service.

GEThttps://api.os.uk/maps/vector/ngd/ota/v1/collections

Response

a local identifier for the collection that is unique for the dataset;
a list of coordinate reference systems (CRS) in which data may be returned by the server. The first CRS is the default coordinate reference system (the default is always WGS 84 with axis order longitude/latitude);
an optional title and description for the collection;
an optional extent that can be used to provide an indication of the spatial and temporal extent of the collection - typically derived from the data;
for collections accessible via the Features or Records API, an optional indicator about the type of the items in the collection (the default value, if the indicator is not provided, is 'feature').

Body

links*array of link (object)

href*string

Supplies the URI to a remote resource (or resource fragment).

Example: "http://data.example.com/buildingpart/123"

rel*string

The type or semantics of the relation.

Example: "alternate"

typestring

A hint indicating what the media type of the result of dereferencing the link should be.

Example: "application/geo+json"

templatedboolean

This flag set to true if the link is a URL template.

varBasestring

A base path to retrieve semantic information about the variables used in URL template.

Example: "/ogcapi/vars/"

hreflangstring

A hint indicating what the language of the result of dereferencing the link should be.

Example: "en"

titlestring

Used to label the destination of a link such that it can be used as a human-readable identifier.

Example: "Building Part"

lengthinteger

collections*array of collectionInfo (object)

id*string

identifier of the collection used, for example, in URIs

Example: "buildingpart"

titlestring

human readable title of the collection

Example: "Building Part"

descriptionstring

a description of the data in the collection

Example: "Polygon feature representing a building."

links*array of link (object)

href*string

Supplies the URI to a remote resource (or resource fragment).

Example: "http://data.example.com/buildingpart/123"

rel*string

The type or semantics of the relation.

Example: "alternate"

typestring

A hint indicating what the media type of the result of dereferencing the link should be.

Example: "application/geo+json"

templatedboolean

This flag set to true if the link is a URL template.

varBasestring

A base path to retrieve semantic information about the variables used in URL template.

Example: "/ogcapi/vars/"

hreflangstring

A hint indicating what the language of the result of dereferencing the link should be.

Example: "en"

titlestring

Used to label the destination of a link such that it can be used as a human-readable identifier.

Example: "Building Part"

lengthinteger

extentExtent with Uniform Additional Dimensions Schema

The extent module only addresses spatial and temporal extents. This module extends extent by specifying how intervals and crs properties can be used to specify additional geometries.

spatialextent_spatial (object)

The spatial extent of the data in the collection.

bboxarray of array of number

One or more bounding boxes that describe the spatial extent of the dataset. In the Core only a single bounding box is supported.

itemsnumber

crsenum

http://www.opengis.net/def/crs/EPSG/0/3857http://www.opengis.net/def/crs/EPSG/0/3857hhttp://www.opengis.net/def/crs/OGC/1.3/CRS84http://www.opengis.net/def/crs/OGC/0/CRS84h

Request

Response