Page cover image

Using OS APIs in ESRI Software

OS Maps API

OS Maps API is a way of accessing OS base mapping quickly and easily. It shows the most up-to-date data that is available with a choice of the typical OS Styles

  • Leisure

  • Light

  • Outdoor

  • Road

It does require an internet connection and an API key that you can create via your OS

Step 1

When adding an API to your project navigate to ‘Connections’ under the Insert toolbar. Select New WMTS Server

Step 2

Copy your OS Maps API WMTS Endpoint Address into the Server URL box

Remove "key=" and copy in your key

Create a Custom request parameter where the parameter is ‘key’ and paste your key into the Value box

Then click ‘OK’

Step 3

Show your Catalog Pane in your map and now you will have OS Maps API under your Servers folder. All of the different styles of the OS Maps API are available here to drag and drop into your map

Step 4

Drag and drop the basemap that you want into your map and it will appear in the Contents Pane ready to be switched on and used as a OS basemap for your project

OS NGD Features API

OS NGD Features API is a way of accessing all the data within the OS NGD quickly and easily.

You are provided with a list of the individual feature datasets available within the OS NGD and can add them individually.

You cannot choose and area of interest, the API will load all of GB. This can mean a long loading time.

It does require an internet connection and an API key that you can create via your OS

Step 1

Open up a map project and click the add symbol which appears at the top of the toolbar. Select add layer from URL

Step 2

Copy your OS Maps API OGC Feature Endpoint Address into the URL box

Remove "key=" and copy your key

Create a Custom parameter where the parameter is ‘key’ and paste your key into the Value box

Select the OGC Feature Type

Select Use as basemap if this is what you want to do

Then click ‘Next’

Step 3

Select the OS NGD layer you want to add to your map. You can only select one layer at a time.

Step 4

The layer will appear under your map layers. You will likely need to zoom into the map to get the right scale for the data to show. All the OS NGD features appear in a basic orange style.

To build up your map with OS NGD layers you will need to follow this process each time, adding a new OS NGD layer.

OS Features API

OS Features API is a way of accessing all the OS MasterMap, Zoomstack, and Open data products quickly and easily

You are provided with a list of all the product data layers and can add them individually

You cannot choose and area of interest, the API will load all of GB It does require an internet connection and an API key that you can create via your OS Data Hub Account

Note we have found issues with loading OS Features API into ArcPRO 3.1.0

Step 1

When adding an API to your project navigate to ‘Connections’ under the Insert toolbar. Select New WFS Server

Step 2

Copy your OS Features API Endpoint Address into the Server URL box

Remove "key=" and copy your key

Create Custom request parameters for

KEY (and paste your key into the Value box)

Then click ‘OK’

Step 3

In the Catalog Pane under the Servers folder you will now see the OS Features API connection WFS

Step 4

Drag and drop the layer that you want into your map and it will appear in the Contents Pane ready to be switched on and be used.

Step 5

For each layer that you add from the API to your project change the WFS connection mode from Snapshot to On demand.

You can do this by right clicking the layer in the Contents and clicking on Properties at the bottom.

By changing it from Snapshot to On demand it will only request the features that appear in the map extent, which a faster loading time

For more information on OS Select+Build and the OS data available to developers, business, and government, visit the OS Data Hub.

Last updated

Was this helpful?