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

# OS Downloads API

## What is OS Downloads API?

OS Downloads API allows you to access information about available OS OpenData products and obtain product metadata as well as download links. The API also allows you to access information about your data packages, and to download any available data package versions. The API can be used to automate the retrieval and integration of OS data with your own systems.

{% hint style="info" %}

### Get this data

To access the OS Downloads 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 Downloads 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" %}
**Automated data access**

Allows automated downloading of OS OpenData and Premium datasets.

**Support multiple formats**

Supports downloading a variety of formats, including GeoTIFF, CSV and GeoPackage.
{% endtab %}

{% tab title="Benefits" %}
**Save time and resources**

Automates data retrieval, eliminating manual download processes.

**Ensuring data accuracy**

Guarantees up-to-date data through automated processes.

**Support scalable workflows**

Support users managing and scaling data update processes to simplify data management.
{% endtab %}
{% endtabs %}

## Things to remember for OS Downloads API

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

* Discover which OS OpenData products are available
* Discover which data packages are available
* Automate the download of OS OpenData and data packages
* Request various coverage areas depending on the OS OpenData dataset
* Request various formats depending on the OS OpenData dataset
* Request metadata on available OS OpenData datasets including thumbnail images
  {% endhint %}

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

* Access previous releases of OS OpenData datasets
* Create new data packages
* Request alterations to existing data packages
  {% endhint %}

## What's next?

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Getting started</strong></td><td>The getting started guide provides an overview of how to get started using the OS Downloads API to automate the download of OS OpenData and OS Premium data.</td><td><a href="/os-apis/accessing-os-apis/os-downloads-api/getting-started.md">Getting started</a></td></tr><tr><td><strong>Technical specification</strong></td><td>The technical specification explains the methods that you can use to call the OS Downloads API.</td><td><a href="/os-apis/accessing-os-apis/os-downloads-api/technical-specification.md">Technical specification</a></td></tr><tr><td><strong>How to access the OS Downloads API</strong></td><td>Visit the Getting started with an API project page for details on how to access and use the OS Downloads API in your projects. </td><td><a href="/os-apis/core-concepts/getting-started-with-an-api-project.md">Getting started with an API project</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-downloads-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.