# 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

<figure><img src="/files/EErNGlWpHcr36BWcMuxT" alt=""><figcaption></figcaption></figure>

{% tabs %}
{% tab title="OS Maps API with ESRI ArcPRO" %}
Step 1

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

<figure><img src="/files/6qcK57jdBVvIXwLdGJKO" alt=""><figcaption></figcaption></figure>

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’

<figure><img src="/files/wcdlrplzBDBev4uBnT3a" alt=""><figcaption></figcaption></figure>

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

<figure><img src="/files/Bu0L4ikpUe8Pu7WSHQj1" alt=""><figcaption></figcaption></figure>

Step 4

<figure><img src="/files/TrPjbq30Ee6Sgwt4NKmi" alt=""><figcaption></figcaption></figure>

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
{% endtab %}

{% tab title="OS Maps API with ArcGIS Online" %}
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

<figure><img src="/files/u7R2nLxJD3DEhHxy7loS" alt=""><figcaption><p>Travelling sales person routing</p></figcaption></figure>

Step 2

Copy your OS Maps API WMTS 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 WMTS (OGC) Type

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

Then click ‘Next’

<figure><img src="/files/arGZUJa9NV7s8uBFDZ3n" alt="" width="563"><figcaption></figcaption></figure>

Step 3

Select which style of OS Maps basemapping you would like to add to the project. You can only add one at a time.

<figure><img src="/files/2ZjiaCGXSvxVSFmgNVxN" alt=""><figcaption></figcaption></figure>

Step 4

<figure><img src="/files/OpbQlKPJ8QPvdvvPIhgX" alt="" width="514"><figcaption></figcaption></figure>

The layer is added to your map project, and if you selected to be used as a basemap will appear under your basemap layers
{% endtab %}
{% endtabs %}

## 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

<figure><img src="/files/U6LA4RI3VhINmtRiPTVu" alt=""><figcaption></figcaption></figure>

{% tabs %}
{% tab title="OS Maps API with ArcGIS Online" %}
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

<figure><img src="/files/kRTdy32mNlibkVUotz3N" alt="" width="563"><figcaption></figcaption></figure>

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’

<figure><img src="/files/Hmit8DDWeT9W1NFR8BWA" alt="" width="563"><figcaption></figcaption></figure>

Step 3

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

<figure><img src="/files/vhI1t3Sjpf5RnWY9oKLk" alt="" width="563"><figcaption></figcaption></figure>

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.

<figure><img src="/files/4fk5mW7EfqdIf9WEJE9W" alt="" width="563"><figcaption></figcaption></figure>
{% endtab %}
{% endtabs %}

## 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

<figure><img src="/files/rwKCQy245d97T6YsRaPN" alt=""><figcaption></figcaption></figure>

{% tabs %}
{% tab title="OS Features API with ESRI ArcPRO" %}
Step 1

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

<figure><img src="/files/cBYzIi70YX79IzTf1Ce8" alt="" width="517"><figcaption></figcaption></figure>

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’

<figure><img src="/files/QkcjdX1hXnzDuNTyYMCr" alt="" width="496"><figcaption></figcaption></figure>

Step 3

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

<figure><img src="/files/porxq3Bn7r5TokLG0SFx" alt="" width="324"><figcaption></figcaption></figure>

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.

<figure><img src="/files/W9uapsduK9ymPOe2Ka4N" alt="" width="563"><figcaption></figcaption></figure>

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

<figure><img src="/files/qx54pyJeOQfoMo5VwTaq" alt="" width="277"><figcaption></figcaption></figure>
{% endtab %}

{% tab title="OS Features API with ArcGIS Online" %}
Step 1

Download the Connector for OS Features API

[Connector for OS Features API by Esri UK - ArcGIS Marketplace Listing](https://www.esri.com/en-us/arcgis-marketplace/listing/products/539e395c45b141de850140a80a2cbd61)

<figure><img src="/files/ZLNNr8aANna8tvT2BEWm" alt="" width="386"><figcaption></figcaption></figure>

Step 2

View Item, and sign in to your AGOL account. You will then see the Connector page ready for you to create a OS Features API Connector.

<figure><img src="/files/HFWdE4CbuoobjanTyeZz" alt="" width="563"><figcaption></figcaption></figure>

Step 3

On the Connector page you can select from the Services list what dataset you want to ‘connect’ to.

As this connector is bespoke to OS Features API you only need to input your API key in the API key box

Then you can select create your service. The Service connector will then be saved in your folder on your AGOL contents page, ready for you to load into your map

<figure><img src="/files/7l2HomwKVAz2QKfDLmLX" alt="" width="551"><figcaption></figcaption></figure>

Step 4

Add the service into your map and it will appear like a standard feature layer in your layers list.

The styling is the same as OS NGD Features API basic orange polygons, points, or lines

<figure><img src="/files/WuNlFXaBeLVrxJDc5mTU" alt="" width="494"><figcaption></figcaption></figure>
{% endtab %}
{% endtabs %}

For more information on OS Select+Build and the OS data available to developers, business, and government, visit the [OS Data Hub](https://osdatahub.os.uk/).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.os.uk/more-than-maps/using-os-mapping-apis/using-os-apis-in-esri-software.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.