Download an OpenData product

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

get

/products/{productId}/downloads

Path parameters

productIdstringrequired

The id of the product.

Query parameters

fileNamestring

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

formatstring

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

subformatstring

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

areastring · enum

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

Options: GB, HP, HT, HU, HW, HX, HY, HZ, NA, NB, NC, ND, NF, NG, NH, NJ, NK, NL, NM, NN, NO, NR, NS, NT, NU, NW, NX, NY, NZ, OV, SD, SE, TA, SH, SJ, SK, TF, TG, SM, SN, SO, SP, TL, TM, SR, SS, ST, SU, TQ, TR, SV, SW, SX, SY, SZ, TV

redirectboolean

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

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.os.uk/downloads/v1/products/{productId}/downloads'

200

307

404

200

[
  {
    "url": "https://example.com",
    "fileName": "data.zip",
    "size": 1234,
    "md5": "2f9dd13abd56140afa3b5621e8864f59",
    "area": "GB",
    "format": "GML",
    "subformat": "3"
  }
]

Successful response.