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
  • Core concepts
  • API reference
  • Correlation method table

Was this helpful?

  1. Accessing OS APIs
  2. OS Linked Identifiers API

Technical specification

PreviousGetting started with implementing a look-up applicationNextIdentifier

Last updated 2 months ago

Was this helpful?

This technical specification explains the content of the OS Linked Identifiers API and the methods you can use to call it.

The OS Linked Identifiers API is a free OpenData product that allows you to access the valuable relationships between properties, streets and OS MasterMap identifiers.

If you are not familiar with the OS Linked Identifiers API please read the before proceeding.

Core concepts

This specification does not cover core concepts that apply to all Ordnance Survey APIs.

Please read the following pages to learn more about OS API core concepts:

  • Authentication

  • Error codes

  • Rate-limiting policy

API reference

OS Linked Identifiers API has four main endpoints:

Correlation method table

The table below lists all of the correlation methods:

Correlation method
Feature relationship

RoadLink_TOID_TopographicArea_TOID_2

RoadLink ↔ TopographicArea

Road_TOID_TopographicArea_TOID_3

Road ↔ TopographicArea

Street_USRN_TopographicArea_TOID_4

Street ↔ TopographicArea

BLPU_UPRN_TopographicArea_TOID_5

BLPU ↔ TopographicArea

RoadLink_TOID_Road_TOID_7

RoadLink ↔ Road

RoadLink_TOID_Street_USRN_8

RoadLink ↔ Street

BLPU_UPRN_RoadLink_TOID_9

BLPU ↔ RoadLink

Road_TOID_Street_USRN_10

Road ↔ Street

BLPU_UPRN_Street_USRN_11

BLPU ↔ Street

ORRoadLink_GUID_RoadLink_TOID_12

Open Roads RoadLink ↔ OSMM Highways RoadLink

ORRoadNode_GUID_RoadLink_TOID_13

Open Roads RoadNode ↔ OSMM Highways RoadLink

Please see the following documents for more information about how each of these identifiers has been linked to each other:

overview documentation

Identifier

Query by identifier and find its associated IDs.

Identifier Types

Find associated identifiers from an identifier type.

Feature Types

Find associated identifiers from a feature type.

Product Version Information

Find version information for identifier relationships.

OS Open Linked Identifiers Technical Specification
Open Identifiers product family
Open Identifiers support page