> 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/getting-started.md).

# Getting started

The following pages provide an overview of how to get started using the OS Downloads API. They cover the core elements on how to get started automating the download of OS OpenData and OS Premium data.

{% hint style="info" %}
If you are not familiar with the OS Downloads API, please read the [overview documentation](/os-apis/accessing-os-apis/os-downloads-api.md) before proceeding.
{% endhint %}

## What you need?

* A basic understanding of automatic processing of JSON data and basic procedural (if-then-else) programming
* A text editor like Visual Studio Code
* A working installation of [Node.js](https://nodejs.org/) and the popular [axios](https://github.com/axios/axios) module
* For [Premium data downloads](/os-apis/accessing-os-apis/os-downloads-api/getting-started/automating-os-premium-data-downloads.md), OS Downloads 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

## Instructions

{% hint style="info" %}
Please read these pages in conjunction with the API's [Technical specification](/os-apis/accessing-os-apis/os-downloads-api/technical-specification.md).
{% endhint %}

The following pages provide instructions to get started with OS OpenData and Premium data downloads:

* [Automating OS OpenData downloads](/os-apis/accessing-os-apis/os-downloads-api/getting-started/automating-os-opendata-downloads.md)
* [Automating OS Premium data downloads](/os-apis/accessing-os-apis/os-downloads-api/getting-started/automating-os-premium-data-downloads.md)


---

# 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 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/getting-started.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 `automate deployments from our CI pipeline` 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.