> For the complete documentation index, see [llms.txt](https://docs.os.uk/os-apis/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.os.uk/os-apis/accessing-os-apis/os-maps-api/getting-started/qgis.md).

# QGIS

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 [WMTS ](#user-content-fn-1)[^1]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](/os-apis/core-concepts/getting-started-with-an-api-project.md) for more information
* QGIS version 3.22.0 or later

## Instructions

{% stepper %}
{% step %}

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

<figure><img src="/files/VBOnC1JzSrWiXi18C6XU" alt="QGIS UI showing Layer > Add Layer > Add WMS/WMTS Layer... navigation option"><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Create a new connection

In the Data Source Manager | WMS/WMTS dialog:

* Click \_New.

<figure><img src="/files/ELy0eWde6FIx5Nb1c1qv" alt="QGIS Create a New WMS/WMTS dialog"><figcaption></figcaption></figure>

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

<figure><img src="/files/rgpOv1uXWVugXafnbwD5" alt="QGIS Data Source Manager | WMS/WMTS dialog showing new connection" width="375"><figcaption><p>QGIS Create a New WMS/WMTS dialog<br></p></figcaption></figure>
{% endstep %}

{% step %}

#### 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\_.

<figure><img src="/files/sCSn3ghA4YYmq90djm2o" alt="QGIS QGIS Data Source Manager | WMS/WMTS dialog showing list of OS Maps API tilesets"><figcaption><p>QGIS Data Source Manager | WMS/WMTS dialog showing list of OS Maps API tilesets</p></figcaption></figure>

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

<figure><img src="/files/HTgseAPJ0B62LYRQdr9Y" alt="QGIS UI showing OS Maps API in map area"><figcaption><p>QGIS UI showing OS Maps API in map area</p></figcaption></figure>
{% endstep %}
{% endstepper %}

[^1]: Web Map Tile Service


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.os.uk/os-apis/accessing-os-apis/os-maps-api/getting-started/qgis.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.