LogoLogo
OS Docs HomeOS NGDOS APIsOS Download ProductsMore than MapsContact Us
  • More than Maps
  • Geographic Data Visualisation
    • Guide to cartography
      • Introduction to cartography
      • Types of maps
      • Symbology
      • Colour
      • Text on maps
      • Generalisation
      • Coordinate reference systems
      • Projections
      • Scale
      • Map legends
      • Map layout
      • Relief representation
      • North arrows
    • Guide to data visualisation
      • Introduction to data visualisation
      • GeoDataViz design principles
      • Types of visualisation
      • Thematic mapping techniques
      • Data visualisation critique
      • Accessible data visualisation
      • Ethical data visualisation
      • Software
      • Data
    • GeoDataViz assets
      • GeoDataViz basemaps
      • Stylesheets
      • GeoDataViz virtual gallery
      • Equal area cartograms
      • How did I make that?
        • Apollo 11 Landing
        • North York Moors National Park, 70 years
        • Snowdonia National Park, 70 years
        • Great Britain's National Parks
        • Great Britain's Islands
        • Great Britain's AONB's and National Scenic Areas
        • Famous shipwrecks of Pembrokeshire
        • Trig pillars today
        • Britain's most complex motorway junctions
      • #30DayMapChallenge
  • Data in Action
    • Examples
  • Demonstrators
    • 🆕Product Viewer
    • Addressing & location demonstrators
      • Address Portfolio overview
      • Which address product should you use?
      • AddressBase
      • AddressBase Core
      • AddressBase Plus
      • AddressBase Premium
      • Address Classifications
      • Addressing Lifecycle
      • OS Emergency Services Gazetteer
      • What are Vertical Streets?
      • Why are there differences in boundaries?
    • Contextual demonstrators
    • Customer best practice
      • Channel Shift
      • Data Management and OS Data Hub
      • End User Licence vs Contractor Licence
      • 🆕 IDs vs Spatial Relationships
      • Why we should capture good quality addresses at source
      • Why we Snap and Trace
    • Network Demonstrators
      • OS Detailed Path Network
      • OS Multi Modal Routing Network
        • OS Multi Modal Routing Network
      • Water Networks overview
      • OS MasterMap Highways Network and OS NGD Speeds
      • OS MasterMap® Highways Network and OS Open Roadsâ„¢
    • OS MasterMap Generation APIs
      • Using the OS Features API
      • Using the OS Features API Archive
      • Using the OS Downloads API
      • Using OS APIs in ESRI Software
    • 🆕OS NGD (National Geographic Database)
      • OS NGD Address
      • OS NGD Boundaries
      • 🆕OS NGD Buildings
        • 🆕Building and Building Access Feature Types
        • Building Part and Building Line Feature Types
      • 🆕OS NGD Geographical Names
      • OS NGD Land
      • OS NGD Land Cover enhancements
      • 🆕OS NGD Land Use
      • OS NGD Land Use enhancements
      • 🆕OS NGD Structures
        • 🆕OS NGD Structures
        • Field Boundaries
      • 🆕OS NGD Transport Features
      • 🆕OS NGD Transport Network
      • OS NGD Transport RAMI
      • OS NGD Water Features
      • OS NGD Water Network
      • OS NGD API - Features
      • Ordering OS NGD data
      • Change only updates
      • OS NGD Versioning
      • Creating a topographic map from OS NGD Data
      • Analytical styling for OS NGD data
    • OS MasterMap® demonstrators
    • 🆕Product & API Comparisons
      • 🆕Comparison of Water Network Products
  • Tutorials
    • GeoDataViz
      • Thematic Mapping Techniques
      • Downloading and using data from the OS Data Hub
      • How to download and use OS stylesheets
      • How to use the OS Maps API
      • Creating a bespoke style in Maputnik
    • GIS
      • Analysing pavement widths
      • Basic routing with OS Open Data and QGIS
      • Walktime analysis using OS Multi-modal Routing Network and QGIS
      • Creating 3D Symbols for GIS Applications
      • Constructing a Single Line Address using a Geographic Address
      • Creating a Digital Terrain Model (DTM)
      • Visualising a road gradient using a Digital Terrain Model
      • Visualising a road gradient using OSMM Highways
    • 🆕APIs
      • 🆕Using OS APIs with EPC API
      • 🆕OS APIs and ArcGIS
  • Deep Dive
    • Introduction to address matching
    • Guide to routing for the Public Sector
      • Part 1: Guide to routing
      • Part 2: Routing software and data options
      • Part 3: Building a routable network
    • Unlocking the Power of Geospatial Data
    • Using Blender for Geospatial Projects
    • A Guide to Coordinate Systems in Great Britain
      • Myths about coordinate systems
      • The shape of the Earth
      • What is position?
        • Types of coordinates
        • We need a datum
        • Position summary
      • Modern GNSS coordinate systems
        • Realising WGS84 with a TRF
        • The WGS84 broadcast TRF
        • The International Terrestrial Reference Frame (ITRF)
        • The International GNSS Service (IGS)
        • European Terrestrial Reference System 1989 (ETRS89)
      • Ordnance Survey coordinate systems
        • ETRS89 realised through OS Net
        • National Grid and the OSGB36 TRF
        • Ordnance Datum Newlyn
        • The future of British mapping coordinate systems
        • The future of British mapping coordinate systems
      • From one coordinate system to another: geodetic transformations
        • What is a geodetic transformation?
        • Helmert datum transformations
        • National Grid Transformation OSTN15 (ETRS89–OSGB36)
        • National Geoid Model OSGM15 (ETRS89-Orthometric height)
        • ETRS89 to and from ITRS
        • Approximate WGS84 to OSGB36/ODN transformation
        • Transformation between OS Net v2001 and v2009 realisations
      • Transverse Mercator map projections
        • The National Grid reference convention
      • Datum, ellipsoid and projection information
      • Converting between 3D Cartesian and ellipsoidal latitude, longitude and height coordinates
      • Converting between grid eastings and northings and ellipsoidal latitude and longitude
      • Helmert transformation worked example
      • Further information
  • Code
    • Ordnance Survey APIs
    • Mapping
    • Routing with pgRouting
      • Getting started with OS MasterMap Highways and pgRouting
      • Getting started with OS MasterMap Highways Network - Paths and pgRouting
      • Getting started with OS NGD Transport Theme and pgRouting
      • Getting started with OS NGD Transport Path features and pgRouting
  • RESOURCES
    • 🆕Data Visualisation External Resources
