ORordnance-survey
Data Packages

Get a specific data package.

get/dataPackages/{dataPackageId}

Request

  • Base URL
    https://api.os.uk/downloads/v1
  • Auth
    • OAuth 2
      Client credentials
      Token URLhttps://api.os.uk/oauth2/token/v1
    • or API key in query parameter key
    • or API key in header key

Path parameters

dataPackageIdstring required

The id of the data package.

Response

A data package.

idstring required
namestring required
urlstring uri required
createdOnstring date required
productIdstring required
productNamestring required

Example response

{
  "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",
      "productVersion": "E37 December 2015 Update",
      "format": "CSV",
      "dataPackageUrl": "https://api.os.uk/downloads/v1/dataPackages/0040046952"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.