Download an OpenData product

Returns a list of downloads for a specific OpenData product, or redirects to the actual download if requested.

get
Path parameters
productIdstringRequired

The id of the product.

Query parameters
fileNamestringOptional

Filter the list of downloads to only include those with this file name.

formatstringOptional

Filter the list of downloads to only include those with this format.

subformatstringOptional

Filter the list of downloads to only include those with this subformat.

areastring · enumOptional

This describes the geographical area that a download covers. GB is all of Great Britain, while codes like 'HP' cover National Grid Reference squares.

Possible values:
redirectbooleanOptional

When included, if the selected downloads list contains exactly one download, redirect to the download location.

Responses
200
Successful response.
application/json
get
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?