Powered by GitBook

Website

  • Ordnance Survey

Data

  • OS Data Hub
On this page
  • What is the OS Downloads API?
  • Why use OS Downloads API
  • What are Data Packages?
  • How to get your API Key?
  • What can you do with the API?
  • How does it work?
  • What data packages do I have?
  • How do I get my latest data package?
  • How do download that package?
  • Summary
  • Resources

Was this helpful?

  1. Demonstrators
  2. OS MasterMap Generation APIs

Using the OS Downloads API

PreviousUsing the OS Features API ArchiveNextUsing OS APIs in ESRI Software

Last updated 11 months ago

Was this helpful?

What is the OS Downloads API?

OS Downloads API is a service, not new data, and provides a mechanism to download OS data. It allows you to download OS OpenData and OS Premium Data outside of OS Data Hub.

Released October 2021 the service uses a URL to perform requests and retrieve the datasets.

It is available to all PSGA members and requires an OS Data Hub account

Why use OS Downloads API

What are Data Packages?

Data Packages is the generic term for any order that you have created in the ‘Download’ section of the OS Data Hub.

They are displayed by:

  • Your reference (the name you gave it on creation)

  • Data Package ID (auto generated but persists)

  • Date (date the package was created)

  • Product Name (name of the OS Product)

  • Status (whether a download is available)

You will need to have created your data packages before you can download them via the OS Downloads API.

How to get your API Key?

  • Create a new project or open an existing project in the API Dashboard tab.​

  • Click ‘Add API’ button.​

  • Click on the ‘Add to Project’ button for the OS Downloads API to add it to this project.​

  • Your OS Downloads API Key will be generated and listed in your API list.​

  • Should your API Key ever be compromised, or you wish prevent access (e.g. a contractor) you can click ‘Actions’ near the project name and ‘Regenerate API Key’ to create a new API Key.​

What can you do with the API?

For OS Open data and Premium data packages you can:

  • Discover which datasets are available.​

  • Find the latest data available.​

  • Automate the download.​

  • Request the metadata.​

You won’t be able to:​

  • Access previous releases of OS OpenData datasets.​

  • Use it to create new recipes or data packages.​

  • Request alterations to existing data packages.

How does it work?

  • JSON (JavaScript Object Notation) is a format for representing data in a way that can be easily read and processed by computers.

  • JSON is often used to exchange data between a client and a server.

  • It is lightweight and widely supported

  • Comprised of keys and values – a bit like a dictionary In its simplest form it can be used in a web browser

What data packages do I have?

This looks at the OS DataHub and the Downloads API to compare what you will see in each

On the OS DataHub your packages will look as they do on the left: https://osdatahub.os.uk/downloads/packages

On the OS Downloads API the same packages will look as they do on the right: https://api.os.uk/downloads/v1/dataPackages?key=(APIKey)

How do I get my latest data package?

Adding specific parameters into your API call will allow you to download specific versions of the data:

https://api.os.uk/downloads/v1/dataPackages/(PackageNumber)/versions/latest?key=(APIKey)

On the OS Data Hub choosing versions looks like the image below...

Using the OS Downloads API choosing versions looks more like the following image, but is displaying the same information as above.

How do download that package?

Having selected a version, you can further modify the API call to download specific files using a url similar to this one:

https://api.os.uk/downloads/v1/dataPackages/(PackageNumber)/versions/(version)/downloads?fileName=ad_gb_builtaddress.zip&key=(APIKey)

On the OS DataHub, having chosen a version you are presented with a set of download links, as shown here on the left. On the right are the same links but via the OS Downloads API:

Summary

  • OS Downloads API can be used to automate OS data downloads

  • Data is kept up to date, so the data currency is the best that it can be

  • This can be integrated with data loaders to fully automate the whole data update process

  • The process is reliable as it always runs the same way

  • Efficient by massively reducing officer time in handling data updates

  • It can be run out of hours making updates convenient

Resources

Getting Started Guide:

Technical Specification:

OS Data Hub:

Automate downloads and remove manual handling

Currency

Always have the most up-to-date data

Integrate

Join to data loading to fully automate your data updates

Reliable

Reduce/eliminate download and loading errors

Efficiency

Save time and resources by not manually handling

Convenient

Can be scheduled to run out of hours or at any time

https://docs.os.uk/os-apis/accessing-os-apis/os-downloads-api/getting-started
https://docs.os.uk/os-apis/accessing-os-apis/os-downloads-api/technical-specification
https://osdatahub.os.uk/
Data Packages in the OS Data Hub
OS Downloads API get capabilities
The entry highlighted in pink on the OS DataHub is the same as the one highlighted on the Downloads API
The entry highlighted in pink on the Downloads API is the same as the one highlighted on the OS DataHub
OS DataHub with the option to choose versions highlighted
OS Downloads API with the version information highlighted
Download links on OS DataHub
The same download links via the OS Downloads API
Page cover image