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

Was this helpful?

  1. Accessing OS APIs
  2. OS Maps API
  3. Getting started

QGIS

Accessing OS Maps API via QGIS

PreviousMapInfo ProNextTechnical specification

Last updated 4 months ago

Was this helpful?

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 Service).

What you need

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

  • QGIS version 3.22.0 or later

Instructions

1

Set up a new connection

Once a new project with a base map map has been set up, select Layer > Add Layer > Add WMS / WMTS Layer.

2

Create a new connection

In the Data Source Manager | WMS/WMTS dialog:

  • Click New.

In the Create a New WMS/WMTS Connection dialog:

  • Name: Provide a name for the API.

  • URL: Copy your OS Maps API WMTS endpoint address from the OS Data Hub and paste it into this field. Your API Key is automatically added to the URL in the key parameter.

  • Authentication: You can ignore these options. It is not necessary to enter your username and password to use the service as as all authentication is done through your Project key.

  • Other fields: Leave the rest of the fields as they are.

  • Click OK.

3

Add Layer

In the Data Source Manager | WMS/WMTS dialog,

  • Select your new connection in the dropdown.

  • Click Connect.

  • Select your preferred tileset.

  • Click Add and then Close to close the dialog.

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

QGIS Create a New WMS/WMTS dialog
QGIS Data Source Manager | WMS/WMTS dialog showing list of OS Maps API tilesets
QGIS UI showing OS Maps API in map area
QGIS UI showing Layer > Add Layer > Add WMS/WMTS Layer... navigation option
QGIS Create a New WMS/WMTS dialog
QGIS Data Source Manager | WMS/WMTS dialog showing new connection
QGIS QGIS Data Source Manager | WMS/WMTS dialog showing list of OS Maps API tilesets
QGIS UI showing OS Maps API in map area