# 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](https://docs.os.uk/os-apis/accessing-os-apis/os-downloads-api) 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](https://docs.os.uk/os-apis/accessing-os-apis/os-downloads-api/getting-started/automating-os-premium-data-downloads), OS Downloads API added to an API project in the OS Data Hub with an API Key; see [getting-started-with-an-api-project](https://docs.os.uk/os-apis/core-concepts/getting-started-with-an-api-project "mention") for more information

## Instructions

{% hint style="info" %}
Please read these pages in conjunction with [technical-specification](https://docs.os.uk/os-apis/accessing-os-apis/os-downloads-api/technical-specification "mention").
{% endhint %}

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

* [automating-os-opendata-downloads](https://docs.os.uk/os-apis/accessing-os-apis/os-downloads-api/getting-started/automating-os-opendata-downloads "mention")
* [automating-os-premium-data-downloads](https://docs.os.uk/os-apis/accessing-os-apis/os-downloads-api/getting-started/automating-os-premium-data-downloads "mention")


---

# Agent Instructions: 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:

```
GET https://docs.os.uk/os-apis/accessing-os-apis/os-downloads-api/getting-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
