Data package version ID

Get a specific data package version, including details of the files that are available to download.

get

/dataPackages/{dataPackageId}/versions/{versionId}

Authorizations

OAuth2APIKeyQueryAPIKeyHeader

Path parameters

dataPackageIdstringrequired

The id of the data package.

versionIdstringrequired

The id of the data package version, or the string 'latest'.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.os.uk/downloads/v1/dataPackages/{dataPackageId}/versions/{versionId}'

200

401

404

200

{
  "id": "110012",
  "url": "https://api.os.uk/downloads/v1/dataPackages/0040046952/versions/110012",
  "createdOn": "2021-04-01",
  "reason": "INITIAL",
  "supplyType": "FULL",
  "productVersion": "E37 December 2015 Update",
  "format": "CSV",
  "dataPackageUrl": "https://api.os.uk/downloads/v1/dataPackages/0040046952",
  "nextVersionUrl": "https://api.os.uk/downloads/v1/dataPackages/0040046952/versions/110013",
  "previousVersionUrl": "https://api.os.uk/downloads/v1/dataPackages/0040046952/versions/110011",
  "downloads": [
    {
      "url": "https://example.com",
      "fileName": "data.zip",
      "size": 1234,
      "md5": "2f9dd13abd56140afa3b5621e8864f59"
    }
  ]
}

A data package version, including download details.