How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OS Downloads API

Automated bulk download of OS OpenData and OS Premium datasets. The OpenData half of this API answers anonymously with no key - 26 open products including OS Open UPRN, OS Open TOID, Code-Point Open, OS Open Names, and Boundary-Line, each with direct zip download URLs.

OS Downloads API is one of 12 APIs that Ordnance Survey publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Downloads, Open Data, Bulk Data, and Addressing. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 9 paths, organized into 2 resource areas, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://api.os.uk/downloads/v1/.

9 operations 9 paths 9 schemas 9 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.os.uk/downloads/v1
Authentication
OAuth 2.0, API Key, API Key
Resource Areas
2

Authentication & Security 3

OS Downloads API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow. An API key is passed in the query as key (APIKeyQuery). An API key is passed in the header as key (APIKeyHeader).

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 9 GET. They span 2 resource areas: OpenData, Data Packages. Each is listed below with its method, path, parameters, and response codes.

OpenData 4

Operations providing access to OpenData products.

GET
/products
Returns a list of the OpenData products that are available to download.
1 param → 200
GET
/products/{productId}
Returns details about a specific OpenData product.
1 param → 200404
GET
/products/{productId}/downloads
Returns a list of downloads for a specific OpenData product, or redirects to the actual download if requested.
6 params → 200307404
GET
/products/{productId}/images/{index}
Returns a HTTP redirect, pointing to thumbnail images for the specified OpenData product.
3 params → 200307404
Data Packages 5

Operations providing access to data packages. To access data packages you must supply a valid API key or OAuth 2 access token.

GET
/dataPackages
List the data packages that are available to you.
→ 200401
GET
/dataPackages/{dataPackageId}
Get a specific data package.
1 param → 200401404
GET
/dataPackages/{dataPackageId}/versions
Get the list of versions for a specific data package.
1 param → 200401404
GET
/dataPackages/{dataPackageId}/versions/{versionId}
Get a specific data package version, including details of the files that are available to download.
2 params → 200401404
GET
/dataPackages/{dataPackageId}/versions/{versionId}/downloads
Get a specific file from a data package version.
3 params → 307401404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Product (17 properties), DataPackageVersionSummary (8 properties), DataPackage (7 properties), ThirdPartyInfo (4 properties). Each schema is shown below with its type and property counts.

ThirdPartyInfo
object
Information about the data provider for third-party products.
4 properties 4 required
Product
object
Information about a product made available through this API.
17 properties 5 required
Format
object
Information about the format that a download is available in.
2 properties 1 required
Download
object
Information about a specific download file that is made available through this API.
4 properties 2 required
ProductDownload
Information about a specific OpenData file that is made available through this API.
Area
string
This describes the geographical area that a download covers. GB is all of Great Britain, while codes like 'HP' cover National Grid Reference squares.
DataPackage
object
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…
7 properties 7 required
DataPackageVersionSummary
object
Summary information about a data package version.
8 properties 7 required
DataPackageVersion
Detailed information about a data package version, including a list of the files available to download.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ordnance-survey-downloads-openapi.yaml Raw ↑

Other APIs Ordnance Survey publishes across the network.

OS NGD API - Features
OS NGD API - Tiles
OS Net API
OS Places API
OS Names API
OS Linked Identifiers API
OS Match & Cleanse API (withdrawn)
OS Features API
OS Maps API
OS Vector Tile API
OS OAuth 2 API
Where this information came from

This is an independent, third-party profile of OS Downloads API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.