Data packages

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.

List the data packages that are available to you.

get

Authorizations

OAuth2APIKeyQueryAPIKeyHeader

OAuth2clientCredentialsRequired

Token URL:

Responses

200

A list of data packages.

application/json

A data package provides access to OS products that are not OpenData. If you have access to to products that are available as data packages then you can create new data packages using the OS Data Hub. Once you have set up your data packages you can use this API to access them.

idstringRequiredExample: 0040046952

namestringRequiredExample: Southampton Addresses

urlstring · uriRequiredExample: https://api.os.uk/downloads/v1/dataPackages/0040046952

createdOnstring · dateRequiredExample: 2021-01-20

productIdstringRequiredExample: ABPOSTSLA

productNamestringRequiredExample: AddressBase

401

The API key or OAuth 2 access token is missing or invalid.

application/json

get

/dataPackages

HTTPcURLJavaScriptPython

GET /downloads/v1/dataPackages 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"
      }
    ]
  }
]