LogoLogo
OS Docs HomeOS NGDOS APIsOS Download ProductsMore than MapsOS Data Hub
  • Introduction to OS APIs
  • Core Concepts
    • Getting started with an API project
    • Authentication
    • Error codes
    • Rate-limiting policy
    • OS API branding
    • Service level agreements
    • Service availability dashboard
  • Accessing OS APIs
    • OS Maps API
      • Layers and styles
      • Getting started
        • ESRI ArcGIS Online
        • ESRI ArcGIS Pro
        • ESRI ArcMap
        • Cadcorp SIS
        • MapInfo Pro
        • QGIS
      • Technical specification
        • ZXY
        • WMTS
      • Code examples
    • OS Vector Tile API
      • What data is available?
      • Getting started
        • ESRI ArcGIS Pro
        • Cadcorp SIS
        • QGIS
        • Create a web application using the OS Vector Tile API
      • Technical specification
        • Service Metadata
        • Stylesheet
        • Tile request
      • Code examples
      • Stylesheets
    • OS NGD API – Tiles
    • OS NGD API – Features
    • OS Features API
      • OS Product Archive
      • What data is available?
      • Getting started
        • ArcGIS Online
        • ArcGIS Pro
        • ArcMap
        • Cadcorp SIS
        • MapInfo Pro
        • QGIS
      • Technical specification
        • getCapabilities
        • describeFeatureType
        • getFeature
        • Filtering
        • Paging
        • Empty values
      • Code examples
    • OS Names API
      • Getting started with example queries using Node.js
      • Technical specification
        • Find
        • Nearest
      • Code list
      • Code examples
    • OS Linked Identifiers API
      • What data is available?
      • Getting started with implementing a look-up application
      • Technical specification
        • Identifier
        • Identifier Types
        • Feature Types
        • Product Version Information
      • Code examples
    • OS Places API
      • Getting started with example queries using Node.js
      • Technical specification
        • Find
        • Postcode
        • UPRN
        • Nearest
        • BBOX
        • Radius
        • Polygon
      • Datasets
      • Code lists
      • Code examples
    • OS Match & Cleanse API
      • End of Life Information
      • Getting started with an example match query using Node.js
      • Technical specification
      • Datasets
      • Code lists
    • OS Downloads API
      • Getting started
        • Automating OS OpenData downloads
        • Automating OS Premium data downloads
      • Technical specification
        • OpenData products
        • OpenData product details
        • Download an OpenData product
        • OpenData product image
        • Data packages
        • Data package ID
        • Data package version
        • Data package version ID
        • Download a data package
    • OAuth 2 API
      • Getting started
      • Technical specification
  • Additional resources
    • OS API Wrappers
      • JavaScript
      • Python
      • R
  • Extra Links
    • Accessibility
    • Contact us
    • PSGA Product Summary
    • Terms and conditions
Powered by GitBook
On this page
  • What you need
  • Connecting to the API
  • Add a custom style
  • Publishing a custom base map to ESRI ArcGIS Online

Was this helpful?

  1. Accessing OS APIs
  2. OS Vector Tile API
  3. Getting started

ESRI ArcGIS Pro

Accessing OS Vector Tile API via ESRI ArcGIS Pro

PreviousGetting startedNextCadcorp SIS

Last updated 2 months ago

Was this helpful?

ESRI ArcGIS Pro is a desktop geographic information system (GIS) application that allows users to maintain, visualise and analyse spatial data.

The instructions that follow demonstrate how to connect to OS Vector Tile API using ESRI ArcGIS Pro.

What you need

  • OS Vector Tile API added to an API project in the OS Data Hub with an API Key. See Getting started with an API project for more information.

  • ESRI ArcGIS Pro (version 3.0 or later)

Connecting to the API

1

Set up a connection

Once a new project with a new map has been set up, select Map > Add Data > From Path.

2

Add an API URL and set up custom parameters

In the Add Data From Path dialog:

  • Path: Enter the URL for OS Vector Tile API, excluding the API Key. For example, https://api.os.uk/maps/vector/v1/vts.

  • Service type: Select Vector Tile Service

  • Select Custom request parameters and enter the following:

Parameter
Value

srs

The required coordinate reference system – 27700 or 3857

key

[Insert your OS API Key here]

  • Click Add.

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

Add a custom style

1

Find a style

Once you have an existing OS Vector Tile API connection, go to the and select the required style file.

2

Get a Style URL

With the custom stylesheet file open:

  • Click Raw (a new window will open).

  • Copy the URL to link to the style JSON file.

3

Set up a Style URL connection

In ESRI ArcGIS Pro, follow steps 1 and 2 from the Connecting to the API section to set up a connection to the OS Vector Tile API using the custom style URL in the path field.

Publishing a custom base map to ESRI ArcGIS Online

1

Share Web Map

Once a connection to the OS Vector Tile API has been set up and you've signed into your ArcGIS Online account within ArcPro, select Share > Web Map.

In the Share As Web Map panel:

  • Complete the relevant details.

  • Click Share.

2

View in ESRI ArcGIS Online

Once the web map has been successfully shared, this will be available in your ArcGIS Online account under My content:

3

Add a custom base map

Open the OS Vector Tile API web map in the map viewer and select Layers.

  • Click on the '…' button for the Vector Tile Layer.

  • Select Move to basemap.

OS-Vector-Tile-API Stylesheets Repo in GitHub
ESRI ArcGIS Pro UI.
ESRI ArcGIS Pro Add Data From Path dialog.
ESRI ArcGIS Pro Add Data From Path dialog with custom request parameters set.
ESRI ArcGIS Pro UI showing OS Vector Tile API in the map area.
GitHub UI with a custom stylesheet file open and the Raw button highlighted
ESRI ArcGIS Pro Add Data From Path dialog with custom request parameters set.
ESRI ArcGIS Pro UI.
ESRI ArcGIS Online account UI with OS Vector Tile Web Map shared.
ESRI ArcGIS Online Map Viewer with a greyscale basemap.
ESRI ArcGIS Pro UI.
ESRI ArcGIS Pro Add Data From Path dialog.
ESRI ArcGIS Pro Add Data From Path dialog with custom request parameters set.
ESRI ArcGIS Pro UI showing OS Vector Tiles API in the map area.
A  style file open on GitHub with the Raw button highlighted.
ESRI ArcGIS Pro Add Data From Path dialog with custom request parameters set.
ArcGIS Pro UI's Share to Web Map ribbon
ESRI ArcGIS Online account with OS Vector Tile Web Map shared.
ArcGIS Online Map Viewer with greyscale base map