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.

If you are not familiar with the OS Downloads API, please read the overview documentation before proceeding.

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 and the popular axios module

• For 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 for more information

Instructions

Please read these pages in conjunction with the API's Technical specification.

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

• Automating OS OpenData downloads

• Automating OS Premium data downloads