LogoLogo
OS Docs HomeOS NGDOS APIsOS Download ProductsMore than MapsOS Data Hub
  • Introduction to OS APIs
  • Core Concepts
    • Getting started with an API project
    • Authentication
    • Error codes
    • Rate-limiting policy
    • OS API branding
    • Service level agreements
    • Service availability dashboard
  • Accessing OS APIs
    • OS Maps API
      • Layers and styles
      • Getting started
        • ESRI ArcGIS Online
        • ESRI ArcGIS Pro
        • ESRI ArcMap
        • Cadcorp SIS
        • MapInfo Pro
        • QGIS
      • Technical specification
        • ZXY
        • WMTS
      • Code examples
    • OS Vector Tile API
      • What data is available?
      • Getting started
        • ESRI ArcGIS Pro
        • Cadcorp SIS
        • QGIS
        • Create a web application using the OS Vector Tile API
      • Technical specification
        • Service Metadata
        • Stylesheet
        • Tile request
      • Code examples
      • Stylesheets
    • OS NGD API – Tiles
    • OS NGD API – Features
    • OS Features API
      • OS Product Archive
      • What data is available?
      • Getting started
        • ArcGIS Online
        • ArcGIS Pro
        • ArcMap
        • Cadcorp SIS
        • MapInfo Pro
        • QGIS
      • Technical specification
        • getCapabilities
        • describeFeatureType
        • getFeature
        • Filtering
        • Paging
        • Empty values
      • Code examples
    • OS Names API
      • Getting started with example queries using Node.js
      • Technical specification
        • Find
        • Nearest
      • Code list
      • Code examples
    • OS Linked Identifiers API
      • What data is available?
      • Getting started with implementing a look-up application
      • Technical specification
        • Identifier
        • Identifier Types
        • Feature Types
        • Product Version Information
      • Code examples
    • OS Places API
      • Getting started with example queries using Node.js
      • Technical specification
        • Find
        • Postcode
        • UPRN
        • Nearest
        • BBOX
        • Radius
        • Polygon
      • Datasets
      • Code lists
      • Code examples
    • OS Match & Cleanse API
      • End of Life Information
      • Getting started with an example match query using Node.js
      • Technical specification
      • Datasets
      • Code lists
    • OS Downloads API
      • Getting started
        • Automating OS OpenData downloads
        • Automating OS Premium data downloads
      • Technical specification
        • OpenData products
        • OpenData product details
        • Download an OpenData product
        • OpenData product image
        • Data packages
        • Data package ID
        • Data package version
        • Data package version ID
        • Download a data package
    • OAuth 2 API
      • Getting started
      • Technical specification
  • Additional resources
    • OS API Wrappers
      • JavaScript
      • Python
      • R
  • Extra Links
    • Accessibility
    • Contact us
    • PSGA Product Summary
    • Terms and conditions
Powered by GitBook
On this page

Was this helpful?

  1. Accessing OS APIs
  2. OS Downloads API
  3. Technical specification

OpenData product details

PreviousOpenData productsNextDownload an OpenData product

Last updated 7 days ago

Was this helpful?

Returns details about a specific OpenData product.

get
Path parameters
productIdstringRequired

The id of the product.

Responses
200
Successful response.
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//products/{productId} HTTP/1.1
Host: api.os.uk
Accept: */*
{
  "id": "text",
  "name": "text",
  "description": [
    "text"
  ],
  "version": "text",
  "thirdPartyInfo": {
    "dataProvider": {
      "name": "text",
      "shortName": "text",
      "homepage": "text",
      "logoUrl": "https://example.com"
    },
    "supportingInfo": [
      {
        "name": "text",
        "link": "https://example.com"
      }
    ],
    "alsoAvailable": [
      {
        "name": "text",
        "link": "https://example.com"
      }
    ],
    "supportEmail": "name@gmail.com"
  },
  "url": "text",
  "documentationUrl": "text",
  "areas": [
    "GB"
  ],
  "dataStructures": [
    "Raster"
  ],
  "category": "text",
  "formats": [
    {
      "format": "text",
      "subformat": "text"
    }
  ],
  "imageCount": 1,
  "imageTemplate": "text",
  "downloadsUrl": "https://example.com",
  "warning": "text"
}