Set up a new connection

Once a new project with a base map map has been set up, zoom in to a small area to reduce the number of requests that are initially sent to the API. Select Layer > Add Layer > Add WFS / OGC API - Features Layer.

Create a new connection

In the Data Source Manager | WFS / OGC API - Features dialog click New and in the New WFS Connection dialog:

• Name: Provide a name for the connection. You can reuse this connection in the future.

• URL: Copy the OS NGD API – Features 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.

• Authentication: Leave these settings at their defaults. You do not need a username or password as authentication is done through your API Key.

• Version: Click Detect to identify the version.

• Enable feature paging: Select this option, if necessary.

• Page size: Enter a maximum page size. This limits the page size to a maximum number of features. We recommend a setting of about 100 to speed up response times. Larger values may result in a very slow response time.

• Other: Leave the other settings at their defaults.

• Click OK.

Adding layers to the map

Data Source Manager | WFS / OGC API - Features dialog:

• Select your new connection in the dropdown, if necessary.

• Click Connect.

When you click Connect, a list of layers available in OS NGD API – Features populates in the main box:

• To add a layer to the map: Select the layer to highlight it. You can select multiple layers by using the Ctrl key.

• Only request features overlapping the view extent: Select this option.

• Click Add.

The layer will then display in the Layers panel and the data will display on the map:

Add a new layer

Once you've signed into your ESRI ArcGIS Online account and opened the map viewer. Zoom in to a small area to reduce the number of requests that are initially sent to the API.

• Select Layers > Add > Add layer from URL.

Add an API and set up custom parameters

In the Add Layer dialog:

• URL: Enter the base URL for OS NGD API – Features, excluding the API Key. For example, https://api.os.uk/features/ngd/ofa/v1.

• Type: Select OGC feature layer.

• Select Custom request parameters and enter the following:

  • Parameter: key

  • Value: [Insert your OS API Key here]

• Click Next.

Adding layers to the map

In the Add Layer dialog:

• To add a layer to the map: Select a layer to add to the map and then click Add to map.

The layer will then display in the Layers panel and the data will display on the map:

Features will automatically refresh when you zoom or pan on the map. If you wish to add multiple layers to the same map, repeat steps 2 and 3.

Set up a connection

Once a new project with a new map has been set up, select Insert > Connections > Server > New OGC API Server.

Add an API URL and set up custom parameters

In the Add OGC API Server Connection dialog:

• Server URL: Enter the URL for OS NGD API – Features, excluding the API Key. For example, https://api.os.uk/features/ngd/ofa/v1.

• Select Custom request parameters and enter the following:

  • Parameter: key

  • Value: [Insert your OS API Key here]

• Click OK.

Adding layers to the map

You can explore the available layers in OS NGD API – Features by using the ArcGIS Pro Catalog panel.

In the Catalog panel:

• To add a layer to the map: Right-click on a layer and select Add to Current Map.

In the pop-up Add OGC API Layer(s) dialog:

• Set the maximum features returned: Set the maximum number of features to be displayed (we suggest 1000).

• To specify the extent:

  • Select the Use Spatial Extent checkbox.

  • Get extent from: Select Current visible extent.

  • Click OK to load the features onto the map.

The layer will then display in the Contents panel and the data will display on the map:

Adjusting the map view

Features will not automatically refresh when you zoom or pan on the map. This is purposely designed to protect the API from unnecessary spikes in usage.

If the extent of the screen changes and you need to update the features displayed, right-click on the layer in the Contents panel, then select the OGC Features property for the layer, re-click Current visible extent, and click Apply and OK. This will force ESRI ArcGIS Pro to send a new request to the API and load features based on the new extent.

Add overlay

Once a new map has been set up, in the Home tab, click Add Overlay.

Select API

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 – Features.

• 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.

Adding layers to the map

In the OS Data Hub NGD API – Features Data Themes and Feature Types dialog:

• Well-known ‘recipe’: Select a predefined recipe, if available.

• Data Themes: Select your data themes.

• Features: If necessary, use the editing tools (on the right) to delete feature types or to change the order in which they display in your SIS Workspace Definition (SWD). By default, all feature types within the selected data themes are available in the right panel.

• Local cache: Select this option to store the data temporarily on your machine. If you save and reopen the SWD, the data will still be available as it is fetched from your local cache.

• One-off import: Select this option to do a one-off import of the data. If you save and reopen the SWD, the data will not be available and you will need to re-import it. These imports have a larger file size.

• Filtering: These settings are used in conjunction and define how much data is required for display. It is recommended that you always set a spatial filter and feature limit.

  • Spatial: The Intersect with current view extent option limits the download to only selected features within the current window extent. You can also load features within a specific area of interest using the polygon feature to draw your area of interest on the map BEFORE opening the Add Overlay dialog.

  • Maximum number of features: Limits the number of feature values downloaded to the number set. This limit is applied per feature within any filtered spatial area.

• Click Finish.

The selected layer(s) will then display in the SIS Workspace Definition (SWD) and the data will display in the map area: