Data package version ID
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.
Get a specific data package version, including details of the files that are available to download.
The id of the data package.
The id of the data package version, or the string 'latest'.
A data package version, including download details.
Detailed information about a data package version, including a list of the files available to download.
The API key or OAuth 2 access token is missing or invalid.
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//dataPackages/{dataPackageId}/versions/{versionId} HTTP/1.1
Host: api.os.uk
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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"
}
]
}
Last updated
Was this helpful?