Sign in

v1

latestOpenAPI 3.0.02026-07-239914.4 KB
OpenData

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

get/products/{productId}/downloads

Path parameters

productIdstring required

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.

area'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'

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

Filter the list of downloads to only include those which cover this area.

redirectboolean

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

Response

Successful response.

urlstring uri required

Getting this URL will return a HTTP redirect to the actual data.

fileNamestring required

The name of the file.

sizeinteger

The file size, in bytes.

md5string

A MD5 checksum of the file data. This can be used to verify the integrity of the data once you have downloaded it.

area'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' required

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

formatstring required

This describes the format of the data.

subformatstring

This describes the subformat of the data.

Example response

[
  {
    "fileName": "data.zip",
    "size": 1234,
    "md5": "2f9dd13abd56140afa3b5621e8864f59",
    "format": "GML",
    "subformat": "3"
  }
]