LogoLogo
OS Docs HomeOS NGDOS APIsOS Download ProductsMore than MapsOS Data Hub
  • Introduction to OS APIs
  • Core Concepts
    • Getting started with an API project
    • Authentication
    • Error codes
    • Rate-limiting policy
    • OS API branding
    • Service level agreements
    • Service availability dashboard
  • Accessing OS APIs
    • OS Maps API
      • Layers and styles
      • Getting started
        • ESRI ArcGIS Online
        • ESRI ArcGIS Pro
        • ESRI ArcMap
        • Cadcorp SIS
        • MapInfo Pro
        • QGIS
      • Technical specification
        • ZXY
        • WMTS
      • Code examples
    • OS Vector Tile API
      • What data is available?
      • Getting started
        • ESRI ArcGIS Pro
        • Cadcorp SIS
        • QGIS
        • Create a web application using the OS Vector Tile API
      • Technical specification
        • Service Metadata
        • Stylesheet
        • Tile request
      • Code examples
      • Stylesheets
    • OS NGD API – Tiles
    • OS NGD API – Features
    • OS Features API
      • OS Product Archive
      • What data is available?
      • Getting started
        • ArcGIS Online
        • ArcGIS Pro
        • ArcMap
        • Cadcorp SIS
        • MapInfo Pro
        • QGIS
      • Technical specification
        • getCapabilities
        • describeFeatureType
        • getFeature
        • Filtering
        • Paging
        • Empty values
      • Code examples
    • OS Names API
      • Getting started with example queries using Node.js
      • Technical specification
        • Find
        • Nearest
      • Code list
      • Code examples
    • OS Linked Identifiers API
      • What data is available?
      • Getting started with implementing a look-up application
      • Technical specification
        • Identifier
        • Identifier Types
        • Feature Types
        • Product Version Information
      • Code examples
    • OS Places API
      • Getting started with example queries using Node.js
      • Technical specification
        • Find
        • Postcode
        • UPRN
        • Nearest
        • BBOX
        • Radius
        • Polygon
      • Datasets
      • Code lists
      • Code examples
    • OS Match & Cleanse API
      • End of Life Information
      • Getting started with an example match query using Node.js
      • Technical specification
      • Datasets
      • Code lists
    • OS Downloads API
      • Getting started
        • Automating OS OpenData downloads
        • Automating OS Premium data downloads
      • Technical specification
        • OpenData products
        • OpenData product details
        • Download an OpenData product
        • OpenData product image
        • Data packages
        • Data package ID
        • Data package version
        • Data package version ID
        • Download a data package
    • OAuth 2 API
      • Getting started
      • Technical specification
  • Additional resources
    • OS API Wrappers
      • JavaScript
      • Python
      • R
  • Extra Links
    • Accessibility
    • Contact us
    • PSGA Product Summary
    • Terms and conditions
Powered by GitBook
On this page
  • Core concepts
  • API reference
  • OS OpenData
  • Premium OS Data (Data Packages)

Was this helpful?

  1. Accessing OS APIs
  2. OS Downloads API

Technical specification

PreviousAutomating OS Premium data downloadsNextOpenData products

Last updated 2 months ago

Was this helpful?

The OS Downloads API is a service that lets you automate the discovery and download of OS OpenData and data packages.

This technical specification explains the methods that you can use to call the OS Downloads API.

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

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.

Core concepts

This specification does not cover core concepts that apply to all Ordnance Survey APIs.

Please read the following pages to learn more about OS API core concepts:

  • Authentication

  • Error codes

  • Rate-limiting policy

API reference

To use the:

  • OS OpenData parts of this API you do not require an API Key.

  • Data package endpoints (premium products) you need to use an API Key (or OAuth 2 access token).

Since the content of the API may change as products are changed, added to or removed, you should use the methods listed to get the most current list of content available.

The OS Downloads API provides different methods for downloading OS OpenData and data packages (premium data products).

OS OpenData

Operations providing access to OS OpenData products:

Premium OS Data (Data Packages)

Operations providing access to data packages.

To access data packages you must supply a valid API key or OAuth 2 access token.

overview documentation

OpenData products

Returns a list of OS OpenData products that are available.

OpenData product details

Return details about a specific OS OpenData product.

Download an OpenData product

Return a list of downloads for a specific OS OpenData product

OpenData product image

Return a HTTP redirect to thuimbnail images for an OS OpenData product.

Data packages

Lists the data packages that are available.

Data package ID

Get a specific data package.

Data package version

Get a list of versions for a specific

Data package version ID

Get a specific data package version.

Download a data package

Get a specific file from a data package version