Download an OpenData product
API test authentication
The Open API block allows you to test OS APIs directly from the page with example data and parameters. To use this feature, you will need to add your API Key or OAuth2 token to the authentication field.
For help generating an API Key or OAuth2 token, please see the Getting started with an API project or OAuth2 documentation.
Returns a list of downloads for a specific OpenData product, or redirects to the actual download if requested.
The id of the product.
Filter the list of downloads to only include those with this file name.
Filter the list of downloads to only include those with this format.
Filter the list of downloads to only include those with this subformat.
This describes the geographical area that a download covers. GB is all of Great Britain, while codes like 'HP' cover National Grid Reference squares.
When included, if the selected downloads list contains exactly one download, redirect to the download location.
Successful response.
Returned when the 'redirect' parameter was supplied, and there was exactly one matching download.
The request does not match any known content. The response will contain a human readable message, and may also contain links to help you navigate to other API endpoints.
GET /downloads/v1//products/{productId}/downloads HTTP/1.1
Host: api.os.uk
Accept: */*
[
{
"url": "https://example.com",
"fileName": "data.zip",
"size": 1234,
"md5": "2f9dd13abd56140afa3b5621e8864f59",
"area": "GB",
"format": "GML",
"subformat": "3"
}
]
Last updated
Was this helpful?