Data package 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.
Authorizations
Path parameters
dataPackageIdstringRequired
The id of the data package.
Responses
200
A data package.
application/json
401
The API key or OAuth 2 access token is missing or invalid.
application/json
404
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.
application/json
get
GET /downloads/v1//dataPackages/{dataPackageId} HTTP/1.1
Host: api.os.uk
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"id": "0040046952",
"name": "Southampton Addresses",
"url": "https://api.os.uk/downloads/v1/dataPackages/0040046952",
"createdOn": "2021-01-20",
"productId": "ABPOSTSLA",
"productName": "AddressBase",
"versions": [
{
"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"
}
]
}
Last updated
Was this helpful?