> 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-vector-tile-api.md).

# OS Vector Tile API

{% hint style="info" icon="map-location" %}

#### Have you considered the benefits of the OS National Geographic Database?

OS Vector Tile API is anticipated to [reach End of Life in Autumn 2028](https://www.ordnancesurvey.co.uk/products/roadmap) and will be retired.

Its replacement, [OS NGD API – Tiles](https://docs.os.uk/os-apis/accessing-os-apis/os-ngd-api-tiles), is built on the latest [OGC API - Tiles](https://ogcapi.ogc.org/tiles/) standard and offers you all of the [benefits of the OS National Geographic Database](https://docs.os.uk/osngd/introduction-to-os-ngd/os-ngd-key-benefits-to-customers) (OS NGD), including:

* Increased data update frequency (up-to-daily updates for many datasets)
* Richer attribution
* Improved data structures
* A continuous series of ongoing data enhancements

A detailed [comparison between the OS Vector Tile API and OS NGD API – Tiles](https://docs.os.uk/more-than-maps/os-ngd-migration/comparison-of-os-apis/comparison-of-vector-tile-apis) is available on our More than Maps site. Alternatively, [find out how to get started using OS NGD API – Tiles](https://docs.os.uk/os-apis/accessing-os-apis/os-ngd-api-tiles/getting-started). with our getting started guide.
{% endhint %}

## What is OS Vector Tile API?

OS Vector Tile API is a vector tile service providing detailed Ordnance Survey data as a customisable basemap. It can be used with most web mapping libraries including Mapbox GL JS, Leaflet, OpenLayers and ArcGIS API for JavaScript. Vector tiles have the benefit of being optimised for use across the internet and are great for building interactive web maps. You can zoom, pan, rotate, tilt and even extrude 3D buildings.

You have a choice between using OS styles or creating your own. You can customise the content and the style to create a map that perfectly meets your needs. Design a map that matches your brand or get creative and add some cartographic flair to your application.

With OS Vector Tile API you can also select and interact with the individual map features.

OS Vector Tile API is available in two projections:

* British National Grid for Great Britain (GB) data
* Web Mercator, which is a global coordinate system

{% hint style="info" %}

### Get this data

To access the OS Vector Tile API, you need an API Key. This key will be specific to a dedicated API project linked to your OS Data Hub account.

Click Get started to find out how to get your API Key and access OS Vector Tile API data, or Go to the OS Data Hub where you can access the API Projects page to manage all of your OS APIs.

\
\ <a href="/os-apis/core-concepts/getting-started-with-an-api-project.md" class="button primary">Get started</a><a href="https://osdatahub.os.uk/" class="button secondary">Go to the OS Data Hub</a>
{% endhint %}

{% tabs %}
{% tab title="Features" %}
**Scalable vector tile mapping**

Provides lightweight, high-resolution vector tile basemaps in different styles and projections for fast rendering in interactive applications.

**Customisable style options**

Access to pre-defined, professional styling which can be customised to meet your own requirements and map designs.

**3D visualisation support**

Allows for tilting and extruding building features.

**Built in data overlays**

Access build in and detailed overlays to add give additional geographic context.
{% endtab %}

{% tab title="Benefits" %}
**Faster performance**

Loads maps quicker than traditional raster-mapping services.

**Up-to-date mapping**

Ensures that users always have access to the most current mapping data.

**Flexible customisation**

Customise the style and content to make your map meet your requirements.

**Interactive mapping**

Improves interactivity by offering high-quality, scalable mapping with direct access to attribution.
{% endtab %}

{% tab title="Summary" %}

* **Format:** Vector tiles
* **Primary Data Source**: [OS Open Zoomstack](https://docs.os.uk/os-downloads/products/maps-and-imagery-portfolio/os-open-zoomstack) and [OS MasterMap Topography Layer](https://docs.os.uk/os-downloads/products/maps-and-imagery-portfolio/os-mastermap-topography-layer)
* **Additional Data Source**: [Boundary-Line](https://docs.os.uk/os-downloads/products/areas-and-zones-portfolio/boundary-line), [OS MasterMap Greenspace Layer](https://docs.os.uk/os-downloads/products/land-and-terrain-portfolio/os-mastermap-greenspace-layer), [OS MasterMap Sites Layer](https://docs.os.uk/os-downloads/resources/product-resources/end-of-life-product-documentation/os-mastermap-water-network-layer), [OS MasterMap Highways Network – Roads](https://docs.os.uk/os-downloads/products/transport-network-portfolio/os-mastermap-highways-network-roads), [OS MasterMap Highways Network – Paths](https://docs.os.uk/os-downloads/products/transport-network-portfolio/os-mastermap-highways-network-paths) and [OS Detailed Path Network](https://docs.os.uk/os-downloads/resources/product-resources/end-of-life-product-documentation/os-detailed-path-network).
* **Coverage:** Great Britain
* **Update:** 15 working days from each [product refresh date](https://docs.os.uk/os-downloads/resources/product-resources/product-refresh-dates)
  {% endtab %}
  {% endtabs %}

{% hint style="warning" %}

#### Associated products reached / reaching their End of Life (withdrawal) dates

The following associated products have reached their End of Life and have been removed from the API:

* The OS MasterMap Water Network Layer product (also referred to as OS MasterMap Networks – Water Layer) became End of Life on 31 March 2026 and was removed from the OS Vector Tile API. Further information on the withdrawal of this product is available on the [OS MasterMap Water Network Layer End of Life Information page](https://docs.os.uk/os-downloads/resources/product-resources/end-of-life-product-documentation/os-mastermap-water-network-layer/os-mastermap-water-network-layer-end-of-life-information).
* The OS Detailed Path Network product became End of Life on 30 September 2026. As of this date, access to the product was removed from the OS Vector Tile API. Further information on the withdrawal of this product is available on the [OS Detailed Path Network End of Life Information page](https://docs.os.uk/os-downloads/resources/product-resources/end-of-life-product-documentation/os-detailed-path-network/os-detailed-path-network-end-of-life-information).

The following associated product is reaching its End of Life date soon:

* The OS MasterMap Greenspace Layer product will become End of Life on 31 March 2027. As of this date, access to the product will be removed from the OS Vector Tile API. Further information on the withdrawal of this product is available on the [End of Life Notice – OS MasterMap Greenspace Layer page](https://docs.os.uk/os-downloads/resources/product-resources/end-of-life-product-notices/end-of-life-notice-os-mastermap-greenspace-layer).
  {% endhint %}

## Things to remember for OS Vector Tile API

{% hint style="success" %}
You can:

* Use as a basemap in GIS, web or mobile applications
* View the whole of Great Britain in unrivalled detail
* Seamlessly pan, zoom, pitch and tilt the map
* Overlay your own data to give it geographic context
* Trace over OS MasterMap Topography Layers (Premium data) detailed geometries
* Customise the map style and content to create the map you need
* Access the maps in different projections – British National Grid and Web Mercator
  {% endhint %}

{% hint style="warning" %}
You can't:

* Retrieve all the detailed attribution from OS data
  {% endhint %}

## What's next?

<table data-view="cards"><thead><tr><th></th><th></th><th><select><option value="nm1DxKqO3Qj1" label="GitHub.com" color="blue"></option><option value="kMZeXFjNhVML" label="Labs.os.uk" color="blue"></option></select></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>What data is available?</strong></td><td>A guide outlining the data available through OS Vector Tile API.</td><td></td><td><a href="/os-apis/accessing-os-apis/os-vector-tile-api/what-data-is-available.md">What data is available?</a></td></tr><tr><td><strong>Getting started</strong></td><td>The getting started guide explains how you can integrate OS Vector Tile API in various open GIS software applications.</td><td></td><td><a href="/os-apis/accessing-os-apis/os-vector-tile-api/getting-started.md">Getting started</a></td></tr><tr><td><strong>Technical specification</strong></td><td>The technical specification explains the content of OS Vector Tile API and the methods that you can use to call it.</td><td></td><td><a href="/os-apis/accessing-os-apis/os-vector-tile-api/technical-specification.md">Technical specification</a></td></tr><tr><td><strong>Code examples</strong></td><td>Code examples you can use to display a map using OS Vector Tile API.</td><td><span data-option="kMZeXFjNhVML">Labs.os.uk</span></td><td><a href="https://labs.os.uk/public/os-data-hub-examples/os-vector-tile-api/vts-3857-basic-map#maplibre-gl-js">https://labs.os.uk/public/os-data-hub-examples/os-vector-tile-api/vts-3857-basic-map#maplibre-gl-js</a></td></tr><tr><td><strong>Stylesheets</strong></td><td>Cartographic stylesheets hosted on GitHub for use with OS Vector Tile API.</td><td><span data-option="nm1DxKqO3Qj1">GitHub.com</span></td><td><a href="https://github.com/OrdnanceSurvey/OS-Vector-Tile-API-Stylesheets">https://github.com/OrdnanceSurvey/OS-Vector-Tile-API-Stylesheets</a></td></tr><tr><td><strong>How to access the OS Vector Tile API</strong></td><td>Visit the Getting started with an API project page for details on how to access and use OS Vector Tile API in your projects. </td><td></td><td><a href="/os-apis/accessing-os-apis/os-vector-tile-api.md">OS Vector Tile API</a></td></tr></tbody></table>


---

# 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 following URL with the `ask` and `goal` query parameters:

```
GET https://docs.os.uk/os-apis/accessing-os-apis/os-vector-tile-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

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.